GitLab CI
This support article provides step-by-step instructions to execute Provar test cases in Gitlab using its built-in pipeline.
Continuous Integration (CI) works to integrate code from your team in a shared repository. Developers share their new code in a merge (pull) request, which triggers a pipeline to build, test and validate the new code before merging the changes in your repository.
Continuous Delivery delivers CI validated code to your application.
Git plugin information
With Provar version 2.2.0 and future releases, you no longer need to install the Git plugin. We’ve packaged this together with our installer files. As a result, the Provar plugin installer will no longer show Git as an option. You can still enable the Jira, TFS and SVN plugins as previously.
Prerequisites
- Provar ANT zip file.
- Provar project with at least one test case and associated ANT build.xml file.
- The Provar project is pushed in Gitlab as a public or private repository.
- Provar Execution Only (or Floating) license key pushed into the .license folder of the Github repository. Please only upload license keys on private repositories to avoid unlicensed usage by third parties. Unlicensed access will be tracked and can cause you to be locked out of Provar until a new license key is re-issued to you.
Steps to create a project in GitLab
The following steps are completed using free as well as paid GitLab account:
Step 1: Login into your GitLab account.
Step 2: Create a new project and mention project name, description and visibility level.
Step 3: Take a clone of this new repository into your local machine.
Step 4: Add three folders in this repository:
- ProvarProject: It contains provar test cases and build.xml file to execute those tests.
- Provar: It contains .license folder.
- Provar_Home: This folder is created by extracting Provar_Ant_<Version>.zip file from the latest version of Provar which can be downloaded from the Provar community. This folder contains ant and lib folders.
Step 5: Add .gitlab-ci.yml file in base location of the repository.
Screenshot of folder structure:
Steps to create .gitlab-ci.yml file
In order for Gitlab CI to build your project, you will need to add .gitlab-ci.yml configuration file to the root directory of your repository.
If .gitlab-ci.yml is not in your repository, or is not valid YAML, GitLab CI will ignore it.
Here is an example file:
image: "frekele/ant:1.10.3-jdk8" before_script: - apt-get update && apt-get install -y xvfb wget -qq - java -version - ant -version - wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - - echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list - apt-get update -qq - apt-get install -qq google-chrome-stable google-chrome-beta - export DISPLAY=:99.0 - wget -O /etc/init.d/xvfb https://gist.githubusercontent.com/axilleas/3fc13e0c90ad9f58bee903a41e8a6d48/raw/169a60010635e05eaa902c5f3b4393321f2452f0/xvfb - chmod 0755 /etc/init.d/xvfb - sh -e /etc/init.d/xvfb start build: variables: PROVAR_HOME: "$CI_PROJECT_DIR/Provar_Home" LICENSE_PATH: "$CI_PROJECT_DIR/Provar" script: - pwd - xvfb-run ant -Dprovar.home=$PROVAR_HOME -Dlicense.path=$LICENSE_PATH -f ProvarProject/ANT/build.xml
Just walking through the example script above:
Firstly, we need to mention the base docker image, as we support Java 8 and test cases execution requires ANT. So, we have taken official image of ant frekele/ant:1.10.3-jdk8.
Describe before_script:
As we need to execute our UI test cases on a browser, that is why the chrome installation is included.
To execute test cases in headless manner, we also need to install xvfb, so before executing the actual test script section we are installing xvfb and running xvfb service.
Build step contains variables like PROVAR_HOME and script that is required to execute test cases using command xvfb-run ant -Dprovar.home=$PROVAR_HOME -Dlicense.path=$LICENSE_PATH -f ProvarProject/ANT/build.xml.
Parameter changes in build.xml
Edit the build.xml file.
- provar.home: value is ${env.PROVAR_HOME}
- testproject.home: value is Project name i.e. ProvarProject
- testproject.results: It’s a result path ProvarProject/Results
- license.path: It’s a path where .license folder is located. (The path is provided in.gitlab-ci.yml.)
See the example build.xml
<project default="runtests"> <property environment="env"/> <property name="provar.home" value="${env.PROVAR_HOME}"/> <property name="testproject.home" value="ProvarProject"/> <property name="testproject.results" value="ProvarProject/Results"/> <property name="license.path" value=""/> <echo message="provar home is:${provar.home}"/> <taskdef name="Provar-Compile" classname="com.provar.testrunner.ant.CompileTask" classpath="${provar.home}/ant/ant-provar.jar"/> <taskdef name="Run-Test-Case" classname="com.provar.testrunner.ant.RunnerTask" classpath="${provar.home}/ant/ant-provar.jar;${provar.home}/ant/ant-provar-bundled.jar;${provar.home}/ant/ant-provar-sf.jar"/> <taskdef name="Test-Cycle-Report" classname="com.provar.testrunner.ant.TestCycleReportTask" classpath="${provar.home}/ant/ant-provar.jar;${provar.home}/ant/ant-provar-bundled.jar;${provar.home}/ant/ant-provar-sf.jar"/> <target name="runtests"> <Provar-Compile provarHome="${provar.home}" projectPath="${testproject.home}"/> <Run-Test-Case provarHome="${provar.home}" projectPath="${testproject.home}" resultsPath="${testproject.results}" resultsPathDisposition="Replace" testEnvironment="" webBrowser="Chrome_Headless" webBrowserConfiguration="Full Screen" excludeCallableTestCases="true" salesforceMetadataCache="Reload" projectCachePath="${provar.home}/.provarCaches" licensePath="${license.path}/.licenses" testOutputlevel="WARNING" pluginOutputlevel="WARNING" stopTestRunOnError="false" invokeTestRunMonitor="true" > <fileset dir="../tests/sample"/> </Run-Test-Case> </target> </project>
Trigger the first build
Once you pushed all changes into gitlab, CI process automatically gets triggered.
Status of the execution can be checked on CI/CD -> Pipelines.
Caching in Gitlab
GitLab CI/CD provides a caching mechanism that can be used to save time when your jobs are running. For more information check this link.
https://docs.gitlab.com/ee/ci/caching/
.provarCaches is used to speed up runs of a given job in subsequent pipelines. By including it in the cache, Provar will not download the metadata during each test execution which reduces execution time.
Including the Provar_Home directory in the cache will eliminate the need to download the ANT zip file and unzip it in between jobs.
image: "frekele/ant:1.10.3-jdk8" before_script: - wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - - echo "deb http://dl.google.com/linux/chrome/deb/ stable main" > /etc/apt/sources.list.d/google.list - apt-get update -yqqq - apt-get install -qq google-chrome-stable - apt-get install -y xvfb -qq - if [ ! -d Provar_Home ]; then curl -O https://download.provartesting.com/latest/Provar_ANT_latest.zip && unzip Provar_ANT_latest.zip -d Provar_Home; else echo "Found Provar_Home"; fi build: variables: PROVAR_HOME: "$CI_PROJECT_DIR/Provar_Home" LICENSE_PATH: "$CI_PROJECT_DIR/Provar" script: - cd demo/ANT - xvfb-run ant -Dprovar.home=$PROVAR_HOME -Dlicense.path=$LICENSE_PATH -f build.xml cache: paths: - $PROVAR_HOME/.provarCaches - $PROVAR_HOME artifacts: paths: - demo/ANT/Results
Test results
After successful execution, test reports will be generated in the location mentioned in the build.xml testproject.results parameter.
<property name=”testproject.results” value=”ProvarProject/Results”/>
Refer to this link for help customizing the reporting options in Provar.
To get reports folder as artifacts in GitLab, just add below code in your .gitlab-ci.yml file.
artifacts: paths: - ProvarProject/Results
Artifacts can be downloaded from the button available on the right side of the below screenshot.
In case you don’t want to place Provar_Home in GIT, just add these lines of code in before_script tag
- curl -O https://download.provartesting.com/latest/Provar_ANT_latest.zip - unzip -o Provar_ANT_latest.zip -d Provar_Home - rm Provar_ANT_latest.zip
- General information
- Licensing Provar
- Provar trial guide and extensions
- Using Provar
- API testing
- Behavior-driven development
- Creating and importing projects
- Creating test cases
- Custom table mapping
- Functions
- Debugging tests
- Defining a namespace prefix on a connection
- Defining proxy settings
- Environment management
- Exporting test cases into a PDF
- Exporting test projects
- Managing test steps
- Namespace org testing
- Provar desktop
- Provar Test Builder
- Refresh and Recompile
- Reload Org Cache
- Reporting
- Running tests
- Searching Provar with find usages
- Secrets management and encryption
- Setup and teardown test cases
- Tags and Service Level Agreements (SLAs)
- Test cycles
- Test plans
- Testing browser options
- Tooltip testing
- Using the Test Palette
- Using custom APIs
- Callable tests
- Data-driven testing
- Page objects
- Block locator strategies
- Introduction to XPaths
- Creating an XPath
- JavaScript locator support
- Label locator strategies
- Maintaining page objects
- Mapping non-Salesforce fields
- Page object operations
- ProvarX™
- Refresh and reselect field locators in Test Builder
- Using Java method annotations for custom objects
- Applications testing
- DevOps
- Introduction to test scheduling
- Apache Ant
- Configuration for sending emails via the Provar Command Line Interface (CLI)
- Continuous integration
- AutoRABIT
- Azure DevOps
- Running a Provar CI task in Azure DevOps
- Configuring the Provar secrets password in Microsoft Azure Pipelines
- Parallel execution in Microsoft Azure Pipelines using multiple build.xml files
- Parallel execution in Microsoft Azure Pipelines using targets
- Parallel execution in Microsoft Azure Pipelines using Test Plans
- Bitbucket Pipelines
- CircleCI
- Copado
- Docker
- Flosum
- Gearset
- GitHub Actions
- Running a Provar CI task in GitHub Actions
- Remote Trigger in GitHub Actions
- Parameterization using Environment Variables in GitHub Actions
- Parallel Execution in GitHub Actions using multiple build.xml files
- Parallel Execution in GitHub Actions using Targets
- Parallel Execution in GitHub Actions using Test Plan
- Parallel Execution in GitHub Actions using Job Matrix
- GitLab CI
- Jenkins
- Travis CI
- Parallel Execution
- Running Provar on Linux
- Reporting
- Salesforce DX
- Git
- Team foundation server
- Version control
- Zephyr Cloud and Server
- Salesforce testing
- Adding a Salesforce connection
- Assert Page Error Messages on Add/Edit Product
- Dynamic Forms
- Internationalization support
- List and table testing
- Salesforce Release Updates
- Salesforce Lightning Testing
- Salesforce Lightning Web Component (LWC) locator support
- Salesforce console testing
- Visualforce Testing
- Testing best practices
- Troubleshooting
- Release notes