Add profile to continue on jQAssistant scan errors

JohT · JohT · commit c2a9ac850057 · 2024-10-08T08:04:42.000+02:00
diff --git a/COMMANDS.md b/COMMANDS.md
@@ -71,7 +71,9 @@ The [analyze.sh](./scripts/analysis/analyze.sh) command comes with these command
 - `--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/).
+a profile, the newest versions will be used. Profiles can be found in the directory [scripts/profiles](./scripts/profiles/).
+
+- `--profile Neo4jv5-continue-on-scan-errors` is based on the default profile (`Neo4jv5`) but uses the jQAssistant configuration template [template-neo4jv5-jqassistant-continue-on-error.yaml](./scripts/configuration/template-neo4jv5-jqassistant-continue-on-error.yaml) to continue on scan error instead of failing fast. This is temporarily useful when there is a known error that needs to be ignored. It is still recommended to use the default profile and fail fast if there is something wrong. Profiles can be found in the directory [scripts/profiles](./scripts/profiles/).
 
 - `--explore` activates the "explore" mode where no reports are generated. Furthermore, Neo4j won't be stopped at the end of the script and will therefore continue running.  This makes it easy to just set everything up but then use the running Neo4j server to explore the data manually.
 
diff --git a/README.md b/README.md
@@ -226,6 +226,14 @@ The [Code Structure Analysis Pipeline](./.github/workflows/java-code-analysis.ym
   TYPESCRIPT_SCAN_HEAP_MEMORY=16384 ./../../scripts/analysis/analyze.sh
   ```
 
