Add tests for unsupported

- change how mocks are declared
- introduce test_utils

Author: labkey-nicka

test/mock_server_responses.py

@@ -21,63 +21,45 @@
 except ImportError:
     import unittest.mock as mock
 
-from labkey.utils import create_server_context
 from labkey.experiment import load_batch, save_batch, Batch, Run
 from labkey.exceptions import RequestError, QueryNotFoundError, ServerNotFoundError, RequestAuthorizationError
-from mock_server_responses import MockLoadBatch, MockSaveBatch
 
+from test_utils import MockLabKey, mock_server_context, success_test, throws_error_test
 
-def success_test(test, expected_response, api_method, *args, **expected_kwargs):
-    with mock.patch('labkey.utils.requests.Session.post') as mock_post:
-        mock_post.return_value = expected_response
-        resp = api_method(*args)
 
-        # validate call is made as expected
-        expected_args = expected_kwargs.pop('expected_args')
-        mock_post.assert_called_once_with(*expected_args, **expected_kwargs)
+class MockLoadBatch(MockLabKey):
+    api = 'getAssayBatch.api'
+    default_action = 'assay'
+    default_success_body = {"assayId": 2809, "batch": {"lsid": "urn:lsid:labkey.com:Experiment.Folder-1721:465ad7db-58d8-1033-a587-7eb0c02c2efe", "createdBy": "", "created": "2015/10/19 18:21:57", "name": "python batch", "modified": "2015/10/19 18:21:57", "modifiedBy": "", "comment": None, "id": 120, "runs": [{"dataOutputs": [], "dataRows": [{"Treatment Group": None, "Start Date": None, "Height _inches_": None, "Comments": None, "Status of Infection": None, "Country": None, "Gender": None, "Group Assignment": None, "Participant ID": None, "Date": None}, {"Treatment Group": None, "Start Date": None, "Height _inches_": None, "Comments": None, "Status of Infection": None, "Country": None, "Gender": None, "Group Assignment": None, "Participant ID": None, "Date": None}, {"Treatment Group": None, "Start Date": None, "Height _inches_": None, "Comments": None, "Status of Infection": None, "Country": None, "Gender": None, "Group Assignment": None, "Participant ID": None, "Date": None}], "dataInputs": [], "created": "2015/10/19 18:21:57", "materialInputs": [{"lsid": "urn:lsid:labkey.com:AssayRunMaterial.Folder-1721:Unknown", "role": "Sample", "created": "2015/10/19 18:21:57", "name": "Unknown", "modified": "2015/10/19 18:21:57", "id": 7641}], "lsid": "urn:lsid:labkey.com:GeneralAssayRun.Folder-1721:465ad7dd-58d8-1033-a587-7eb0c02c2efe", "materialOutputs": [], "createdBy": "", "name": "python upload", "modified": "2015/10/19 18:21:57", "modifiedBy": "", "comment": None, "id": 1526, "properties": {}}], "properties": {"ParticipantVisitResolver": None, "TargetStudy": None}}}
 
 
-def throws_error_test(test, expected_error, expected_response, api_method, *args, **expected_kwargs):
-    with mock.patch('labkey.utils.requests.Session.post') as mock_post:
-        with test.assertRaises(expected_error):
-            mock_post.return_value = expected_response
-            api_method(*args)
+class MockSaveBatch(MockLabKey):
+    api = 'saveAssayBatch.api'
+    default_action = 'assay'
+    default_success_body = {"batches": [{"lsid": "urn:lsid:labkey.com:Experiment.Folder-1721:50666e45-609f-1033-ba4a-ca4935e31f28", "createdBy": "", "created": "2015/10/29 12:17:50", "name": "python batch 7", "modified": "2015/10/29 12:17:51", "modifiedBy": "", "comment": None, "id": 139, "runs": [{"dataOutputs": [], "dataRows": [{"Treatment Group": None, "Start Date": None, "Height _inches_": None, "Comments": None, "Status of Infection": None, "Country": None, "Gender": None, "Group Assignment": None, "Participant ID": None, "Date": None}, {"Treatment Group": None, "Start Date": None, "Height _inches_": None, "Comments": None, "Status of Infection": None, "Country": None, "Gender": None, "Group Assignment": None, "Participant ID": None, "Date": None}, {"Treatment Group": None, "Start Date": None, "Height _inches_": None, "Comments": None, "Status of Infection": None, "Country": None, "Gender": None, "Group Assignment": None, "Participant ID": None, "Date": None}], "dataInputs": [], "created": "2015/10/29 12:17:50", "materialInputs": [{"lsid": "urn:lsid:labkey.com:AssayRunMaterial.Folder-1721:Unknown", "role": "Sample", "created": "2015/10/19 18:21:57", "name": "Unknown", "modified": "2015/10/19 18:21:57", "id": 7641}], "lsid": "urn:lsid:labkey.com:GeneralAssayRun.Folder-1721:50666e47-609f-1033-ba4a-ca4935e31f28", "materialOutputs": [], "createdBy": "", "name": "python upload", "modified": "2015/10/29 12:17:51", "modifiedBy": "", "comment": None, "id": 1673, "properties": {}}], "properties": {"ParticipantVisitResolver": None, "TargetStudy": None}}], "assayId": 2809}
 
