Marking deprecated methods using old device-run api

Author: lastverb

testdroid/__init__.py

@@ -569,32 +569,51 @@ def get_test_run(self, project_id, test_run_id):
 
         return self.get("me/projects/%s/runs/%s" % (project_id, test_run_id))
 
-    def retry_test_run(self, project_id, test_run_id, device_run_ids=None):
-        """ Re-run an already-existing test run. Specify individual device run IDs to only re-run those devices. """
+    def retry_test_run(self, project_id, test_run_id, device_session_ids=None):
+        """ Re-run an already-existing test run. Specify individual device session IDs to only re-run those devices. """
 
         endpoint = "me/projects/%s/runs/%s/retry" % (project_id, test_run_id)
-        if device_run_ids:
-            endpoint += "?deviceRunIds[]=" + "&deviceRunIds[]=".join(str(device_id) for device_id in device_run_ids)
+        if device_session_ids:
+            endpoint += "?deviceRunIds[]=" + "&deviceRunIds[]=".join(str(device_id) for device_id in device_session_ids)
         return self.post(endpoint)
 
     def abort_test_run(self, project_id, test_run_id):
         """ Abort a test run """
 
         return self.post("me/projects/%s/runs/%s/abort" % (project_id, test_run_id))
 
+    def get_device_sessions(self, project_id, test_run_id, limit=0):
+        """ Return device sessions for a project """
+
+        return self.get(path="me/projects/%s/runs/%s/device-sessions" %
+                             (project_id, test_run_id), payload={'limit': limit})
+
     def get_device_runs(self, project_id, test_run_id, limit=0):
-        """ Return device runs for a project """
+        """ ***DEPRECATED***
+
+            Return device sessions for a project
+            use get_device_sessions() instead
+        """
 
-        return self.get(path="me/projects/%s/runs/%s/device-runs" % (project_id, test_run_id), payload={'limit': limit})
+        return self.get_device_sessions(project_id, test_run_id, limit)
+
+    def get_device_session_screenshots_list(self, project_id, test_run_id, device_session_id, limit=0):
+        """ Downloads screenshots list for a device session """
+
+        return self.get("me/projects/%s/runs/%s/device-sessions/%s/screenshots" %
+                        (project_id, test_run_id, device_session_id), payload={'limit': limit})
 
     def get_device_run_screenshots_list(self, project_id, test_run_id, device_run_id, limit=0):
-        """ Downloads screenshots list for a device run """
+        """ ***DEPRECATED***
 
-        return self.get("me/projects/%s/runs/%s/device-runs/%s/screenshots" % (project_id, test_run_id, device_run_id),
-                        payload={'limit': limit})
+            Downloads screenshots list for a device run
+            use get_device_run_screenshots_list() instead
+        """
 
