Fix catalog patch test

Author: jeff-schnitter

cortexapps_cli/commands/catalog.py

@@ -50,7 +50,11 @@ class CatalogCommandOptions:
     ]
     append_arrays = Annotated[
         Optional[bool],
-        typer.Option("--append-arrays", "-aa", help="Default merge behavior is to replace arrays, set this to true to append arrays instead. For simple types, duplicate values will be removed from the merged array", show_default=False)
+        typer.Option("--append-arrays", "-a", help="Default merge behavior is to replace arrays, set this to true to append arrays instead. For simple types, duplicate values will be removed from the merged array", show_default=False)
+    ]
+    fail_if_not_exist = Annotated[
+        Optional[bool],
+        typer.Option("--fail-if-not-exist", "-n", help="Default behavior is to upsert the entity, if set command will fail (404) if the entity specified in x-cortex-tag does not exist.", show_default=False)
     ]
     git_repositories = Annotated[
         Optional[str],
@@ -292,6 +296,7 @@ def patch(
     delete_marker_value = typer.Option("__delete__", "--delete-marker-value", "-dmv", help="Delete keys with this value from the merged yaml, defaults to __delete__, if any values match this, they will not be included in merged YAML. For example my_value: __delete__ will remove my_value from the merged YAML."),
     dry_run: CatalogCommandOptions.dry_run = False,
     append_arrays: CatalogCommandOptions.append_arrays = False,
+    fail_if_not_exist: CatalogCommandOptions.fail_if_not_exist = False,
 ):
     """
     Creates or updates an entity. If the YAML refers to an entity that already exists (as referenced by the x-cortex-tag), this API will merge the specified changes into the existing entity
@@ -301,7 +306,8 @@ def patch(
     params = {
         "dryRun":dry_run,
         "appendArrays": append_arrays,
-        "deleteMarkerValue": delete_marker_value
+        "deleteMarkerValue": delete_marker_value,
+        "failIfEntityDoesNotExist": fail_if_not_exist
     }
 
     r = client.patch("api/v1/open-api", data=file_input.read(), params=params, content_type="application/openapi;charset=UTF-8")

data/run-time/create-patch-entity.yaml …mport/catalog/cli-test-patch-entity.yamldata/run-time/create-patch-entity.yaml renamed to data/import/catalog/cli-test-patch-entity.yaml data/run-time/create-patch-entity.yaml renamed to data/import/catalog/cli-test-patch-entity.yaml

@@ -1,12 +1,11 @@
 openapi: 3.0.0
 info:
-  title: Patch Entity
+  title: CLI Test Patch Entity
   description: Entity that will be created to test catalog patch entity
-  x-cortex-tag: patch-entity
-  x-cortex-type: component
+  x-cortex-tag: cli-test-patch-entity
+  x-cortex-type: service
   x-cortex-groups:
-  - public-api-test
-  x-cortex-definition: {}
+  - cli-test
   x-cortex-custom-metadata:
     owners:
     - owner-1

data/run-time/patch-entity.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  x-cortex-tag: patch-entity
+  x-cortex-tag: cli-test-patch-entity
   x-cortex-custom-metadata:
     owners:
     - owner-2

tests/test_catalog_patch_entity.py

@@ -1,18 +1,7 @@
-from common import *
+from tests.helpers.utils import *
 
 def test(capsys):
-    cli(["-q", "catalog", "patch", "-f", "data/run-time/create-patch-entity.yaml"])
-    # Need to clear captured system output from the above commands to clear the way for the next one.
-    capsys.readouterr()
+    cli(["catalog", "patch", "-a", "-f", "data/run-time/patch-entity.yaml"])
 
-    response = cli_command(capsys, ["catalog", "descriptor", "-t", "patch-entity"])
-    assert response['info']['x-cortex-tag'] == "patch-entity"
-
-    # Need to clear captured system output from the above commands to clear the way for the next one.
-    capsys.readouterr()
-
-    cli(["-q", "catalog", "patch", "-a", "-f", "data/run-time/patch-entity.yaml"])
-    capsys.readouterr()
-
-    response = cli_command(capsys, ["custom-data", "get", "-t", "patch-entity", "-k", "owners"])
+    response = cli(["custom-data", "get", "-t", "cli-test-patch-entity", "-k", "owners"])
     assert 'owner-2' in response['value'], "owner-2 should have been merged in owners array"