Update content build retry test, update test setup

Author: dbkegley

tests/test_main_content.py

@@ -15,55 +15,63 @@
 
 from .utils import apply_common_args
 
-_bundle_download_dest = "download.tar.gz"
-_test_build_dir = "rsconnect-build-test"
+# These tests need to run in order because they share the same tempdir
+# For some reason setup and teardown aren't enough to fully reset the state
+# between tests. Overriding the env var CONNECT_CONTENT_BUILD_DIR to be a tempdir
+# would be preferable but this is fine for now.
+TEMP_DIR="rsconnect-build-test"
 
 def register_uris(connect_server: str):
+    def register_content_endpoints(i: int, guid: str):
+        httpretty.register_uri(
+            httpretty.GET,
+            f"{connect_server}/__api__/v1/content/{guid}",
+            body=open(f"tests/testdata/connect-responses/describe-content-{i}.json", "r").read(),
+            adding_headers={"Content-Type": "application/json"},
+        )
+        httpretty.register_uri(
+            httpretty.POST,
+            f"{connect_server}/__api__/v1/content/{guid}/build",
+            body='{"task_id": "1234"}',
+            adding_headers={"Content-Type": "application/json"},
+        )
+        httpretty.register_uri(
+            httpretty.GET,
+            f"{connect_server}/__api__/applications/{guid}/config",
+            body='{' +
+                f'"config_url": "{connect_server}/connect/#/apps/{guid}",' +
+                f'"logs_url": "{connect_server}/connect/#/apps/{guid}"' +
+            '}',
+            adding_headers={"Content-Type": "application/json"},
+        )
+
     httpretty.register_uri(
         httpretty.GET,
-        f"%s/__api__/server_settings" % (connect_server),
+        f"{connect_server}/__api__/server_settings",
         body=open("tests/testdata/connect-responses/server_settings.json", "r").read(),
         adding_headers={"Content-Type": "application/json"},
     )
     httpretty.register_uri(
         httpretty.GET,
-        f"%s/__api__/me" % (connect_server),
+        f"{connect_server}/__api__/me",
         body=open("tests/testdata/connect-responses/me.json", "r").read(),
         adding_headers={"Content-Type": "application/json"},
     )
     httpretty.register_uri(
         httpretty.GET,
-        f"%s/__api__/v1/content" % (connect_server),
+        f"{connect_server}/__api__/v1/content",
         body=open("tests/testdata/connect-responses/list-content.json", "r").read(),
         adding_headers={"Content-Type": "application/json"},
     )
     httpretty.register_uri(
         httpretty.GET,
-        f"%s/__api__/v1/content/7d59c5c7-c4a7-4950-acc3-3943b7192bc4" % (connect_server),
-        body=open("tests/testdata/connect-responses/describe-content-1.json", "r").read(),
-        adding_headers={"Content-Type": "application/json"},
-    )
-    httpretty.register_uri(
-        httpretty.GET,
-        f"%s/__api__/v1/content/ab497e4b-b706-4ae7-be49-228979a95eb4" % (connect_server),
-        body=open("tests/testdata/connect-responses/describe-content-2.json", "r").read(),
-        adding_headers={"Content-Type": "application/json"},
-    )
-    httpretty.register_uri(
-        httpretty.GET,
-        f"%s/__api__/v1/content/7d59c5c7-c4a7-4950-acc3-3943b7192bc4/bundles/92/download" % (connect_server),
+        f"{connect_server}/__api__/v1/content/7d59c5c7-c4a7-4950-acc3-3943b7192bc4/bundles/92/download",
         body=open("tests/testdata/bundle.tar.gz", "rb").read(),
         adding_headers={"Content-Type": "application/tar+gzip"},
     )
-    httpretty.register_uri(
-        httpretty.POST,
-        f"%s/__api__/v1/content/7d59c5c7-c4a7-4950-acc3-3943b7192bc4/build" % (connect_server),
-        body='{"task_id": "1234"}',
-        adding_headers={"Content-Type": "application/json"},
-    )
     httpretty.register_uri(
         httpretty.GET,
-        f"%s/__api__/tasks/1234" % (connect_server),
+        f"{connect_server}/__api__/tasks/1234",
         body="""{
             "id": "1234",
             "user_id": 0,
@@ -76,23 +84,15 @@ def register_uris(connect_server: str):
         }""",
         adding_headers={"Content-Type": "application/json"},
     )
