-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
system tests: refactor registry code
The podman-login tests have accumulated much cruft over the years, because that's the only place where we run a local registry, and the process was crufty: we actually start/stopped the registry as the first & last tests of the file. Meaning, you couldn't do 'hack/bats 150:just-one-test' because that would skip the registry start. And just now, a completely unrelated test has had to be shoved into the login file. This PR revamps the whole thing, by adding a new registry helper module that can be used anywhere. And, once the registry is started, it just stays running until the end of tests. (This requires BATS 1.7 or greater). Signed-off-by: Ed Santiago <[email protected]>
- Loading branch information
1 parent
624bb83
commit 8fffcf4
Showing
5 changed files
with
181 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| # -*- bash -*- | ||
| # | ||
| # helpers for starting/stopping a local registry. | ||
| # | ||
| # Used primarily in 150-login.bats | ||
| # | ||
|
|
||
| ############################################################################### | ||
| # BEGIN one-time envariable setup | ||
|
|
||
| # Override any user-set path to an auth file | ||
| unset REGISTRY_AUTH_FILE | ||
|
|
||
| # END one-time envariable setup | ||
| ############################################################################### | ||
|
|
||
| # Start a local registry. Only needed on demand (e.g. by 150-login.bats) | ||
| # and then only once: if we start, leave it running until final teardown. | ||
| function start_registry() { | ||
| if [[ -d "$PODMAN_LOGIN_WORKDIR/auth" ]]; then | ||
| # Already started | ||
| return | ||
| fi | ||
|
|
||
| AUTHDIR=${PODMAN_LOGIN_WORKDIR}/auth | ||
| mkdir -p $AUTHDIR | ||
|
|
||
| # Registry image; copy of docker.io, but on our own registry | ||
| local REGISTRY_IMAGE="$PODMAN_TEST_IMAGE_REGISTRY/$PODMAN_TEST_IMAGE_USER/registry:2.8" | ||
|
|
||
| # Pull registry image, but into a separate container storage | ||
| mkdir ${PODMAN_LOGIN_WORKDIR}/root | ||
| mkdir ${PODMAN_LOGIN_WORKDIR}/runroot | ||
| PODMAN_LOGIN_ARGS="--storage-driver vfs --root ${PODMAN_LOGIN_WORKDIR}/root --runroot ${PODMAN_LOGIN_WORKDIR}/runroot" | ||
| # _prefetch() will retry twice on network error, and will also use | ||
| # a pre-cached image if present (helpful on dev workstation, not in CI). | ||
| _PODMAN_TEST_OPTS="${PODMAN_LOGIN_ARGS}" _prefetch $REGISTRY_IMAGE | ||
|
|
||
| # Registry image needs a cert. Self-signed is good enough. | ||
| CERT=$AUTHDIR/domain.crt | ||
| if [ ! -e $CERT ]; then | ||
| openssl req -newkey rsa:4096 -nodes -sha256 \ | ||
| -keyout $AUTHDIR/domain.key -x509 -days 2 \ | ||
| -out $AUTHDIR/domain.crt \ | ||
| -subj "/C=US/ST=Foo/L=Bar/O=Red Hat, Inc./CN=localhost" \ | ||
| -addext "subjectAltName=DNS:localhost" | ||
| fi | ||
|
|
||
| # Copy a cert to another directory for --cert-dir option tests | ||
| mkdir -p ${PODMAN_LOGIN_WORKDIR}/trusted-registry-cert-dir | ||
| cp $CERT ${PODMAN_LOGIN_WORKDIR}/trusted-registry-cert-dir | ||
|
|
||
| # Store credentials where container will see them | ||
| htpasswd -Bbn ${PODMAN_LOGIN_USER} ${PODMAN_LOGIN_PASS} > $AUTHDIR/htpasswd | ||
|
|
||
| # In case $PODMAN_TEST_KEEP_LOGIN_REGISTRY is set, for testing later | ||
| echo "${PODMAN_LOGIN_USER}:${PODMAN_LOGIN_PASS}" > $AUTHDIR/htpasswd-plaintext | ||
|
|
||
| # Run the registry container. | ||
| run_podman ${PODMAN_LOGIN_ARGS} run -d \ | ||
| -p 127.0.0.1:${PODMAN_LOGIN_REGISTRY_PORT}:5000 \ | ||
| --name registry \ | ||
| -v $AUTHDIR:/auth:Z \ | ||
| -e "REGISTRY_AUTH=htpasswd" \ | ||
| -e "REGISTRY_AUTH_HTPASSWD_REALM=Registry Realm" \ | ||
| -e REGISTRY_AUTH_HTPASSWD_PATH=/auth/htpasswd \ | ||
| -e REGISTRY_HTTP_TLS_CERTIFICATE=/auth/domain.crt \ | ||
| -e REGISTRY_HTTP_TLS_KEY=/auth/domain.key \ | ||
| $REGISTRY_IMAGE | ||
| cid="$output" | ||
|
|
||
| # wait_for_port isn't enough: that just checks that podman has mapped the port... | ||
| wait_for_port 127.0.0.1 ${PODMAN_LOGIN_REGISTRY_PORT} | ||
| # ...so we look in container logs for confirmation that registry is running. | ||
| _PODMAN_TEST_OPTS="${PODMAN_LOGIN_ARGS}" wait_for_output "listening on .::.:5000" $cid | ||
| } | ||
|
|
||
| function stop_registry() { | ||
| if [[ ! -d "$PODMAN_LOGIN_WORKDIR/auth" ]]; then | ||
| # No registry running | ||
| return | ||
| fi | ||
|
|
||
| # For manual debugging; user may request keeping the registry running | ||
| if [ -n "${PODMAN_TEST_KEEP_LOGIN_REGISTRY}" ]; then | ||
| skip "[leaving registry running by request]" | ||
| fi | ||
|
|
||
| run_podman --storage-driver vfs \ | ||
| --root ${PODMAN_LOGIN_WORKDIR}/root \ | ||
| --runroot ${PODMAN_LOGIN_WORKDIR}/runroot \ | ||
| rm -f -t0 registry | ||
| run_podman --storage-driver vfs \ | ||
| --root ${PODMAN_LOGIN_WORKDIR}/root \ | ||
| --runroot ${PODMAN_LOGIN_WORKDIR}/runroot \ | ||
| rmi -a -f | ||
|
|
||
| # By default, clean up | ||
| if [ -z "${PODMAN_TEST_KEEP_LOGIN_WORKDIR}" ]; then | ||
| # FIXME: why is this necessary??? If we don't do this, we can't | ||
| # rm -rf the workdir, because ..../overlay is mounted | ||
| mount | grep ${PODMAN_LOGIN_WORKDIR} | awk '{print $3}' | xargs --no-run-if-empty umount | ||
|
|
||
| if [[ $(id -u) -eq 0 ]]; then | ||
| rm -rf ${PODMAN_LOGIN_WORKDIR} | ||
| else | ||
| # rootless image data is owned by a subuid | ||
| run_podman unshare rm -rf ${PODMAN_LOGIN_WORKDIR} | ||
| fi | ||
| fi | ||
|
|
||
| # Make sure socket is closed | ||
| if tcp_port_probe $PODMAN_LOGIN_REGISTRY_PORT; then | ||
| die "Socket still seems open" | ||
| fi | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # -*- bash -*- | ||
| # | ||
| # global setup/teardown for the entire system test suite | ||
| # | ||
| bats_require_minimum_version 1.8.0 | ||
|
|
||
| load helpers | ||
| load helpers.network | ||
| load helpers.registry | ||
|
|
||
| # Create common environment just in case we end up needing a registry. | ||
| # These environment variables will be available to all tests. | ||
| function setup_suite() { | ||
| # Can't use $BATS_SUITE_TMPDIR because podman barfs: | ||
| # Error: the specified runroot is longer than 50 characters | ||
| export PODMAN_LOGIN_WORKDIR=$(mktemp -d --tmpdir=${BATS_TMPDIR:-${TMPDIR:-/tmp}} podman-bats-registry.XXXXXX) | ||
|
|
||
| export PODMAN_LOGIN_USER="user$(random_string 4)" | ||
| export PODMAN_LOGIN_PASS="pw$(random_string 15)" | ||
|
|
||
| # FIXME: racy! It could be many minutes between now and when we start it. | ||
| # To mitigate, we use a range not used anywhere else in system tests. | ||
| export PODMAN_LOGIN_REGISTRY_PORT=$(random_free_port 42000-42999) | ||
| } | ||
|
|
||
| # Run at the very end of all tests. Useful for cleanup of non-BATS tmpdirs. | ||
| function teardown_suite() { | ||
| stop_registry | ||
| } |