Refactor reset-test-db.sh script and allow for an option to rebuild the cache

scripts/reset-test-db.sh

@@ -35,12 +35,50 @@ else
     SETTINGS="bok_choy_docker"
 fi
 
+for i in "$@"; do
+    case $i in
+        -r|--rebuild_cache)
+            REBUILD_CACHE=true
+            ;;
+    esac
+done
+
 declare -A databases
 declare -a database_order
 databases=(["default"]="edxtest" ["student_module_history"]="student_module_history_test")
 database_order=("default" "student_module_history")
 
-# Ensure the test database exists.
+run_migrations() {
+    echo "Running the lms migrations on the $db bok_choy DB."
+    ./manage.py lms --settings $SETTINGS migrate --database $db --traceback --noinput
+    echo "Running the cms migrations on the $db bok_choy DB."
+    ./manage.py cms --settings $SETTINGS migrate --database $db --traceback --noinput
+}
+
+load_cache_into_db() {
+    echo "Loading the schema from the filesystem into the $db MySQL DB."
+    mysql $MYSQL_HOST -u root "${databases["$db"]}" < $DB_CACHE_DIR/bok_choy_schema_$db.sql
+    echo "Loading the fixture data from the filesystem into the $db MySQL DB."
+    ./manage.py lms --settings $SETTINGS loaddata --database $db $DB_CACHE_DIR/bok_choy_data_$db.json
+    echo "Loading the migration data from the filesystem into the $db MySQL DB."
+    mysql $MYSQL_HOST -u root "${databases["$db"]}" < $DB_CACHE_DIR/bok_choy_migrations_data_$db.sql
+}
+
+rebuild_cache_for_db() {
+    # Make sure the DB has all migrations applied
+    run_migrations
+
+    # Dump the schema and data to the cache
+    echo "Using the dumpdata command to save the $db fixture data to the filesystem."
+    ./manage.py lms --settings $SETTINGS dumpdata --database $db > $DB_CACHE_DIR/bok_choy_data_$db.json --exclude=api_admin.Catalog
+    echo "Saving the schema of the $db bok_choy DB to the filesystem."
+    mysqldump $MYSQL_HOST -u root --no-data --skip-comments --skip-dump-date "${databases[$db]}" > $DB_CACHE_DIR/bok_choy_schema_$db.sql
+
+    # dump_data does not dump the django_migrations table so we do it separately.
+    echo "Saving the django_migrations table of the $db bok_choy DB to the filesystem."
+    mysqldump $MYSQL_HOST -u root --no-create-info "${databases["$db"]}" django_migrations > $DB_CACHE_DIR/bok_choy_migrations_data_$db.sql
+}
+
 for db in "${database_order[@]}"; do
     echo "CREATE DATABASE IF NOT EXISTS ${databases[$db]};" | mysql $MYSQL_HOST -u root
 
@@ -53,59 +91,25 @@ for db in "${database_order[@]}"; do
     echo "Issuing a reset_db command to the $db bok_choy MySQL database."
     ./manage.py lms --settings $SETTINGS reset_db --traceback --router $db
 
-    # If there are cached database schemas/data, load them
+    # If there are cached database schemas/data, then load them.
+    # If they are missing, then we will want to build new cache files even if
+    # not explicitly directed to do so via arguments passed to this script.
     if [[ ! -f $DB_CACHE_DIR/bok_choy_schema_$db.sql || ! -f $DB_CACHE_DIR/bok_choy_data_$db.json || ! -f $DB_CACHE_DIR/bok_choy_migrations_data_$db.sql ]]; then
-        echo "Missing $DB_CACHE_DIR/bok_choy_schema_$db.sql or $DB_CACHE_DIR/bok_choy_data_$db.json, or $DB_CACHE_DIR/bok_choy_migrations_data_$db.sql rebuilding cache"
         REBUILD_CACHE=true
+    else
+        load_cache_into_db
     fi
-
 done
 
-# If there are cached database schemas/data, load them
-if [[ -z $REBUILD_CACHE ]]; then
-
-    echo "Found the bok_choy DB cache files. Loading them into the database..."
+if [[ $REBUILD_CACHE ]]; then
+    echo "Cleaning the DB cache directory and building new files."
+    mkdir -p $DB_CACHE_DIR && rm -f $DB_CACHE_DIR/bok_choy*
 
     for db in "${database_order[@]}"; do
-        # Load the schema, then the data (including the migration history)
-        echo "Loading the schema from the filesystem into the $db MySQL DB."
-        mysql $MYSQL_HOST -u root "${databases["$db"]}" < $DB_CACHE_DIR/bok_choy_schema_$db.sql
-        echo "Loading the fixture data from the filesystem into the $db MySQL DB."
-        ./manage.py lms --settings $SETTINGS loaddata --database $db $DB_CACHE_DIR/bok_choy_data_$db.json
-
-        # Migrations are stored in the default database
-        echo "Loading the migration data from the filesystem into the $db MySQL DB."
-        mysql $MYSQL_HOST -u root "${databases["$db"]}" < $DB_CACHE_DIR/bok_choy_migrations_data_$db.sql
-
-        # Re-run migrations to ensure we are up-to-date
-        echo "Running the lms migrations on the $db bok_choy DB."
-        ./manage.py lms --settings $SETTINGS migrate --database $db --traceback --noinput
-        echo "Running the cms migrations on the $db bok_choy DB."
-        ./manage.py cms --settings $SETTINGS migrate --database $db --traceback --noinput
-
+        rebuild_cache_for_db
     done
-
-# Otherwise, update the test database and update the cache
 else
-    echo "Did not find a bok_choy DB cache. Creating a new one from scratch."
-    # Clean the cache directory
-    mkdir -p $DB_CACHE_DIR && rm -f $DB_CACHE_DIR/bok_choy*
-
     for db in "${database_order[@]}"; do
-        # Re-run migrations on the test database
-        echo "Issuing a migrate command to the $db bok_choy MySQL database for the lms django apps."
-        ./manage.py lms --settings $SETTINGS migrate --database $db --traceback --noinput
-        echo "Issuing a migrate command to the $db bok_choy MySQL database for the cms django apps."
-        ./manage.py cms --settings $SETTINGS migrate --database $db --traceback --noinput
-
-        # Dump the schema and data to the cache
-        echo "Using the dumpdata command to save the $db fixture data to the filesystem."
-        ./manage.py lms --settings $SETTINGS dumpdata --database $db > $DB_CACHE_DIR/bok_choy_data_$db.json --exclude=api_admin.Catalog
-        echo "Saving the schema of the $db bok_choy DB to the filesystem."
-        mysqldump $MYSQL_HOST -u root --no-data --skip-comments --skip-dump-date "${databases[$db]}" > $DB_CACHE_DIR/bok_choy_schema_$db.sql
-
-        # dump_data does not dump the django_migrations table so we do it separately.
-        echo "Saving the django_migrations table of the $db bok_choy DB to the filesystem."
-        mysqldump $MYSQL_HOST -u root --no-create-info "${databases["$db"]}" django_migrations > $DB_CACHE_DIR/bok_choy_migrations_data_$db.sql
+        run_migrations
     done
 fi