gchq / gchq/sleeper

Update scripts to run Docker image tests

Open
#7,674 3 comments 0 reactions 0 assignees View on GitHub
scripts
Dominant language
Java
Stars
107
Forks
29
Avg merge
19h 46m
Merged PRs (30d)
141

Description

### Description / Background

The scripts to run the Docker image tests are out of date and need updating. They don't currently run the tests we expect them to.

### Technical Notes / Implementation Details

This is the scripts in `scripts/test/docker`. The script `testCompactionDockerImage.sh` has a wildcard in the test invocation which will include the query Docker image test, when it's intended to only run the compaction one, and only builds the compaction Docker image.

The tests run in GitHub Actions via the workflow at `.github/workflows/docker-image-tests-changes.yaml`.

The Docker image tests are also mentioned in `docs/development/dev-scripts.md`, which state that `scripts/dev/buildDockerImage.sh` can be used when you want to run these tests locally. That documentation doesn't mention that you need to build the system first.

We could include `scripts/test/docker` in the dev scripts documentation, or move them into `scripts/dev`.

Contributor guide

Open the contributing guide

Research direction

Start with scripts/test/docker and compare testCompactionDockerImage.sh with the expected compaction and query image coverage. Read .github/workflows/docker-image-tests-changes.yaml and docs/development/dev-scripts.md to understand how the tests are run and documented. Done means the scripts run the intended Docker image tests, and the local-build prerequisites and script location are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, github-actions, shell
Domain
build-system, ci-cd, devops, documentation, testing-qa
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.