refactor: only use detected port mapping if override is not specified

Previously, we would always set the port mapping during a dockerfile build, making it difficult for users to override mappings. We also only _sometimes_ updated the detected port mapping, further confusing issues when users were migrating from Dockerfile to Buildpacks for builds.

Now, we always detect the port mapping during the build process, and only use that detected port mapping if an override is not specified. This greatly simplifies the experience around port mapping, as now a user can create an app, set a port mapping, and that first deploy will respect the port mapping without an additional deploy.

The builder always has the best context for what the app should be listening on, and thus we can always specify a "default" port mapping at this stage. Users can override this map as desired later.

This change also results in the removal of a ton of internal code that is now centralized in the ports plugin.

Closes #4067

tests/unit/builder-dockerfile.bats

@@ -4,9 +4,11 @@ load test_helper
 
 setup() {
   create_app
+  DOCKERFILE="$BATS_TMPDIR/Dockerfile"
 }
 
 teardown() {
+  rm -f "$DOCKERFILE"
   destroy_app
 }
 
@@ -66,3 +68,29 @@ teardown() {
   assert_success
   assert_output_contains "TOKEN is: custom-value" 2
 }
+
+@test "(builder-dockerfile) port exposure (dockerfile raw port)" {
+  source "$PLUGIN_CORE_AVAILABLE_PATH/builder-dockerfile/internal-functions"
+  cat <<EOF >$DOCKERFILE
+EXPOSE 3001/udp
+EXPOSE 3003
+EXPOSE  3000/tcp
+EOF
+  run fn-builder-dockerfile-get-ports-from-dockerfile $DOCKERFILE
+  echo "output: $output"
+  echo "status: $status"
+  assert_output "3001/udp 3003 3000/tcp"
+}
+
+@test "(builder-dockerfile) port exposure (dockerfile tcp port)" {
+  source "$PLUGIN_CORE_AVAILABLE_PATH/builder-dockerfile/internal-functions"
+  cat <<EOF >$DOCKERFILE
+EXPOSE 3001/udp
+EXPOSE  3000/tcp
+EXPOSE 3003
+EOF
+  run fn-builder-dockerfile-get-ports-from-dockerfile $DOCKERFILE
+  echo "output: $output"
+  echo "status: $status"
+  assert_output "3001/udp 3000/tcp 3003"
+}

tests/unit/caddy.bats

