Rule — Testing — Project passes all of its automated tests

Of course, the point of having automated tests is to ensure that they pass. While mllint will not run your tests as part of its static analysis, mllint expects you to run these on your own terms and provide a the filenames to a JUnit-compatible XML test report and a Cobertura-compatible XML coverage report in your project’s mllint configuration. Specifically for this rule, the JUnit test report is analysed.

When using pytest to run your project’s tests, use the --junitxml=<filename> option to generate such a test report, e.g.:

pytest --junitxml=tests-report.xml

You can then configure mllint to pick up your test report as follows:

testing:
  report: tests-report.xml # JUnit report for rule testing/pass

or equivalent TOML:

[tool.mllint.testing]
report = "tests-report.xml"