Add tests for json parsing and update README.md

Author: soul-catcher

README.md

@@ -13,18 +13,22 @@ Example gitlab codequality report from [gitlab documentation](https://docs.gitla
 ![Example gitlab codequality widget](https://docs.gitlab.com/ee/ci/testing/img/code_quality_widget_v13_11.png)
 
 # Usage
-`$ mypy program.py | mypy-gitlab-code-quality`
+`$ mypy program.py --output=json | mypy-gitlab-code-quality`
 
 This command send to `STDOUT` generated json that can be used as Code Quality report artifact.
 
+Also, this script supports plain text output parsing for backward compatability but json is recommended
+
+`$ mypy program.py | mypy-gitlab-code-quality`
+
 ## Example .gitlab-ci.yml
 ```yaml
 image: python:alpine
 codequality:
   script:
     - pip install mypy mypy-gitlab-code-quality
-    - mypy program.py --no-pretty > mypy-out.txt || true  # "|| true" is used for preventing job fail when mypy find errors
-    - mypy-gitlab-code-quality < mypy-out.txt > codequality.json
+    - mypy program.py --output=json > mypy-out.json || true  # "|| true" is used for preventing job fail when mypy find errors
+    - mypy-gitlab-code-quality < mypy-out.json > codequality.json
   artifacts:
     when: always
     reports:
@@ -33,11 +37,11 @@ codequality:
 Note: if you want to use this example you should replace `program.py` with yours module names.
 
 # Contributing
-Please run linters before creating merge request
+Please run linters before creating pull request
 ```shell
 pip install requirements/dev.txt
 mypy .
 ruff check
 ruff format
 ```
-Suggestions and merge requests are always welcome :)
+Suggestions and pull requests are always welcome :)

mypy_gitlab_code_quality/__init__.py

@@ -2,7 +2,6 @@
 
 import hashlib
 import json
-import os
 import re
 from enum import Enum
 from functools import reduce
@@ -40,7 +39,7 @@ def parse_issue(line: str) -> GitlabIssue | None:
         except json.JSONDecodeError:
             match = None
         if hint := match.get("hint"):  # attach hint to message
-            match["message"] += os.linesep + hint
+            match["message"] += "\n" + hint
     else:
         match = re.fullmatch(
             r"(?P<file>.+?)"

tests.py

@@ -3,7 +3,7 @@
 from mypy_gitlab_code_quality import Severity, parse_issue
 
 
-class ParseIssueTestCase(unittest.TestCase):
+class ParsePlainTextTestCase(unittest.TestCase):
     def test_path(self):
         issue = parse_issue("dir/module.py:2: error: Description")
         self.assertEqual("dir/module.py", issue["location"]["path"])
@@ -48,3 +48,148 @@ def test_column_number(self):
     def test_summary(self):
         issue = parse_issue("Found 5 errors in 1 file (checked 1 source file)")
         self.assertIsNone(issue)
+
+
+class ParseJsonTestCase(unittest.TestCase):
+    def test_path(self):
+        issue = parse_issue(
+            r"""{
+                "file": "dir/module.py",
+                "line": 2,
+                "column": 4,
+                "message": "Description",
+                "hint": null,
+                "code": "error-code",
+                "severity": "error"
+            }"""
+        )
+        self.assertEqual("dir/module.py", issue["location"]["path"])
+
+    def test_line_number(self):
+        issue = parse_issue(
+            r"""{
+                "file": "module.py",
+                "line": 2,
+                "column": 4,
+                "message": "Description",
+                "hint": null,
+                "code": "error-code",
+                "severity": "error"
+            }"""
+        )
+        self.assertEqual(2, issue["location"]["lines"]["begin"])
+
+    def test_fingerprint(self):
+        issue = parse_issue(
+            r"""{
+                "file": "module.py",
+                "line": 2,
+                "column": 4,
+                "message": "Description",
+                "hint": null,
+                "code": "error-code",
+                "severity": "error"
+            }"""
+        )
+        self.assertEqual("4455bb04f307121aa95a7b3725996837", issue["fingerprint"])
+
+    def test_error_level_error(self):
+        issue = parse_issue(
+            r"""{
+                "file": "module.py",
+                "line": 2,
+                "column": 4,
+                "message": "Description",
+                "hint": null,
+                "code": "error-code",
+                "severity": "error"
+            }"""
+        )
+        self.assertEqual(Severity.major, issue["severity"])
+
+    def test_error_level_note(self):
+        issue = parse_issue(
+            r"""{
+                "file": "module.py",
+                "line": 2,
+                "column": 4,
+                "message": "Description",
+                "hint": null,
+                "code": "error-code",
+                "severity": "note"
+            }"""
+        )
+        self.assertEqual(Severity.info, issue["severity"])
+
+    def test_error_level_unknown(self):
+        issue = parse_issue(
+            r"""{
+                "file": "module.py",
+                "line": 2,
+                "column": 4,
+                "message": "Description",
+                "hint": null,
+                "code": "error-code",
+                "severity": "egg"
+            }"""
+        )
+        self.assertEqual(Severity.unknown, issue["severity"])
+
+    def test_description(self):
+        issue = parse_issue(
+            r"""{
+                "file": "module.py",
+                "line": 2,
+                "column": 4,
+                "message": "Description",
+                "hint": null,
+                "code": "error-code",
+                "severity": "error"
+            }"""
+        )
+        self.assertEqual("Description", issue["description"])
+
+    def test_description_with_characters(self):
+        issue = parse_issue(
+            r"""{
+                "file": "module.py",
+                "line": 2,
+                "column": 4,
+                "message": "Incompatible (got \"None\", expected \"Object\")",
+                "hint": null,
+                "code": "error-code",
+                "severity": "error"
+            }"""
+        )
+        self.assertEqual(
+            'Incompatible (got "None", expected "Object")',
+            issue["description"],
+        )
+
+    def test_error_code(self):
+        issue = parse_issue(
+            r"""{
+                "file": "module.py",
+                "line": 2,
+                "column": 4,
+                "message": "Description",
+                "hint": null,
+                "code": "error-code",
+                "severity": "error"
+            }"""
+        )
+        self.assertEqual("error-code", issue["check_name"])
+
+    def test_hint(self):
+        issue = parse_issue(
+            r"""{
+                "file": "module.py",
+                "line": 2,
+                "column": 4,
+                "message": "Description",
+                "hint": "Hint",
+                "code": "error-code",
+                "severity": "error"
+            }"""
+        )
+        self.assertEqual("Description\nHint", issue["description"])