Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.

[[Docs]] Updated Testing.md to include all requirement options of TestSkipIf and TestSkipIfNot #6642

Merged
montegoulding merged 1 commit into from
Aug 19, 2018
Merged

[[Docs]] Updated Testing.md to include all requirement options of TestSkipIf and TestSkipIfNot #6642

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 19 additions & 4 deletions docs/development/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,33 @@ Before running each test command, the test framework inserts a test library stac
* `TestAssert pDescription, pExpectTrue`: Make a test assertion. The test is recorded as a failure if *pExpectTrue* is false. *pDescription* should be a short string that describes the test (e.g. "clipboard is clear").
* `TestSkip pDescription, pReasonSkipped`: Record a test as having been skipped. *pReasonSkipped* should be a short explanation of why the test was skipped (e.g. "not supported on Windows").
* `TestSkipIf pRequirement, pOptions`: Skip a test if the requirements
are met. `pOptions` varies depending on the `pRequirement` enum. The
following requirements are implemented:
- `ide` - the IDE repo is available. No options.
are met. `pOptions` varies depending on the `pRequirement` enum (if no
options are explicitly specified then no options are available for that
particular `pRequirement`. The following requirements are implemented:
- `ide` - the IDE repo is available
- `lcb` - LCB compilation supported
- `docs` - the docs are available. No options.
- `docs` - the docs are available
- `standalone` - the test is running in the standalone test runner
- `securityPermissions` - Option `set` to skip if a test should not
set the `securityPermissions`
- `platform` - options are comma delimited platform strings
- `processor` - options are comma delimited processor strings
- `stack` - options are comma delimited stack names to test if they
are available
- `environment` - options are comma delimited environment strings
- `clipboard` - access to the clipboard is available
- `wait` - the `wait` command is available and works as expected
- `security` - the security module is available
- `write` - write access to the filesystem is available
- `ui` - the test is running in a graphical environment (as opposed
to the command line)
- `desktop` - the test is running on a desktop computer
- `mobile` - the test is running on a mobile device
- `external` - an external module can be loaded/used. Options are a
comma delimited list of external module names
- `database` - an database module can be loaded/used. Options are a
comma delimited list of external module names
- `jvm` - the Java Virtual Machine is available
* `TestSkipIfNot pRequirement, pOptions`: Skip a test if the
requirements are not met. Requirements and options are the same as for
`TestSkipIf`.
Expand Down