cortexapps-cli 1.14.0__tar.gz → 1.15.0__tar.gz

{cortexapps_cli-1.14.0 → cortexapps_cli-1.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cortexapps-cli
-Version: 1.14.0
+Version: 1.15.0
 Summary: Command Line Interface for cortexapps
 License: MIT
 License-File: LICENSE
@@ -480,105 +480,6 @@ This recipe creates YAML files for each Workflow.  This may be helpful if you ar
        cortex workflows get --tag $workflow --yaml > $workflow.yaml
     done
 
------------------------------------------------------------------------------
-Obfuscating a Cortex export
------------------------------------------------------------------------------
-
-This script will obfuscate a Cortex backup.  This can be helpful for on-premise customers who may need to provide data to Cortex to help identify performance or usability issues.
-
-.. code:: bash
-
-   # Works off an existing cortex CLI backup.
-   # - Create a backup with cortex CLI command: cortex backup export -z 10000
-   set -e
-   input=$1
-   output=$2
-
-   all_file=${output}/all.yaml
-   obfuscated_file=${output}/obfuscated.yaml
-
-   echo "Output directory: ${output}"
-   translate_file="${output}/translate.csv"
-
-   if [ ! -d ${output} ]; then
-      mkdir -p ${output}
-   fi
-
-   for yaml in `ls -1 ${input}/catalog/*`
-   do
-      entity=$(yq ${yaml} | yq ".info.x-cortex-tag")
-      new_entity=$(echo ${entity} | md5sum | cut -d' ' -f 1)
-      echo "${entity},${new_entity}" >> ${translate_file}
-      echo "Creating: $new_entity"
-      cat ${yaml} |\
-         yq ".info.\"x-cortex-tag\" = \"${new_entity}\" | \
-             .info.title=\"${new_entity}\" | \
-             del(.info.description) | \
-             del(.info.\"x-cortex-link\") | \
-             del(.info.\"x-cortex-links\") | \
-             del(.info.\"x-cortex-groups\") | \
-             del(.info.\"x-cortex-custom-metadata\") | \
-             del(.info.\"x-cortex-issues\") | \
-             del(.info.\"x-cortex-git\") | \
-             del(.info.\"x-cortex-slack\") | \
-             del(.info.\"x-cortex-oncall\") | \
-             with(.info; \
-                select(.\"x-cortex-team\".members != null) | .\"x-cortex-team\".members = {\"name\": \"Cortex User\", \"email\": \"user@example.com\"} \
-                 )" >> ${all_file}
-      echo "---" >> ${all_file}
-   done
-
-   # The longer strings are translated first preventing substrings from being replaced in a longer string
-   cat ${translate_file} | sort -r > ${translate_file}.tmp && echo "entity,new_entity" > ${translate_file} && cat ${translate_file}.tmp >> ${translate_file} && rm ${translate_file}.tmp
-
-   python3 - ${all_file} ${translate_file} ${obfuscated_file} << EOF
-   import csv
-   import re
-   import sys
-
-   yaml_file = sys.argv[1]
-   translate_file = sys.argv[2]
-   output = sys.argv[3]
-
-   with open(yaml_file, 'r') as f:
-        bytes = f.read() # read entire file as bytes
-        with open(translate_file, newline='') as csvfile:
-            reader = csv.DictReader(csvfile)
-            for row in reader:
-                entity = row['entity']
-                new_entity = row['new_entity']
-                print("entity = " + entity + ", new_entity = " + new_entity)
-                bytes = bytes.replace("tag: " + entity, "tag: " + new_entity)
-                bytes = bytes.replace("name: " + entity, "name: " + new_entity)
-
-   f = open(output, "w")
-   f.write(bytes)
-   f.close()
-   EOF
-
-   # change all email addresses
-   sed -i 's/email:.*/email: user@example.com/' ${obfuscated_file}
-
-   # change all slack channel names
-   sed -i 's/channel:.*/channel: my-slack-channel/' ${obfuscated_file}
-
-   # copy export directory to new directory, without catalog YAML
-   rsync -av --exclude='catalog' ${input}/ ${output}
-   mkdir -p ${output}/catalog
-
-   # now split single file into multiple that can be passed as parameter to cortex catalog create -f
-   cd ${output}/catalog
-   yq --no-doc -s '"file_" + $index' ${obfuscated_file}
-
-   # tar it up
-   tar_file=$(basename ${output}).tar
-   cd ${output}
-   rm ${all_file}
-   rm ${translate_file} 
-   tar -cvf ${tar_file} ./*
-
-   echo "Created: ${output}/${tar_file}"
-
 ====================================
 
 .. |PyPI download month| image:: https://img.shields.io/pypi/dm/cortexapps-cli.svg

{cortexapps_cli-1.14.0 → cortexapps_cli-1.15.0}/README.rst

@@ -453,105 +453,6 @@ This recipe creates YAML files for each Workflow.  This may be helpful if you ar
        cortex workflows get --tag $workflow --yaml > $workflow.yaml
     done
 
------------------------------------------------------------------------------
-Obfuscating a Cortex export
------------------------------------------------------------------------------
-
-This script will obfuscate a Cortex backup.  This can be helpful for on-premise customers who may need to provide data to Cortex to help identify performance or usability issues.
-
-.. code:: bash
-
-   # Works off an existing cortex CLI backup.
-   # - Create a backup with cortex CLI command: cortex backup export -z 10000
-   set -e
-   input=$1
-   output=$2
-
-   all_file=${output}/all.yaml
-   obfuscated_file=${output}/obfuscated.yaml
-
-   echo "Output directory: ${output}"
-   translate_file="${output}/translate.csv"
-
-   if [ ! -d ${output} ]; then
-      mkdir -p ${output}
-   fi
-
-   for yaml in `ls -1 ${input}/catalog/*`
-   do
-      entity=$(yq ${yaml} | yq ".info.x-cortex-tag")
-      new_entity=$(echo ${entity} | md5sum | cut -d' ' -f 1)
-      echo "${entity},${new_entity}" >> ${translate_file}
-      echo "Creating: $new_entity"
-      cat ${yaml} |\
-         yq ".info.\"x-cortex-tag\" = \"${new_entity}\" | \
-             .info.title=\"${new_entity}\" | \
-             del(.info.description) | \
-             del(.info.\"x-cortex-link\") | \
-             del(.info.\"x-cortex-links\") | \
-             del(.info.\"x-cortex-groups\") | \
-             del(.info.\"x-cortex-custom-metadata\") | \
-             del(.info.\"x-cortex-issues\") | \
-             del(.info.\"x-cortex-git\") | \
-             del(.info.\"x-cortex-slack\") | \
-             del(.info.\"x-cortex-oncall\") | \
-             with(.info; \
-                select(.\"x-cortex-team\".members != null) | .\"x-cortex-team\".members = {\"name\": \"Cortex User\", \"email\": \"user@example.com\"} \
-                 )" >> ${all_file}
-      echo "---" >> ${all_file}
-   done
-
-   # The longer strings are translated first preventing substrings from being replaced in a longer string
-   cat ${translate_file} | sort -r > ${translate_file}.tmp && echo "entity,new_entity" > ${translate_file} && cat ${translate_file}.tmp >> ${translate_file} && rm ${translate_file}.tmp
-
-   python3 - ${all_file} ${translate_file} ${obfuscated_file} << EOF
-   import csv
-   import re
-   import sys
-
-   yaml_file = sys.argv[1]
-   translate_file = sys.argv[2]
-   output = sys.argv[3]
-
-   with open(yaml_file, 'r') as f:
-        bytes = f.read() # read entire file as bytes
-        with open(translate_file, newline='') as csvfile:
-            reader = csv.DictReader(csvfile)
-            for row in reader:
-                entity = row['entity']
-                new_entity = row['new_entity']
-                print("entity = " + entity + ", new_entity = " + new_entity)
-                bytes = bytes.replace("tag: " + entity, "tag: " + new_entity)
-                bytes = bytes.replace("name: " + entity, "name: " + new_entity)
-
-   f = open(output, "w")
-   f.write(bytes)
-   f.close()
-   EOF
-
-   # change all email addresses
-   sed -i 's/email:.*/email: user@example.com/' ${obfuscated_file}
-
-   # change all slack channel names
-   sed -i 's/channel:.*/channel: my-slack-channel/' ${obfuscated_file}
-
-   # copy export directory to new directory, without catalog YAML
-   rsync -av --exclude='catalog' ${input}/ ${output}
-   mkdir -p ${output}/catalog
-
-   # now split single file into multiple that can be passed as parameter to cortex catalog create -f
-   cd ${output}/catalog
-   yq --no-doc -s '"file_" + $index' ${obfuscated_file}
-
-   # tar it up
-   tar_file=$(basename ${output}).tar
-   cd ${output}
-   rm ${all_file}
-   rm ${translate_file} 
-   tar -cvf ${tar_file} ./*
-
-   echo "Created: ${output}/${tar_file}"
-
 ====================================
 
 .. |PyPI download month| image:: https://img.shields.io/pypi/dm/cortexapps-cli.svg

{cortexapps_cli-1.14.0 → cortexapps_cli-1.15.0}/cortexapps_cli/commands/entity_relationships.py

@@ -5,7 +5,7 @@ from cortexapps_cli.utils import print_output_with_context
 from cortexapps_cli.command_options import CommandOptions, ListCommandOptions
 
 app = typer.Typer(
-    help="Entity Relationships commands (Beta)",
+    help="Entity Relationships commands",
     no_args_is_help=True
 )
 

{cortexapps_cli-1.14.0 → cortexapps_cli-1.15.0}/cortexapps_cli/commands/workflows.py

@@ -7,7 +7,7 @@ import typer
 import yaml
 
 app = typer.Typer(
-    help="Workflows commands",
+    help="Workflows commands (Beta)",
     no_args_is_help=True
 )
 
@@ -142,3 +142,80 @@ def create(
         raise typer.BadParameter("Input file is neither valid JSON nor YAML.")
 
     r = client.post("api/v1/workflows", data=data, content_type=content_type)
+
+@app.command()
+def run(
+    ctx: typer.Context,
+    tag: str = typer.Option(..., "--tag", "-t", help="The tag or unique identifier for the workflow"),
+    scope: str = typer.Option("GLOBAL", "--scope", "-s", help="Scope type: GLOBAL or ENTITY"),
+    entity: str = typer.Option(None, "--entity", "-e", help="Entity tag (required when scope is ENTITY)"),
+    run_as: str = typer.Option(None, "--run-as", help="Email of user to run the workflow as"),
+    context: str = typer.Option(None, "--context", "-x", help="JSON string for initialContext"),
+    context_file: Annotated[typer.FileText, typer.Option("--context-file", help="JSON file for initialContext")] = None,
+    wait: bool = typer.Option(False, "--wait", "-w", help="Poll until the run completes"),
+    timeout: int = typer.Option(300, "--timeout", help="Max seconds to wait when --wait is used"),
+):
+    """
+    (Beta) Run a workflow.  API key must have the Run workflows permission.
+    The workflow must have isRunnableViaApi set to true.
+    """
+    import time as time_module
+
+    client = ctx.obj["client"]
+
+    # Build scope payload
+    if scope.upper() == "ENTITY":
+        if not entity:
+            raise typer.BadParameter("--entity is required when --scope is ENTITY")
+        scope_payload = {"type": "ENTITY", "entityId": entity}
+    else:
+        scope_payload = {"type": "GLOBAL"}
+
+    # Build request body
+    body = {"scope": scope_payload}
+
+    if run_as:
+        body["runAs"] = run_as
+
+    # Handle initialContext from --context or --context-file
+    if context and context_file:
+        raise typer.BadParameter("Cannot specify both --context and --context-file")
+    if context:
+        body["initialContext"] = json.loads(context)
+    elif context_file:
+        body["initialContext"] = json.load(context_file)
+
+    r = client.post(f"api/v1/workflows/{tag}/runs", data=body)
+
+    if not wait:
+        print_output(r)
+        return
+
+    # Poll until completed or timeout
+    run_id = r.get("id")
+    if not run_id:
+        print_output(r)
+        return
+
+    start = time_module.time()
+    while time_module.time() - start < timeout:
+        time_module.sleep(2)
+        r = client.get(f"api/v1/workflows/{tag}/runs/{run_id}")
+        status = r.get("status", "").upper()
+        if status in ("COMPLETED", "FAILED", "CANCELLED"):
+            break
+
+    print_output(r)
+
+@app.command("get-run")
+def get_run(
+    ctx: typer.Context,
+    tag: str = typer.Option(..., "--tag", "-t", help="The tag or unique identifier for the workflow"),
+    run_id: str = typer.Option(..., "--run-id", "-r", help="The run ID"),
+):
+    """
+    (Beta) Get details of a workflow run.  API key must have the View workflow runs permission.
+    """
+    client = ctx.obj["client"]
+    r = client.get(f"api/v1/workflows/{tag}/runs/{run_id}")
+    print_output(r)

{cortexapps_cli-1.14.0 → cortexapps_cli-1.15.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "cortexapps-cli"
 # version will be incremented via command line as part of github actions build
-version = "1.14.0"
+version = "1.15.0"
 description = "Command Line Interface for cortexapps"
 license = "MIT"
 authors = [
@@ -27,7 +27,7 @@ click = "<8.2"
 cortex = "cortexapps_cli.cli:app"
 
 [tool.poetry.group.test.dependencies]
-pytest = "^8.2.2"
+pytest = "^9.0.3"
 pytest-cov = "^5.0.0"
 
 
@@ -45,13 +45,3 @@ Homepage = "https://github.com/cortexapps/cli"
 "Bug Tracker" = "https://github.com/cortexapps/cli/issues"
 "Changes" = " https://github.com/cortexapps/cli/blob/main/HISTORY.md"
 "Documentation" = " https://github.com/cortexapps/cli/blob/main/README.rst"
-
-[tool.pytest.ini_options]
-markers = [
-    "serial"
-]
-minversion = "7.4.3"
-addopts = "--cov=cortexapps_cli --cov-append --cov-report term-missing"
-testpaths = [
-    "tests"
-]