-        # validate call is made as expected
-        expected_args = expected_kwargs.pop('expected_args')
-        mock_post.assert_called_once_with(*expected_args, **expected_kwargs)
-
-
-configs = {
-    'protocol': 'https://'
-    , 'server': 'my_testServer:8080'
-    , 'context_path': 'testPath'
-    , 'project_path': 'testProject/subfolder'
-}
 
 assay_id = 12345
 batch_id = 54321
-server_context = create_server_context(configs['server'], configs['project_path'], configs['context_path'])
 
 
 class TestLoadBatch(unittest.TestCase):
 
     def setUp(self):
-        self.configs = configs.copy()
-        self.service = MockLoadBatch(**self.configs)
+        self.service = MockLoadBatch()
         self.expected_kwargs = {
             'expected_args': [self.service.get_server_url()]
             , 'data': '{"assayId": 12345, "batchId": 54321}'
             , 'headers': {'Content-type': 'application/json', 'Accept': 'text/plain'}
         }
 
         self.args = [
-            server_context, assay_id, batch_id
+            mock_server_context(self.service), assay_id, batch_id
         ]
 
     def test_success(self):
         test = self
-        success_test(test, self.service.get_successful_response(), load_batch, *self.args, **self.expected_kwargs)
+        success_test(test, self.service.get_successful_response(), load_batch, False, *self.args, **self.expected_kwargs)
 
     def test_unauthorized(self):
         test = self
@@ -104,35 +86,34 @@ class TestSaveBatch(unittest.TestCase):
 
     def setUp(self):
 
-        dataRows = []
+        data_rows = []
 
         # Generate the Run object(s)
-        runTest = Run()
-        runTest.name = 'python upload'
-        runTest.data_rows = dataRows
-        runTest.properties['RunFieldName'] = 'Run Field Value'
+        run = Run()
+        run.name = 'python upload'
+        run.data_rows = data_rows
+        run.properties['RunFieldName'] = 'Run Field Value'
 
         # Generate the Batch object(s)
         batch = Batch()
-        batch.runs = [runTest]
+        batch.runs = [run]
         # batch.name = 'python batch'
         batch.properties['PropertyName'] = 'Property Value'
 
-        self.configs = configs.copy()
-        self.service = MockSaveBatch(**self.configs)
+        self.service = MockSaveBatch()
         self.expected_kwargs = {
             'expected_args': [self.service.get_server_url()]
             , 'data': '{"assayId": 12345, "batches": [{"batchProtocolId": 0, "comment": null, "created": null, "createdBy": null, "lsid": null, "modified": null, "modifiedBy": null, "name": null, "properties": {"PropertyName": "Property Value"}, "runs": [{"comment": null, "created": null, "createdBy": null, "dataInputs": [], "dataRows": [], "experiments": [], "filePathRoot": null, "lsid": null, "materialInputs": [], "materialOutputs": [], "modified": null, "modifiedBy": null, "name": "python upload", "properties": {"RunFieldName": "Run Field Value"}}]}]}'
             , 'headers': {'Content-type': 'application/json', 'Accept': 'text/plain'}
         }
 
         self.args = [
-            server_context, assay_id, batch
+            mock_server_context(self.service), assay_id, batch
         ]
 
     def test_success(self):
         test = self
-        success_test(test, self.service.get_successful_response(), save_batch, *self.args, **self.expected_kwargs)
+        success_test(test, self.service.get_successful_response(), save_batch, False, *self.args, **self.expected_kwargs)
 
     def test_unauthorized(self):
         test = self
@@ -163,4 +144,4 @@ def suite():
     ])
 
 if __name__ == '__main__':
-    unittest.main()
+    unittest.main()

test/test_experiment_api.py

@@ -18,10 +18,12 @@
 
 from test_experiment_api import suite as exp_suite
 from test_query_api import suite as query_suite
+from test_unsupported import suite as unsupported_suite
 
 if __name__ == '__main__':
     all_tests = unittest.TestSuite([
         exp_suite(),
-        query_suite()
+        query_suite(),
+        unsupported_suite()
     ])
-    unittest.TextTestRunner().run(all_tests)
+    unittest.TextTestRunner().run(all_tests)