-    def get_device_run_files(self, project_id, test_run_id, device_session_id, tags=None):
-        """ Get list of files for device run """
+        return self.get_device_session_screenshots_list(project_id, test_run_id, device_run_id, limit)
+
+    def get_device_session_files(self, project_id, test_run_id, device_session_id, tags=None):
+        """ Get list of files for device session """
 
         if tags is None:
             return self.get("me/projects/%s/runs/%s/device-sessions/%s/output-file-set/files" %
@@ -603,6 +622,15 @@ def get_device_run_files(self, project_id, test_run_id, device_session_id, tags=
             return self.get("me/projects/%s/runs/%s/device-sessions/%s/output-file-set/files?tag[]=%s" %
                             (project_id, test_run_id, device_session_id, tags))
 
+    def get_device_run_files(self, project_id, test_run_id, device_session_id, tags=None):
+        """ ***DEPRECATED***
+
+            Get list of files for device run
+            use get_device_session_files() instead
+        """
+
+        return self.get_device_session_files(project_id, test_run_id, device_session_id, tags)
+
     def get_input_files(self, limit=0):
         """ Get list of input files """
 
@@ -612,25 +640,25 @@ def download_test_run(self, project_id, test_run_id):
         """ Downloads test run files to a directory hierarchy """
 
         test_run = self.get_test_run(project_id, test_run_id)
-        device_runs = self.get_device_runs(project_id, test_run_id)
+        device_sessions = self.get_device_sessions(project_id, test_run_id)
 
         logger.info("")
-        logger.info("Test run %s: \"%s\" has %s device runs:" %
-                    (test_run['id'], test_run['displayName'], len(device_runs['data'])))
+        logger.info("Test run %s: \"%s\" has %s device sessions:" %
+                    (test_run['id'], test_run['displayName'], len(device_sessions['data'])))
 
-        for device_run in device_runs['data']:
-            state = device_run['state']
+        for device_session in device_sessions['data']:
+            state = device_session['state']
             logger.info("")
-            logger.info("%s \"%s\" %s" % (device_run['id'], device_run['device']['displayName'], state))
+            logger.info("%s \"%s\" %s" % (device_session['id'], device_session['device']['displayName'], state))
 
             if state in ("ABORTED", "TIMEOUT", "WARNING", "SUCCEEDED", "FAILED", "EXCLUDED"):
-                directory = "%s-%s/%d-%s" % (test_run_id, test_run['displayName'], device_run['id'],
-                                             device_run['device']['displayName'])
-                session_id = device_run['id']
-                files = self.get_device_run_files(project_id, test_run_id, session_id)
+                directory = "%s-%s/%d-%s" % (test_run_id, test_run['displayName'], device_session['id'],
+                                             device_session['device']['displayName'])
+                session_id = device_session['id']
+                files = self.get_device_session_files(project_id, test_run_id, session_id)
                 self.__download_files(files, directory)
             else:
-                logger.info("Device run is not ended - Skipping file downloads")
+                logger.info("Device session hasn't ended - Skipping file downloads")
                 logger.info("")
 
     def __download_files(self, files, directory):
@@ -654,18 +682,19 @@ def download_test_screenshots(self, project_id, test_run_id):
         """ Downloads test run screenshots """
 
         test_run = self.get_test_run(project_id, test_run_id)
-        device_runs = self.get_device_runs(project_id, test_run_id)
-        logger.info("Test run %s: \"%s\" has %s device runs:" %
-                    (test_run['id'], test_run['displayName'], len(device_runs['data'])))
-        for device_run in device_runs['data']:
-            logger.info("%s \"%s\" %s" % (device_run['id'], device_run['device']['displayName'], device_run['state']))
+        device_sessions = self.get_device_sessions(project_id, test_run_id)
+        logger.info("Test run %s: \"%s\" has %s device sessions:" %
+                    (test_run['id'], test_run['displayName'], len(device_sessions['data'])))
+        for device_session in device_sessions['data']:
+            logger.info("%s \"%s\" %s" %
+                        (device_session['id'], device_session['device']['displayName'], device_session['state']))
 
         logger.info("")
-        for device_run in device_runs['data']:
-            if device_run['state'] in ["SUCCEEDED", "FAILED", "ABORTED", "WARNING", "TIMEOUT"]:
+        for device_session in device_sessions['data']:
+            if device_session['state'] in ["SUCCEEDED", "FAILED", "ABORTED", "WARNING", "TIMEOUT"]:
                 directory = "%s-%s/%d-%s/screenshots" % (test_run['id'], test_run['displayName'],
-                                                         device_run['id'], device_run['device']['displayName'])
-                screenshots = self.get_device_run_screenshots_list(project_id, test_run_id, device_run['id'])
+                                                         device_session['id'], device_session['device']['displayName'])
+                screenshots = self.get_device_session_screenshots_list(project_id, test_run_id, device_session['id'])
                 no_screenshots = True
 
                 for screenshot in screenshots['data']:
@@ -675,7 +704,7 @@ def download_test_screenshots(self, project_id, test_run_id):
                         os.makedirs(directory)
 
                     if not os.path.exists(full_path):
-                        self.__download_screenshot(project_id, test_run['id'], device_run['id'], screenshot['id'],
+                        self.__download_screenshot(project_id, test_run['id'], device_session['id'], screenshot['id'],
                                                    full_path)
                     else:
                         ''' Earlier downloaded images are checked, and if needed re-downloaded.
@@ -686,18 +715,18 @@ def download_test_screenshots(self, project_id, test_run_id):
                             else:
                                 raise
                         except:
-                            self.__download_screenshot(project_id, test_run['id'], device_run['id'], screenshot['id'],
-                                                       full_path)
+                            self.__download_screenshot(project_id, test_run['id'], device_session['id'],
+                                                       screenshot['id'], full_path)
 
                 if no_screenshots:
-                    logger.info("Device %s has no screenshots - skipping" % device_run['device']['displayName'])
+                    logger.info("Device %s has no screenshots - skipping" % device_session['device']['displayName'])
             else:
                 logger.info("Device %s has errored or has not finished - skipping" %
-                            device_run['device']['displayName'])
+                            device_session['device']['displayName'])
 
-    def __download_screenshot(self, project_id, test_run_id, device_run_id, screenshot_id, full_path):
-        url = "me/projects/%s/runs/%s/device-runs/%s/screenshots/%s" % \
-              (project_id, test_run_id, device_run_id, screenshot_id)
+    def __download_screenshot(self, project_id, test_run_id, device_session_id, screenshot_id, full_path):
+        url = "me/projects/%s/runs/%s/device-sessions/%s/screenshots/%s" % \
+              (project_id, test_run_id, device_session_id, screenshot_id)
         prog = DownloadProgressBar()
         self.download(url, full_path, callback=lambda pos, total: prog.update(int(pos), int(total)))
         print("")
@@ -740,7 +769,7 @@ def get_access_group_resources(self, access_group_id):
     def get_access_group_resource(self, access_group_id, resource_id):
         """ Get resource from access group """
 
-        return self.get("ame/ccess-groups/{}/resources/{}".format(access_group_id, resource_id))
+        return self.get("me/access-groups/{}/resources/{}".format(access_group_id, resource_id))
 
     def delete_access_group_resource(self, access_group_id, resource_id):
         """ Delete resource from access group """
@@ -795,7 +824,6 @@ def format_epilog(self, formatter):
         usage = "usage: %prog [options] <command> [arguments...]"
         description = "Client for Bitbar Cloud API v2"
         epilog = """
-
 Commands:
 
     me                                          Get user details
@@ -824,15 +852,17 @@ def format_epilog(self, formatter):
     wait-test-run <project-id> <test-run-id>    Await completion (polling) of the test run
     test-runs <project-id>                      Get test runs for a project
     test-run <project-id> <test-run-id>         Get test run details
-    device-runs <project-id> <test-run-id>      Get device runs for a test run
+    get_device_sessions <project-id> <test-run-id>      
+                                                Get device sessions for a test run
+    device-runs <project-id> <test-run-id>      ***DEPRECATED*** Get device runs for a test run
     download-test-run <project-id> <test-run-id>
                                                 Download test run data. Data will be downloaded to
                                                 current directory in a structure:
-                                                [test-run-id]/[device-run-id]-[device-name]/files...
+                                                [test-run-id]/[device-session-id]-[device-name]/files...
     download-test-screenshots <project-id> <test-run-id>
                                                 Download test run screenshots. Screenshots will be downloaded to
                                                 current directory in a structure:
-                                                [test-run-id]/[device-run-id]-[device-name]/screenshots/...
+                                                [test-run-id]/[device-session-id]-[device-name]/screenshots/...
 
     access-groups                               Get access groups
     access-group <access-group-id>              Get an access group by id
@@ -901,6 +931,8 @@ def get_commands(self):
             "wait-test-run": self.wait_test_run,
             "test-run": self.get_test_run,
             "test-runs": self.print_project_test_runs,
+            "device-sessions": self.get_device_sessions,
+            "device-session-files": self.get_device_session_files,
             "device-runs": self.get_device_runs,
             "device-run-files": self.get_device_run_files,
             "list-input-files": self.print_input_files,

testdroid/tests/test_all.py

@@ -9,7 +9,6 @@
 JSON = {'k': 'v'}
 PROJECT_ID = 2
 TEST_RUN_ID = 3
-DEVICE_RUN_ID = 4
 DEVICE_SESSION_ID = 5
 DEVICE_GROUP_ID = 6
 USER_ID = 7
@@ -112,20 +111,6 @@ def test_get_project(self):
         response = t.get_project(PROJECT_ID)
         self.assertEqual(response, JSON)
 
-    @responses.activate
-    def test_get_project_parameters(self):
-        url = '{}/projects/{}/config/parameters'.format(URL_API_ME, PROJECT_ID)
-        responses.add(responses.GET, url, json=JSON, status=200)
-        response = t.get_project_parameters(PROJECT_ID)
-        self.assertEqual(response, JSON)
-
-    @responses.activate
-    def test_get_project_config(self):
-        url = '{}/projects/{}/config'.format(URL_API_ME, PROJECT_ID)
-        responses.add(responses.GET, url, json=JSON, status=200)
-        response = t.get_project_config(PROJECT_ID)
-        self.assertEqual(response, JSON)
-
     @responses.activate
     def test_get_project_test_runs(self):
         url = '{}/projects/{}/runs'.format(URL_API_ME, PROJECT_ID)
@@ -135,87 +120,44 @@ def test_get_project_test_runs(self):
 
     @responses.activate
     def test_get_test_run(self):
-        url = '{}/projects/{}/runs/{}'.format(URL_API_ME, PROJECT_ID,
-                                              TEST_RUN_ID)
+        url = '{}/projects/{}/runs/{}'.format(URL_API_ME, PROJECT_ID, TEST_RUN_ID)
         responses.add(responses.GET, url, json=JSON, status=200)
         response = t.get_test_run(PROJECT_ID, TEST_RUN_ID)
         self.assertEqual(response, JSON)
 
     @responses.activate
-    def test_get_device_runs(self):
-        url = '{}/projects/{}/runs/{}/device-runs'.format(
-            URL_API_ME, PROJECT_ID, TEST_RUN_ID)
+    def test_get_device_session(self):
+        url = '{}/projects/{}/runs/{}/device-sessions'.format(URL_API_ME, PROJECT_ID, TEST_RUN_ID)
         responses.add(responses.GET, url, json=JSON, status=200)
-        response = t.get_device_runs(PROJECT_ID, TEST_RUN_ID)
+        response = t.get_device_sessions(PROJECT_ID, TEST_RUN_ID)
         self.assertEqual(response, JSON)
 
     @responses.activate
-    def test_get_device_run_screenshots_list(self):
-        url = '{}/projects/{}/runs/{}/device-runs/{}/screenshots'.format(
-            URL_API_ME, PROJECT_ID, TEST_RUN_ID, DEVICE_RUN_ID)
+    def test_get_device_session_screenshots_list(self):
+        url = '{}/projects/{}/runs/{}/device-sessions/{}/screenshots'.format(
+            URL_API_ME, PROJECT_ID, TEST_RUN_ID, DEVICE_SESSION_ID)
         responses.add(responses.GET, url, json=JSON, status=200)
-        response = t.get_device_run_screenshots_list(PROJECT_ID, TEST_RUN_ID,
-                                                     DEVICE_RUN_ID)
+        response = t.get_device_session_screenshots_list(PROJECT_ID, TEST_RUN_ID, DEVICE_SESSION_ID)
         self.assertEqual(response, JSON)
 
     @responses.activate
-    def test_get_device_run_files_without_tags(self):
+    def test_get_device_sessions_files_without_tags(self):
         url = '{}/projects/{}/runs/{}/device-sessions/{}/output-file-set/files'.format(
             URL_API_ME, PROJECT_ID, TEST_RUN_ID, DEVICE_SESSION_ID)
         responses.add(responses.GET, url, json=JSON, status=200)
-        response = t.get_device_run_files(PROJECT_ID, TEST_RUN_ID,
-                                          DEVICE_SESSION_ID)
+        response = t.get_device_session_files(PROJECT_ID, TEST_RUN_ID, DEVICE_SESSION_ID)
         self.assertEqual(response, JSON)
 
     @responses.activate
-    def test_get_device_run_files_with_tags(self):
+    def test_get_device_session_files_with_tags(self):
         url = '{}/projects/{}/runs/{}/device-sessions/{}/output-file-set/files?tag[]={}'.format(
             URL_API_ME, PROJECT_ID, TEST_RUN_ID, DEVICE_SESSION_ID, TAGS)
         responses.add(responses.GET, url, json=JSON, status=200)
-        response = t.get_device_run_files(PROJECT_ID, TEST_RUN_ID,
-                                          DEVICE_SESSION_ID, TAGS)
+        response = t.get_device_session_files(PROJECT_ID, TEST_RUN_ID, DEVICE_SESSION_ID, TAGS)
         self.assertEqual(response, JSON)
 
     @responses.activate
     def test_get_input_files(self):
-        url = '{}/files?limit={}&filter=s_direction_eq_INPUT'.format(
-            URL_API_ME, LIMIT)
+        url = '{}/files?limit={}&filter=s_direction_eq_INPUT'.format(URL_API_ME, LIMIT)
         responses.add(responses.GET, url, json=JSON, status=200)
         self.assertEqual(t.get_input_files(LIMIT), JSON)
-
-    @responses.activate
-    def test_start_test_run(self):
-        url = '{}/projects/2'.format(
-            URL_API_ME)
-        json = {
-            'id': USER_ID,
-            'name': 'Sample project',
-        }
-
-        responses.add(responses.GET, url, json=json, status=200)
-
-        responses.add(responses.GET, URL_API_ME, json=json, status=200)
-
-        url = '{}/projects/{}/runs'.format(
-            URL_USERS, PROJECT_ID)
-        json = {
-            'id': 12,
-            'displayName': "My test run"
-        }
-
-        responses.add(responses.POST, url, json=json, status=201)
-        self.assertEqual(t.start_test_run(PROJECT_ID, DEVICE_GROUP_ID), json['id'])
-
-    @responses.activate
-    def test_delete_project_parameters(self):
-        path = 'projects/{}/config/parameters/{}'.format(PROJECT_ID, PARAM_ID)
-        url = '{}/{}'.format(URL_USERS, path)
-
-        json = {
-            'id': USER_ID
-        }
-
-        responses.add(responses.GET, URL_API_ME, json=json, status=200)
-        responses.add(responses.DELETE, url, json=JSON, status=204)
-        response = t.delete_project_parameters(PROJECT_ID, PARAM_ID)
-        self.assertEqual(response.status_code, 204)