fixed various testing issues with 'test_video_range_request', 'test_accept_ranges_header', and added a new test to ensure students are sending the correct Content-Type in responses to /api/login requests ('test_login_content_type')

tests/server_unit_test_pserv.py

@@ -1375,6 +1375,17 @@ class Access_Control(Doc_Print_Test_Case):
         # Close the HTTP connection
         self.session.close()
 
+    # =============================== Helpers ================================ #
+    # Does a lower-case search for headers within a response's headers. If
+    # found, the first ocurrence is returned (the header's value is returned).
+    def find_header(self, response, name):
+        for header in response.headers:
+            if header.lower() == name.lower():
+                return response.headers[header]
+        return None
+
+
+    # ================================ Tests ================================= #
     def test_access_control_private_valid_token(self):
         """ Test Name: test_access_control_private_valid_token
         Number Connections: N/A
@@ -1690,6 +1701,56 @@ class Access_Control(Doc_Print_Test_Case):
         self.assertEqual(response.status_code, requests.codes.not_found,
                          "Server did not respond with 404 when it should have, possible IDOR?")
 
+    def test_login_content_type(self):
+        """ Test Name: test_login_content_type
+        Number Connections: N/A
+        Procedure: Checks to ensure the Content-Type header is being sent in
+                   responses to GETs and POSTs to /api/login (both with AND
+                   without Cookie headers). A failure here means either:
+                    - 'Content-Type' is not a part of some or all of your /api/login responses, OR
+                    - The value of your 'Content-Type' header is not what it should be.
+        """
+        # inner helper function that takes a response and checks for the correct
+        # content-type header
+        def check_content_type(response):
+            # search for the content-type header and ensure we see "application/json"
+            content_type = self.find_header(response, "Content-Type")
+            content_expect = "application/json"
+            if content_type == None:
+                raise AssertionError("Server didn't respond with the Content-Type header when sent a GET request to /api/login")
+            if content_type.lower() != content_expect:
+                raise AssertionError("Server didn't respond with the correct Content-Type value when sent a GET request to /api/login. "
+                                     "Expected: '%s', received: '%s'" % (content_expect, content_type))
+
+        # first, we'll build the /api/login url
+        login_url = "http://%s:%s/api/login" % (self.hostname, self.port)
+
+        # TEST 1: send a simple GET /api/login with NO COOKIE
+        try:
+            response = self.session.get(login_url, timeout=2)
+            check_content_type(response)
+        except requests.exceptions.RequestException:
+            raise AssertionError("The server did not respond within 2s")
+
+        # TEST 2: try sending a POST /api/login with the correct credentials
+        try:
+            response = self.session.post(login_url,
+                                         json={'username': self.username, 'password': self.password},
+                                         timeout=2)
+            check_content_type(response)
+            # Ensure that the user is authenticated
+            self.assertEqual(response.status_code, requests.codes.ok, "Authentication failed.")
+        except requests.exceptions.RequestException:
+            raise AssertionError("The server did not respond within 2s")
+
+        # TEST 3: send one more GET /api/login with the cookie we just received
+        try:
+            response = self.session.get(login_url, timeout=2)
+            check_content_type(response)
+        except requests.exceptions.RequestException:
+            raise AssertionError("The server did not respond within 2s")
+        
+
 class Fallback(Doc_Print_Test_Case):
     """
     Test cases for HTML 5 fallback, using good requests that expect a
@@ -1933,7 +1994,7 @@ class Authentication(Doc_Print_Test_Case):
         pool = ThreadPool(30)
         pool.map(test_expiry_authentication, range(30))
         pool.terminate()
-
+ 
     def test_jwt_claims_json(self):
         """ Test Name: test_jwt_claims_json
         Number Connections: N/A
@@ -2252,7 +2313,7 @@ class VideoStreaming(Doc_Print_Test_Case):
             # make sure the correct status code was received
             if response.status_code != requests.codes.ok:
                 raise AssertionError("Server responded with %d instead of 200 OK when requested with %s" %
-                                     response.status_code, resource)
+                                     (response.status_code, resource))
             
             # search the header dictionary (lowercase comparison) for Accept-Ranges
             accept_ranges_expect = "bytes"
@@ -2266,7 +2327,8 @@ class VideoStreaming(Doc_Print_Test_Case):
 
         # if no occurrences were found, throw an error
         if occurrences == 0:
-            raise AssertionError("Failed to find the Accept-Ranges header in the server's responses.")
+            raise AssertionError("Failed to find the Accept-Ranges header in the server's responses. "
+                                 "Your server must send 'Accept-Ranges: bytes' in its HTTP responses when serving static files.")
 
     def test_video_get(self):
         """ Test Name: test_video_get
