dokku/tests/unit/client.bats

#!/usr/bin/env bats

load test_helper

setup() {
  global_setup
  export "DOKKU_HOST=${DOKKU_DOMAIN}"
  create_app
  clone_test_plugin
}

teardown() {
  remove_test_plugin || true
  destroy_app
  unset DOKKU_HOST
  global_teardown
}

@test "(client) unconfigured DOKKU_HOST" {
  unset DOKKU_HOST
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh apps"
  echo "output: $output"
  echo "status: $status"
  assert_exit_status 20
}

@test "(client) remote:show" {
  unset DOKKU_HOST
  local DOKKU_APP_PATH=$(mktemp -d "/tmp/${DOKKU_DOMAIN}.XXXXX")
  trap 'popd &>/dev/null || true; rm -rf "$DOKKU_APP_PATH"' INT TERM

  setup_client_repo "$DOKKU_APP_PATH"
  export DOKKU_APP_PATH="$DOKKU_APP_PATH"

  # handle simple remote: dokku@example.com:app-name
  run /bin/bash -c "git -C "$DOKKU_APP_PATH" remote add dokku 'dokku@example.com:$TEST_APP'"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "DOKKU_APP_PATH=$DOKKU_APP_PATH ${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:show"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output_contains "dokku-app: $TEST_APP"
  assert_output_contains "dokku-git-remote: dokku"
  assert_output_not_contains "dokku-host: example.com"
  assert_output_not_contains "dokku-host: example.net"
  assert_output_contains "dokku-host: "
  assert_output_contains "dokku-port: 22"
  assert_output_contains "dokku-remote-host: example.com"
  assert_output_contains "dokku-ssh-user: dokku"
  assert_output_contains "dokku-constructed-remote: ssh://dokku@example.com:22/$TEST_APP"

  # handle custom DOKKU_HOST (no app name detected without --app flag)
  run /bin/bash -c "DOKKU_HOST="example.net" DOKKU_APP_PATH=$DOKKU_APP_PATH ${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:show"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output_not_contains "dokku-app: $TEST_APP"
  assert_output_contains "dokku-git-remote: dokku"
  assert_output_contains "dokku-host: example.net"
  assert_output_contains "dokku-port: 22"
  assert_output_contains "dokku-remote-host: example.net"
  assert_output_contains "dokku-ssh-user: dokku"
  assert_output_contains "dokku-constructed-remote: ssh://dokku@example.net:22/"
  assert_output_not_contains "dokku-constructed-remote: ssh://dokku@example.net:22/$TEST_APP"

  # handle custom DOKKU_HOST (app name detected with --app flag)
  run /bin/bash -c "DOKKU_HOST="example.net" DOKKU_APP_PATH=$DOKKU_APP_PATH ${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:show --app $TEST_APP"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output_contains "dokku-app: $TEST_APP"
  assert_output_contains "dokku-git-remote: dokku"
  assert_output_contains "dokku-host: example.net"
  assert_output_contains "dokku-port: 22"
  assert_output_contains "dokku-remote-host: example.net"
  assert_output_contains "dokku-ssh-user: dokku"
  assert_output_contains "dokku-constructed-remote: ssh://dokku@example.net:22/$TEST_APP"

  # handle custom DOKKU_PORT
  run /bin/bash -c "DOKKU_PORT=2222 DOKKU_APP_PATH=$DOKKU_APP_PATH ${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:show"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output_contains "dokku-app: $TEST_APP"
  assert_output_contains "dokku-git-remote: dokku"
  assert_output_not_contains "dokku-host: example.com"
  assert_output_not_contains "dokku-host: example.net"
  assert_output_contains "dokku-host: "
  assert_output_contains "dokku-port: 2222"
  assert_output_contains "dokku-remote-host: example.com"
  assert_output_contains "dokku-ssh-user: dokku"
  assert_output_contains "dokku-constructed-remote: ssh://dokku@example.com:2222/$TEST_APP"

  # handle remote with scheme (no port): ssh://dokku@example.com/app-name
  run /bin/bash -c "git -C "$DOKKU_APP_PATH" remote set-url dokku 'ssh://dokku@example.com:22/$TEST_APP'"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "DOKKU_APP_PATH=$DOKKU_APP_PATH ${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:show"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output_contains "dokku-app: $TEST_APP"
  assert_output_contains "dokku-git-remote: dokku"
  assert_output_not_contains "dokku-host: example.com"
  assert_output_not_contains "dokku-host: example.net"
  assert_output_contains "dokku-host: "
  assert_output_contains "dokku-port: 22"
  assert_output_contains "dokku-remote-host: example.com"
  assert_output_contains "dokku-ssh-user: dokku"
  assert_output_contains "dokku-constructed-remote: ssh://dokku@example.com:22/$TEST_APP"

  # handle remote with scheme (with port): ssh://dokku@example.com:2222/app-name
  run /bin/bash -c "git -C "$DOKKU_APP_PATH" remote set-url dokku 'ssh://dokku@example.com:2222/$TEST_APP'"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "DOKKU_APP_PATH=$DOKKU_APP_PATH ${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:show"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output_contains "dokku-app: $TEST_APP"
  assert_output_contains "dokku-git-remote: dokku"
  assert_output_not_contains "dokku-host: example.com"
  assert_output_not_contains "dokku-host: example.net"
  assert_output_contains "dokku-host: "
  assert_output_contains "dokku-port: 2222"
  assert_output_contains "dokku-remote-host: example.com"
  assert_output_contains "dokku-ssh-user: dokku"
  assert_output_contains "dokku-constructed-remote: ssh://dokku@example.com:2222/$TEST_APP"

  # #8093: ssh://dokku@pipescan.shipit.dev:2222/pipescan
  run /bin/bash -c "git -C "$DOKKU_APP_PATH" remote set-url dokku 'ssh://dokku@pipescan.shipit.dev:2222/pipescan'"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "DOKKU_APP_PATH=$DOKKU_APP_PATH ${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:show"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output_contains "dokku-app: pipescan"
  assert_output_contains "dokku-git-remote: dokku"
  assert_output_not_contains "dokku-host: example.com"
  assert_output_not_contains "dokku-host: example.net"
  assert_output_contains "dokku-host: "
  assert_output_contains "dokku-port: 2222"
  assert_output_contains "dokku-remote-host: pipescan.shipit.dev"
  assert_output_contains "dokku-ssh-user: dokku"
  assert_output_contains "dokku-constructed-remote: ssh://dokku@pipescan.shipit.dev:2222/pipescan"
}

