Merge pull request #249 from snok/sondrelg/sonarcloud-upload

Add sonarcloud coverage upload

Author: sondrelg

.github/workflows/testing.yml

@@ -81,11 +81,32 @@ jobs:
       - name: Run tests
         run: |
           source .venv/bin/activate
-          poetry run pytest --cov=openapi_tester --verbose --assert=plain --cov-report=xml
+          poetry run pytest --cov=. --cov-report=xml
           poetry run coverage report
+      - name: Archive coverage
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage-xml
+          path: coverage.xml
+        if: matrix.python-version == '3.10' && matrix.django-version == '3.2'
+  coverage:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Get coverage
+        uses: actions/download-artifact@v2
+        with:
+          name: coverage-xml
       - uses: codecov/codecov-action@v2
         with:
           file: ./coverage.xml
           fail_ci_if_error: true
           token: ${{ secrets.CODECOV_TOKEN }}
-        if: matrix.python-version == '3.10'
+      - name: Fix coverage file for sonarcloud
+        run: |
+          sed -i "s/<source>\/home\/runner\/work\/drf-openapi-tester\//<source>/g" coverage.xml
+      - uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

poetry.lock

@@ -58,7 +58,7 @@ pytest = "*"
 pytest-django = "*"
 pylint = "*"
 coverage = { extras = ["toml"], version = "^6"}
-pytest-cov = "^2"
+pytest-cov = "*"
 
 [tool.black]
 line-length = 120
@@ -101,13 +101,20 @@ good-names = "_,e,i"
 
 [tool.coverage.run]
 source = ["openapi_tester/*"]
-omit = ["openapi_tester/type_declarations.py"]
+omit = [
+    "openapi_tester/type_declarations.py",
+    "manage.py",
+    "test_project/*",
+]
 branch = true
 
 [tool.coverage.report]
 show_missing = true
 skip_covered = true
-exclude_lines = ["raise NotImplementedError"]
+exclude_lines = [
+    "raise NotImplementedError",
+    "pragma: no cover",
+]
 
 [tool.pytest.ini_options]
 DJANGO_SETTINGS_MODULE = "test_project.settings"

pyproject.toml

@@ -0,0 +1,10 @@
+sonar.projectKey=snok_drf-openapi-tester
+sonar.organization=snok
+
+sonar.language=py
+sonar.python.version=3.6, 3.7, 3.8, 3.9, 3.10
+
+sonar.test.inclusions=tests/*
+sonar.sources=openapi_tester
+sonar.sourceEncoding=UTF-8
+sonar.python.coverage.reportPaths=*coverage.xml

sonar-project.properties

@@ -76,7 +76,7 @@ def schema_type_to_mock_value(self, schema_object: Dict[str, Any]) -> Any:
                 minimum += 1 if schema_object.get("exclusiveMinimum") else 0
             if maximum is not None:
                 maximum -= 1 if schema_object.get("exclusiveMaximum") else 0
-            if minimum is not None or maximum is not None:
+            if minimum is not None or maximum is not None:  # pragma: no cover
                 minimum = minimum or 0
                 maximum = maximum or minimum * 2
                 if schema_type == "integer":

tests/schema_converter.py

@@ -401,17 +401,14 @@ def test_custom_validators():
     def uuid_4_validator(schema_section: dict, data: Any) -> Optional[str]:
         schema_format = schema_section.get("format")
         if schema_format == "uuid4":
-            try:
-                result = UUID(data, version=4)
-                if str(result) != str(data):
-                    return f"Expected uuid4, but received {data}"
-            except ValueError:
+            result = UUID(data, version=4)
+            if str(result) != str(data):
                 return f"Expected uuid4, but received {data}"
         return None
 
-    def uuid_1_validator(schema_section: dict, data: Any) -> Optional[str]:
+    def uuid_1_validator(schema_section: dict, data: Any) -> Optional[str]:  # pragma: no cover
         schema_format = schema_section.get("format")
-        if schema_format == "uuid1":
+        if schema_format == "uuid1":  #
             try:
                 result = UUID(data, version=1)
                 if str(result) != str(data):

tests/test_schema_tester.py

@@ -1,26 +1,15 @@
-import json
 from contextlib import suppress
 from copy import deepcopy
 from pathlib import Path
 from typing import Any, Callable, Generator, Optional, Tuple, Union
 
-import yaml
 from rest_framework.response import Response
 
 from tests.schema_converter import SchemaToPythonConverter
 
 TEST_ROOT = Path(__file__).resolve(strict=True).parent
 
 
-def load_schema(file_name: str) -> dict:
-    with open(str(TEST_ROOT) + f"/schemas/{file_name}") as f:
-        content = f.read()
-        if "json" in file_name:
-            return json.loads(content)
-        else:
-            return yaml.load(content, Loader=yaml.FullLoader)
-
-
 def response_factory(schema: dict, url_fragment: str, method: str, status_code: Union[int, str] = 200) -> Response:
     converted_schema = SchemaToPythonConverter(deepcopy(schema)).result
     response = Response(status=int(status_code), data=converted_schema)
@@ -67,7 +56,7 @@ def sort_object(data_object: Any) -> Any:
     if isinstance(data_object, list) and data_object:
         if not all(isinstance(entry, type(data_object[0])) for entry in data_object):
             return data_object
-        if isinstance(data_object[0], (dict, list)):
+        if isinstance(data_object[0], (dict, list)):  # pragma: no cover
             return [sort_object(entry) for entry in data_object]
         return sorted(data_object)
     return data_object