feat(karate): #14: integrate and add e2e tests in karate

.devcontainer/Dockerfile

@@ -1,8 +1,7 @@
-FROM mcr.microsoft.com/devcontainers/base:ubuntu-22.04 AS base
+FROM mcr.microsoft.com/devcontainers/base:ubuntu-22.04
 
-RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
-    && apt-get -y install --no-install-recommends \
-    build-essential clang lld make gdb cmake ninja-build \
+RUN apt-get update && apt-get -y install --no-install-recommends \
+    build-essential clang lld gdb make cmake ninja-build \
     crossbuild-essential-arm64 \
     git curl wget unzip sudo \
     pip \
@@ -13,4 +12,6 @@ RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
 
 RUN pip install conan alembic psycopg2-binary sqlalchemy-utils
 
-COPY to-dos-conan-profile.conf /root/.conan2/profiles/default
+# If this profile is not copied, the profile must be specified via an argument 
+# when calling `conan`. 
+COPY ./to-dos-conan-profile.conf /root/.conan2/profiles/default

.devcontainer/devcontainer.json

@@ -6,13 +6,35 @@
 		"dockerfile": "Dockerfile"
 	},
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
+	"forwardPorts": [
+		4501,
+		7501,
+		9501
+	],
+	// More information about 'portsAttributes' here: https://containers.dev/implementors/json_reference/#port-attributes
+	"portsAttributes": {
+		"4501": {
+			"label": "VSCode Dev Container API Running Port",
+			"requireLocalPort": true
+		},
+		"7501": {
+			"label": "VSCode Dev Container DB Running Port",
+			"requireLocalPort": true
+		},
+		"9501": {
+			"label": "VSCode Dev Container PgAdmin Running Port",
+			"requireLocalPort": true
+		}
+	},
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "conan remote add local-recipes ./deps --type=local-recipes-index", // Add a local recipes store for odb libraries
+	"postCreateCommand": "conan remote add local-recipes ./deps --type=local-recipes-index --force", // Add a local recipes store for odb libraries. Need force flag for redefine while second time container is up
 	// Configure tool-specific properties.
 	// "customizations": {},
 	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
 	"remoteUser": "root",
