Added some more rest testing and make sure api version is valid.

Author: rouilj

roundup/rest.py

@@ -1730,27 +1730,34 @@ def dispatch(self, method, uri, input):
             pretty_output = True
 
         # check for @apiver in query string
+        msg=( "Unrecognized version: %s. "
+              "See /rest without specifying version "
+              "for supported versions." )
         try:
             if not self.api_version:
                 self.api_version = int(input['@apiver'].value)
         except KeyError:
             self.api_version = None
         except ValueError:
-            msg=( "Unrecognized version: %s. "
-                  "See /rest without specifying version "
-                  "for supported versions."%(
-                      input['@apiver'].value))
-            output = self.error_obj(400, msg)
+            output = self.error_obj(400, msg%input['@apiver'].value)
+
+        # by this time the API version is set. Error if we don't
+        # support it?
+        if self.api_version is None:
+            # FIXME: do we need to raise an error if client did not specify
+            # version? This may be a good thing to require. Note that:
+            # Accept: application/json; version=1 may not be legal but....
+            #    Use default if not specified for now.
+            self.api_version = self.__default_api_version
+        elif self.api_version not in self.__supported_api_versions:
+              raise UsageError(msg%self.api_version)
+
         # sadly del doesn't work on FieldStorage which can be the type of
-        #   input. So I have to ignore keys starting with @ at other
+        # input. So we have to ignore keys starting with @ at other
         # places in the code.
         # else:
         #     del(input['@apiver'])  
 
-        # FIXME: do we need to raise an error if client did not specify
-        # version? This may be a good thing to require. Note that:
-        # Accept: application/json; version=1 may not be legal but....
-
         # Call the appropriate method
         try:
             # If output was defined by a prior error

test/rest_common.py

@@ -954,9 +954,6 @@ def testDispatch(self):
         # TEST #5
         # POST: create new issue
         # no etag needed
