hudson.plugins.tasks
Class TasksPublisher

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.plugins.tasks.util.HealthAwarePublisher
              hudson.plugins.tasks.TasksPublisher

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class TasksPublisher
extends HealthAwarePublisher

Publishes the results of the task scanner.

Author:

Ulli Hafner

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

static TasksDescriptor

TASK_SCANNER_DESCRIPTOR Descriptor of this publisher.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

TasksPublisher(java.lang.String pattern, java.lang.String threshold, java.lang.String healthy, java.lang.String unHealthy, java.lang.String high, java.lang.String normal, java.lang.String low)
Creates a new instance of TaskScannerPublisher.

Method Summary

hudson.model.Descriptor<hudson.tasks.Publisher>	getDescriptor()
java.lang.String	getHigh() Returns the high priority task identifiers.
java.lang.String	getLow() Returns the low priority task identifiers.
java.lang.String	getNormal() Returns the normal priority task identifiers.
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Scans the workspace, collects all data files and copies these files to the build results folder.

Methods inherited from class hudson.plugins.tasks.util.HealthAwarePublisher

createHealthReporter, getHealthy, getHealthyAnnotations, getMinimumAnnotations, getPattern, getThreshold, getUnHealthy, getUnHealthyAnnotations, isHealthyReportEnabled, isThresholdEnabled

Methods inherited from class hudson.tasks.Publisher

getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

prebuild

Field Detail

TASK_SCANNER_DESCRIPTOR

public static final TasksDescriptor TASK_SCANNER_DESCRIPTOR

Descriptor of this publisher.

Constructor Detail

TasksPublisher

public TasksPublisher(java.lang.String pattern,
                      java.lang.String threshold,
                      java.lang.String healthy,
                      java.lang.String unHealthy,
                      java.lang.String high,
                      java.lang.String normal,
                      java.lang.String low)

Creates a new instance of TaskScannerPublisher.

Parameters:

pattern - Ant file-set pattern of files to scan for open tasks in

threshold - Tasks threshold to be reached if a build should be considered as unstable.

healthy - Report health as 100% when the number of open tasks is less than this value

unHealthy - Report health as 0% when the number of open tasks is greater than this value

high - tag identifiers indicating high priority

normal - tag identifiers indicating normal priority

low - tag identifiers indicating low priority

Method Detail

getHigh

public java.lang.String getHigh()

Returns the high priority task identifiers.

Returns:

the high priority task identifiers

getNormal

public java.lang.String getNormal()

Returns the normal priority task identifiers.

Returns:

the normal priority task identifiers

getLow

public java.lang.String getLow()

Returns the low priority task identifiers.

Returns:

the low priority task identifiers

getProjectAction

public hudson.model.Action getProjectAction(hudson.model.AbstractProject<?,?> project)

Specified by:

getProjectAction in interface hudson.tasks.BuildStep

Overrides:

getProjectAction in class hudson.tasks.BuildStepCompatibilityLayer

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws java.lang.InterruptedException,
                       java.io.IOException

Scans the workspace, collects all data files and copies these files to the build results folder. Then counts the number of bugs and sets the result of the build accordingly (HealthAwarePublisher.getThreshold().

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build - the build

launcher - the launcher

listener - the build listener

Returns:

true if the build could continue

Throws:

java.io.IOException - if the files could not be copied

java.lang.InterruptedException - if user cancels the operation

getDescriptor

public hudson.model.Descriptor<hudson.tasks.Publisher> getDescriptor()