Merge pull request #717 from codecov/dorian/lint-compare

Dorian/lint compare

Author: dorian-writes-code

.circleci/config.yml

@@ -105,6 +105,12 @@ jobs:
           apk add git
           chmod +x codecov-alpine
           ./codecov-alpine -R . --url https://stage-web.codecov.dev -t $CODECOV_STAGING_TOKEN -F unit
+  lint:
+    executor: codecov-api
+    steps:
+    - run:
+        name: Pylint
+        command: make lint
   portable:
     executor: codecov-deploy
     steps:
@@ -196,6 +202,10 @@ workflows:
           filters:
             tags:
               only: /.*/
+      - lint:
+          context: "circleci google deploy context" 
+          requires:
+            - build
       - build-enterprise:
           context: "circleci google deploy context"
           requires:
@@ -228,6 +238,7 @@ workflows:
           requires:
             - build
             - test
+            - lint
           filters:
             branches:
               only:
@@ -238,6 +249,7 @@ workflows:
           requires:
             - build
             - test
+            - lint
           filters:
             branches:
               only: staging
@@ -246,6 +258,7 @@ workflows:
           requires:
             - build
             - test
+            - lint
             - dive
           filters:
             branches:
@@ -269,6 +282,7 @@ workflows:
           requires:
             - build-enterprise
             - test
+            - lint
             - dive-enterprise
           filters:
             tags:
@@ -298,4 +312,4 @@ workflows:
             tags:
               only: /^enterprise-.*/
             branches:
-              ignore: /.*/
+              ignore: /.*/

.pylintrc

@@ -0,0 +1,5 @@
+[MESSAGES CONTROL]
+disable=C0114,C0115,C0116,R0201,R0801
+
+[FORMAT]
+max-line-length=120

Makefile

@@ -47,6 +47,9 @@ test.unit:
 test.integration:
 	python -m pytest --cov=./ -m "integration" --cov-report=xml:integration.coverage.xml
 
+lint:
+	pylint --load-plugins pylint_django --django-settings-module=codecov.settings_dev compare
+
 tag.qa-release:
 	git tag -a qa-${release_version}-${sha}-${epoch} -m "Autogenerated tag for enterprise api QA ${version}"
 	git push origin qa-${release_version}-${sha}-${epoch}

compare/admin.py

@@ -35,8 +35,8 @@ def get_queryset(self, request):
             "base_commit", "compare_commit", "base_commit__repository"
         ).defer("base_commit__report", "compare_commit__report")
 
-    def has_add_permission(self, _, obj=None):
+    def has_add_permission(self, *args, **kwargs):
         return False
 
-    def has_delete_permission(self, _, obj=None):
-        return False
+    def has_delete_permission(self, *args, **kwargs):
+        return True

compare/commands/compare/interactors/compare_commits.py

@@ -1,6 +1,5 @@
 from asgiref.sync import sync_to_async
 
-from codecov_auth.models import Session
 from codecov.commands.base import BaseInteractor
 from compare.models import CommitComparison
 from services.task import TaskService

compare/commands/compare/interactors/get_impacted_files.py

@@ -24,6 +24,7 @@ def get_comparison_data_from_archive(self, comparison):
         try:
             data = archive_service.read_file(comparison.report_storage_path)
             return json.loads(data)
+        # pylint: disable=W0702
         except:
             log.error(
                 "GetImpactedFiles - couldnt fetch data from storage", exc_info=True

compare/commands/compare/interactors/tests/test_compare_commits.py

@@ -1,13 +1,12 @@
-from asgiref.sync import async_to_sync
 from unittest.mock import patch
-import pytest
 
+from asgiref.sync import async_to_sync
 from django.contrib.auth.models import AnonymousUser
 from django.test import TransactionTestCase
 
 from core.tests.factories import CommitFactory
-from compare.models import CommitComparison
 from compare.tests.factories import CommitComparisonFactory
+
 from ..compare_commits import CompareCommitsInteractor
 
 

compare/commands/compare/interactors/tests/test_get_impacted_files.py

@@ -1,15 +1,12 @@
 import json
-
-from asgiref.sync import async_to_sync
 from unittest.mock import patch
-import pytest
 
+from asgiref.sync import async_to_sync
 from django.contrib.auth.models import AnonymousUser
 from django.test import TransactionTestCase
 from shared.reports.types import ReportTotals
 
 from core.tests.factories import CommitFactory
-from compare.models import CommitComparison
 from compare.tests.factories import CommitComparisonFactory
 from ..get_impacted_files import GetImpactedFilesInteractor
 

compare/commands/compare/tests/test_compare.py

@@ -1,7 +1,8 @@
 import asyncio
+from unittest.mock import patch
+
 from django.test import TransactionTestCase
 from core.tests.factories import CommitFactory
-from unittest.mock import patch
 
 from codecov_auth.tests.factories import OwnerFactory
 from compare.tests.factories import CommitComparisonFactory

compare/tests/test_admin.py

@@ -14,7 +14,5 @@ def setUp(self):
         self.client.force_login(user=self.staff_user)
 
     def test_compare_admin_detail_page(self):
-        response = self.client.get(
-            reverse(f"admin:compare_commitcomparison_changelist")
-        )
+        response = self.client.get(reverse("admin:compare_commitcomparison_changelist"))
         self.assertEqual(response.status_code, 200)

requirements.in

@@ -37,3 +37,5 @@ aiodataloader
 fakeredis
 opentelemetry-sdk
 opentelemetry-instrumentation-django
+pylint
+pylint-django

requirements.txt

@@ -20,6 +20,8 @@ asgiref==3.3.4
     #   opentelemetry-util-http
 asn1crypto==1.4.0
     # via cryptography
+astroid==2.6.6
+    # via pylint
 attrs==20.3.0
     # via
     #   pytest
@@ -143,14 +145,20 @@ iniconfig==1.1.1
     # via pytest
 intervaltree==3.1.0
     # via ddtrace
+isort==5.9.3
+    # via pylint
 jmespath==0.10.0
     # via
     #   boto3
     #   botocore
 kombu==4.6.11
     # via celery
+lazy-object-proxy==1.6.0
+    # via astroid
 marshmallow==3.8.0
     # via environs
+mccabe==0.6.1
+    # via pylint
 minio==6.0.0
     # via
     #   -r requirements.in
@@ -215,6 +223,15 @@ pyasn1==0.4.8
     #   rsa
 pycparser==2.20
     # via cffi
+pylint-django==2.4.4
+    # via -r requirements.in
+pylint-plugin-utils==0.6
+    # via pylint-django
+pylint==2.9.6
+    # via
+    #   -r requirements.in
+    #   pylint-django
+    #   pylint-plugin-utils
 pyparsing==2.4.7
     # via packaging
 pytest-cov==2.11.1
@@ -323,6 +340,7 @@ tlslite-ng==0.7.5
 toml==0.10.2
     # via
     #   pre-commit
+    #   pylint
     #   pytest
 tornado==6.0.4
     # via shared
@@ -346,6 +364,7 @@ whitenoise==5.2.0
     # via -r requirements.in
 wrapt==1.12.1
     # via
+    #   astroid
     #   deprecated
     #   opentelemetry-instrumentation
     #   vcrpy