test: add bats tests to test explorer

Author: rjaegers

.devcontainer/cpp/devcontainer.json

@@ -30,18 +30,17 @@
       },
       "extensions": [
         "[email protected]",
-        "github.copilot@1.208.0",
-        "github.vscode-github-actions@0.26.3",
-        "github.vscode-pull-request-github@0.90.0",
+        "github.copilot@1.277.0",
+        "github.vscode-github-actions@0.27.1",
+        "github.vscode-pull-request-github@0.106.0",
         "[email protected]",
-        "[email protected]",
         "[email protected]",
         "[email protected]",
-        "[email protected].7",
-        "ms-vscode.cmake-tools@1.18.42",
-        "ms-vscode.cpptools@1.20.5",
-        "sonarsource.sonarlint-vscode@4.7.0",
-        "usernamehw.errorlens@3.20.0"
+        "[email protected].13",
+        "ms-vscode.cmake-tools@1.20.53",
+        "ms-vscode.cpptools@1.23.6",
+        "sonarsource.sonarlint-vscode@4.17.0",
+        "usernamehw.errorlens@3.24.0"
       ]
     }
   }

.vscode/tasks.json

@@ -0,0 +1,10 @@
+cmake_minimum_required(VERSION 3.30)
+
+include(CPM)
+
+project(devcontainer-test "NONE")
+
+CPMAddPackage("gh:neonsoftware/cmake-bats#05e53f68976fcee935a40643b30f31e250bc5a9c")
+
+enable_testing()
+bats_discover_tests("${CMAKE_CURRENT_SOURCE_DIR}/test/$ENV{CONTAINER_FLAVOR}/integration-tests.bats")

CMakeLists.txt

@@ -0,0 +1,25 @@
+{
+  "version": 8,
+  "configurePresets": [
+    {
+      "name": "default",
+      "binaryDir": "${sourceDir}/build/${presetName}",
+      "generator": "Ninja"
+    }
+  ],
+  "buildPresets": [
+    {
+      "name": "default",
+      "configurePreset": "default"
+    }
+  ],
+  "testPresets": [
+    {
+      "output": {
+        "quiet": true
+      },
+      "name": "default",
+      "configurePreset": "default"
+    }
+  ]
+}

CMakePresets.json

@@ -120,7 +120,7 @@ The resulting containers can be used in a `.devcontainer.json` file or in a `.de
 ## Community
 
 This project uses a [code of conduct](.github/CODE_OF_CONDUCT.md) to define expected conduct in our community. Instances of
-abusive, harassing, or otherwise unacceptable behavior may be reported to the repository administrators by using the [Report content](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam) functionality of GitHub.
+abusive, harassing, or otherwise unacceptable behavior may be reported to the repository administrators by using the [report content](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam) functionality of GitHub.
 
 ## Changelog
 
@@ -132,11 +132,11 @@ This project uses [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.htm
 
 ### Build & Test
 
-The containers can be built and tested locally by importing this repository in VS Code with the [Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) plug-in installed. As a prerequisite Docker needs to be installed on the host system. Alternatively a GitHub Codespace can be started.
+The containers can be built and tested locally by importing this repository in VS Code with the [Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) plug-in installed. As a prerequisite an OCI compatible container engine needs to be installed on the host system. Alternatively a GitHub Codespace can be started.
 
 #### Running the Integration Tests
 
-A test task is available to run the included `bats` tests. Choose `Tasks: Run Test Task` from the command pallette (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>).
+Run the included `bats` integration tests from the test explorer. Alternatively run all tests with <kbd>Ctrl</kbd> + <kbd>;</kbd> <kbd>A</kbd>.
 
 #### Running the Acceptance Tests
 

README.md

@@ -6,30 +6,30 @@ setup_file() {
   # Installing the Windows SDK/CRT takes a long time.
   # When still valid, use the installation from cache.
 
-  xwin --accept-license --cache-dir .xwin-hash list
-  HASH_LIST_MANIFEST=$(sha256sum .xwin-hash/dl/manifest*.json | awk '{ print $1 }')
+  xwin --accept-license --cache-dir ${BATS_TEST_DIRNAME}/.xwin-hash list
+  HASH_LIST_MANIFEST=$(sha256sum ${BATS_TEST_DIRNAME}/.xwin-hash/dl/manifest*.json | awk '{ print $1 }')
   HASH_CACHED_MANIFEST=
 
-  if [[ -d .xwin-cache/dl ]]; then
-    HASH_CACHED_MANIFEST=$(sha256sum .xwin-cache/dl/manifest*.json | awk '{ print $1 }')
+  if [[ -d ${BATS_TEST_DIRNAME}/.xwin-cache/dl ]]; then
+    HASH_CACHED_MANIFEST=$(sha256sum ${BATS_TEST_DIRNAME}/.xwin-cache/dl/manifest*.json | awk '{ print $1 }')
   fi
 
   if [[ $HASH_LIST_MANIFEST != $HASH_CACHED_MANIFEST ]]; then
-    xwin --accept-license splat --preserve-ms-arch-notation
+    xwin --accept-license --cache-dir ${BATS_TEST_DIRNAME}/.xwin-cache splat --preserve-ms-arch-notation
   fi
 
-  cp -r .xwin-cache/splat/ /winsdk
+  ln -sf ${BATS_TEST_DIRNAME}/.xwin-cache/splat/ /winsdk
 }
 
 teardown_file() {
-  rm -rf .xwin-hash/ /winsdk
+  rm -rf ${BATS_TEST_DIRNAME}/.xwin-hash/ /winsdk
 }
 
 setup() {
   load '/usr/local/bats-support/load'
   load '/usr/local/bats-assert/load'
 
-  pushd workspace
+  pushd ${BATS_TEST_DIRNAME}/workspace
 }
 
 teardown() {

test/cpp/integration-tests.bats

@@ -13,9 +13,11 @@ if (ENABLE_COVERAGE_TEST)
 
     add_executable(test-coverage EXCLUDE_FROM_ALL test.cpp)
     target_compile_options(test-coverage PRIVATE
-        -g -O0 --coverage -fprofile-arcs -ftest-coverage -fno-inline
+        -g -O0 --coverage -fcondition-coverage -fno-inline
     )
-    target_link_libraries(test-coverage PRIVATE gmock_main gcov)
+    target_link_options(test-coverage PRIVATE --coverage)
+    target_link_libraries(test-coverage PRIVATE gmock_main)
+
     add_test(NAME test-coverage COMMAND test-coverage)
 endif()