Added tests

Changes to be committed:
	modified:   search/apis.py
	new file:   tests/test_views/test_api_objects.py
	modified:   tests/test_views/test_api_objects_search.py

Author: HadleyKing

search/apis.py

@@ -56,7 +56,7 @@ class SearchObjectsAPI(APIView):
           )
         ],
         responses={
-            200: ""
+            200: "Search successfull"
         },
         tags=["BCO Management"],
     )

tests/test_views/test_api_objects.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+
+"""Search the BCODB
+Tests for endpoint for use of query string based search.
+    Four parameters are defined by this API: 
+    1. contents: Search in the contents of the BCO
+    2. prefix: BCO Prefix to search
+    3. owner_user: Search by BCO owner
+    4. object_id: BCO object_id to search for
+"""
+
+from django.test import TestCase
+from rest_framework.test import APIClient
+from rest_framework.authtoken.models import Token
+from django.contrib.auth.models import User
+from rest_framework.test import APITestCase
+
+class ObjectsTestCase(APITestCase):
+    fixtures = ['tests/fixtures/test_data']
+
+    def setUp(self):
+        self.client = APIClient()
+
+    def test_search_contents(self):
+        """Search successfull. 200
+        """
+
+        token = Token.objects.get(user=User.objects.get(username='bco_api_user')).key
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
+        response = self.client.get('http://localhost:8000/api/objects/?contents=review')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()[0]), 12)
+
+    def test_search_prefix(self):
+        """Search successfull. 200
+        """
+
+        token = Token.objects.get(user=User.objects.get(username='bco_api_user')).key
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
+        response = self.client.get('http://localhost:8000/api/objects/?prefix=TEST')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()[0]), 2)
+
+    def test_search_owner_user(self):
+        """Search successfull. 200
+        """
+
+        token = Token.objects.get(user=User.objects.get(username='bco_api_user')).key
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
+        response = self.client.get('http://localhost:8000/api/objects/?owner_user=test50')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()[0]), 4)
+
+    def test_search_object_id(self):
+        """Search successfull. 200
+        """
+
+        token = Token.objects.get(user=User.objects.get(username='bco_api_user')).key
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
+        response = self.client.get('http://localhost:8000/api/objects/?object_id=DRAFT')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()[0]), 6)
+
+    def test_search_all(self):
+        """Search successfull. 200
+        """
+
+        token = Token.objects.get(user=User.objects.get(username='bco_api_user')).key
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
+        response = self.client.get('http://localhost:8000/api/objects/?')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()[0]), 12)
+
+    def test_search_multi_value(self):
+        """Search successfull. 200
+        """
+
+        token = Token.objects.get(user=User.objects.get(username='bco_api_user')).key
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
+        response = self.client.get('http://localhost:8000/api/objects/?contents=HCV&contents=DRAFT')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()[0]), 2)

tests/test_views/test_api_objects_search.py

@@ -11,27 +11,18 @@
 from django.contrib.auth.models import User
 from rest_framework.test import APITestCase
 
+#TODO: this needs refinement
 class ObjectsSearchTestCase(APITestCase):
 
     fixtures = ['tests/fixtures/test_data']
     def setUp(self):
-        
         self.client = APIClient()
-                # Checking if the user 'bco_api_user' already exists
-        try:
-            self.user = User.objects.get(username='bco_api_user')
-        except User.DoesNotExist:
-            self.user = User.objects.create_user(username='bco_api_user')
-
-        # 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_search_successful(self):
-        # Test case for a successful search (status code: 200)
+        """Test case for a successful search (status code: 200)
+        """
 
+        token = Token.objects.get(user=User.objects.get(username='bco_api_user')).key
         data = {
             "POST_api_objects_search": [
                 {
@@ -40,16 +31,15 @@ def test_search_successful(self):
                 }
             ]
         }
-        self.client.credentials(HTTP_AUTHORIZATION='Token ' + self.token.key)
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
         response = self.client.post("/api/objects/search/", data=data, format="json")
-
         self.assertEqual(response.status_code, 200)
 
-
-
     def test_prefix_not_found(self):
-        # Test case for prefix not found (status code: 404)
+        """Test case for prefix not found (status code: 404)
+        """
 
+        token = Token.objects.get(user=User.objects.get(username='bco_api_user')).key
         data = {
             "POST_api_objects_search": [
                 {
@@ -59,6 +49,6 @@ def test_prefix_not_found(self):
             ]
         }
 
-        self.client.credentials(HTTP_AUTHORIZATION='Token ' + self.token.key)
+        self.client.credentials(HTTP_AUTHORIZATION='Token ' + token)
         response = self.client.post("/api/objects/search/", data=data, format="json")
         self.assertEqual(response.status_code, 404)