1. provartesting/provar@2.18.0

provartesting/provar@2.18.0

Partner
Sections
Test Automation for Salesforce. The only code-free, integrated automation testing tool for Salesforce. Official Provar Orb for all your testing needs in CircleCI.
Created: June 26, 2019Version Published: August 30, 2024Releases: 47
Org Usage:
< 25

Orb Quick Start Guide

Use CircleCI version 2.1 at the top of your .circleci/config.yml file.

1 version: 2.1

Add the orbs stanza below your version, invoking the orb:

1 2 orbs: provar: provartesting/provar@2.18.0

Use provar elements in your existing workflows and jobs.

Opt-in to use of uncertified orbs on your organization’s Security settings page.

Usage Examples

run_provar_command

Checkout Code test cases from Git, run test cases and publish report

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 version: '2.1' orbs: browser-tools: circleci/browser-tools@1 provar: provartesting/provar@2.18 jobs: build: executor: name: provar/default tag: current-browsers parameters: build_file: default: build.xml type: string email_target: default: michael.dailey@provartesting.com type: string environment: default: Dev type: string license_path: default: /home/circleci/project/ProvarProject/.licenses type: string project_name: default: DemoProject type: string test_plan: default: Regression type: string steps: - checkout - provar/setup_provar: majorversion: << parameters.majorversion >> url: << parameters.url >> - browser-tools/install-chrome - browser-tools/install-chromedriver - run: command: sudo apt-get update -y && sudo apt-get install -y ant - provar/run_test_plans: build_file: << parameters.build_file >> email_target: << parameters.email_target >> environment: << parameters.environment >> license_path: << parameters.license_path >> project_name: << parameters.project_name >> test_plan: << parameters.test_plan >> - provar/store_provar_test_results: project_name: << parameters.project_name >> workflows: null

use_provar_job

Run provar tests using job

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 version: '2.1' orbs: provar: provartesting/provar@2.18 workflows: run_all: jobs: - provar/run_provar: build_file: build.xml email_target: noreply@example.com environment: '' license_path: /home/circleci/project/ProvarProject/.licenses majorversion: 2.14.1 name: Run Job that executes Provar tests project_name: DemoProject test_plan: Regression url: download.provartesting.com version: 2.1

Jobs

run_provar

Checkout code from Git which contains a test project, execute test cases using Provar CLI, and publish report

Show job Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
build_file
The name of the build file to execute.
No
build.xml
string
email_target
The email to send the job results to.
No
noreply@test.com
string
environment
The name of the test environment to run the tests against.
No
''
string
executor
Executor to use for this job, defaults to this orb's default executor
No
default
executor
license_path
The path of your Provar Execution license folder on the machine
No
/home/circleci/project/ProvarProject/.licenses
string
majorversion
Major version of provar
No
2.14.1
string
project_name
The folder containing the Provar Automation Test Project.
No
ProvarProject
string
steps
Steps to execute
No
[]
steps
test_plan
The name of the test plan to run.
No
Regression
string
url
URL, minus https://, from which to download the specified version of the Provar CLI
No
download.provartesting.com
string

Commands

run_test_plans

Runs Provar test plans with parameters

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
build_file
The name of the build file to execute.
No
build.xml
string
email_target
The email to send the job results to.
No
noreply@test.com
string
environment
The name of the test environment to run the tests against.
No
''
string
license_path
The path of your Provar Execution license folder on the machine
No
/home/circleci/project/ProvarProject/.licenses
string
project_name
The folder containing the Provar Automation Test Project.
No
ProvarProject
string
test_plan
The name of the test plan to run.
No
Regression
string

setup_provar

Downloads and extracts provar Ant zip file

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
majorversion
Major version of provar
No
2.14.1
string
url
URL, minus https://, from which to download the specified version of the Provar CLI
No
download.provartesting.com
string

store_provar_test_results

Stores Test Results from Test Run

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
project_name
The folder containing the Provar Automation Test Project.
No
ProvarProject
string

Executors

default

Node-based Docker image with Java 11 and current browsers like Firefox, Chrome, Explorer

Show executor Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
tag
Specific variant of CircleCI's Selenium Node Image: https://hub.docker.com/r/cimg/node
No
current-browsers
string
working-directory
Working directory for the job using this executor: https://circleci.com/docs/2.0/configuration-reference/#job_name
No
~/project
string

