Merge pull request #48 from cfpb/actions

Add action that runs backend linting and unit tests

Author: willbarton

.github/workflows/backend_test.yml

@@ -0,0 +1,39 @@
+name: Back-end tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: django
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.13
+      - run: python -m pip install --upgrade pip -r ./requirements.txt
+      - run: ruff check
+
+  test:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: django
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.13
+      - run: python -m pip install --upgrade pip -r ./requirements.txt
+      - run: coverage run ./manage.py test
+      - run: coverage report

django/django_application/asgi.py

@@ -11,6 +11,7 @@
 
 from django.core.asgi import get_asgi_application
 
+
 os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_application.settings')
 
 application = get_asgi_application()

django/django_application/file_utils.py

@@ -1,8 +1,9 @@
 import json
 
+
 def get_json_file_contents(filepath: str):
     return json.loads(get_file_contents(filepath))
 
 def get_file_contents(filepath: str):
-    with open(filepath, "r") as f:
+    with open(filepath) as f:
         return f.read().strip()

django/django_application/s3_utils.py

@@ -1,6 +1,7 @@
-import boto3
 from django.conf import settings
 
+import boto3
+
 
 def s3_bucket_files(bucket_directory: str):
     bucket_name = settings.S3_BUCKET_NAME

django/django_application/tests/test_read_files.py

@@ -1,18 +1,23 @@
-from django.conf import settings
 from os import path
+
+from django.conf import settings
 from django.test import TestCase
+
 from django_application.file_utils import get_file_contents, get_json_file_contents
 
 
 class TestReadFilesystemFiles(TestCase):
-    file_path = path.join(settings.BASE_DIR, 'django_application', 'tests', 'sample_file.json')
+    file_path = path.join(
+        settings.BASE_DIR, 'django_application', 'tests', 'sample_file.json'
+    )
 
     def test_read_plaintext_file(self):
         result = get_file_contents(self.file_path)
         self.assertEqual(result,
-            '{"NAME":"myName","USER":"myUser","PASSWORD":"password123456","PORT":9876,"HOST":"myHost.sample.example.gov"}')
+            '{"NAME":"myName","USER":"myUser","PASSWORD":"password123456","PORT":9876,"HOST":"myHost.sample.example.gov"}'  # noqa: E501
+        )
 
     def test_read_json_file(self):
         result = get_json_file_contents(self.file_path)
         keys = sorted(list(result.keys()))
-        self.assertEqual(keys, ['HOST', 'NAME', 'PASSWORD', 'PORT', 'USER'])
+        self.assertEqual(keys, ['HOST', 'NAME', 'PASSWORD', 'PORT', 'USER'])

django/django_application/urls.py

@@ -14,15 +14,17 @@
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
-from django.core.exceptions import ImproperlyConfigured
+from contextlib import suppress
+
 from django.contrib import admin
-from django.urls import path, include, re_path
+from django.core.exceptions import ImproperlyConfigured
+from django.urls import include, path, re_path
 from django.views.generic import TemplateView
 
-from users import views
-from evaluate_m2 import views as eval_views
-from evaluate_m2 import urls as evaluate_m2_urls
 from django_application import views as error_view
+from evaluate_m2 import urls as evaluate_m2_urls
+from evaluate_m2 import views as eval_views
+from users import views
 
 
 urlpatterns = [
@@ -33,16 +35,16 @@
     path('api/users/<int:user_id>/', views.users_view)
 ]
 
-try:
+with suppress(ImproperlyConfigured):
     # If the SSO library is installed, include auth-related URLs
     urlpatterns += [
         path('oauth2/', include('django_auth_adfs.urls')),
     ]
-except ImproperlyConfigured:
-    pass
 
 # All erroneous API calls to return 400: bad request
 urlpatterns.append(re_path(r'api(?:.*)?', error_view.bad_request_view ))
 
 # Fall through route: Handle all other URLs through the front end
-urlpatterns.append(re_path(r'^(?:.*)?', TemplateView.as_view(template_name='m2/index.html')))
+urlpatterns.append(
+    re_path(r'^(?:.*)?', TemplateView.as_view(template_name='m2/index.html'))
+)

django/django_application/views.py

@@ -1,6 +1,7 @@
+from rest_framework import status
 from rest_framework.decorators import api_view
 from rest_framework.response import Response
-from rest_framework import status
+
 
 @api_view()
 def bad_request_view(request):

django/django_application/wsgi.py

@@ -11,6 +11,7 @@
 
 from django.core.wsgi import get_wsgi_application
 
+
 os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_application.settings')
 
 application = get_wsgi_application()

django/evaluate_m2/admin.py

@@ -1,5 +1,11 @@
 from django.contrib import admin
-from evaluate_m2.models import EvaluatorMetadata, EvaluatorResultSummary, EvaluatorResult
+
+from evaluate_m2.models import (
+    EvaluatorMetadata,
+    EvaluatorResult,
+    EvaluatorResultSummary,
+)
+
 
 # Register your models here.
 class EvaluatorMetadataAdmin(admin.ModelAdmin):

django/evaluate_m2/evaluate.py

@@ -5,15 +5,13 @@
 from django.db import connection
 from django.utils.module_loading import import_string
 
-from evaluate_m2.evaluate_utils import  create_eval_insert_query
-from evaluate_m2.upload_utils import stream_results_files_to_s3
-
+from evaluate_m2.evaluate_utils import create_eval_insert_query
 from evaluate_m2.models import EvaluatorMetadata, EvaluatorResultSummary
-
+from evaluate_m2.upload_utils import stream_results_files_to_s3
 from parse_m2.models import Metro2Event
 
 
-class Evaluate():
+class Evaluate:
     # Evaluator version is saved on each evaluator result summary.
     # Increment this version for all updates to evaluator functionality.
     evaluator_version = "1.3"
@@ -27,12 +25,12 @@ def load_evaluators(self):
         for eval_id, eval_import_str in evaluators_dict.items():
             try:
                 eval_callable = import_string(eval_import_str)
-            except ImportError:
+            except ImportError as e:
                 raise ImproperlyConfigured(
                     f"Unable to import {eval_import_str} for evaluator "
                     f"{eval_id}. Are you sure the package and evaluator "
                     "callable exist?"
-                )
+                ) from e
             self.evaluators[eval_id] = eval_callable
 
     # runs evaluators to produce results
@@ -82,7 +80,9 @@ def save_evaluator_results(self, result_summary, eval_query):
         with connection.cursor() as cursor:
             cursor.execute(full_query, query_params)
 
-    def prepare_result_summary(self, event: Metro2Event, eval_id: str) -> EvaluatorResultSummary:
+    def prepare_result_summary(
+        self, event: Metro2Event, eval_id: str
+    ) -> EvaluatorResultSummary:
         """
         Create an EvaluatorResultSummary object so we can associate results with it.
         Later, we will update the values related to eval hits.
@@ -102,7 +102,9 @@ def prepare_result_summary(self, event: Metro2Event, eval_id: str) -> EvaluatorR
             evaluator_version = self.evaluator_version,
         )
 
-    def update_result_summary_with_actual_results(self, result_summary: EvaluatorResultSummary):
+    def update_result_summary_with_actual_results(
+        self, result_summary: EvaluatorResultSummary
+    ):
         """
         If the evaluator had any hits, update the information about the hits
         in the EvaluatorResultSummary record.