-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Move utils package to top * Move Chip Tool tests to https://github.com/canonical/chip-tool-snap * Remove obsolete code and doc * Update unit testing triggers
- Loading branch information
Showing
23 changed files
with
11 additions
and
567 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,89 +1,8 @@ | ||
| # Matter Snap Tests (WIP) | ||
| Test scripts, Github actions, and workflows for the [Matter](https://github.com/project-chip/connectedhomeip/tree/master) snaps. | ||
| # Matter Snap Testing | ||
|
|
||
| The following diagram shows the Snap Testing workflow for building and testing snaps from upstream source code: | ||
| ```mermaid | ||
| --- | ||
| title: Snap Testing Workflow | ||
| --- | ||
| flowchart LR | ||
| subgraph build [Build Job] | ||
| builda[[Build Action]] --> Source | ||
| --> Build[Build Snap] | ||
| --> Snap[/Artifact<br>Snap/] | ||
| end | ||
| subgraph test [Test Job] | ||
| Snap -.-> testa[[Test Action]] | ||
| --> gotests[Go Test Suites] | ||
| --> Logs[/Artifact<br>Logs/] | ||
| end | ||
| ``` | ||
|
|
||
| The Github Workflow configurations (triggers, jobs, etc) are maintained in respective upstream source codes. | ||
| The Github Actions and testing suites are maintained in this repository. | ||
|
|
||
| ## Test locally | ||
| This section includes example command to run tests. | ||
|
|
||
| Useful `go test` flags are: | ||
| - `-v` is to enable verbose output | ||
| - `-failfast` makes the test stop after first failure | ||
| - `-timeout 60m` extends the timeout to longer than the default 10m | ||
| - `-count 1` is to avoid Go test caching for example when testing a rebuilt snap | ||
|
|
||
| #### Run one testing suite | ||
| ```bash | ||
| go test -v -failfast -count 1 ./test/suites/chip-tool | ||
| ``` | ||
|
|
||
| #### Run all suites | ||
| ```bash | ||
| go test -p 1 -timeout 60m -failfast -count 1 ./test/suites/... | ||
| ``` | ||
| Utility package for testing Matter snaps in Go. | ||
|
|
||
| #### Run one suite with env variables | ||
| The environment variables are defined in [test/utils/env.go](./test/utils/env.go) | ||
|
|
||
| #### Test the testing utils | ||
| ```bash | ||
| go test ./test/utils -count=10 | ||
| Test the testing utils: | ||
| ``` | ||
|
|
||
| ## Test using Github Actions | ||
| This project includes two Github Actions that can be used in workflows to test snaps: | ||
| * [build](./build): Checkout code, build the snap, and upload snap as build artifact | ||
| * [test](./test): Download the snap from build artifacts (optional) and run smoke tests | ||
|
|
||
| A workflow that uses both the actions from `v2` branch may look as follows: | ||
|
|
||
| `.github/workflows/snap.yml` | ||
| ```yaml | ||
| name: Snap Testing | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [ main ] | ||
| # allow manual trigger | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Build and upload snap | ||
| id: build | ||
| uses: canonical/matter-snap-testing/build@v2 | ||
| outputs: | ||
| snap: ${{steps.build.outputs.snap}} | ||
|
|
||
| test: | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Download and test snap | ||
| uses: canonical/matter-snap-testing/test@v2 | ||
| with: | ||
| name: device-mqtt | ||
| snap: ${{needs.build.outputs.snap}} | ||
| go test ./utils -count=100 | ||
| ``` | ||
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.