Skip to content

Commit a98dc79

Browse files
authored
YAML documentation: Add section on step timeouts (#33640)
1 parent 6368d7d commit a98dc79

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/testing/yaml.md

+29
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,17 @@ function can be use. See
279279
[TestEqualities](https://github.com/project-chip/connectedhomeip/blob/master/src/app/tests/suites/TestEqualities.yaml)
280280
for an example of how to use this pseudo-cluster.
281281

282+
#### Setting step timeouts
283+
284+
The timeout argument can be used for each individual test step to set the time
285+
the runner will wait for a test step to complete before reporting a failure.
286+
287+
Note that this timeout is different than the subscription report timeout and the
288+
subscription report timeout is not currently adjustable in YAML.
289+
290+
There several other options for configuring test steps as shown in the
291+
[YAML schema](./yaml_schema.md) document.
292+
282293
## Running YAML tests
283294

284295
YAML scripts are parsed and run using a python-based runner program that parses
@@ -304,6 +315,24 @@ There are several options for running tests locally. Because the YAML runner
304315
uses python, it is necessary to compile and install the chip python package
305316
before using any YAML runner script.
306317

318+
First activate the matter environment using either
319+
320+
```
321+
. ./scripts/bootstrap.sh
322+
```
323+
324+
or
325+
326+
```
327+
. ./scripts/activate.sh
328+
```
329+
330+
bootstrap.sh should be used for for the first setup, activate.sh may be used for
331+
subsequent setups as it is faster.
332+
333+
Next build the python wheels and create a venv (called `py` here, but any name
334+
may be used)
335+
307336
```
308337
./scripts/build_python.sh -i py
309338
source py/bin/activate

0 commit comments

Comments
 (0)