org.sonar.api.Plugin Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation
Show all versions of sonar-plugin-api Show documentation
Plugin API for SonarQube, SonarCloud and SonarLint
/*
* Sonar Plugin API
* Copyright (C) 2009-2022 SonarSource SA
* mailto:info AT sonarsource DOT 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 02110-1301, USA.
*/
package org.sonar.api;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.sonar.api.config.Configuration;
import org.sonar.api.utils.Version;
import static java.util.Arrays.asList;
import static java.util.Objects.requireNonNull;
/**
* Entry-point for plugins to inject extensions into SonarQube.
* The JAR manifest must declare the name of the implementation class in the property Plugin-Class.
* This property is automatically set by sonar-packaging-maven-plugin when building plugin.
*
Example of implementation
*
* public class MyPlugin implements Plugin {
* {@literal @}Override
* public void define(Context context) {
* context.addExtensions(MySensor.class, MyRules.class);
* if (context.getSonarQubeVersion().isGreaterThanOrEqual(Version.create(6, 0))) {
* // Extension which supports only versions 6.0 and greater
* // See org.sonar.api.SonarRuntime for more details.
* context.addExtension(MyNewExtension.class);
* }
* }
* }
*
*
* Example of pom.xml
*
* <project>
* ...
* <packaging>sonar-plugin</packaging>
*
* <build>
* <plugins>
* <plugin>
* <groupId>org.sonarsource.sonar-packaging-maven-plugin</groupId>
* <artifactId>sonar-packaging-maven-plugin</artifactId>
* <extensions>true</extensions>
* <configuration>
* <pluginClass>com.mycompany.sonarqube.MyPlugin</pluginClass>
* </configuration>
* </plugin>
* </plugins>
* </build>
* </project>
*
*
* Example of Test
* Add a test dependency to sonar-plugin-api-impl to have access to implementation classes in tests.
*
*{@literal @}Test
* public void test_plugin_extensions_compatible_with_5_6() {
* SonarRuntime runtime = SonarRuntimeImpl.forSonarQube(Version.create(5, 6), SonarQubeSide.SCANNER);
* Plugin.Context context = new PluginContextImpl.Builder().setSonarRuntime(runtime).build();
* MyPlugin underTest = new MyPlugin();
*
* underTest.define(context);
*
* assertThat(context.getExtensions()).hasSize(4);
* }
*
*
* @since 5.5
* @see org.sonar.api.internal.PluginContextImpl for unit tests
*/
public interface Plugin {
class Context {
private final SonarRuntime sonarRuntime;
private final List extensions = new ArrayList();
/**
* For unit tests only. It's recommended to use {@link org.sonar.api.internal.PluginContextImpl.Builder}
* to create instances of {@link Plugin.Context}.
* The configuration returned by {@see #getBootConfiguration()} is empty.
*/
public Context(SonarRuntime sonarRuntime) {
this.sonarRuntime = requireNonNull(sonarRuntime, "sonarRuntime is null");
}
/**
* Shortcut on {@code getRuntime().getApiVersion()} since version 6.0.
*
* @see #getRuntime()
* @since 5.5
* @return the version of SonarQube API at runtime, not at compilation time
*/
public Version getSonarQubeVersion() {
return sonarRuntime.getApiVersion();
}
/**
* Runtime environment. Can be use to add some extensions only on some conditions.
* @since 6.0
*/
public SonarRuntime getRuntime() {
return sonarRuntime;
}
/**
* Add an extension as :
*
* - a Class that is annotated with {@link org.sonar.api.scanner.ScannerSide}, {@link org.sonar.api.server.ServerSide}
* or {@link org.sonar.api.ce.ComputeEngineSide}. The extension will be instantiated once. Its dependencies are
* injected through constructor parameters.
* - an instance that is annotated with {@link org.sonar.api.scanner.ScannerSide}, {@link org.sonar.api.server.ServerSide}
* or {@link org.sonar.api.ce.ComputeEngineSide}.
*
* Only a single component can be registered for a class. It's not allowed for example to register:
*
* - two MyExtension.class
* - MyExtension.class and new MyExtension()
*
*/
public Context addExtension(Object extension) {
requireNonNull(extension);
this.extensions.add(extension);
return this;
}
/**
* @see #addExtension(Object)
*/
public Context addExtensions(Collection extensions) {
this.extensions.addAll(extensions);
return this;
}
/**
* @see #addExtension(Object)
*/
public Context addExtensions(Object first, Object second, Object... others) {
addExtension(first);
addExtension(second);
addExtensions(asList(others));
return this;
}
public List getExtensions() {
return extensions;
}
/**
* The configuration that contains only the few properties required to bootstrap the process, for example:
* - conf/sonar.properties and persisted properties on web server and Compute Engine sides. The default values
* defined by plugins are ignored.
* - command-line arguments on scanner side. Default values or properties persisted in server are ignored.
*
* @since 7.1
*/
public Configuration getBootConfiguration() {
throw new UnsupportedOperationException("Unit tests should create Plugin.Context with org.sonar.api.internal.PluginContextImpl#Builder");
}
}
/**
* This method is executed at runtime when:
*
* - Web Server starts
* - Compute Engine starts
* - Scanner starts
*
*/
void define(Context context);
}