eosc-synergy / jpl-validator

YAML validator (based on JSON schema draft 7) for the configuration of jenkins-pipeline-library (v2)

jpl-validator

Application that validates the main YAML-based configuration file from the v2 series of the indigo-dc/jenkins-pipeline-library.

Institutions owning the result

The validation uses a JSON schema (Draft 7).

Usage

Directly with gradlew

$ ./gradlew run --args='.sqa/config.yml'

Building & running (fat)JAR

$ ./gradlew fatJar
$ java -jar ./build/libs/jpl-validator-2.0.0.jar .sqa/config.yml

Through Docker (via Google's Jib)

$ ./gradlew jibDockerBuild
$ docker run --rm -v $PWD:/jpl eoscsynergy/jpl-validator:2.0.0 /jpl/.sqa/config.yml

jpl-validator's Issues

tox file path is a required parameter

jpl-validator/src/main/resources/schema.json

Line 25 in 4926dcb

"required": ["testenv"],

Add tox_file as a required parameter. This always need to have the real path inside container to the tox.ini file.

More details on indigo-dc/jenkins-pipeline-library#150

Fix SLF4J warnings

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

config_repo name pattern must comply to defined code style

Schema must be updated to only allow the characters expected in the defined code style syntax (removed dash):

"config_repo": {
            "type": "object",
            "minProperties": 1,
            "patternProperties": {
                "[a-z0-9_]*": { "$ref": "#/definitions/config_repo_settings" }
            }
        },

Validate JSON schema in Jenkinsfile

Add support for QC.Met

As part of the bronze badge issuing, the validator needs to allow a new criterion: QC.Met

Container required for Tox?

While the JSON schema allows for a tox property to exist without a container (unlike the command one), it seems that the current executor implementation (docker-compose) relies on having such container.
Error message:
"docker-compose -f .sqa/docker-compose.yml --project-directory /var/lib/jenkins/workspace/Dispel4py/ exec -T tox tox -c /dispel4py-testing/tox.ini -e stylecheck
No such service: tox"

tox is used as name of the service, that is not defined in the docker-compose.yml.

Dependency on "container" should be added to "tox".

PS: I understand from the documentation that this is the expected behaviour on the executor part, just saying that this should be enforced in the schema.

Duplicated key in schema.json

There is a duplicated key (credentials_file) in schema.json.
PR #29

Support for QC.FAIR criterion

Lowercase environment variables are allowed

See issue indigo-dc/jenkins-pipeline-library#20

Remove the docker image corresponding to a branch name when the branch is deleted

Gradle build: documentation incomplete

Missing the following details on the README.md file that are important for current gradle build implementation:

• to push jpl-validator image is required to run with argument jib and is required to define the variables JPL_USERNAME and JPL_PASSWORD
• the image tag is defined by the following criteria with strict order:
  • master if on master branch
  • lastest tag belonging to current branch if there is any
  • the branch name

Run jib for any new release and latest when jpl-2.1.0 is released

Use jpl-2.1.0 to run ./gradlew jib (need credentials)