ProvarDX™

ProvarDX™ is a Salesforce CLI Plugin for existing Provar customer to allow them to execute Provar Test Cases from the command line, leveraging the Salesforce CLI and SalesforceDX applications. This provides an alternative mechanism for running test cases than running under ANT.
You must be a Provar customer with a valid paid license to write and maintain your test cases.


Installation into the Salesforce CLI

Install the plugin into your Salesforce CLI using this command:

``sh-session
$ sfdx plugins:install @provartesting/provardx
`

To check list of installed plugins and their versions use following command:

`sh-session
$ sfdx plugins
`

To update the sdfx plugin use following command:

`sh-session
$ sfdx plugins:update
`

Uninstall the plugin using this command:

`sh-session
$ sfdx plugins:uninstall @provartesting/provardx
`

By default, the Salesforce CLI periodically checks for and installs updates for sfdx and the salesforcedx plug-in. To disable sfdx auto-update, set the SFDX_AUTOUPDATE_DISABLE environment variable to true.

Commands

* sfdx provar:compile
* sfdx provar:metadatacache
* sfdx provar:runtests
* sfdx provar:validate

sfdx provar:compile

Pre-compiles any /src PageObject or PageControl Java source files into object code to use in runtests

`
USAGE
$ sfdx provar:compile [-p ] [-h ] [-c ] [--json] [-l ]

OPTIONS
-c, --projectpath=projectpath Specify project path override
-h, --provarhome=provarhome Specify provar home override
-l, --loglevel=loglevel Specify log level for command output
-p, --propertyfile=propertyfile Specify custom property file.
--json format output as json

EXAMPLE
$ sfdx provar:compile -p './myproperties.json' --json --loglevel SEVERE
`

sfdx provar:metadatacache

Command to pre-download any required metadata for a specified user or provar connection

`
USAGE
$ sfdx provar:metadatacache [-m ] [-c ] [-p ] [-n ] [-o ] [--json] [-l
]

OPTIONS
-c, --cachepath=cachepath Relative or full file path for where the metadata cache will be stored.
-l, --loglevel=loglevel Specify the log level for command

-m, --metadatalevel=metadatalevel Permitted values reload (get all metadata - default) | refresh (only
download changes).

-n, --connections=connections Specify the name of connection for which metadata to be downloaded.

-o, --connectionoverrides=connectionoverrides Specify comma seperated values for connection overrides, eg
Admin:test@provar.com,Reg:test1@provar.com

-p, --propertyfile=propertyfile Specify custom property file.

--json format output as json

EXAMPLE
$ sfdx provar:metadatacache -m 'refresh' -c './metadata' -f './myproperties.json'
`

sfdx provar:runtests

Runs a specified list of Provar test cases against a specified DevHub user alias or username

`
USAGE
$ sfdx provar:runtests [-f ] [-p ] [-o ] [-c ] [-m ] [-s ] [--json]
[-l ]

OPTIONS
-c, --cachepath=cachepath Specify relative or full file path for where a metadata cache has
already been downloaded using either a VCS extract or metadata
ProvarDX command.

-f, --filespec=filespec Specify comma-delimited, ordered paths of test cases to be
executed. If not provided all tests in the PROJECTPATH will be
executed.

-l, --loglevel=loglevel Specify the level of feedback provided during the compilation
(see above) and execution.

-m, --metadatalevel=metadatalevel Specify permitted values reload (get all metadata - default) |
refresh (only download changes). This overrides any settings made
in the propertyfile.

-o, --connectionoverridefile=connectionoverridefile Connection file in the format provardx-connection-schema.json
providing a mapping between the Provar project Connection names
and the target users to be used.

-p, --propertyfile=propertyfile provardx-properties.json file. If filepath specified the filename
will be assumed or it can be specified (.e.g myprops.json). File
must be in JSON format and conform to the provardx-properties
JSON schema.

-s, --secrets=secrets Specify a secrets encryption key for accessing the chosen project/environment.

--json format output as json

EXAMPLE
$ sfdx provar:runtests -f './myproperties.json'
`

sfdx provar:validate

Verify a property file to confirm it is a well formed provardx property file

`
USAGE
$ sfdx provar:validate [-p ] [--json] [-l ]

OPTIONS
-l, --loglevel=loglevel Allow to provide loglevels.
-p, --propertyfile=propertyfile Specify custom property file.
--json format output as json

EXAMPLES
$ sfdx provar:validate
Property file is valid.

$ sfdx provar:validate --json
Invalid property file.
[Detailed validation error shown]

$ sfdx provar:validate -p './provardx-properties.json' --json
Invalid property file.
[Detailed validation error shown]
``