write write tests for slug, fix seed

Author: MikeyManoguerra

core/fixtures/programs.yaml

@@ -2,62 +2,53 @@
   pk: 1
   fields:
     name: TESTING
-    slug: TESTING
     is_closed: false
     has_queue: true
 - model: core.program
   pk: 2
   fields:
     name: CM
-    slug: CM
     is_closed: false
     has_queue: true
 - model: core.program
   pk: 3
   fields:
     name: SSHP
-    slug: SSHP
     is_closed: false
     has_queue: true
 - model: core.program
   pk: 4
   fields:
     name: LEGAL
-    slug: LEGAL
     is_closed: false
     has_queue: true
 - model: core.program
   pk: 5
   fields:
     name: CRAFT
-    slug: CRAFT
     is_closed: false
     has_queue: false
 - model: core.program
   pk: 6
   fields:
     name: PHAN
-    slug: PHAN
     is_closed: false
     has_queue: false
 - model: core.program
   pk: 7
   fields:
     name: STEP
-    slug: STEP
     is_closed: false
     has_queue: false
 - model: core.program
   pk: 8
   fields:
     name: BIENESTAR
-    slug: BIENESTAR
     is_closed: false
     has_queue: false
 - model: core.program
   pk: 9
   fields:
     name: SKWC
-    slug: SKWC
     is_closed: false
     has_queue: false

core/management/commands/seed.py

@@ -240,8 +240,6 @@ def create_programs(output=True):
     for program, services in DEFAULT_PROGRAMS.items():
         p = Program()
         p.name = program
-        p.slug = re.sub(r' [^a-zA-Z0-9\-]+', '',
-                        '-'.join(program.lower().split()))
 
         if p.name in HAS_QUEUE:
             p.has_queue = True
@@ -256,8 +254,7 @@ def create_programs(output=True):
         for service in services:
             s = Service()
             s.name = service
-            s.slug = p.slug+ '-'+re.sub(r'  [^a-zA-Z0-9\-]',
-                                   '', '-'.join(service.lower().split()))
+            s.slug = f"{p.name}-{s.name}"
 
             s.available = random_bool()
             s.program = p

core/migrations/0013_auto_20210124_2349.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2.13 on 2021-01-25 04:49
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0012_auto_20201216_0954'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='service',
+            name='slug',
+            field=models.CharField(max_length=100, unique=True, verbose_name='Concise Descriptive Identifier'),
+        ),
+    ]

core/programs/serializer.py

@@ -9,11 +9,8 @@ class ProgramSerializer(serializers.ModelSerializer):
     class Meta:
         model = Program
         # related_name on model allows for services instead of service_set
-        fields = ("id", "name", "slug", "is_closed",
-                  "is_frozen", "services", "has_queue")
-        extra_kwargs = {
-            "slug": {"read_only": True}
-        }
+        fields = ("id", "name", "is_closed", "is_frozen", "services", "has_queue")
+
 
 
 class ProgramForVisitSerializer(serializers.ModelSerializer):
