Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for dep8 tests #3355

Draft
wants to merge 1 commit into
base: next-v36
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions dev-docs/howtoguides/run_dep8_tests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# How to run dep8 tests

The ubuntu-advantage-tools source package currently supports [dep8
tests]( https://salsa.debian.org/ci-team/autopkgtest/-/blob/master/doc/README.package-tests.rst).
Those dep8 tests can be found under `debian/tests/usage` and although they are currently only
running a few Pro client commands, the idea is to verify if any modification to our package dependencies
will affect the Pro client.

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,
and it will run for all releases by launchpad when dependencies are updated.
Loading