Skip to content
Get Free Trial

Integrate with Jenkins

Jenkins and other Continuous Integration systems can trigger Sahi scripts as part of the build process using Sahi's ANT and Gradle target.

Automation is useless without Continuous Integration. Sahi suites should be periodically executed and CI systems can trigger suites when code changes happen. Sahi suites can be triggered via ANT. We configure Jenkins to call Sahi’s ANT target and then make Sahi’s logs accessible from Jenkins.

Sahi Pro needs real browsers to run test scenarios. But most Jenkins/build machines run in server mode and do not have a GUI. This forces end users to either try with headless browsers or to execute Sahi scripts remotely.

With Sahi, this is what you can do:

Jenkins machine (J): Run Jenkins on server. No Sahi installed.
Sahi Master machine (SM): Sahi Pro Runner (or Sahi Pro) runs on this machine and behaves as Master
Sahi slave machines (SL1, SL2, SL3): These are slave machines with Sahi Pro Runner (or Sahi Pro) running on them.
Central Database: Sync all the logs from Sahi Master to this machine. For more info, look at Sahi Sync DB.

During the build process:

Jenkins pulls the latest scripts from the Source Control Management (SCM) system. It calls the Sahi ant target. Sahi target copies over the scripts from Jenkins (J) to master (SM). SM then copies scripts to SL1, SL2, SL3, distributes the execution and collects all reports. Sahi ant target then pulls reports from SM to Jenkins. This allows Jenkins to remain a headless server and does not need Sahi installed on it. Also all distribution of scripts and pulling of reports happens through Sahi’s ant target itself.

Before integration, you will first need an ant target to run the suite file. You can create the ANT target from the Editor’s Run Configuration. Save the file in any path accessible by Jenkins (say C:\jenkins_sahi) and lets call it build.xml.

In the build.xml make sure that:

  • scriptDir points to where your Sahi scripts will reside on your Jenkins machine. This will mostly be the local directory where the scripts are checked out via Git or SVN. If your checkout directory is E:/automation/scripts/ your build.xml should have

    <property name="scriptDir" value="E:/automation/scripts/"/>
  • Offline reports path should be configured correctly. The path in report tag in build.xml should be the same as that used in Publish HTML Reports in Jenkins configuration In this example, we use <report type="html" logdir="C:/jenkins_sahi/logs/"/>

  • If email is configured to be sent at the end of a build, the path to email.properties in build.xml should point to the correct location. You will need to copy SahiPro/userdata/config/email.properties into C:/jenkins_sahi/email.properties and have this in build.xml

    <property name="emailproperties" value="C:/jenkins_sahi/email.properties"/>

Also Install the HTML Publisher plugin if you wish to see HTML logs via Jenkins UI.

