Package jetbrains.buildServer.serverSide.impl

Class CurrentProblemsManagerImpl

java.lang.Object

jetbrains.buildServer.serverSide.ProjectsModelListenerAdapter

jetbrains.buildServer.serverSide.BuildServerAdapter

jetbrains.buildServer.serverSide.impl.CurrentProblemsManagerImpl

All Implemented Interfaces:

EventListener, BuildServerListener, CurrentProblemsManager, CurrentProblemsManagerEx, ProjectsModelListener, ServerListener

public class CurrentProblemsManagerImpl
extends BuildServerAdapter
implements CurrentProblemsManagerEx

Few implementation details:

the instance of CurrentProblemsManagerImpl holds the reference for all build types (per project) and for all build types - a reference to last normally finished build (can be null). The current problems of a build type include failed tests from the last normally finished build plus failed tests from running builds. All normally finished builds except running ones form the cache.

The instance also listens for build events - start and finish - to update the cache. Thus there is no "stop-the-world" phase collecting the cache. But if the cache isn't full enough, the first rendering of the "Current Problems" page can take some time.

Thread-safe.

Ideas for further performance improvement:

• persist the cache

Currently the manager ignores all the problems from non-default branches.

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Constructor Summary

Constructors

Constructor	Description
CurrentProblemsManagerImpl(BuildsManager buildsManager, ProblemMutingService problemMutingService, ResponsibilityManager responsibilityManager, BuildProblemManager buildProblemManager, ProjectManager projectManager, SQLRunnerEx sqlRunner, EventDispatcher<BuildServerListener> eventDispatcher)

Method Summary

Modifier and Type	Method	Description
void	buildFinished(SRunningBuild build)	Called after build finishing, only if build was not interrupted
void	buildStarted(SRunningBuild build)	Build server events.
void	buildTypeRegistered(SBuildType buildType)	Called when build configuration is created or build configuration is reloaded from the disk
void	buildTypeUnregistered(SBuildType buildType)	Called when build configuration is deleted
Map<TestName,List<STestRun>>	getCurrentProblems(SBuildType bt, long lastNormalBuildId)
Map<TestName,List<STestRun>>	getFailingTests(SProject project)	Calculates and returns currently failing tests (including muted) with corresponding test runs in the specified project
Map<TestName,List<STestRun>>	getMutedOnlyProblems(SBuildType bt, long lastNormalBuildId)
CurrentProblems	getProblemsForProject(SProject project)	Calculates and returns current project problems.
List<STestRun>	getProblemsInRunningBuilds(SProject project, Collection<Long> testNameIds, boolean includingMutedProblems, boolean inAllBranches)	Returns the list of test runs in which the tests is currently failing, from running builds only.
ProblemsSummary	getProblemsSummary(Map<SProject,List<SBuildType>> buildTypes)	Returns the problems summary for the projects and build types specified.
static boolean	isFinishedNormally(SBuild build)	Returns whether a build is finished normally, i.e.
static boolean	isFromDefaultBranch(SBuild build)	Returns whether a build is from the default branch.

Methods inherited from class jetbrains.buildServer.serverSide.BuildServerAdapter

agentDescriptionUpdated, agentRegistered, agentRemoved, agentRemoved, agentsDescriptionUpdated, agentStatusChanged, agentUnregistered, agentUnregistered, beforeAgentUnregistered, beforeBuildFinish, beforeEntryDelete, beforeServerConfigurationLoaded, buildArtifactsChanged, buildChangedStatus, buildCommented, buildDetachedFromAgent, buildInterrupted, buildPinned, buildProblemsChanged, buildProblemsMuted, buildProblemsUnmuted, buildPromotionTagsChanged, buildQueueOrderChanged, buildRemovedFromQueue, buildTagsChanged, buildTagsChanged, buildTypeAddedToQueue, buildTypeAddedToQueue, buildUnpinned, changeAdded, changesLoaded, changesLoaded, cleanupFinished, cleanupStarted, entriesDeleted, entryCreated, entryDeleted, labelingFailed, labelingSucceed, messageReceived, pluginsLoaded, responsibleChanged, responsibleChanged, responsibleChanged, responsibleChanged, responsibleRemoved, responsibleRemoved, serverConfigurationReloaded, serverShutdown, serverShutdownComplete, serverStartup, sourcesVersionReleased, sourcesVersionReleased, sourcesVersionReleased, statisticValuePublished, testsMuted, testsUnmuted

Methods inherited from class jetbrains.buildServer.serverSide.ProjectsModelListenerAdapter

beforeBuildTypeDeleted, beforeBuildTypesDeleted, buildTypeActiveStatusChanged, buildTypeDeleted, buildTypeDescriptionUpdated, buildTypeExternalIdChanged, buildTypeMoved, buildTypePersisted, buildTypeRenamed, buildTypeTemplateDeleted, buildTypeTemplateDeleted, buildTypeTemplateExternalIdChanged, buildTypeTemplateMoved, buildTypeTemplatePersisted, buildTypeTemplateRestored, projectArchived, projectCreated, projectDearchived, projectDescriptionUpdated, projectExternalIdChanged, projectFeatureAdded, projectFeatureChanged, projectFeatureRemoved, projectMoved, projectPersisted, projectPluginDataFileRemoved, projectPluginDataFileSaved, projectRemoved, projectRemoved, projectRenamed, projectRestored, vcsRootExternalIdChanged, vcsRootMoved, vcsRootPersisted, vcsRootRemoved, vcsRootsPersisted, vcsRootUpdated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jetbrains.buildServer.serverSide.ProjectsModelListener

