org.sonar.api.ce.posttask.PostProjectAnalysisTask Maven / Gradle / Ivy
Show all versions of sonar-plugin-api Show documentation
/*
* 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.ce.posttask;
import java.util.Optional;
import javax.annotation.CheckForNull;
import org.sonar.api.ExtensionPoint;
import org.sonar.api.ce.ComputeEngineSide;
/**
* Extension point of which any plugin can provide an implementation and will allow them to be notified whenever some
* analysis report processing ends in the Compute Engine.
*
*
* If more then one implementation of {@link PostProjectAnalysisTask} is found, they will be executed in no specific order.
*
*
* Class {@link PostProjectAnalysisTaskTester} is provided to write unit tests of implementations of this interface.
*
* @since 5.5
* @see PostProjectAnalysisTaskTester
*/
@ExtensionPoint
@ComputeEngineSide
public interface PostProjectAnalysisTask {
/**
* A short description or name for the task.
*
* This will be used (but not limited to) in logs reporting the execution of the task.
* @since 8.0
*/
default String getDescription() {
return this.getClass().getSimpleName();
}
/**
* This method is called whenever the processing of a Project analysis has finished, whether successfully or not.
*
* @deprecated in 8.0. Implement {@link #finished(Context)} instead
*/
@Deprecated
default void finished(ProjectAnalysis analysis) {
throw new IllegalStateException("Provide an implementation of method finished(Context)");
}
/**
* @since 8.0
*/
default void finished(Context context) {
finished(context.getProjectAnalysis());
}
interface Context {
ProjectAnalysis getProjectAnalysis();
LogStatistics getLogStatistics();
}
/**
* Each key-value paar will be added to the log describing the end of the
*/
interface LogStatistics {
/**
* @return this
* @throws NullPointerException if key or value is null
* @throws IllegalArgumentException if key has already been set
* @throws IllegalArgumentException if key is "status", to avoid conflict with field with same name added by the executor
* @throws IllegalArgumentException if key is "time", to avoid conflict with the profiler field with same name
*/
LogStatistics add(String key, Object value);
}
/**
* @since 5.5
*/
interface ProjectAnalysis {
/**
* When organizations are enabled in SonarQube, the organization the project belongs to.
*
* @since 7.0
* @return a non empty value when organizations are enabled, otherwise empty
*/
Optional getOrganization();
/**
* Details of the Compute Engine task in which the project analysis was run.
*/
CeTask getCeTask();
/**
* Details of the analyzed project.
*/
Project getProject();
/**
* The branch that is being analyzed.
*
* @since 6.6
*/
Optional getBranch();
/**
* Status and details of the Quality Gate of the project (if any was configured on the project).
*/
@CheckForNull
QualityGate getQualityGate();
/**
* Analysis containing the UUID of the analysis and the date
*
*
* This Analysis can be missing when the status of the task is
* {@link org.sonar.api.ce.posttask.CeTask.Status#FAILED FAILED}.
*
*/
Optional getAnalysis();
/**
* Context as defined by scanner through {@link org.sonar.api.batch.sensor.SensorContext#addContextProperty(String, String)}.
* It does not contain the settings used by scanner.
*
* @since 6.1
*/
ScannerContext getScannerContext();
/**
* Revision Id that has been analysed. May return null.
* @since 7.6
* @deprecated in 7.8, replaced by {@code Analysis#getRevision()}
* @see #getAnalysis()
*/
@Deprecated
String getScmRevisionId();
}
}