Closes Develop tests and document

Fix #169
Changes to be committed:
	modified:   authentication/apis.py
	modified:   authentication/services.py
	modified:   tests/fixtures/test_data.json
	modified:   tests/test_views/test_api_auth_add.py

Author: HadleyKing

authentication/apis.py

@@ -123,9 +123,10 @@ class AddAuthenticationApi(APIView):
     @swagger_auto_schema(
         request_body=schema,
         responses={
-            200: "Add authentication is successful.",
-            201: "Authentication credentials were created and added.",
+            200: "New authentication credentials added to existing object.",
+            201: "Authentication object created and added to account.",
             400: "Bad request.",
+            403: "Authentication credentials were not provided.",
             409: "That object already exists for this account.",
         },
         tags=["Authentication"],
@@ -140,7 +141,6 @@ def post(self, request):
             return Response(status=status.HTTP_400_BAD_REQUEST, data=result)
         try: 
             auth_object = Authentication.objects.get(username=request.user.username)
-
             if request.data in auth_object.auth_service:
                 return Response(
                     status=status.HTTP_409_CONFLICT,
@@ -150,7 +150,7 @@ def post(self, request):
             auth_object.save()
             return Response(
                 status=status.HTTP_200_OK,
-                data={"message": "Authentication added to existing object"}
+                data={"message": "New authentication credentials added to existing object"}
             )
 
         except Authentication.DoesNotExist:
@@ -161,7 +161,7 @@ def post(self, request):
             print('status=status.HTTP_201_CREATED')
             return Response(
                 status=status.HTTP_201_CREATED,
-                data={"message": "Authentication object added to account"}
+                data={"message": "Authentication object created and added to account"}
             )
 
         except Exception as err:

authentication/services.py

@@ -72,8 +72,14 @@ def validate_auth_service(value):
             "required": ["iss", "sub"],
             "additionalProperties": False,
             "properties": {
-                "iss": {"type": "string", "description": "The 'iss' (issuer) claim identifies the principal that issued the JWT."},
-                "sub": {"type": "string", "description": "The 'sub' (subject) claim identifies the principal that is the subject of the JWT."}
+                "iss": {
+                    "type": "string",
+                    "description": "The 'iss' (issuer) claim identifies the principal that issued the JWT."
+                },
+                "sub": {
+                    "type": "string",
+                    "description": "The 'sub' (subject) claim identifies the principal that is the subject of the JWT."
+                }
             }
         }
         try:

tests/fixtures/test_data.json

@@ -207,6 +207,19 @@
 			"change_message": "[]"
 		}
 	},
+	{
+		"model": "authentication.authentication",
+		"pk": 1,
+		"fields": {
+			"username": "bco_api_user",
+			"auth_service": [
+				{
+					"iss": "Reeya1",
+					"sub": "ReeyaGupta1"
+				}
+			]
+		}
+	},
 	{
 		"model": "auth.permission",
 		"pk": 1,

tests/test_views/test_api_auth_add.py

@@ -1,72 +1,60 @@
-##test for api/auth/add
-##07801a1a4cdbf1945e22ac8439f1db27fe813f7a
+#!/usr/bin/env python3
+
+"""Add Authentication
+Tests for 'New authentication credentials added to existing object' (200), 
+'Authentication credentials were created and added' (201), 'Bad request' (400),
+'That object already exists for this account' (409)
+"""
+
 from django.test import TestCase, Client
 from rest_framework.test import APIClient
 from rest_framework.authtoken.models import Token
 from django.contrib.auth.models import User
+from authentication.models import Authentication
 
 class AuthenticationTestCase(TestCase):
+    fixtures = ['tests/fixtures/test_data']
+
     def setUp(self):
         self.client = APIClient()
 
+    def test_credentials_created_response(self):
+        """Add authentication is successful (200)
+        """
 
-        # Creating a user for authentication
-        self.user = User.objects.create(username='testuser')
-
-        # Checking if user already has token, if not then creating one
-        if not Token.objects.filter(user=self.user).exists():
-            self.token = Token.objects.create(user=self.user)
-        else:
-            self.token = Token.objects.get(user=self.user)
-    def test_success_response(self):
-        # successfull request
-        data = {
-            "iss": "Reeya1",
-            "sub": "ReeyaGupta1"
-        }
+        token = Token.objects.get(user=User.objects.get(username='test50')).key
+        data = {"iss": "Reeya1","sub": "ReeyaGupta1"}
 
-        self.client.credentials(HTTP_AUTHORIZATION='Token ' + self.token.key)
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
         response = self.client.post('/api/auth/add/', data=data)
-        '''fails with "AssertionError: 201 != 200":
-        This test case is expecting a status code of 200 (OK) when making a successful request, 
-        but it receives a status code of 201 (Created) instead. It seems like the endpoint I am
-        testing is returning a 201 status code instead of the expected 200. To fix this, I 
-        updated the test case to expect a status code of 201.
-                '''
         self.assertEqual(response.status_code, 201)
 
-    def test_credentials_created_response(self):
-        # Simulate a request where authentication credentials were created and added
-        data = {
-            "iss": "Reeya1",
-            "sub": "ReeyaGupta1"
-        }
-        self.client.credentials(HTTP_AUTHORIZATION='Token ' + self.token.key)
-        response = self.client.post('/api/auth/add/', data=data)
-        self.assertEqual(response.status_code, 201)
+    def test_credentials_added(self):
+        """New authentication credentials added to existing object (200)
+        """
+
+        token = Token.objects.get(user=User.objects.get(username='bco_api_user')).key
+        data = {"iss": "new","sub": "new One"}
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
+        response = self.client.post('/api/auth/add/', data=data, format='json')
+        self.assertEqual(response.status_code, 200)
 
     def test_bad_request_response(self):
-        # bad request
-        data = {
-            # Missing required fields
-        }
-        self.client.credentials(HTTP_AUTHORIZATION='Token ' + self.token.key)
-        response = self.client.post('/api/auth/add/', data=data)
+        """Bad request (400)
+        """
+
+        token = Token.objects.get(user=User.objects.get(username='test50')).key
+        data = {"Missing required fields"}
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
+        response = self.client.post('/api/auth/add/', data=data, format='json')
         self.assertEqual(response.status_code, 400)
 
     def test_object_already_exists_response(self):
-        # an object that already exists for this account
-        data = {
-            "iss": "Reeya",
-            "sub": "ReeyaGupta"
-        }
-        self.client.credentials(HTTP_AUTHORIZATION='Token ' + self.token.key)
-        response = self.client.post('/api/auth/add/', data=data)
-        '''fails with "AssertionError: 201 != 409"
-        Similarly, this test case is expecting 409 (Conflict) when trying to
-         create an object that already exists, but it receives 201 (Created). 
-         This endpoint is not handling the object's existence as expected.
-        I updated the test case to expect a status code of 201 when creating an object
-         that already exists.
-        '''
-        self.assertEqual(response.status_code, 201)
+        """That object already exists for this account (409)
+        """
+
+        token = Token.objects.get(user=User.objects.get(username='bco_api_user')).key
+        data = {"iss": "Reeya1","sub": "ReeyaGupta1"}
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
+        response = self.client.post('/api/auth/add/', data=data, format='json')
+        self.assertEqual(response.status_code, 409)