@test "(client) no args should print help" {
  # dokku container is not run with a TTY on GitHub Actions so we don't get normal output
  # https://github.com/actions/runner/issues/241
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh"
  echo "output: $output"
  echo "status: $status"
  assert_output_contains "Manage apps"
  assert_output_contains "Manage buildpack settings for an app"
  assert_success
}

@test "(client) arg parsing" {
  run /bin/bash -c "dokku config:set --global GLOBAL_KEY=VALUE"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "dokku config:set $TEST_APP APP_KEY=VALUE"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh --app $TEST_APP config:export --merged --format shell"
  echo "output: $output"
  echo "status: $status"
  assert_success

  common_output="$output"
  run /bin/bash -c "dokku config:export $TEST_APP --merged --format shell"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "$common_output"

  run /bin/bash -c "dokku config:export --merged $TEST_APP --format shell"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "$common_output"

  run /bin/bash -c "dokku config:export --merged --format shell $TEST_APP"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "$common_output"

  run /bin/bash -c "dokku --app $TEST_APP config:export --merged --format shell"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "$common_output"
}

@test "(client) apps:create AND apps:destroy with random name" {
  setup_client_repo
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh apps:create"
  echo "output: $output"
  echo "status: $status"
  assert_success
  git remote | grep dokku
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh apps:destroy --force"
  echo "output: $output"
  echo "status: $status"
  assert_success
}

@test "(client) apps:create AND apps:destroy with name" {
  setup_client_repo
  local test_app_name=test-apps-create-with-name
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh apps:create $test_app_name"
  echo "output: $output"
  echo "status: $status"
  assert_success
  git remote | grep dokku
  git remote -v | grep $test_app_name
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh apps:destroy --force"
  echo "output: $output"
  echo "status: $status"
  assert_success
}

