Add composite action for starting a JIMM environment #1321
Conversation
- Use the composite action as part of a basic integration test
- Adding a trigger to run the new integration test on PRs to verify it works.
kian99
force-pushed
the
CSS-6347-integration-testing
branch
from
4dff75d
to
195794f
Compare
| uses: actions/setup-go@v4 | ||
| with: | ||
| go-version-file: 'go.mod' | ||
| - name: Go vendor to speed up docker build |
There was a problem hiding this comment.
Why would this speed it up? Wouldn't it be exactly the same as referencing our mod cache?
There was a problem hiding this comment.
It speeds up the build inside the docker container because we mount the working directory into the air container and with the vendor folder present, Go does not need to download all the dependencies.
It would indeed be the same thing as adding a volume mount to the mod cache, I can do that instead if you prefer.
There was a problem hiding this comment.
But vendoring downloads them just like a build would? This would only make it faster when you're bring the compose up and down right?
There was a problem hiding this comment.
Vendoring puts them in the repo in ./vendor and they are already present in the Go module cache because of the setup-go action. So this ends up bringing them into the air docker image which then greatly speeds up the build.
- Use `extends` to shift common config to a separate file
| - name: Go vendor to speed up docker build | ||
| if: ${{ github.event_name == 'pull_request' }} | ||
| run: go mod vendor | ||
| - name: Start JIMM (pull request) |
| @@ -0,0 +1,62 @@ | |||
| # This file contains a collection of common configurations used in JIMM's Docker compose file. | |||
There was a problem hiding this comment.
I think I've conventionally seen another dot, like docker-compose.qa.yaml, can we do that instead for the name plz?
There was a problem hiding this comment.
So this file isn't a docker compose file, it's just a base template. With that in mind what do you think for the name?
| # An instance of JIMM used in integration tests, pulled from a tag. | ||
| jimm-test: | ||
| extends: | ||
| file: compose-common.yaml |
There was a problem hiding this comment.
I think having an actual separate compose file is better under a specific network name?
There was a problem hiding this comment.
https://stackoverflow.com/questions/38088279/communication-between-multiple-docker-compose-projects
But we don't need external or anything, just have them in the same network
There was a problem hiding this comment.
I won't do this now because it's more complexity than we need. We're just extending some config rather than needing to create multiple composes.
* Add composite action for starting a JIMM environment - Use the composite action as part of a basic integration test * Run integration test on PR - Adding a trigger to run the new integration test on PRs to verify it works. * fix naming * allow action to start dev env * rewording * remove need for env file * add default string * use extends in compose - Use `extends` to shift common config to a separate file
Description
This PR creates a Github "composite action", i.e. an action that can be called from other workflows for the purposes of allowing other projects to spin up JIMM as part of an integration test. As mentioned in the readme.md file for the action, the high-level steps it takes are:
The motivation for this change is to provide the Juju Terraform provider with a way of running integration tests against JIMM.
Additionally I've made 2 further changes:
jimmcontainer except it does not buildjimmfrom source and instead pulls the image from the Github Container Registry. This makes the environment much faster to start up since no Go modules need to be downloaded and nothing needs to be compiled.integration-test.yamlfile that uses the new composite action as part of a basic integration test. This verifies that the composite action is working and gives us a nice, easy to spin up testing environment which we could use in the future for further tests.Partially addresses CSS-6347
Engineering checklist
Check only items that apply