Disable database export for default analysis

Author: JohT

.github/workflows/code-reports.yml

@@ -112,7 +112,7 @@ jobs:
       env:
         NEO4J_INITIAL_PASSWORD: ${{ secrets.NEO4J_INITIAL_PASSWORD }}
       run: |
-        ./../../scripts/analysis/analyze.sh --report All --profile Neo4jv5
+        ./../../scripts/analysis/analyze.sh
 
     - name: Move reports from the temp to the results directory preserving their surrounding directory
       working-directory: temp
@@ -128,13 +128,15 @@ jobs:
         retention-days: 5
 
     # Upload Database Export
-    - name: Archive exported database
-      uses: actions/upload-artifact@v3
-      with:
-        name: code-report-database-export-${{ matrix.java }}-python-${{ matrix.python }}-mambaforge-${{ matrix.mambaforge }}
-        path: ./temp/**/import
-        if-no-files-found: error
-        retention-days: 5
+    # Only possible after an export with "./../../scripts/analysis/analyze.sh --report DatabaseCsvExport"
+    # Won't be done here because of performance and security concerns
+    #- name: Archive exported database
+    #  uses: actions/upload-artifact@v3
+    #  with:
+    #    name: code-report-database-export-${{ matrix.java }}-python-${{ matrix.python }}-mambaforge-${{ matrix.mambaforge }}
+    #    path: ./temp/**/import
+    #    if-no-files-found: error
+    #    retention-days: 5
 
     # Commit and push the native image agent results
     - name: Display environment variable "github.event_name"

COMMANDS.md

@@ -51,7 +51,7 @@
 
 The [analyze.sh](./scripts/analysis/analyze.sh) command comes with these command line options:
 
-- `--report Csv` only generates CSV reports. This speeds up the report generation and doesn't depend on Python, Jupyter Notebook or any other related dependencies. The default value os `All` to generate all reports. `Jupiter` will only generate Jupyter Notebook reports.
+- `--report Csv` only generates CSV reports. This speeds up the report generation and doesn't depend on Python, Jupyter Notebook or any other related dependencies. The default value os `All` to generate all reports. `Jupiter` will only generate Jupyter Notebook reports. `DatabaseCsvExport` exports the whole graph database as a CSV file (performance intense, check if there are security concerns first).
 
 - `--profile Neo4jv4` uses the older long term support (june 2023) version v4.4.x of Neo4j and suitable compatible versions of plugins and JQAssistant. `Neo4jv5` will explicitly select the newest (june 2023) version 5.x of Neo4j. Without setting
 a profile, the newest versions will be used. Profiles are scripts that can be found in the directory [scripts/profiles](./scripts/profiles/).

scripts/SCRIPTS.md

@@ -22,7 +22,6 @@ Script | Directory | Description
 | [Neo4jv5.sh](./profiles/Neo4jv5.sh) | profiles | Sets all settings variables for an analysis with Neo4j v5.x (newest version as of june 2023). |
 | [CentralityCsv.sh](./reports/CentralityCsv.sh) | reports | Looks for centrality using the Graph Data Science Library of Neo4j and creates CSV reports. |
 | [CommunityCsv.sh](./reports/CommunityCsv.sh) | reports | Detects communities using the Graph Data Science Library of Neo4j and creates CSV reports. |
-| [DatabaseCsvExport.sh](./reports/DatabaseCsvExport.sh) | reports | Exports the whole graph database as a CSV file using the APOC procedure "apoc.export.csv.all" |
 | [ExternalDependenciesCsv.sh](./reports/ExternalDependenciesCsv.sh) | reports | Executes "Package_Usage" Cypher queries to get the "external-dependencies-csv" CSV reports. |
 | [ExternalDependenciesJupyter.sh](./reports/ExternalDependenciesJupyter.sh) | reports | Creates the "overview" report (ipynb, md, pdf) based on the Jupyter Notebook "Overview.ipynb". |
 | [InternalDependenciesCsv.sh](./reports/InternalDependenciesCsv.sh) | reports | Executes "Package_Usage" Cypher queries to get the "internal-dependencies" CSV reports. |