Orb Source

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 # This code is licensed from CircleCI to the user under the MIT license. # See here for details: https://circleci.com/developer/orbs/licensing version: 2.1 description: | Test Automation for Salesforce. The only code-free, integrated automation testing tool for Salesforce. Official Provar Orb for all your testing needs in CircleCI. display: home_url: https://www.provartesting.com/documentation/devops/continuous-integration/circleci/circleci-orb/ source_url: https://github.com/ProvarTesting/provartesting-orb orbs: browser-tools: circleci/browser-tools@1.4.8 commands: run_test_plans: description: Runs Provar test plans with parameters parameters: build_file: default: build.xml description: The name of the build file to execute. type: string email_target: default: noreply@test.com description: The email to send the job results to. type: string environment: default: "" description: The name of the test environment to run the tests against. type: string license_path: default: /home/circleci/project/ProvarProject/.licenses description: The path of your Provar Execution license folder on the machine type: string project_name: default: ProvarProject description: The folder containing the Provar Automation Test Project. type: string test_plan: default: Regression description: The name of the test plan to run. type: string steps: - run: command: | ant -Dprovar.home="/home/circleci/project/Provar_Home" -Dproject.home="/home/circleci/project/<< parameters.project_name >>" -Dtest.plan="<< parameters.test_plan >>" -Denvironment="<< parameters.environment >>" -Demail.target=<< parameters.email_target >> -Dlicense.path=<< parameters.license_path >> -f << parameters.project_name >>/ANT/<< parameters.build_file >> name: Run Provar Test Plan setup_provar: description: Downloads and extracts provar Ant zip file parameters: majorversion: default: 2.14.1 description: Major version of provar type: string url: default: download.provartesting.com description: | URL, minus https://, from which to download the specified version of the Provar CLI type: string steps: - run: command: | curl -O https://<< parameters.url >>/<< parameters.majorversion >>/Provar_ANT_<< parameters.majorversion >>.zip unzip Provar_ANT_<< parameters.majorversion >>.zip -d Provar_Home rm Provar_ANT_<< parameters.majorversion >>.zip name: Download Provar_ANT.zip file and extract it into Provar_Home directory store_provar_test_results: description: Stores Test Results from Test Run parameters: project_name: default: ProvarProject description: The folder containing the Provar Automation Test Project. type: string steps: - store_test_results: name: Store Test Results path: << parameters.project_name >>/ANT/Results/JUnit html/ - store_artifacts: name: Store Test Artifacts path: << parameters.project_name >>/ANT/Results executors: default: description: Node-based Docker image with Java 11 and current browsers like Firefox, Chrome, Explorer docker: - image: cimg/node:<< parameters.tag >> parameters: tag: default: current-browsers description: | Specific variant of CircleCI's Selenium Node Image: https://hub.docker.com/r/cimg/node type: string working-directory: default: ~/project description: | Working directory for the job using this executor: https://circleci.com/docs/2.0/configuration-reference/#job_name type: string working_directory: <<parameters.working-directory>> jobs: run_provar: description: | Checkout code from Git which contains a test project, execute test cases using Provar CLI, and publish report executor: <<parameters.executor>> parameters: build_file: default: build.xml description: The name of the build file to execute. type: string email_target: default: noreply@test.com description: The email to send the job results to. type: string environment: default: "" description: The name of the test environment to run the tests against. type: string executor: default: default description: | Executor to use for this job, defaults to this orb's default executor type: executor license_path: default: /home/circleci/project/ProvarProject/.licenses description: The path of your Provar Execution license folder on the machine type: string majorversion: default: 2.14.1 description: Major version of provar type: string project_name: default: ProvarProject description: The folder containing the Provar Automation Test Project. type: string steps: default: [] description: Steps to execute type: steps test_plan: default: Regression description: The name of the test plan to run. type: string url: default: download.provartesting.com description: | URL, minus https://, from which to download the specified version of the Provar CLI type: string steps: - checkout - setup_provar: majorversion: << parameters.majorversion >> url: << parameters.url >> - run: sudo apt-get update - browser-tools/install-chrome: chrome-version: 119.0.6045.105 replace-existing: true - browser-tools/install-chromedriver - run: command: sudo apt-get update -y && sudo apt-get install -y ant - run_test_plans: build_file: << parameters.build_file >> email_target: << parameters.email_target >> environment: << parameters.environment >> license_path: << parameters.license_path >> project_name: << parameters.project_name >> test_plan: << parameters.test_plan >> - store_provar_test_results: project_name: << parameters.project_name >> examples: run_provar_command: description: | Checkout Code test cases from Git, run test cases and publish report usage: version: "2.1" orbs: browser-tools: circleci/browser-tools@1 provar: provartesting/provar@2.18 jobs: build: executor: name: provar/default tag: current-browsers parameters: build_file: default: build.xml type: string email_target: default: michael.dailey@provartesting.com type: string environment: default: Dev type: string license_path: default: /home/circleci/project/ProvarProject/.licenses type: string project_name: default: DemoProject type: string test_plan: default: Regression type: string steps: - checkout - provar/setup_provar: majorversion: << parameters.majorversion >> url: << parameters.url >> - browser-tools/install-chrome - browser-tools/install-chromedriver - run: command: sudo apt-get update -y && sudo apt-get install -y ant - provar/run_test_plans: build_file: << parameters.build_file >> email_target: << parameters.email_target >> environment: << parameters.environment >> license_path: << parameters.license_path >> project_name: << parameters.project_name >> test_plan: << parameters.test_plan >> - provar/store_provar_test_results: project_name: << parameters.project_name >> workflows: null use_provar_job: description: | Run provar tests using job usage: version: "2.1" orbs: provar: provartesting/provar@2.18 workflows: run_all: jobs: - provar/run_provar: build_file: build.xml email_target: noreply@example.com environment: "" license_path: /home/circleci/project/ProvarProject/.licenses majorversion: 2.14.1 name: Run Job that executes Provar tests project_name: DemoProject test_plan: Regression url: download.provartesting.com version: 2.1
Developer Updates
Get tips to optimize your builds
Or join our research panel and give feedback
By submitting this form, you are agreeing to ourTerms of UseandPrivacy Policy.