Class BaseBuild
- java.lang.Object
-
- jetbrains.buildServer.serverSide.impl.BaseBuild
-
- All Implemented Interfaces:
Build,BuildEx,BuildPromotionOwner,ParametersSupport,SBuild
- Direct Known Subclasses:
BaseRunningBuild,DummyBuild,FinishedBuildImpl
public abstract class BaseBuild extends Object implements BuildEx
-
-
Field Summary
Fields Modifier and Type Field Description protected longmyBuildIdprotected BuildContextmyContextprotected CountermyStatsCallCounterstatic StringREMOTE_ARTIFACTS_PREFIXInternal property that enables storing remote artifacts count by type in custom storage
-
Constructor Summary
Constructors Modifier Constructor Description protectedBaseBuild(long buildId, String rawTriggeredBy, Date buildStartDateOnServer, BuildContext context)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddBuildProblem(BuildProblemData buildProblem)Adds build problem to the build.BuildProblemDataaddUserBuildProblem(SUser user, String problemDescription)Adds user provided build problem to the build.voidbuildProblemsChanged(List<BuildProblemData> before, List<BuildProblemData> after)Called when build problems are changed (added, deleted or muted)DateconvertToAgentTime(Date serverTime)Converts server time to agent time by taking into account agent and server time difference.DateconvertToServerTime(Date agentTime)Converts agent time to server time by taking into account agent and server time difference.protected ShortStatisticscreateShortStatistics(boolean updatePersistentCaches)voiddeleteBuildProblem(SUser user, String identity, String comment)Deletes build problem Deleting build problem may change build status to SUCCESSprotected DepParametersMemoryOptimizedMapdoGetBuildFinishParameters()protected DepParametersMemoryOptimizedMapdoGetBuildStartParameters()abstract BuildAgentExgetAgent()List<SArtifactDependency>getArtifactDependencies()Returns the artifact dependencies of this build.BuildArtifactsgetArtifacts(BuildArtifactsViewMode mode)Returns accessor for build artifacts.FilegetArtifactsDirectory()Returns artifacts directory of this build.AuditLogFactorygetAuditLogFactory()AuditLogProvidergetAuditLogProvider()BranchgetBranch()CommentgetBuildComment()Returns build comment.protected BuildContextgetBuildContext()protected abstract longgetBuildCounter()Collection<SBuildFeatureDescriptor>getBuildFeaturesOfType(String featureType)Returns collection of enabled and resolved build features of specified type from build settings (resolving is performed at the moment of the method call).DepParametersMemoryOptimizedMapgetBuildFinishParameters()longgetBuildId()Returns build idMap<String,String>getBuildNumberParameters()protected static StringgetBuildNumberWithoutRefs(String curBuildNumber)Map<String,String>getBuildOwnParameters()Returns map of parameters (configuration params, system properties and environment variables) excluding parameters provided by extensions.List<BuildProblem>getBuildProblems()Returns all build problems for this promotion with extended information about muting This method can perform rather slow as it reloads build problems from database and fills mute info from audit (reads database as well) If you don't need mute info try usingSBuild.getFailureReasons()abstract BuildPromotionExgetBuildPromotion()Returns build promotionDepParametersMemoryOptimizedMapgetBuildStartParameters()BuildStatisticsgetBuildStatistics(BuildStatisticsOptions options)Same asSBuild.getFullStatistics()but with more control of data being loaded.StatusgetBuildStatus()Returns current build statusBuildTypeExgetBuildType()Returns build configuration this build belongs to.StringgetBuildTypeExternalId()Returns the build type external ID.StringgetBuildTypeId()Returns build configuration internal idStringgetBuildTypeName()Returns name of the build configuration this build belongs to.List<SVcsModification>getChanges(SelectPrevBuildPolicy policy, boolean includeModificationsIfPreviousBuildIsAbsent)List of modifications detected in the version control since the previous build (selected according to the specified policy) Ordering: last detected modifications goes first in the listDategetClientStartDate()Returns the timestamp when the build was started on the build agent (in agent time)TimeZonegetClientTimeZone()Returns agent machine time zone if it's available on server.UserSet<SUser>getCommitters(SelectPrevBuildPolicy selectPrevBuildPolicy)Returns all users who made modifications since the previous build selected according to the specified policy.List<String>getCompilationErrorMessages()Returns compilation error messages of this buildList<SVcsModification>getContainingChanges()Returns changes in this build.CustomDataStoragegetCustomDataStorage(String key)Returns a data storage which can be used to associate arbitrary data with the build.protected Set<String>getCustomDataStorageIdsByPrefix(String keyPrefix)LonggetDetachFromAgentReceivedTimestamp()DownloadedArtifactsgetDownloadedArtifacts()Returns information about artifacts downloaded by this build according to configured artifact dependencies.longgetDuration()The build duration is computed as follows: - if build was started on an agent (run command was successfully sent) then duration is calculated as finish time - start on agent time - otherwise duration is calculated as finish time - remove from queue timelonggetDurationOnAgent()List<BuildProblemData>getFailureReasons()Returns build problems that caused build failure or empty list if build is successfulbyte[]getFileContent(String filePath)Get binary content of the single file related to this build.DategetFinishOnAgentDate()Returns timestamp when the build finished on agent (server time) ornullif it is still running on agent.StringgetFirstInternalError()Returns the first internal error in a build, or null.StringgetFirstInternalErrorMessage()Returns the error message associated with the first internal error, or nullStringgetFullName()BuildStatisticsgetFullStatistics()Calculates full statistics for this build.StringgetId()List<VcsLabel>getLabels()VCS labels which were made by TeamCity for the build.List<String>getLogMessages(int skipMessages, int maxCount)Allows to get messages logged for the buildSUsergetOwner()If this build is personal one, returns the owner of this build.ParametersProvidergetParametersProvider()Returns parameters which can be used by value resolver.SFinishedBuildgetPreviousFinished()DownloadedArtifactsgetProvidedArtifacts()Returns information about provided artifacts, i.e.DategetQueuedDate()Returns the date when the build was added to queue.abstract StringgetRawBuildNumber()Returns raw build number (i.e.SFinishedBuildgetRecentlyFinishedBuild()Collection<Issue>getRelatedIssues()Returns the collection of related issues (e.g.List<RemoteArtifacts>getRemoteArtifacts()Returns list of all remote artifacts that were published for this build.RemoteArtifactsgetRemoteArtifactsByType(String type)Returns list of remote artifacts that belong to a specific type.List<BuildRevision>getRevisions()List of all revisions which were used for the build instanceSBuildgetSequenceBuild()If associated build promotion has modification id, returns the sequence build which contains the same changes as this build promotion.DategetServerStartDate()Returns the timestamp when the build was removed from the queue.protected FilegetSettingsDigestFile()static byte[]getSettingsDigestFromFile(File artifactsDirectory)ShortStatisticsgetShortStatistics()Calculates short statistics for this build.DategetStartDate()Returns timestamp when the build start command has been sent to an agent (server-time) or remove from queue time if start command has not been sentBigDecimalgetStatisticValue(String valueTypeKey)Map<String,BigDecimal>getStatisticValues()protected static StatusgetStatus(List<BuildProblemData> before, List<BuildProblemData> after)List<String>getTags()Returns list of public tags for this buildCustomDataStoragegetTemporaryCustomDataStorage()List<TestInfo>getTestMessages(int skipTests, int maxTestsToLoad)Retrieves information about tests failed in the build.TriggeredBygetTriggeredBy()Returns details about how this build was triggered.ValueResolvergetValueResolver()Returns build-aware value resolver to be used to resolve values based on the build's properties.ValueResolvergetValueResolver(boolean preferBuildStartParameters)Creates resolver which can use build start parameters instead of build finish params, this resolver is required to provide consistent resolving on the server for personal and non personal buildsprotected ValueResolvergetValueResolver(Map<String,String> highPrioParams)Creates value resolver where the specified map of parameters has the highest priority.protected ContextVariablesgetVariablesProvider()List<VcsRootInstanceEntry>getVcsRootEntries()Returns vcs roots with checkout rules for the build start moment.Map<String,Long>getWaitReasons()Returns wait reasons for this build, while it was in the build queue.booleanhasBuildFinishParameters()booleanhasBuildProblemOfType(String type)Returns true if build has build problem of this typebooleanhasTests()protected voidinitMetrics(BuildContext context)booleanisAgentLessBuild()booleanisArtifactsExists()Returns true if this build has artifacts.booleanisDetachedFromAgent()Returns true if this build was detached from agent at some point.booleanisHasInternalArtifactsOnly()Returns true if this build has only internal (hidden) artifacts.booleanisHasRelatedIssues()Returns whether the build has related issues (e.g.booleanisInternalError()Returns whether this build failed because of internal error (infrastructural error not related to build script).booleanisOutdated()Returns true if this build is outdated.booleanisOutOfChangesSequence()Returns true if there is a build started before but having more recent changes then this build.booleanisPersonal()Returns if this build has been run to test personal changesprotected booleanisPersonalPatchAvailable()booleanisPinned()Returns true if this build is pinnedbooleanisResponsibleNeeded()Always returns false for personal and/or cancelled builds.booleanisStartedOnAgent()Returns true if this build was started on agent.booleanisTimedOut()booleanisUsedByOtherBuilds()Returns true if this build is used by other builds, i.e.voidmuteBuildProblems(boolean muteIfTrue)Makes all existing build problems enabled or disabledvoidmuteBuildProblems(SUser user, boolean muteIfTrue, String comment)Makes all existing build problems enabled or disabledprotected abstract voidnotifyOnBuildProblemsChanged(List<BuildProblemData> before, List<BuildProblemData> after)protected longnow()protected DatenowDate()protected voidpreloadFailedTests(ShortStatistics stats)voidpublishStatisticValue(String valueTypeKey, BigDecimal value)voidresetBuildFinalParameters()voidsetBuildComment(User user, String comment)Sets the comment for the buildprotected voidsetBuildStartTimes(Date buildStartTimeAgent, Date buildStartTimeServer, TimeZone agentTimeZone)voidsetTags(List<String> tags)Sets public tags for this buildvoidsetTags(User user, List<String> tags)Sets public tags for this buildvoidupdateExternalArtifactsInfoOnAccess()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface jetbrains.buildServer.Build
getAgentName, getBuildNumber, getCanceledInfo, getFinishDate, getProjectExternalId, getProjectId, getStatusDescriptor, isFinished
-
Methods inherited from interface jetbrains.buildServer.serverSide.BuildEx
getBuildLog, getCachedShortStatistics
-
Methods inherited from interface jetbrains.buildServer.serverSide.SBuild
getBuildDescription, isCompositeBuild
-
-
-
-
Field Detail
-
REMOTE_ARTIFACTS_PREFIX
public static final String REMOTE_ARTIFACTS_PREFIX
Internal property that enables storing remote artifacts count by type in custom storage- Since:
- 2022.06
- See Also:
- Constant Field Values
-
myContext
protected final BuildContext myContext
-
myBuildId
protected long myBuildId
-
myStatsCallCounter
protected Counter myStatsCallCounter
-
-
Constructor Detail
-
BaseBuild
protected BaseBuild(long buildId, String rawTriggeredBy, @Nullable Date buildStartDateOnServer, @NotNull BuildContext context)
-
-
Method Detail
-
initMetrics
protected void initMetrics(@NotNull BuildContext context)
-
setBuildStartTimes
protected void setBuildStartTimes(@Nullable Date buildStartTimeAgent, @NotNull Date buildStartTimeServer, @Nullable TimeZone agentTimeZone)
-
isPersonal
public boolean isPersonal()
Description copied from interface:BuildReturns if this build has been run to test personal changes- Specified by:
isPersonalin interfaceBuild- Returns:
- true is the build has been started as personal, and its changes were not committed to the VCS
-
isPersonalPatchAvailable
protected boolean isPersonalPatchAvailable()
-
getDuration
public long getDuration()
The build duration is computed as follows: - if build was started on an agent (run command was successfully sent) then duration is calculated as finish time - start on agent time - otherwise duration is calculated as finish time - remove from queue time- Specified by:
getDurationin interfaceBuild- Returns:
- current build duration in seconds
-
getDurationOnAgent
public long getDurationOnAgent()
- Specified by:
getDurationOnAgentin interfaceBuildEx- Returns:
- build duration in seconds on agent or 0 if the build wasn't running on agent
-
getOwner
@Nullable public SUser getOwner()
Description copied from interface:SBuildIf this build is personal one, returns the owner of this build.- Specified by:
getOwnerin interfaceSBuild- Returns:
- null if this build is not personal otherwise owner of this build
- See Also:
Build.isPersonal()
-
getBuildId
public long getBuildId()
Description copied from interface:BuildReturns build id- Specified by:
getBuildIdin interfaceBuild- Returns:
- Unique build id
-
getBuildTypeId
@NotNull public String getBuildTypeId()
Description copied from interface:BuildReturns build configuration internal id- Specified by:
getBuildTypeIdin interfaceBuild- Returns:
- ID of the configuration this build belongs to.
-
getBuildTypeExternalId
@NotNull public String getBuildTypeExternalId()
Description copied from interface:BuildReturns the build type external ID.If the external identifier does not exist (this might happen for a running build if the build type was deleted, and a new build type with same external id was created), a
BuildPromotion#NOT_EXISTING_BUILD_TYPE_IDvalue is returned.- Specified by:
getBuildTypeExternalIdin interfaceBuild- Returns:
- build type external ID
-
getBuildType
@Nullable public BuildTypeEx getBuildType()
Description copied from interface:SBuildReturns build configuration this build belongs to.- Specified by:
getBuildTypein interfaceBuild- Specified by:
getBuildTypein interfaceSBuild- Returns:
- build configuration descriptor.
-
getBuildTypeName
@NotNull public String getBuildTypeName()
Description copied from interface:BuildReturns name of the build configuration this build belongs to.- Specified by:
getBuildTypeNamein interfaceBuild- Returns:
- name of the build configuration this build belongs to.
-
getFullName
@NotNull public String getFullName()
- Specified by:
getFullNamein interfaceBuild- Returns:
- full name of the build configuration this build belongs to, has form "project_name :: buildconfig_name"
-
getArtifacts
@NotNull public BuildArtifacts getArtifacts(@NotNull BuildArtifactsViewMode mode)
Description copied from interface:SBuildReturns accessor for build artifacts. This accessor checks all necessary permissions for accessing files.- Specified by:
getArtifactsin interfaceSBuild- Parameters:
mode- view mode to see artifacts- Returns:
- build artifacts viewer
-
getArtifactsDirectory
@NotNull public File getArtifactsDirectory()
Description copied from interface:SBuildReturns artifacts directory of this build. Artifacts should be locked with help ofArtifactsGuardfor the period of their processing.- Specified by:
getArtifactsDirectoryin interfaceSBuild- Returns:
- artifacts directory of this build
-
getArtifactDependencies
@NotNull public List<SArtifactDependency> getArtifactDependencies()
Description copied from interface:SBuildReturns the artifact dependencies of this build. Same as getBuildPromotion().getArtifactDependencies().- Specified by:
getArtifactDependenciesin interfaceSBuild- Returns:
- artifact dependencies
-
isResponsibleNeeded
public boolean isResponsibleNeeded()
Description copied from interface:SBuildAlways returns false for personal and/or cancelled builds. Returns true if this build is failed (or failing) and there are no finished successful builds after this build. Returns true even if there is active responsible for the build configuration but the configuration status is failed.- Specified by:
isResponsibleNeededin interfaceSBuild- Returns:
- see above.
-
getLogMessages
public List<String> getLogMessages(int skipMessages, int maxCount)
Description copied from interface:BuildAllows to get messages logged for the build- Specified by:
getLogMessagesin interfaceBuild- Parameters:
skipMessages- index of the first message to load (zero based)maxCount- messages count limit.- Returns:
- list of plain messages
-
getCompilationErrorMessages
public List<String> getCompilationErrorMessages()
Description copied from interface:BuildReturns compilation error messages of this build- Specified by:
getCompilationErrorMessagesin interfaceBuild- Returns:
- list of plain messages
-
getDownloadedArtifacts
@NotNull public DownloadedArtifacts getDownloadedArtifacts()
Description copied from interface:SBuildReturns information about artifacts downloaded by this build according to configured artifact dependencies.- Specified by:
getDownloadedArtifactsin interfaceSBuild- Returns:
- information about downloaded artifacts.
-
getProvidedArtifacts
@NotNull public DownloadedArtifacts getProvidedArtifacts()
Description copied from interface:SBuildReturns information about provided artifacts, i.e. artifacts that were downloaded from this build by other builds by artifact dependencies.- Specified by:
getProvidedArtifactsin interfaceSBuild- Returns:
- see above
-
isUsedByOtherBuilds
public boolean isUsedByOtherBuilds()
Description copied from interface:SBuildReturns true if this build is used by other builds, i.e. there are dependencies by sources on this build or artifacts of this build were downloaded by other builds.- Specified by:
isUsedByOtherBuildsin interfaceSBuild- Returns:
- see above
-
getTags
public List<String> getTags()
Description copied from interface:SBuildReturns list of public tags for this build
-
setTags
public void setTags(List<String> tags)
Description copied from interface:SBuildSets public tags for this build
-
setTags
public void setTags(@Nullable User user, @Nullable List<String> tags)Description copied from interface:SBuildSets public tags for this build
-
getFileContent
@NotNull public byte[] getFileContent(String filePath) throws VcsException
Description copied from interface:SBuildGet binary content of the single file related to this build.- Specified by:
getFileContentin interfaceSBuild- Parameters:
filePath- - relative file path regarding to the project root, "checkout root" from vcs root should not be included- Returns:
- - specified file content, corresponding to the build
- Throws:
VcsException- if some problem occurred while getting file content from the source control repository.
-
getRevisions
@NotNull public List<BuildRevision> getRevisions()
Description copied from interface:SBuildList of all revisions which were used for the build instance- Specified by:
getRevisionsin interfaceSBuild- Returns:
- all revisions which were used in this build
-
getLabels
public List<VcsLabel> getLabels()
Description copied from interface:SBuildVCS labels which were made by TeamCity for the build. If label attempt fails VcsLabel status is FAILED and failureReason contains short description of the problem.
-
getFullStatistics
@NotNull public BuildStatistics getFullStatistics()
Description copied from interface:SBuildCalculates full statistics for this build. This method can be time consuming, if you do not need some parts of build statistics try to use methodSBuild.getBuildStatistics(BuildStatisticsOptions)instead.- Specified by:
getFullStatisticsin interfaceSBuild- Returns:
- full statistics for this build.
-
getBuildStatistics
@NotNull public BuildStatistics getBuildStatistics(@NotNull BuildStatisticsOptions options)
Description copied from interface:SBuildSame asSBuild.getFullStatistics()but with more control of data being loaded.- Specified by:
getBuildStatisticsin interfaceSBuild- Parameters:
options- options- Returns:
- build statistics according to specified options
-
isArtifactsExists
public boolean isArtifactsExists()
Description copied from interface:SBuildReturns true if this build has artifacts. Internal TeamCity artifacts are ignored.- Specified by:
isArtifactsExistsin interfaceSBuild- Returns:
- true if this build has artifacts
- See Also:
ArtifactsConstants.TEAMCITY_ARTIFACTS_DIR,SBuild.isHasInternalArtifactsOnly()
-
isHasInternalArtifactsOnly
public boolean isHasInternalArtifactsOnly()
Description copied from interface:SBuildReturns true if this build has only internal (hidden) artifacts.- Specified by:
isHasInternalArtifactsOnlyin interfaceSBuild- Returns:
- true if this build has internal artifacts only
- See Also:
SBuild.isArtifactsExists()
-
getQueuedDate
@NotNull public Date getQueuedDate()
Description copied from interface:SBuildReturns the date when the build was added to queue.- Specified by:
getQueuedDatein interfaceSBuild- Returns:
- queued time.
-
getServerStartDate
@NotNull public Date getServerStartDate()
Description copied from interface:SBuildReturns the timestamp when the build was removed from the queue.- Specified by:
getServerStartDatein interfaceSBuild- Returns:
- the timestamp when the build was removed from the queue.
-
getClientStartDate
@Nullable public Date getClientStartDate()
Description copied from interface:SBuildReturns the timestamp when the build was started on the build agent (in agent time)- Specified by:
getClientStartDatein interfaceSBuild- Returns:
- the timestamp when the build was started on the build agent (in agent time)
-
isStartedOnAgent
public boolean isStartedOnAgent()
Description copied from interface:SBuildReturns true if this build was started on agent.- Specified by:
isStartedOnAgentin interfaceSBuild- Returns:
- see above
-
getStartDate
@NotNull public Date getStartDate()
Description copied from interface:BuildReturns timestamp when the build start command has been sent to an agent (server-time) or remove from queue time if start command has not been sent- Specified by:
getStartDatein interfaceBuild- Returns:
- see above
-
convertToServerTime
@NotNull public Date convertToServerTime(@NotNull Date agentTime)
Description copied from interface:SBuildConverts agent time to server time by taking into account agent and server time difference.- Specified by:
convertToServerTimein interfaceSBuild- Parameters:
agentTime- time on agent- Returns:
- server time
-
convertToAgentTime
@NotNull public Date convertToAgentTime(@NotNull Date serverTime)
Description copied from interface:SBuildConverts server time to agent time by taking into account agent and server time difference.- Specified by:
convertToAgentTimein interfaceSBuild- Parameters:
serverTime- server time to convert- Returns:
- agent time
-
getRawBuildNumber
public abstract String getRawBuildNumber()
Description copied from interface:SBuildReturns raw build number (i.e. build number with unresolved parameters if they exist) in contradistinction toBuild.getBuildNumber()method which will return build number with all unresolved parameters replaced with ???.- Specified by:
getRawBuildNumberin interfaceSBuild- Returns:
- raw build number which can contain unresolved parameters
-
getBuildCounter
protected abstract long getBuildCounter()
-
getBuildPromotion
@NotNull public abstract BuildPromotionEx getBuildPromotion()
Description copied from interface:BuildPromotionOwnerReturns build promotion- Specified by:
getBuildPromotionin interfaceBuildEx- Specified by:
getBuildPromotionin interfaceBuildPromotionOwner- Returns:
- see above.
-
getSequenceBuild
public SBuild getSequenceBuild()
Description copied from interface:BuildPromotionOwnerIf associated build promotion has modification id, returns the sequence build which contains the same changes as this build promotion. I.e. returns the first build, which contains all the changes from associated build promotion. If associated build promotion already in changes sequence, returnsBuildPromotion.getAssociatedBuild()- Specified by:
getSequenceBuildin interfaceBuildPromotionOwner- Returns:
- sequence build for the same changes as for associated build promotion, or null if there are no such a build
-
getVcsRootEntries
public List<VcsRootInstanceEntry> getVcsRootEntries()
Description copied from interface:SBuildReturns vcs roots with checkout rules for the build start moment.- Specified by:
getVcsRootEntriesin interfaceSBuild- Returns:
- vcs roots with checkout rules for the build start moment.
-
getChanges
@NotNull public List<SVcsModification> getChanges(@NotNull SelectPrevBuildPolicy policy, boolean includeModificationsIfPreviousBuildIsAbsent)
Description copied from interface:BuildList of modifications detected in the version control since the previous build (selected according to the specified policy) Ordering: last detected modifications goes first in the list- Specified by:
getChangesin interfaceBuild- Specified by:
getChangesin interfaceSBuild- Parameters:
policy- can be one of the two kinds:SelectPrevBuildPolicy.SINCE_LAST_BUILD- all modifications made since previous running buildSelectPrevBuildPolicy.SINCE_LAST_SUCCESSFULLY_FINISHED_BUILD- all modifications made since previous successfully finished build
includeModificationsIfPreviousBuildIsAbsent- should the method return something if there's no previous build.- Returns:
- list of modifications
-
getContainingChanges
@NotNull public List<SVcsModification> getContainingChanges()
Description copied from interface:BuildReturns changes in this build. Same as getChanges(SelectPrevBuildPolicy.SINCE_LAST_BUILD, false) Ordering: last detected modifications goes first in the list- Specified by:
getContainingChangesin interfaceBuild- Specified by:
getContainingChangesin interfaceSBuild- Returns:
- changes in this build
-
getCommitters
public UserSet<SUser> getCommitters(@NotNull SelectPrevBuildPolicy selectPrevBuildPolicy)
Description copied from interface:BuildReturns all users who made modifications since the previous build selected according to the specified policy. Will provide results only after changes are collected for a build (i.e. afterBuildServerListener.changesLoadedevent for the build) and will only return users with matching VCS usernames set.- Specified by:
getCommittersin interfaceBuild- Specified by:
getCommittersin interfaceSBuild- Parameters:
selectPrevBuildPolicy- can be one of the two kinds:SelectPrevBuildPolicy.SINCE_LAST_BUILD- all modifications made since previous running buildSelectPrevBuildPolicy.SINCE_LAST_SUCCESSFULLY_FINISHED_BUILD- all modifications made since previous successfully finished build
- Returns:
- committers in this build according to selection policy. If the build is personal, the set contains the only user who started the build
-
isOutOfChangesSequence
public boolean isOutOfChangesSequence()
Description copied from interface:SBuildReturns true if there is a build started before but having more recent changes then this build. Such situation can occur if this build was associated with a specific change list before adding to queue at the time when more recent changes were available.- Specified by:
isOutOfChangesSequencein interfaceSBuild- Returns:
- see above
-
getTriggeredBy
@NotNull public TriggeredBy getTriggeredBy()
Description copied from interface:SBuildReturns details about how this build was triggered.- Specified by:
getTriggeredByin interfaceSBuild- Returns:
- see above
-
getBuildComment
public Comment getBuildComment()
Description copied from interface:SBuildReturns build comment.- Specified by:
getBuildCommentin interfaceSBuild- Returns:
- build comment, or null if this build is not commented.
-
setBuildComment
public void setBuildComment(@Nullable User user, @Nullable String comment)Description copied from interface:SBuildSets the comment for the build- Specified by:
setBuildCommentin interfaceSBuild- Parameters:
user- user who sets the commentcomment- text of the comment
-
isPinned
public boolean isPinned()
Description copied from interface:SBuildReturns true if this build is pinned
-
getId
public String getId()
-
hasBuildFinishParameters
public boolean hasBuildFinishParameters()
-
resetBuildFinalParameters
public void resetBuildFinalParameters()
-
getParametersProvider
@NotNull public ParametersProvider getParametersProvider()
Description copied from interface:ParametersSupportReturns parameters which can be used by value resolver. Note that some of the parameters may not have values defined because sometimes values can be calculated on the agent side only.- Specified by:
getParametersProviderin interfaceParametersSupport- Returns:
- set of build parameters known on the server-side for the build and prefixed server-side parameters of all the build dependencies
-
getShortStatistics
@NotNull public ShortStatistics getShortStatistics()
Description copied from interface:SBuildCalculates short statistics for this build. Short statistics provides "isNew" details for failed tests only. If you need information about passed, ignored tests and compilation errors useSBuild.getBuildStatistics(jetbrains.buildServer.serverSide.BuildStatisticsOptions)method.- Specified by:
getShortStatisticsin interfaceSBuild- Returns:
- short statistics for this build.
-
hasTests
public boolean hasTests()
-
createShortStatistics
@NotNull protected ShortStatistics createShortStatistics(boolean updatePersistentCaches)
-
preloadFailedTests
protected void preloadFailedTests(@NotNull ShortStatistics stats)
-
getBuildFinishParameters
@Nullable public DepParametersMemoryOptimizedMap getBuildFinishParameters()
-
getBuildStartParameters
@Nullable public DepParametersMemoryOptimizedMap getBuildStartParameters()
-
doGetBuildFinishParameters
@Nullable protected DepParametersMemoryOptimizedMap doGetBuildFinishParameters()
-
doGetBuildStartParameters
@Nullable protected DepParametersMemoryOptimizedMap doGetBuildStartParameters()
-
publishStatisticValue
public void publishStatisticValue(@NotNull String valueTypeKey, @Nullable BigDecimal value)
-
getBuildOwnParameters
@NotNull public Map<String,String> getBuildOwnParameters()
Description copied from interface:SBuildReturns map of parameters (configuration params, system properties and environment variables) excluding parameters provided by extensions.- Specified by:
getBuildOwnParametersin interfaceSBuild- Returns:
- set of build parameters known on the server-side for the build.
-
getRelatedIssues
@NotNull public Collection<Issue> getRelatedIssues()
Description copied from interface:SBuildReturns the collection of related issues (e.g. mentioned in modification's comments, or mentioned in the build's comment).- Specified by:
getRelatedIssuesin interfaceSBuild- Returns:
- related issues
- See Also:
SBuild.isHasRelatedIssues(),SVcsModification.getRelatedIssues()
-
isHasRelatedIssues
public boolean isHasRelatedIssues()
Description copied from interface:SBuildReturns whether the build has related issues (e.g. mentioned in modification's comments, or mentioned in the build's comment).- Specified by:
isHasRelatedIssuesin interfaceSBuild- Returns:
- true if the build has related issues
- See Also:
SBuild.getRelatedIssues(),SVcsModification.isHasRelatedIssues()
-
getVariablesProvider
@NotNull protected ContextVariables getVariablesProvider()
-
getValueResolver
@NotNull public ValueResolver getValueResolver()
Description copied from interface:SBuildReturns build-aware value resolver to be used to resolve values based on the build's properties.- Specified by:
getValueResolverin interfaceParametersSupport- Specified by:
getValueResolverin interfaceSBuild- Returns:
- this build-aware value resolver
-
getValueResolver
@NotNull protected ValueResolver getValueResolver(@NotNull Map<String,String> highPrioParams)
Creates value resolver where the specified map of parameters has the highest priority.
-
getValueResolver
@NotNull public ValueResolver getValueResolver(boolean preferBuildStartParameters)
Creates resolver which can use build start parameters instead of build finish params, this resolver is required to provide consistent resolving on the server for personal and non personal builds
-
getBuildNumberWithoutRefs
@NotNull @Contract("null -> !null") protected static String getBuildNumberWithoutRefs(@Nullable String curBuildNumber)
-
isInternalError
public boolean isInternalError()
Description copied from interface:SBuildReturns whether this build failed because of internal error (infrastructural error not related to build script).- Specified by:
isInternalErrorin interfaceSBuild- Returns:
- true iff the build is error
-
getFirstInternalError
public String getFirstInternalError()
Description copied from interface:SBuildReturns the first internal error in a build, or null.- Specified by:
getFirstInternalErrorin interfaceSBuild- Returns:
- first internal error type
-
getFirstInternalErrorMessage
public String getFirstInternalErrorMessage()
Description copied from interface:SBuildReturns the error message associated with the first internal error, or null- Specified by:
getFirstInternalErrorMessagein interfaceSBuild- Returns:
- first internal error message
-
getTestMessages
public List<TestInfo> getTestMessages(int skipTests, int maxTestsToLoad)
Description copied from interface:BuildRetrieves information about tests failed in the build. Note that for running build currently executing test will be added to the list too.- Specified by:
getTestMessagesin interfaceBuild- Parameters:
skipTests- index/order number of the first test to load (zero based)maxTestsToLoad- indicates how many tests to load, -1 to load all- Returns:
- list of plain messages
-
getClientTimeZone
@Nullable public TimeZone getClientTimeZone()
Description copied from interface:SBuildReturns agent machine time zone if it's available on server.- Specified by:
getClientTimeZonein interfaceSBuild- Returns:
- Agent time zone or null if the build wasn't started yet.
-
getAgent
@NotNull public abstract BuildAgentEx getAgent()
-
addBuildProblem
public void addBuildProblem(@NotNull BuildProblemData buildProblem)Description copied from interface:SBuildAdds build problem to the build. Currently build problem causes build failure.- Specified by:
addBuildProblemin interfaceSBuild
-
buildProblemsChanged
public void buildProblemsChanged(@NotNull List<BuildProblemData> before, @NotNull List<BuildProblemData> after)Description copied from interface:BuildExCalled when build problems are changed (added, deleted or muted)- Specified by:
buildProblemsChangedin interfaceBuildEx- Parameters:
before- problems before changeafter- problems after change
-
getRemoteArtifacts
@NotNull public List<RemoteArtifacts> getRemoteArtifacts()
Description copied from interface:SBuildReturns list of all remote artifacts that were published for this build.- Specified by:
getRemoteArtifactsin interfaceSBuild- Returns:
- collection of
RemoteArtifact
-
getRemoteArtifactsByType
@NotNull public RemoteArtifacts getRemoteArtifactsByType(@NotNull String type)
Description copied from interface:SBuildReturns list of remote artifacts that belong to a specific type.- Specified by:
getRemoteArtifactsByTypein interfaceSBuild- Returns:
- collection of
RemoteArtifact
-
notifyOnBuildProblemsChanged
protected abstract void notifyOnBuildProblemsChanged(@NotNull List<BuildProblemData> before, @NotNull List<BuildProblemData> after)
-
getStatus
@Nullable protected static Status getStatus(@NotNull List<BuildProblemData> before, @NotNull List<BuildProblemData> after)
-
getBuildStatus
public Status getBuildStatus()
Description copied from interface:BuildReturns current build status- Specified by:
getBuildStatusin interfaceBuild- Returns:
- Current build status
-
getFailureReasons
@NotNull public List<BuildProblemData> getFailureReasons()
Description copied from interface:SBuildReturns build problems that caused build failure or empty list if build is successful- Specified by:
getFailureReasonsin interfaceSBuild- Returns:
- see above
-
getBuildProblems
@NotNull public List<BuildProblem> getBuildProblems()
Description copied from interface:BuildExReturns all build problems for this promotion with extended information about muting This method can perform rather slow as it reloads build problems from database and fills mute info from audit (reads database as well) If you don't need mute info try usingSBuild.getFailureReasons()- Specified by:
getBuildProblemsin interfaceBuildEx- Returns:
- see above
-
hasBuildProblemOfType
public boolean hasBuildProblemOfType(@NotNull String type)Description copied from interface:SBuildReturns true if build has build problem of this type- Specified by:
hasBuildProblemOfTypein interfaceSBuild- Parameters:
type- build problem type- Returns:
- see above
- See Also:
BuildProblemData
-
muteBuildProblems
public void muteBuildProblems(boolean muteIfTrue)
Description copied from interface:BuildExMakes all existing build problems enabled or disabled- Specified by:
muteBuildProblemsin interfaceBuildEx- Parameters:
muteIfTrue- pass true to make build successful, false to make existing problems visible again
-
muteBuildProblems
public void muteBuildProblems(@NotNull SUser user, boolean muteIfTrue, @NotNull String comment)Description copied from interface:SBuildMakes all existing build problems enabled or disabled- Specified by:
muteBuildProblemsin interfaceSBuild- Parameters:
user- user that will be used in auditmuteIfTrue- pass true to make build successful, false to make existing problems visible againcomment- comment for audit
-
addUserBuildProblem
public BuildProblemData addUserBuildProblem(@NotNull SUser user, @NotNull String problemDescription)
Description copied from interface:SBuildAdds user provided build problem to the build. Currently build problem causes build failure. Adding user provided problem always overrides previously added one- Specified by:
addUserBuildProblemin interfaceSBuild- Parameters:
user- user that will be used in audit- Returns:
- added build problem
-
deleteBuildProblem
public void deleteBuildProblem(@NotNull SUser user, @NotNull String identity, @Nullable String comment)Description copied from interface:BuildExDeletes build problem Deleting build problem may change build status to SUCCESS- Specified by:
deleteBuildProblemin interfaceBuildEx- Parameters:
user- user that will be used in auditidentity- identiry of build problem to be removedcomment- comment for audit
-
getBranch
@Nullable public Branch getBranch()
-
getPreviousFinished
@Nullable public SFinishedBuild getPreviousFinished()
- Specified by:
getPreviousFinishedin interfaceSBuild- Returns:
- returns previous finished build (ordered by changes). If this build is personal, this method can return previous personal build, otherwise only regular builds are returned.
-
getAuditLogFactory
@NotNull public AuditLogFactory getAuditLogFactory()
-
getAuditLogProvider
@NotNull public AuditLogProvider getAuditLogProvider()
-
getSettingsDigestFromFile
@Nullable public static byte[] getSettingsDigestFromFile(@NotNull File artifactsDirectory)
-
getCustomDataStorage
@NotNull public CustomDataStorage getCustomDataStorage(@NotNull String key)
Description copied from interface:SBuildReturns a data storage which can be used to associate arbitrary data with the build.- Specified by:
getCustomDataStoragein interfaceSBuild- Parameters:
key- a key to access the storage- Returns:
- an existing or newly created storage for the given key
-
getCustomDataStorageIdsByPrefix
@NotNull protected Set<String> getCustomDataStorageIdsByPrefix(@NotNull String keyPrefix)
-
getTemporaryCustomDataStorage
@NotNull public CustomDataStorage getTemporaryCustomDataStorage()
-
getSettingsDigestFile
@NotNull protected File getSettingsDigestFile()
-
getStatisticValue
@Nullable public BigDecimal getStatisticValue(@NotNull String valueTypeKey)
- Specified by:
getStatisticValuein interfaceSBuild- Parameters:
valueTypeKey- ValueType key to lookup. Eg TimeSpentInQueue, ArtifactsSize, DuplicatorStats CodeCoverageB, CodeCoverageC or any custom build statistic value reported by service message during the build.- Returns:
- Value of specified ValueType. Null when specified value wasn't produced during the build (eg no artifacts produced for ArtifactsSize key) or key is invalid.
- See Also:
ValueProviderRegistry
-
getStatisticValues
@NotNull public Map<String,BigDecimal> getStatisticValues()
- Specified by:
getStatisticValuesin interfaceSBuild- Returns:
- All statistics values associated with this build. Includes all predefined ValueTypes reported for this build and custom metrics reported by service message during the build as well (even when there is no ValueType defined for the metric).
-
getBuildFeaturesOfType
@NotNull public Collection<SBuildFeatureDescriptor> getBuildFeaturesOfType(@NotNull String featureType)
Description copied from interface:SBuildReturns collection of enabled and resolved build features of specified type from build settings (resolving is performed at the moment of the method call).- Specified by:
getBuildFeaturesOfTypein interfaceSBuild- Parameters:
featureType- type of the build feature- Returns:
- see above
-
isOutdated
public boolean isOutdated()
Description copied from interface:SBuildReturns true if this build is outdated. The build is considered outdated if there is a finished non-personal build which contains newer (or same) changes as contained in this build.- Specified by:
isOutdatedin interfaceSBuild- Returns:
- see above
-
getRecentlyFinishedBuild
@Nullable public SFinishedBuild getRecentlyFinishedBuild()
- Specified by:
getRecentlyFinishedBuildin interfaceSBuild- Returns:
- the build because of which this running build has been marked as outdated (see
SBuild.isOutdated()).
-
isAgentLessBuild
public boolean isAgentLessBuild()
- Specified by:
isAgentLessBuildin interfaceSBuild- Returns:
- true if this build does not require an agent (for now this is true for composite builds only)
-
isDetachedFromAgent
public boolean isDetachedFromAgent()
Description copied from interface:SBuildReturns true if this build was detached from agent at some point.- Specified by:
isDetachedFromAgentin interfaceSBuild- Returns:
- see above
-
getDetachFromAgentReceivedTimestamp
@Nullable public Long getDetachFromAgentReceivedTimestamp()
- Specified by:
getDetachFromAgentReceivedTimestampin interfaceBuildEx- Returns:
- timestamp when this build was attempted to detach from agent
-
getWaitReasons
@NotNull public Map<String,Long> getWaitReasons()
Description copied from interface:SBuildReturns wait reasons for this build, while it was in the build queue. The key of the map is a wait reason description in human friendly form. The value is amount of milliseconds this wait reason was reported for this queued build.- Specified by:
getWaitReasonsin interfaceSBuild- Returns:
- map of a wait reason to amount of time it was reported for the build in milliseconds
-
getBuildContext
@NotNull protected BuildContext getBuildContext()
-
isTimedOut
public boolean isTimedOut()
- Specified by:
isTimedOutin interfaceBuildEx- Returns:
- true if this build finished by timeout
-
getFinishOnAgentDate
@Nullable public Date getFinishOnAgentDate()
Description copied from interface:SBuildReturns timestamp when the build finished on agent (server time) ornullif it is still running on agent.- Specified by:
getFinishOnAgentDatein interfaceSBuild- Returns:
- see above
-
nowDate
@NotNull protected Date nowDate()
-
now
protected long now()
-
updateExternalArtifactsInfoOnAccess
public void updateExternalArtifactsInfoOnAccess()
-
-