feat: add workflows similar to amp-embedded-infra-lib, restructure components

.devcontainer/devcontainer.json

@@ -1,17 +1,17 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.231.6/containers/cpp
 {
-    "build": {
-        "context": "..",
-        "dockerfile": "Dockerfile"
-    },
-    "customizations": {
-        "vscode": {
-            "extensions": [
-                "alexkrechik.cucumberautocomplete",
-                "akiramiyakoda.cppincludeguard",
-                "github.vscode-github-actions"
-            ]
-        }
+  "build": {
+    "context": "..",
+    "dockerfile": "Dockerfile"
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "alexkrechik.cucumberautocomplete",
+        "akiramiyakoda.cppincludeguard",
+        "github.vscode-github-actions"
+      ]
     }
+  }
 }

.github/linters/.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "trailingComma": "none"
+}

.github/linters/goodcheck.yml

@@ -0,0 +1,43 @@
+---
+rules:
+  - id: amp.suppressions.sonar
+    pattern: ///\s*NOSONAR/
+    glob: "**/*.[c|h]pp"
+    severity: info
+    message: |
+      Try to minimize the use of static-analysis suppressions
+
+  - id: amp.suppressions.compiler-warning
+    pattern:
+      - /#pragma.*diagnostic ignored.*/
+      - /#pragma warning(\s*disable.*)/
+    glob: "**/*.[c|h]pp"
+    severity: info
+    message: |
+      Try to minimize the use of warning suppressions
+
+  - id: amp.no-pragma-once
+    pattern: /#pragma\s*once/
+    glob: "**/*.hpp"
+    severity: error
+    message: |
+      Do not use #pragma once
+    fail: |
+      #pragma once
+    pass: |
+      #ifndef NAMESPACE_COMPONENT_HPP
+      #define NAMESPACE_COMPONENT_HPP
+
+  - id: amp.no-global-tracer
+    pattern: /services::GlobalTracer().Trace().*/
+    glob: "**/*.[c|h]pp"
+    severity: error
+    message: |
+      Do not use services::GlobalTracer() in production code
+      Write a tracing decorator class instead
+
+exclude:
+  - .build
+  - .install
+
+exclude_binary: true

.github/workflows/ci.yml

@@ -38,9 +38,11 @@ jobs:
         with:
           key: ${{ github.job }}
           max-size: 2G
-      - run: |
-          cmake --preset=Windows
-          cmake --build --preset=Windows-Release
+      - uses: lukka/run-cmake@2ce8982be71b8e9a3c4d5e432135035afd1e76a7 # v10.7
+        with:
+          configurePreset: "Windows"
+          buildPreset: "Windows-Release"
+          configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=ccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache']"
 
   build-linux:
     name: Linux Host Build
@@ -57,6 +59,13 @@ jobs:
           configurePreset: "Host"
           buildPreset: "Host-Release"
           testPreset: "Host-Release"
+          configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=ccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache']"
+      - name: Upload test logs
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4
+        with:
+          name: test-logs
+          path: build/Host/Testing/Temporary/
 
   build-linux-devcontainer:
     name: Linux Host Build in Devcontainer
@@ -73,6 +82,13 @@ jobs:
           configurePreset: "Host"
           buildPreset: "Host-Release"
           testPreset: "Host-Release"
+          configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=ccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache']"
+      - name: Upload test logs
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4
+        with:
+          name: test-logs
+          path: build/Host/Testing/Temporary/
 
   test-linux:
     name: Linux Host Test
@@ -89,11 +105,42 @@ jobs:
         with:
           key: ${{ github.job }}
           max-size: 2G
+      - uses: lukka/run-cmake@af1be47fd7c933593f687731bc6fdbee024d3ff4 # v10.8
+        with:
+          configurePreset: "Host"
+          buildPreset: "Host-Debug"
+          configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=ccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache']"
       - run: |
-          cmake --preset=Host
-          cmake --build --preset=Host-Debug
-          bats --formatter junit test/test.bats | tee test-report.xml
+          bats --formatter junit cucumber_cpp/acceptance_test/test.bats | tee test-report.xml
       - uses: EnricoMi/publish-unit-test-result-action@82082dac68ad6a19d980f8ce817e108b9f496c2a # v2.17.1
         if: always()
         with:
           files: test-report.xml
+
+  host_build_test:
+    name: Host Build & Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          persist-credentials: false
+      - uses: hendrikmuhs/ccache-action@c92f40bee50034e84c763e33b317c77adaa81c92 # v1.2.13
+        with:
+          key: ${{ github.job }}-${{ matrix.os }}
+          max-size: 2G
+          variant: sccache
+      - uses: lukka/run-cmake@2ce8982be71b8e9a3c4d5e432135035afd1e76a7 # v10.7
+        with:
+          configurePreset: "host-single-Debug"
+          buildPreset: "host-single-Debug"
+          testPreset: "host-single-Debug"
+          configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=sccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=sccache']"
+      - name: Upload test logs
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4
+        with:
+          name: test-logs
+          path: build/host-single-Dbebug/Testing/Temporary/

