Package hudson.plugins.robot

Class RobotPublisher

java.lang.Object
hudson.tasks.BuildStepCompatibilityLayer
hudson.tasks.Publisher
hudson.tasks.Recorder
hudson.plugins.robot.RobotPublisher
All Implemented Interfaces:
ExtensionPoint, hudson.matrix.MatrixAggregatable, Describable<Publisher>, BuildStep, Serializable, SimpleBuildStep
public class RobotPublisher extends Recorder implements Serializable, hudson.matrix.MatrixAggregatable, SimpleBuildStep
See Also:

  • Field Details

  • Constructor Details

    • RobotPublisher

      @DataBoundConstructor public RobotPublisher(String archiveDirName, String outputPath, String outputFileName, boolean disableArchiveOutput, String reportFileName, String logFileName, double passThreshold, double unstableThreshold, boolean countSkippedTests, String otherFiles, boolean enableCache, String overwriteXAxisLabel, boolean useArtifactManager)
      Create new publisher for Robot Framework results
      Parameters:
      archiveDirName - Name of Archive dir
      outputPath - Path to Robot Framework's output files
      outputFileName - Name of Robot output xml
      disableArchiveOutput - Disable Archiving output xml file to server
      reportFileName - Name of Robot report html
      logFileName - Name of Robot log html
      passThreshold - Threshold of test pass percentage for successful builds
      unstableThreshold - Threshold of test pass percentage for unstable builds
      otherFiles - Other files to be saved
      enableCache - True if caching is used
      useArtifactManager - True if Artifact Manager is used

  • Method Details

    • getArchiveDirName

      public String getArchiveDirName()
      Gets the name of archive dir. Reverts to default if empty or whitespace.
      Returns:
      the name of archive dir

    • getOutputPath

      public String getOutputPath()
      Gets the output path of Robot files
      Returns:
      the output path of Robot files

    • getOutputFileName

      public String getOutputFileName()
      Gets the name of output xml file. Reverts to default if empty or whitespace.
      Returns:
      the name of output xml file

    • getDisableArchiveOutput

      public boolean getDisableArchiveOutput()
      Get the value of disable Archive of output xml checkbox
      Returns:
      the value of disable Archive of output xml checkbox

    • getReportFileName

      public String getReportFileName()
      Gets the name of report html file. Reverts to default if empty or whitespace.
      Returns:
      the name of report html file

    • getLogFileName

      public String getLogFileName()
      Gets the name of log html file. Reverts to default if empty or whitespace.
      Returns:
      the name of log html file

    • getPassThreshold

      public double getPassThreshold()
      Gets the test pass percentage threshold for successful builds.
      Returns:
      the test pass percentage threshold for successful builds

    • getUnstableThreshold

      public double getUnstableThreshold()
      Gets the test pass percentage threshold for unstable builds.
      Returns:
      the test pass percentage threshold for unstable builds

    • getCountSkippedTests

      public boolean getCountSkippedTests()
      Gets if skipped tests should be counted in the thresholds.
      Returns:
      true if skipped tests should be counted in the thresholds

    • getEnableCache

      public boolean getEnableCache()
      Gets value of enableCache
      Returns:
      true if cache is enabled

    • getOtherFiles

      public String getOtherFiles()
      Gets the comma separated list of other filemasks to copy into build dir
      Returns:
      List of files as string

    • getOverwriteXAxisLabel

      public String getOverwriteXAxisLabel()
      Gets the value of overwriteXAxisLabel
      Returns:
      X axis label for the trend

    • getUseArtifactManager

      public boolean getUseArtifactManager()
      Gets value of useArtifactManager
      Returns:
      true if Artifact Manager is used

    • getProjectActions

      public Collection<Action> getProjectActions(AbstractProject<?,?> project)
      Specified by:
      getProjectActions in interface BuildStep
      Overrides:
      getProjectActions in class BuildStepCompatibilityLayer

    • parse

      protected RobotResult parse(String expandedTestResults, String expandedLogFileName, String expandedReportFileName, String outputPath, Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener) throws IOException, InterruptedException
      Throws:
      IOException
      InterruptedException

    • perform

      public void perform(Run<?,?> build, @NonNull FilePath workspace, @NonNull EnvVars buildEnv, @NonNull Launcher launcher, @NonNull TaskListener listener) throws InterruptedException, IOException
      Specified by:
      perform in interface SimpleBuildStep
      Throws:
      InterruptedException
      IOException

    • copyFilesToDestination

      public void copyFilesToDestination(Run<?,?> build, FilePath workspace, String inputPath, String filemaskToCopy, Launcher launcher, TaskListener listener) throws IOException, InterruptedException
      Copy files with given filemasks from input path relative to build into local build archive dir or artifact manager destination
      Parameters:
      build - The Jenkins run
      workspace - Build workspace
      inputPath - Base path for copy. Relative to build workspace.
      filemaskToCopy - List of Ant GLOB style filemasks to copy from dirs specified at inputPathMask
      launcher - A way to start processes
      listener - A place to send output
      Throws:
      IOException - thrown exception
      InterruptedException - thrown exception

    • copyFilesToBuildDir

      public void copyFilesToBuildDir(Run<?,?> build, FilePath workspace, String inputPath, String filemaskToCopy) throws IOException, InterruptedException
      Copy files with given filemasks from input path relative to build into local build file archive dir
      Parameters:
      build - The Jenkins run
      inputPath - Base path for copy. Relative to build workspace.
      filemaskToCopy - List of Ant GLOB style filemasks to copy from dirs specified at inputPathMask
      workspace - Build workspace
      Throws:
      IOException - thrown exception
      InterruptedException - thrown exception

    • archiveFilesToDestination

      public void archiveFilesToDestination(Run<?,?> build, FilePath workspace, String inputPath, String artifactsFilemask, Launcher launcher, TaskListener listener) throws IOException, InterruptedException
      Copy files with given filemasks from input path relative to Artifact Manager
      Parameters:
      build - The Jenkins run
      workspace - Build workspace
      inputPath - Base path for copy. Relative to build workspace.
      artifactsFilemask - List of Ant GLOB style filemasks to copy from dirs specified at inputPathMask
      launcher - A way to start processes
      listener - A place to send output
      Throws:
      IOException - thrown exception
      InterruptedException - thrown exception

    • trimSuffix

      public static String trimSuffix(String filename)
      Return filename without file suffix.
      Parameters:
      filename - Filename with suffix
      Returns:
      filename as string

    • getSuffix

      public static String getSuffix(String filename)
      Return file suffix from string.
      Parameters:
      filename - Filename with suffix
      Returns:
      file suffix as string

    • getBuildResult

      protected Result getBuildResult(Run<?,?> build, RobotResult result)
      Determines the build result based on set thresholds. If build is already failed before the tests it won't be changed to successful.
      Parameters:
      build - Build to be evaluated
      result - Results associated to build
      Returns:
      Result of build

    • getRequiredMonitorService

      public BuildStepMonitor getRequiredMonitorService()
      Specified by:
      getRequiredMonitorService in interface BuildStep

    • createAggregator

      public hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild build, Launcher launcher, BuildListener listener)
      Specified by:
      createAggregator in interface hudson.matrix.MatrixAggregatable