diff --git a/README.md b/README.md index 98de273..21cb0e6 100644 --- a/README.md +++ b/README.md @@ -48,18 +48,26 @@ dokku redis:create lolipop # official redis image export REDIS_IMAGE="redis" export REDIS_IMAGE_VERSION="2.8.21" +dokku redis:create lolipop # you can also specify custom environment # variables to start the redis service # in semi-colon separated forma export REDIS_CUSTOM_ENV="USER=alpha;HOST=beta" - -# create a redis service dokku redis:create lolipop # get connection information as follows dokku redis:info lolipop +# you can also retrieve a specific piece of service info via flags +dokku redis:info lolipop --config-dir +dokku redis:info lolipop --data-dir +dokku redis:info lolipop --dsn +dokku redis:info lolipop --exposed-ports +dokku redis:info lolipop --links +dokku redis:info lolipop --status +dokku redis:info lolipop --version + # a redis service can be linked to a # container this will use native docker # links via the docker-options plugin diff --git a/functions b/functions index f2a4ee4..0722eea 100755 --- a/functions +++ b/functions @@ -139,13 +139,37 @@ service_exposed_ports() { } service_info() { - local SERVICE="$1" + local SERVICE="$1" INFO_FLAG="$2" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_URL=$(service_url "$SERVICE") + local PORT_FILE="$SERVICE_ROOT/PORT" + local flag key valid_flags - echo " DSN: $SERVICE_URL" - echo " Config dir: $SERVICE_ROOT/config" - echo " Data dir: $SERVICE_ROOT/data" + local flag_map=( + "--config-dir: ${SERVICE_ROOT}/config" + "--data-dir: ${SERVICE_ROOT}/data" + "--dsn: ${SERVICE_URL}" + "--exposed-ports: $(service_exposed_ports "$SERVICE")" + "--links: $(service_linked_apps "$SERVICE")" + "--status: $(service_status "$SERVICE")" + "--version: $(service_version "$SERVICE")" + ) + if [[ -z "$INFO_FLAG" ]]; then + dokku_log_info2 "Container Information" + for flag in "${flag_map[@]}"; do + key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')" + dokku_log_verbose "$(printf "%-20s %-25s" "${key^}" "${flag#*: }")" + done + else + local match=false + for flag in "${flag_map[@]}"; do + valid_flags="${valid_flags} $(echo "$flag" | cut -d':' -f1)" + if [[ "$flag" == "${INFO_FLAG}:"* ]]; then + echo "${flag#*: }" && match=true + fi + done + [[ "$match" == "true" ]] || dokku_log_fail "Invalid flag passed, valid flags:${valid_flags}" + fi } service_link() { diff --git a/subcommands/info b/subcommands/info index 381984f..caf425f 100755 --- a/subcommands/info +++ b/subcommands/info @@ -7,11 +7,11 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" redis-info-cmd() { declare desc="print the connection information" local cmd="$PLUGIN_COMMAND_PREFIX:info" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1 - declare SERVICE="$1" + declare SERVICE="$1" INFO_FLAG="$2" [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service" verify_service_name "$SERVICE" - service_info "$SERVICE" + service_info "$SERVICE" "$INFO_FLAG" } redis-info-cmd "$@" diff --git a/tests/service_info.bats b/tests/service_info.bats index c86db48..85d6015 100755 --- a/tests/service_info.bats +++ b/tests/service_info.bats @@ -21,12 +21,43 @@ teardown() { @test "($PLUGIN_COMMAND_PREFIX:info) success" { run dokku "$PLUGIN_COMMAND_PREFIX:info" l - assert_contains "${lines[*]}" "DSN: redis://dokku-redis-l:6379" + assert_contains "${lines[*]}" "redis://dokku-redis-l:6379" } @test "($PLUGIN_COMMAND_PREFIX:info) replaces underscores by dash in hostname" { dokku "$PLUGIN_COMMAND_PREFIX:create" test_with_underscores run dokku "$PLUGIN_COMMAND_PREFIX:info" test_with_underscores - assert_contains "${lines[*]}" "DSN: redis://dokku-redis-test-with-underscores:6379" + assert_contains "${lines[*]}" "redis://dokku-redis-test-with-underscores:6379" dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" test_with_underscores } + +@test "($PLUGIN_COMMAND_PREFIX:info) success with flag" { + run dokku "$PLUGIN_COMMAND_PREFIX:info" l --dsn + assert_output "redis://dokku-redis-l:6379" + + run dokku "$PLUGIN_COMMAND_PREFIX:info" l --config-dir + assert_success + + run dokku "$PLUGIN_COMMAND_PREFIX:info" l --data-dir + assert_success + + run dokku "$PLUGIN_COMMAND_PREFIX:info" l --dsn + assert_success + + run dokku "$PLUGIN_COMMAND_PREFIX:info" l --exposed-ports + assert_success + + run dokku "$PLUGIN_COMMAND_PREFIX:info" l --links + assert_success + + run dokku "$PLUGIN_COMMAND_PREFIX:info" l --status + assert_success + + run dokku "$PLUGIN_COMMAND_PREFIX:info" l --version + assert_success +} + +@test "($PLUGIN_COMMAND_PREFIX:info) error when invalid flag" { + run dokku "$PLUGIN_COMMAND_PREFIX:info" l --invalid-flag + assert_failure +} diff --git a/tests/test_helper.bash b/tests/test_helper.bash index 4842f7f..e172412 100644 --- a/tests/test_helper.bash +++ b/tests/test_helper.bash @@ -47,6 +47,14 @@ assert_success() { fi } +assert_failure() { + if [[ "$status" -eq 0 ]]; then + flunk "expected failed exit status" + elif [[ "$#" -gt 0 ]]; then + assert_output "$1" + fi +} + assert_exists() { if [ ! -f "$1" ]; then flunk "expected file to exist: $1"