Let us assume that Jenkins is available in C:\.jenkins\

  • From the Jenkins dashboard, click on New job (or New item).

  • Enter job (or item) name as SahiFunctionalTests (This will be the name of the job identified by Jenkins.)

  • Select Build a free-style software project. Click OK.

  • At this point, you should be directed to the Configure page. Click on Add build step. Select invoke Ant

  • Type -f C:/jenkins_sahi/build.xml in the ANT target textbox.

  • Copy SahiPro/lib/ant-sahi.jar from your Sahi Pro Runner installation folder into C:/jenkins_sahi/lib/ant-sahi.jar

  • To publish HTML reports after build, click on Add Post Build Action button and select Publish HTML Reports.

    Provide Logs directory and other details.

    In the field of “HTML directory to archive” you need to provide the same path defined in the report attribute of Sahi task in build.xml. e.g. <report type="html" logdir="C:/jenkins_sahi/logs/"/>. This is configured via the Offline Reports in the Editor’s Run Configuration.

  • On the Jenkins dashboard, click Build now.

    Automation is useless without Continuous Integration. Sahi suites should be periodically executed and CI systems can trigger suites when code changes happen. Sahi suites can be triggered via Gradle. We configure Jenkins to call Sahi’s Gradle target and then make Sahi’s logs accessible from Jenkins.

    Sahi Pro needs real browsers to run test scenarios. But most Jenkins/build machines run in server mode and do not have a GUI. This forces end users to either try with headless browsers or to execute Sahi scripts remotely.

    With Sahi, this is what you can do:

    Jenkins machine (J): Run Jenkins on server. No Sahi installed.
    Sahi Master machine (SM): Sahi Pro Runner (or Sahi Pro) runs on this machine and behaves as Master
    Sahi slave machines (SL1, SL2, SL3): These are slave machines with Sahi Pro Runner (or Sahi Pro) running on them.
    Central Database: Sync all the logs from Sahi Master to this machine. For more info, look at Sahi Sync DB.

    During the build process:

    Jenkins pulls the latest scripts from the Source Control Management (SCM) system. It calls the Sahi gradle target. Sahi target copies over the scripts from Jenkins (J) to master (SM). SM then copies scripts to SL1, SL2, SL3, distributes the execution and collects all reports. Sahi gradle target then pulls reports from SM to Jenkins. This allows Jenkins to remain a headless server and does not need Sahi installed on it. Also all distribution of scripts and pulling of reports happens through Sahi’s gradle target itself.

    Before integration, you will first need a Gradle task to run the suite file. You can create the Gradle target from the Editor’s Run Configuration. Save the file in any path accessible by Jenkins (say C:\jenkins_sahi) and lets call it build.gradle (for Groovy scripts) or build.gradle.kts (for Kotlin Scripts).

    In the build.gradle or build.gradle.kts make sure that:

    • scriptDir points to where your Sahi scripts will reside on your Jenkins machine. This will mostly be the local directory where the scripts are checked out via Git or SVN. If your checkout directory is E:/automation/scripts/ your build.gradle or build.gradle.kts should have

      def scriptDir = "E:/automation/scripts/"
    • Offline reports path should be configured correctly. The path in report tag in build.gradle or build.gradle.kts should be the same as that used in Publish HTML Reports in Jenkins configuration In this example, we use reports: "html:C:/sahi_Jenkins/Logs"

    • If email is configured to be sent at the end of a build, the path to email.properties in build.gradle or build.gradle.kts should point to the correct location. You will need to copy SahiPro/userdata/config/email.properties into C:/jenkins_sahi/email.properties and have this in build.gradle or build.gradle.kts

      emailproperties: "C:/sahi_Jenkins/userdata/config/email.properties"

    Also Install the HTML Publisher plugin if you wish to see HTML logs via Jenkins UI.

    Let us assume that Jenkins is available in C:\.jenkins\

    • From the Jenkins dashboard, click on New job (or New item).

    • Enter job (or item) name as SahiFunctionalTests (This will be the name of the job identified by Jenkins.)

    • Select Build a free-style software project. Click OK.

    • At this point, you should be directed to the Configure page. Click on Add build step. Select invoke Gradle script

    • Specify the task name in the Gradle script Tasks textbox,to execute the specific task.

    • Click on Advanced and enter your build.gradle or build.gradle.kts script directory. e.g. C:/sahi_Jenkins/

    • Copy SahiPro/lib/ant-sahi.jar from your Sahi Pro Runner installation folder into C:/jenkins_sahi/lib/ant-sahi.jar

    • To publish HTML reports after build, click on Add Post Build Action button and select Publish HTML Reports.

      Provide Logs directory and other details.

      In the field of “HTML directory to archive” you need to provide the same path defined in the report attribute of Sahi task in build.xml. e.g. reports: "html:C:/sahi_Jenkins/Logs". This is configured via the Offline Reports in the Editor’s Run Configuration.

    • On the Jenkins dashboard, click Build now.

      • If starting Jenkins using jenkins.war file then use the below command.

        Terminal window
        java -Dhudson.model.DirectoryBrowserSupport.CSP= -jar jenkins.war
      • If starting Jenkins as a service on a Windows machine:

        • Go to <Home>/.jenkins/jenkins.xml file, and add "-Dhudson.model.DirectoryBrowserSupport.CSP=\"\"" under the <arguments> Tag. After adding the property in the <arguments> tag, the tag will look as below.

          <arguments>-Xrs -Xmx256m -Dhudson.lifecycle=hudson.lifecycle.WindowsServiceLifecycle "-Dhudson.model.DirectoryBrowserSupport.CSP=\"\"" -jar "%BASE%\jenkins.war" --httpPort=8080 --webroot="%BASE%\war"</arguments>
        • Save the file, Restart Jenkins.

      • If starting Jenkins as a service on a Linux machine:

        • Create a new directory with name init.groovy.d in Jenkins home directory /var/jenkins_home.

        • Within init.groovy.d directory create a new groovy script. Say startup-properties.groovy

        • Copy the below content to the startup-properties.groovy file.

          import jenkins.model.Jenkins
          import java.util.logging.LogManager
          /* Jenkins home directory */
          def jenkinsHome = Jenkins.instance.getRootDir().absolutePath
          def logger = LogManager.getLogManager().getLogger("")
          /* Replace the Key and value with the values you want to set.*/
          /* System.setProperty(key, value) */
          System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "")
          logger.info("Jenkins Startup Script: Successfully updated the system properties value for hudson.model.DirectoryBrowserSupport.CSP . Script location : ${jenkinsHome}/init.groovy.d ")
        • Save the file, Restart the Jenkins server.

      :::

      Once HTML Reports are configured, one can view Sahi’s report logs by clicking on the “HTML Reports” link on the left side navigation links on the Jenkins project page.

      The Sahi Pro HTML report looks like this:

      The Sahi Pro HTML suite report for book_store_regression.dd.csv: the suite and its three scenario files on the left, Suite Details with status Failure, time taken, browser chrome, start and end times and nodes, and the Test Scenario Summary (2 passed, 1 error) and Test Cases Summary (3 passed, 1 error) charts