JSON & XML formaters

.github/workflows/ci.yaml

@@ -45,7 +45,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Append GitHub Actions system path
         run: echo "$HOME/.local/bin" >> $GITHUB_PATH
-      - run: pip install coveralls
+      - run: pip install coveralls ddt
       - run: pip install .
       - run: coverage run --source=yamllint -m unittest discover
       - name: Coveralls

.gitignore

@@ -5,3 +5,7 @@ __pycache__
 /yamllint.egg-info
 /build
 /.eggs
+.venv
+venv
+.coverage
+coverage.xml

CONTRIBUTING.rst

@@ -14,8 +14,12 @@ Pull Request Process
    .. code:: bash
 
     pip install --user .
-    python -m unittest discover  # all tests...
-    python -m unittest tests/rules/test_commas.py  # or just some tests (faster)
+    pip install coveralls ddt
+    # all tests...
+    python -m coverage run --source=yamllint -m unittest discover
+    coverage report
+    # or just some tests (faster)
+    python -m unittest tests/rules/test_commas.py
 
 3. If you add code that should be tested, add tests.
 

tests/test_cli.py

@@ -305,6 +305,9 @@ def test_run_with_user_global_config_file(self):
         config = os.path.join(dir, 'config')
 
         self.addCleanup(os.environ.update, HOME=os.environ['HOME'])
+        # remove other env vars to make sure we are using the HOME config file.
+        os.environ.pop('YAMLLINT_CONFIG_FILE', None)
+        os.environ.pop('XDG_CONFIG_HOME', None)
         os.environ['HOME'] = home
 
         with open(config, 'w') as f:

tests/test_format.py