+	"remoteEnv": {
+		"LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}"
+	},
 	"runArgs": [
 		// This is necessary to avoid having to manually export environment variables from 
 		// the .env file in every terminal session.
@@ -24,10 +46,10 @@
 	"mounts": [
 		// This mounts increase future building on devcontainer in case any reseting of container volumes
 		// Mount caching of build folder
-        "source=dev-build-cache,target=${containerWorkspaceFolder}/build,type=volume",
+		"source=dev-build-cache,target=${containerWorkspaceFolder}/build,type=volume",
 		// Mount caching of conan dependencies builds
-        "source=dev-conan-cache,target=~/.conan2,type=volume"
-    ],
+		"source=dev-conan-cache,target=/root/.conan2,type=volume"
+	],
 	"customizations": {
 		"vscode": {
 			"extensions": [

.dockerignore

@@ -0,0 +1,19 @@
+.github/
+.vscode/
+build/
+ci/
+scripts/
+e2e/
+docs/
+.clang-format
+.clang-tidy
+.env
+.env.example
+.gitattributes
+.gitignore
+CMakeUserPresets.json
+docker-compose.yml
+Dockerfile
+LICENSE
+pgAdmin.json
+README.md

.github/workflows/reusable-docker-build-and-push.yml → .github/workflows/.reusable-docker-build-and-push.yml

@@ -7,17 +7,18 @@ name: Publish Docker image
 # if you build => deploy => run e2e against prod it will build the image 3 times!
 on:
   # to allow to wait for a docker image to be published to proceed in another workflow
-  # workflow_call:
-  # PR-based activation has been added, as there are no workflows that trigger this. 
-  # After adding a workflow with tests, you must revert the change and leave only the `workflow_call`.
-  pull_request:
-    types: [opened, synchronize]
+  workflow_call:
+  # This event has been added for debugging purposes; there is currently no workflow 
+  # that triggers when changes are made to the master branch.
+  push:
+    branches:
+      - master
 
 jobs:
   build-amd64:
     runs-on: ubuntu-24.04
     steps:
-      - name: Check out the repo
+      - name: Checkout the repo
         uses: actions/checkout@v4
 
       # this is needed to address this issue according to the comment https://github.com/devcontainers/ci/issues/271#issuecomment-2301764487
@@ -26,10 +27,14 @@ jobs:
         run: |
           echo "REGISTRY_IMAGE=ghcr.io/${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
 
+      # we need to remove the / characters from the branch name, 
+      # as they will cause an error when saving the cache
       - name: Prepare
         run: |
           platform=linux/amd64
           echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV
+          BRANCH_NAME="${GITHUB_REF_NAME//[^a-zA-Z0-9._-]/-}"
+          echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_ENV
 
       - name: Docker meta
         id: meta
@@ -59,6 +64,15 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           tags: ${{ env.REGISTRY_IMAGE }}
           outputs: type=image,push-by-digest=true,name-canonical=true,push=true
+          # The `cache-from` and `cache-to` instructions allow you to load and unload the image cache on ghcr.io, 
+          # respectively. The `mode=max` option allows each instruction in the Dockerfile to be cached separately, 
+          # regardless of the build stage (in the case of a multi-stage build), which speeds up image builds 
+          # significantly if there have been no changes to the instruction.
+          # More info: 
+          #  - https://github.com/docker/build-push-action/
+          #  - https://docs.docker.com/build/cache/backends/#cache-mode
+          cache-from: type=registry,ref=${{ env.REGISTRY_IMAGE }}:cache-amd64-${{ env.BRANCH_NAME }}
+          cache-to: type=registry,ref=${{ env.REGISTRY_IMAGE }}:cache-amd64-${{ env.BRANCH_NAME }},mode=max
 
       - name: Export digest
         run: |
@@ -86,10 +100,14 @@ jobs:
         run: |
           echo "REGISTRY_IMAGE=ghcr.io/${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
 
+      # we need to remove the / characters from the branch name, 
+      # as they will cause an error when saving the cache
       - name: Prepare
         run: |
           platform=linux/arm64
           echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV
+          BRANCH_NAME="${GITHUB_REF_NAME//[^a-zA-Z0-9._-]/-}"
+          echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_ENV
 
       - name: Docker meta
         id: meta
@@ -119,6 +137,8 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           tags: ${{ env.REGISTRY_IMAGE }}
           outputs: type=image,push-by-digest=true,name-canonical=true,push=true
+          cache-from: type=registry,ref=${{ env.REGISTRY_IMAGE }}:cache-arm64-${{ env.BRANCH_NAME }}
+          cache-to: type=registry,ref=${{ env.REGISTRY_IMAGE }}:cache-arm64-${{ env.BRANCH_NAME }},mode=max
 
       - name: Export digest
         run: |
@@ -165,9 +185,10 @@ jobs:
       - name: Check out the repo
         uses: actions/checkout@v4
 
-      - name: Add SEMVER_VERSION Env Var with Value from __version File
-        run: |
-          echo "SEMVER_VERSION=$(cat __version)" >>${GITHUB_ENV}
+      # TODO: This needs to be reverted once the semantic versioning workflow is added
+      # - name: Add SEMVER_VERSION Env Var with Value from __version File
+      #   run: |
+      #     echo "SEMVER_VERSION=$(cat __version)" >>${GITHUB_ENV}
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
@@ -180,7 +201,8 @@ jobs:
             # full length sha
             type=sha,format=long
             # SemVer human readable version
-            type=raw,value=${{ env.SEMVER_VERSION }}
+            # TODO: This needs to be reverted once the semantic versioning workflow is added
+            # type=raw,value=${{ env.SEMVER_VERSION }}
             # set latest tag for default branch
             # https://github.com/docker/metadata-action/issues/171 explains how to tag latest only on default branch
             type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}

.github/workflows/e2e-tests-on-pull-request.yml

@@ -0,0 +1,103 @@
+name: E2E Tests in PR
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  # this is needed to wait for the new docker image to be build and published to the registry
+  # so that we can use the image to run the service of the needed commit related version as part of local-env
+  # the idea is taken from here https://stackoverflow.com/a/71489231
+  docker-build-and-push:
+    uses: ./.github/workflows/.reusable-docker-build-and-push.yml
+
+  e2e-test-against-local-env:
+    runs-on: ubuntu-24.04
+    needs: [docker-build-and-push]
+    steps:
+      - name: Checkout local-env
+        uses: actions/checkout@v4
+        with:
+          repository: TourmalineCore/to-dos-local-env
+
+      # we need to make sure that the values-to-dos-api-cpp.yaml.gotmpl file hasn't been modified 
+      # in the `to-dos-local-env` repository, to ensure that the test runs as expected.
+      - name: Verify values file checksum
+        run: |
+          # the awk command is required to extract the target hash from the output of the sha256sum command
+          VALUES_HASH=$(sha256sum deploy/values-to-dos-api-cpp.yaml.gotmpl | awk '{ print $1 }')
+          if [ "$VALUES_HASH" != ${{ vars.TO_DOS_API_CPP_LOCAL_ENV_HELMFILE_HASH }} ]; then
+            echo "ERROR: checksum mismatch"
+            echo "Expected: 88d14f527d1c39d9af93ddbe2f41462f01b523bdc340b4c62cb72c31a4c46d1f"
+            echo "Actual:   $VALUES_HASH"
+            exit 1
+          fi
+
+      - name: Deploy Local Env to Kind k8s
+        uses: devcontainers/ci@v0.3
+        with:
+          runCmd: |
+            # we need to override "latest" image tag of ui inside local-env to run e2e against the current commit api version and not against latest from master
+            # We tried to use yq to change the image tag, but in the values files for helmfile we have non-yaml code that yq can`t parse or ignore
+            # so for that reason we use Stream EDitor which can find needed string using regular expressions and change it to a new value
+            # The -i flag is needed to write new image tag directly to values file
+            sed -i "0,/tag:.*/s//tag: \"sha-${{ github.event.pull_request.head.sha }}\"/" deploy/values-to-dos-api-cpp.yaml.gotmpl
+
+            # we also need to update the commit sha in the initContainer so that the latest image is used inside it
+            sed -i "0,/image:.*/s//image: \"ghcr.io/tourmalinecore/to-dos-api-cpp:sha-${{ github.event.pull_request.head.sha }}\"/" deploy/values-to-dos-api-cpp.yaml.gotmpl
+
+            # we need to override "latest" ref of service chart inside local-env to run tests against the current commit service chart version and not against latest from master
+            sed -i "0,/git+https:\/\/github.com\/TourmalineCore\/${{ github.event.repository.name }}.git?ref=.*/s//git+https:\/\/github.com\/TourmalineCore\/${{ github.event.repository.name }}.git?ref=${{ github.event.pull_request.head.sha }}/" deploy/helmfile.yaml.gotmpl
+
+            sed -i "0,/git::https:\/\/github.com\/TourmalineCore\/${{ github.event.repository.name }}.git@\/ci\/values.yaml?ref=.*/s//git::https:\/\/github.com\/TourmalineCore\/${{ github.event.repository.name }}.git@\/ci\/values.yaml?ref=${{ github.event.pull_request.head.sha }}/" deploy/helmfile.yaml.gotmpl
+
+            kind create cluster --name to-dos --config kind-local-config.yaml --kubeconfig ./.to-dos-cluster-kubeconfig
+            # we need to properly expose KUBECONFIG as an absolute path, pwd prints current working directory path
+            export KUBECONFIG=$(pwd)/.to-dos-cluster-kubeconfig
+
+            # When called, Makefile targets execute a sequence of commands. 
+            # The targets are defined in the Makefile located in the root of the to-dos-local-env repository.
+            make deploy-with-cpp-api
+          push: never
+
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Download Karate JAR
+        run: |
+          curl -L https://github.com/karatelabs/karate/releases/download/v1.5.1/karate-1.5.1.jar -o karate.jar
+
+      - name: Run E2E Tests Against Local Env
+        run: |
+          java -jar karate.jar .
+        env:
+          "API_ROOT_URL": "http://localhost:30080/api/to-dos-api"
+
+  e2e-karate-tests-in-docker-compose:
+    runs-on: ubuntu-24.04
+    steps:
+    - name: Checkout to repo
+      uses: actions/checkout@v4
+
+    # If you don't create a .env file, the services in Docker Compose 
+    # won't be able to start because they use this file.
+    - name: Create .env file
+      run: |
+        echo "API_HOST=0.0.0.0" >> .env
+        echo "API_PORT=80" >> .env
+        echo "API_LOG_LEVEL=INFO" >> .env
+        echo "API_NUMBER_OF_THREADS=1" >> .env
+        echo "POSTGRES_HOST=0.0.0.0" >> .env
+        echo "POSTGRES_PORT=5432" >> .env
+        echo "POSTGRES_DB=to-dos-api-cpp-db" >> .env
+        echo "POSTGRES_USER=postgres" >> .env
+        echo "POSTGRES_PASSWORD=password" >> .env
+
+    - name: Run service via docker-compose and run Karate-tests
+      run:  docker compose --profile MockForPullRequest up --exit-code-from to-dos-api-cpp-karate-tests

.gitignore

@@ -37,11 +37,13 @@
 *.out
 *.app
 
-# debug information files
+# Debug information files
 *.dwo
 
 # Build files
-
 /build
 __pycache__
 .env
+
+# Service files
+.DS_Store

CMakeLists.txt

@@ -33,12 +33,12 @@ target_link_libraries(${PROJECT_NAME}
 )
 
 # Tests
-if (ENV{EXCLUDE_UNIT_TESTS_FROM_BUILD} STREQUAL "true")
+if ("$ENV{EXCLUDE_UNIT_TESTS_FROM_BUILD}" STREQUAL "true")
   # Disable test here needed for uncompatible builds, bc `enable_testing` is run executable tests file for collecting tests.
   # E.g. if executable tests are builded for another OS or CPU arch. 
   message(STATUS "UNIT TEST DISABLED")
 else()
   message(STATUS "UNIT TEST ENABLED")
   enable_testing()
-  add_subdirectory(test)
+  add_subdirectory(unit)
 endif()

Dockerfile

@@ -7,13 +7,11 @@ WORKDIR /app
 EXPOSE 80
 
 # pip is installed here because it needs to be available in both the build and final stages
-RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
-    && apt-get -y install --no-install-recommends pip
+RUN apt-get update && apt-get -y install --no-install-recommends pip
 
 FROM base AS build
 
 WORKDIR /src
-COPY . .
 
 RUN apt-get -y install --no-install-recommends \
     build-essential clang lld make cmake ninja-build gdb \
@@ -23,12 +21,26 @@ RUN apt-get -y install --no-install-recommends \
 
 RUN pip install conan
 
+# this is necessary so that Conan can install the dependencies
+COPY conanfile.py /src/
+COPY .devcontainer/to-dos-conan-profile.conf /src/.devcontainer/
+COPY deps/ /src/deps/
+
 # this is necessary so that Conan can see the local dependency recipes
 RUN conan remote add local-recipes ./deps --type=local-recipes-index
 
+RUN conan install . --build=missing \
+    --profile:all=.devcontainer/to-dos-conan-profile.conf \
+    # this is necessary because, by default, the `build_type` property in the profile is set to `Debug`
+    --settings:host="build_type=Release"
+
+# We cannot copy all the content before running `conan install`, because 
+# otherwise the image layers cannot be cached in the pipeline
+COPY . .
+
 RUN conan build . --build=missing \
     --profile:all=.devcontainer/to-dos-conan-profile.conf \
-    # This is necessary because, by default, the `build_type` property in the profile is set to `Debug`
+    # this is necessary because, by default, the `build_type` property in the profile is set to `Debug`
     --settings:host="build_type=Release"
 
 FROM base AS final
@@ -39,7 +51,7 @@ RUN pip install alembic psycopg2-binary sqlalchemy-utils
 WORKDIR /app
 
 # alembic needs this to apply the migrations correctly
-COPY --from=build /src/alembic/* ./alembic/
+COPY --from=build /src/alembic/ ./alembic/
 
 COPY --from=build /src/build/Release/to-dos-api .