tooling.json

{
    "tools": {
        "dockerfile": {
            "hadolint": {
                "docs": "https://github.com/hadolint/hadolint",
                "docker": {
                    "image": "hadolint/hadolint:latest-alpine",
                    "reviewed": "2021-06-21"
                },
                "args": [{
                    "type": "optional", "description": "Ignore rules (see https://github.com/hadolint/hadolint#rules)", "value": "--ignore", "format": "string", "selectable": true, "repeatable": true
                }]
            }
        },
        "java": {
            "checkstyle": {
                "docs": "https://github.com/checkstyle/checkstyle",
                "docker": {
                    "image": "davrodgon/checkstyle",
                    "reviewed": "1970-01-01"
                }
            }
        },
        "json": {
            "jsonlint": {
                "docs": "https://github.com/zaach/jsonlint",
                "docker": {
                    "image": "cytopia/jsonlint",
                    "reviewed": "1970-01-01"
                }
            }
        },
        "python": {
            "bandit": {
                "docs": "https://bandit.readthedocs.io/",
                "docker": {
                    "image": "secfigo/bandit",
                    "reviewed": "1970-01-01"
                }
            },
            "pycodestyle": {
                "docs": "https://pycodestyle.pycqa.org/",
                "docker": {
                    "image": "cytopia/pycodestyle",
                    "reviewed": "1970-01-01"
                }
            },
            "tox": {
                "jepl_support": true,
                "docs": "https://tox.readthedocs.io/",
                "docker": {
                    "image": "painless/tox",
                    "reviewed": "1970-01-01"
                }
            }
        },
        "license": {
            "licensee": {
                "docs": "https://github.com/licensee/licensee",
                "docker": {
                    "dockerfile": "QC.Lic/licensee/Dockerfile",
                    "reviewed": "2021-06-28"
                },
                "args": [{
                    "type": "subcommand", "description": "Detect the license of the given project", "value": "detect", "selectable": false, "args": [{
                        "type": "positional", "description": "Path to project's license", "value": ".", "selectable": false
                    }]
                }]
            },
            "checkLicense": {
                "docs": "https://github.com/EOSC-synergy/sqa-composer-templates/tree/main/QC.Lic",
                "docker": {
                    "dockerfile": "Qc.Lic/Dockerfile",
                    "composer_file": "QC.Lic/docker-compose.yml",
                    "reviewed": "1970-01-01"
                }
            }
        },
        "codemeta": {
            "checkCitable": {
                "docs": "https://github.com/EOSC-synergy/sqa-composer-templates/tree/main/QC.Acc",
                "docker": {
                    "dockerfile": "Qc.Acc/Dockerfile",
                    "composer_file": "QC.Acc/docker-compose.yml",
                    "reviewed": "1970-01-01"
                }
            }
        },
        "default": {
            "commands": {
                "docs": "https://indigo-dc.github.io/jenkins-pipeline-library/2.0.0/user/config_file.html#commands",
                "docker": {
                    "dockerfile": "alpine:latest",
                    "reviewed": "1970-01-01"
                }
            }
        }
    },
    "criteria": {
        "QC.Sty": {
            "description": {
                "msg": "Use code style standards to guide your code writing so you let others understand it",
                "improves": "readability, reusability",
                "docs": "https://indigo-dc.github.io/sqa-baseline/#code-style-qc.sty"
            },
            "tools": {
                "dockerfile": ["hadolint"],
                "json": ["jsonlint"],
                "python": ["tox", "pycodestyle"]
            }
        },
        "QC.Uni": {
            "description": {
                "msg": "Test the behaviour of segments or units within your code (e.g. conditionals, loops, functions)",
                "improves": "code design, early bug detection",
                "docs": "https://indigo-dc.github.io/sqa-baseline/#unit-testing-qc.uni"
            },
            "tools": {
                "python": ["tox"]
            }
        },
        "QC.Fun": {
            "description": {
                "msg": "Ensure compliance with the functional requirements to meet your users’ expectations",
                "improves": "end-user satisfaction, usability",
                "docs": "https://indigo-dc.github.io/sqa-baseline/#functional-testing-qc.fun"
            },
            "tools": {
                "python": ["tox"]
            }
        },
        "QC.Sec": {
            "description": {
                "msg": "Secure your software by finding (statically) common issues associated to the programming language in use and look for disclosed security vulnerabilities",
                "improves": "security issues detection",
                "docs": "https://indigo-dc.github.io/sqa-baseline/#security-qc.sec"
            },
            "tools": {
                "python": ["tox", "bandit"]
            }
        },
        "QC.Doc": {
            "description": {
                "msg": "Treat documentation as code by using markup languages to automatically build and place it in online repositories",
                "improves": "outreach capacity, documentation maintenance",
                "docs": "https://indigo-dc.github.io/sqa-baseline/#documentation-qc.doc"
            },
            "tools": {
                "python": ["tox"]
            }
        },
        "QC.Acc": {
            "description": {
                "msg": "Source code and documentation publicly available in online repositories",
                "improves": "reusability, reproducibility",
                "docs": "https://indigo-dc.github.io/sqa-baseline/#code-accessibility-qc.acc"
            },
            "tools": {
                "codemeta": ["checkCitable"]
            }
        },
        "QC.Lic": {
            "description": {
                "msg": "Usage of an open license to distribute your code",
                "improves": "external contributions, reusability",
                "docs": "https://indigo-dc.github.io/sqa-baseline/#licensing-qc.lic"
            },
            "tools": {
                "license": ["licensee"]
            }
        }
    }
}