@@ -22,7 +19,4 @@ class ProgramForVisitSerializer(serializers.ModelSerializer):
     """
     class Meta:
         model = Program
-        fields = ("id", "name", "slug", "is_closed", "is_frozen", "has_queue")
-        extra_kwargs = {
-            "slug": {"read_only": True}
-        }
+        fields = ("id", "name", "is_closed", "is_frozen", "has_queue")

core/programs/views.py

@@ -8,13 +8,3 @@
 class ProgramViewSet(ModelViewSet):
     queryset = Program.objects.all()
     serializer_class = ProgramSerializer
-
-
-    def get_queryset(self):
-        slug = self.request.query_params.get('slug', None)
-        queryset = Program.objects.all()
-        if slug is not None:
-            queryset = queryset.filter(slug__iexact=slug)
-        if not queryset.exists():
-            raise NotFound()
-        return queryset

core/services/views.py

@@ -1,6 +1,7 @@
 from core.models import Service
 from core.viewsets import ModelViewSet
 from core.services.serializers import ServiceSerializer
+from rest_framework.exceptions import NotFound
 
 class ServiceViewSet(ModelViewSet):
     queryset = Service.objects.all()

core/tests/services.py

@@ -1,26 +1,28 @@
 from django.forms.models import model_to_dict
 from core.tests.base import BaseTestCase
+from django.core.exceptions import ValidationError
 from django.core.management import call_command
-from core.models import Service
+from core.models import Service, Program
 from rest_framework import status
 import random
 import json
 
+
 def get_random_service():
-    #gets random service from DB
+    # gets random service from DB
     random_pk = random.randint(1, 40)
     return model_to_dict(Service.objects.get(pk=random_pk))
 
-class ServicesTests(BaseTestCase):
-    fixtures = ['services.yaml', 'programs.yaml']
 
+class ServicesTests(BaseTestCase):
+    fixtures = ["services.yaml", "programs.yaml"]
 
     def test_get_services_list(self):
         """
         Ensures that list of services is returned
         """
-        headers = self.auth_headers_for_user('admin')
-        response = self.client.get( '/api/services/', follow=True, **headers)
+        headers = self.auth_headers_for_user("admin")
+        response = self.client.get("/api/services/", follow=True, **headers)
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(Service.objects.count(), 43)
@@ -29,15 +31,21 @@ def test_update_availability(self):
         """
         Ensures the 'available' boolean can update
         """
-        headers = self.auth_headers_for_user('admin')
+        headers = self.auth_headers_for_user("admin")
         random_service = get_random_service()
 
-        service_availability = random_service['available']
-        random_service['available'] = not service_availability
-        route = '/api/services/{}/'.format(random_service['id'])
+        service_availability = random_service["available"]
+        random_service["available"] = not service_availability
+        route = "/api/services/{}/".format(random_service["id"])
 
-        response = self.client.put(route, json.dumps(random_service), content_type='application/json', follow=True, **headers)
-        updated_availabilty = Service.objects.get(pk=random_service['id']).available
+        response = self.client.put(
+            route,
+            json.dumps(random_service),
+            content_type="application/json",
+            follow=True,
+            **headers
+        )
+        updated_availabilty = Service.objects.get(pk=random_service["id"]).available
 
         self.assertNotEqual(service_availability, updated_availabilty)
         self.assertEqual(response.status_code, status.HTTP_200_OK)
@@ -46,13 +54,80 @@ def test_disallow_service_name_change(self):
         """
         Ensures that name field is read only
         """
-        headers = self.auth_headers_for_user('admin')
+        headers = self.auth_headers_for_user("admin")
         random_service = get_random_service()
-        service_name = random_service['name']
-        random_service['name'] = 'Some nonexistent service'
-        route = '/api/services/{}/'.format(random_service['id'])
+        service_name = random_service["name"]
+        random_service["name"] = "Some nonexistent service"
+        route = "/api/services/{}/".format(random_service["id"])
 
-        self.client.put(route, json.dumps(random_service), content_type='application/json', follow=True, **headers)
-        unchanged_name = Service.objects.get(pk=random_service['id']).name
-        #returns a 200 status, but field is unchanged
+        self.client.put(
+            route,
+            json.dumps(random_service),
+            content_type="application/json",
+            follow=True,
+            **headers
+        )
+        unchanged_name = Service.objects.get(pk=random_service["id"]).name
+        # returns a 200 status, but field is unchanged
         self.assertEqual(service_name, unchanged_name)
+
+    def test_service_has_slug_field(self):
+        """
+        Ensure Service has slug field
+        """
+        headers = self.auth_headers_for_user("admin")
+        random_service = get_random_service()
+        route = "/api/services/{}/".format(random_service["id"])
+        res = self.client.get(route, follow=True, **headers)
+        content = json.loads(res.content)
+        self.assertTrue("slug" in content)
+        self.assertTrue(content["slug"], random_service["slug"])
+
+    def test_disallow_slug_change(self):
+        """
+        Ensure slug field read only
+        """
+        headers = self.auth_headers_for_user("admin")
+        random_service = get_random_service()
+        service_slug = random_service["slug"]
+        random_service["name"] = "a fake slug"
+        route = "/api/services/{}/".format(random_service["id"])
+
+        self.client.put(
+            route,
+            json.dumps(random_service),
+            content_type="application/json",
+            follow=True,
+            **headers
+        )
+        unchanged_slug = Service.objects.get(pk=random_service["id"]).name
+        # returns a 200 status, but field is unchanged
+        self.assertEqual(service_slug, unchanged_slug)
+
+    def test_slug_uniqueness(self):
+        """
+        Ensure slug field is unique.
+        Note: since serializer removes name and slug
+        bc read_only=true for all request types at the moment,
+        we're testing the model directly
+        """
+
+        slug = "banana"
+
+        program = Program.objects.all().first()
+        Service.objects.create(name="some name", slug=slug, program=program)
+        count_before_error = Service.objects.count()
+        with self.assertRaises(Exception) as context:
+            Service.objects.create(name="another name", slug=slug, program=program)
+
+        self.assertEqual(Service.objects.count(), count_before_error)
+
+    def test_slug_normalization(self):
+        """
+        Ensure slug gets normalized when created
+        """
+
+        slug = "   $%^$#    543 Sligh Bannaga *&^%*&   "
+        program = Program.objects.all().first()
+        service = Service.objects.create(name="some name", slug=slug, program=program)
+        self.assertRegex(service.slug, r"[a-z0-9\-]")

frontend/src/components/SepForm.js

@@ -15,7 +15,7 @@ import PrevPointHeading from "./Typography/PrevPointHeading"
 import PrevPointCopy from "./Typography/PrevPointCopy"
 import { Formik, Form } from "formik"
 import { SEPSearchSchema, SEPNeedleSchema } from "../validation"
-import { SNACKBAR_SEVERITY } from "../constants"
+import { SNACKBAR_SEVERITY, SYRINGE_EXCHANGE_SLUG } from "../constants"
 
 const useStyles = makeStyles(theme => ({
   root: {
@@ -78,7 +78,8 @@ const SepForm = ({
   }, [participantStore])
 
   useEffect(() => {
-    utilityStore.getServiceBySlug("sep-needle-exchange")
+    utilityStore.getServiceBySlug(SYRINGE_EXCHANGE_SLUG)
+
     return function cleanup() {
       utilityStore.setServiceSlugResponse({})
     }

frontend/src/constants/index.js

@@ -50,3 +50,5 @@ export const SNACKBAR_SEVERITY = {
   SUCCESS: "success",
   ERROR: "error",
 }
+
+export const SYRINGE_EXCHANGE_SLUG = "sep-needle-exchange"