com.viae.maven.sonar.services.SonarQualityGateService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-maven-plugin Show documentation

This plugin will make maven interact with SONAR.

There is a newer version: 1.1.4

/*
 * Copyright (c) 2016 by VIAE (http///viae-it.com)
 */

package com.viae.maven.sonar.services;

import com.viae.maven.sonar.exceptions.SonarQualityException;
import org.sonar.wsclient.SonarClient;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

/**
 * Service to validate (a) SONAR quality gate(s).
 *
 * Created by Vandeperre Maarten on 30/04/2016.
 */
public interface SonarQualityGateService {
	public static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern( "yyyy-MM-dd'T'HH:mm:ssZZ" );
	/**
	 * Validate if the quality gate linked to the given project is passed.
	 *
	 * @param client, the SONAR configuration.
	 * @param projectKey, the identifier of the project (e.g. groupId:ArtifactId:branchId).
	 * @throws SonarQualityException will be thrown when the given project doesn't pass the linked quality gate.
     */
	default void validateQualityGate( final SonarClient client, final String projectKey ) throws SonarQualityException {
		validateQualityGate( client, projectKey, null, -1 );
	}

	/**
	 * Validate if the quality gate linked to the given project is passed.
	 *
	 * @param client,         the SONAR configuration.
	 * @param projectKey,     the identifier of the project (e.g. groupId:ArtifactId:branchId).
	 * @param executionStart, a timestamp before the sonar validation run started (e.g. the last run timestamp).
	 * @param 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 {@code null}.
	 * @throws SonarQualityException will be thrown when the given project doesn't pass the linked quality gate.
	 */
	void validateQualityGate( SonarClient client, String projectKey, LocalDateTime executionStart, int secondsToWait ) throws SonarQualityException;

	void linkQualityGateToProject( SonarClient client, String projectKey, String qualityGateName ) throws SonarQualityException;

	LocalDateTime getLastRunTimeStamp( SonarClient client, String projectKey ) throws SonarQualityException;

	/**
	 * Compose the project key used by SONAR based on the project key and an optional branch name.
	 *
	 * @param projectKey, the key of the project (i.e. groupId:artifactId).
	 * @param branchName, the branchName (optional)
	 * @return the project key known to SONAR
	 */
	String composeSonarProjectKey(String projectKey, String branchName);
}