org.sonar.plugins.delphi.codecoverage.CodeCoverageSensor.java Source code

Introduction

Here is the source code for org.sonar.plugins.delphi.codecoverage.CodeCoverageSensor.java

Source

/*
 * Sonar Delphi Plugin
 * Copyright (C) 2011 Sabre Airline Solutions and Fabricio Colombo
 * Author(s):
 * Przemyslaw Kociolek (przemyslaw.kociolek@sabre.com)
 * Michal Wojcik (michal.wojcik@sabre.com)
 * Fabricio Colombo (fabricio.colombo.mva@gmail.com)
 *
 * 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.delphi.codecoverage;

import java.io.File;
import java.util.HashMap;
import java.util.Map;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.batch.Sensor;
import org.sonar.api.batch.SensorContext;
import org.sonar.api.config.Settings;
import org.sonar.api.resources.Project;
import org.sonar.plugins.delphi.DelphiPlugin;
import org.sonar.plugins.delphi.codecoverage.aqtime.AQTimeCoverageParser;
import org.sonar.plugins.delphi.codecoverage.delphicodecoveragetool.DelphiCodeCoverageToolParser;
import org.sonar.plugins.delphi.core.helpers.DelphiProjectHelper;
import org.sonar.plugins.delphi.utils.DelphiUtils;

/**
 * Sensor that analyses code coverage by connecting to AQTime CC database
 */
public class CodeCoverageSensor implements Sensor {
    private static final String JDBC_PROPERTY_KEYS[] = { DelphiPlugin.JDBC_DRIVER_KEY, DelphiPlugin.JDBC_URL_KEY,
            DelphiPlugin.JDBC_USER_KEY, DelphiPlugin.JDBC_PASSWORD_KEY, DelphiPlugin.JDBC_DB_TABLE_PREFIX_KEY };

    private static final String JDBC_DEFAULT_VALUES[] = { "net.sourceforge.jtds.jdbc.Driver", "", "", "", "", "" };

    private Map<String, String> jdbcProperties = new HashMap<String, String>();
    private CodeCoverageTool usedCodeCoverageTool = CodeCoverageTool.None;
    private File codeCoverageFile;

    private final DelphiProjectHelper delphiProjectHelper;

    public CodeCoverageSensor(Settings settings, DelphiProjectHelper delphiProjectHelper) {
        this.delphiProjectHelper = delphiProjectHelper;
        readJdbcFromConfiguration(settings);
        readCoverageToolFromConfiguration(settings);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean shouldExecuteOnProject(Project project) {
        return delphiProjectHelper.shouldExecuteOnProject();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void analyse(Project project, SensorContext context) {

        if (usedCodeCoverageTool.equals(CodeCoverageTool.None)) {
            DelphiUtils.LOG.info("Skipping code coverage.");
            return;
        }

        DelphiCodeCoverageParser parser = createParser(usedCodeCoverageTool);
        if (parser != null) {
            parser.parse(context);
        }
    }

    private void readCoverageToolFromConfiguration(Settings settings) {
        String value = settings.getString(DelphiPlugin.CODECOVERAGE_TOOL_KEY);
        usedCodeCoverageTool = parseCodeCoverageToolUsed(value);
        DelphiUtils.LOG.info("Code coverage tool selected: " + usedCodeCoverageTool.name());

        String fileName = StringUtils.defaultString(settings.getString(DelphiPlugin.CODECOVERAGE_REPORT_KEY), "");
        codeCoverageFile = new File(fileName);
    }

    private void readJdbcFromConfiguration(Settings settings) {
        for (int i = 0; i < JDBC_PROPERTY_KEYS.length; ++i) {
            String jdbcProperty = StringUtils.defaultIfBlank(settings.getString(JDBC_PROPERTY_KEYS[i]),
                    JDBC_DEFAULT_VALUES[i]);
            jdbcProperties.put(JDBC_PROPERTY_KEYS[i], jdbcProperty);
        }
    }

    private CodeCoverageTool parseCodeCoverageToolUsed(String usedTool) {
        if ("aqtime".equals(usedTool)) {
            return CodeCoverageTool.AQTime;
        }
        if ("delphi code coverage".equals(usedTool)) {
            return CodeCoverageTool.DelphiCodeCoverage;
        }
        return CodeCoverageTool.None;
    }

    private boolean areJdbcPropertiesValid() {
        for (int i = 0; i < JDBC_PROPERTY_KEYS.length - 1; i++) {
            if (StringUtils.isEmpty(jdbcProperties.get(JDBC_PROPERTY_KEYS[i]))) {
                DelphiUtils.LOG.warn("Empty jdbc property " + JDBC_PROPERTY_KEYS[i] + ", code coverage skipped.");
                return false;
            }
        }
        return true;
    }

    private DelphiCodeCoverageParser createParser(CodeCoverageTool usedTool) {
        if (usedTool.equals(CodeCoverageTool.AQTime)) {
            if (areJdbcPropertiesValid()) {
                AQTimeCoverageParser parser = new AQTimeCoverageParser(delphiProjectHelper);
                parser.setConnectionProperties(jdbcProperties);

                return parser;
            }
            return null;
        }
        if (usedTool.equals(CodeCoverageTool.DelphiCodeCoverage)) {
            DelphiCodeCoverageParser parser = new DelphiCodeCoverageToolParser(codeCoverageFile,
                    delphiProjectHelper);
            return parser;
        }

        return null;
    }

    @Override
    public String toString() {
        return "Delphi Code Coverage Sensor";
    }

}