-
-
Notifications
You must be signed in to change notification settings - Fork 282
Add CI workflow to test CITE compliance #2011
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
ricardogsilva
wants to merge
42
commits into
geopython:master
Choose a base branch
from
ricardogsilva:update-cite-related-in-order-to-allow-running-from-docker
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Add CI workflow to test CITE compliance #2011
ricardogsilva
wants to merge
42
commits into
geopython:master
from
ricardogsilva:update-cite-related-in-order-to-allow-running-from-docker
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR introduces a new CI workflow for running CITE-related tests in an automated fashion.
This GitHub workflow file stands up a new docker compose stack which serves the purpose of readying pygeoapi for being tested. I am using a docker compose file with the intention of both:
The actual CITE testing is done by using the new cite-runner project, which I have been developing. It has now reached a level of maturity where it can be used reliably and its principal motivation for existing was to satisfy this type of workflow.
Important
I don't think this PR is ready to be merged just yet, but I'm opening it now in order to get some eyeballs on it and hopefully generate some discussion about it.
Included in the workflow is a matrix for running CITE tests for all of these test suites:
The workflow is configured to fail if any of these test suites fail - and this is indeed happening. My intention is just to demonstrate a possible usage pattern for pygeoapi but I am not actually advocating that we merge this PR like this 😛 . The current CITE test configuration that is included in pygeoapi repo, and which I am also reusing in this PR, does not really include resources for performing successful tests of all these test suites.
Perhaps the optimal strategy would be to ship only tests for OGC API Features for now.
Another option would be to keep all these test suites in effect, but rather modify the GitHub workflow so that it does not fail. In this way we could treat this new CITE testing workflow as merely informative.
Another option might be to set the workflow up so that it runs on a fixed schedule (maybe once per day) and uses the pygeoapi demo instance instead of running on each commit to the
master
branch.Anyway, the idea is that this workflow provides a nice test execution report on the GitHub actions workflow run page. See for example the result of this PR's checks here:
https://github.com/geopython/pygeoapi/actions/runs/14978028515
It looks like this:
The logs also provide a more comprehensive report, as seen in this screenshot I just took from them:
Related Issue / discussion
Additional information
Dependency policy (RFC2)
Updates to public demo
Contributions and licensing
(as per https://github.com/geopython/pygeoapi/blob/master/CONTRIBUTING.md#contributions-and-licensing)