API Testing
Provar Automation provides various APIs to assist in rapidly creating and maintaining test data. To add an API test step, click on a row in the org browser and drag it into your test case. These APIs can also be used to mass-create or update test data, working alongside a source such as an Excel spreadsheet.
SOQL query
A SOQL Query test step is useful for pulling data from specific Salesforce records. Refer to Salesforce’s documentation for more information on SOQL.
To use this API, click and drag a row from the org browser into the test case, then select Add a SOQL Query Step. Ensure that the row chosen in the org browser corresponds to the object you want to query (e.g., Opportunity).
Select which fields to return in the query. Then click the OK button.
This will automatically generate a simple SOQL statement. This statement can be amended manually, e.g., to add a WHERE clause. Refer to the Org Browser if unsure of any field’s name.
When this test step is executed, it will populate OpportunityRows or whatever name is specified in the Result List Name (see screenshot above). This can then be accessed in subsequent test steps. A period can be added after OpportunityRows to access a specific variable, e.g., OpportunityRows.Name.
Read/assert
A Read/Assert test step helps validate or check data.
To use this API, click and drag a row of data from the org browser into the test case, then select Add an Object read/assert step. Ensure that the row in the org browser corresponds to the object you want to read/assert (e.g., Opportunity).
In the following form, tick fields in the first column to read values and tick fields in the second column to create assertions. Then click the OK button.
This will automatically generate the following test step.
Note: An Object Id is required to run this test step.
In this example, reads and asserts have both been added. To add or remove fields after the test step has been added, click the icon at the top of the Test Step parameters.
Read results will be added to the result object OpportunityRead or whatever name is specified in the Result Object (see screenshot above). This can then be accessed in subsequent test steps. A period can be added after OpportunityRead to access a specific variable, e.g., OpportunityRead.StageName.
Asserts have been added as separate sections, validating specific values for Name and Stage. If these are not passed during execution, the test step will fail.
Create
A Create test step helps create records.
To use this API, click and drag a row from the org browser into the test case, then select Add an Object create step. Ensure that the row chosen in the org browser corresponds to the object you want to create (e.g., Opportunity).
Select which fields to populate in the test step. Note that the required fields are ticked automatically. Then click the OK button.
This will automatically generate the following test step.
Note: The selected fields are shown under the Fields section.
To add or remove fields after the test step has been added, click the icon at the top of the Test Step parameters.
When this test step is executed, a new record will be created, and the record ID will be added to the variable named in Result Object Id, e.g., OpportunityId.
Update
An Update test step helps amend record information at the API level.
To use this API, click and drag a row from the org browser into the test case, then select Add an Object update step. Ensure that the row chosen in the org browser corresponds to the object you want to update (e.g., Opportunity).
Select which fields to populate in the test step. Note that required fields are also identified. Make sure that the Object Id correctly identifies the record to be updated. Where applicable, it will be pre-populated based on the data row chosen from the org browser, but it should generally be updated to a variable storing the record Id, e.g., OpportunityId. Use Content Assist to locate the correct variable (CTRL + spacebar). In this example, OpportunityId is populated through the preceding Create test step.
Note: An Object Id is required to run this test step. The fields to be updated are shown under the Fields section.
To add or remove fields after the test step has been added, click the icon at the top of the Test Step parameters.
Delete
A Delete test step deletes a record at the API level.
To use this API, click and drag a row of data from the org browser into the test case, then select Add an Object delete step. Ensure that the row chosen in the org browser corresponds to the object you want to delete (e.g., Opportunity).
For more information, check out this course on University of Provar.
- Provar Automation
- System Requirements
- Browser and Driver Recommendations
- Installing Provar Automation
- Updating Provar Automation
- Licensing Provar
- Granting Org Permissions to Provar Automation
- Optimizing Org and Connection Metadata Processing in Provar
- Using Provar Automation
- API Testing
- Behavior-Driven Development
- Consolidating Multiple Test Execution Reports
- 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
- Japanese Language Support
- Override Auto-Retry for Test Step
- Mapping and Executing the Lightning Article Editor in Provar
- Managing Test Steps
- Namespace Org Testing
- NitroX
- Provar Automation
- Provar Test Builder
- ProvarDX
- Refresh and Recompile
- Reintroduction of CLI License Check
- 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
- Provar Manager
- How to Use Provar Manager
- Provar Manager Setup
- Provar Manager Integrations
- Release Management
- Test Management
- Test Operations
- Provar Manager and Provar Automation
- Setting Up a Connection to Provar Manager
- Object Mapping Between Automation and Manager
- How to Upload Test Plans, Test Plan Folders, Test Plan Instances, and Test Cases
- Provar Manager Filters
- Uploading Callable Test Cases in Provar Manager
- Uploading Test Steps in Provar Manager
- How to Know if a File in Automation is Linked in Test Manager
- Test Execution Reporting
- Metadata Coverage with Manager
- Provar Grid
- DevOps
- Introduction to Provar DevOps
- Introduction to Test Scheduling
- Apache Ant
- Configuration for Sending Emails via the Automation Command Line Interface
- Continuous Integration
- AutoRABIT Salesforce DevOps in Provar Test
- Azure DevOps
- Running a Provar CI Task in Azure DevOps Pipelines
- Configuring the Automation 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
- Integrating GitHub Actions CI to Run Automation CI Task
- 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 Continuous Integration
- Travis CI
- Jenkins
- Execution Environment Security Configuration
- Provar Jenkins Plugin
- Parallel Execution
- Running Provar on Linux
- Reporting
- Salesforce DX
- Git
- Version Control
- Masking Provar Credentials on CI
- Salesforce Testing
- Best Practices
- Improve Your Metadata Performance
- Java 21 Upgrade
- Salesforce Connection Best Practices
- Testing Best Practices
- Automation Planning
- Supported Testing Phases
- Provar Naming Standards
- Test Case Design
- Create records via API
- Avoid using static values
- Abort Unused Test Sessions/Runs
- Avoid Metadata performance issues
- Increase auto-retry waits for steps using a global variable
- Create different page objects for different pages
- The Best Ways to Change Callable Test Case Locations
- Working with the .testProject file and .secrets file
- Best practices for the .provarCaches folder
- Best practices for .pageObject files
- Troubleshooting
- How to Use Keytool Command for Importing Certificates
- Installing Provar After Upgrading to macOS Catalina
- Browsers
- Configurations and Permissions
- Connections
- DevOps
- Error Messages
- Provar Manager 3.0 Install Error Resolution
- Provar Manager Test Case Upload Resolution
- Administrator has Blocked Access to Client
- JavascriptException: Javascript Error
- macOS Big Sur Upgrade
- Resolving Failed to Create ChromeDriver Error
- Resolving Jenkins License Missing Error
- Resolving Metadata Timeout Errors
- Test Execution Fails – Firefox Not Installed
- Selenium 4 Upgrade
- Licensing, Installation and Firewalls
- Memory
- Test Builder and Test Cases
- Release Notes