Leapwork Integration

This is LEAPWORK plugin for Jenkins (version 2.60.3 or later)

More Details

LEAPWORK is a mighty automation testing system and now it can be used for running [smoke, functional, acceptance] tests, generating reports and a lot more in Jenkins. You can easily configure integration directly in Jenkins enjoying UI friendly configuration page with easy connection and test suites selection.

Features:

• Setup and test LEAPWORK connection in few clicks
• Run automated tests in your Jenkins build tasks
• Automatically receive test results
• Build status based tests results
• Generate a xml report file in JUnit format
• Write tests trace to build output log
• Smart UI

Installing

• Use maven
• Command: mvn package
• Or simply install hpi-file from the "target" folder: Manage Jenkins -> Manage Plugins -> Advanced -> Upload Plugin -> Choose that hpi-file -> Press Upload

Update 3.1.1

• For LEAPWORK version 2018.2.283
• Removed "Access key" info from console log.
• Fixed bug when schedules are executing in non-ordered way.
• Now it is possible to insert a list of schedules to "Schedule Names" text box. List of names must be new line or comma separated. Be noticed that by clicking on any checkbox with schedule to select, using "Get Schedules" button, all non-existing or disabled schedules will be removed from "Schedule names" text box.
• Added "Schedule variables" non-mandatory field. Schedule variables must be listed in "key : value" way and separated by new line or comma. Be noticed that all the schedules will be run with this list of variables.
• Boolean field "leapworkWritePassedFlowKeyFrames" is not mandatory anymore.
• Fixed problem with enforcer for compiling the plugin using sources.
• Uses new Leapwork v3 API, API v2 is not supported

Instruction

1. Add Build "Leapwork Integration" to your job.
2. Enter your LEAPWORK controller hostname or IP-address something like "win10-agent20" or "localhost".
3. Enter your LEAPWORK controller API port, by default it is 9001.
4. Enter JUnit report file name. This file will be created at your job's working directory. If there is an xml file with the same name, it will be overwritten. By default it is "report.xml".
5. Enter time delay in seconds. When schedule is run, plugin will wait this time before trying to get schedule state. If schedule is still running, plugin will wait this time again. By default this value is 5 seconds.
6. Select how plugin should set "Done" status value: to Success or Failed.
7. Press button "Select Schedules" to get a list of all available schedules. Select schedules you want to run.
8. If your workspace folder path is not default (JENKINS_HOME\workspace),enter your full path here like {Your path to workspace folder}\workspace. Otherwise DO NOT enter anything!
9. Add Post-Build "Publish JUnit test result report" to your job. Enter JUnit report file name. It MUST be the same you've entered before!
10. Run your job and get results. Enjoy!

Pipeline

This is an example script for pipeline:

node{
stage ('Leapwork Integration') {
   step([$class: "LeaptestJenkinsBridgeBuilder",
     leapworkHostname: "win10-agent2",
     leapworkPort: "9001",
     leapworkAccessKey: "9Kz0qeoIhhNo48Id",
     leapworkDelay: "5",
     leapworkDoneStatusAs: "Success", //"Failed"
     leapworkReport: "report.xml",
     leapworkSchIds: "",//"9c3fa950-d1e8-4e12-bf17-ebc945defad5\ndb5c3a25-8eec-434c-8526-c1b2ef9c56f2",   // splitters: "\n" "," ", "
     leapworkSchNames: "Problem schedule, Open Applications,    sch, sch 2,sch 3,sch 4      ,        sch 5",
     leapworkWritePassedFlowKeyFrames: false,
     leapworkScheduleVariables: "var1:val1, var2 : val2,      var3: val3,var4   :   val4,       var5:    val5"
   ]);

   step([$class: "JUnitResultArchiver", testResults: "report.xml"]);

   if(currentBuild.result != "FAILURE") {
     echo "RESULT: ${currentBuild.result}  SUCCESS INFO"
     // do something else
   } else {
     echo "RESULT: ${currentBuild.result}  FAIL INFO"
     // do something else
   }
 }
}

Troubleshooting

• If you catch an error "No such run [runId]!" after schedule starting, increase time delay parameter in "advanced".

Screenshots