Concepts
Learn the key concepts that form the foundation of Doc Detective.
Test specification
A test specification is a group of tests to run in one or more contexts. Conceptually parallel to a document.
Test
A test is a sequence of steps to perform. Conceptually parallel to a procedure.
Step
A step is a portion of a test that includes a single action. Conceptually parallel to a step in a procedure.
Action
An action is the task performed in a step. Doc Detective supports a variety of actions:
| Name | Description |
|---|---|
| checkLink | Check if a URL returns an acceptable status code from a GET request. |
| find | Locate and interact with an element on the page. |
| goTo | Navigate to a specified URL. |
| httpRequest | Perform a generic HTTP request, for example to an API. |
| runShell | Perform a native shell command. |
| saveScreenshot | Take a screenshot in PNG format. |
| setVariables | Load environment variables from a .env file. |
| startRecording | Capture a video of test run. |
| stopRecording | Stop capturing a video of test run. |
| typeKeys | Type keys. To type special keys, begin and end the string with $ and use the special key’s enum. For example, to type the Escape key, enter $ESCAPE$. |
| wait | Pause before performing the next action. |
Context
A context consists of an application and platforms that support the tests.