github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

chore: remove deprecated nginx commands

Browse Source
This commit is contained in:
Jose Diaz-Gonzalez
2023-02-12 13:20:45 -05:00
parent 954b2d9d34
commit f84a650849
13 changed files with 67 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/appendices/0.30.0-migration-guide.md
View File

@@ -22,9 +22,10 @@
- The following git shell functions have been removed:
- `git#use_git_worktree()` (deprecated since 0.23.7) has been removed. There is no alternative as the function has been made internal.
- `git#git_deploy_branch()`(deprecated since 0.21.0) has been removed in favor of `plugn trigger git-deploy-branch`.
- The following deprecated nginx commands have been removed:
- `nginx:show-conf` (deprecated since since 0.20.0) has been removed in favor of `nginx:show-config`
- `nginx:validate` (deprecated since since 0.20.0) has been removed in favor of `nginx:validate-config`
- The following nginx commands - deprecated since 0.20.0 - have been removed:
- `nginx:show-conf` has been removed in favor of `nginx:show-config`.
- `nginx:validate` has been removed in favor of `nginx:validate-config`.
- `nginx:build-config` - deprecated since 0.21.0 - has been removed in favor of `proxy:build-config`.
- The following proxy functions - deprecated since 0.20.0 - have been removed in favor of their plugin trigger equivalents. Sourcing the `proxy/functions` file will fail going forward.
- `proxy#is_app_proxy_enabled()` is removed in favor of `plugn trigger proxy-is-enabled`.
- `proxy#get_app_proxy_type()` is removed in favor of `plugn trigger proxy-type`.

2
docs/development/plugin-triggers.md
View File

@@ -1196,7 +1196,7 @@ echo "$NEW_SUBDOMAIN.$VHOST"
> Warning: The arguments INTERNAL_PORT and INTERNAL_IP_ADDRESS are no longer sufficient to retrieve all app listeners. Please run `plugn trigger network-get-listeners APP` within any implementation of `nginx-pre-reload` in order to retrieve all application listeners.
- Description: Run before nginx reloads hosts
- Invoked by: `dokku nginx:build-config`
- Invoked by: `dokku proxy:build-config`
- Arguments: `$APP $INTERNAL_PORT $INTERNAL_IP_ADDRESS`
- Example:

24
plugins/nginx-vhosts/subcommands/build-config
View File

@@ -1,24 +0,0 @@
#!/usr/bin/env bash
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
cmd-nginx-build-config() {
declare desc="build nginx config to proxy app containers from command line"
declare cmd="nginx:build-config"
[[ "$1" == "$cmd" ]] && shift 1
declare APP="$1"
verify_app_name "$APP"
dokku_log_warn "Deprecated: Please use proxy:build-config"
local PROXY_APP_TYPE
PROXY_APP_TYPE="$(plugn trigger proxy-type "$APP")"
if [[ "$PROXY_APP_TYPE" == "nginx" ]]; then
plugn trigger proxy-build-config "$APP"
else
dokku_log_fail "Configured proxy for ${APP} is ${PROXY_APP_TYPE}"
fi
}
cmd-nginx-build-config "$@"

6
tests/unit/nginx-vhosts_1.bats
View File

