com.viae.maven.sonar.services

Interface SonarQualityGateService

All Known Implementing Classes:

SonarQualityGateServiceImpl

public interface SonarQualityGateService

Service to validate (a) SONAR quality gate(s).

Created by Vandeperre Maarten on 30/04/2016.

Field Summary

Fields

Modifier and Type	Field and Description
static java.time.format.DateTimeFormatter	DATE_TIME_FORMATTER

Method Summary

Modifier and Type	Method and Description
String	composeSonarProjectKey(org.apache.maven.project.MavenProject project, String projectKey, String branchName) Compose the project key used by SONAR based on the project key and an optional branch name.
java.time.LocalDateTime	getLastRunTimeStamp(org.sonar.wsclient.SonarClient client, String projectKey, String qualityGateName) Get the timestamp of the last sonar run.
void	linkQualityGateToProject(org.sonar.wsclient.SonarClient client, String projectKey, String qualityGateName) Link the given the given quality gate (i.e.
default void	validateQualityGate(org.sonar.wsclient.SonarClient client, String projectKey, String qualityGateName) Validate if the quality gate linked to the given project is passed.
void	validateQualityGate(org.sonar.wsclient.SonarClient client, String projectKey, String qualityGateName, java.time.LocalDateTime executionStart, int secondsToWait) Validate if the quality gate linked to the given project is passed.

Field Detail

DATE_TIME_FORMATTER

static final java.time.format.DateTimeFormatter DATE_TIME_FORMATTER

Method Detail

validateQualityGate

default void validateQualityGate(org.sonar.wsclient.SonarClient client,
                                 String projectKey,
                                 String qualityGateName)
                          throws SonarQualityException

Validate if the quality gate linked to the given project is passed.

Parameters:

client, - the SONAR configuration.

projectKey, - the identifier of the project (e.g. groupId:ArtifactId:branchId).

qualityGateName, - the name of the quality gate.

Throws:

SonarQualityException - will be thrown when the given project doesn't pass the linked quality gate.

validateQualityGate

void validateQualityGate(org.sonar.wsclient.SonarClient client,
                         String projectKey,
                         String qualityGateName,
                         java.time.LocalDateTime executionStart,
                         int secondsToWait)
                  throws SonarQualityException

Validate if the quality gate linked to the given project is passed.

Parameters:

client, - the SONAR configuration.

projectKey, - the identifier of the project (e.g. groupId:ArtifactId:branchId).

qualityGateName, - the name of the quality gate.

executionStart, - a timestamp before the sonar validation run started (e.g. the last run timestamp).

secondsToWait, - the interval that you will wait before going in a timeout (default set tot DEFAULT_WAIT_INTERVAL). (this is the time that you will wait until the last run timestamp of the given sonar run is after the executionStart. It will only be taken into account when the executionStart argument is passed and ignored when it's null.

Throws:

SonarQualityException - will be thrown when the given project doesn't pass the linked quality gate.

linkQualityGateToProject

void linkQualityGateToProject(org.sonar.wsclient.SonarClient client,
                              String projectKey,
                              String qualityGateName)
                       throws SonarQualityException

Link the given the given quality gate (i.e. via the qualityGateName) to the given project (i.e. via the projectKey).

Parameters:

client, - the SONAR configuration.

projectKey, - the identifier of the project (e.g. groupId:ArtifactId:branchId).

qualityGateName, - the name of the quality gate to link

Throws:

SonarQualityException - will be thrown when something goes wrong while linking the quality gate to the project.

getLastRunTimeStamp

java.time.LocalDateTime getLastRunTimeStamp(org.sonar.wsclient.SonarClient client,
                                            String projectKey,
                                            String qualityGateName)
                                     throws SonarQualityException

Get the timestamp of the last sonar run.

Parameters:

client, - the SONAR configuration.

projectKey, - the identifier of the project (e.g. groupId:ArtifactId:branchId).

qualityGateName, - the name of the quality gate.

Throws:

SonarQualityException - will be thrown when something goes wrong while fetching the last run timestamp.

composeSonarProjectKey

String composeSonarProjectKey(org.apache.maven.project.MavenProject project,
                              String projectKey,
                              String branchName)

Compose the project key used by SONAR based on the project key and an optional branch name. If projectKey is blank, the projectKey will be composed as groupId:artifactId like put in the project configuration.

Parameters:

projectKey, - the sonar project.

projectKey, - the key of the project (i.e. groupId:artifactId).

branchName, - the branchName (optional)

Returns:

the project key known to SONAR