Skip to content
This repository was archived by the owner on Jul 2, 2026. It is now read-only.

W-20148320: update readme #95

Open
peternhale wants to merge 2 commits into
base: main
Choose a base branch
from
Open

W-20148320: update readme #95

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c28bcfd
fix: [W-20148320] update readme
peternhale Nov 6, 2025
136bcbf
fix: [W-20148320] update readme
peternhale Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,4 @@ yarn-error.log*
.wireit
/salesforcedx-vscode
/.cursor
/test-resources
50 changes: 34 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,30 +97,48 @@ This repository is published and used as an npm module, currently imported by `s

@madhur310 madhur310 Nov 6, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't seem to add a comment on line 36, but since you are updating this - do you mind removing line: The full API documentation is available at [https://forcedotcom.github.io/salesforcedx-vscode-test-tools](https://forcedotcom.github.io/salesforcedx-vscode-test-tools). it wrong and the link doesn't work.

@CristiCanizales CristiCanizales Nov 6, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a suggestion for that heh

The following environment variables can be used to configure the automation tests. These are managed by the `EnvironmentSettings` class.

| Environment Variable | Description | Default Value |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| `VSCODE_VERSION` | VSCode version to use in tests | `'latest'` |
| `SPEC_FILES` | Test spec filename(s) to run, will be prefixed with 'lib/specs/' | `[]` |
| `VSIX_TO_INSTALL` | Path to directory containing VSIX files to install | `undefined` |
| `DEV_HUB_ALIAS_NAME` | Alias for the DevHub org | `'vscodeOrg'` |
| `DEV_HUB_USER_NAME` | Username for the DevHub org | - |
| `SFDX_AUTH_URL` | URL for authenticating with Salesforce DX | `undefined` |
| `EXTENSION_PATH` | Path to extensions directory | `{cwd}/../../salesforcedx-vscode/extensions` |
| `SALESFORCEDX_VSCODE_EXTENSIONS_PATH` | Alternative path to extensions (takes precedence over EXTENSION_PATH) | - |
| `THROTTLE_FACTOR` | Number to multiply timeouts by (used to slow down test execution) | `1` |
| `JAVA_HOME` | Path to Java installation | `undefined` |
| `USE_EXISTING_PROJECT_PATH` | Path to an existing project to use instead of creating a new one | `undefined` |
| `E2E_LOG_LEVEL` | Log level for test execution (one of the valid log levels: 'error', 'warn', 'info', 'debug', 'trace') | `'info'` |
| Environment Variable | Description | Default Value | Required? |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------- | --------- |
| `VSCODE_VERSION` | VSCode version to use in tests | `'latest'` | No |
| `SPEC_FILES` | Test spec filename(s) to run, will be prefixed with 'lib/specs/' | `[]` | No |
| `VSIX_TO_INSTALL` | Path to directory containing VSIX files to install | `undefined` | Yes\* |
| `DEV_HUB_ALIAS_NAME` | Alias for the DevHub org | `'vscodeOrg'` | Yes\*\* |
| `DEV_HUB_USER_NAME` | Username for the DevHub org | - | Yes\*\* |
| `SFDX_AUTH_URL` | URL for authenticating with Salesforce DX | `undefined` | Yes\*\* |
| `EXTENSION_PATH` | Path to extensions directory | `{cwd}/../../salesforcedx-vscode/extensions` | No |
| `SALESFORCEDX_VSCODE_EXTENSIONS_PATH` | Alternative path to extensions (takes precedence over EXTENSION_PATH) | - | No |
| `THROTTLE_FACTOR` | Number to multiply timeouts by (used to slow down test execution) | `1` | No |
| `JAVA_HOME` | Path to Java installation | `undefined` | No |
| `USE_EXISTING_PROJECT_PATH` | Path to an existing project to use instead of creating a new one | `undefined` | Yes\* |
| `E2E_LOG_LEVEL` | Log level for test execution (one of the valid log levels: 'error', 'warn', 'info', 'debug', 'trace') | `'info'` | No |
| `TEST_RESOURCES` | Path to workspace directory where VS Code and test artifacts are stored | `[project_root]/test-resources` | Yes\* |

\* Required when used (conditional requirement)
\*\* Required when org authorization is needed

#### Usage Notes

- **SPEC_FILES**: If specified, only the named test spec files will be run instead of all tests

- **EXTENSION_PATH**: If your folder structure does not match the standard folder structure shown in the Getting Started section, `EXTENSION_PATH` will need to be set to the correct relative path to 'salesforcedx-vscode/extensions'

- **SFDX_AUTH_URL**: To obtain this URL, run `sf org display -o <myDevHub> --verbose --json` in your terminal and extract the value from the `sfdxAuthUrl` property
- **DEV_HUB_USER_NAME**: **Required** when org authorization is needed. Missing this will cause an initialization error when `verifyAliasAndUserName()`, `setupAndAuthorizeOrg()`, or `authorizeDevHub()` are called.

- **USE_EXISTING_PROJECT_PATH**: If specified, must point to a valid existing project directory. The test framework will use this project instead of creating a new one
- **DEV_HUB_ALIAS_NAME**: **Required** when org authorization is needed. Has a default value of `'vscodeOrg'`, but must be set correctly to match an existing org. Missing this will cause an initialization error during org authorization setup.

- **SFDX_AUTH_URL**: **Required** when:

- `orgLoginSfdxUrl()` is called directly
- `setupAndAuthorizeOrg()` is called and no existing authentication is found
- `authorizeDevHub()` is called (which calls `orgLoginSfdxUrl()`)

To obtain this URL, run `sf org display -o <myDevHub> --verbose --json` in your terminal and extract the value from the `sfdxAuthUrl` property. Missing this will cause an initialization error when attempting to authenticate with Salesforce.

- **VSIX_TO_INSTALL**: **Required** when `installExtensions()` is called. If set, the directory must exist or an initialization error will be thrown.

- **USE_EXISTING_PROJECT_PATH**: If specified, must point to a valid existing project directory. The test framework will use this project instead of creating a new one. **Required** when set - the path must exist or an initialization error will be thrown.

- **TEST_RESOURCES**: **Required** when `validateTestConfig()` is called and neither `testResources` nor `workspacePath` is set. Has a default value, but if both are missing, an initialization error will be thrown.

- **THROTTLE_FACTOR**: Useful for debugging tests by slowing down UI interactions. For example, setting to `2` will make tests run at half speed

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading