Skip to content

Latest commit

 

History

History
178 lines (126 loc) · 6.55 KB

README.rst

File metadata and controls

178 lines (126 loc) · 6.55 KB
Raw

CI

BCI tests

What is this?

This is our tooling to test the BCI containers, ensuring they are matching what our ISVs are expecting, e.g.:

  • ensure that they don't exceed a certain size,
  • working with multi-stage dockerfiles,
  • able to build common software for the languages stacks that we provide,
  • test how they behave in FIPS enabled environments,
  • ...

How can I contribute?

  • Create a PR to increase test coverage (See below for further information).
  • Create an issue, stating your use case.
  • Improve our documentation.

What do I need to contribute?

  • A host with python 3.6+, gcc and the python development header files
  • tox
  • go
  • docker and/or podman+buildah
  • vagrant (optional, can be used to test FIPS mode and registered hosts)

How can I run the tests?

  1. Ensure that you have the dependencies installed
  2. Optionally set the BCI_DEVEL_REPO environment variable (see next section).
  3. Run tox -e build (this is not strictly necessary to run beforehands, but it will reduce the danger of race conditions when building containers)
  4. Run tox -e $language_stack -- -n auto

Technical contributions

The base container

We are basing most of our tests on _the_ base container (available via the BASE_CONTAINER variable in :file:`bci_tester/data.py`). This container is pulled directly from registry.suse.de and is being build from the SUSE:SLE-15-SP3:Update:CR:ToTest/sles15-image package.

That container is automatically configured at build time to contain the SLE_BCI repository from update.suse.com (i.e. the repository after QA tested it). We also want to be able to test the current development state of the SLE_BCI repository. This can be achieved by setting the environment variable BCI_DEVEL_REPO to the url of the development/snapshot state. It is published on dist.nue.suse.com in one of the subfolders of http://dist.nue.suse.com/ibs/SUSE:/SLE-15-SP3:/Update:/BCI/images/repo/. Unfortunately, you have to hand pick the correct folder (use the one ending with -Media1 and for the correct arch) because the build number is put into the folder name.

The BASE_CONTAINER will then be rebuild with the SLE_BCI repository replaced with the one from the BCI_DEVEL_REPO and all tests will thus use the new repository.

Adding new containers and their tests

  1. Find container "type" or "language". When adding a new container, be sure to add it to :file:`bci_tester/data.py`, optionally also include it in the if branch to replace the SLE_BCI repository.
  2. Add it into :file:`tox.ini` in envlist, if not present.
  3. Create or update a file named :file:`test_<container_type>.py` (for example, :file:`test_python.py`)
  4. Add your tests there based on testinfra and pytest_container

Extending coverage/Writing tests for existing containers

Just use testinfra documentation (linked above). It should be easy.

You can use the convenience tools from conftest:

  • If you are using the auto_container fixture, your test will automatically be run for all containers defined in the module variables CONTAINER_IMAGES.

The container fixture

The auto_container fixture contains the black magic to run tests for all container images without having to parametrize everything yourself. If you need to run a test only for certain versions of a language stack, you have the following three options (by order of preference):

  1. Use the container fixture and parametrize it yourself.
  2. Create your own fixture

Adding additional container run and build parameters

It is sometimes necessary to add additional parameters to the docker build or docker run invocation, for it to succeed. E.g. when the docker network needs access to a VPN connection to access dist.nue.suse.de, then one has to run docker with --network=host.

This can be achieved by setting the environment variables EXTRA_RUN_ARGS and EXTRA_BUILD_ARGS to whatever should be added to the calls to docker run / podman run and docker build / buildah bud, respectively.

Running all tests

$ tox --parallel

For CI environments it is recommended to set the environment variable TOX_PARALLEL_NO_SPINNER to 1 so that the output from tox is not mangled.

Running tests in production

Some of the tests can be a bit flaky due to network resources not being available. To avoid these issues, we make use of the pytest-rerunfailures plugin. To enable it, invoke tox with the --reruns command line flag as follows:

$ tox -e test_name -- --reruns 3 --reruns-delay 10

The option --reruns-delay delays the rerun (in this case) by 10 seconds, thereby reducing the likelihood of another network issue.

Running specific tests

$ tox -e testname

testname equals to python for the test file named :file:`test_python.py`

This will run _all_ the tests for a language, which could mean multiple stacks. If you have Python 3.6 or later available and have the python development headers installed, then pytest-xdist will be installed as well and can be used to launch the tests of a single test suite in parallel via:

$ tox -e testname -- -n auto

Testing on FIPS enabled systems

The base container tests execute a different set of tests on a FIPS enabled system. Currently, the CI does not run on such a system, so these must be executed manually. If you do not have access to such a system, you can use a prebuild vagrant box from the Open Build Service for this.

Install vagrant and run vagrant up in the root directory of this repository. The provisioning script defined in the :file:`Vagrantfile` will automatically run the base container tests.