Skip to content

Commit

Permalink
[docs] Improve docs on chip-tool tests. Add example. Fix broken links.
Browse files Browse the repository at this point in the history
  • Loading branch information
turon committed May 5, 2022
1 parent 62fdb60 commit 41c00eb
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
20 changes: 20 additions & 0 deletions docs/guides/chip_tool_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,26 @@ In this command:
- _<test_name\>_ is the name of the particular test.
#### Example: running TestClusters test
As an example of running one test suite test:
```
# Clean initialization of state.
rm -fr /tmp/chip_*

# In a shell window, start the DUT device.
./out/debug/standalone/chip-all-clusters-app

# In a second shell window, pair the DUT with chip-tool.
./out/debug/standalone/chip-tool pairing onnetwork 1 20202021

# Now run the test
./out/debug/standalone/chip-tool tests TestCluster --nodeId 1
```
Developer details on how the test suite is structured can be found [here](../../src/app/tests/suites/README.md).
### Parsing the setup payload
The CHIP Tool offers a utility for parsing the Matter onboarding setup payload
Expand Down
4 changes: 2 additions & 2 deletions src/app/tests/suites/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,10 +246,10 @@ Top level key to define a YAML test: [test](#property-test)
[tests.js](../../../../examples/placeholder/linux/apps/app1/tests.js)

- chip-tool(darwin) tests:
[tests.js](../../../../examples/chip-tool-darwin/templates/tests.js)
[tests.js](../../../../examples/chip-tool-darwin/templates/tests/tests.js)

- chip-tool tests:
[tests.js](../../../../examples/chip-tool/templates/tests.js)
[tests.js](../../../../examples/chip-tool/templates/tests/tests.js)

```javascript
// Manual test definitions. Does not run in CI.
Expand Down

0 comments on commit 41c00eb

Please sign in to comment.