beforeBuildTypeDeleted, beforeBuildTypesDeleted, buildTypeActiveStatusChanged, buildTypeDeleted, buildTypeDescriptionUpdated, buildTypeExternalIdChanged, buildTypeMoved, buildTypePersisted, buildTypeRenamed, buildTypeTemplateDeleted, buildTypeTemplateDeleted, buildTypeTemplateExternalIdChanged, buildTypeTemplateMoved, buildTypeTemplatePersisted, buildTypeTemplateRestored, projectArchived, projectCreated, projectDearchived, projectDescriptionUpdated, projectExternalIdChanged, projectFeatureAdded, projectFeatureChanged, projectFeatureRemoved, projectMoved, projectPersisted, projectPluginDataFileRemoved, projectPluginDataFileSaved, projectRemoved, projectRemoved, projectRenamed, projectRestored, vcsRootExternalIdChanged, vcsRootMoved, vcsRootPersisted, vcsRootRemoved, vcsRootsPersisted, vcsRootUpdated

Constructor Detail

CurrentProblemsManagerImpl

public CurrentProblemsManagerImpl(@NotNull
                                  BuildsManager buildsManager,
                                  @NotNull
                                  ProblemMutingService problemMutingService,
                                  @NotNull
                                  ResponsibilityManager responsibilityManager,
                                  @NotNull
                                  BuildProblemManager buildProblemManager,
                                  @NotNull
                                  ProjectManager projectManager,
                                  @NotNull
                                  SQLRunnerEx sqlRunner,
                                  @NotNull
                                  EventDispatcher<BuildServerListener> eventDispatcher)

Method Detail

getProblemsForProject

@NotNull
public CurrentProblems getProblemsForProject(@NotNull
                                             SProject project)

Description copied from interface: CurrentProblemsManager

Calculates and returns current project problems. All running builds are taken into account.

Specified by:

getProblemsForProject in interface CurrentProblemsManager

Parameters:

project - the project

Returns:

current project problems

getFailingTests

@NotNull
public Map<TestName,List<STestRun>> getFailingTests(@NotNull
                                                          SProject project)

Description copied from interface: CurrentProblemsManager

Calculates and returns currently failing tests (including muted) with corresponding test runs in the specified project

Specified by:

getFailingTests in interface CurrentProblemsManager

Returns:

see above

getProblemsInRunningBuilds

@NotNull
public List<STestRun> getProblemsInRunningBuilds(@NotNull
                                                 SProject project,
                                                 @NotNull
                                                 Collection<Long> testNameIds,
                                                 boolean includingMutedProblems,
                                                 boolean inAllBranches)

Description copied from interface: CurrentProblemsManagerEx

Returns the list of test runs in which the tests is currently failing, from running builds only.

Specified by:

getProblemsInRunningBuilds in interface CurrentProblemsManagerEx

Parameters:

project - the project

testNameIds - the test names

includingMutedProblems - if true, muted tests are considered a problem

Returns:

the list of test runs

getProblemsSummary

@NotNull
public ProblemsSummary getProblemsSummary(@NotNull
                                          Map<SProject,List<SBuildType>> buildTypes)

Description copied from interface: CurrentProblemsManager

Returns the problems summary for the projects and build types specified. All current problems (including ones from the running builds) and investigations are taken into account.

Specified by:

getProblemsSummary in interface CurrentProblemsManager

Parameters:

buildTypes - the map of build types to get summary for

Returns:

problems summary

buildStarted

public void buildStarted(@NotNull
                         SRunningBuild build)

Build server events.

Specified by:

buildStarted in interface BuildServerListener

Overrides:

buildStarted in class BuildServerAdapter

Parameters:

build - build configuration whose status has changed

buildFinished

public void buildFinished(@NotNull
                          SRunningBuild build)

Description copied from interface: BuildServerListener

Called after build finishing, only if build was not interrupted

Specified by:

buildFinished in interface BuildServerListener

Overrides:

buildFinished in class BuildServerAdapter

Parameters:

build - running build // TODO: shall pass SFinishedBuild as parameter

buildTypeUnregistered

public void buildTypeUnregistered(@NotNull
                                  SBuildType buildType)

Description copied from interface: ProjectsModelListener

Called when build configuration is deleted

Specified by:

buildTypeUnregistered in interface ProjectsModelListener

Overrides:

buildTypeUnregistered in class ProjectsModelListenerAdapter

Parameters:

buildType - unregistered build configuration

buildTypeRegistered

public void buildTypeRegistered(@NotNull
                                SBuildType buildType)

Description copied from interface: ProjectsModelListener

Called when build configuration is created or build configuration is reloaded from the disk

Specified by:

buildTypeRegistered in interface ProjectsModelListener

Overrides:

buildTypeRegistered in class ProjectsModelListenerAdapter

Parameters:

buildType - registered build configuration

isFinishedNormally

public static boolean isFinishedNormally(@NotNull
                                         SBuild build)

Returns whether a build is finished normally, i.e. because of failed tests. Compilation errors, checkout errors, OOM, etc are not considered normal.

Parameters:

build - the build

Returns:

true iff build is finished normally

isFromDefaultBranch

public static boolean isFromDefaultBranch(@NotNull
                                          SBuild build)

Returns whether a build is from the default branch.

Parameters:

build - the build to check

Returns:

true iff build is from the default branch.

getCurrentProblems

@Nullable
public Map<TestName,List<STestRun>> getCurrentProblems(@NotNull
                                                             SBuildType bt,
                                                             long lastNormalBuildId)

getMutedOnlyProblems

@NotNull
public Map<TestName,List<STestRun>> getMutedOnlyProblems(@NotNull
                                                               SBuildType bt,
                                                               long lastNormalBuildId)