#992: added design doc for script options (#477)

fixes exasol/script-languages-release#992 --------- Co-authored-by: Torsten Kilias <[email protected]>
exasol · Jan 20, 2025 · 5fe0fbe · 5fe0fbe
1 parent 4fdd91f
commit 5fe0fbe
Show file tree

Hide file tree

Showing 10 changed files with 569 additions and 9 deletions.
diff --git a/.github/workflows/oft.yaml b/.github/workflows/oft.yaml
@@ -0,0 +1,24 @@
+name: OFT Report
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run HTML Report
+        run: |
+          bash .github/workflows/scripts/run_oft.sh ./exaudfclient base -o html -f ./oft_report.html -t V2,_ || echo failed
+      - name: Run Plaintext Report
+        run: |
+          bash .github/workflows/scripts/run_oft.sh ./exaudfclient base -t V2,_
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: "oft_report.html"
+          path: oft_report.html
diff --git a/.github/workflows/scripts/run_oft.sh b/.github/workflows/scripts/run_oft.sh
@@ -0,0 +1,27 @@
+#!/bin/bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+oft_version="4.1.0"
+
+base_dir="$1"
+shift 1
+src_dir="$1"
+shift 1
+additional_options=$@
+readonly base_dir
+readonly oft_jar="$HOME/.m2/repository/org/itsallcode/openfasttrace/openfasttrace/$oft_version/openfasttrace-$oft_version.jar"
+
+if [ ! -f "$oft_jar" ]; then
+    echo "Downloading OpenFastTrace $oft_version"
+    mvn --batch-mode org.apache.maven.plugins:maven-dependency-plugin:3.3.0:get -Dartifact=org.itsallcode.openfasttrace:openfasttrace:$oft_version
+fi
+
+# Trace all
+java -jar "$oft_jar" trace \
+    $additional_options \
+    -a feat,req,dsn \
+    "$base_dir/docs" \
+    "$base_dir/$src_dir"
diff --git a/exaudfclient/docs/diagrams/CTPGParserHandler.drawio.png b/exaudfclient/docs/diagrams/CTPGParserHandler.drawio.png
diff --git a/exaudfclient/docs/diagrams/LegacyParserHandler.drawio.png b/exaudfclient/docs/diagrams/LegacyParserHandler.drawio.png
diff --git a/exaudfclient/docs/diagrams/OveralScriptOptionalsBuildingBlocks.drawio.png b/exaudfclient/docs/diagrams/OveralScriptOptionalsBuildingBlocks.drawio.png
diff --git a/exaudfclient/docs/diagrams/ScriptOptionsExtractorInterface.drawio.png b/exaudfclient/docs/diagrams/ScriptOptionsExtractorInterface.drawio.png
diff --git a/exaudfclient/docs/diagrams/ScriptOptionsParserHandlerSequence.drawio.png b/exaudfclient/docs/diagrams/ScriptOptionsParserHandlerSequence.drawio.png
diff --git a/exaudfclient/docs/diagrams/V2ImportScriptFlow.drawio.png b/exaudfclient/docs/diagrams/V2ImportScriptFlow.drawio.png