Add run_tests_in_Docker script

.vscode/tasks.json

@@ -98,6 +98,19 @@
                 "command": "${workspaceFolder}/projectFolder/scripts/windows/run_tests.ps1"
             }
         },
+        {
+            "label": "run_tests_in_Docker",
+            "type": "shell",
+            "presentation": {
+                "focus": true,
+                "showReuseMessage": false
+            },
+            "group": {
+                "kind": "build"
+            },
+
+            "command": "${workspaceFolder}/projectFolder/scripts/run_tests_in_Docker.sh"
+        },
         // Other tasks
         {
             "label": "format_code",

Dockerfile

@@ -1,6 +1,3 @@
-# Development / Testing image for C++ CMake template project
-
-# base image used as the starting point for this image
 FROM debian:12-slim
 
 # ENV DEBIAN_FRONTEND=noninteractive
@@ -36,10 +33,7 @@ COPY projectFolder /projectFolder
 # Setting the working directory inside the project folder
 WORKDIR /
 
-RUN projectFolder/scripts/build_cmake_debug.sh
-RUN projectFolder/scripts/build_debug.sh
+RUN projectFolder/scripts/create_release.sh withTests
 
 # The command that is run by default when the container starts
-CMD ["./projectFolder/scripts/run_tests.sh"]
-# Run this to launch the project binary instead
-# CMD ["./projectFolder/build/Debug/bin/cpp-cmake-template"]
+CMD ["./projectFolder/scripts/run_tests.sh", "Release"]

README.md

@@ -5,10 +5,11 @@
 ## Template for a multi-platform C++ CMake project
 
 ### Main features:
+- CMake files
 - CTest unit tests framework
-- Github Actions performing build and running the tests
+- Github Actions that build and run the tests
 - Scripts and VSCode files for ease of use
-- Dockerfile for building and running the tests
+- Dockerfile for building and running the tests in a container
 - Support for compiler cache tools: ccache and sccache
 - Formatting via clang-format (that runs automatically in a git pre-commit hook)
 
@@ -29,7 +30,7 @@ Execute VSCode task `build_cmake_debug` or run this script:
     ./projectFolder/scripts/build_cmake_debug.sh
 
 This needs to run the first time and any time you make  
-changes to a CMake file or add new source files.
+changes to a CMake file or add new source or test files.
 
 ### How to build the project:
 Execute VSCode task `build_debug` or run this script:
@@ -53,10 +54,10 @@ Execute VSCode task `run_tests` or run this script:
 
     ./projectFolder/scripts/run_tests.sh
 
-If you want to run the tests in a fresh Docker container, run these commands:
+If you want to build and run the tests in a fresh Docker container  
+execute VSCode task `run_tests_in_Docker` or run this script:
 
-    docker compose down --volumes --rmi all
-    docker compose up
+    ./projectFolder/scripts/run_tests_in_Docker.sh
 
 ### How to add new files to the project:
 Add any new source file to a `projectFolder/src/dir` directory.  

docker-compose.yml

@@ -1,8 +1,6 @@
-version: "3.7"
-
 services:
   dev-container:
-    
+
     build:
       context: .
       dockerfile: Dockerfile

projectFolder/scripts/run_tests_in_Docker.sh

@@ -0,0 +1,6 @@
+#!/bin/bash -xe
+
+echo "Running tests in a docker container"
+
+docker compose down --volumes --rmi all
+docker compose up