Improve error handling using a fail-fast approach

Author: JohT

.github/workflows/code-structure-analysis.yml

@@ -134,10 +134,9 @@ jobs:
       if: failure()
       uses: actions/upload-artifact@v3
       with:
-        name: code-analysis-logs-java-${{ matrix.java }}-python-${{ matrix.python }}-mambaforge-${{ matrix.mambaforge }}
+        name: code-analysis-error-logs-java-${{ matrix.java }}-python-${{ matrix.python }}-mambaforge-${{ matrix.mambaforge }}
         path: |
-          ./temp/**/runtime/*
-          ./results
+          temp/AxonFramework-${{ env.AXON_FRAMEWORK_VERSION }}/**/*.log
         retention-days: 5
 
     # Upload successful results in case they are needed for troubleshooting

scripts/analysis/analyze.sh

@@ -30,6 +30,9 @@
 
 # Requires setupNeo4j.sh,setupJQAssistant.sh,startNeo4j.sh,resetAndScanChanged.sh,prepareAnalysis.sh,stopNeo4j.sh,comilations/*.sh,profiles/*.sh
 
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -eo pipefail
+
 # Overrideable variables with directory names
 REPORTS_SCRIPTS_DIRECTORY=${REPORTS_SCRIPTS_DIRECTORY:-"reports"} # Working directory containing the generated reports
 REPORT_COMPILATIONS_SCRIPTS_DIRECTORY=${REPORT_COMPILATIONS_SCRIPTS_DIRECTORY:-"compilations"} # Repository directory that contains scripts that execute selected report generation scripts
@@ -116,18 +119,18 @@ fi
 
 # Execute the settings profile script that sets all the neccessary settings variables (overrideable by environment variables).
 echo "analyze: Using analysis settings profile script ${SETTINGS_PROFILE_SCRIPT}"
-source "${SETTINGS_PROFILE_SCRIPT}" || exit 2
+source "${SETTINGS_PROFILE_SCRIPT}"
 
 # Setup Tools
-source "${SCRIPTS_DIR}/setupNeo4j.sh" || exit 3
-source "${SCRIPTS_DIR}/setupJQAssistant.sh" || exit 3
-source "${SCRIPTS_DIR}/startNeo4j.sh" || exit 3
+source "${SCRIPTS_DIR}/setupNeo4j.sh"
+source "${SCRIPTS_DIR}/setupJQAssistant.sh"
+source "${SCRIPTS_DIR}/startNeo4j.sh"
 
 # Scan and analyze artifacts when they were changed
-source "${SCRIPTS_DIR}/resetAndScanChanged.sh" || exit 4
+source "${SCRIPTS_DIR}/resetAndScanChanged.sh"
 
 # Prepare and validate graph database before analyzing and creating reports 
-source "${SCRIPTS_DIR}/prepareAnalysis.sh" || exit 5
+source "${SCRIPTS_DIR}/prepareAnalysis.sh"
 
 if ${exploreMode}; then
   echo "analyze: Explore mode activated. Report generation will be skipped. Neo4j keeps running."
@@ -138,7 +141,7 @@ fi
 # Create Reports
 #########################
 echo "analyze: Creating Reports with ${REPORT_COMPILATION_SCRIPT} ..."
-source "${REPORT_COMPILATION_SCRIPT}" || exit 6
+source "${REPORT_COMPILATION_SCRIPT}"
 
 # Stop Neo4j at the end
 source "${SCRIPTS_DIR}/stopNeo4j.sh"

scripts/copyReportsIntoResults.sh

@@ -8,6 +8,9 @@
 
 # Requires generateJupyterReportReference.sh
 
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -eo pipefail
+
 ## Get this "scripts" directory if not already set
 # Even if $BASH_SOURCE is made for Bourne-like shells it is also supported by others and therefore here the preferred solution. 
 # CDPATH reduces the scope of the cd command to potentially prevent unintended directory changes.

scripts/detectChangedArtifacts.sh

