felipe/apparmor.d
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: update integration tests section.

Browse source
This commit is contained in:
Alexandre Pujol 2025-03-01 16:04:18 +01:00
parent 835b73f64e
commit fa6c37a7ab
No known key found for this signature in database
GPG key ID: C5469996F0DF68EC
5 changed files with 161 additions and 136 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/development/tests.md
View file

@ -1,15 +1,37 @@
---
title: Tests suite
title: Overview
---
A full test suite to ensure compatibility across supported distributions and that software is still considered a work in progress. Here is an overview of the current CI jobs:
Misconfigured AppArmor profiles is one of the most effective ways to break someone's system. This section present the various tests applied to the profiles as well as their current stage of deployment.
**On Gitlab CI**
**Current**
- Packages build for all supported distributions
- Profiles preprocessing verification for all supported distributions
- Go based command linting, coverage, and unit tests
- [x] **[Build:](https://gitlab.com/roddhjav/apparmor.d/-/pipelines)** `make`
- Build the profiles for all supported distributions.
- All CI jobs validate the profiles syntax and ensure they can be safely loaded into a kernel.
- Ensure the profile entry point (`@{exec_path}`) is defined.
**On Github Action**
- [x] **[Checks:](https://github.com/roddhjav/apparmor.d/blob/main/tests/check.sh)** `make check` checks basic style of profiles:
- Ensure apparmor.d header & licence
- Ensure 2 spaces indentation
- Ensure local include for profile and subprofiles
- Ensure abi 4 is used
- Ensure modern profile naming
- Ensure `vim:syntax=apparmor`
- Integration test on the ubuntu-latest VM: run a simple list of tasks with all the rules enabled and ensure no new issue has been raised. Github Action is used as it offers direct access to a VM with AppArmor included.
- [x] **[Integration Tests:](integration.md)** `make integration`
- Run simple CLI commands to ensure no logs are raised.
- Uses the [bats](https://github.com/bats-core/bats-core) test system.
- Run in the Github Action as well as in all local [test VM](vm.md).
**Plan**
For more complex software suite, more integration tests need to be done. The plan is to run existing integration suite from these very software in an environment with `apparmor.d` profiles.
- [ ] Systemd
- They use mkosi to generate a VM image to run their own integration tests.
- See https://www.codethink.co.uk/articles/2024/systemd-integration-testing-part-1/
- [ ] Gnome
- They use openQA to run their integration tests.
- See https://gitlab.gnome.org/GNOME/openqa-tests/