Add strict SQL mode to allow d2-cloner to stop execution on error during cloning process

src/d2_docker/cli.py

@@ -80,6 +80,9 @@ def main():
     args = parser.parse_args()
     utils.logger.setLevel(args.log_level.upper())
 
+
+    if getattr(args, "strict_sql", False) and not args.run_sql:
+        parser.error("--strict-sql requires --run-sql to be set")
     if not getattr(args, "func", None):
         parser.print_usage()
         return 1

src/d2_docker/commands/start.py

@@ -26,6 +26,7 @@ def setup(parser):
     parser.add_argument("--tomcat-server-xml", metavar="FILE", help=server_xml_help)
     parser.add_argument("--dhis-conf", metavar="FILE", help=dhis_conf_help)
     parser.add_argument("--run-sql", metavar="DIRECTORY", help="Run .sql[.gz] files in directory")
+    parser.add_argument("--strict-sql", action="store_true", default=False, help="Stop the sql script on first fail and show in the log")
     parser.add_argument("--debug-port", metavar="PORT", help="Expose DHIS2 core debug port")
     parser.add_argument("--db-port", metavar="PORT", help="Expose DB Postgres port")
     parser.add_argument(
@@ -93,6 +94,11 @@ def start(args):
     )
 
     deploy_path = "/" + re.sub("^/*", "", args.deploy_path) if args.deploy_path else ""
+    post_strict_sql_dir = None
+    post_sql_dir = args.run_sql
+    if args.run_sql and args.strict_sql:
+        post_strict_sql_dir = post_sql_dir
+        post_sql_dir = None
 
     with utils.stop_docker_on_interrupt(image_name, core_image):
         utils.run_docker_compose(
@@ -102,7 +108,8 @@ def start(args):
             bind_ip=args.bind_ip,
             core_image=core_image,
             load_from_data=override_containers,
-            post_sql_dir=args.run_sql,
+            post_sql_dir=post_sql_dir,
+            post_strict_sql_dir=post_strict_sql_dir,
             debug_port=args.debug_port,
             db_port=args.db_port,
             scripts_dir=args.run_scripts,

src/d2_docker/config/dhis2-core-start.sh

@@ -17,13 +17,16 @@ export PGPASSWORD="dhis"
 
 dhis2_url="http://localhost:8080/$DEPLOY_PATH"
 dhis2_url_with_auth="http://$DHIS2_AUTH@localhost:8080/$DEPLOY_PATH"
-psql_cmd="psql -v ON_ERROR_STOP=0 --quiet -h db -U dhis dhis2"
+psql_base_cmd="psql --quiet -h db -U dhis dhis2"
+psql_cmd="$psql_base_cmd -v ON_ERROR_STOP=0"
+psql_strict_cmd="$psql_base_cmd -v ON_ERROR_STOP=1"
 pgrestore_cmd="pg_restore -h db -U dhis -d dhis2"
 configdir="/config"
 homedir="/dhis2-home-files"
 scripts_dir="/data/scripts"
 root_db_path="/data/db"
 post_db_path="/data/db/post"
+post_strict_db_path="/data/db/post_strict_sql"
 source_apps_path="/data/apps"
 source_documents_path="/data/document"
 source_datavalues_path="/data/dataValue"
@@ -50,12 +53,22 @@ run_sql_files() {
         echo "Load SQL (compressed): $path"
         zcat "$path" | $psql_cmd || true
     done
-
     find "$base_db_path" -type f \( -name '*.sql' \) |
         sort | while read -r path; do
         echo "Load SQL: $path"
         $psql_cmd <"$path" || true
     done
+    find "$post_strict_db_path" -type f \( -name '*.sql' \) |
+        sort | while read -r path; do
+        echo "Load SQL: $path"
+        $psql_strict_cmd <"$path"
+        exit_code=$?
+        echo "Exit code of psql: $exit_code"
+        if [[ $exit_code -ne 0 ]]; then
+            echo "Error detected while executing SQL file: $path"
+        fi
+        true
+    done
 }
 
 run_pre_scripts() {

src/d2_docker/docker-compose.yml

@@ -12,6 +12,7 @@ services:
             - "${TOMCAT_SERVER}:/config/override/tomcat/server.xml"
             - "${SCRIPTS_DIR}:/data/scripts"
             - "${POST_SQL_DIR}:/data/db/post"
+            - "${POST_STRICT_SQL_DIR}:/data/db/post_strict_sql"
             - "/etc/timezone:/etc/timezone:ro"
             - "/etc/localtime:/etc/localtime:ro"
         environment:

src/d2_docker/utils.py

@@ -250,6 +250,7 @@ def run_docker_compose(
     port=None,
     load_from_data=True,
     post_sql_dir=None,
+    post_strict_sql_dir=None,
     debug_port=None,
     db_port=None,
     bind_ip=None,
@@ -274,6 +275,7 @@ def run_docker_compose(
     project_name = get_project_name(final_image_name)
     core_image_name = core_image or get_core_image_name(data_image)
     post_sql_dir_abs = get_absdir_for_docker_volume(post_sql_dir)
+    post_strict_sql_dir_abs= get_absdir_for_docker_volume(post_strict_sql_dir)
     scripts_dir_abs = get_absdir_for_docker_volume(scripts_dir)
 
     env_pairs = [
@@ -285,6 +287,8 @@ def run_docker_compose(
         ("LOAD_FROM_DATA", "yes" if load_from_data else "no"),
         # Set default values for directory, required by docker-compose volumes section
         ("POST_SQL_DIR", post_sql_dir_abs),
+        ("POST_STRICT_SQL_DIR", post_strict_sql_dir_abs),
+
         ("SCRIPTS_DIR", scripts_dir_abs),
         ("DEPLOY_PATH", deploy_path or ""),
         ("JAVA_OPTS", java_opts or ""),