[DAPS-1906-1] - feature: add core unit testing to CI

[JoshuaSBrown]

Description

Part 1 of 2 in supporting testing of Core Server.

Summary by Sourcery

Add CI support for running core component unit tests using an intermediate Docker image that includes test binaries.

Build:

• Update core Docker build to enable unit and integration tests so the intermediate image produces test binaries without changing the production runtime image.

CI:

• Introduce a core unit test job in the GitLab unit stage, reusing common CI configuration.

Tests:

• Ensure core unit and integration test binaries are built and executed in CI while keeping them out of the production image.

[sourcery-ai]

Reviewer's Guide

Adds a new GitLab CI unit test job for the core component and updates the core Docker build to compile and include test binaries in the intermediate image so they can be executed in CI, without changing the final production image contents.

Sequence diagram for the new core unit CI job

sequenceDiagram
    participant GitLabCI
    participant GitLabRunner
    participant DockerRegistry
    participant CoreUnitContainer

    GitLabCI->>GitLabRunner: Schedule run-core-unit-job
    GitLabRunner->>DockerRegistry: docker login REGISTRY with HARBOR_USER and token
    GitLabRunner->>DockerRegistry: Pull core intermediate image
    DockerRegistry-->>GitLabRunner: core intermediate image
    GitLabRunner->>GitLabRunner: Generate random container suffix
    GitLabRunner->>CoreUnitContainer: docker run --entrypoint bash ... ctest
    CoreUnitContainer->>CoreUnitContainer: ctest --test-dir build -LE integration|fixture
    CoreUnitContainer-->>GitLabRunner: Test results and exit code
    GitLabRunner-->>GitLabCI: Report job status based on ctest result

Loading

Flow diagram for Docker multi-stage build with enabled tests

flowchart TD
    subgraph Build_Stage[Docker build stage: core build]
        direction TB
        S1[Copy source and scripts into BUILD_DIR]
        S2[Run generate_dependencies_config.sh]
        S3[Run generate_datafed.sh]
        S4[Configure CMake<br/>-DBUILD_TESTS=True?<br/>-DENABLE_UNIT_TESTS=True<br/>-DENABLE_INTEGRATION_TESTS=True]
        S5[cmake --build build -j 8]
        S6[cmake --build build --target install]
        S7[Intermediate image contains server and test binaries]
        S1 --> S2 --> S3 --> S4 --> S5 --> S6 --> S7
    end

    subgraph Prod_Stage[Docker runtime stage: core]
        direction TB
        P1[FROM RUNTIME AS core]
        P2[Copy only server binary from build stage]
        P3[Final production image without test binaries]
        P1 --> P2 --> P3
    end

    S7 -->|copy server only| P2

Loading

File-Level Changes

Change	Details	Files
Wire common CI configuration into the unit test stage pipeline.	Include shared GitLab CI configuration in the unit test stage YAML to reuse common variables and settings	.gitlab/stage_unit.yml
Introduce a core unit test CI job that runs tests from the intermediate core image.	Define run-core-unit-job in the unit stage depending on the core build job Configure job variables for project, component, and intermediate layer name to target the correct Docker image Add CI tags for routing to appropriate runners Log in to the Docker registry using CI-provided credentials Stop any existing core-unit containers with a helper script to avoid name collisions Generate a random suffix for the container name to ensure uniqueness per run Run a container from the core intermediate build image and execute ctest against the build directory, excluding integration and fixture tests and showing failures	.gitlab/stage_unit.yml
Enable building of unit and integration tests in the core intermediate Docker image while keeping the production image lean.	Add comments clarifying that tests are enabled only in the intermediate image and not copied into the production image Change CMake configuration flags to enable both unit and integration tests during the intermediate image build Leave the final core runtime stage unchanged so that only the server binary is copied into the production image	core/docker/Dockerfile

Possibly linked issues

• #[Feature] - CI, Test, Core, add integration and core unit testing to CI: PR adds core unit-test job in CI and enables test binaries, directly addressing the CI test gap in issue

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've found 2 issues, and left some high level feedback:

