[#10] Add support for filtering spec items using OFT tags

The OFT Action has been extended to support a new input parameter
for specifying tag values which are passed on to the run-oft.sh script.

Author: sophokles73

.github/workflows/requirements-tracing.yaml

@@ -23,7 +23,7 @@ jobs:
         with:
           report-filename: ${{ env.REPORT_FILENAME }}
           report-format: "html"
-          file-patterns: "."
+          file-patterns: ${{ github.workspace }}
 
       - name: Upload tracing report
         id: upload-report

Dockerfile

@@ -1,5 +1,7 @@
 # [impl->req~run-oft-trace-command~1]
 FROM eclipse-temurin:22-jre-alpine
+# alpine comes with sh only, by default
+RUN apk add --no-cache bash
 
 ARG OFT_CORE_VERSION=4.1.0
 ARG OFT_ASCIIDOC_PLUGIN_VERSION=0.2.0
@@ -13,6 +15,6 @@ wget -P $LIB_DIR ${base_url}/openfasttrace/releases/download/$OFT_CORE_VERSION/o
 wget -P $LIB_DIR ${base_url}/openfasttrace-asciidoc-plugin/releases/download/$OFT_ASCIIDOC_PLUGIN_VERSION/openfasttrace-asciidoc-plugin-$OFT_ASCIIDOC_PLUGIN_VERSION-with-dependencies.jar
 EOF
 
-COPY run-oft.sh /opt/oft/run-oft.sh 
+COPY run-oft.sh /opt/oft/run-oft.sh
 
 ENTRYPOINT [ "/opt/oft/run-oft.sh" ]

action.yaml

@@ -8,7 +8,7 @@ description: |
 inputs:
   file-patterns:
     description: |
-      A whitespace separated list of (Bash standard) glob patterns which specify the files and directories to include in the OFT trace run.
+      A whitespace separated list of (standard Bash) glob patterns which specify the files and directories to include in the OFT trace run.
       If not specified, the local workspace directory is used.
     default: "."
     required: false
@@ -20,6 +20,10 @@ inputs:
     description: The format of the report that OpenFastTrace should produce.
     default: "plain"
     required: false
+  tags:
+    description: |
+      A comma separated list of tags to use for filtering specification items.
+    required: false
   fail-on-error:
     description: |
       By default, the action will never fail but indicate the result of running the trace command in the "oft-exit-code" output variable.
@@ -35,8 +39,9 @@ outputs:
 runs:
   using: "docker"
   image: "Dockerfile"
-  args:
-    - ${{ inputs.fail-on-error }}
-    - ${{ inputs.report-filename }}
-    - ${{ inputs.report-format }}
-    - ${{ inputs.file-patterns }}
+  env:
+    OFT_FILE_PATTERNS: ${{ inputs.file-patterns }}
+    OFT_REPORT_FORMAT: ${{ inputs.report-format }}
+    OFT_REPORT_FILENAME: ${{ inputs.report-filename }}
+    OFT_TAGS: ${{ inputs.tags }}
+    OFT_FAIL_ON_ERROR: ${{ inputs.fail-on-error }}

doc/spec/system_requirements.md

@@ -33,3 +33,13 @@ Covers:
 - feat~standard-github-action~1
 
 Needs: impl
+
+### Filter specification items based on tags
+`req~filter-specitems-using-tags~1`
+
+The OFT Action supports filtering relevant specification items using OFT Tags.
+
+Covers:
+- feat~standard-github-action~1
+
+Needs: impl

run-oft.sh

@@ -1,20 +1,24 @@
-#!/bin/sh
+#!/bin/bash
 
-# [impl->req~run-oft-trace-command~1]
-fail_on_error=$1
-report_file_name=$2
-report_format=$3
-files=$4
+fail_on_error=${OFT_FAIL_ON_ERROR:-"false"}
+report_file_name=${OFT_REPORT_FILENAME:-"trace-report.txt"}
+report_format=${OFT_REPORT_FORMAT:-"plain"}
+tags=${OFT_TAGS:-""}
+file_patterns=${OFT_FILE_PATTERNS:-"."}
+
+options=(-o "$report_format" -f "$report_file_name")
+# [impl->req~filter-specitems-using-tags~1]
+if [[ -n "$tags" ]]; then
+  options=("${options[@]}" -t "$tags")
+fi
 
 echo "::notice::using OpenFastTrace JARs from: ${LIB_DIR}"
+echo "::notice::running OpenFastTrace for file patterns: $file_patterns"
 
-# Run OpenFastTrace
+# [impl->req~run-oft-trace-command~1]
 # shellcheck disable=SC2086
 # we need to provide the file patterns unquoted in order for the shell to expand any glob patterns like "*.md"
-if (java -cp "${LIB_DIR}/*" \
-  org.itsallcode.openfasttrace.core.cli.CliStarter trace -o "${report_format}" \
-  -f "${report_file_name}" \
-  ${files})
+if (java -cp "${LIB_DIR}/*" org.itsallcode.openfasttrace.core.cli.CliStarter trace "${options[@]}" $file_patterns)
 then
   echo "oft-exit-code=0" >> "${GITHUB_OUTPUT}"
   echo "All specification items are covered." >> "${GITHUB_STEP_SUMMARY}"