com.axis.system.jenkins.plugins.downstream.cache

Class BuildCache

java.lang.Object

com.axis.system.jenkins.plugins.downstream.cache.BuildCache

public class BuildCache
extends Object

Cache responsible for keeping track of the upstream to downstream mapping. The initial scan takes approximately 1 second per 50k builds.

Author:

Gustaf Lundh (C) Axis 2018

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuildCache.BuildComparator Allows returned downstreamBuild Sets to be sorted first by project name and then by number.
static class	BuildCache.QueueTaskComparator

Constructor Summary

Constructors

Constructor and Description
BuildCache()

Method Summary

Modifier and Type	Method and Description
void	doGarbageCollect()
static BuildCache	getCache() Returns the instance of this class.
Set<hudson.model.Run>	getDownstreamBuilds(hudson.model.Run run) Returns all downstream builds triggered by the upstream builds.
Set<hudson.model.Run>	getDownstreamBuildsByProject(hudson.model.Run upstreamBuild, hudson.model.Job downstreamProject) Fetches all downstream builds belonging to the specified project.
static Set<hudson.model.Queue.Item>	getDownstreamQueueItems(hudson.model.Queue.Item[] items, hudson.model.Run run) Helper method to find downstream Queue.Items triggered by Run.
static Set<hudson.model.Queue.Item>	getDownstreamQueueItems(hudson.model.Run run) Helper method to find downstream Queue.Items triggered by Run.
String	getStatistics() Builds a summary report of the cache
static void	initCache() Initialize the cache after all jobs are loaded.
void	reloadCache() Clears and reloads cache from disk.
protected void	removeFromCache(hudson.model.Run run) Remove a run from the cache.
void	startGarbageCollector()
static void	stop()
void	stopGarbageCollector()
protected void	updateCache(hudson.model.Run downstreamRun) Parses upstream causes in a downstream build and updates the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildCache

public BuildCache()

Method Detail

getCache

public static BuildCache getCache()

Returns the instance of this class.

Returns:

the instance.

initCache

@Initializer(after=JOB_LOADED)
public static void initCache()

Initialize the cache after all jobs are loaded.

stop

@Terminator
public static void stop()
                             throws Exception

Throws:

Exception

getDownstreamQueueItems

public static Set<hudson.model.Queue.Item> getDownstreamQueueItems(hudson.model.Run run)

Helper method to find downstream Queue.Items triggered by Run.

Parameters:

run - The upstream build

Returns:

Queue.Items that has run as upstream cause

getDownstreamQueueItems

public static Set<hudson.model.Queue.Item> getDownstreamQueueItems(hudson.model.Queue.Item[] items,
                                                                   hudson.model.Run run)

Helper method to find downstream Queue.Items triggered by Run.

Since Queue.getItems() is validating readability permissions on every queue item, this method allows for providing a cached version of the Queue.Items. This is helpful if many Queue downstream look-ups are needed within a very short span of time.

Parameters:

items - The cached version of Queue.getItems()

run - The upstream build

Returns:

Queue.Items that has run as upstream cause

reloadCache

public void reloadCache()

Clears and reloads cache from disk. Should be executed on Jenkins startup after builds are loaded.

E.g. @Initializer(after = JOB_LOADED)

updateCache

protected void updateCache(hudson.model.Run downstreamRun)

Parses upstream causes in a downstream build and updates the cache.

Parameters:

downstreamRun - Downstream build to update the cache with

doGarbageCollect

public void doGarbageCollect()

stopGarbageCollector

public void stopGarbageCollector()

startGarbageCollector

public void startGarbageCollector()

getDownstreamBuilds

public Set<hudson.model.Run> getDownstreamBuilds(hudson.model.Run run)

Returns all downstream builds triggered by the upstream builds.

Parameters:

run - The upstream build

Returns:

Downstream builds or empty set if none is found

getStatistics

public String getStatistics()

Builds a summary report of the cache

Returns:

A summarized view of the content of the cache

removeFromCache

protected void removeFromCache(hudson.model.Run run)

Remove a run from the cache. First from values (downstream builds) and then the key (upstream build).

Parameters:

run - The run to remove from the cache.

getDownstreamBuildsByProject

public Set<hudson.model.Run> getDownstreamBuildsByProject(hudson.model.Run upstreamBuild,
                                                          hudson.model.Job downstreamProject)

Fetches all downstream builds belonging to the specified project.

Parameters:

upstreamBuild - The upstream build

downstreamProject - The downstream project

Returns:

Downstream builds belonging to the upstream build and filtered by the downstream project.