Make validator GitHub Action

[CasperWA]

This PR adds the possibility of using the OPTiMaDe validator optimade_validator developed by @ml-evs as a GitHub Action.

It is a Docker-based action that supports both "local" servers running within the GitHub Actions runner, as well as external, deployed servers.

There are the following available inputs at this point (taken from the updated README.md):

---

GitHub Action - OPTiMaDe validator

This action runs optimade_validator from this repository on a running server.

Example usage

To run optimade_validator for an index meta-database at http://gh_actions_host:5001/optimade/v0 do the following:
Within the same job, first, start a server, e.g., using the docker-compose.yml setup from this repository, and then add the step

uses: Materials-Consortia/optimade-python-tools@master
with:
  port: 5001
  path: /optimade/v0
  index: yes

To run optimade_validator for a regular OPTiMaDe deployed implementation, testing all possible versioned base URLs:

• https://example.org:443/optimade/example/v0
• https://example.org:443/optimade/example/v0.10
• https://example.org:443/optimade/example/v0.10.1

uses: Materials-Consortia/optimade-python-tools@master
with:
  protocol: https
  domain: example.org
  port: 443
  path: /optimade/example
  all versioned paths: True

Inputs

protocol

Optional Protocol for the OPTiMaDe URL.
Default: http

domain

Optional Domain for the OPTiMaDe URL (defaults to the GitHub Actions runner host).
Default: gh_actions_host

port

Optional Port for the OPTiMaDe URL.
Default: 5000

path

Optional Path for the OPTiMaDe (versioned) base URL - MUST start with /
Note: If all versioned paths is true, this MUST be un-versioned, e.g., /optimade, otherwise it MUST be versioned, e.g., the default value.
Default: /optimade/v0

all versioned paths

Optional Whether to test all possible versioned base URLs:

• /vMAJOR
• /vMAJOR.MINOR
• /vMAJOR.MINOR.PATCH

If this is 'true', the input 'path' MUST exempt the version part (e.g., '/optimade' instead of '/optimade/v0').
If this is 'false', the input 'path' MUST include the version part (e.g., '/optimade/v0' instead of '/optimade').
Default: false

index

Optional Whether or not this is an index meta-database.
Default: false

---

Furthermore, the PR adds a separate CI file for the action, as well as updated invoke tasks to update the action with the newest supported OPTiMaDe version.

[ml-evs]

This looks really nice, thanks @CasperWA. Previously I had a similar thing set up from in separate repo using GitHub's secrets but I could never get the syntax working... This will encourage me to update the validator and try to verify it against the spec itself, rather than the subset we have implemented. I'll review it properly tomorrow when I'm able to test it.

[CasperWA]

(...) This will encourage me to update the validator and try to verify it against the spec itself, rather than the subset we have implemented. I'll review it properly tomorrow when I'm able to test it.

Wonderful!
I indeed also wanted to have the test run against provider.optimade.org as an index meta-database, testing deployed implementations, but the validator is of course too strict to allow that to pass.
I think we need to introduce the concept of optionality properly - without having to change too much in the models (preferably nothing at all).

[ml-evs]

Thanks for this @CasperWA, not sure I can test it on my server repo until we've merged here, but I can't see any problems :)

[CasperWA]

Thanks for this @CasperWA, not sure I can test it on my server repo until we've merged here, but I can't see any problems :)

You can use the validator temporarily for tests via the following:

uses: CasperWA/optimade-python-tools@make_validator_github_action
with:
  # ...

I would encourage you to test it before merging - if you have time :)