Testing: Configuration Tests

Testinfra tests verify the end state of the Vagrant machines. Any changes to the Ansible configuration should have a corresponding spectest.

Installation

pip install -r securedrop/requirements/develop-requirements.txt

Running the config tests

In order to run the tests, first create and provision the VM you intend to test. For the development VM:

vagrant up development

For the staging VMs:

vagrant up build --no-provision
vagrant up /staging/

Note

The staging machines must be rebooted via in order to finalize the iptables config. You must manually reboot the machines via vagrant reload /staging/ prior to running the config tests to ensure the config is valid.

Running all VMs concurrently may cause performance problems if you have less than 8GB of RAM. You can isolate specific machines for faster testing:

./testinfra/test.py development
./testinfra/test.py app-staging
./testinfra/test.py mon-staging

Note

The config tests for the app-prod and mon-prod hosts are incomplete. Further changes are necessary to run the tests via SSH over Authenticated Tor Hidden Service (ATHS), for both local testing via Vagrant and automated testing via CI.

Test failure against any host will generate a report with informative output about the specific test that triggered the error. The wrapper script will also exit with a non-zero status code.

Updating the config tests

Changes to the Ansible config should result in failing config tests, but only if an existing task was modified. If you add a new task, make sure to add a corresponding spectest to validate that state after a new provisioning run. Tests import variables from separate YAML files than the Ansible playbooks:

testinfra/vars/
├── app-prod.yml
├── app-staging.yml
├── build.yml
├── development.yml
├── mon-prod.yml
└── mon-staging.yml

Any variable changes in the Ansible config should have a corresponding entry in these vars files. These vars are dynamically loaded for each host via the testinfra/conftest.py file. Make sure to add your tests to relevant location for the host you plan to test:

testinfra/app/
├── apache
│   ├── test_apache_journalist_interface.py
│   ├── test_apache_service.py
│   ├── test_apache_source_interface.py
│   └── test_apache_system_config.py
├── test_apparmor.py
├── test_appenv.py
├── test_network.py
└── test_ossec.py

In the example above, to add a new test for the app-staging host, add a new file to the testinfra/spec/app-staging directory.

Config test layout

The config tests are mostly broken up according to machines in the Vagrantfile:

testinfra/
├── app
├── app-code
├── build
├── common
├── development
└── mon

Ideally the config tests would be broken up according to roles, mirroring the Ansible configuration. Prior to the reorganization of the Ansible layout, the tests are rather tightly coupled to hosts. The layout of config tests is therefore subject to change.

Config testing strategy

The config tests currently emphasize testing implementation rather than functionality. This is a temporary measure to increase the current testing baseline for validating the Ansible provisioning flow, to aid in migrating to a current version of Ansible (v2+). After the Ansible version is current, the config tests can be improved to validate behavior, such as confirming ports are blocked via external network calls, rather than simply checking that the iptables rules are formatted as expected.