Merge branch 'typer' of github.com:cortexapps/cli into typer

Author: jeff-schnitter

.github/workflows/validate-pr.yml

@@ -21,12 +21,17 @@ Release History
 - plugins `get-by-tag` subcommand changed to `get`
 - `resource-definitions` command changed to `entity-types`
 
+0.27.0 (2025-01-04)
+------------------
+
+**Improvements**
+- Add support for catalog patch command.
+
 0.26.7 (2024-11-18)
 ------------------
 
 **Bugfixes**
 - Fix dryRun query parameter for catalog create command.
->>>>>>> main
 
 0.26.6 (2024-07-30)
 ------------------

HISTORY.md

@@ -597,7 +597,8 @@ def debug_json(r, method):
         print(json_data, file=sys.stderr)
 
 def exit(r, method, expected_rc=200, err=None):
-    if r.status_code != expected_rc:
+    # Quick fix for catalog patch; will fix with typer change.
+    if r.status_code != expected_rc and r.status_code != 201:
         sys.stderr.write(r.reason + "\n")
         if r.status_code == 401:
             if config['config_file'] == "ENVIRONMENT":
@@ -689,6 +690,17 @@ def post(url, headers={}, payload="", expected_rc=200):
         err = e.response.text
     exit(r, 'POST', expected_rc, err)
 
+def patch(url, headers={}, payload="", expected_rc=200):
+    api_key(headers)
+
+    err = None
+    try:
+        r = requests.patch(config['url'] + url, headers=headers,data=payload)
+        r.raise_for_status()
+    except requests.exceptions.RequestException as e:
+        err = e.response.text
+    exit(r, 'PATCH', expected_rc, err)
+
 # Generate HTTP API options.  Everything in the Namespace argparse object is
 # added to the URL with the exception of those listed in the array below.
 def parse_opts(args, ignore_tags=[]):
@@ -972,6 +984,7 @@ def subparser_catalog_opts(subparsers):
     subparser_catalog_gitops_logs(sp)
     subparser_catalog_list(sp)
     subparser_catalog_list_descriptors(sp)
+    subparser_catalog_patch(sp)
     subparser_catalog_scorecard_scores(sp)
     subparser_catalog_unarchive(sp)
 
@@ -1148,6 +1161,52 @@ def subparser_catalog_details(subparser):
 def catalog_details(args):
     get("/api/v1/catalog/" + args.tag + parse_opts(args))
 
+def subparser_catalog_patch(subparser):
+    sp = subparser.add_parser(
+            'patch',
+            help='Creates or updates an entity using OpenAPI. 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.')
+    add_argument_file(sp, 'File containing openapi descriptor for entity')
+    sp.add_argument(
+            '-m',
+            '--delete-marker-value',
+            dest='deleteMarkerValue',
+            help='Delete keys with this value from the merged yaml, e.g. __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.',
+            required=False,
+            default="__delete__",
+            metavar=''
+    )
+    sp.add_argument(
+            '-d',
+            '--dry-run',
+            dest="dryRun",
+            help='When true, this endpoint only validates the descriptor contents and returns any errors or warnings.',
+            action='store_true',
+            default='false'
+    )
+    sp.add_argument(
+            '-a',
+            '--append-arrays',
+            dest="appendArrays",
+            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',
+            action='store_true',
+            default='false'
+    )
+    sp.add_argument(
+            '-n',
+            '--fail-if-entity-does-not-exist',
+            dest="failIfEntityDoesNotExist",
+            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.',
+            action='store_true',
+            default='false'
+    )
+    sp.set_defaults(func=catalog_patch)
+
+def catalog_patch(args):
+    patch(
+        "/api/v1/open-api" + parse_opts(args),
+        default_headers('application/openapi'), read_file(args)
+    )
+
 def subparser_catalog_scorecard_scores(subparser):
     sp = subparser.add_parser('scorecard-scores', help='Retrieve entity Scorecard scores')
     add_argument_tag(sp)

cortexapps_cli/cortex.py

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

data/run-time/create-patch-entity.yaml

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

data/run-time/patch-entity.yaml

@@ -3,4 +3,4 @@
 #@pytest.mark.skip(reason="Disabled until CET-15982 is resolved.")
 def test():
     result = cli(["audit-logs", "get"])
-    assert (len(result['logs']) > 0)
+    assert (len(result['logs']) > 0)

tests/test_audit_logs.py

@@ -3,4 +3,4 @@
 #@pytest.mark.skip(reason="Disabled until CET-15982 is resolved.")
 def test():
     result = cli(["audit-logs", "get", "-p", "0"])
-    assert (len(result['logs']) > 0)
+    assert (len(result['logs']) > 0)

tests/test_audit_logs_page.py

@@ -3,4 +3,4 @@
 #@pytest.mark.skip(reason="Disabled until CET-15982 is resolved.")
 def test():
     result = cli(["audit-logs", "get", "-p", "0", "-z", "1"])
-    assert (len(result['logs']) == 1)
+    assert (len(result['logs']) == 1)

tests/test_audit_logs_size.py

@@ -4,4 +4,4 @@
 def test():
     start_date = yesterday()
     result = cli(["audit-logs", "get", "-s", start_date])
-    assert (len(result['logs']) > 0)
+    assert (len(result['logs']) > 0)

tests/test_audit_logs_start_date.py

@@ -0,0 +1,18 @@
+from common 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()
+
+    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"])
+    assert 'owner-2' in response['value'], "owner-2 should have been merged in owners array"