001 /* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2009 SonarSource SA 004 * mailto:contact AT sonarsource DOT com 005 * 006 * Sonar is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * Sonar is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public 017 * License along with Sonar; if not, write to the Free Software 018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 019 */ 020 package org.sonar.api.batch; 021 022 import org.apache.commons.lang.ArrayUtils; 023 import org.sonar.api.BatchExtension; 024 import org.sonar.api.Plugins; 025 import org.sonar.api.resources.Project; 026 027 /** 028 * This class implements the management of the code coverage engine if there are several. 029 * It is a pre-implementation for Sensors and Decorators 030 * 031 * @since 1.10 032 */ 033 public abstract class AbstractCoverageExtension implements BatchExtension { 034 035 /** 036 * The plugin key to retrieve the coverage engine to be used 037 */ 038 public static final String PARAM_PLUGIN = "sonar.core.codeCoveragePlugin"; 039 040 /** 041 * The default value for the code coverage plugin 042 */ 043 public static final String DEFAULT_PLUGIN = "cobertura"; 044 045 private final Plugins plugins; 046 047 /** 048 * Default constructor 049 * @param plugins the list of plugins available 050 */ 051 public AbstractCoverageExtension(Plugins plugins) { 052 this.plugins = plugins; 053 } 054 055 /** 056 * Whether to implement the extension on the project 057 */ 058 public boolean shouldExecuteOnProject(Project project) { 059 return project.getAnalysisType().isDynamic(true) && isSelectedPlugin(project); 060 } 061 062 protected boolean isSelectedPlugin(Project project) { 063 String[] selectedPluginKeys = project.getConfiguration().getStringArray(PARAM_PLUGIN); 064 if (selectedPluginKeys.length == 0) { 065 selectedPluginKeys = new String[]{DEFAULT_PLUGIN}; 066 } 067 String pluginKey = plugins.getPluginKeyByExtension(getClass()); 068 return ArrayUtils.contains(selectedPluginKeys, pluginKey); 069 } 070 }