Add comment for dependencies to other scripts

JohT · JohT · commit 0c8ae2148373 · 2023-07-19T08:01:05.000+02:00
diff --git a/scripts/analysis/analyze.sh b/scripts/analysis/analyze.sh
@@ -28,6 +28,8 @@
 #       when it comes to subsequent executions.
 #       Existing downloads, installations, scans and processes will be detected.
 
+# Requires setupNeo4j.sh,setupJQAssistant.sh,startNeo4j.sh,resetAndScanChanged.sh,prepareAnalysis.sh,stopNeo4j.sh,comilations/*.sh,profiles/*.sh
+
 # Overrideable variables with directory names
 REPORTS_SCRIPTS_DIRECTORY=${REPORTS_SCRIPTS_DIRECTORY:-"reports"}
 REPORT_COMPILATIONS_SCRIPTS_DIRECTORY=${REPORT_COMPILATIONS_SCRIPTS_DIRECTORY:-"compilations"}
diff --git a/scripts/copyReportsIntoResults.sh b/scripts/copyReportsIntoResults.sh
@@ -6,6 +6,8 @@
 
 # Notice that this scripts needs to be executed within the "temp" directory.
 
+# Requires generateMarkdownReference.sh
+
 ## 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.
diff --git a/scripts/downloader/downloadAxonFramework.sh b/scripts/downloader/downloadAxonFramework.sh
@@ -8,6 +8,8 @@
 
 # Note: This script is meant to be started within the temporary analysis directory (e.g. "temp/AnalysisName/")
 
+# Requires downloadMavenArtifact.sh
+
 # Get the analysis name from the middle part of the current file name (without prefix "download" and without extension)
 SCRIPT_FILE_NAME="$(basename -- "${BASH_SOURCE[0]}")"
 SCRIPT_FILE_NAME_WITHOUT_EXTENSION="${SCRIPT_FILE_NAME%%.*}"
diff --git a/scripts/executeQueryFunctions.sh b/scripts/executeQueryFunctions.sh
@@ -2,6 +2,8 @@
 
 # Provides functions to execute Cypher queries using either "executeQuery.sh" or Neo4j's "cypher-shell". 
 
+# Requires executeQuery.sh
+
 ## 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.
diff --git a/scripts/prepareAnalysis.sh b/scripts/prepareAnalysis.sh
@@ -2,6 +2,8 @@
 
 # Prepares and validates the graph database before analysis 
 
+# Requires executeQueryFunctions.sh
+
 ## 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.
diff --git a/scripts/reports/CentralityCsv.sh b/scripts/reports/CentralityCsv.sh
@@ -5,6 +5,8 @@
 # The reports (csv files) will be written into the sub directory reports/community.
 # Note that "scripts/prepareAnalysis.sh" is required to run prior to this script.
 
+# Requires executeQueryFunctions.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/CommunityCsv.sh b/scripts/reports/CommunityCsv.sh
@@ -5,6 +5,8 @@
 # The reports (csv files) will be written into the sub directory reports/community.
 # Note that "scripts/prepareAnalysis.sh" is required to run prior to this script.
 
+# Requires executeQueryFunctions.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/ExternalDependenciesCsv.sh b/scripts/reports/ExternalDependenciesCsv.sh
@@ -3,6 +3,8 @@
 # Executes "Package_Usage" Cypher queries to get the "external-dependencies-csv" CSV reports.
 # They list external library package usage like how often a external package is called.
 
+# Requires executeQueryFunctions.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/ExternalDependenciesJupyter.sh b/scripts/reports/ExternalDependenciesJupyter.sh
@@ -5,6 +5,8 @@
 # how they relate to each other, distribution of Methods and their effective lines of code
 # and how the cyclomatic complexity is distributed across all Methods per artifact.
 
+# Requires executeJupyterNotebook.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/InternalDependenciesCsv.sh b/scripts/reports/InternalDependenciesCsv.sh
@@ -4,6 +4,8 @@
 # It contains lists of e.g. incoming and outgoing package dependencies,
 # abstractness, instability and the distance to the so called "main sequence".
 
+# Requires executeQueryFunctions.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/InternalDependenciesJupyter.sh b/scripts/reports/InternalDependenciesJupyter.sh
@@ -4,6 +4,8 @@
 # It contains lists of e.g. cyclic dependencies, dependencies that are only used by a few packages,
 # classes that are used by many different packages and some more.
 
+# Requires executeJupyterNotebook.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/ObjectOrientedDesignMetricsCsv.sh b/scripts/reports/ObjectOrientedDesignMetricsCsv.sh
@@ -4,6 +4,8 @@
 # It contains lists of e.g. incoming and outgoing package dependencies,
 # abstractness, instability and the distance to the so called "main sequence".
 
+# Requires executeQueryFunctions.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/ObjectOrientedDesignMetricsJupyter.sh b/scripts/reports/ObjectOrientedDesignMetricsJupyter.sh
@@ -4,6 +4,8 @@
 # It contains lists of e.g. incoming and outgoing package dependencies,
 # abstractness, instability and the distance to the so called "main sequence".
 
+# Requires executeJupyterNotebook.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/OverviewCsv.sh b/scripts/reports/OverviewCsv.sh
@@ -3,6 +3,8 @@
 # Executes "Overview" Cypher queries to get the "overview-csv" CSV reports.
 # It contains the numbers of packages, types, methods, cyclic complexity, etc.
 
+# Requires executeQueryFunctions.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/OverviewJupyter.sh b/scripts/reports/OverviewJupyter.sh
@@ -5,6 +5,8 @@
 # how they relate to each other, distribution of Methods and their effective lines of code
 # and how the cyclomatic complexity is distributed across all Methods per artifact.
 