@test "(client) config:set" {
  run ${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh config:set $TEST_APP test_var=true test_var2=\"hello world\"
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh config:get $TEST_APP test_var2 | grep -q 'hello world'"
  echo "output: $output"
  echo "status: $status"
  assert_success
}

@test "(client) config:unset" {
  run ${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh config:set $TEST_APP test_var=true test_var2=\"hello world\"
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh config:get $TEST_APP test_var"
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh config:unset $TEST_APP test_var"
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh config:get $TEST_APP test_var | grep test_var"
  echo "output: $output"
  echo "status: $status"
  assert_failure
}

@test "(client) domains:add" {
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh domains:add $TEST_APP www.test.app.${DOKKU_DOMAIN}"
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh domains:add $TEST_APP test.app.${DOKKU_DOMAIN}"
  echo "output: $output"
  echo "status: $status"
  assert_success
}

@test "(client) domains:remove" {
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh domains:add $TEST_APP test.app.${DOKKU_DOMAIN}"
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh domains:remove $TEST_APP test.app.${DOKKU_DOMAIN}"
  echo "output: $output"
  echo "status: $status"
  refute_line "test.app.${DOKKU_DOMAIN}"
}

@test "(client) domains:clear" {
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh domains:add $TEST_APP test.app.${DOKKU_DOMAIN}"
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh domains:clear $TEST_APP"
  echo "output: $output"
  echo "status: $status"
  assert_success
}

# @test "(client) ps" {
#   # CI support: 'Ah. I just spoke with our Docker expert --
#   # looks like docker exec is built to work with docker-under-libcontainer,
#   # but we're using docker-under-lxc. I don't have an estimated time for the fix, sorry
#   skip "circleci does not support docker exec at the moment."
#   run deploy_app
#   echo "output: $output"
#   echo "status: $status"
#   assert_success
#   run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh ps $TEST_APP | grep -q 'node web.js'"
#   echo "output: $output"
#   echo "status: $status"
#   assert_success
# }

@test "(client) ps:start" {
  run deploy_app
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh ps:stop $TEST_APP"
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh ps:start $TEST_APP"
  echo "output: $output"
  echo "status: $status"
  assert_success
  for CID_FILE in $DOKKU_ROOT/$TEST_APP/CONTAINER.*; do
    run /bin/bash -c "docker ps -q --no-trunc | grep -q $(<$CID_FILE)"
    echo "output: $output"
    echo "status: $status"
    assert_success
  done
}

@test "(client) ps:stop" {
  run deploy_app
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh ps:stop $TEST_APP"
  echo "output: $output"
  echo "status: $status"
  assert_success
  for CID_FILE in $DOKKU_ROOT/$TEST_APP/CONTAINER.*; do
    run /bin/bash -c "docker ps -q --no-trunc | grep -q $(<$CID_FILE)"
    echo "output: $output"
    echo "status: $status"
    assert_failure
  done
}

@test "(client) ps:restart" {
  run deploy_app
  echo "output: $output"
  echo "status: $status"
  assert_success
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh ps:restart $TEST_APP"
  echo "output: $output"
  echo "status: $status"
  assert_success
  for CID_FILE in $DOKKU_ROOT/$TEST_APP/CONTAINER.*; do
    run /bin/bash -c "docker ps -q --no-trunc | grep -q $(<$CID_FILE)"
    echo "output: $output"
    echo "status: $status"
    assert_success
  done
}

@test "(client) remote management commands" {
  setup_client_repo
  local test_app_name=test-apps-create-with-name
  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh apps:create $test_app_name"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "dokku"

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:list"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "dokku"

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:set dokku2"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "dokku2"

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:list"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "dokku"

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:add dokku2 dokku@${DOKKU_DOMAIN}:dokku2"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:list"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "$(printf "dokku\ndokku2")"

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:remove dokku2"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:list"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "dokku"

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:unset"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote:unset"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh remote"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "dokku"
}

@test "(client) test-args" {
  run /bin/bash -c "dokku plugin:install $TEST_PLUGIN_GIT_REPO --name $TEST_PLUGIN_NAME"
  echo "output: $output"
  echo "status: $status"
  assert_success

  run /bin/bash -c "dokku smoke-test-plugin:args bash -c 'echo Hello'"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output "triggered smoke-test-plugin:args with args: smoke-test-plugin:args, bash, -c, echo Hello"

  run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh 'smoke-test-plugin:args bash -c \"echo Hello\"'"
  echo "output: $output"
  echo "status: $status"
  assert_success
  assert_output_contains "triggered smoke-test-plugin:args with args: smoke-test-plugin:args, bash, -c, echo Hello"
}

setup_client_repo() {
  declare TMP="${1:-$(mktemp -d "/tmp/${DOKKU_DOMAIN}.XXXXX")}"
  rmdir "$TMP" && cp -r "${BATS_TEST_DIRNAME}/../../tests/apps/nodejs-express" "$TMP"
  cd "$TMP" || exit 1
  git init
  git config user.email "robot@example.com"
  git config user.name "Test Robot"

  [[ -f gitignore ]] && mv gitignore .gitignore
  git add .
  git commit -m 'initial commit'
}