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

{xsoar_cli-1.0.3 → xsoar_cli-1.0.4}/.github/workflows/release.yml

@@ -1,12 +1,8 @@
 name: release
 
 on:
-  push:
-    tags:
-      - "[0-9]+.[0-9]+.[0-9]+"
-      - "[0-9]+.[0-9]+.[0-9]+a[0-9]+"
-      - "[0-9]+.[0-9]+.[0-9]+b[0-9]+"
-      - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
+  release:
+    types: [published]
 
 env:
   PACKAGE_NAME: "xsoar-cli"
@@ -117,28 +113,3 @@ jobs:
 
       - name: Publish distribution to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
-
-  github_release:
-    name: Create GitHub Release
-    needs: [setup_and_build, details]
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Download artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: dist
-          path: dist/
-
-      - name: Create GitHub Release
-        id: create_release
-        env:
-          GH_TOKEN: ${{ github.token }}
-        run: |
-          gh release create ${{ needs.details.outputs.tag_name }} dist/* --title ${{ needs.details.outputs.tag_name }} --generate-notes

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xsoar-cli
-Version: 1.0.3
+Version: 1.0.4
 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

{xsoar_cli-1.0.3 → xsoar_cli-1.0.4}/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.3"
+__version__ = "1.0.4"

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

@@ -20,7 +20,7 @@ def case() -> None:
 @click.pass_context
 @load_config
 def get(ctx: click.Context, casenumber: int, environment: str) -> None:
-    xsoar_client: Client = ctx.obj["server_envs"][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"]:
         click.echo(f"Cannot find case ID {casenumber}")
@@ -40,7 +40,7 @@ def clone(ctx: click.Context, casenumber: int, source: str, dest: str) -> None:
     if not valid_envs:
         click.echo(f"Error: cannot find environments {source} and/or {dest} in config")
         ctx.exit(1)
-    xsoar_source_client: Client = ctx.obj["server_envs"][source]
+    xsoar_source_client: Client = ctx.obj["server_envs"][source]["xsoar_client"]
     results = xsoar_source_client.get_case(casenumber)
     data = results["data"][0]
     # Dbot mirror info is irrelevant. This will be added again if applicable by XSOAR after ticket creation in dev.
@@ -57,7 +57,7 @@ def clone(ctx: click.Context, casenumber: int, source: str, dest: str) -> None:
     # Ensure that playbooks run immediately when the case is created
     data["createInvestigation"] = True
 
-    xsoar_dest_client: Client = ctx.obj["server_envs"][dest]
+    xsoar_dest_client: Client = ctx.obj["server_envs"][dest]["xsoar_client"]
     case_data = xsoar_dest_client.create_case(data=data)
     click.echo(json.dumps(case_data, indent=4))
 
@@ -71,7 +71,7 @@ def clone(ctx: click.Context, casenumber: int, source: str, dest: str) -> None:
 @load_config
 def create(ctx: click.Context, environment: str, casetype: str, name: str, 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."""
-    xsoar_client: Client = ctx.obj["server_envs"][environment]
+    xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     if not casetype:
         casetype = ctx.obj["default_new_case_type"]
     data = {

{xsoar_cli-1.0.3 → xsoar_cli-1.0.4}/src/xsoar_cli/config/commands.py

@@ -8,7 +8,13 @@ if TYPE_CHECKING:
 
 import contextlib
 
-from xsoar_cli.utilities import get_config_file_contents, get_config_file_path, get_config_file_template_contents, load_config
+from xsoar_cli.utilities import (
+    fail_if_no_artifacts_provider,
+    get_config_file_contents,
+    get_config_file_path,
+    get_config_file_template_contents,
+    load_config,
+)
 
 
 @click.group(help="Create/validate etc")
@@ -35,6 +41,7 @@ def show(ctx: click.Context, masked: bool) -> None:
 @click.option("--only-test-environment", default=None, show_default=True, help="Environment as defined in config file")
 @click.pass_context
 @load_config
+@fail_if_no_artifacts_provider
 def validate(ctx: click.Context, only_test_environment: str) -> None:
     """Validates that the configuration file is JSON and tests connectivity for each XSOAR Client environment defined."""
     return_code = 0
@@ -44,7 +51,7 @@ def validate(ctx: click.Context, only_test_environment: str) -> None:
             # what the user specified in option
             continue
         click.echo(f'Testing "{server_env}" environment...', nl=False)
-        xsoar_client: Client = ctx.obj["server_envs"][server_env]
+        xsoar_client: Client = ctx.obj["server_envs"][server_env]["xsoar_client"]
         try:
             xsoar_client.test_connectivity()
         except ConnectionError as ex:
@@ -53,6 +60,9 @@ def validate(ctx: click.Context, only_test_environment: str) -> None:
             return_code = 1
             continue
         click.echo("OK")
+    if ctx.obj["default_environment"] not in ctx.obj["server_envs"]:
+        click.echo(f'Error: default environment "{ctx.obj["default_environment"]}" not found in server config.')
+        return_code = 1
     ctx.exit(return_code)
 
 

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

@@ -46,7 +46,7 @@ def manifest() -> None:
 @load_config
 def update(ctx: click.Context, environment: str, manifest: str) -> None:
     """Update manifest on disk with latest available content pack versions."""
-    xsoar_client: Client = ctx.obj["server_envs"][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)
     results = xsoar_client.get_outdated_packs()
@@ -89,7 +89,7 @@ def update(ctx: click.Context, environment: str, manifest: str) -> None:
 def validate(ctx: click.Context, environment: str, manifest: str) -> None:
     """Validate manifest JSON and all pack availability. Validates upstream pack availability by doing HTTP CONNECT.
     Custom pack availability is implementation dependant."""
-    xsoar_client: Client = ctx.obj["server_envs"][environment]
+    xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     manifest_data = load_manifest(manifest)
     click.echo("Manifest is valid JSON")
     keys = ["custom_packs", "marketplace_packs"]
@@ -129,7 +129,7 @@ def validate(ctx: click.Context, environment: str, manifest: str) -> None:
 def diff(ctx: click.Context, manifest: str, environment: str) -> 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."""
-    xsoar_client: Client = ctx.obj["server_envs"][environment]
+    xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     manifest_data = load_manifest(manifest)
     installed_packs = xsoar_client.get_installed_packs()
     all_good = True
@@ -170,7 +170,7 @@ def deploy(ctx: click.Context, environment: str, manifest: str, verbose: bool, y
     if not should_continue:
         ctx.exit()
 
-    xsoar_client: Client = ctx.obj["server_envs"][environment]
+    xsoar_client: Client = ctx.obj["server_envs"][environment]["xsoar_client"]
     manifest_data = load_manifest(manifest)
     click.echo("Fetching installed packs...", err=True)
     installed_packs = xsoar_client.get_installed_packs()
@@ -191,7 +191,7 @@ def deploy(ctx: click.Context, environment: str, manifest: str, verbose: bool, y
                 # Print message that install is skipped
 
     if none_installed:
-        click.echo("No packs to install. XSOAR server is up to date with manifest.")
+        click.echo("No packs to install. All packs and versions in manifest is already installed on XSOAR server.")
 
 
 manifest.add_command(deploy)

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

@@ -22,7 +22,7 @@ def pack(ctx: click.Context) -> None:
 @load_config
 def delete(ctx: click.Context, environment: str, pack_id: str) -> None:
     """Deletes a content pack from the XSOAR server."""
-    xsoar_client: Client = ctx.obj["server_envs"][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.")
         sys.exit(1)
@@ -36,7 +36,7 @@ def delete(ctx: click.Context, environment: str, pack_id: str) -> None:
 @load_config
 def get_outdated(ctx: click.Context, environment: str) -> None:
     """Prints out a list of outdated content packs."""
-    xsoar_client: Client = ctx.obj["server_envs"][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()
     if not outdated_packs:

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

@@ -40,20 +40,20 @@ class MyPlugin(XSOARPlugin):
     @property
     def name(self) -> str:
         return "myplugin"
-    
-    @property 
+
+    @property
     def version(self) -> str:
         return "1.0.0"
-    
+
     @property
     def description(self) -> str:
         return "My custom plugin"
-    
+
     def get_command(self) -> click.Command:
         @click.command(help="My custom command")
         def mycommand():
             click.echo("Hello from my plugin!")
-        
+
         return mycommand
 ```
 
@@ -75,23 +75,23 @@ class MyCustomPlugin(XSOARPlugin):
     @property
     def name(self) -> str:
         return "mycustom"
-    
+
     @property
     def version(self) -> str:
         return "1.0.0"
-    
+
     @property
     def description(self) -> str:
         return "A custom plugin with multiple commands"
-    
+
     def get_command(self) -> click.Command:
         """Return the main command group for this plugin."""
-        
+
         @click.group(help="My custom commands")
         def mycustom():
             """Main command group for my custom plugin."""
             pass
-        
+
         @click.command(help="Greet someone")
         @click.option("--name", default="World", help="Name to greet")
         @click.option("--times", default=1, help="Number of times to greet")
@@ -99,7 +99,7 @@ class MyCustomPlugin(XSOARPlugin):
             """Greet someone multiple times."""
             for i in range(times):
                 click.echo(f"Hello, {name}!")
-        
+
         @click.command(help="Show current status")
         @click.option("--verbose", "-v", is_flag=True, help="Verbose output")
         def status(verbose: bool):
@@ -108,7 +108,7 @@ class MyCustomPlugin(XSOARPlugin):
             if verbose:
                 click.echo(f"Description: {self.description}")
                 click.echo("Status: Active")
-        
+
         @click.command(help="Process a file")
         @click.argument("filename", type=click.Path(exists=True))
         @click.option("--output", "-o", help="Output file")
@@ -118,18 +118,18 @@ class MyCustomPlugin(XSOARPlugin):
             if output:
                 click.echo(f"Output will be saved to: {output}")
             # Your processing logic here
-        
+
         # Add commands to the group
         mycustom.add_command(greet)
         mycustom.add_command(status)
         mycustom.add_command(process)
-        
+
         return mycustom
-    
+
     def initialize(self):
         """Initialize the plugin."""
         click.echo("My custom plugin initialized!")
-    
+
     def cleanup(self):
         """Cleanup when the plugin is unloaded."""
         pass
@@ -176,7 +176,7 @@ from xsoar_cli.utilities import load_config
 @load_config
 def my_command(ctx: click.Context):
     # Access XSOAR client
-    xsoar_client = ctx.obj["server_envs"]["dev"]
+    xsoar_client = ctx.obj["server_envs"]["dev"]["xsoar_client"]
     # Use the client...
 ```
 
@@ -284,11 +284,11 @@ class MyPlugin(XSOARPlugin):
         @click.group()
         def myplugin():
             pass
-        
+
         @click.command()
         def case():  # ✅ Namespaced as 'myplugin case'
             click.echo("My case command")
-        
+
         myplugin.add_command(case)
         return myplugin
 ```
@@ -297,7 +297,7 @@ class MyPlugin(XSOARPlugin):
 
 These command names are reserved by the core CLI:
 - `case` - Case/incident management
-- `config` - Configuration management  
+- `config` - Configuration management
 - `graph` - Dependency graphs
 - `manifest` - Manifest operations
 - `pack` - Content pack operations
@@ -330,7 +330,7 @@ def get_command(self) -> click.Command:
         except Exception as e:
             click.echo(f"Error: {e}", err=True)
             raise click.Abort()
-    
+
     return mycommand
 ```
 
@@ -430,4 +430,4 @@ except ImportError:
 
 You can share plugins by simply sharing the Python file. Users can place it in their plugins directory and it will be automatically discovered.
 
-For more complex plugins, consider packaging them as proper Python packages that install the plugin file automatically.
+For more complex plugins, consider packaging them as proper Python packages that install the plugin file automatically.

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

@@ -1,3 +1,4 @@
+import contextlib
 import json
 from collections.abc import Callable
 from functools import update_wrapper
@@ -75,6 +76,29 @@ def load_config(f: Callable) -> Callable:
     return update_wrapper(wrapper, f)
 
 
+def fail_if_no_artifacts_provider(f: Callable) -> Callable:
+    """
+    This function is only to be used as a decorator for various xsoar-cli subcommands, and only AFTER the load_config decorator has been called.
+    The intention is to fail gracefully if any subcommand is executed which requires an artifacts provider."
+    """
+
+    @click.pass_context
+    def wrapper(ctx: click.Context, *args, **kwargs) -> Callable:  # noqa: ANN002, ANN003
+        if "environment" in ctx.params:  # noqa: SIM108
+            key = ctx.params["environment"]
+        else:
+            key = ctx.obj["default_environment"]
+
+        with contextlib.suppress(KeyError):
+            location = ctx.obj["server_envs"][key].get("artifacts_location", None)
+            if not location:
+                click.echo("Command requires artifacts repository, but no artifacts_location defined in config.")
+                ctx.exit(1)
+        return ctx.invoke(f, *args, **kwargs)
+
+    return update_wrapper(wrapper, f)
+
+
 def parse_config(config: dict, ctx: click.Context) -> None:
     # Set the two XSOAR client objects in Click Context for use in later functions
     ctx.obj = {}
@@ -83,7 +107,8 @@ def parse_config(config: dict, ctx: click.Context) -> None:
     ctx.obj["default_new_case_type"] = config["default_new_case_type"]
     ctx.obj["server_envs"] = {}
     for key in config["server_config"]:
-        ctx.obj["server_envs"][key] = Client(
+        ctx.obj["server_envs"][key] = {}
+        ctx.obj["server_envs"][key]["xsoar_client"] = Client(
             api_token=config["server_config"][key]["api_token"],
             server_url=config["server_config"][key]["base_url"],
             verify_ssl=config["server_config"][key]["verify_ssl"],
@@ -93,3 +118,4 @@ def parse_config(config: dict, ctx: click.Context) -> None:
             artifacts_location=config["server_config"][key].get("artifacts_location", None),
             s3_bucket_name=config["server_config"][key].get("s3_bucket_name", None),
         )
+        ctx.obj["server_envs"][key]["artifacts_location"] = config["server_config"][key].get("artifacts_location", None)