xsoar-cli 1.0.4__tar.gz → 1.0.5__tar.gz

{xsoar_cli-1.0.4 → xsoar_cli-1.0.5}/.github/workflows/pull-request-open.yml

@@ -5,14 +5,18 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Setup Python 3.12
+      - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
 
       - name: Create and activate virtual environment
         run: |
@@ -21,7 +25,6 @@ jobs:
 
       - name: Install requirements
         run: |
-          pip install -r requirements.txt
           pip install -r requirements_dev.txt
 
       - name: Install xsoar-cli

{xsoar_cli-1.0.4 → xsoar_cli-1.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xsoar-cli
-Version: 1.0.4
+Version: 1.0.5
 Project-URL: Documentation, https://github.com/tlium/xsoar-cli#readme
 Project-URL: Issues, https://github.com/tlium/xsoar-cli/issues
 Project-URL: Source, https://github.com/tlium/xsoar-cli
@@ -9,10 +9,12 @@ License-Expression: MIT
 License-File: LICENSE.txt
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.12
+Requires-Python: <3.13,>=3.10
 Requires-Dist: click==8.1.8
 Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: xsoar-client>=1.0.0

{xsoar_cli-1.0.4 → xsoar_cli-1.0.5}/pyproject.toml

@@ -7,13 +7,15 @@ name = "xsoar-cli"
 dynamic = ["version"]
 description = ''
 readme = "README.md"
-requires-python = ">=3.12"
+requires-python = ">=3.10, <3.13"
 license = "MIT"
 keywords = []
 authors = [{ name = "Torbjørn Lium", email = "torben@lium.org" }]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",

{xsoar_cli-1.0.4 → xsoar_cli-1.0.5}/src/xsoar_cli/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2025-present Torbjørn Lium <torben@lium.org>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "1.0.4"
+__version__ = "1.0.5"

{xsoar_cli-1.0.4 → xsoar_cli-1.0.5}/src/xsoar_cli/case/commands.py

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING
 
 import click
 
-from xsoar_cli.utilities import load_config, validate_environments
+from xsoar_cli.utilities import load_config, parse_string_to_dict, validate_environments
 
 if TYPE_CHECKING:
     from xsoar_client.xsoar_client import Client
@@ -15,11 +15,13 @@ def case() -> None:
 
 
 @click.argument("casenumber", type=int)
-@click.option("--environment", default="dev", show_default=True, help="Environment as defined in config file")
+@click.option("--environment", default=None, help="Default environment set in config file.")
 @click.command(help="Get basic information about a single case in XSOAR")
 @click.pass_context
 @load_config
-def get(ctx: click.Context, casenumber: int, environment: str) -> None:
+def get(ctx: click.Context, casenumber: int, environment: str | None) -> None:
+    if not environment:
+        environment = ctx.obj["default_environment"]
     xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     response = xsoar_client.get_case(casenumber)
     if response["total"] == 0 and not response["data"]:
@@ -62,15 +64,31 @@ def clone(ctx: click.Context, casenumber: int, source: str, dest: str) -> None:
     click.echo(json.dumps(case_data, indent=4))
 
 
-@click.option("--environment", default="dev", show_default=True, help="Environment as defined in config file")
+@click.option("--environment", default=None, help="Default environment set in config file.")
 @click.option("--casetype", default="", show_default=True, help="Create case of specified type. Default type set in config file.")
+@click.option(
+    "--custom-fields",
+    default=None,
+    help='Additional fields on the form "myfield=my_value,anotherfield=another value". Use machine name for field names, e.g mycustomfieldname.',
+)
+@click.option("--custom-fields-delimiter", default=",", help='Delimiter when specifying additional fields. Default is ","')
 @click.argument("details", type=str, default="Placeholder case details")
 @click.argument("name", type=str, default="Test case created from xsoar-cli")
 @click.command()
 @click.pass_context
 @load_config
-def create(ctx: click.Context, environment: str, casetype: str, name: str, details: str) -> None:
+def create(  # noqa: PLR0913
+    ctx: click.Context,
+    environment: str | None,
+    casetype: str,
+    name: str,
+    custom_fields: str | None,
+    custom_fields_delimiter: str | None,
+    details: str,
+) -> None:
     """Creates a new case in XSOAR. If invalid case type is specified as a command option, XSOAR will default to using Unclassified."""
+    if not environment:
+        environment = ctx.obj["default_environment"]
     xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     if not casetype:
         casetype = ctx.obj["default_new_case_type"]
@@ -79,6 +97,7 @@ def create(ctx: click.Context, environment: str, casetype: str, name: str, detai
         "name": name,
         "type": casetype,
         "details": details,
+        "CustomFields": parse_string_to_dict(custom_fields, custom_fields_delimiter),
     }
     case_data = xsoar_client.create_case(data=data)
     case_id = case_data["id"]

{xsoar_cli-1.0.4 → xsoar_cli-1.0.5}/src/xsoar_cli/manifest/commands.py

@@ -39,13 +39,42 @@ def manifest() -> None:
     """Various commands to interact/update/deploy content packs defined in the xsoar_config.json manifest."""
 
 
-@click.option("--environment", default="dev", show_default=True, help="Environment as defined in config file")
+@click.option("--environment", default=None, help="Default environment set in config file.")
+@click.argument("manifest_path", type=str)
+@click.command()
+@click.pass_context
+@load_config
+def generate(ctx: click.Context, environment: str | None, manifest_path: str) -> None:
+    """Generate a new xsoar_config.json manifest from installed content packs.
+
+    This command assumes that you do not have any custom content packs uploaded to XSOAR.
+    All packs will be added as "marketplace_packs" in the manifest.
+    """
+    if not environment:
+        environment = ctx.obj["default_environment"]
+    xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
+    installed_packs = xsoar_client.get_installed_packs()
+    manifest_data = {
+        "marketplace_packs": [],
+    }
+    for item in installed_packs:
+        tmpobj = {
+            "id": item["id"],
+            "version": item["currentVersion"],
+        }
+        manifest_data["marketplace_packs"].append(tmpobj)
+    write_manifest(manifest_path, manifest_data)
+
+
+@click.option("--environment", default=None, help="Default environment set in config file.")
 @click.argument("manifest", type=str)
 @click.command()
 @click.pass_context
 @load_config
-def update(ctx: click.Context, environment: str, manifest: str) -> None:
+def update(ctx: click.Context, environment: str | None, manifest: str) -> None:
     """Update manifest on disk with latest available content pack versions."""
+    if not environment:
+        environment = ctx.obj["default_environment"]
     xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     manifest_data = load_manifest(manifest)
     click.echo("Fetching outdated packs from XSOAR server. This may take a minute...", nl=False)
@@ -81,14 +110,16 @@ def update(ctx: click.Context, environment: str, manifest: str) -> None:
     write_manifest(manifest, manifest_data)
 
 
-@click.option("--environment", default="dev", show_default=True, help="Environment as defined in config file")
+@click.option("--environment", default=None, help="Default environment set in config file.")
 @click.argument("manifest", type=str)
 @click.command()
 @click.pass_context
 @load_config
-def validate(ctx: click.Context, environment: str, manifest: str) -> None:
+def validate(ctx: click.Context, environment: str | None, manifest: str) -> None:
     """Validate manifest JSON and all pack availability. Validates upstream pack availability by doing HTTP CONNECT.
     Custom pack availability is implementation dependant."""
+    if not environment:
+        environment = ctx.obj["default_environment"]
     xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     manifest_data = load_manifest(manifest)
     click.echo("Manifest is valid JSON")
@@ -121,14 +152,16 @@ def validate(ctx: click.Context, environment: str, manifest: str) -> None:
     click.echo("Manifest is valid JSON and all packs are reachable.")
 
 
-@click.option("--environment", default="dev", show_default=True, help="Environment as defined in config file")
+@click.option("--environment", default=None, help="Default environment set in config file.")
 @click.argument("manifest", type=str)
 @click.command()
 @click.pass_context
 @load_config
-def diff(ctx: click.Context, manifest: str, environment: str) -> None:
+def diff(ctx: click.Context, manifest: str, environment: str | None) -> None:
     """Prints out the differences (if any) between what is defined in the xsoar_config.json manifest and what is actually
     installed on the XSOAR server."""
+    if not environment:
+        environment = ctx.obj["default_environment"]
     xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     manifest_data = load_manifest(manifest)
     installed_packs = xsoar_client.get_installed_packs()
@@ -147,14 +180,14 @@ def diff(ctx: click.Context, manifest: str, environment: str) -> None:
         click.echo("All packs up to date.")
 
 
-@click.option("--environment", default="dev", show_default=True, help="Environment as defined in config file")
+@click.option("--environment", default=None, help="Default environment set in config file.")
 @click.option("--verbose", is_flag=True, default=False)
 @click.option("--yes", is_flag=True, default=False)
 @click.command()
 @click.argument("manifest", type=str)
 @click.pass_context
 @load_config
-def deploy(ctx: click.Context, environment: str, manifest: str, verbose: bool, yes: bool) -> None:  # noqa: FBT001
+def deploy(ctx: click.Context, environment: str | None, manifest: str, verbose: bool, yes: bool) -> None:  # noqa: FBT001
     """
     Deploys content packs to the XSOAR server as defined in the xsoar_config.json manifest.
     The PATH argument expects the full or relative path to xsoar_config.json
@@ -169,7 +202,8 @@ def deploy(ctx: click.Context, environment: str, manifest: str, verbose: bool, y
         )
     if not should_continue:
         ctx.exit()
-
+    if not environment:
+        environment = ctx.obj["default_environment"]
     xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     manifest_data = load_manifest(manifest)
     click.echo("Fetching installed packs...", err=True)
@@ -198,3 +232,4 @@ manifest.add_command(deploy)
 manifest.add_command(diff)
 manifest.add_command(update)
 manifest.add_command(validate)
+manifest.add_command(generate)

{xsoar_cli-1.0.4 → xsoar_cli-1.0.5}/src/xsoar_cli/pack/commands.py

@@ -15,13 +15,15 @@ def pack(ctx: click.Context) -> None:
     """Various content pack related commands."""
 
 
-@click.option("--environment", default="dev", show_default=True, help="Environment as defined in config file")
+@click.option("--environment", default=None, help="Default environment set in config file.")
 @click.command()
 @click.argument("pack_id", type=str)
 @click.pass_context
 @load_config
-def delete(ctx: click.Context, environment: str, pack_id: str) -> None:
+def delete(ctx: click.Context, environment: str | None, pack_id: str) -> None:
     """Deletes a content pack from the XSOAR server."""
+    if not environment:
+        environment = ctx.obj["default_environment"]
     xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     if not xsoar_client.is_installed(pack_id=pack_id):
         click.echo(f"Pack ID {pack_id} is not installed. Cannot delete.")
@@ -30,12 +32,14 @@ def delete(ctx: click.Context, environment: str, pack_id: str) -> None:
     click.echo(f"Deleted pack {pack_id} from XSOAR {environment}")
 
 
-@click.option("--environment", default="dev", show_default=True, help="Environment as defined in config file")
+@click.option("--environment", default=None, help="Default environment set in config file.")
 @click.command()
 @click.pass_context
 @load_config
-def get_outdated(ctx: click.Context, environment: str) -> None:
+def get_outdated(ctx: click.Context, environment: str | None) -> None:
     """Prints out a list of outdated content packs."""
+    if not environment:
+        environment = ctx.obj["default_environment"]
     xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     click.echo("Fetching outdated packs. This may take a little while...", err=True)
     outdated_packs = xsoar_client.get_outdated_packs()

{xsoar_cli-1.0.4 → xsoar_cli-1.0.5}/src/xsoar_cli/playbook/commands.py

@@ -19,12 +19,12 @@ def playbook(ctx: click.Context) -> None:
     """Download/attach/detach playbooks"""
 
 
-@click.option("--environment", default="dev", show_default=True, help="Environment as defined in config file")
+@click.option("--environment", default=None, help="Default environment set in config file.")
 @click.command()
 @click.argument("name", type=str)
 @click.pass_context
 @load_config
-def download(ctx: click.Context, environment: str, name: str) -> None:
+def download(ctx: click.Context, environment: str | None, name: str) -> None:
     """Download and reattach playbook.
 
     We try to detect output path to $(cwd)/Packs/<Pack ID>/Playbooks/<name>.yml
@@ -32,7 +32,8 @@ def download(ctx: click.Context, environment: str, name: str) -> None:
     then demisto-sdk format --assume-yes --no-validate --no-graph is done on the downloaded playbook before the item
     is re-attached in XSOAR.
     """
-
+    if not environment:
+        environment = ctx.obj["default_environment"]
     xsoar_client: Client = ctx.obj["server_envs"][environment]
     # Maybe we should search for the playbook before attempting download in
     # case user specifies a cutsom playbook and not a system playbook

{xsoar_cli-1.0.4 → xsoar_cli-1.0.5}/src/xsoar_cli/plugins/README.md

@@ -346,7 +346,7 @@ def my_command(ctx: click.Context):
     # Access configuration
     config = ctx.obj
     # Access XSOAR clients
-    dev_client = ctx.obj["server_envs"]["dev"]
+    dev_client = ctx.obj["server_envs"]["dev"]["xsoar_client"]
 ```
 
 ### 5. Logging

{xsoar_cli-1.0.4 → xsoar_cli-1.0.5}/src/xsoar_cli/utilities.py

@@ -8,6 +8,16 @@ import click
 from xsoar_client.xsoar_client import Client
 
 
+def parse_string_to_dict(input_string: str | None, delimiter: str) -> dict:
+    if not input_string:
+        return {}
+    # Parse a string into a python dictionary
+    pairs = [pair.split("=", 1) for pair in input_string.split(delimiter)]
+    # Filter pairs that have exactly 2 parts (key and value) after splitting by "="
+    valid_pairs = [pair for pair in pairs if len(pair) == 2]
+    return {key.strip(): value.strip() for key, value in valid_pairs}
+
+
 def get_config_file_template_contents() -> dict:
     return {
         "default_environment": "dev",
@@ -67,7 +77,11 @@ def load_config(f: Callable) -> Callable:
             ctx.exit(1)
         config = get_config_file_contents(config_file_path)
         parse_config(config, ctx)
-        if "environment" in ctx.params and ctx.params["environment"] not in ctx.obj["server_envs"]:
+        if (
+            "environment" in ctx.params
+            and ctx.params["environment"] not in ctx.obj["server_envs"]
+            and ctx.params["environment"] is not None
+        ):
             click.echo(f"Invalid environment: {ctx.params['environment']}")
             click.echo(f"Available environments as defined in config file are: {list(ctx.obj['server_envs'])}")
             ctx.exit(1)