Files
dokku/tests/unit/registry.bats
T
Jose Diaz-Gonzalez 624eea1959 feat: add registry:auth-status to read back login state
There was no way to ask whether Dokku was already logged in to a registry with a given credential, so tooling converging a declared state onto a server had to re-run `registry:login` on every pass purely to discover that nothing needed to change. The new `registry:auth-status` command compares a supplied credential against the stored one and reports the result through its exit code alone, distinguishing a server with no credential from one whose credential differs, and from one whose secret a docker credential helper or an identity token puts out of reach. An `auth-servers` triad on `registry:report` exposes which servers have credentials without emitting any part of one.
2026-09-19 19:19:57 -04:00

1026 lines
33 KiB
Bash

#!/usr/bin/env bats
load test_helper
setup() {
global_setup
create_app
dokku checks:set $TEST_APP wait-to-retire 30
}
teardown() {
destroy_app
global_teardown
}
@test "(registry) registry:help" {
run /bin/bash -c "dokku registry"
echo "output: $output"
echo "status: $status"
assert_output_contains "Manage registry settings for an app"
help_output="$output"
run /bin/bash -c "dokku registry:help"
echo "output: $output"
echo "status: $status"
assert_output_contains "Manage registry settings for an app"
assert_output "$help_output"
}
@test "(registry:login) global login with deprecated warning" {
if [[ -z "$DOCKERHUB_USERNAME" ]] || [[ -z "$DOCKERHUB_TOKEN" ]]; then
skip "skipping due to missing docker.io credentials DOCKERHUB_USERNAME:DOCKERHUB_TOKEN"
fi
run /bin/bash -c "dokku registry:login docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "Login Succeeded"
assert_output_contains "Deprecated: please use --global flag"
run /bin/bash -c "echo $DOCKERHUB_TOKEN | dokku registry:login docker.io --password-stdin $DOCKERHUB_USERNAME"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "Login Succeeded"
}
@test "(registry:login) global login with --global flag" {
if [[ -z "$DOCKERHUB_USERNAME" ]] || [[ -z "$DOCKERHUB_TOKEN" ]]; then
skip "skipping due to missing docker.io credentials DOCKERHUB_USERNAME:DOCKERHUB_TOKEN"
fi
run /bin/bash -c "dokku registry:login --global docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "Login Succeeded"
assert_output_not_contains "Deprecated"
}
@test "(registry:login) per-app login" {
if [[ -z "$DOCKERHUB_USERNAME" ]] || [[ -z "$DOCKERHUB_TOKEN" ]]; then
skip "skipping due to missing docker.io credentials DOCKERHUB_USERNAME:DOCKERHUB_TOKEN"
fi
run /bin/bash -c "dokku registry:login $TEST_APP docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "Login Succeeded"
run /bin/bash -c "test -f /var/lib/dokku/config/registry/$TEST_APP/config.json"
echo "output: $output"
echo "status: $status"
assert_success
}
@test "(registry:logout) per-app logout" {
if [[ -z "$DOCKERHUB_USERNAME" ]] || [[ -z "$DOCKERHUB_TOKEN" ]]; then
skip "skipping due to missing docker.io credentials DOCKERHUB_USERNAME:DOCKERHUB_TOKEN"
fi
run /bin/bash -c "dokku registry:login $TEST_APP docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:logout $TEST_APP docker.io"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "jq -r '.auths | keys | join(\",\")' /var/lib/dokku/config/registry/$TEST_APP/config.json"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_contains "index.docker.io"
}
@test "(registry:logout) global logout" {
if [[ -z "$DOCKERHUB_USERNAME" ]] || [[ -z "$DOCKERHUB_TOKEN" ]]; then
skip "skipping due to missing docker.io credentials DOCKERHUB_USERNAME:DOCKERHUB_TOKEN"
fi
run /bin/bash -c "dokku registry:login --global docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:logout --global docker.io"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "jq -r '.auths | keys | join(\",\")' $DOKKU_ROOT/.docker/config.json"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_contains "index.docker.io"
}
@test "(registry:auth-status) matches a credential written by registry:login" {
if [[ -z "$DOCKERHUB_USERNAME" ]] || [[ -z "$DOCKERHUB_TOKEN" ]]; then
skip "skipping due to missing docker.io credentials DOCKERHUB_USERNAME:DOCKERHUB_TOKEN"
fi
run /bin/bash -c "dokku registry:login --global docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:auth-status --global docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_exit_status 0
assert_output ""
run /bin/bash -c "dokku registry:auth-status --global docker.io $DOCKERHUB_USERNAME wrong-password"
echo "output: $output"
echo "status: $status"
assert_exit_status 2
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"global-auth-servers\"'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "docker.io"
run /bin/bash -c "dokku registry:logout --global docker.io"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:auth-status --global docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_exit_status 1
run /bin/bash -c "dokku registry:auth-status --global docker.io"
echo "output: $output"
echo "status: $status"
assert_exit_status 0
}
@test "(registry) per-app credentials deleted on app destroy" {
if [[ -z "$DOCKERHUB_USERNAME" ]] || [[ -z "$DOCKERHUB_TOKEN" ]]; then
skip "skipping due to missing docker.io credentials DOCKERHUB_USERNAME:DOCKERHUB_TOKEN"
fi
run /bin/bash -c "dokku registry:login $TEST_APP docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "test -d /var/lib/dokku/config/registry/$TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
destroy_app
run /bin/bash -c "test -d /var/lib/dokku/config/registry/$TEST_APP"
echo "output: $output"
echo "status: $status"
assert_failure
create_app
}
@test "(registry:report) image-repo raw vs computed vs global" {
run /bin/bash -c "dokku registry:set --global image-repo-template"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-image-repo\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-global-image-repo-template\"'"
assert_success
assert_output ""
# When neither per-app image-repo nor a global image-repo-template are set,
# reportComputedImageRepo falls back to common.GetAppImageRepo which returns
# the default dokku/<app> image name.
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-image-repo\"'"
assert_success
assert_output "dokku/$TEST_APP"
run /bin/bash -c "dokku registry:set --global image-repo-template 'dokku/{{ APP }}'"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-global-image-repo-template\"'"
assert_success
assert_output 'dokku/{{ APP }}'
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-image-repo\"'"
assert_success
assert_output "dokku/$TEST_APP"
run /bin/bash -c "dokku registry:set $TEST_APP image-repo my/$TEST_APP"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-image-repo\"'"
assert_success
assert_output "my/$TEST_APP"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-image-repo\"'"
assert_success
assert_output "my/$TEST_APP"
run /bin/bash -c "dokku registry:set $TEST_APP image-repo"
assert_success
run /bin/bash -c "dokku registry:set --global image-repo-template"
assert_success
}
@test "(registry:report) image-repo-template raw vs computed vs global" {
run /bin/bash -c "dokku registry:set --global image-repo-template"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-image-repo-template\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-global-image-repo-template\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-image-repo-template\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:set --global image-repo-template 'global-prefix/{{ .AppName }}'"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-image-repo-template\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-global-image-repo-template\"'"
assert_success
assert_output 'global-prefix/{{ .AppName }}'
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-image-repo-template\"'"
assert_success
assert_output 'global-prefix/{{ .AppName }}'
# The global template renders into the computed image-repo.
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-image-repo\"'"
assert_success
assert_output "global-prefix/$TEST_APP"
# Per-app template overrides the global template.
run /bin/bash -c "dokku registry:set $TEST_APP image-repo-template 'app-prefix/{{ .AppName }}-prod'"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-image-repo-template\"'"
assert_success
assert_output 'app-prefix/{{ .AppName }}-prod'
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-global-image-repo-template\"'"
assert_success
assert_output 'global-prefix/{{ .AppName }}'
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-image-repo-template\"'"
assert_success
assert_output 'app-prefix/{{ .AppName }}-prod'
# The per-app template flows through to the computed image-repo.
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-image-repo\"'"
assert_success
assert_output "app-prefix/$TEST_APP-prod"
# Unsetting the per-app template restores the global template behavior.
run /bin/bash -c "dokku registry:set $TEST_APP image-repo-template"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-image-repo-template\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-image-repo-template\"'"
assert_success
assert_output 'global-prefix/{{ .AppName }}'
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-image-repo\"'"
assert_success
assert_output "global-prefix/$TEST_APP"
run /bin/bash -c "dokku registry:set --global image-repo-template"
assert_success
}
@test "(registry:report) push-on-release raw vs computed vs global" {
run /bin/bash -c "dokku registry:set --global push-on-release"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-push-on-release\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-global-push-on-release\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-push-on-release\"'"
assert_success
assert_output "false"
run /bin/bash -c "dokku registry:set --global push-on-release true"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-global-push-on-release\"'"
assert_success
assert_output "true"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-push-on-release\"'"
assert_success
assert_output "true"
run /bin/bash -c "dokku registry:set $TEST_APP push-on-release false"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-push-on-release\"'"
assert_success
assert_output "false"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-push-on-release\"'"
assert_success
assert_output "false"
run /bin/bash -c "dokku registry:set $TEST_APP push-on-release"
assert_success
run /bin/bash -c "dokku registry:set --global push-on-release"
assert_success
}
@test "(registry:report --global) computed and global keys" {
run /bin/bash -c "dokku registry:set --global push-on-release"
assert_success
run /bin/bash -c "dokku registry:set --global server"
assert_success
run /bin/bash -c "dokku registry:set --global image-repo-template"
assert_success
run /bin/bash -c "dokku registry:set --global push-extra-tags"
assert_success
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-global-push-on-release\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-computed-push-on-release\"'"
assert_success
assert_output "false"
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-global-server\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-computed-server\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-global-image-repo-template\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-computed-image-repo-template\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-global-push-extra-tags\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-computed-push-extra-tags\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:set --global push-on-release true"
assert_success
run /bin/bash -c "dokku registry:set --global server ghcr.io"
assert_success
run /bin/bash -c "dokku registry:set --global image-repo-template 'dokku/{{ APP }}'"
assert_success
run /bin/bash -c "dokku registry:set --global push-extra-tags latest,stable"
assert_success
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-global-push-on-release\"'"
assert_success
assert_output "true"
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-computed-push-on-release\"'"
assert_success
assert_output "true"
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-global-server\"'"
assert_success
assert_output "ghcr.io"
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-computed-server\"'"
assert_success
assert_output "ghcr.io/"
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-global-image-repo-template\"'"
assert_success
assert_output 'dokku/{{ APP }}'
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-computed-image-repo-template\"'"
assert_success
assert_output 'dokku/{{ APP }}'
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-global-push-extra-tags\"'"
assert_success
assert_output "latest,stable"
run /bin/bash -c "dokku registry:report --global --format json | jq -r '.\"registry-computed-push-extra-tags\"'"
assert_success
assert_output "latest,stable"
run /bin/bash -c "dokku registry:set --global push-on-release"
assert_success
run /bin/bash -c "dokku registry:set --global server"
assert_success
run /bin/bash -c "dokku registry:set --global image-repo-template"
assert_success
run /bin/bash -c "dokku registry:set --global push-extra-tags"
assert_success
}
@test "(registry:report) push-extra-tags raw vs computed vs global" {
run /bin/bash -c "dokku registry:set --global push-extra-tags"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-push-extra-tags\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-global-push-extra-tags\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-push-extra-tags\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:set --global push-extra-tags global-tag"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-global-push-extra-tags\"'"
assert_success
assert_output "global-tag"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-push-extra-tags\"'"
assert_success
assert_output "global-tag"
run /bin/bash -c "dokku registry:set $TEST_APP push-extra-tags release,stable"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-push-extra-tags\"'"
assert_success
assert_output "release,stable"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"registry-computed-push-extra-tags\"'"
assert_success
assert_output "release,stable"
run /bin/bash -c "dokku registry:set $TEST_APP push-extra-tags"
assert_success
run /bin/bash -c "dokku registry:set --global push-extra-tags"
assert_success
}
@test "(registry) registry:set server" {
run /bin/bash -c "dokku registry:set --global server ghcr.io"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --registry-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
run /bin/bash -c "dokku registry:report $TEST_APP --registry-global-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "ghcr.io"
run /bin/bash -c "dokku registry:report $TEST_APP --registry-computed-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "ghcr.io/"
run /bin/bash -c "dokku registry:set --global server docker.io"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --registry-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
run /bin/bash -c "dokku registry:report $TEST_APP --registry-global-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "docker.io"
run /bin/bash -c "dokku registry:report $TEST_APP --registry-computed-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
run /bin/bash -c "dokku registry:set $TEST_APP server docker.io"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --registry-computed-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
run /bin/bash -c "dokku registry:report $TEST_APP --registry-global-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "docker.io"
run /bin/bash -c "dokku registry:report $TEST_APP --registry-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "docker.io"
run /bin/bash -c "dokku registry:set $TEST_APP server ghcr.io"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:report $TEST_APP --registry-computed-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "ghcr.io/"
run /bin/bash -c "dokku registry:report $TEST_APP --registry-global-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "docker.io"
run /bin/bash -c "dokku registry:report $TEST_APP --registry-server"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "ghcr.io"
}
@test "(registry) registry:set image-repo" {
run /bin/bash -c "docker images"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:set $TEST_APP image-repo heroku/$TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker inspect heroku/$TEST_APP:latest"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker images"
echo "output: $output"
echo "status: $status"
assert_success
}
@test "(registry) registry:set push-on-release" {
if [[ -z "$DOCKERHUB_USERNAME" ]] || [[ -z "$DOCKERHUB_TOKEN" ]]; then
skip "skipping due to missing docker.io credentials DOCKERHUB_USERNAME:DOCKERHUB_TOKEN"
fi
# this test pushes to the registry, so it establishes its own credentials
# rather than relying on a login left behind by an earlier test
run /bin/bash -c "dokku registry:login --global docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:set $TEST_APP push-on-release true"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:set $TEST_APP image-repo dokku/test-app"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app
echo "output: $output"
echo "status: $status"
assert_success
sleep 60
run /bin/bash -c "dokku ps:retire"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker container ls -a"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker image ls"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ps:rebuild $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
sleep 60
run /bin/bash -c "dokku ps:retire"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker container ls -a"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker image ls"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:set $TEST_APP key=VALUE"
echo "output: $output"
echo "status: $status"
assert_success
sleep 60
run /bin/bash -c "dokku ps:retire"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker container ls -a"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker image ls"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ps:rebuild $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
sleep 60
run /bin/bash -c "dokku ps:retire"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ps:retire"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker container ls -a"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker image ls"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker image inspect dokku/test-app:1"
echo "output: $output"
echo "status: $status"
assert_failure
run /bin/bash -c "docker image inspect dokku/test-app:2"
echo "output: $output"
echo "status: $status"
assert_failure
run /bin/bash -c "docker image inspect dokku/test-app:3"
echo "output: $output"
echo "status: $status"
assert_failure
run /bin/bash -c "docker image inspect dokku/test-app:4"
echo "output: $output"
echo "status: $status"
assert_success
}
@test "(registry) registry:set push-extra-tags" {
if [[ -z "$DOCKERHUB_USERNAME" ]] || [[ -z "$DOCKERHUB_TOKEN" ]]; then
skip "skipping due to missing docker.io credentials DOCKERHUB_USERNAME:DOCKERHUB_TOKEN"
fi
# this test pushes to the registry, so it establishes its own credentials
# rather than relying on a login left behind by an earlier test
run /bin/bash -c "dokku registry:login --global docker.io $DOCKERHUB_USERNAME $DOCKERHUB_TOKEN"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:set $TEST_APP push-on-release true"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:set $TEST_APP image-repo dokku/test-app"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku registry:set $TEST_APP push-extra-tags foo"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "dokku/test-app:foo"
}
@test "(registry:report) emits new stripped JSON keys alongside legacy" {
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r 'has(\"image-repo\") and has(\"registry-image-repo\")'"
assert_success
assert_output "true"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r 'has(\"computed-image-repo\") and has(\"registry-computed-image-repo\")'"
assert_success
assert_output "true"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r 'has(\"push-on-release\") and has(\"registry-push-on-release\")'"
assert_success
assert_output "true"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r 'has(\"global-push-on-release\") and has(\"registry-global-push-on-release\")'"
assert_success
assert_output "true"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r 'has(\"computed-server\") and has(\"registry-computed-server\")'"
assert_success
assert_output "true"
run /bin/bash -c "dokku registry:report --global --format json | jq -r 'has(\"global-image-repo-template\") and has(\"registry-global-image-repo-template\")'"
assert_success
assert_output "true"
}
@test "(registry:auth-status) validates arguments" {
run /bin/bash -c "dokku registry:auth-status"
echo "output: $output"
echo "status: $status"
assert_exit_status 3
assert_output_contains "Please specify an app or the --global flag"
run /bin/bash -c "dokku registry:auth-status --global"
echo "output: $output"
echo "status: $status"
assert_exit_status 3
assert_output_contains "Missing server argument"
run /bin/bash -c "dokku registry:auth-status $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_exit_status 3
assert_output_contains "Missing server argument"
run /bin/bash -c "dokku registry:auth-status $TEST_APP docker.io username"
echo "output: $output"
echo "status: $status"
assert_exit_status 3
assert_output_contains "Missing password argument"
# an unknown flag must not be reported as a differing credential, which is
# what pflag would exit with if it handled the error itself
run /bin/bash -c "dokku registry:auth-status --nonsense --global docker.io"
echo "output: $output"
echo "status: $status"
assert_exit_status 3
run /bin/bash -c "dokku registry:auth-status --help"
echo "output: $output"
echo "status: $status"
assert_exit_status 3
run /bin/bash -c "dokku registry:auth-status nonexistent-app-name docker.io username password"
echo "output: $output"
echo "status: $status"
assert_exit_status 20
# a malformed app name must not be reported as a missing credential
run /bin/bash -c "dokku registry:auth-status 'BAD NAME' docker.io username password"
echo "output: $output"
echo "status: $status"
assert_exit_status 3
}
@test "(registry:auth-status) reports per-app credential state" {
run /bin/bash -c "dokku registry:auth-status $TEST_APP docker.io fakeuser fakepass"
echo "output: $output"
echo "status: $status"
assert_exit_status 1
assert_output ""
run /bin/bash -c "dokku registry:auth-status $TEST_APP docker.io"
echo "output: $output"
echo "status: $status"
assert_exit_status 0
assert_output ""
write_registry_auth_config "$TEST_APP" "{\"auths\":{\"https://index.docker.io/v1/\":{\"auth\":\"$(fake_registry_auth fakeuser fakepass)\"}}}"
run /bin/bash -c "dokku registry:auth-status $TEST_APP docker.io fakeuser fakepass"
echo "output: $output"
echo "status: $status"
assert_exit_status 0
assert_output ""
run /bin/bash -c "dokku registry:auth-status $TEST_APP docker.io fakeuser wrongpass"
echo "output: $output"
echo "status: $status"
assert_exit_status 2
assert_output ""
run /bin/bash -c "dokku registry:auth-status $TEST_APP docker.io otheruser fakepass"
echo "output: $output"
echo "status: $status"
assert_exit_status 2
run /bin/bash -c "dokku registry:auth-status $TEST_APP docker.io"
echo "output: $output"
echo "status: $status"
assert_exit_status 2
run /bin/bash -c "dokku registry:auth-status $TEST_APP ghcr.io fakeuser fakepass"
echo "output: $output"
echo "status: $status"
assert_exit_status 1
run /bin/bash -c "printf 'fakepass' | dokku registry:auth-status --password-stdin $TEST_APP docker.io fakeuser"
echo "output: $output"
echo "status: $status"
assert_exit_status 0
run /bin/bash -c "printf 'wrongpass' | dokku registry:auth-status --password-stdin $TEST_APP docker.io fakeuser"
echo "output: $output"
echo "status: $status"
assert_exit_status 2
run /bin/bash -c "dokku --app $TEST_APP registry:auth-status docker.io fakeuser fakepass"
echo "output: $output"
echo "status: $status"
assert_exit_status 0
}
@test "(registry:auth-status) normalizes server names and reports unreadable credentials" {
write_registry_auth_config "$TEST_APP" "{\"auths\":{\"https://index.docker.io/v1/\":{\"auth\":\"$(fake_registry_auth fakeuser fakepass)\"}}}"
for server in docker.io hub.docker.com docker.com index.docker.io; do
run /bin/bash -c "dokku registry:auth-status $TEST_APP $server fakeuser fakepass"
echo "server: $server"
echo "output: $output"
echo "status: $status"
assert_exit_status 0
done
# docker stores registry-1.docker.io under a key of its own rather than the
# index server, so a docker hub credential does not cover it
run /bin/bash -c "dokku registry:auth-status $TEST_APP registry-1.docker.io fakeuser fakepass"
echo "output: $output"
echo "status: $status"
assert_exit_status 1
write_registry_auth_config "$TEST_APP" '{"auths":{"ghcr.io":{}},"credsStore":"secretservice"}'
run /bin/bash -c "dokku registry:auth-status $TEST_APP ghcr.io fakeuser fakepass"
echo "output: $output"
echo "status: $status"
assert_exit_status 4
assert_output_contains "credential helper"
assert_output_not_contains "fakepass"
# knowing a credential exists needs no access to the secret
run /bin/bash -c "dokku registry:auth-status $TEST_APP ghcr.io"
echo "output: $output"
echo "status: $status"
assert_exit_status 2
write_registry_auth_config "$TEST_APP" "{\"auths\":{\"ghcr.io\":{\"auth\":\"$(fake_registry_auth fakeuser '')\",\"identitytoken\":\"token\"}}}"
run /bin/bash -c "dokku registry:auth-status $TEST_APP ghcr.io fakeuser fakepass"
echo "output: $output"
echo "status: $status"
assert_exit_status 4
assert_output_contains "identity token"
# a username that differs settles the comparison without reading the secret
run /bin/bash -c "dokku registry:auth-status $TEST_APP ghcr.io otheruser fakepass"
echo "output: $output"
echo "status: $status"
assert_exit_status 2
}
@test "(registry:report) auth-servers raw vs computed vs global" {
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"auth-servers\"'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output ""
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"computed-auth-servers\" == .\"global-auth-servers\"'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "true"
write_registry_auth_config "$TEST_APP" "{\"auths\":{\"https://index.docker.io/v1/\":{\"auth\":\"$(fake_registry_auth fakeuser fakepass)\"},\"ghcr.io\":{\"auth\":\"$(fake_registry_auth fakeuser fakepass)\"}}}"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"auth-servers\"'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "docker.io,ghcr.io"
# a per-app config shadows the global one entirely rather than merging
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r '.\"computed-auth-servers\"'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "docker.io,ghcr.io"
run /bin/bash -c "dokku registry:report $TEST_APP --format json | jq -r 'has(\"auth-servers\") and has(\"registry-auth-servers\")'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "true"
run /bin/bash -c "dokku registry:report --global --format json | jq -r 'has(\"global-auth-servers\") and has(\"computed-auth-servers\")'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "true"
}
fake_registry_auth() {
declare desc="base64 encodes a username and password as docker stores them"
declare USERNAME="$1" PASSWORD="$2"
printf '%s:%s' "$USERNAME" "$PASSWORD" | base64 -w0
}
write_registry_auth_config() {
declare desc="writes a docker config.json for an app without contacting a registry"
declare APP="$1" CONTENTS="$2"
mkdir -p "/var/lib/dokku/config/registry/$APP"
echo "$CONTENTS" >"/var/lib/dokku/config/registry/$APP/config.json"
chown -R dokku:dokku "/var/lib/dokku/config/registry/$APP"
chmod 600 "/var/lib/dokku/config/registry/$APP/config.json"
}