@@ -2329,7 +2391,7 @@ class VideoStreaming(Doc_Print_Test_Case):
         vidsize = os.path.getsize(self.vids[0])
         url = "http://%s:%s/%s" % (self.hostname, self.port, vid)
         # set up a few range request values to test with the video
-        ranges = [[0, 1], [0, 100], [300, 500], [1000, -1], [-1, 1000]]
+        ranges = [[0, 1], [0, 100], [300, 500], [1000, -1]]#, [-1, 1000]]
 
         # iterate across each range array to test each one
         for rg in ranges:
@@ -2347,21 +2409,22 @@ class VideoStreaming(Doc_Print_Test_Case):
                 prepared_req.url = url
                 response = self.session.send(prepared_req, timeout=2)
             except requests.exceptions.RequestException:
-                raise AssertionError("The server did not respond within 2s")
+                raise AssertionError("The server did not respond within 2s\nRange request sent: '%s'" % rgheader)
             
             # make sure the correct status code was received
             if response.status_code != requests.codes.partial_content:
-                raise AssertionError("Server responded with %d instead of 206 PARTIAL CONTENT when range-requested with a valid video" %
+                raise AssertionError("Server responded with %d instead of 206 PARTIAL CONTENT when range-requested with a valid video"
-                                     response.status_code)
+                                     "\nRange request sent: '%s'" % (response.status_code, rgheader))
             
             # check for the content-type header
             content_type = self.find_header(response, "Content-Type")
             content_expect = "video/mp4"
             if content_type == None:
-                raise AssertionError("Server didn't respond with the Content-Type header when requested with a valid video")
+                raise AssertionError("Server didn't respond with the Content-Type header when requested with a valid video"
+                                     "\nRange request sent: '%s'" % rgheader)
             if content_type.lower() != content_expect:
                 raise AssertionError("Server didn't respond with the correct Content-Type value when requested with a valid video. "
-                                    "Expected: %s, received: %s" % (content_expect, content_type))
+                                     "Expected: %s, received: %s\nRange request sent: '%s'" % (content_expect, content_type, rgheader))
     
             # check for the content-length header and make sure it's the correct
             # value based on the current range value we're trying
@@ -2372,27 +2435,29 @@ class VideoStreaming(Doc_Print_Test_Case):
             elif rg[1] == -1:
                 content_length_expect = vidsize - rg[0]
             if content_length == None:
-                raise AssertionError("Server didn't respond with the Content-Length header when requested with a valid video")
+                raise AssertionError("Server didn't respond with the Content-Length header when requested with a valid video"
+                                     "\nRange request sent: '%s'" % rgheader)
             if content_length != str(content_length_expect):
                 raise AssertionError("Server didn't respond with the correct Content-Length value when requested with a valid video. "
-                                    "Expected: %s, received: %s" % (content_length_expect, content_length))
+                                     "Expected: %s, received: %s\nRange request sent: '%s'" % (content_length_expect, content_length, rgheader))
 
             # check for the Content-Range header and make sure it's the correct
             # value
             content_range = self.find_header(response, "Content-Range")
             byte_start = rg[0] if rg[0] != -1 else vidsize - rg[1]
-            content_range_expect = "bytes %d-%d/%d" % (byte_start, byte_start + content_length_expect, vidsize)
+            content_range_expect = "bytes %d-%d/%d" % (byte_start, byte_start + content_length_expect - 1, vidsize)
             if content_range == None:
-                raise AssertionError("Server didn't respond with the Content-Range header when requested with a valid video")
+                raise AssertionError("Server didn't respond with the Content-Range header when requested with a valid video"
-            if content_type.lower() != content_expect:
+                                     "\nRange request sent: '%s'" % rgheader)
+            if content_range.lower() != content_range_expect:
                 raise AssertionError("Server didn't respond with the correct Content-Range value when requested with a valid video. "
-                                    "Expected: '%s', received: '%s'" % (content_range_expect, content_range))
+                                     "Expected: '%s', received: '%s'\nRange request sent: '%s'" % (content_range_expect, content_range, rgheader))
 
             # finally, we'll compare the actual bytes that were received. They
             # must match the exact bytes found in the original file
             if not self.compare_file_bytes(self.vids[0], response, byte_start, content_length_expect):
-                raise AssertionError("Server didn't send the correct bytes. Should have been bytes %d-%d" %
+                raise AssertionError("Server didn't send the correct bytes. Should have been bytes %d-%d"
-                                     (byte_start, byte_start + content_length_expect - 1))
+                                     "\nRange request sent: '%s'" % (byte_start, byte_start + content_length_expect - 1, rgheader))
 
 
 ###############################################################################