wbrawner/toolbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
toolbox/test/system
History
Debarshi Ray 8f6e47a191 test/system: Avoid future problems caused by Bat's 'run' overwriting 'i' 
Until Bats 1.10.0, 'run' with options had a bug where it would overwrite
the value of the 'i' variable even outside 'run' [1].

In these particular instances, no options are being passed to 'run',
and, hence, currently there's no problem.  However, in case a future
commit adds an option, then it could lead to hard-to-debug problems.
eg., --separate-stderr sets 'i' to 1, --show-output-of-passing-tests
sets it to 2, etc..  Therefore, depending on the flag and the loop, the
loop might get terminated prematurely or run infinitely or something
else.

Moreover, Bats 1.10.0 is only available in Fedora >= 39 and is absent
from Fedoras 37 and 38.  Therefore, it's not possible to consider this
bug fixed.

Hence, it's better to preemptively work around it to avoid any future
issues.

[1] Bats commit 502dc47dd063c187
    https://github.com/bats-core/bats-core/commit/502dc47dd063c187
    https://github.com/bats-core/bats-core/issues/726

https://github.com/containers/toolbox/pull/1373
2023-09-21 19:22:24 +02:00
..
libs test/system: Avoid future problems caused by Bat's 'run' overwriting 'i' 2023-09-21 19:22:24 +02:00
001-version.bats test/system: Silence SC2154 2023-09-20 01:33:29 +02:00
002-help.bats test/system: Silence SC2086 2023-09-19 14:29:17 +02:00
101-create.bats test/system: Silence SC2155 2023-09-20 10:24:29 +02:00
102-list.bats test/system: Silence SC2154 2023-09-20 01:33:29 +02:00
103-container.bats test/system: Silence SC2155 2023-09-20 10:24:29 +02:00
104-run.bats test/system: Silence SC2155 2023-09-20 10:24:29 +02:00
105-enter.bats test/system: Silence SC2155 2023-09-20 10:24:29 +02:00
106-rm.bats test/system: Silence SC2086 2023-09-19 14:29:17 +02:00
107-rmi.bats test/system: Silence SC2154 2023-09-20 01:33:29 +02:00
108-completion.bats test/system: Silence SC2154 2023-09-20 01:33:29 +02:00
201-ipc.bats test/system: Unbreak the line count checks with Bats >= 1.10.0 2023-08-18 06:21:40 +02:00
203-network.bats test/system: Unbreak the line count checks with Bats >= 1.10.0 2023-08-18 06:21:40 +02:00
206-user.bats test/system: Test that group and user IDs work 2023-08-22 16:01:08 +02:00
210-ulimit.bats test/system: Unbreak the line count checks with Bats >= 1.10.0 2023-08-18 06:21:40 +02:00
211-dbus.bats test/system: Test that D-Bus works 2023-08-22 17:11:59 +02:00
meson.build test/system: Test that D-Bus works 2023-08-22 17:11:59 +02:00
README.md test/system: Clarify the use of Git submodules 2023-06-21 12:34:08 +02:00
setup_suite.bash test/system: Silence SC2155 2023-09-20 10:24:29 +02:00

README.md

System tests

These tests are built with BATS (Bash Automated Testing System).

The tests are meant to ensure that Toolbox's functionality remains stable throughout updates of both Toolbox and Podman/libpod.

The tests are set up in a way that does not affect the host environment. Running them won't remove any existing containers or images.

Dependencies

  • awk
  • bats
  • GNU coreutils
  • httpd-tools
  • openssl
  • podman
  • skopeo
  • toolbox

These tests use a few standard libraries for bats which help with clarity and consistency. The libraries are bats-support and bats-assert. These libraries are provided as git submodules in the libs directory. Make sure both are present by running git submodule init and git submodule update.

How to run the tests

First, make sure you have all the dependencies installed.

  • Enter the toolbox root folder
  • Invoke command bats ./test/system/ and the test suite should fire up

Mocking of images is done automatically to prevent potential networking issues and to speed up the cases.

By default the test suite uses the system versions of podman, skopeo and toolbox.

If you have a podman, skopeo or toolbox installed in a nonstandard location then you can use the PODMAN, SKOPEO and TOOLBOX environmental variables to set the path to the binaries. So the command to invoke the test suite could look something like this: PODMAN=/usr/libexec/podman TOOLBOX=./toolbox bats ./test/system/.

When running the tests, make sure the test suite: [job] jobs are successful. These jobs set up the whole environment and are a strict requirement for other jobs to run correctly.

Writing tests

Environmental variables

  • Inspect top part of libs/helpers.bats for a list of helper environmental variables

Naming convention

  • All tests should follow the nomenclature: [command]: <test description>...
  • When the test is expected to fail, start the test description with "Try to..."
  • When the test is to give a non obvious output, it should be put in parenthesis at the end of the title

Examples:

  • @test "create: Create the default container"
  • @test "rm: Try to remove a non-existent container"

Test case environment

  • All the tests start with a clean system (no images or containers) to make sure that there are no dependencies between tests and they are really isolated. Use the setup() and teardown() functions for that purpose.

Image registry

  • The system tests set up an OCI image registry for testing purposes - localhost:50000. The registry requires authentication. There is one account present: user (password: user)

  • The registry contains by default only one image: fedora-toolbox:34

Example pull of the fedora-toolbox:34 image:

$PODMAN login --username user --password user "$DOCKER_REG_URI"
$PODMAN pull "$DOCKER_REG_URI/fedora-toolbox:34"