chore: add requirements and tests

philips-software · Oct 26, 2023 · 927df0c · 927df0c
1 parent aa286a7
commit 927df0c
Show file tree

Hide file tree

Showing 33 changed files with 170 additions and 36 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -34,7 +34,7 @@ jobs:
       - name: Run Tests
         run: |
           set -Eeuo pipefail
-          docker run --rm --mount type=bind,src="$(pwd)/specification/requirements/tests/assets",dst=/ws -w /ws ${{ github.repository }}:test bats --formatter junit testsuite.bats | tee test-report.xml
+          docker run --rm --mount type=bind,src="$(pwd)/tests",dst=/ws -w /ws ${{ github.repository }}:test bats --formatter junit testsuite.bats | tee test-report.xml
       - uses: EnricoMi/publish-unit-test-result-action@ca89ad036b5fcd524c1017287fb01b5139908408 # v2.11.0
         if: always()
         with:

diff --git a/.github/workflows/verify-specification.yml b/.github/workflows/verify-specification.yml
@@ -14,4 +14,4 @@ jobs:
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       - run: |
           pip install doorstop==3.0b4
-          doorstop >> "$GITHUB_STEP_SUMMARY"
+          doorstop -e 2>> "$GITHUB_STEP_SUMMARY"
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -10,7 +10,7 @@
       "command": "bats",
       "args": ["testsuite.bats"],
       "options": {
-        "cwd": "${workspaceFolder}/test"
+        "cwd": "${workspaceFolder}/tests"
       },
       "problemMatcher": {
         "owner": "bats",

diff --git a/specification/requirements/HEAD-1.0.md b/specification/requirements/HEAD-1.0.md
@@ -0,0 +1,21 @@
+---
+active: true
+derived: false
+level: 1.0
+links: []
+normative: false
+ref: ''
+reviewed: XYLWU-Hs44a06GH7ROEbzshG7qwQoerFvs4kHZ5ZXxw=
+---
+
+# Introduction
+
+This document describes the requirements for amp-devcontainer.
+
+## Abstract
+
+amp-devcontainer is a [devcontainer](https://containers.dev/) tailored towards modern C++ development.
+
+## Definitions of key words
+
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119).
diff --git a/specification/requirements/HEAD-2.0.md b/specification/requirements/HEAD-2.0.md
@@ -0,0 +1,21 @@
+---
+active: true
+derived: false
+level: 2.0
+links: []
+normative: false
+ref: ''
+reviewed: NGwtZc9fjLTn_jPUJIaBlnRaPoeXCrhpDtoTutuvI_o=
+---
+
+# Requirements
+
+This document describes the requirements for amp-devcontainer.
+
+## Abstract
+
+amp-devcontainer is a [devcontainer](https://containers.dev/) tailored towards modern C++ development.
+
+## Definitions of key words
+
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119).
diff --git a/specification/requirements/HEAD-2.1.md b/specification/requirements/HEAD-2.1.md
@@ -0,0 +1,13 @@
+---
+active: true
+derived: false
+level: 2.1.0
+links: []
+normative: false
+ref: ''
+reviewed: 6nNXJvAjfy6ZFiOHZUk6pAYIH6s354g9yKW7Nlg4sBQ=
+---
+
+# Compilation
+
+This chapter list the requirements that pertain to compilation.
diff --git a/specification/requirements/REQ-0001.md b/specification/requirements/REQ-0001.md
@@ -1,16 +1,17 @@
 ---
 active: true
 derived: false
-level: 1.0
+level: 2.1.1
 links: []
 normative: true
 ref: ''
-reviewed: YlXqzBrdPVyJ1kOTSXb5BVd0U3qRt39jT_lcpotaxh8=
+reviewed: BahQmI-3t190oidQmtYsgRnqsF5ZInkZITtpW1PvQgY=
 ---
 
-**amp-devcontainer __shall__ be able to compile source-code into a working executable**
+# Host compilation
+
+**amp-devcontainer *SHALL* be able to compile source-code into a working executable**
 
 Compiling source-code into working executables, able to run inside the container, can be necessary in several scenarios e.g.
-- When targeting the container host system and architecture
 - When running tests inside the container
-- When building plug-ins, extensions, code generators, or other additional tools
+- When building plug-ins, extensions, code generators, or other additional tools that need to run inside the container
diff --git a/specification/tests/HEAD-1.0.md b/specification/tests/HEAD-1.0.md
@@ -0,0 +1,38 @@
+---
+active: true
+derived: false
+level: 1.0
+links: []
+normative: false
+ref: ''
+reviewed: BQb72tLqNOlSKhoixy2-c7fRw2CcinT4qeWWv7gOSms=
+---
+
+# Purpose
+
+This document describes the test cases to be executed as part of the verification of amp-devcontainer.
+
+``` {.sh file=tests/testsuite.bats}
+#!/usr/bin/env bats
+
+setup() {
+  #!/usr/bin/env bats
+  <<setup>>
+}
+
+teardown() {
+  #!/usr/bin/env bats
+  <<teardown>>
+}
+
+<<testcase>>
+```
+
+``` {.sh #setup}
+load '/usr/local/bats-support/load'
+load '/usr/local/bats-assert/load'
+```
+
+``` {.sh #teardown}
+rm -rf build
+```
diff --git a/specification/tests/HEAD-2.0.md b/specification/tests/HEAD-2.0.md
@@ -0,0 +1,13 @@
+---
+active: true
+derived: false
+level: 2.0
+links: []
+normative: false
+ref: ''
+reviewed: rLndHKdsx6QMzsyN_INI_Sil5SClUFemu3pBDzOri48=
+---
+
+# Test cases
+
+This chapter contains a description and implementation of automated test cases used to verify the requirements of amp-devcontainer.
diff --git a/specification/tests/TEST-0001.md b/specification/tests/TEST-0001.md
@@ -1,16 +1,23 @@
 ---
 active: true
 derived: false
-level: 1.0
+level: 2.1
 links:
-- REQ-0001: YlXqzBrdPVyJ1kOTSXb5BVd0U3qRt39jT_lcpotaxh8=
+- REQ-0001: BahQmI-3t190oidQmtYsgRnqsF5ZInkZITtpW1PvQgY=
 normative: true
 ref: ''
-reviewed: 7TzxCCfQzn1Pc7-N6_G-zn3G43Iw6fccUg8flhUq42o=
+references:
+- keyword: TEST-0001
+  path: tests/testsuite.bats
+  type: file
+reviewed: -ARwwSIY4W0KIWljxJ_o4qFstQkH79Jo_B_X0Ov_rTM=
 ---
 
+# Test host compilation
+
 ``` {.sh #testcase}
-"valid code input should result in working executable using host compiler" {
+# bats test_tags=TC:TEST-0001
+@test "valid code input should result in working executable using host compiler" {
   run cmake --preset gcc
   assert_success
 

diff --git a/specification/tests/TEST-0002.md b/specification/tests/TEST-0002.md
@@ -0,0 +1,9 @@
+---
+active: true
+derived: false
+level: 2.2
+links: []
+normative: true
+ref: ''
+reviewed: null
+---
diff --git a/specification/tests/assets/TESTSUITE.md b/specification/tests/assets/TESTSUITE.md
diff --git a/specification/tests/assets/CMakeLists.txt → tests/CMakeLists.txt b/specification/tests/assets/CMakeLists.txt → tests/CMakeLists.txt
diff --git a/specification/tests/assets/CMakePresets.json → tests/CMakePresets.json b/specification/tests/assets/CMakePresets.json → tests/CMakePresets.json
diff --git a/...tion/tests/assets/clang-cl/CMakeLists.txt → tests/clang-cl/CMakeLists.txt b/...tion/tests/assets/clang-cl/CMakeLists.txt → tests/clang-cl/CMakeLists.txt
diff --git a/specification/tests/assets/clang-cl/main.cpp → tests/clang-cl/main.cpp b/specification/tests/assets/clang-cl/main.cpp → tests/clang-cl/main.cpp
diff --git a/...ion/tests/assets/clang-cl/toolchain.cmake → tests/clang-cl/toolchain.cmake b/...ion/tests/assets/clang-cl/toolchain.cmake → tests/clang-cl/toolchain.cmake
diff --git a/...n/tests/assets/clang-tools/CMakeLists.txt → tests/clang-tools/CMakeLists.txt b/...n/tests/assets/clang-tools/CMakeLists.txt → tests/clang-tools/CMakeLists.txt
diff --git a/...ication/tests/assets/clang-tools/main.cpp → tests/clang-tools/main.cpp b/...ication/tests/assets/clang-tools/main.cpp → tests/clang-tools/main.cpp
diff --git a/.../tests/assets/clang-tools/unformatted.cpp → tests/clang-tools/unformatted.cpp b/.../tests/assets/clang-tools/unformatted.cpp → tests/clang-tools/unformatted.cpp
diff --git a/...tion/tests/assets/coverage/CMakeLists.txt → tests/coverage/CMakeLists.txt b/...tion/tests/assets/coverage/CMakeLists.txt → tests/coverage/CMakeLists.txt
diff --git a/specification/tests/assets/coverage/test.cpp → tests/coverage/test.cpp b/specification/tests/assets/coverage/test.cpp → tests/coverage/test.cpp
diff --git a/...ation/tests/assets/fuzzing/CMakeLists.txt → tests/fuzzing/CMakeLists.txt b/...ation/tests/assets/fuzzing/CMakeLists.txt → tests/fuzzing/CMakeLists.txt
diff --git a/specification/tests/assets/fuzzing/main.cpp → tests/fuzzing/main.cpp b/specification/tests/assets/fuzzing/main.cpp → tests/fuzzing/main.cpp
diff --git a/...s/assets/gcc-arm-none-eabi/CMakeLists.txt → tests/gcc-arm-none-eabi/CMakeLists.txt b/...s/assets/gcc-arm-none-eabi/CMakeLists.txt → tests/gcc-arm-none-eabi/CMakeLists.txt
diff --git a/...n/tests/assets/gcc-arm-none-eabi/main.cpp → tests/gcc-arm-none-eabi/main.cpp b/...n/tests/assets/gcc-arm-none-eabi/main.cpp → tests/gcc-arm-none-eabi/main.cpp
diff --git a/.../assets/gcc-arm-none-eabi/toolchain.cmake → tests/gcc-arm-none-eabi/toolchain.cmake b/.../assets/gcc-arm-none-eabi/toolchain.cmake → tests/gcc-arm-none-eabi/toolchain.cmake
diff --git a/...ification/tests/assets/gcc/CMakeLists.txt → tests/gcc/CMakeLists.txt b/...ification/tests/assets/gcc/CMakeLists.txt → tests/gcc/CMakeLists.txt
diff --git a/specification/tests/assets/gcc/main-fail.cpp → tests/gcc/main-fail.cpp b/specification/tests/assets/gcc/main-fail.cpp → tests/gcc/main-fail.cpp
diff --git a/specification/tests/assets/gcc/main.cpp → tests/gcc/main.cpp b/specification/tests/assets/gcc/main.cpp → tests/gcc/main.cpp
diff --git a/...tion/tests/assets/mutation/CMakeLists.txt → tests/mutation/CMakeLists.txt b/...tion/tests/assets/mutation/CMakeLists.txt → tests/mutation/CMakeLists.txt
diff --git a/specification/tests/assets/mutation/test.cpp → tests/mutation/test.cpp b/specification/tests/assets/mutation/test.cpp → tests/mutation/test.cpp
diff --git a/tests/testsuite.bats b/tests/testsuite.bats
@@ -0,0 +1,35 @@
+#!/usr/bin/env bats
+# ~/~ begin <<specification/tests/HEAD-1.0.md#tests/testsuite.bats>>[init]
+
+setup() {
+  #!/usr/bin/env bats
+  #!/usr/bin/env bats
+  # ~/~ begin <<specification/tests/HEAD-1.0.md#setup>>[init]
+  load '/usr/local/bats-support/load'
+  load '/usr/local/bats-assert/load'
+  # ~/~ end
+}
+
+teardown() {
+  #!/usr/bin/env bats
+  #!/usr/bin/env bats
+  # ~/~ begin <<specification/tests/HEAD-1.0.md#teardown>>[init]
+  rm -rf build
+  # ~/~ end
+}
+
+# ~/~ begin <<specification/tests/TEST-0001.md#testcase>>[init]
+# bats test_tags=TC:TEST-0001
+@test "valid code input should result in working executable using host compiler" {
+  run cmake --preset gcc
+  assert_success
+
+  run cmake --build --preset gcc
+  assert_success
+
+  run build/gcc/gcc/test-gcc
+  assert_success
+  assert_output "Hello World!"
+}
+# ~/~ end
+# ~/~ end