@@ -4,6 +4,9 @@
 # The hash value is generated based on all files (their names and properties) within the artifacts directory.
 # A change is detected when the current hash and the stored one differ.
 
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -eo pipefail
+
 ARTIFACTS_DIRECTORY=${ARTIFACTS_DIRECTORY:-"artifacts"}
 ARTIFACTS_CHANGE_DETECTION_HASH_FILE=${ARTIFACTS_CHANGE_DETECTION_HASH_FILE:-"artifactsChangeDetectionHash.txt"} # Name of the file that contains the hash code of the file list for change detection
 ARTIFACTS_CHANGE_DETECTION_HASH_FILE_PATH="./${ARTIFACTS_DIRECTORY}/$ARTIFACTS_CHANGE_DETECTION_HASH_FILE"
@@ -16,7 +19,9 @@ fi
 
 # Use find to list all files in the directory with their properties,
 # sort the output, and pipe it to md5 to create a hash
-CURRENT_ARTIFACTS_HASH="$( find "./$ARTIFACTS_DIRECTORY" -type f -not -name "${ARTIFACTS_CHANGE_DETECTION_HASH_FILE}" -exec stat -f "%N %p %z" {} + | sort | md5 -r )"
+# Use openssl md5 that is at least available on Mac and Linux. 
+# See: https://github.com/TRON-US/go-btfs/issues/90#issuecomment-517409369
+CURRENT_ARTIFACTS_HASH="$( find "./$ARTIFACTS_DIRECTORY" -type f -not -name "${ARTIFACTS_CHANGE_DETECTION_HASH_FILE}" -exec openssl md5 -binary {} + | openssl md5 | awk '{print $2}' )"
 
 # Assume that the files where changed if the file containing the hash of the file list does not exist yet.
 if [ ! -f "${ARTIFACTS_CHANGE_DETECTION_HASH_FILE_PATH}" ] ; then

scripts/documentation/appendEnvironmentVariables.sh

@@ -5,6 +5,9 @@
 # Note: If called with "clear" instead of a filename then the generated markdown reference documentation file is deleted.
 #       This is helpful to start over with the generation of a new document.
 
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -eo pipefail
+
 # Markdown file name
 markdownFile="ENVIRONMENT_VARIABLES.md"
 

scripts/documentation/generateCsvReportReference.sh

@@ -5,6 +5,9 @@
 # Note: This script was generated by Chat-GPT after some messages back and forth:
 # https://chat.openai.com/share/0bd3cde7-32d0-460d-830c-79b7d00a2492
 
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -eo pipefail
+
 # Output Markdown file name
 output_file="CSV_REPORTS.md"
 

scripts/documentation/generateCypherReference.sh

@@ -3,6 +3,9 @@
 # Generates "CYPHER.md" containing a reference to all Cypher files in this directory and its subdirectories.
 # This script was generated by Chat-GPT after some messages back and forth and then tuned manually.
 
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -eo pipefail
+
 # Markdown file name
 markdown_file="CYPHER.md"
 

scripts/documentation/generateEnvironmentVariableReference.sh

@@ -4,6 +4,9 @@
 
 # Requires appendEnvironmentVariable.sh
 
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -eo pipefail
+
 ## Get this "scripts" directory if not already set
 # Even if $BASH_SOURCE is made for Bourne-like shells it is also supported by others and therefore here the preferred solution. 
 # CDPATH reduces the scope of the cd command to potentially prevent unintended directory changes.

scripts/documentation/generateImageReference.sh

@@ -2,6 +2,9 @@
 
 # Generates "IMAGES.md" containing a reference to all images (PNG) in this directory and its subdirectories.
 
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -eo pipefail
+
 # Markdown file name
 markdown_file="IMAGES.md"
 

scripts/documentation/generateJupyterReportReference.sh

@@ -3,6 +3,9 @@
 # Generates "JUPYTER_REPORTS.md" containing a reference to all Jupyter Notebook Markdown reports in this directory and its subdirectories.
 # This script was generated by Chat-GPT after some messages back and forth and then tuned manually.
 
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -eo pipefail
+
 # Markdown file name
 markdown_file="JUPYTER_REPORTS.md"