net.nemerosa.ontrack.jenkins.dsl.facade

Interface BuildFacade

All Known Implementing Classes:

BuildV3Facade, BuildV4Facade

public interface BuildFacade

DSL facade for a build

Method Summary

Modifier and Type	Method and Description
ChangeLogFacade	getChangeLog(BuildFacade build) Gets the change log from this build to the other one
int	getId() ID of the build
String	getName() Name of the build
void	promote(String promotionLevelName) Creates a promotion run for this build
void	setGitCommit(String gitCommit) Sets the Git commit property on the target build
void	setJenkinsBuild(String ontrackConfigurationName, String projectPath, int number) Sets the Jenkins property on the target build
void	setRunInfo(Map<String,?> runInfo) Sets some run info on this build.
ValidationRunFacade	validate(String validationStampName, String runStatus) Creates a validation run for this build
ValidationRunFacade	validateWithCHML(String validationStamp, int critical, int high, int medium, int low, String status) Validates with CHML data
ValidationRunFacade	validateWithData(String validationStamp, Map<String,?> data, String dataType, String status) Validates with raw data
ValidationRunFacade	validateWithFraction(String validationStamp, int numerator, int denominator, String status) Validates with a fraction as data
ValidationRunFacade	validateWithMetrics(String validationStamp, Map<String,Double> metrics, String status) Validates with metrics data
ValidationRunFacade	validateWithNumber(String validationStamp, int value, String status) Validates with numeric data
ValidationRunFacade	validateWithPercentage(String validationStamp, int value, String status) Validates with percentage data
ValidationRunFacade	validateWithTestSummary(String validationStamp, int passed, int skipped, int failed, String status) Validates with a test summary as data
ValidationRunFacade	validateWithText(String validationStamp, String status, String text) Validates with text data

Method Detail

getId

int getId()

ID of the build

getName

String getName()

Name of the build

promote

void promote(String promotionLevelName)

Creates a promotion run for this build

Parameters:

promotionLevelName - Name of the promotion level

validate

ValidationRunFacade validate(String validationStampName,
                             String runStatus)

Creates a validation run for this build

Parameters:

validationStampName - Name of the validation stamp

runStatus - Status for the run

Returns:

Validation run facade

setRunInfo

void setRunInfo(Map<String,?> runInfo)

Sets some run info on this build.

Parameters:

runInfo - Run info to set

setJenkinsBuild

void setJenkinsBuild(String ontrackConfigurationName,
                     String projectPath,
                     int number)

Sets the Jenkins property on the target build

Parameters:

ontrackConfigurationName - Name of the Jenkins configuration in Ontrack

projectPath - Path to the job in Jenkins

number - Build number in Jenkins

setGitCommit

void setGitCommit(String gitCommit)

Sets the Git commit property on the target build

Parameters:

gitCommit - Git commit

getChangeLog

ChangeLogFacade getChangeLog(BuildFacade build)

Gets the change log from this build to the other one

Parameters:

build - Other bound

Returns:

Change log

validateWithFraction

ValidationRunFacade validateWithFraction(String validationStamp,
                                         int numerator,
                                         int denominator,
                                         String status)

Validates with a fraction as data

Parameters:

validationStamp - Name of the validation stamp

numerator - Fraction numerator

denominator - Fraction denominator

status - Optional status for the run

Returns:

Validation run

validateWithTestSummary

ValidationRunFacade validateWithTestSummary(String validationStamp,
                                            int passed,
                                            int skipped,
                                            int failed,
                                            String status)

Validates with a test summary as data

Parameters:

validationStamp - Name of the validation stamp

passed - Number of passed tests

skipped - Number of skipped tests

failed - Number of failed tests

status - Optional status for the run

Returns:

Validation run

validateWithCHML

ValidationRunFacade validateWithCHML(String validationStamp,
                                     int critical,
                                     int high,
                                     int medium,
                                     int low,
                                     String status)

Validates with CHML data

Parameters:

validationStamp - Name of the validation stamp

critical - Number of critical issues

high - Number of high issues

medium - Number of medium issues

low - Number of low issues

status - Optional status for the run

Returns:

Validation run

validateWithText

ValidationRunFacade validateWithText(String validationStamp,
                                     String status,
                                     String text)

Validates with text data

Parameters:

validationStamp - Name of the validation stamp

text - Text to set

status - Optional status for the run

Returns:

Validation run

validateWithNumber

ValidationRunFacade validateWithNumber(String validationStamp,
                                       int value,
                                       String status)

Validates with numeric data

Parameters:

validationStamp - Name of the validation stamp

value - Value to set

status - Optional status for the run

Returns:

Validation run

validateWithPercentage

ValidationRunFacade validateWithPercentage(String validationStamp,
                                           int value,
                                           String status)

Validates with percentage data

Parameters:

validationStamp - Name of the validation stamp

value - Value to set

status - Optional status for the run

Returns:

Validation run

validateWithMetrics

ValidationRunFacade validateWithMetrics(String validationStamp,
                                        Map<String,Double> metrics,
                                        String status)

Validates with metrics data

Parameters:

validationStamp - Name of the validation stamp

metrics - Value to set

status - Optional status for the run

Returns:

Validation run

validateWithData

ValidationRunFacade validateWithData(String validationStamp,
                                     Map<String,?> data,
                                     String dataType,
                                     String status)

Validates with raw data

Parameters:

validationStamp - Name of the validation stamp

data - Raw data

dataType - Data type

status - Optional status for the run

Returns:

Validation run