de.hms.sasunit.sasunitplugin

Class SASUnitPlugInBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

de.hms.sasunit.sasunitplugin.SASUnitPlugInBuilder

All Implemented Interfaces:

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

public class SASUnitPlugInBuilder
extends hudson.tasks.Builder

Jenkins Plug-In for SASUnit, the unit testing framework for SAS. This Plug-In runs SASUnit and executes SASUnit unit tests. If specified a doxygen documentation is created as well.

Version:

0.1.0.0

Author:

Bernhard Braun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SASUnitPlugInBuilder.DescriptorImpl Descriptor for SASUnitPlugInBuilder.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields

Modifier and Type	Field and Description
static SASUnitPlugInBuilder.DescriptorImpl	DESCRIPTOR Descriptor should be singleton.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
SASUnitPlugInBuilder(String sasunitBatch, String doxygenBatch, String sasUnitVersion, boolean createDoxygenDocu) Constructor using fields

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execCmdJob(String cmd, hudson.Launcher launcher, hudson.model.BuildListener listener, hudson.FilePath rootFolder) Method to execute commands in a linux shell or windows cmd window.
hudson.model.Descriptor<hudson.tasks.Builder>	getDescriptor()
String	getDoxygenBatch()
SASUnitInstallation	getInstallation() Method loops over all available SASUnit installations and returns the one specified in the project setup.
String	getSasunitBatch()
String	getSasunitVersion()
boolean	isCreateDoxygenDocu()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR

public static final SASUnitPlugInBuilder.DescriptorImpl DESCRIPTOR

Descriptor should be singleton.

Constructor Detail

SASUnitPlugInBuilder

@DataBoundConstructor
public SASUnitPlugInBuilder(String sasunitBatch,
                                         String doxygenBatch,
                                         String sasUnitVersion,
                                         boolean createDoxygenDocu)

Constructor using fields

Parameters:

sasunitBatch - Relative path to SASUnit batch file to be executed

doxygenBatch - Relative path to Doxygen batch file to be executed

sasUnitVersion - SASUnit Version used to run the test

createDoxygenDocu - Doxygen documentation is created if set to true

Method Detail

getSasunitBatch

public String getSasunitBatch()

getDoxygenBatch

public String getDoxygenBatch()

getSasunitVersion

public String getSasunitVersion()

isCreateDoxygenDocu

public boolean isCreateDoxygenDocu()

perform

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

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

IOException

InterruptedException

getInstallation

public SASUnitInstallation getInstallation()

Method loops over all available SASUnit installations and returns the one specified in the project setup. If not found, the method returns null.

Returns:

SASUnitInstallation

execCmdJob

public boolean execCmdJob(String cmd,
                 hudson.Launcher launcher,
                 hudson.model.BuildListener listener,
                 hudson.FilePath rootFolder)

Method to execute commands in a linux shell or windows cmd window. Used to start creation of SASUnit and Doxygen reports in batch mode.

Parameters:

cmd - The String to be executed in a linux shell or windows cmd window

launcher - The Launcher of the Build

listener - The BuildListender that receives events that happen during the build

rootFolder - The FilePath in which the cmd shall be executed in

Returns:

boolean

getDescriptor

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

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder