Skip to content

Commit

Permalink
docs: add documentation for dep8 tests
Browse files Browse the repository at this point in the history
We are now documenting our rationale for our dep8 tests while
also documenting how to run them locally
  • Loading branch information
lucasmoura authored and renanrodrigo committed Sep 5, 2024
1 parent 5e4948a commit 4cf189d
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions dev-docs/howtoguides/run_dep8_tests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# How to run dep8 tests

Our package currently supports [dep8
tests]( https://salsa.debian.org/ci-team/autopkgtest/-/blob/master/doc/README.package-tests.rst).
Those tests can be found under `debian/tests/usage` and although the test is running
some Pro client commands, the idea is to verify if any modification to our package dependencies
will affect the execution of this command.

Right now, we are looking for signal from our `python3-apt` dependency. That's why we are running
the `packages` API there, as those endpoints directly interact with APT.

If you perform any modification to those tests, you can verify it by following these steps:

1. Install the `autopkgtest` application:

```shell
sudo apt install autopkgtest
```

2. Run the following command:

```shell
autopkgtest -U --shell-fail . -- lxd ubuntu:xenial
```

Note that you can run this command on any release we support, not only Xenial.

0 comments on commit 4cf189d

Please sign in to comment.