@@ -137,7 +137,12 @@ teardown() {
   assert_success
   assert_output "$TEST_APP.dokku.me"
 
-  run /bin/bash -c "dokku ports:report $TEST_APP --ports-map"
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map"
+  echo "output: $output"
+  echo "status: $status"
+  assert_output_not_exists
+
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map-detected"
   echo "output: $output"
   echo "status: $status"
   assert_output "http:80:5000"

tests/unit/core_1.bats

@@ -46,32 +46,6 @@ teardown() {
   docker rm $RANDOM_RUN_CID
 }
 
-@test "(core) port exposure (dockerfile raw port)" {
-  source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
-  cat <<EOF >$DOCKERFILE
-EXPOSE 3001/udp
-EXPOSE 3003
-EXPOSE  3000/tcp
-EOF
-  run get_dockerfile_exposed_ports $DOCKERFILE
-  echo "output: $output"
-  echo "status: $status"
-  assert_output "3001/udp 3003 3000/tcp"
-}
-
-@test "(core) port exposure (dockerfile tcp port)" {
-  source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
-  cat <<EOF >$DOCKERFILE
-EXPOSE 3001/udp
-EXPOSE  3000/tcp
-EXPOSE 3003
-EOF
-  run get_dockerfile_exposed_ports $DOCKERFILE
-  echo "output: $output"
-  echo "status: $status"
-  assert_output "3001/udp 3000/tcp 3003"
-}
-
 @test "(core) image type detection (herokuish default user)" {
   run deploy_app
   echo "output: $output"

tests/unit/haproxy.bats

@@ -154,7 +154,12 @@ teardown() {
   assert_success
   assert_output "true"
 
-  run /bin/bash -c "dokku ports:report $TEST_APP --ports-map"
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map"
+  echo "output: $output"
+  echo "status: $status"
+  assert_output_not_exists
+
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map-detected"
   echo "output: $output"
   echo "status: $status"
   assert_output "http:80:5000"

tests/unit/nginx-vhosts_4.bats

@@ -26,6 +26,11 @@ teardown() {
   echo "status: $status"
   assert_success
 
+  run /bin/bash -c "dokku ports:report $TEST_APP"
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
   HOSTNAME="$(hostname -f)"
   check_urls http://${HOSTNAME}:[0-9]+
 

tests/unit/nginx-vhosts_5.bats

@@ -63,6 +63,9 @@ teardown() {
 @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}"
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
 
   run deploy_app
   echo "output: $output"
@@ -72,4 +75,7 @@ teardown() {
   assert_http_success http://${TEST_APP}.dokku.me:${GLOBAL_PORT}
 
   run /bin/bash -c "dokku config:unset --global DOKKU_PROXY_PORT"
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
 }

tests/unit/nginx-vhosts_7.bats

@@ -43,7 +43,7 @@ teardown() {
   echo "status: $status"
   assert_success
 
-  run deploy_app nodejs-express dokku@dokku.me:$TEST_APP custom_nginx_template
+  run deploy_app python dokku@dokku.me:$TEST_APP custom_nginx_template
   echo "output: $output"
   echo "status: $status"
   assert_success
@@ -73,7 +73,7 @@ teardown() {
   echo "status: $status"
   assert_success
 
-  run deploy_app nodejs-express dokku@dokku.me:$TEST_APP custom_nginx_template
+  run deploy_app python dokku@dokku.me:$TEST_APP custom_nginx_template
   echo "output: $output"
   echo "status: $status"
   assert_success

tests/unit/nginx-vhosts_8.bats

@@ -133,19 +133,25 @@ teardown() {
   echo "status: $status"
   assert_output_contains "Ignoring detected https port mapping without an accompanying ssl certificate" 0
 
-  teardown_test_tls
-  run /bin/bash -c "dokku ports:report $TEST_APP --ports-map"
+  run /bin/bash -c "dokku ports:report $TEST_APP --ports-map-detected"
   echo "output: $output"
   echo "status: $status"
   assert_output "http:80:5000 https:443:5000"
+  teardown_test_tls
+
+  run /bin/bash -c "dokku ports:report $TEST_APP --ports-map-detected"
+  echo "output: $output"
+  echo "status: $status"
+  assert_output "http:80:5000"
 
   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
+  run /bin/bash -c "dokku nginx:show-config $TEST_APP"
+  assert_output_contains "Ignoring detected https port mapping without an accompanying ssl certificate" 0
 
-  run /bin/bash -c "dokku ports:report $TEST_APP --ports-map"
+  run /bin/bash -c "dokku ports:report $TEST_APP --ports-map-detected"
   echo "output: $output"
   echo "status: $status"
-  assert_output "http:80:5000 https:443:5000"
+  assert_output "http:80:5000"
 }

tests/unit/ports.bats

@@ -34,60 +34,65 @@ teardown() {
   echo "status: $status"
   assert_success
 
-  run /bin/bash -c "dokku --quiet ports:list $TEST_APP | xargs"
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map"
   echo "output: $output"
   echo "status: $status"
-  assert_output "http 1234 5001"
+  assert_output "http:1234:5001"
 
   run /bin/bash -c "dokku ports:add $TEST_APP http:8080:5002 https:8443:5003"
   echo "output: $output"
   echo "status: $status"
   assert_success
 
-  run /bin/bash -c "dokku --quiet ports:list $TEST_APP | xargs"
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map"
   echo "output: $output"
   echo "status: $status"
-  assert_output "http 1234 5001 http 8080 5002 https 8443 5003"
+  assert_output "http:1234:5001 http:8080:5002 https:8443:5003"
 
   run /bin/bash -c "dokku ports:set $TEST_APP http:8080:5000 https:8443:5000 http:1234:5001"
   echo "output: $output"
   echo "status: $status"
   assert_success
 
-  run /bin/bash -c "dokku --quiet ports:list $TEST_APP | xargs"
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map"
   echo "output: $output"
   echo "status: $status"
-  assert_output "http 1234 5001 http 8080 5000 https 8443 5000"
+  assert_output "http:1234:5001 http:8080:5000 https:8443:5000"
 
   run /bin/bash -c "dokku ports:remove $TEST_APP 8080"
   echo "output: $output"
   echo "status: $status"
   assert_success
 
-  run /bin/bash -c "dokku --quiet ports:list $TEST_APP | xargs"
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map"
   echo "output: $output"
   echo "status: $status"
-  assert_output "http 1234 5001 https 8443 5000"
+  assert_output "http:1234:5001 https:8443:5000"
 
   run /bin/bash -c "dokku ports:remove $TEST_APP http:1234:5001"
   echo "output: $output"
   echo "status: $status"
   assert_success
 
-  run /bin/bash -c "dokku --quiet ports:list $TEST_APP | xargs"
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map"
   echo "output: $output"
   echo "status: $status"
-  assert_output "https 8443 5000"
+  assert_output "https:8443:5000"
 
   run /bin/bash -c "dokku ports:clear $TEST_APP"
   echo "output: $output"
   echo "status: $status"
   assert_success
 
-  run /bin/bash -c "dokku --quiet ports:list $TEST_APP | xargs"
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map"
   echo "output: $output"
   echo "status: $status"
-  assert_output "http 80 5000"
+  assert_output_not_exists
+
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map-detected"
+  echo "output: $output"
+  echo "status: $status"
+  assert_output "http:80:5000"
 }
 
 @test "(ports:add) post-deploy add" {
@@ -138,7 +143,7 @@ teardown() {
   run /bin/bash -c "dokku ports:report $TEST_APP --ports-map"
   echo "output: $output"
   echo "status: $status"
-  assert_output "http:80:5000 https:443:5000"
+  assert_output_not_exists
 
   run /bin/bash -c "dokku ports:report $TEST_APP --ports-map-detected"
   echo "output: $output"
@@ -155,7 +160,7 @@ teardown() {
   run /bin/bash -c "dokku ports:report $TEST_APP --ports-map"
   echo "output: $output"
   echo "status: $status"
-  assert_output "http:3000:3000 http:3003:3003"
+  assert_output_not_exists
 
   run /bin/bash -c "dokku ports:report $TEST_APP --ports-map-detected"
   echo "output: $output"
@@ -170,7 +175,7 @@ teardown() {
   run /bin/bash -c "dokku ports:report $TEST_APP --ports-map"
   echo "output: $output"
   echo "status: $status"
-  assert_output "http:3000:3000 http:3003:3003"
+  assert_output_not_exists
 
   run /bin/bash -c "dokku ports:report $TEST_APP --ports-map-detected"
   echo "output: $output"

tests/unit/test_helper.bash

@@ -224,7 +224,7 @@ assert_http_success() {
 assert_http_localhost_success() {
   local scheme="$1" domain="$2" port="${3:-80}" path="${4:-}"
   run curl --connect-to "$domain:$port:localhost:$port" -kSso /dev/null -w "%{http_code}" "$scheme://$domain:$port$path"
-  echo "curl: curl --connect-to $domain:$port:localhost:$port-kSso /dev/null -w %{http_code} $scheme://$domain:$port$path"
+  echo "curl: curl --connect-to $domain:$port:localhost:$port -kSso /dev/null -w %{http_code} $scheme://$domain:$port$path"
   echo "output: $output"
   echo "status: $status"
   assert_output "200"

tests/unit/traefik.bats

@@ -233,7 +233,12 @@ teardown() {
   assert_success
   assert_output "5000"
 
-  run /bin/bash -c "dokku ports:report $TEST_APP --ports-map"
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map"
+  echo "output: $output"
+  echo "status: $status"
+  assert_output_not_exists
+
+  run /bin/bash -c "dokku --quiet ports:report $TEST_APP --ports-map-detected"
   echo "output: $output"
   echo "status: $status"
   assert_output "http:80:5000"