.github/workflows/linting-formatting.yml

@@ -0,0 +1,47 @@
+---
+name: Linting & Formatting
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  merge_group:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  linter:
+    name: Linting
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      security-events: write
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: oxsecurity/megalinter/flavors/c_cpp@bacb5f8674e3730b904ca4d20c8bd477bc51b1a7 # v7.13.0
+        env:
+          APPLY_FIXES: all
+          VALIDATE_ALL_CODEBASE: true
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - run: git diff
+      - uses: github/codeql-action/upload-sarif@4fa2a7953630fd2f3fb380f21be14ede0169dd4f # v3.25.12
+        if: ${{ success() || failure() }}
+        with:
+          sarif_file: megalinter-reports/megalinter-report.sarif
+      - uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4
+        if: ${{ success() || failure() }}
+        with:
+          name: linter
+          path: |
+            megalinter-reports
+      - uses: reviewdog/action-suggester@63b8f8cc21dfa052ac44436e65ed31edcffcb6c1 # v1.17.0
+        with:
+          tool_name: MegaLinter

.github/workflows/security.yml

@@ -0,0 +1,36 @@
+---
+name: Security
+
+on:
+  workflow_dispatch:
+  branch_protection_rule:
+  schedule:
+    - cron: "33 8 * * 6"
+  push:
+    branches: [main]
+
+permissions: read-all
+
+jobs:
+  analysis:
+    name: OSSF Scorecards
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      id-token: write
+      actions: read
+      contents: read
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          persist-credentials: false
+      - name: Analysis
+        uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0
+        with:
+          results_file: scorecards.sarif
+          results_format: sarif
+          repo_token: ${{ secrets.SCORECARD_READ_TOKEN }}
+          publish_results: true
+      - uses: github/codeql-action/upload-sarif@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
+        with:
+          sarif_file: scorecards.sarif

.gitignore

@@ -2,3 +2,4 @@
 .install
 .xwin-cache
 .vs/
+megalinter-reports/

.ls-lint.yml

@@ -0,0 +1,12 @@
+ls:
+  .dir: snake_case
+  .hpp: PascalCase
+  .cpp: PascalCase
+
+ignore:
+  - .devcontainer
+  - .git
+  - .github
+  - .vscode
+  - extern
+  - megalinter-reports

.mega-linter.yml

@@ -0,0 +1,29 @@
+ENABLE:
+  - ACTION
+  - CPP
+  - DOCKERFILE
+  - JSON
+  - MARKDOWN
+  - REPOSITORY
+  - SPELL
+  - XML
+  - YAML
+DISABLE_LINTERS:
+  - CPP_CPPLINT
+  - REPOSITORY_DEVSKIM
+  - REPOSITORY_GITLEAKS
+  - REPOSITORY_KICS
+  - REPOSITORY_SEMGREP
+  - SPELL_CSPELL
+  - JSON_V8R
+DISABLE_ERRORS_LINTERS:
+  - MARKDOWN_MARKDOWN_LINK_CHECK
+  - SPELL_PROSELINT
+  - SPELL_LYCHEE
+CPP_CLANG_FORMAT_FILTER_REGEX_EXCLUDE: (external)
+SPELL_PROSELINT_FILE_EXTENSIONS: [".md", ".adoc"]
+SARIF_REPORTER: true
+PRINT_ALPACA: false
+SHOW_SKIPPED_LINTERS: false
+REPOSITORY_GOODCHECK_RULES_PATH: .github/linters
+JSON_JSONLINT_ARGUMENTS: --mode cjson

.trivyignore

@@ -0,0 +1,3 @@
+# See: https://avd.aquasec.com/misconfig/dockerfile/general/avd-ds-0002/
+# We allow root access in our container that we use for development purposes
+DS002

.vscode/tasks.json

@@ -6,7 +6,7 @@
         {
             "label": "bats",
             "type": "shell",
-            "command": "bats --formatter junit test/test.bats | tee test-report.xml",
+            "command": "bats --formatter junit cucumber_cpp/integration_test/test.bats | tee test-report.xml",
             "problemMatcher": []
         }
     ]

CMakeLists.txt

@@ -31,8 +31,5 @@ include(GNUInstallDirs)
 include(CTest)
 include(GoogleTest)
 
-add_subdirectory(extern)
-add_subdirectory(cucumber-cpp)
-add_subdirectory(cucumber-cpp-runner)
-add_subdirectory(cucumber-cpp-example)
-add_subdirectory(test)
+add_subdirectory(external)
+add_subdirectory(cucumber_cpp)