Skip to content

Commit

Permalink
docs: updated integration tests README
Browse files Browse the repository at this point in the history
  • Loading branch information
neilmunday committed Nov 20, 2023
1 parent fa767d2 commit 86155bd
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions tests/integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

## Introduction

The `tests/integration` directory contains an automated test harness for Slurm-Mail. It makes use of https://github.com/neilmunday/rocky8-slurm to create a container to run the integration tests under.
The `tests/integration` directory contains an automated test harness for Slurm-Mail. It makes use of the docker images created by the Docker files in the [docker-slurm](docker-slurm) sub directory.

## Adding new Slurm version support

> **_Note:_** When a new version of Slurm is released https://github.com/neilmunday/rocky8-slurm needs to have been updated to support this new version first.
When a new version of Slurm is released the Docker files in the [docker-slurm](docker-slurm) sub directory need to be updated to the new version and the images created and pushed to the `ghcr.io/neilmunday/slurm-mail` image repository. This is partially automated via the [slurm_version_check](../../.github/workflows/slurm_version_check.yml) and [build_docker_slurm](../../.github/workflows/build_docker_slurm.yml) workflows.

Update the `../.github/workflows/testing.yml` workflow to include the new Slurm version.
Each day [slurm_version_check](../../.github/workflows/slurm_version_check.yml) checks for new versions of Slurm. If a new version is found the workflow updates all of the files in the [docker-slurm](docker-slurm) directory with the new version string and creates a pull request.

When the pull request is merged the [build_docker_slurm](../../.github/workflows/build_docker_slurm.yml) workflow automatically creates the new Slurm-Mail docker images so they are ready to use.

Finally, the `../.github/workflows/testing.yml` workflow must be updated to include the new Slurm version.

## Adding tests

Expand Down

0 comments on commit 86155bd

Please sign in to comment.