Move USE_VITESS variable into entrypoint.sh (#8567)

This allows standing up a boulder that uses Vitess even when not running
a specific test:

docker compose run -e USE_VITESS=true boulder

It also allows us to run migrations for mariadb or Vitess depending on
which environment we'll be using, which may save a small amount of
startup time.

Specify USE_VITESS: false as an environment variable in
docker-compose.yml to indicate an easy place to change it to `true` if
someone prefers to use `docker compose up` (which does not accept `-e`).

This unfortunately means losing the `-b` flag to `test.sh` but I think
that's an okay tradeoff.

Author: jsha

.github/workflows/boulder-ci.yml

@@ -55,11 +55,11 @@ jobs:
           - "./tn.sh --unit --enable-race-detection"
           - "./t.sh --start-py"
           # Same cases but backed by Vitess + MySQL 8 instead of ProxySQL + MariaDB
-          - "./t.sh --use-vitess --integration"
-          - "./tn.sh --use-vitess --integration"
-          - "./t.sh --use-vitess --unit --enable-race-detection"
-          - "./tn.sh --use-vitess --unit --enable-race-detection"
-          - "./t.sh --use-vitess --start-py"
+          - "USE_VITESS=true ./t.sh --integration"
+          - "USE_VITESS=true ./tn.sh --integration"
+          - "USE_VITESS=true ./t.sh --unit --enable-race-detection"
+          - "USE_VITESS=true ./tn.sh --unit --enable-race-detection"
+          - "USE_VITESS=true ./t.sh --start-py"
 
     env:
       # This sets the docker image tag for the boulder-tools repository to

docker-compose.yml

@@ -15,6 +15,7 @@ services:
       # pointing at the boulder service's "public" IP, where challtestsrv is.
       FAKE_DNS: 64.112.117.122
       BOULDER_CONFIG_DIR: test/config
+      USE_VITESS: false
       GOCACHE: /boulder/.gocache/go-build
     volumes:
       - .:/boulder:cached

t.sh

@@ -12,4 +12,4 @@ fi
 # Generate the test keys and certs necessary for the integration tests.
 docker compose run --rm bsetup
 
-exec docker compose run --rm --name boulder_tests boulder ./test.sh "$@"
+exec docker compose run -e USE_VITESS --rm --name boulder_tests boulder ./test.sh "$@"

test.sh

@@ -12,7 +12,6 @@ fi
 # Defaults
 #
 export RACE="false"
-export USE_VITESS="false"
 STAGE="starting"
 STATUS="FAILURE"
 RUN=()
@@ -22,14 +21,6 @@ INTEGRATION_FLAGS=()
 FILTER=()
 COVERAGE="false"
 COVERAGE_DIR="test/coverage/$(date +%Y-%m-%d_%H-%M-%S)"
-DB_URL_FILES=(
-  badkeyrevoker_dburl
-  cert_checker_dburl
-  incidents_dburl
-  revoker_dburl
-  sa_dburl
-  sa_ro_dburl
-)
 
 #
 # Cleanup Functions
@@ -87,23 +78,6 @@ function run_and_expect_silence() {
   rm "${result_file}"
 }
 
-configure_database_endpoints() {
-  dburl_target_dir="proxysql"
-  export DB_ADDR="boulder-proxysql:6033"
-
-  if [[ "${USE_VITESS}" == "true" ]]
-  then
-    dburl_target_dir="vitess"
-    export DB_ADDR="boulder-vitess:33577"
-  fi
-
-  # Configure DBURL symlinks
-  rm -f test/secrets/*_dburl || true
-  for file in ${DB_URL_FILES:+${DB_URL_FILES[@]+"${DB_URL_FILES[@]}"}}
-  do
-    ln -sf "dburls/${dburl_target_dir}/${file}" "test/secrets/${file}"
-  done
-}
 #
 # Testing Helpers
 #
@@ -147,7 +121,6 @@ With no options passed, runs standard battery of tests (lint, unit, and integrat
                                           Example:
                                            TestGenerateValidity/TestWFECORS
     -h, --help                            Shows this help message
-    -b  --use-vitess                      Run tests against Vitess + MySQL 8.0 database
 
 EOM
 )"
@@ -172,17 +145,13 @@ while getopts luvwecisgnhbd:p:f:-: OPT; do
     n | config-next )                BOULDER_CONFIG_DIR="test/config-next" ;;
     c | coverage )                   COVERAGE="true" ;;
     d | coverage-dir )               check_arg; COVERAGE_DIR="${OPTARG}" ;;
-    b | use-vitess )                 USE_VITESS="true" ;;
     h | help )                       print_usage_exit ;;
     ??* )                            exit_msg "Illegal option --$OPT" ;;  # bad long option
     ? )                              exit 2 ;;  # bad short option (error reported via getopts)
   esac
 done
 shift $((OPTIND-1)) # remove parsed options and args from $@ list
 
-# Defaults to MariaDB unless USE_VITESS is true.
-configure_database_endpoints
-
 # The list of segments to run. Order doesn't matter.
 if [ -z "${RUN[@]+x}" ]
 then

test/entrypoint.sh

@@ -10,6 +10,36 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 rm -f /var/run/rsyslogd.pid
 rsyslogd
 
+DB_URL_FILES=(
+  badkeyrevoker_dburl
+  cert_checker_dburl
+  incidents_dburl
+  revoker_dburl
+  sa_dburl
+  sa_ro_dburl
+)
+
+configure_database_endpoints() {
+  dburl_target_dir="proxysql"
+  export DB_ADDR="boulder-proxysql:6033"
+
+  if [[ "${USE_VITESS}" == "true" ]]
+  then
+    dburl_target_dir="vitess"
+    export DB_ADDR="boulder-vitess:33577"
+  fi
+
+  # Configure DBURL symlinks
+  rm -f test/secrets/*_dburl || true
+  for file in ${DB_URL_FILES:+${DB_URL_FILES[@]+"${DB_URL_FILES[@]}"}}
+  do
+    ln -sf "dburls/${dburl_target_dir}/${file}" "test/secrets/${file}"
+  done
+}
+
+# Defaults to MariaDB/ProxySQL unless USE_VITESS is true.
+configure_database_endpoints
+
 # make sure we can reach mariadb and proxysql
 ./test/wait-for-it.sh boulder-mariadb 3306
 ./test/wait-for-it.sh boulder-proxysql 6033
@@ -21,21 +51,23 @@ rsyslogd
 ./test/wait-for-it.sh bpkimetal 8080
 
 # create the databases
-MYSQL_CONTAINER=1 \
-DB_HOST="boulder-mariadb" \
-DB_PORT=3306 \
-DB_CONFIG_FILE="${DIR}/../sa/db/dbconfig.mariadb.yml" \
-SKIP_CREATE=0 \
-SKIP_USERS=0 \
-"$DIR/create_db.sh"
-
-MYSQL_CONTAINER=1 \
-DB_HOST="boulder-vitess" \
-DB_PORT=33577 \
-DB_CONFIG_FILE="${DIR}/../sa/db/dbconfig.mysql8.yml" \
-SKIP_CREATE=1 \
-SKIP_USERS=1 \
-"$DIR/create_db.sh"
+if [[ "${USE_VITESS}" == "true" ]]; then
+  MYSQL_CONTAINER=1 \
+  DB_HOST="boulder-vitess" \
+  DB_PORT=33577 \
+  DB_CONFIG_FILE="${DIR}/../sa/db/dbconfig.mysql8.yml" \
+  SKIP_CREATE=1 \
+  SKIP_USERS=1 \
+  "$DIR/create_db.sh"
+else
+  MYSQL_CONTAINER=1 \
+  DB_HOST="boulder-mariadb" \
+  DB_PORT=3306 \
+  DB_CONFIG_FILE="${DIR}/../sa/db/dbconfig.mariadb.yml" \
+  SKIP_CREATE=0 \
+  SKIP_USERS=0 \
+  "$DIR/create_db.sh"
+fi
 
 if [[ $# -eq 0 ]]; then
     exec python3 ./start.py

tn.sh

@@ -12,4 +12,4 @@ fi
 # Generate the test keys and certs necessary for the integration tests.
 docker compose run --rm bsetup
 
-exec docker compose -f docker-compose.yml -f docker-compose.next.yml run --rm --name boulder_tests boulder ./test.sh "$@"
+exec docker compose -f docker-compose.yml -f docker-compose.next.yml run -e USE_VITESS --rm --name boulder_tests boulder ./test.sh "$@"