-    httpretty.register_uri(
-        httpretty.GET,
-        f"%s/__api__/applications/7d59c5c7-c4a7-4950-acc3-3943b7192bc4/config" % (connect_server),
-        body="""{
-            "config_url": "http://localhost:3939/connect/#/apps/7d59c5c7-c4a7-4950-acc3-3943b7192bc4",
-            "logs_url": "http://localhost:3939/connect/#/apps/7d59c5c7-c4a7-4950-acc3-3943b7192bc4/logs"
-        }""",
-        adding_headers={"Content-Type": "application/json"},
-    )
+    register_content_endpoints(1, "7d59c5c7-c4a7-4950-acc3-3943b7192bc4")
+    register_content_endpoints(2, "ab497e4b-b706-4ae7-be49-228979a95eb4")
+    register_content_endpoints(3, "cdfed1f7-0e09-40eb-996d-0ef77ea2d797")
 
 class TestContentSubcommand(unittest.TestCase):
     @classmethod
     def tearDownClass(cls):
-        if os.path.exists(_bundle_download_dest):
-            os.remove(_bundle_download_dest)
-        if os.path.exists(_test_build_dir):
-            shutil.rmtree(_test_build_dir, ignore_errors=True)
+        if os.path.exists(TEMP_DIR):
+            shutil.rmtree(TEMP_DIR, ignore_errors=True)
 
     def setUp(self):
         self.connect_server = "http://localhost:3939"
@@ -138,11 +138,11 @@ def test_content_download_bundle(self):
         runner = CliRunner()
         args = ["content", "download-bundle",
                 "-g", "7d59c5c7-c4a7-4950-acc3-3943b7192bc4",
-                "-o", _bundle_download_dest]
+                "-o", f"{TEMP_DIR}/bundle.tar.gz"]
         apply_common_args(args, server=self.connect_server, key=self.api_key)
         result = runner.invoke(cli, args)
         self.assertEqual(result.exit_code, 0, result.output)
-        with tarfile.open(_bundle_download_dest, mode="r:gz") as tgz:
+        with tarfile.open(f"{TEMP_DIR}/bundle.tar.gz", mode="r:gz") as tgz:
             manifest = json.loads(tgz.extractfile("manifest.json").read())
             self.assertIn("metadata", manifest)
 
@@ -157,7 +157,7 @@ def test_build(self):
         result = runner.invoke(cli, args)
         self.assertEqual(result.exit_code, 0, result.output)
         self.assertTrue(
-            os.path.exists("%s/%s.json" % (_test_build_dir, _normalize_server_url(self.connect_server)))
+            os.path.exists("%s/%s.json" % (TEMP_DIR, _normalize_server_url(self.connect_server)))
         )
 
         # list the "tracked" content
@@ -186,34 +186,28 @@ def test_build(self):
         self.assertTrue(len(listing) == 1)
         self.assertEqual(listing[0]["rsconnect_build_status"], BuildStatus.COMPLETE)
 
+    @httpretty.activate(verbose=True, allow_net_connect=False)
     def test_build_retry(self):
         register_uris(self.connect_server)
         runner = CliRunner()
 
-        # add a content item
-        args = ["content", "build", "add", "-g", "7d59c5c7-c4a7-4950-acc3-3943b7192bc4"]
+        # add 3 content items
+        args = ["content", "build", "add",
+                "-g", "7d59c5c7-c4a7-4950-acc3-3943b7192bc4",
+                "-g", "ab497e4b-b706-4ae7-be49-228979a95eb4",
+                "-g", "cdfed1f7-0e09-40eb-996d-0ef77ea2d797"]
         apply_common_args(args, server=self.connect_server, key=self.api_key)
         result = runner.invoke(cli, args)
         self.assertEqual(result.exit_code, 0, result.output)
         self.assertTrue(
-            os.path.exists("%s/%s.json" % (_test_build_dir, _normalize_server_url(self.connect_server)))
+            os.path.exists("%s/%s.json" % (TEMP_DIR, _normalize_server_url(self.connect_server)))
         )
 
-        # list the "tracked" content
-        args = ["content", "build", "ls", "-g", "7d59c5c7-c4a7-4950-acc3-3943b7192bc4"]
-        apply_common_args(args, server=self.connect_server, key=self.api_key)
-        result = runner.invoke(cli, args)
-        self.assertEqual(result.exit_code, 0, result.output)
-        listing = json.loads(result.output)
-        self.assertTrue(len(listing) == 1)
-        self.assertEqual(listing[0]["guid"], "7d59c5c7-c4a7-4950-acc3-3943b7192bc4")
-        self.assertEqual(listing[0]["bundle_id"], "92")
-        self.assertEqual(listing[0]["rsconnect_build_status"], BuildStatus.NEEDS_BUILD)
-
-        # set the content build status to RUNNING so it looks like it was interrupted
-        # and the cleanup did not have time to finish, otherwise it would be marked as ABORTED
+        # change the content build status so it looks like it was interrupted/failed
         store = ContentBuildStore(RSConnectServer(self.connect_server, self.api_key))
         store.set_content_item_build_status("7d59c5c7-c4a7-4950-acc3-3943b7192bc4", BuildStatus.RUNNING)