@@ -28,7 +28,7 @@ teardown() {
assert_output "$help_output"
}
@test "(nginx-vhosts) nginx:build-config (domains:disable/enable)" {
@test "(nginx-vhosts) proxy:build-config (domains:disable/enable)" {
deploy_app
dokku domains:disable $TEST_APP
@@ -45,7 +45,7 @@ teardown() {
assert_http_success http://${TEST_APP}.dokku.me
}
@test "(nginx-vhosts) nginx:build-config (domains:add pre deploy)" {
@test "(nginx-vhosts) proxy:build-config (domains:add pre deploy)" {
create_app
run /bin/bash -c "dokku domains:add $TEST_APP www.test.app.dokku.me"
echo "output: $output"
@@ -59,7 +59,7 @@ teardown() {
assert_http_success http://www.test.app.dokku.me
}
@test "(nginx-vhosts) nginx:build-config (with global VHOST)" {
@test "(nginx-vhosts) proxy:build-config (with global VHOST)" {
echo "dokku.me" >"$DOKKU_ROOT/VHOST"
deploy_app

20
tests/unit/nginx-vhosts_10.bats
View File

@@ -20,7 +20,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -35,7 +35,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -52,7 +52,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -67,7 +67,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -84,7 +84,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -99,7 +99,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -116,7 +116,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -131,7 +131,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -146,7 +146,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -161,7 +161,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success

16
tests/unit/nginx-vhosts_11.bats
View File

@@ -22,7 +22,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -37,7 +37,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -56,7 +56,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -71,7 +71,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -90,7 +90,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -105,7 +105,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -124,7 +124,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -139,7 +139,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success

8
tests/unit/nginx-vhosts_2.bats
View File

@@ -14,7 +14,7 @@ teardown() {
global_teardown
}
@test "(nginx-vhosts) nginx:build-config (with SSL and unrelated domain)" {
@test "(nginx-vhosts) proxy:build-config (with SSL and unrelated domain)" {
setup_test_tls
dokku domains:add $TEST_APP "node-js-app.dokku.me"
dokku domains:add $TEST_APP "test.dokku.me"
@@ -24,7 +24,7 @@ teardown() {
assert_http_redirect "http://test.dokku.me" "https://test.dokku.me:443/"
}
@test "(nginx-vhosts) nginx:build-config (wildcard SSL)" {
@test "(nginx-vhosts) proxy:build-config (wildcard SSL)" {
setup_test_tls wildcard
dokku domains:add $TEST_APP "wildcard1.dokku.me"
dokku domains:add $TEST_APP "wildcard2.dokku.me"
@@ -34,7 +34,7 @@ teardown() {
assert_ssl_domain "wildcard2.dokku.me"
}
@test "(nginx-vhosts) nginx:build-config (wildcard SSL and unrelated domain) 1" {
@test "(nginx-vhosts) proxy:build-config (wildcard SSL and unrelated domain) 1" {
destroy_app
TEST_APP="${TEST_APP}.example.com"
run /bin/bash -c "dokku apps:create $TEST_APP"
@@ -49,7 +49,7 @@ teardown() {
assert_output "0"
}
@test "(nginx-vhosts) nginx:build-config (with SSL and Multiple SANs)" {
@test "(nginx-vhosts) proxy:build-config (with SSL and Multiple SANs)" {
setup_test_tls sans
dokku domains:add $TEST_APP "test.dokku.me"
dokku domains:add $TEST_APP "www.test.dokku.me"

10
tests/unit/nginx-vhosts_4.bats
View File

@@ -14,7 +14,7 @@ teardown() {
global_teardown
}
@test "(nginx-vhosts) nginx:build-config (without global VHOST)" {
@test "(nginx-vhosts) proxy:build-config (without global VHOST)" {
rm "$DOKKU_ROOT/VHOST"
deploy_app
@@ -32,7 +32,7 @@ teardown() {
done
}
@test "(nginx-vhosts) nginx:build-config (without global VHOST and IPv4 address set as HOSTNAME)" {
@test "(nginx-vhosts) proxy:build-config (without global VHOST and IPv4 address set as HOSTNAME)" {
rm "$DOKKU_ROOT/VHOST"
echo "127.0.0.1" >"$DOKKU_ROOT/VHOST"
deploy_app
@@ -46,7 +46,7 @@ teardown() {
done
}
@test "(nginx-vhosts) nginx:build-config (without global VHOST and IPv6 address set as HOSTNAME)" {
@test "(nginx-vhosts) proxy:build-config (without global VHOST and IPv6 address set as HOSTNAME)" {
rm "$DOKKU_ROOT/VHOST"
echo "fda5:c7db:a520:bb6d::aabb:ccdd:eeff" >"$DOKKU_ROOT/VHOST"
deploy_app
@@ -55,7 +55,7 @@ teardown() {
check_urls http://${HOSTNAME}:[0-9]+
}
@test "(nginx-vhosts) nginx:build-config (without global VHOST and domains:add pre deploy)" {
@test "(nginx-vhosts) proxy:build-config (without global VHOST and domains:add pre deploy)" {
rm "$DOKKU_ROOT/VHOST"
create_app
dokku domains:add $TEST_APP "www.test.app.dokku.me"
@@ -63,7 +63,7 @@ teardown() {
assert_nonssl_domain "www.test.app.dokku.me"
}
@test "(nginx-vhosts) nginx:build-config (without global VHOST and domains:add post deploy)" {
@test "(nginx-vhosts) proxy:build-config (without global VHOST and domains:add post deploy)" {
rm "$DOKKU_ROOT/VHOST"
deploy_app
dokku domains:add $TEST_APP "www.test.app.dokku.me"

10
tests/unit/nginx-vhosts_5.bats
View File

@@ -15,7 +15,7 @@ teardown() {
global_teardown
}
@test "(nginx-vhosts) nginx:build-config (sslip.io style hostnames)" {
@test "(nginx-vhosts) proxy:build-config (sslip.io style hostnames)" {
echo "127.0.0.1.sslip.io.dokku.me" >"$DOKKU_ROOT/VHOST"
deploy_app
@@ -23,7 +23,7 @@ teardown() {
assert_http_success http://${TEST_APP}.127.0.0.1.sslip.io.dokku.me
}
@test "(nginx-vhosts) nginx:build-config (dockerfile expose)" {
@test "(nginx-vhosts) proxy:build-config (dockerfile expose)" {
deploy_app dockerfile
dokku domains:add $TEST_APP "www.test.app.dokku.me"
@@ -38,17 +38,17 @@ teardown() {
}
@test "(nginx-vhosts) nginx:build-config (multiple networks)" {
@test "(nginx-vhosts) proxy:build-config (multiple networks)" {
deploy_app
create_attach_network
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
}
@test "(nginx-vhosts) nginx:build-config (global DOKKU_PROXY_PORT)" {
@test "(nginx-vhosts) proxy:build-config (global DOKKU_PROXY_PORT)" {
local GLOBAL_PORT=30999
run /bin/bash -c "dokku config:set --global DOKKU_PROXY_PORT=${GLOBAL_PORT}"

12
tests/unit/nginx-vhosts_6.bats
View File

@@ -53,7 +53,7 @@ teardown() {
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -66,7 +66,7 @@ teardown() {
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -79,7 +79,7 @@ teardown() {
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -93,7 +93,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -171,7 +171,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -192,7 +192,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success

8
tests/unit/nginx-vhosts_7.bats
View File

@@ -14,7 +14,7 @@ teardown() {
global_teardown
}
@test "(nginx-vhosts) nginx:build-config (wildcard SSL and custom nginx template)" {
@test "(nginx-vhosts) proxy:build-config (wildcard SSL and custom nginx template)" {
setup_test_tls wildcard
dokku domains:add $TEST_APP "wildcard1.dokku.me"
dokku domains:add $TEST_APP "wildcard2.dokku.me"
@@ -26,7 +26,7 @@ teardown() {
assert_http_success "https://${CUSTOM_TEMPLATE_SSL_DOMAIN}"
}
@test "(nginx-vhosts) nginx:build-config (custom nginx template - no ssl)" {
@test "(nginx-vhosts) proxy:build-config (custom nginx template - no ssl)" {
dokku domains:add $TEST_APP "www.test.app.dokku.me"
run deploy_app nodejs-express dokku@dokku.me:$TEST_APP custom_nginx_template
echo "output: $output"
@@ -47,7 +47,7 @@ teardown() {
assert_output_contains "${TEST_APP}-worker-5000"
}
@test "(nginx-vhosts) nginx:build-config (disable custom nginx template - no ssl)" {
@test "(nginx-vhosts) proxy:build-config (disable custom nginx template - no ssl)" {
run /bin/bash -c "dokku nginx:set $TEST_APP disable-custom-config true"
echo "output: $output"
echo "status: $status"
@@ -72,7 +72,7 @@ teardown() {
assert_output_contains "${TEST_APP}-worker-5000" 0
}
@test "(nginx-vhosts) nginx:build-config (failed validate_nginx)" {
@test "(nginx-vhosts) proxy:build-config (failed validate_nginx)" {
run deploy_app nodejs-express dokku@dokku.me:$TEST_APP bad_custom_nginx_template
echo "output: $output"
echo "status: $status"

16
tests/unit/nginx-vhosts_8.bats
View File

@@ -22,7 +22,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -37,7 +37,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -56,7 +56,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -71,7 +71,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -91,7 +91,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -106,7 +106,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -117,7 +117,7 @@ teardown() {
assert_output_contains "45s;" 0
}
@test "(nginx-vhosts) nginx:build-config ignore bad https mapping" {
@test "(nginx-vhosts) proxy:build-config ignore bad https mapping" {
setup_test_tls
run deploy_app "dockerfile-noexpose"
echo "output: $output"
@@ -130,7 +130,7 @@ teardown() {
echo "status: $status"
assert_output "http:80:5000 https:443:5000"
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_output_contains "Ignoring detected https port mapping without an accompanying ssl certificate" 1

18
tests/unit/nginx-vhosts_9.bats
View File

@@ -46,7 +46,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -61,7 +61,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -76,7 +76,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -91,7 +91,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -110,7 +110,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -125,7 +125,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -141,7 +141,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:build-config $TEST_APP"
run /bin/bash -c "dokku proxy:build-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
@@ -152,7 +152,7 @@ teardown() {
assert_output_contains "-access.log;"
}
@test "(nginx-vhosts) nginx:build-config (with SSL and unrelated domain)" {
@test "(nginx-vhosts) proxy:build-config (with SSL and unrelated domain)" {
setup_test_tls
dokku domains:add $TEST_APP "node-js-app.dokku.me"
dokku domains:add $TEST_APP "test.dokku.me"
@@ -162,7 +162,7 @@ teardown() {
assert_http_redirect "http://test.dokku.me" "https://test.dokku.me:443/"
}
@test "(nginx-vhosts) nginx:build-config (wildcard SSL)" {
@test "(nginx-vhosts) proxy:build-config (wildcard SSL)" {
setup_test_tls wildcard
dokku domains:add $TEST_APP "wildcard1.dokku.me"
dokku domains:add $TEST_APP "wildcard2.dokku.me"