Skip to content

Commit

Permalink
YAML documentation: Add section on step timeouts (#33640)
Browse files Browse the repository at this point in the history
  • Loading branch information
cecille authored and pull[bot] committed Sep 27, 2024
1 parent 68da497 commit 07c99ca
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/testing/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,17 @@ function can be use. See
[TestEqualities](https://github.com/project-chip/connectedhomeip/blob/master/src/app/tests/suites/TestEqualities.yaml)
for an example of how to use this pseudo-cluster.

#### Setting step timeouts

The timeout argument can be used for each individual test step to set the time
the runner will wait for a test step to complete before reporting a failure.

Note that this timeout is different than the subscription report timeout and the
subscription report timeout is not currently adjustable in YAML.

There several other options for configuring test steps as shown in the
[YAML schema](./yaml_schema.md) document.

## Running YAML tests

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

First activate the matter environment using either

```
. ./scripts/bootstrap.sh
```

or

```
. ./scripts/activate.sh
```

bootstrap.sh should be used for for the first setup, activate.sh may be used for
subsequent setups as it is faster.

Next build the python wheels and create a venv (called `py` here, but any name
may be used)

```
./scripts/build_python.sh -i py
source py/bin/activate
Expand Down

0 comments on commit 07c99ca

Please sign in to comment.