• In run-core-unit-job, consider using CI_COMMIT_REF_SLUG instead of manually lowercasing CI_COMMIT_REF_NAME to avoid issues with branch names that contain unsupported characters in Docker container names/tags.
• The Dockerfile now enables both unit and integration tests (-DENABLE_UNIT_TESTS=True and -DENABLE_INTEGRATION_TESTS=True), but the CI job filters out integration tests (-LE "integration|fixture"); if integration tests are not needed for this stage, you might want to leave them disabled to reduce build time and image size.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In `run-core-unit-job`, consider using `CI_COMMIT_REF_SLUG` instead of manually lowercasing `CI_COMMIT_REF_NAME` to avoid issues with branch names that contain unsupported characters in Docker container names/tags.
- The Dockerfile now enables both unit and integration tests (`-DENABLE_UNIT_TESTS=True` and `-DENABLE_INTEGRATION_TESTS=True`), but the CI job filters out integration tests (`-LE "integration|fixture"`); if integration tests are not needed for this stage, you might want to leave them disabled to reduce build time and image size.

## Individual Comments

### Comment 1
<location path=".gitlab/stage_unit.yml" line_range="144-150" />
<code_context>
+        - ci-datafed-core
+        - docker
+    script:
+        - BRANCH_LOWER=$(echo "$CI_COMMIT_REF_NAME" | tr '[:upper:]' '[:lower:]')
+        - docker login "${REGISTRY}" -u "${HARBOR_USER}" -p "${HARBOR_DATAFED_GITLAB_CI_REGISTRY_TOKEN}"
+        - ./scripts/container_stop.sh -n "core-unit-" -p
+        - random_string=$(bash -c "cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 10 | head -n 1")
+        - |
+            docker run --rm \
+              --name "core-unit-${BRANCH_LOWER}-${CI_COMMIT_SHORT_SHA}-${random_string}" \
+              --entrypoint bash \
+              -t "${REGISTRY}/${PROJECT}/${COMPONENT}-${INTERMEDIATE_LAYER_NAME}-${BRANCH_LOWER}:${CI_COMMIT_SHA}" \
</code_context>
<issue_to_address>
**issue:** Sanitize branch name to avoid invalid characters in Docker image/container names.

`CI_COMMIT_REF_NAME` may contain characters invalid in Docker names (e.g. `/`, `@`, spaces in `feature/foo`, `release@candidate`). Please further sanitize `BRANCH_LOWER` (e.g. replace invalid chars with `-` and optionally truncate to a safe length) before using it in `--name` and the image path so this works for all branch names.
</issue_to_address>

### Comment 2
<location path=".gitlab/stage_unit.yml" line_range="145" />
<code_context>
+        - docker
+    script:
+        - BRANCH_LOWER=$(echo "$CI_COMMIT_REF_NAME" | tr '[:upper:]' '[:lower:]')
+        - docker login "${REGISTRY}" -u "${HARBOR_USER}" -p "${HARBOR_DATAFED_GITLAB_CI_REGISTRY_TOKEN}"
+        - ./scripts/container_stop.sh -n "core-unit-" -p
+        - random_string=$(bash -c "cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 10 | head -n 1")
</code_context>
<issue_to_address>
**🚨 suggestion (security):** Use `--password-stdin` for Docker login to avoid exposing credentials in process args.

Passing the token via `-p` exposes it in process arguments, which may be visible in process lists or logs. Prefer piping the token into `docker login` with `--password-stdin`, e.g.:

```bash
- docker login "${REGISTRY}" -u "${HARBOR_USER}" -p "${HARBOR_DATAFED_GITLAB_CI_REGISTRY_TOKEN}"
+ echo "${HARBOR_DATAFED_GITLAB_CI_REGISTRY_TOKEN}" | docker login "${REGISTRY}" -u "${HARBOR_USER}" --password-stdin
```

```suggestion
        - echo "${HARBOR_DATAFED_GITLAB_CI_REGISTRY_TOKEN}" | docker login "${REGISTRY}" -u "${HARBOR_USER}" --password-stdin
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

issue: Sanitize branch name to avoid invalid characters in Docker image/container names.

CI_COMMIT_REF_NAME may contain characters invalid in Docker names (e.g. /, @, spaces in feature/foo, release@candidate). Please further sanitize BRANCH_LOWER (e.g. replace invalid chars with - and optionally truncate to a safe length) before using it in --name and the image path so this works for all branch names.