-        # FIXME at some point we probably want to implement
-        # Post Once Only, so we need to add a Post Once Exactly
-        # test and a resubmit as well.
         etag = "not needed"
         body=b'{ "title": "foo bar", "priority": "critical" }'
         env = { "CONTENT_TYPE": "application/json",
@@ -986,6 +983,101 @@ def testDispatch(self):
         self.assertEqual(self.dummy_client.response_code, 200)
         self.assertEqual(results['data']['attributes']['title'],
                          'foo bar')
+
+        # TEST #6
+        # POST: an invalid class
+        # no etag needed
+        etag = "not needed"
+        body=b'{ "title": "foo bar", "priority": "critical" }'
+        env = { "CONTENT_TYPE": "application/json",
+                "CONTENT_LENGTH": len(body),
+                "REQUEST_METHOD": "POST"
+        }
+        headers={"accept": "application/json",
+                 "content-type": env['CONTENT_TYPE'],
+                 "content-length": len(body)
+        }
+        self.headers=headers
+        body_file=BytesIO(body)  # FieldStorage needs a file
+        form = client.BinaryFieldStorage(body_file,
+                                headers=headers,
+                                environ=env)
+        self.server.client.request.headers.get=self.get_header
+        results = self.server.dispatch('POST',
+                            "/rest/data/nonissue",
+                            form)
+
+        self.assertEqual(self.server.client.response_code, 404)
+        json_dict = json.loads(b2s(results))
+        status=json_dict['error']['status']
+        msg=json_dict['error']['msg']
+        self.assertEqual(status, 404)
+        self.assertEqual(msg, 'Class nonissue not found')
+
+        # TEST #7
+        # POST: status without key field of name
+        # also test that version spec in accept header is accepted
+        # no etag needed
+        etag = "not needed"
+        body=b'{ "order": 5 }'
+        env = { "CONTENT_TYPE": "application/json",
+                "CONTENT_LENGTH": len(body),
+                "REQUEST_METHOD": "POST"
+        }
+        headers={"accept": "application/json; version=1",
+                 "content-type": env['CONTENT_TYPE'],
+                 "content-length": len(body)
+        }
+        self.headers=headers
+        body_file=BytesIO(body)  # FieldStorage needs a file
+        form = client.BinaryFieldStorage(body_file,
+                                headers=headers,
+                                environ=env)
+        self.server.client.request.headers.get=self.get_header
+        self.db.setCurrentUser('admin') # must be admin to create status
+        results = self.server.dispatch('POST',
+                            "/rest/data/status",
+                            form)
+
+        self.assertEqual(self.server.client.response_code, 400)
+        json_dict = json.loads(b2s(results))
+        status=json_dict['error']['status']
+        msg=json_dict['error']['msg']
+        self.assertEqual(status, 400)
+        self.assertEqual(msg, "Must provide the 'name' property.")
+
+
+        # TEST #8
+        # DELETE: delete issue 1
+        etag = calculate_etag(self.db.issue.getnode("1"))
+        etagb = etag.strip ('"')
+        env = {"CONTENT_TYPE": "application/json",
+               "CONTENT_LEN": 0,
+               "REQUEST_METHOD": "DELETE" }
+        # use text/plain header and request json output by appending
+        # .json to the url.
+        headers={"accept": "text/plain",
+                 "content-type": env['CONTENT_TYPE'],
+                 "if-match": '"%s"'%etagb,
+                 "content-length": 0,
+        }
+        self.headers=headers
+        body_file=BytesIO(b'')  # FieldStorage needs a file
+        form = client.BinaryFieldStorage(body_file,
+                                headers=headers,
+                                environ=env)
+        self.server.client.request.headers.get=self.get_header
+        self.db.setCurrentUser('admin') # must be admin to delete issue
+        results = self.server.dispatch('DELETE',
+                            "/rest/data/issue/1.json",
+                            form)
+        self.assertEqual(self.server.client.response_code, 200)
+        json_dict = json.loads(b2s(results))
+        print(results)
+        status=json_dict['data']['status']
+        status=json_dict['data']['status']
+        self.assertEqual(status, 'ok')
+
         del(self.headers)
 
     def testPostPOE(self):
@@ -995,17 +1087,18 @@ def testPostPOE(self):
         import time
         # setup environment
         etag = "not needed"
-        body=b'{ "title": "foo bar", "priority": "critical" }'
+        empty_body=b''
         env = { "CONTENT_TYPE": "application/json",
-                "CONTENT_LENGTH": len(body),
+                "CONTENT_LENGTH": len(empty_body),
                 "REQUEST_METHOD": "POST"
         }
         headers={"accept": "application/json",
                  "content-type": env['CONTENT_TYPE'],
-                 "content-length": len(body)
+                 "content-length": len(empty_body)
         }
         self.headers=headers
-        body_file=BytesIO(body)  # FieldStorage needs a file
+        # use empty_body to test code path for missing/empty json
+        body_file=BytesIO(empty_body)  # FieldStorage needs a file
         form = client.BinaryFieldStorage(body_file,
                                 headers=headers,
                                 environ=env)
@@ -1024,6 +1117,20 @@ def testPostPOE(self):
         url = url[len(self.db.config['TRACKER_WEB'])-1:]
 
         ## create an issue using poe url.
+        body=b'{ "title": "foo bar", "priority": "critical" }'
+        env = { "CONTENT_TYPE": "application/json",
+                "CONTENT_LENGTH": len(body),
+                "REQUEST_METHOD": "POST"
+        }
+        headers={"accept": "application/json",
+                 "content-type": env['CONTENT_TYPE'],
+                 "content-length": len(body)
+        }
+        self.headers=headers
+        body_file=BytesIO(body)  # FieldStorage needs a file
+        form = client.BinaryFieldStorage(body_file,
+                                headers=headers,
+                                environ=env)
         self.server.client.request.headers.get=self.get_header
         results = self.server.dispatch('POST',
                             url,