+        store.set_content_item_build_status("ab497e4b-b706-4ae7-be49-228979a95eb4", BuildStatus.ABORTED)
+        store.set_content_item_build_status("cdfed1f7-0e09-40eb-996d-0ef77ea2d797", BuildStatus.ERROR)
 
         # run the build
         args = ["content", "build", "run", "--retry"]
@@ -222,25 +216,39 @@ def test_build_retry(self):
         self.assertEqual(result.exit_code, 0, result.output)
 
         # check that the build succeeded
-        args = ["content", "build", "ls", "-g", "7d59c5c7-c4a7-4950-acc3-3943b7192bc4"]
+        args = ["content", "build", "ls",
+                "-g", "7d59c5c7-c4a7-4950-acc3-3943b7192bc4",
+                "-g", "ab497e4b-b706-4ae7-be49-228979a95eb4",
+                "-g", "cdfed1f7-0e09-40eb-996d-0ef77ea2d797"]
         apply_common_args(args, server=self.connect_server, key=self.api_key)
         result = runner.invoke(cli, args)
         self.assertEqual(result.exit_code, 0, result.output)
         listing = json.loads(result.output)
-        self.assertTrue(len(listing) == 1)
+        self.assertTrue(len(listing) == 3)
         self.assertEqual(listing[0]["rsconnect_build_status"], BuildStatus.COMPLETE)
+        self.assertEqual(listing[1]["rsconnect_build_status"], BuildStatus.COMPLETE)
+        self.assertEqual(listing[2]["rsconnect_build_status"], BuildStatus.COMPLETE)
 
+    @httpretty.activate(verbose=True, allow_net_connect=False)
     def test_build_rm(self):
         register_uris(self.connect_server)
         runner = CliRunner()
 
-        # remove a content item
+        # remove all the content items
         args = ["content", "build", "rm", "-g", "7d59c5c7-c4a7-4950-acc3-3943b7192bc4"]
         apply_common_args(args, server=self.connect_server, key=self.api_key)
         result = runner.invoke(cli, args)
         self.assertEqual(result.exit_code, 0, result.output)
+        args = ["content", "build", "rm", "-g", "ab497e4b-b706-4ae7-be49-228979a95eb4"]
+        apply_common_args(args, server=self.connect_server, key=self.api_key)
+        result = runner.invoke(cli, args)
+        self.assertEqual(result.exit_code, 0, result.output)
+        args = ["content", "build", "rm", "-g", "cdfed1f7-0e09-40eb-996d-0ef77ea2d797"]
+        apply_common_args(args, server=self.connect_server, key=self.api_key)
+        result = runner.invoke(cli, args)
+        self.assertEqual(result.exit_code, 0, result.output)
 
-        # check that it was removed
+        # check that they were removed
         args = ["content", "build", "ls"]
         apply_common_args(args, server=self.connect_server, key=self.api_key)
         result = runner.invoke(cli, args)

tests/testdata/connect-responses/describe-content-3.json

@@ -0,0 +1,45 @@
+{
+  "guid": "cdfed1f7-0e09-40eb-996d-0ef77ea2d797",
+  "name": "plumbr-testing",
+  "title": "plumbr-testing",
+  "description": "",
+  "access_type": "acl",
+  "connection_timeout": null,
+  "read_timeout": null,
+  "init_timeout": null,
+  "idle_timeout": null,
+  "max_processes": null,
+  "min_processes": null,
+  "max_conns_per_process": null,
+  "load_factor": null,
+  "memory_request": null,
+  "memory_limit": null,
+  "cpu_request": null,
+  "cpu_limit": null,
+  "amd_gpu_limit": null,
+  "nvidia_gpu_limit": null,
+  "service_account_name": null,
+  "default_image_name": null,
+  "created_time": "2023-09-11T18:32:48Z",
+  "last_deployed_time": "2023-09-11T18:32:50Z",
+  "bundle_id": "17",
+  "app_mode": "api",
+  "content_category": "api",
+  "parameterized": false,
+  "cluster_name": "Local",
+  "image_name": null,
+  "r_version": "4.3.0",
+  "py_version": null,
+  "quarto_version": null,
+  "r_environment_management": true,
+  "default_r_environment_management": null,
+  "py_environment_management": null,
+  "default_py_environment_management": null,
+  "run_as": null,
+  "run_as_current_user": false,
+  "owner_guid": "820f092f-d564-4ab5-819a-0f4d2f03d11e",
+  "content_url": "http://localhost:3939/content/cdfed1f7-0e09-40eb-996d-0ef77ea2d797/",
+  "dashboard_url": "http://localhost:3939/connect/#/apps/cdfed1f7-0e09-40eb-996d-0ef77ea2d797",
+  "app_role": "owner",
+  "id": "12"
+}