The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
loadRunnerTest: Run LoadRunner performance scenario testsrunLoadRunnerScript: Run LoadRunner scriptsseBuildAndPublish: Execute tests using ALM Lab Management and Publish tests resultcollectBranchesToAlmOctane: ALM Octane branch collectorcommonResultUploadBuilder: Upload test result to ALM using field mappingpublishGherkinResults: ALM Octane Cucumber test reporterexecuteTestsFromAlmOctane: Execute tests from Alm Octane (Tech Preview)healthAnalyzer: Micro Focus Health Analyzerstep([$class: 'JobConfigRebrander']): Fix old Micro Focus Jenkins buildsstep([$class: 'MigrateAlmCredentialsBuilder']): Migrate ALM CredentialspcBuild: Execute performance test using LoadRunner EnterprisecollectPullRequestsToAlmOctane: ALM Octane pull-request collectorrunFromAlmBuilder: Execute Micro Focus functional tests from Micro Focus ALMrunFromFSBuilder: Execute Micro Focus tests from file systemstep([$class: 'RunLoadRunnerScript']): Run LoadRunner scriptpublishMicroFocusTestResults: Publish Micro Focus tests resultaddALMOctaneSonarQubeListener: ALM Octane SonarQube listenersseBuild: Execute Micro Focus tests using Micro Focus ALM Lab Managementstep([$class: 'SvChangeModeBuilder']): SV: Change Mode of Virtual Servicestep([$class: 'SvDeployBuilder']): SV: Deploy Virtual Servicestep([$class: 'SvExportBuilder']): SV: Export Virtual Servicestep([$class: 'SvUndeployBuilder']): SV: Undeploy Virtual ServiceuploadResultToALM: Upload test result to ALMconvertTestsToRun: ALM Octane testing framework converterpublishCodeCoverage: ALM Octane code coverage publishersvChangeModeStep: SV: Change Mode of Virtual ServicesvDeployStep: SV: Deploy Virtual ServicesvExportStep: SV: Export Virtual ServicesvUndeployStep: SV: Undeploy Virtual ServiceuftScenarioLoad: Run UFT scenarioloadRunnerTest: Run LoadRunner performance scenario teststestPaths
StringarchiveTestResultsMode
StringanalysisTemplate (optional)
StringcontrollerPollingInterval (optional)
StringdisplayController (optional)
StringfsTimeout (optional)
StringignoreErrorStrings (optional)
StringperScenarioTimeOut (optional)
StringscriptRTSSetModel (optional)
scripts
scriptName
StringadditionalAttributes
name
Stringvalue
Stringdescription
StringsummaryDataLogModel (optional)
logVusersStates
booleanlogErrorCount
booleanlogTransactionStatistics
booleanpollingInterval
StringsseBuildAndPublish: Execute tests using ALM Lab Management and Publish tests resultalmServerName
StringalmProject
StringcredentialsId
StringclientType
StringalmDomain
StringrunType
StringalmEntityId
StringtimeslotDuration
StringarchiveTestResultsMode
StringcdaDetails (optional)
deploymentAction
StringdeployedEnvironmentName
StringdeprovisioningAction
Stringdescription (optional)
StringenvironmentConfigurationId (optional)
StringpostRunAction (optional)
StringcollectBranchesToAlmOctane: ALM Octane branch collector| SCM Tool | Supported types of authentication | How to create PAT (Personal access token) |
| Bitbucket Server | User/password and PAT | Click on your profile icon -> Manage account -> Personal access tokens -> Create a token (Assign Read permissions for both Projects and Repositories) |
| Github Cloud | PAT only | Click on your profile icon -> Settings -> Developer settings -> Personal access tokens -> Generate new token (Uncheck all scopes to grants read-only access) |
| Github Server | User/password and PAT |
configurationId
StringworkspaceId
StringscmTool
StringrepositoryUrl
StringcredentialsId
Stringfilter
StringuseSSHFormat (optional)
booleancommonResultUploadBuilder: Upload test result to ALM using field mappingalmServerName
StringcredentialsId
StringalmDomain
StringclientType
StringalmProject
StringalmTestFolder
StringalmTestSetFolder
StringtestingResultFile
StringrunStatusMapping
Run status mapping field is for mapping the test result's status values to ALM run status value. Yaml key represents the test result run status value. You should first set the status field in field mapping. Yaml value represents the ALM run status values. There are following status in ALM:
No Run
Passed
Failed
Blocked
Not Completed
StringfieldMapping
Field mapping content is a yaml format configuration. Three sections are required. They are 'testset', 'test' and 'run'. Each section should has a 'root' property indicates the root node of the testset or test or run. Please note that test's root is based on testset's root. Run's root is based on test's root.
Beside root, you can define any field you want to upload as an ALM entity. Yaml key represents the entity's field name. Yaml value represents the entity's field value.
If you want to upload a value to a User defined field, you could use a key starts with 'udf|' follows by the UDF label. Such as 'udf-duration' would upload value to a UDF field which has label as 'duration'.
For the yaml value part, there're two types of value. Value starts with 'x:' means the following value represents the xpath in the test result file. Value starts with 'v:' means the following value is a string value which would be applied to every entity.
You can use '|' in yame value for combining several parts together.
Sample test result: <?xml version='1.0' encoding='UTF-8'?> <result> <suites> <suite> <file>Changes file</file> <name>Changes Test Set 1</name> <duration>2.293</duration> <cases> <case> <duration>8.293</duration> <className>ChangesManagement</className> <testName>test1</testName> <testVersion>4.0</testVersion> <skipped>false</skipped> <failedSince>0</failedSince> </case> <case> <duration>8.293</duration> <className>ChangesManagement</className> <testName>List changes 2</testName> <testVersion>4.0</testVersion> <skipped>false</skipped> <failedSince>0</failedSince> </case> </cases> </suite> <duration>0.576</duration> </result> Sample field mapping: testset: root: "x:/result/suites/suite" name: "x:file|v:_|x:name" udf|duration: "x:duration" subtype-id: "v:hp.qc.test-set.external" test: root: "x:cases/case" name: "x:testName" subtype-id: "v:EXTERNAL-TEST" udf|duration: "x:duration" udf|test version: "x:testVersion" run: root: "x:." duration: "x:duration" status: "x:failedSince"StringcreateNewTest
booleanpublishGherkinResults: ALM Octane Cucumber test reporter To use the feature, ensure that you have added a Publish JUnit test results post-build action to your build. Then, specify the path to the Cucumber report XML files in the Ant glob syntax.
You can specify multiple patterns by separating them with commas.
This path should only contain Cucumber report files. Note that no other test types will be reported from this job.
cucumberResultsGlob
StringexecuteTestsFromAlmOctane: Execute tests from Alm Octane (Tech Preview)| Mode | Explanation |
| Execute suite runs in ALM Octane | Execute suites according to specified suite IDs. New suite runs will be created and executed in ALM Octane. Jenkins job is finished after triggering the suite runs. The job does not wait until the suite runs are finished. This method is useful if you want to schedule suite execution in ALM Octane. By default, newly created suite runs will have name of suite and will be assigned to default release. In order to override this default behaviour, add following parameters (one or more) to job with your desired values:
|
| Get tests from suites and trigger execution jobs | Get tests from suites and trigger execution jobs : Get tests from specified suite IDs. (This method assumes that tests are assigned to test runner jobs from the current Jenkins.) Tests are send to execution by their assigned test runner jobs. The main job is finished after the test runner jobs are finished. This method is useful if you intend to add your job to the ALM Octane Pipeline module. |
configurationId
StringworkspaceId
StringexecutionMode
Stringids
StringhealthAnalyzer: Micro Focus Health Analyzerproducts
$class: 'HealthAnalyzerLrStep'checkLrInstallation
booleancheckOsVersion
booleancheckFiles
filesList
field
StringpcBuild: Execute performance test using LoadRunner EnterpriseserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestId
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
StringauthenticateWithToken
booleancollectPullRequestsToAlmOctane: ALM Octane pull-request collector| SCM Tool | Supported types of authentication | How to create PAT (Personal access token) |
| Bitbucket Server | User/password and PAT | Click on your profile icon -> Manage account -> Personal access tokens -> Create a token (Assign Read permissions for both Projects and Repositories) |
| Github Cloud | PAT only | Click on your profile icon -> Settings -> Developer settings -> Personal access tokens -> Generate new token (Uncheck all scopes to grants read-only access) |
| Github Server | User/password and PAT |
configurationId
StringworkspaceId
StringscmTool
StringrepositoryUrl
StringcredentialsId
StringsourceBranchFilter
StringtargetBranchFilter
StringuseSSHFormat (optional)
booleanrunFromAlmBuilder: Execute Micro Focus functional tests from Micro Focus ALMalmServerName
StringalmCredentialsScope
StringalmUserName
StringalmPassword
StringalmDomain
StringalmProject
StringalmTestSets
StringalmRunResultsMode
StringalmTimeout
StringalmRunMode
StringalmRunHost
StringalmClientID
StringalmApiKey
StringisSSOEnabled
booleanisFilterTestsEnabled (optional)
booleanfilterTestsModel (optional)
blockedCheckbox
booleanfailedCheckbox
booleannotCompletedCheckbox
booleannoRunCheckbox
booleanpassedCheckbox
booleantestName (optional)
StringalmServerSettingsModel (optional)
almServerName
StringalmServerUrl
StringalmCredentials
almUsername
StringalmPassword
StringalmSSOCredentials
almClientID
StringalmApiKeySecret
StringrunFromFSBuilder: Execute Micro Focus tests from file systemfsTests
StringfileSystemTestSetModel
fileSystemTestSet
tests
StringparallelRunnerEnvironments
environment
StringenvironmentType
StringsummaryDataLogModel
logVusersStates
booleanlogErrorCount
booleanlogTransactionStatistics
booleanpollingInterval
StringscriptRTSSetModel
scripts
scriptName
StringadditionalAttributes
name
Stringvalue
Stringdescription
StringisParallelRunnerEnabled (optional)
booleanuftSettingsModel (optional)
selectedNode (optional)
StringnumberOfReruns (optional)
StringcleanupTest (optional)
StringonCheckFailedTest (optional)
StringfsTestType (optional)
StringrerunSettingsModels (optional)
test (optional)
Stringchecked (optional)
booleannumberOfReruns (optional)
intcleanupTest (optional)
StringanalysisTemplate (optional)
StringcontrollerPollingInterval (optional)
StringdisplayController (optional)
StringfsAutActions (optional)
StringfsDeviceId (optional)
StringfsDevicesMetrics (optional)
StringfsExtraApps (optional)
StringfsInstrumented (optional)
StringfsJobId (optional)
StringfsLaunchAppName (optional)
StringfsManufacturerAndModel (optional)
StringfsOs (optional)
StringfsPassword (optional)
StringfsReportPath (optional)
StringfsTargetLab (optional)
StringfsTimeout (optional)
StringfsUftRunMode (optional)
StringfsUserName (optional)
StringignoreErrorStrings (optional)
StringmcServerName (optional)
StringmcTenantId (optional)
StringperScenarioTimeOut (optional)
StringproxySettings (optional)
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
class hudson.util.SecretresultFileNames (optional)
java.util.Map<java.lang.Long, java.lang.String>useSSL (optional)
booleanpublishMicroFocusTestResults: Publish Micro Focus tests resultarchiveTestResultsMode
StringaddALMOctaneSonarQubeListener: ALM Octane SonarQube listenerpushCoverage (optional)
booleanpushVulnerabilities (optional)
booleanskipWebhookCreation (optional)
booleansonarServerUrl (optional)
StringsonarToken (optional)
StringsseBuild: Execute Micro Focus tests using Micro Focus ALM Lab ManagementalmServerName
StringalmProject
StringcredentialsId
StringclientType
StringalmDomain
StringrunType
StringalmEntityId
StringtimeslotDuration
StringcdaDetails (optional)
deploymentAction
StringdeployedEnvironmentName
StringdeprovisioningAction
Stringdescription (optional)
StringenvironmentConfigurationId (optional)
StringpostRunAction (optional)
Stringstep([$class: 'SvChangeModeBuilder']): SV: Change Mode of Virtual ServiceserverName
Stringforce
booleanmode
OFFLINE, SIMULATING, STAND_BY, LEARNINGdataModel
selectionType
BY_NAME, NONE, DEFAULTdataModel
StringperformanceModel
selectionType
BY_NAME, NONE, OFFLINE, DEFAULTperformanceModel
StringserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
Stringstep([$class: 'SvDeployBuilder']): SV: Deploy Virtual ServiceserverName
Stringforce
booleanservice
StringprojectPath
StringprojectPassword
StringfirstAgentFallback
booleanstep([$class: 'SvExportBuilder']): SV: Export Virtual ServiceserverName
Stringforce
booleantargetDirectory
StringcleanTargetDirectory
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringswitchToStandByFirst
booleanarchive
booleanstep([$class: 'SvUndeployBuilder']): SV: Undeploy Virtual ServiceserverName
StringcontinueIfNotDeployed
booleanforce
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringuploadResultToALM: Upload test result to ALMalmServerName
StringcredentialsId
StringalmDomain
StringclientType
StringalmProject
StringtestingFramework
StringtestingTool
StringalmTestFolder
StringalmTestSetFolder
StringalmTimeout
StringtestingResultFile
StringjenkinsServerUrl
StringconvertTestsToRun: ALM Octane testing framework converter| Framework | Linux shell |
| Maven Surefire | mvn clean -Dtest=$testsToRunConverted test |
| Maven Failsafe | mvn clean -Dit.test=$testsToRunConverted verify |
| Gradle | gradle test $testsToRunConverted |
| Protractor | protractor conf.js --grep="$testsToRunConverted" |
| Cucumber-JVM over Maven/ BDD Scenario |
mvn clean -Dcucumber.options="$testsToRunConverted" test |
| JBehave over Maven | mvn clean -Dfeatures="$testsToRunConverted" test |
| Framework | Windows batch command |
| Maven Surefire | mvn clean -Dtest=%testsToRunConverted% test |
| Maven Failsafe | mvn clean -Dit.test=%testsToRunConverted% verify |
| Gradle | gradle test %testsToRunConverted% |
| Protractor | protractor conf.js --grep="%testsToRunConverted%" |
| Cucumber-JVM over Maven/ BDD Scenario |
mvn clean -Dcucumber.options="%testsToRunConverted%" test |
| JBehave over Maven | mvn clean -Dfeatures="%testsToRunConverted%" test |
| Framework | Pipeline script |
| Maven Surefire | bat 'mvn clean -Dtest=${params.testsToRunConverted} test' |
| Maven Failsafe | bat 'mvn clean -Dit.test=${params.testsToRunConverted} verify' |
| Gradle | bat 'gradle test ${params.testsToRunConverted}' |
| Protractor | bat(/protractor conf.js --grep="${params.testsToRunConverted}"/) |
| Cucumber-JVM over Maven/ BDD Scenario |
bat(/mvn clean -Dcucumber.options="${params.testsToRunConverted}" test/) |
| JBehave over Maven | bat(/mvn clean -Dfeatures="${testsToRunConverted}" test/) |
framework
Stringformat
{
"testPattern": "$package.$class#$testName",
"testDelimiter": ","
}
"replacements": [
{
"type": "replaceRegex",
"target": "$package|$class|$testName",
"regex": "aaa",
"replacement": "bbb",
"description": "Replaces all the sequence of characters matching the regex with a replacement string."
},{
"type": "replaceRegexFirst",
"target": "$package|$class|$testName",
"regex": "aaa",
"replacement": "bbb",
"description": "Replaces the first substring that matches the given regex with the given replacement. For example, given regex '@(.*)@.*' , replacement '$1', and test name '@myTag@ my test name' - will replace test name by the content located between @, that is - 'myTag'."
},{
"type": "replaceString",
"target": "$package|$class|$testName",
"string": "xxx",
"replacement": "yyy",
"description": "Replaces all occurrences of ‘string’ with ‘replacement’."
},{
"type": "joinString",
"target": "$package|$class|$testName",
"prefix": "xxx",
"suffix": "yyy",
"description": "Add prefix and suffix to the test template."
},{
"type": "toLowerCase",
"target": "$package|$class|$testName",
"description": "Convert test template to lower case."
},{
"type": "toUpperCase",
"target": "$package|$class|$testName",
"description": "Convert test template to upper case."
},{
"type": "notLatinAndDigitToOctal",
"target": "$package|$class|$testName",
"description": "Replaces all non-latin characters and digits ^[a-zA-Z0-9] to their ASCII octal value."
}]
StringpublishCodeCoverage: ALM Octane code coverage publisherjacocoPathPattern
StringlcovPathPattern
StringsvChangeModeStep: SV: Change Mode of Virtual ServiceserverName
Stringforce
booleanmode
OFFLINE, SIMULATING, STAND_BY, LEARNINGdataModel
selectionType
BY_NAME, NONE, DEFAULTdataModel
StringperformanceModel
selectionType
BY_NAME, NONE, OFFLINE, DEFAULTperformanceModel
StringserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringsvDeployStep: SV: Deploy Virtual ServiceserverName
Stringforce
booleanservice
StringprojectPath
StringprojectPassword
StringfirstAgentFallback
booleansvExportStep: SV: Export Virtual ServiceserverName
Stringforce
booleantargetDirectory
StringcleanTargetDirectory
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringswitchToStandByFirst
booleanarchive
booleansvUndeployStep: SV: Undeploy Virtual ServiceserverName
StringcontinueIfNotDeployed
booleanforce
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringuftScenarioLoad: Run UFT scenariotestPaths
StringarchiveTestResultsMode
StringfsReportPath (optional)
StringfsTimeout (optional)
StringfsUftRunMode (optional)
StringrunFromFileBuilder (optional)
fsTests
StringfileSystemTestSetModel
fileSystemTestSet
tests
StringparallelRunnerEnvironments
environment
StringenvironmentType
StringsummaryDataLogModel
logVusersStates
booleanlogErrorCount
booleanlogTransactionStatistics
booleanpollingInterval
StringscriptRTSSetModel
scripts
scriptName
StringadditionalAttributes
name
Stringvalue
Stringdescription
StringisParallelRunnerEnabled (optional)
booleanuftSettingsModel (optional)
selectedNode (optional)
StringnumberOfReruns (optional)
StringcleanupTest (optional)
StringonCheckFailedTest (optional)
StringfsTestType (optional)
StringrerunSettingsModels (optional)
test (optional)
Stringchecked (optional)
booleannumberOfReruns (optional)
intcleanupTest (optional)
StringanalysisTemplate (optional)
StringcontrollerPollingInterval (optional)
StringdisplayController (optional)
StringfsAutActions (optional)
StringfsDeviceId (optional)
StringfsDevicesMetrics (optional)
StringfsExtraApps (optional)
StringfsInstrumented (optional)
StringfsJobId (optional)
StringfsLaunchAppName (optional)
StringfsManufacturerAndModel (optional)
StringfsOs (optional)
StringfsPassword (optional)
StringfsReportPath (optional)
StringfsTargetLab (optional)
StringfsTimeout (optional)
StringfsUftRunMode (optional)
StringfsUserName (optional)
StringignoreErrorStrings (optional)
StringmcServerName (optional)
StringmcTenantId (optional)
StringperScenarioTimeOut (optional)
StringproxySettings (optional)
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
class hudson.util.SecretresultFileNames (optional)
java.util.Map<java.lang.Long, java.lang.String>useSSL (optional)
booleanrunResultRecorder (optional)
archiveTestResultsMode
StringPlease submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.