JMeterSensor.java

/*
 * Sonar JMeter Plugin
 * Copyright (C) 2010 eXcentia
 * dev@sonar.codehaus.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */

package org.sonar.plugins.jmeter;

import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.Sensor;
import org.sonar.api.batch.SensorContext;
import org.sonar.api.resources.Project;
import org.sonar.plugins.jmeter.exception.JMeterPluginException;

import es.excentia.jmeter.report.client.JMeterReportClient;
import es.excentia.jmeter.report.client.JMeterReportConst;
import es.excentia.jmeter.report.client.data.GlobalSummary;
import es.excentia.jmeter.report.server.data.ConfigInfo;
import es.excentia.jmeter.report.server.service.ConfigService;
import es.excentia.jmeter.report.server.service.OperationService;
import es.excentia.jmeter.report.server.service.ServiceFactory;

public class JMeterSensor implements Sensor { // , GeneratesViolations {

  public static final Logger LOG = LoggerFactory.getLogger(JMeterSensor.class);

  // Local JMeterReportServer services we will use to analize local jtl files
  static final ConfigService configService = ServiceFactory.get(ConfigService.class);
  static final OperationService metricService = ServiceFactory.get(OperationService.class);


  public boolean shouldExecuteOnProject(Project project) {
    return true;
  }

  public void analyse(Project project, SensorContext context) {

    // this sensor is executed if local jtl path or remote config name are set
    String jtlPath = (String) project.getProperty(JMeterPluginConst.LOCAL_JTL_PATH_PROPERTY);
    String config = (String) project.getProperty(JMeterPluginConst.CONFIG_PROPERTY);
    if (StringUtils.isBlank(jtlPath) && StringUtils.isBlank(config)) {
      return;
    }
    
    LOG.debug("START JMeterSensor");

    try {

      GlobalSummary summary = getGlobalSummary(project);
      JMeterMAO.saveSummaryAsMetrics(summary, context);

    } catch (Exception e) {
      LOG.error("Cannot analyse project '" + project.getName() + "'", e);
    }

    LOG.debug("END JMeterSensor");
  }

  /**
   * Gets a jmeter report client connected to the configured jmeter report
   * server
   */
  protected JMeterReportClient getReportClient(Project project) {

    String host = (String) project.getProperty(JMeterPluginConst.HOST_PROPERTY);
    if (StringUtils.isBlank(host)) {
      throw new JMeterPluginException(
          "You must set the HOST in sonar-jmeter-plugin config "
          + "for the project '" + project.getName() + "'");
    }

    String port = (String) project.getProperty(JMeterPluginConst.PORT_PROPERTY);
    if (StringUtils.isBlank(port) || Integer.parseInt(port) == 0) {
      LOG.warn("Null or invalid jmeter-report-server PORT. "
          + "Using default '{}'", JMeterReportConst.DEFAULT_PORT);
      port = Integer.toString(JMeterReportConst.DEFAULT_PORT);
    }

    return new JMeterReportClient(host, Integer.parseInt(port));
  }


  /**
   * Gets the configured jmeter test configuration name
   */
  protected String getTestConfigName(Project project) {
    String config = (String) project.getProperty(JMeterPluginConst.CONFIG_PROPERTY);
    if (StringUtils.isBlank(config)) {
      throw new JMeterPluginException(
          "You must set test CONFIG in sonar-jmeter-plugin "
          + "for the project '" + project.getName() + "'");
    } else {
      return config;
    }
  }

  /**
   * Gets the configured jmeter jtl file path, if it was specified
   */
  protected String getLocalJtlFilePath(Project project) {
    String localJtlPath = (String) project
    .getProperty(JMeterPluginConst.LOCAL_JTL_PATH_PROPERTY);
    return StringUtils.isBlank(localJtlPath)? null : localJtlPath;
  }


  /**
   * Gets the GlobalSummary from local jtl file or remote jmeter 
   * report server, according to project config.
   */
  protected GlobalSummary getGlobalSummary(Project project) {
    GlobalSummary globalSummary;
    String localJtlPath = getLocalJtlFilePath(project);
    String projectName = project.getName();

    if (!StringUtils.isBlank(localJtlPath)) {
      // Get report parsing local jtl file
      LOG.info("Getting JMeter results from local file");
      ConfigInfo configInfo = new ConfigInfo(localJtlPath);
      configService.setTestConfigInfo(projectName, configInfo);
      globalSummary = metricService.getGlobalSummary(projectName);

    } else {
      // Get report from remote server
      LOG.info("Getting JMeter results from remote server");

      // Remove inMemoryConfig if there was any
      configService.setTestConfigInfo(projectName, null);

      // Use a jmeter report client for getting report from a 
      // remote jmeter report server
      JMeterReportClient client = getReportClient(project);
      String config = getTestConfigName(project);
      globalSummary = client.getGlobalSummary(config);
    }

    return globalSummary;
  }

  @Override
  public String toString() {
    return getClass().getSimpleName();
  }

}