@@ -37,6 +36,7 @@ Script | Directory | Description
 | [WordcloudJupyter.sh](./reports/WordcloudJupyter.sh) | reports | Creates the "overview" report (ipynb, md, pdf) based on the Jupyter Notebook "Overview.ipynb". |
 | [AllReports.sh](./reports/compilations/AllReports.sh) | compilations | Runs all report scripts. |
 | [CsvReports.sh](./reports/compilations/CsvReports.sh) | compilations | Runs all CSV report scripts (no Python and Chromium required). |
+| [DatabaseCsvExportReports.sh](./reports/compilations/DatabaseCsvExportReports.sh) | compilations | Exports the whole graph database as a CSV file using the APOC procedure "apoc.export.csv.all" |
 | [JupyterReports.sh](./reports/compilations/JupyterReports.sh) | compilations | Runs all Jupyter Notebook report scripts. |
 | [resetAndScan.sh](./resetAndScan.sh) |  | Deletes all data in the Neo4j graph database and rescans the downloaded artifacts to create a new graph. |
 | [resetAndScanChanged.sh](./resetAndScanChanged.sh) |  | Executes "resetAndScan.sh" only if "detectChangedArtifacts.sh" returns detected changes. |

scripts/reports/DatabaseCsvExport.sh renamed to scripts/reports/compilations/DatabaseCsvExportReports.sh

@@ -3,27 +3,31 @@
 # Exports the whole graph database as a CSV file using the APOC procedure "apoc.export.csv.all"
 # The exported file can be found in the subdirectory "import" inside the tools/neo4j.. directory.
 
+# Note: This is a special case. It is treated as a compilation even if it is just a single cypher execution. 
+#       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.
+
 # Overrideable Constants (defaults also defined in sub scripts)
 REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
 
-## Get this "scripts/reports" directory if not already set
+## 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.
 # This way non-standard tools like readlink aren't needed.
-REPORTS_SCRIPT_DIR=${REPORTS_SCRIPT_DIR:-$( CDPATH=. cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd -P )}
-echo "ExternalDependenciesCsv: REPORTS_SCRIPT_DIR=${REPORTS_SCRIPT_DIR}"
+REPORT_COMPILATIONS_SCRIPT_DIR=${REPORT_COMPILATIONS_SCRIPT_DIR:-$( CDPATH=. cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd -P )}
+echo "DatabaseCsvExportReports: REPORT_COMPILATIONS_SCRIPT_DIR=${REPORT_COMPILATIONS_SCRIPT_DIR}"
 
 # Get the "scripts" directory by taking the path of this script and going one directory up.
-SCRIPTS_DIR=${SCRIPTS_DIR:-"${REPORTS_SCRIPT_DIR}/.."}
-echo "ExternalDependenciesCsv SCRIPTS_DIR=${SCRIPTS_DIR}"
+SCRIPTS_DIR=${SCRIPTS_DIR:-"${REPORTS_SCRIPT_DIR}/../.."}
+echo "DatabaseCsvExportReports: SCRIPTS_DIR=${SCRIPTS_DIR}"
 
 # Get the "cypher" directory by taking the path of this script and going two directory up and then to "cypher".
 CYPHER_DIR=${CYPHER_DIR:-"${SCRIPTS_DIR}/../cypher"}
-echo "ExportDatabase: CYPHER_DIR=$CYPHER_DIR"
+echo "DatabaseCsvExportReports: CYPHER_DIR=$CYPHER_DIR"
 
 # Define functions to execute a cypher query from within the given file (first and only argument)
 source "${SCRIPTS_DIR}/executeQueryFunctions.sh"
 
 # Execute Database Export Procedure in background
 # The exported file can then be found in the subdirectory "import" inside the tools/neo4j.. directory.
-execute_cypher "${CYPHER_DIR}/Export_the_whole_database_as_CSV.cypher" &
+execute_cypher "${CYPHER_DIR}/Export_the_whole_database_as_CSV.cypher"