+- How can i continue on errors when scanning Typescript projects instead of cancelling the whole analysis?  
+  👉 Use the profile `Neo4jv5-continue-on-scan-errors` (default = `Neo4jv5`):
+
+  ```shell
+  ./../../scripts/analysis/analyze.sh --profile Neo4jv5-continue-on-scan-errors
+  ```
+
+
 ## 🕸 Web References
 
 - [Graph Data Science 101: Understanding Graphs and Graph Data Science](https://techfirst.medium.com/graph-data-science-101-understanding-graphs-and-graph-data-science-c25055a9db01)
diff --git a/scripts/configuration/template-neo4jv5-jqassistant-continue-on-error.yaml b/scripts/configuration/template-neo4jv5-jqassistant-continue-on-error.yaml
@@ -0,0 +1,228 @@
+jqassistant:
+  # Controls whether the execution of jQAssistant shall be skipped
+  #
+  # -Djqassistant.skip: true|false
+  skip: false
+
+  # Defines the local and remote Maven repositories for retrieving additional plugins.
+  repositories:
+    # The path to the local repository.
+    #
+    # -Djqassistant.repositories.local (optional)
+    local: ./../downloads/jqassistant-repository
+
+  # The list of plugins to load and activate.
+  #
+  # Each plugin is identified using its Maven coordinates:
+  #
+  # -Djqassistant.plugins[0].group-id
+  # -Djqassistant.plugins[0].artifact-id
+  # -Djqassistant.plugins[0].version
+  # -Djqassistant.plugins[0].classifier (optional)
+  # -Djqassistant.plugins[0].type (optional)
+  #plugins:
+  #  - group-id:
+  #    artifact-id:
+  #    version:
+  #    classifier:
+  #    type:
+  plugins:
+    - group-id: org.jqassistant.plugin.typescript
+      artifact-id: jqassistant-typescript-plugin
+      version: 1.3.0
+    - group-id: org.jqassistant.plugin
+      artifact-id: jqassistant-npm-plugin
+      version: 2.0.0
+    - group-id: de.kontext-e.jqassistant.plugin
+      artifact-id: jqassistant.plugin.git
+      version: 2.1.0
+
+
+  # The store configuration
+  store:
+    # URI of the database to connect to. Supported URI schemes are 'file' for embedded databases and 'bolt' for connecting to a running Neo4j instance (3.x+), e.g.
+    #
+    # -Djqassistant.store.uri
+    #uri: file://target/jqassistant/store
+    uri: bolt://localhost:${NEO4J_BOLT_PORT:7687}
+
+    # Settings for the embedded Neo4j store
+    embedded:
+      # Enable the HTTP and BOLT connector for the embedded store
+      #
+      # -Djqassistant.store.embedded.connector-enabled: true|false
+      connector-enabled: false
+
+      # The listen address for the HTTP and BOLT connectors
+      #
+      # -Djqassistant.store.embedded.listen-address
+      listen-address: localhost
+
+      # The BOLT connector port
+      #
+      # -Djqassistant.store.embedded.bolt-port
+      bolt-port: 7687
+
+      # The HTTP connector port
+      #
+      # -Djqassistant.store.embedded.http-port: 7474
+      http-port: 7474
+
+    # Settings for connecting to a remote Neo4j store
+    remote:
+      # The user name for authentication.
+      #
+      # -Djqassistant.store.username
+      username: ${NEO4J_USER:neo4j}
+
+      # The password for authentication.
+      #
+      # -Djqassistant.store.password
+      password: ${NEO4J_INITIAL_PASSWORD}
+
+      # Activate encryption level for 'bolt' connections.
+      #
+      # -Djqassistant.store.encryption: true|false
+      encryption: false
+
+      #The trust strategy for 'bolt' connections
+      #
+      # -Djqassistant.store.trust-strategy: trustAllCertificates|trustCustomCaSignedCertificates|trustSystemCaSignedCertificates
+      trust-strategy: trustAllCertificates
+
+      # The file containing the custom CA certificate for trust strategy.
+      #
+      # -Djqassistant.store.trust-certificate
+      trust-certificate:
+
+      # Additional properties to be passed to the remote store as key-value pairs.
+      #
+      # -Djqassistant.store.properties
+      properties:
+
+  # The Scanner configuration
+  scan:
+    # Indicates whether to initially reset the store (i.e. clear all nodes and relationships) before scanning.
+    #
+    # -Djqassistant.scan.reset: true|false
+    reset: true
+
+    # Specifies if a scan shall be continued if an error is encountered.
+    #
+    # -Djqassistant.scan.continue-on-error: true|false
+    continue-on-error: true
+
+    # The items to include for scanning.
+    include:
+      # A list of files to include.
+      #
+      #jqassistant.scan.include.files[0]
+      files:
+      # - src/folder
+
+      # A list of URLs to include.
+      #
+      #jqassistant.scan.include.urls[0]
+      urls:
+      # - maven:repository::https://nexus/repository
+
+    # The properties to configure scanner plugins as key-value pairs. The supported properties are plugin specific.
+    #
+    # -Djqassistant.scan.properties
+    properties:
+      # plugin.property.key: value
+      file.exclude: "*/.DS_Store"
+      json.file.exclude: "*/.reports/jqa/ts-output.json"
+
+  # The analyze configuration
+  analyze:
+    # The rule configuration
+    rule:
+      # The name of the directory containing project rules.
+      #
+      # -Djqassistant.analyze.rule.directory
+      directory: jqassistant/rules
+
+      # The default severity of concepts without an explicit severity.
+      #
+      # -Djqassistant.analyze.rule.default-concept-severity: INFO|MINOR|MAJOR|CRITICAL|BLOCKER
+      default-concept-severity: MINOR
+
+      # The default severity of constraint without an explicit severity.
+      #
+      # -Djqassistant.analyze.rule.default-constraint-severity: INFO|MINOR|MAJOR|CRITICAL|BLOCKER
+      default-constraint-severity: MAJOR
+
+      # The default severity of groups without an explicit severity.
+      #
+      # -Djqassistant.analyze.rule.default-group-severity: INFO|MINOR|MAJOR|CRITICAL|BLOCKER
+      default-group-severity:
+
+    # The report configuration
+    report:
+      # The properties to configure report plugins. The supported properties are plugin specific.
+      #
+      # -Djqassistant.analyze.report.properties
+      properties:
+        # plugin.property.key: value
+
+      # Determines the severity level for reporting a warning.
+      #
+      # -Djqassistant.analyze.report.warn-on-severity: INFO|MINOR|MAJOR|CRITICAL|BLOCKER|NEVER
+      warn-on-severity: MINOR
+
+      # Determines the severity level for reporting a failure.
+      #
+      # -Djqassistant.analyze.report.fail-on-severity: INFO|MINOR|MAJOR|CRITICAL|BLOCKER|NEVER
+      fail-on-severity: MAJOR
+
+      # Determines if jQAssistant shall continue the build if failures have been detected.
+      #
+      # -Djqassistant.analyze.report.continue-on-failure: true|false
+      continue-on-failure: false
+
+      # Create an archive containing all generated reports.
+      #
+      # -Djqassistant.analyze.report.create-archive: true|false
+      create-archive: false
+
+      # Output directory for analysis reports
+      directory: ./runtime/jqassistant/report
+
+    # The concepts to be applied.
+    #
+    # -Djqassistant.analyze.concepts[0]
+    # https://github.com/jQAssistant/jqa-java-plugin/blob/e17fc3032fb0d4258d4f5ca0c64099a6c789c070/src/main/asciidoc/release-notes.adoc#L9
+    concepts:
+     - java-classpath:Resolve
+     - java:PackageDependency
+     - java:ArtifactDependency
+     - java:JavaVersion
+
+    # The constraints to be validated.
+    #
+    # -Djqassistant.analyze.constraints[0]
+    constraints:
+    # - my-constraint
+
+    # The groups to be executed.
+    #
+    # -Djqassistant.analyze.groups[0]
+    groups:
+    # - spring-boot:Default
+
+    # The parameters to be passed to the executed rules.
+    #
+    # -Djqassistant.analyze.rule-parameters."parameterName"
+    rule-parameters:
+    # parameterName: value
+
+    # Execute concepts even if they have already been applied before
+    #
+    # -Djqassistant.analyze.execute-applied-concepts: true|false
+    execute-applied-concepts: false
+
+    # The execution time [seconds] for rules (concepts/constraints) to show a warning. Can be used as a hint for optimization.
+    #
+    # -Djqassistant.analyze.warn-on-rule-execution-time-seconds
+    warn-on-rule-execution-time-seconds: 5
diff --git a/scripts/profiles/Neo4jv5-continue-on-scan-errors.sh b/scripts/profiles/Neo4jv5-continue-on-scan-errors.sh
@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+# Sets all settings variables for an analysis with Neo4j v5.x (newest version as of june 2023).
+# The chosen settings are tested to be compatible and working.
+
+NEO4J_VERSION=${NEO4J_VERSION:-"5.23.0"} # Version 5.9.0 is the current version of june 2023
+NEO4J_HTTP_TRANSACTION_ENDPOINT=${NEO4J_HTTP_TRANSACTION_ENDPOINT:-"db/neo4j/tx/commit"} # Since Neo4j v5 it is "db/<name>/tx/commit"
+
+# Overrideable settings variables for ports (optional, defaults also defined in sub scripts where needed)
+# Override them if you need to run multiple neo4j database servers in parallel.
+NEO4J_HTTP_PORT=${NEO4J_HTTP_PORT:-"7474"} # Neo4j HTTP API port for executing queries
+NEO4J_HTTPS_PORT=${NEO4J_HTTPS_PORT:-"7473"} # Neo4j HTTPS port for encrypted querying
+NEO4J_BOLT_PORT=${NEO4J_BOLT_PORT:-"7687"} # Neo4j's own "Bolt Protocol" port
+
+# Awesome Procedures (APOC) Plugin for Neo4j
+NEO4J_APOC_PLUGIN_VERSION=${NEO4J_APOC_PLUGIN_VERSION:-"5.24.0"} # Version number matches Neo4j version since 5.x
+NEO4J_APOC_PLUGIN_EDITION=${NEO4J_APOC_PLUGIN_EDITION:-"core"} # Since Neo4j v5 the core edition is updated with Neo4j
+NEO4J_APOC_PLUGIN_GITHUB=${NEO4J_APOC_PLUGIN_GITHUB:-"neo4j/apoc"} # Core edition was moved to "neo4j/apoc" for Neo4j v5
+
+NEO4J_GDS_PLUGIN_VERSION=${NEO4J_GDS_PLUGIN_VERSION:-"2.8.0"} # Version 2.4.0 is the newest version of june 2023 and compatible with Neo4j v5
+NEO4J_OPEN_GDS_PLUGIN_VERSION=${NEO4J_OPEN_GDS_PLUGIN_VERSION:-"2.11.0"} # Open package variant of the graph-data-science plugin for Neo4j (https://github.com/JohT/open-graph-data-science-packaging). Since version 2.4. compatible with Neo4j 5.x.
+NEO4J_GDS_PLUGIN_EDITION=${NEO4J_GDS_PLUGIN_EDITION:-"open"} # Graph Data Science Plugin Edition: "open" for OpenGDS, "full" for the full version with Neo4j license
+
+JQASSISTANT_CLI_VERSION=${JQASSISTANT_CLI_VERSION:-"2.3.1"} # Version number of the jQAssistant command line interface. Version 1.12.2 is compatible with Neo4j v4
+JQASSISTANT_CLI_ARTIFACT=${JQASSISTANT_CLI_ARTIFACT:-"template-neo4jv5-jqassistant-continue-on-error"}
+JQASSISTANT_CONFIG_TEMPLATE=${JQASSISTANT_CONFIG_TEMPLATE:-"template-neo4jv5-jqassistant.yaml"} # Name of the template file for the jqassistant configuration
