PerformanceTestReport (jenkins-library 1.4.0 API)

jenkins_shared_library.performance.PerformanceTestReport

Class to work with performance test report.

Example:

     def rpt = new PerformanceTestReport(this)
     rpt.generateCpuChart(testReport)

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`reportDir` Reports folder to store html report
`java.lang.Object`	`steps` Reference to the groovy pipeline variable.

Constructor Summary

Constructors
Constructor and description
`PerformanceTestReport (java.lang.Object steps)` Constructs the class.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.Map`	`generateCpuChartForOneTest(java.lang.Object testReport)` Generate CPU Time Chart
	`void`	`generateCpuChartHtmlReport(java.lang.Object reportFile)` Generate CPU Time Chart
	`java.lang.String`	`getSanitizedTestName(java.lang.Object testReport)` Return sanitized test name
	`void`	`updatePlot(java.lang.Object reportFile)` Update plot
	`void`	`updatePlotForOneTest(java.lang.Object testReport)` Update plot CSV for one test

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.lang.String reportDir
    
    Reports folder to store html report
    Default:
    'reports'
  - java.lang.Object steps
    
    Reference to the groovy pipeline variable.
- Constructor Detail
  - PerformanceTestReport(java.lang.Object steps)
    
    Constructs the class.
    When invoking from a Jenkins pipeline script, the Pipeline must be passed the current environment of the Jenkinsfile to have access to the steps.
    Example:
    def o = new PerformanceTestReport(this)
    Parameters:
    steps - The workflow steps object provided by the Jenkins pipeline
- Method Detail
  - java.util.Map generateCpuChartForOneTest(java.lang.Object testReport)
    
    Generate CPU Time Chart
    Parameters:
    testReport - test report object of one test
    Returns:
    Map contains: sanitizedName, html, js
  - void generateCpuChartHtmlReport(java.lang.Object reportFile)
    
    Generate CPU Time Chart
    Parameters:
    reportFile - report yaml file
    Returns:
    Map contains: sanitizedName, html, js
  - java.lang.String getSanitizedTestName(java.lang.Object testReport)
    
    Return sanitized test name
    Parameters:
    testReport - test report object of one test
  - void updatePlot(java.lang.Object reportFile)
    
    Update plot
    Parameters:
    reportFile - report yaml file
  - void updatePlotForOneTest(java.lang.Object testReport)
    
    Update plot CSV for one test
    Parameters:
    testReport - test report object of one test

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class PerformanceTestReport

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String reportDir

java.lang.Object steps

Constructor Detail

PerformanceTestReport(java.lang.Object steps)

Method Detail

java.util.Map generateCpuChartForOneTest(java.lang.Object testReport)

void generateCpuChartHtmlReport(java.lang.Object reportFile)

java.lang.String getSanitizedTestName(java.lang.Object testReport)

void updatePlot(java.lang.Object reportFile)

void updatePlotForOneTest(java.lang.Object testReport)