DAS-2070 - Implement GitHub workflows CI/CD.

owenlittlejohns commented 8 months ago

Description

This PR implements CI/CD to run the unittest suite for all PRs. It also adds a Docker image publication workflow for when changes are merged into the main branch containing an update to docker/service_version.txt.

The workflows are essentially copies of those used in the HOSS and Swath Projector repositories.

Jira Issue ID

DAS-2070

Local Test Steps

It's probably good to check the bin/build-image, bin/build-test and bin/run-test scripts all work on your local machine (given the change in image name).

You can also test this all works with Harmony locally:

Clone this repository.
Run bin/build-image.
Update your local Harmony instance to use the new HyBIG image name:
- In packages/util/env-defaults update HYBIG_SERVICE_QUEUE_URLS to use an image name of ghcr.io/nasa/harmony-browse-image-generator:latest. (It should just be a case of replacing sds with ghcr.io/nasa)
- In services/harmony/env-defaults update the HyBIG image: HYBIG_IMAGE=ghcr.io/nasa/harmony-browse-image-generator:latest.
Rebuild the image Harmony uses locally with npm run build-all.
Start a new Harmony instance with bin/bootstrap-harmony.
Run through the HyBIG regression test suite using a Jupyter notebook server in the browser, and setting HARMONY_HOST_URL='http:localhost:3000'. The tests should run and complete.

Things to look for on this PR itself:

The unit tests should run and complete successfully.
I think a Snyk check should also have been kicked off and pass. (Checking both security and licenses)

PR Acceptance Checklist

[x] Jira ticket acceptance criteria met.
~~CHANGELOG.md updated to include high level summary of PR changes.~~ (Already prepared for v1.0.0)
~~docker/service_version.txt updated if publishing a release.~~ (Already at 1.0.0)
~~Tests added/updated and passing.~~ (No new tests needed)
[x] Documentation updated (if needed).

lyonthefrog commented 8 months ago

Take out the elusive sds's:

owenlittlejohns commented 8 months ago

@lyonthefrog - good catches. I made some changes in the latest commit to fix most of those:

Updated all the references in the exceptions.py module. I made that just "harmony-browse-image-generator" and made it a variable, so it only ever needs to be tweaked once.
Updated the references in build-test and build-image.
Updated the references in the service.Dockerfile and tests.Dockerfile.
Left things as they were in the CHANGELOG.md, as that is trying to say that v1.0.0 is the same as v0.0.11 of the old sds-related Docker image.

lyonthefrog commented 8 months ago

The HyBIG regression tests were successful, as were the unit tests (report below). And it appears that the Snyk checks below have passed.

nasa / harmony-browse-image-generator