+# Requires executeJupyterNotebook.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/SimilarityCsv.sh b/scripts/reports/SimilarityCsv.sh
@@ -5,6 +5,8 @@
 # The reports (csv files) will be written into the sub directory reports/community.
 # Note that "scripts/prepareAnalysis.sh" is required to run prior to this script.
 
+# Requires executeQueryFunctions.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/VisibilityMetricsCsv.sh b/scripts/reports/VisibilityMetricsCsv.sh
@@ -4,6 +4,8 @@
 # It contains lists of packages with their relative visibility (public types divided by all types)
 # as well as the global statistics for every artifact.
 
+# Requires executeQueryFunctions.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/VisibilityMetricsJupyter.sh b/scripts/reports/VisibilityMetricsJupyter.sh
@@ -3,6 +3,8 @@
 # Creates the "visibility-metrics" report (ipynb, md, pdf) based on the Jupyter Notebook "VisibilityMetrics.ipynb".
 # It contains lists of how many components are visible everywhere in comparison to all (including internal) components.
 
+# Requires executeJupyterNotebook.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/WordcloudJupyter.sh b/scripts/reports/WordcloudJupyter.sh
@@ -5,6 +5,8 @@
 # how they relate to each other, distribution of Methods and their effective lines of code
 # and how the cyclomatic complexity is distributed across all Methods per artifact.
 
+# Requires executeJupyterNotebook.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/compilations/AllReports.sh b/scripts/reports/compilations/AllReports.sh
@@ -3,6 +3,8 @@
 # Runs all report scripts.
 # It only consideres scripts in the "reports" directory (overridable with REPORTS_SCRIPT_DIR) one directory above this one.
 
+# Requires reports/*.sh
+
 ## Get this "scripts/reports/compilations" 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.
diff --git a/scripts/reports/compilations/CsvReports.sh b/scripts/reports/compilations/CsvReports.sh
@@ -3,6 +3,8 @@
 # Runs all CSV report scripts (no Python and Chromium required).
 # It only consideres scripts in the "reports" directory (overridable with REPORTS_SCRIPT_DIR) one directory above this one.
 
+# Requires reports/*.sh
+
 ## Get this "scripts/reports/compilations" 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.
diff --git a/scripts/reports/compilations/DatabaseCsvExportReports.sh b/scripts/reports/compilations/DatabaseCsvExportReports.sh
@@ -7,6 +7,8 @@
 #       The reason for that is that it exports the whole graph database. This should only be done intentionally
 #       and not within a default "AllReports.sh" run because it is performance intense and could raise security concerns.
 
+# Requires repexecuteQueryFunctions.sh
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
diff --git a/scripts/reports/compilations/JupyterReports.sh b/scripts/reports/compilations/JupyterReports.sh
@@ -6,6 +6,8 @@
 # For PDF generation chromium is required additionally.
 # Therefore these reports will take longer and require more ressources than just plain database queries/procedures.
 
+# Requires reports/*.sh
+
 ## Get this "scripts/reports/compilations" 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.
diff --git a/scripts/resetAndScanChanged.sh b/scripts/resetAndScanChanged.sh
@@ -4,6 +4,8 @@
 
 # Note: "resetAndScan" expects jQAssistant to be installed in the "tools" directory.
 
+# Requires resetAndScan.sh
+
 ## 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.
diff --git a/scripts/setupNeo4j.sh b/scripts/setupNeo4j.sh
@@ -4,6 +4,8 @@
 
 # Note: The environment variable NEO4J_INITIAL_PASSWORD needs to be set.
 
+# Requires download.sh,setupNeo4jInitialPassword.sh
+
 NEO4J_EDITION=${NEO4J_EDITION:-"community"} # Choose "community" or "enterprise"
 NEO4J_VERSION=${NEO4J_VERSION:-"5.9.0"}
 NEO4J_APOC_PLUGIN_VERSION=${NEO4J_APOC_PLUGIN_VERSION:-"5.9.0"} #Awesome Procedures for Neo4j Plugin, Version needs to be compatible to Neo4j
diff --git a/scripts/startNeo4j.sh b/scripts/startNeo4j.sh
@@ -5,6 +5,8 @@
 # Note: Does nothing if the database is already running.
 # Note: It requires Neo4j to be installed in the TOOLS_DIRECTORY.
 
+# Requires waitForNeo4jHttp.sh
+
 NEO4J_EDITION=${NEO4J_EDITION:-"community"} # Choose "community" or "enterprise"
 NEO4J_VERSION=${NEO4J_VERSION:-"5.9.0"}
 TOOLS_DIRECTORY=${TOOLS_DIRECTORY:-"tools"} # Get the tools directory (defaults to "tools")
diff --git a/scripts/waitForNeo4jHttp.sh b/scripts/waitForNeo4jHttp.sh
@@ -3,6 +3,8 @@
 # Waits until the HTTP Transactions API of Neo4j Graph Database is available.
 # It queries the number of nodes and relationships to assert the connection.
 
+# Requires executeQueryFunctions.sh
+
 NEO4J_HTTP_PORT=${NEO4J_HTTP_PORT:-"7474"}
 
 ## Get this "scripts" directory if not already set
@@ -28,7 +30,7 @@ echo "${WAIT_TIMES}" | tr ' ' '\n' | while read -r waitTime; do
     echo "waitForNeo4jHttp: Waiting for ${waitTime} second(s)"
     sleep "${waitTime}"
 
-    # Calls the Neo4j HTTP API using cURL ( https://curl.se )
+    # Queries node and relationship count as a basic validation
     if ! cyper_elements_query_result=$(execute_cypher "${CYPHER_DIR}/Count_nodes_and_relationships.cypher");
     then
         continue; # query failed -> try again