@@ -0,0 +1,270 @@
+# -*- coding: utf-8 -*-
+# flake8: noqa
+import unittest
+import string
+import ddt
+
+from yamllint.linter import LintProblem
+from yamllint.format import (
+    escape_xml,
+    severity_from_level,
+    max_level,
+    Formater,
+    ParsableFormater,
+    GithubFormater,
+    ColoredFormater,
+    StandardFormater,
+    JSONFormater,
+    JunitFormater,
+    CodeclimateFormater
+)
+
+
+@ddt.ddt
+class TextToXMLTestCase(unittest.TestCase):
+
+    def test_letters_chars(self):
+        txt = string.ascii_letters
+        self.assertEqual(escape_xml(txt), txt)
+
+    @ddt.data(
+        ('&', '&'),
+        ('<', '&lt;'),
+        ('>', '&gt;'),
+        ('"', '&quot;'),
+        ("'", '&apos;'),
+        ("too many blank lines (3 > 2)", 'too many blank lines (3 &gt; 2)'),
+        ('line too long (100 > 80 characters)', 'line too long (100 &gt; 80 characters)')
+    )
+    @ddt.unpack
+    def test_specials_chars(self, inp, out):
+        self.assertEqual(escape_xml(inp), out)
+
+
+@ddt.ddt
+class CodeClimateSeverityTestCase(unittest.TestCase):
+
+    @ddt.data(
+        (None, "info"),
+        ('warning', "minor"),
+        ('error', "major"),
+        (0, "info"),
+        (1, "minor"),
+        (2, "major"),
+    )
+    @ddt.unpack
+    def test_specials_chars(self, inp, out):
+        self.assertEqual(severity_from_level(inp), out)
+
+
+@ddt.ddt
+class FormaterTestCase(unittest.TestCase):
+
+    def test_get_formaters_names(self):
+        self.assertEqual(
+            set(Formater.get_formaters_names()),
+            {
+                "parsable",
+                "github",
+                "colored",
+                "standard",
+                "json",
+                "junitxml",
+                "codeclimate"
+            }
+        )
+
+    @ddt.data(
+        ("parsable", ParsableFormater, True),
+        ("github", GithubFormater, True),
+        ("colored", ColoredFormater, True),
+        ("standard", StandardFormater, True),
+        ("json", JSONFormater, True),
+        ("junitxml", JunitFormater, True),
+        ("codeclimate", CodeclimateFormater, True),
+        ("parsable", ParsableFormater, False),
+        ("github", GithubFormater, False),
+        ("colored", ColoredFormater, False),
+        ("standard", StandardFormater, False),
+        ("json", JSONFormater, False),
+        ("junitxml", JunitFormater, False),
+        ("codeclimate", CodeclimateFormater, False),
+    )
+    @ddt.unpack
+    def test_get_formater(self, name, cls, no_warn):
+        res = Formater.get_formater(name, no_warn)
+        self.assertTrue(isinstance(res, cls))
+        self.assertEqual(res.no_warn, no_warn)
+
+    def test_unknown_formater(self):
+        with self.assertRaises(ValueError):
+            Formater.get_formater("unknown", False)
+
+    def test_abstract_class(self):
+        inst = Formater(False)
+        with self.assertRaises(NotImplementedError):
+            inst.show_problems_for_all_files([])
+        with self.assertRaises(NotImplementedError):
+            inst.show_problems_for_file([], "a")
+        with self.assertRaises(NotImplementedError):
+            inst.show_problem(None, "a")
+
+
+NONE = {}
+NO_ERROR = {"file1.yml": []}
+ONE_NOTHING = {"file1.yml": [
+    LintProblem(1, 1, desc="desc of None", rule="my-rule")
+]}
+ONE_ERROR = {"file1.yml": [
+    LintProblem(
+        line=1,
+        column=2,
+        desc="desc of error",
+        rule="my-rule",
+        level="error"
+    )
+]}
+ONE_WARNING = {"file1.yml": [
+    LintProblem(
+        line=1,
+        column=2,
+        desc="desc of warn",
+        rule="my-rule",
+        level="warning"
+    )
+]}
+MIXED_ONE_FILE = {"file1.yml": [
+    ONE_NOTHING["file1.yml"][0],
+    ONE_ERROR["file1.yml"][0],
+    ONE_WARNING["file1.yml"][0]
+]}
+MIXED_MULT_FILE = {
+    "file1.yml": ONE_NOTHING["file1.yml"],
+    "file2.yml": ONE_ERROR["file1.yml"],
+    "file3.yml": ONE_WARNING["file1.yml"]
+}
+
+
+@ddt.ddt
+class FormatersTestCase(unittest.TestCase):
+
+    @ddt.data(
+        # No errors
+        (ParsableFormater(True), NONE, ""),
+        (GithubFormater(True), NONE, ""),
+        (ColoredFormater(True), NONE, ""),
+        (StandardFormater(True), NONE, ""),
+        (JSONFormater(True), NONE, "[]\n"),
+        (CodeclimateFormater(True), NONE, "[]\n"),
+        (ParsableFormater(True), NO_ERROR, ""),
+        (GithubFormater(True), NO_ERROR, ""),
+        (ColoredFormater(True), NO_ERROR, ""),
+        (StandardFormater(True), NO_ERROR, ""),
+        (JSONFormater(True), NO_ERROR, "[]\n"),
+        (CodeclimateFormater(True), NO_ERROR, "[]\n"),
+        (ParsableFormater(True), ONE_NOTHING, ""),
+        (GithubFormater(True), ONE_NOTHING, ""),
+        (ColoredFormater(True), ONE_NOTHING, ""),
+        (StandardFormater(True), ONE_NOTHING, ""),
+        (JSONFormater(True), ONE_NOTHING, '[]\n'),
+        (CodeclimateFormater(True), ONE_NOTHING, '[]\n'),
+        # Errors with no level are ignored
+        (ParsableFormater(False), ONE_NOTHING, ""),
+        (GithubFormater(False), ONE_NOTHING, ""),
+        (ColoredFormater(False), ONE_NOTHING, ""),
+        (StandardFormater(False), ONE_NOTHING, ""),
+        (JSONFormater(False), ONE_NOTHING, '[]\n'),
+        (CodeclimateFormater(False), ONE_NOTHING, '[]\n'),
+        # 1 Skipped warning
+        (ParsableFormater(True), ONE_WARNING, ""),
+        (GithubFormater(True), ONE_WARNING, ""),
+        (ColoredFormater(True), ONE_WARNING, ""),
+        (StandardFormater(True), ONE_WARNING, ""),
+        (JSONFormater(True), ONE_WARNING, '[]\n'),
+        (CodeclimateFormater(True), ONE_WARNING, '[]\n'),
+        # 1 Unskipped warning
+        (ParsableFormater(False), ONE_WARNING, 'file1.yml:1:2: [warning] desc of warn (my-rule)\n'),
+        (GithubFormater(False), ONE_WARNING, '::group::file1.yml\n::warning file=file1.yml,line=1,col=2::1:2 [my-rule] desc of warn\n::endgroup::\n\n'),
+        (ColoredFormater(False), ONE_WARNING, '\x1b[4mfile1.yml\x1b[0m\n  \x1b[2m1:2\x1b[0m       \x1b[33mwarning\x1b[0m  desc of warn  \x1b[2m(my-rule)\x1b[0m\n\n'),
+        (StandardFormater(False), ONE_WARNING, 'file1.yml\n  1:2       warning  desc of warn  (my-rule)\n\n'),
+        (JSONFormater(False), ONE_WARNING, '[\n    {\n        "line": 1,\n        "column": 2,\n        "rule": "my-rule",\n        "level": "warning",\n        "message": "desc of warn",\n        "path": "file1.yml"\n    }\n]\n'),
+        (CodeclimateFormater(False), ONE_WARNING, '[\n    {\n        "type": "issue",\n        "check_name": "my-rule",\n        "description": "desc of warn",\n        "content": "desc of warn (my-rule)",\n        "categories": [\n            "Style"\n        ],\n        "location": {\n            "path": "file1.yml",\n            "positions": {\n                "begin": {\n                    "line": 1,\n                    "column": 2\n                }\n            }\n        },\n        "remediation_points": 1000,\n        "severity": "minor"\n    }\n]\n'),
+        # 1 Error
+        (ParsableFormater(True), ONE_ERROR, 'file1.yml:1:2: [error] desc of error (my-rule)\n'),
+        (GithubFormater(True), ONE_ERROR, '::group::file1.yml\n::error file=file1.yml,line=1,col=2::1:2 [my-rule] desc of error\n::endgroup::\n\n'),
+        (ColoredFormater(True), ONE_ERROR, '\x1b[4mfile1.yml\x1b[0m\n  \x1b[2m1:2\x1b[0m       \x1b[31merror\x1b[0m    desc of error  \x1b[2m(my-rule)\x1b[0m\n\n'),
+        (StandardFormater(True), ONE_ERROR, 'file1.yml\n  1:2       error    desc of error  (my-rule)\n\n'),
+        (JSONFormater(True), ONE_ERROR, '[\n    {\n        "line": 1,\n        "column": 2,\n        "rule": "my-rule",\n        "level": "error",\n        "message": "desc of error",\n        "path": "file1.yml"\n    }\n]\n'),
+        (CodeclimateFormater(True), ONE_ERROR, '[\n    {\n        "type": "issue",\n        "check_name": "my-rule",\n        "description": "desc of error",\n        "content": "desc of error (my-rule)",\n        "categories": [\n            "Style"\n        ],\n        "location": {\n            "path": "file1.yml",\n            "positions": {\n                "begin": {\n                    "line": 1,\n                    "column": 2\n                }\n            }\n        },\n        "remediation_points": 1000,\n        "severity": "major"\n    }\n]\n'),
+        # mixed warn / err on the same file
+        (ParsableFormater(False), MIXED_ONE_FILE, 'file1.yml:1:2: [error] desc of error (my-rule)\nfile1.yml:1:2: [warning] desc of warn (my-rule)\n'),
+        (GithubFormater(False), MIXED_ONE_FILE, '::group::file1.yml\n::error file=file1.yml,line=1,col=2::1:2 [my-rule] desc of error\n::warning file=file1.yml,line=1,col=2::1:2 [my-rule] desc of warn\n::endgroup::\n\n'),
+        (ColoredFormater(False), MIXED_ONE_FILE, '\x1b[4mfile1.yml\x1b[0m\n  \x1b[2m1:2\x1b[0m       \x1b[31merror\x1b[0m    desc of error  \x1b[2m(my-rule)\x1b[0m\n  \x1b[2m1:2\x1b[0m       \x1b[33mwarning\x1b[0m  desc of warn  \x1b[2m(my-rule)\x1b[0m\n\n'),
+        (StandardFormater(False), MIXED_ONE_FILE, 'file1.yml\n  1:2       error    desc of error  (my-rule)\n  1:2       warning  desc of warn  (my-rule)\n\n'),
+        (JSONFormater(False), MIXED_ONE_FILE, '[\n    {\n        "line": 1,\n        "column": 2,\n        "rule": "my-rule",\n        "level": "error",\n        "message": "desc of error",\n        "path": "file1.yml"\n    },\n    {\n        "line": 1,\n        "column": 2,\n        "rule": "my-rule",\n        "level": "warning",\n        "message": "desc of warn",\n        "path": "file1.yml"\n    }\n]\n'),
+        (CodeclimateFormater(False), MIXED_ONE_FILE, '[\n    {\n        "type": "issue",\n        "check_name": "my-rule",\n        "description": "desc of error",\n        "content": "desc of error (my-rule)",\n        "categories": [\n            "Style"\n        ],\n        "location": {\n            "path": "file1.yml",\n            "positions": {\n                "begin": {\n                    "line": 1,\n                    "column": 2\n                }\n            }\n        },\n        "remediation_points": 1000,\n        "severity": "major"\n    },\n    {\n        "type": "issue",\n        "check_name": "my-rule",\n        "description": "desc of warn",\n        "content": "desc of warn (my-rule)",\n        "categories": [\n            "Style"\n        ],\n        "location": {\n            "path": "file1.yml",\n            "positions": {\n                "begin": {\n                    "line": 1,\n                    "column": 2\n                }\n            }\n        },\n        "remediation_points": 1000,\n        "severity": "minor"\n    }\n]\n'),
+        # mixed warn / err on multiples files
+        (ParsableFormater(False), MIXED_MULT_FILE, 'file2.yml:1:2: [error] desc of error (my-rule)\nfile3.yml:1:2: [warning] desc of warn (my-rule)\n'),
+        (GithubFormater(False), MIXED_MULT_FILE, '::group::file2.yml\n::error file=file2.yml,line=1,col=2::1:2 [my-rule] desc of error\n::endgroup::\n\n::group::file3.yml\n::warning file=file3.yml,line=1,col=2::1:2 [my-rule] desc of warn\n::endgroup::\n\n'),
+        (ColoredFormater(False), MIXED_MULT_FILE, '\x1b[4mfile2.yml\x1b[0m\n  \x1b[2m1:2\x1b[0m       \x1b[31merror\x1b[0m    desc of error  \x1b[2m(my-rule)\x1b[0m\n\n\x1b[4mfile3.yml\x1b[0m\n  \x1b[2m1:2\x1b[0m       \x1b[33mwarning\x1b[0m  desc of warn  \x1b[2m(my-rule)\x1b[0m\n\n'),
+        (StandardFormater(False), MIXED_MULT_FILE, 'file2.yml\n  1:2       error    desc of error  (my-rule)\n\nfile3.yml\n  1:2       warning  desc of warn  (my-rule)\n\n'),
+        (JSONFormater(False), MIXED_MULT_FILE, '[\n    {\n        "line": 1,\n        "column": 2,\n        "rule": "my-rule",\n        "level": "error",\n        "message": "desc of error",\n        "path": "file2.yml"\n    },\n    {\n        "line": 1,\n        "column": 2,\n        "rule": "my-rule",\n        "level": "warning",\n        "message": "desc of warn",\n        "path": "file3.yml"\n    }\n]\n'),
+        (CodeclimateFormater(False), MIXED_MULT_FILE, '[\n    {\n        "type": "issue",\n        "check_name": "my-rule",\n        "description": "desc of error",\n        "content": "desc of error (my-rule)",\n        "categories": [\n            "Style"\n        ],\n        "location": {\n            "path": "file2.yml",\n            "positions": {\n                "begin": {\n                    "line": 1,\n                    "column": 2\n                }\n            }\n        },\n        "remediation_points": 1000,\n        "severity": "major"\n    },\n    {\n        "type": "issue",\n        "check_name": "my-rule",\n        "description": "desc of warn",\n        "content": "desc of warn (my-rule)",\n        "categories": [\n            "Style"\n        ],\n        "location": {\n            "path": "file3.yml",\n            "positions": {\n                "begin": {\n                    "line": 1,\n                    "column": 2\n                }\n            }\n        },\n        "remediation_points": 1000,\n        "severity": "minor"\n    }\n]\n'),
+    )
+    @ddt.unpack
+    def test_all_formaters(self, inst, inp, ret):
+        self.assertEqual(
+            inst.show_problems_for_all_files(inp),
+            ret
+        )
+
+
+@ddt.ddt
+class MaxLevelTestCase(unittest.TestCase):
+
+    @ddt.data(
+        (NONE, 0),
+        (NO_ERROR, 0),
+        (ONE_NOTHING, 0),
+        (ONE_ERROR, 2),
+        (ONE_WARNING, 1),
+        (MIXED_ONE_FILE, 2),
+        (MIXED_MULT_FILE, 2),
+    )
+    @ddt.unpack
+    def test_all_formaters(self, inp, ret):
+        self.assertEqual(max_level(inp), ret)
+
+@ddt.ddt
+class JunitTestCase(unittest.TestCase):
+
+    @ddt.data(
+        (NONE, False, [], ['<\/error><\/testcase>', '<\/failure><\/testcase>'], 7),
+        (NO_ERROR, False, [], ['<\/error><\/testcase>', '<\/failure><\/testcase>'], 7),
+        (ONE_NOTHING, False, [], ['<\/error><\/testcase>', '<\/failure><\/testcase>'], 7),
+        (ONE_ERROR, False, ['<\/error><\/testcase>'], ['<\/failure><\/testcase>'], 7),
+        (ONE_WARNING, False, ['<\/failure><\/testcase>'], ['<\/error><\/testcase>'], 7),
+        (ONE_WARNING, True, [], ['<\/error><\/testcase>', '<\/failure><\/testcase>'], 7),
+        (MIXED_ONE_FILE, False, ['<\/error><\/testcase>', '<\/failure><\/testcase>'], [], 8),
+        (MIXED_MULT_FILE, False, ['<\/error><\/testcase>', '<\/failure><\/testcase>'], [], 8),
+    )
+    @ddt.unpack
+    def test_all_formaters(self, inp, no_warn, contain, not_contain, length):
+        res = JunitFormater(no_warn).show_problems_for_all_files(inp)
+        self.assertTrue(res.startswith(
+            '<?xml version="1.0" encoding="utf-8"?>\n' \
+            '<testsuites>\n' \
+            '    <testsuite name="yamllint" '
+        ))
+
+        for e in contain:
+            self.assertTrue(e in res)
+        for e in not_contain:
+            self.assertFalse(e in res)
+
+        self.assertTrue(res.endswith(
+            '\n' \
+            '    </testsuite>\n' \
+            '</testsuites>\n'))
+
+        self.assertEqual(len(res.split('\n')), length)