xsoar-cli 1.3.0__tar.gz → 1.3.2__tar.gz

xsoar_cli-1.3.2/.github/workflows/main.yml

@@ -0,0 +1,22 @@
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    coverage:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Install uv and set the Python version
+              uses: astral-sh/setup-uv@v7
+              with:
+                  python-version: "3.14"
+
+            - name: Sync uv
+              run: uv sync --all-groups
+
+            - name: Run unit tests with coverage
+              run: uv run pytest --cov=src/xsoar_cli --cov-report=term-missing

{xsoar_cli-1.3.0 → xsoar_cli-1.3.2}/.github/workflows/pull-request-open.yml

@@ -23,13 +23,24 @@ jobs:
                   python-version: ${{ matrix.python-version }}
 
             - name: Sync uv
-              run: uv sync
-
-            - name: Install requirements
-              run: |
-                  uv pip install -r requirements.txt
-                  uv pip install -r requirements_dev.txt
-                  uv pip install -e .
+              run: uv sync --all-groups
 
             - name: Run unit tests
               run: uv run pytest
+
+    coverage:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Install uv and set the Python version
+              uses: astral-sh/setup-uv@v7
+              with:
+                  python-version: "3.14"
+
+            - name: Sync uv
+              run: uv sync --all-groups
+
+            - name: Run unit tests with coverage
+              run: uv run pytest --cov=src/xsoar_cli --cov-report=term-missing

{xsoar_cli-1.3.0 → xsoar_cli-1.3.2}/CONTRIBUTING.md

@@ -32,29 +32,52 @@ We welcome contributions of all kinds! Whether you're fixing bugs, adding featur
    cd xsoar-cli
    ```
 
-### 2. Set Up Development Environment
+### 2. Install uv
+
+[uv](https://docs.astral.sh/uv/) is the recommended package manager for this project. Using legacy venv/pip workflows should also work, but uv is a great tool.
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+For other platforms and installation options, see the [uv installation docs](https://docs.astral.sh/uv/getting-started/installation/).
+
+### 3. Set Up Development Environment
+
+**Recommended: uv**
+
+You may find that you will need to make modifications in [xsoar-client](https://github.com/tlium/xsoar-client) and/or [xsoar-dependency-graph](https://github.com/tlium/xsoar-dependency-graph) in order
+to fix bugs or add new features to `xsoar-cli`. If you need to work on `xsoar-client` or `xsoar-dependency-graph`, install them in editable mode from your local Git clones:
+
 ```bash
-# Create virtual environment
+uv pip install -e /path/to/your/xsoar-client
+uv pip install -e /path/to/your/xsoar-dependency-graph
+```
+
+```bash
+# Install dependencies and xsoar-cli in editable mode
+uv sync
+uv pip install -e .
+```
+**Alternative: pip/venv**
+
+```bash
+# Create and activate a virtual environment
 python -m venv venv
-source venv/bin/activate  # On Windows: venv\Scripts\activate
+source venv/bin/activate
 
 # Install development dependencies
 pip install -r requirements_dev.txt
 
-# Install the package in development mode
+# Install xsoar-cli in editable mode
 pip install -e .
 ```
 
-### 3. Verify Setup
-```bash
-# Run tests to ensure everything works
-pytest
-
-# Check code style
-black --check src/ tests/
+If you need to work on the supporting libraries, install them in editable mode as well:
 
-# Run the CLI to verify installation
-xsoar-cli --help
+```bash
+pip install -e /path/to/your/xsoar-client
+pip install -e /path/to/your/xsoar-dependency-graph
 ```
 
 ## Development Workflow
@@ -71,12 +94,6 @@ xsoar-cli --help
    ```bash
    # Run tests
    pytest
-   
-   # Format code
-   black src/ tests/
-   
-   # Check for any issues
-   python -m pytest --cov=src/xsoar_cli
    ```
 
 4. **Commit with clear messages**:
@@ -91,8 +108,7 @@ xsoar-cli --help
    ```
 
 ### Code Style
-- We use [Black](https://github.com/psf/black) for code formatting
-- Run `black src/ tests/` before committing
+- We use [Ruff](https://docs.astral.sh/ruff/) for code formatting
 - Follow existing code patterns and conventions
 - Add type hints where appropriate
 - Write docstrings for new functions and classes
@@ -127,12 +143,6 @@ Documentation improvements are especially welcome! You can contribute to documen
 
 ## Submitting Pull Requests
 
-### Before Submitting
-- [ ] Tests pass (`pytest`)
-- [ ] Code is formatted (`black src/ tests/`)
-- [ ] Documentation is updated if needed
-- [ ] Commit messages are clear and descriptive
-
 ### Pull Request Guidelines
 - **Describe your changes** clearly in the PR description
 - **Reference any related issues** (e.g., "Fixes #123")
@@ -194,4 +204,4 @@ Be respectful and constructive in all interactions. We want this to be a welcomi
 
 Contributors are recognized in release notes and we appreciate all contributions, no matter how small!
 
-Thank you for contributing!
+Thank you for contributing!

{xsoar_cli-1.3.0 → xsoar_cli-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xsoar-cli
-Version: 1.3.0
+Version: 1.3.2
 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
@@ -44,7 +44,7 @@ Pull Requests are very welcome and appreciated! See [CONTRIBUTING.md](CONTRIBUTI
 
 ```bash
 # Install
-pip install xsoar-cli
+uv tool install xsoar-cli
 
 # Create configuration file
 xsoar-cli config create
@@ -65,27 +65,47 @@ This CLI tool is made to be run from the root of a content repository. Some comm
 
 ### Core Requirements
 - XSOAR servers version 6 or 8
-- Python 3.9+ (only tested with Python 3.12, earlier versions may work but are not guaranteed)
+- Python 3.10+ (tested with Python 3.10-3.14, earlier versions may work but are untested)
+- [uv](https://docs.astral.sh/uv/) for installation
 
-### Additional Requirements 
-- **AWS SDK for Python (Boto3)** - Only required when working with custom content packs stored in S3.
-- **Azure SDK for Python**
+### Additional Requirements
+- **demisto-sdk** - Required by several commands, most notably `xsoar-cli playbook download`. Should be installed separately.
 
 
 ## Installation
 
+Installing xsoar-cli as a uv tool is recommended. This gives it an isolated environment with its own dependencies, avoiding version conflicts with other Python tools such as demisto-sdk.
+
+```bash
+uv tool install xsoar-cli
+```
+
+Alternatively, using pip:
+
 ```bash
 pip install xsoar-cli
 ```
 
 ## Upgrading
 
+```bash
+uv tool upgrade xsoar-cli
+```
+
+Or with pip:
+
 ```bash
 pip install --upgrade xsoar-cli
 ```
 
 ## Uninstalling
 
+```bash
+uv tool uninstall xsoar-cli
+```
+
+Or with pip:
+
 ```bash
 pip uninstall xsoar-cli
 ```
@@ -106,6 +126,7 @@ After creating the config file, edit it with your XSOAR server details:
 {
     "default_environment": "xsoar6",
     "default_new_case_type": "My case type",
+    "log_level": "INFO",
     "custom_pack_authors": ["My_Org"],
     "server_config": {
         "xsoar6": {
@@ -149,6 +170,7 @@ After creating the config file, edit it with your XSOAR server details:
     "default_environment": "dev",
     "default_new_case_type": "My case type",
     "custom_pack_authors": ["My_Org"],
+    "log_level": "DEBUG"
     "server_config": {
         "dev": {
             "base_url": "https://your.dev.domain",
@@ -241,8 +263,7 @@ xsoar-cli supports a plugin system that allows you to extend the CLI with custom
 - Use `xsoar-cli config validate` to verify your configuration
 
 **Python compatibility issues**
-- Ensure you're using Python 3.9 or later
-- Consider using Python 3.12 for best compatibility
+- Ensure you're using Python 3.10 or later
 
 ## Contributing
 

{xsoar_cli-1.3.0 → xsoar_cli-1.3.2}/README.md

@@ -19,7 +19,7 @@ Pull Requests are very welcome and appreciated! See [CONTRIBUTING.md](CONTRIBUTI
 
 ```bash
 # Install
-pip install xsoar-cli
+uv tool install xsoar-cli
 
 # Create configuration file
 xsoar-cli config create
@@ -40,27 +40,47 @@ This CLI tool is made to be run from the root of a content repository. Some comm
 
 ### Core Requirements
 - XSOAR servers version 6 or 8
-- Python 3.9+ (only tested with Python 3.12, earlier versions may work but are not guaranteed)
+- Python 3.10+ (tested with Python 3.10-3.14, earlier versions may work but are untested)
+- [uv](https://docs.astral.sh/uv/) for installation
 
-### Additional Requirements 
-- **AWS SDK for Python (Boto3)** - Only required when working with custom content packs stored in S3.
-- **Azure SDK for Python**
+### Additional Requirements
+- **demisto-sdk** - Required by several commands, most notably `xsoar-cli playbook download`. Should be installed separately.
 
 
 ## Installation
 
+Installing xsoar-cli as a uv tool is recommended. This gives it an isolated environment with its own dependencies, avoiding version conflicts with other Python tools such as demisto-sdk.
+
+```bash
+uv tool install xsoar-cli
+```
+
+Alternatively, using pip:
+
 ```bash
 pip install xsoar-cli
 ```
 
 ## Upgrading
 
+```bash
+uv tool upgrade xsoar-cli
+```
+
+Or with pip:
+
 ```bash
 pip install --upgrade xsoar-cli
 ```
 
 ## Uninstalling
 
+```bash
+uv tool uninstall xsoar-cli
+```
+
+Or with pip:
+
 ```bash
 pip uninstall xsoar-cli
 ```
@@ -81,6 +101,7 @@ After creating the config file, edit it with your XSOAR server details:
 {
     "default_environment": "xsoar6",
     "default_new_case_type": "My case type",
+    "log_level": "INFO",
     "custom_pack_authors": ["My_Org"],
     "server_config": {
         "xsoar6": {
@@ -124,6 +145,7 @@ After creating the config file, edit it with your XSOAR server details:
     "default_environment": "dev",
     "default_new_case_type": "My case type",
     "custom_pack_authors": ["My_Org"],
+    "log_level": "DEBUG"
     "server_config": {
         "dev": {
             "base_url": "https://your.dev.domain",
@@ -216,8 +238,7 @@ xsoar-cli supports a plugin system that allows you to extend the CLI with custom
 - Use `xsoar-cli config validate` to verify your configuration
 
 **Python compatibility issues**
-- Ensure you're using Python 3.9 or later
-- Consider using Python 3.12 for best compatibility
+- Ensure you're using Python 3.10 or later
 
 ## Contributing
 

{xsoar_cli-1.3.0 → xsoar_cli-1.3.2}/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.3.0'
-__version_tuple__ = version_tuple = (1, 3, 0)
+__version__ = version = '1.3.2'
+__version_tuple__ = version_tuple = (1, 3, 2)
 
 __commit_id__ = commit_id = None

{xsoar_cli-1.3.0 → xsoar_cli-1.3.2}/pyproject.toml

@@ -60,3 +60,9 @@ tests = ["tests", "*/xsoar-cli/tests"]
 
 [tool.coverage.report]
 exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+    "pytest-cov>=7.0.0",
+]

{xsoar_cli-1.3.0 → xsoar_cli-1.3.2}/src/xsoar_cli/cli.py

@@ -16,12 +16,14 @@ from .__about__ import __version__
 from .case import commands as case_commands
 from .config import commands as config_commands
 from .graph import commands as graph_commands
+from .integration import commands as integration_commands
 from .log import LoggingSetup, setup_logging
 from .manifest import commands as manifest_commands
 from .pack import commands as pack_commands
 from .playbook import commands as playbook_commands
 from .plugins import commands as plugin_commands
 from .plugins.manager import PluginManager
+from .rbac import commands as rbac_commands
 from .utilities import get_config_file_contents, get_config_file_path
 
 
@@ -64,10 +66,12 @@ def _register_commands() -> None:
     cli.add_command(config_commands.config)
     cli.add_command(case_commands.case)
     cli.add_command(pack_commands.pack)
+    cli.add_command(integration_commands.integration)
     cli.add_command(manifest_commands.manifest)
     cli.add_command(playbook_commands.playbook)
     cli.add_command(graph_commands.graph)
     cli.add_command(plugin_commands.plugins)
+    cli.add_command(rbac_commands.rbac)
 
 
 def _load_plugins() -> tuple[list[str], PluginManager]:

xsoar_cli-1.3.2/src/xsoar_cli/integration/commands.py

@@ -0,0 +1,55 @@
+import json
+import logging
+from typing import TYPE_CHECKING
+
+import click
+
+from xsoar_cli.utilities import get_xsoar_config, load_config, validate_xsoar_connectivity
+
+if TYPE_CHECKING:
+    from xsoar_client.xsoar_client import Client
+
+logger = logging.getLogger(__name__)
+
+
+@click.group()
+@click.pass_context
+def integration(ctx: click.Context) -> None:
+    """(BETA) Save/load integration configuration for an integration instance."""
+
+
+@click.option("--environment", default=None, help="Default environment set in config file.")
+@click.command()
+@click.argument("name", type=str)
+@click.pass_context
+@load_config
+@validate_xsoar_connectivity()
+def dumpconfig(ctx: click.Context, environment: str | None, name: str | None) -> None:
+    """Dumps integration config to JSON file."""
+    config = get_xsoar_config(ctx)
+    xsoar_client: Client = config.get_client(environment)
+    logger.debug("Dumping integration config (environment: '%s')", environment or config.default_environment)
+    response = xsoar_client.get_integrations()
+    integrations = json.loads(response)
+    integration_data = next((i for i in integrations if i["name"] == name), None)
+    logger.debug("Fetching config for integration name '%s'(environment: '%s')", name, environment or config.default_environment)
+    if not integration_data:
+        click.echo(f"Cannot find integration instance '{name}'")
+        ctx.exit(1)
+    click.echo(json.dumps(integration_data, sort_keys=True, indent=4) + "\n")
+
+
+@click.option("--environment", default=None, help="Default environment set in config file.")
+@click.command()
+@click.argument("name", type=str)
+@click.pass_context
+@load_config
+@validate_xsoar_connectivity()
+def loadconfig(ctx: click.Context, environment: str | None, name: str, instance_name: str) -> None:
+    """Loads integration config from JSON file."""
+    logger.debug("integration loadconfig command not implemented")
+    click.echo("Command not implemented")
+
+
+integration.add_command(dumpconfig)
+integration.add_command(loadconfig)

{xsoar_cli-1.3.0 → xsoar_cli-1.3.2}/src/xsoar_cli/playbook/commands.py

@@ -72,9 +72,11 @@ def download(ctx: click.Context, environment: str | None, name: str) -> None:
         [
             "demisto-sdk",
             "format",
-            "--assume-yes",
+            "--assume-no",
             "--no-validate",
             "--no-graph",
+            "--from-version",
+            "6.10.0",
             str(filepath),
         ],
         check=False,

xsoar_cli-1.3.2/src/xsoar_cli/rbac/commands.py

@@ -0,0 +1,72 @@
+import json
+import logging
+from typing import TYPE_CHECKING
+
+import click
+
+import xsoar_cli
+from xsoar_cli.utilities import get_xsoar_config, load_config, validate_xsoar_connectivity
+
+if TYPE_CHECKING:
+    from xsoar_client.xsoar_client import Client
+
+logger = logging.getLogger(__name__)
+
+
+@click.group()
+@click.pass_context
+def rbac(ctx: click.Context) -> None:
+    """Dump roles, users and user groups"""
+
+
+@click.option("--environment", default=None, help="Default environment set in config file.")
+@click.command()
+@click.pass_context
+@load_config
+@validate_xsoar_connectivity()
+def getroles(ctx: click.Context, environment: str | None) -> None:
+    """Dump all roles in your environment."""
+    config = get_xsoar_config(ctx)
+    xsoar_client: Client = config.get_client(environment)
+    results = xsoar_client.get_roles()
+    roles = json.loads(results)
+    click.echo(json.dumps(roles, sort_keys=True, indent=4) + "\n")
+
+
+@click.option("--environment", default=None, help="Default environment set in config file.")
+@click.command()
+@click.pass_context
+@load_config
+@validate_xsoar_connectivity()
+def getusers(ctx: click.Context, environment: str | None) -> None:
+    """Dump all users in your environment."""
+    config = get_xsoar_config(ctx)
+    xsoar_client: Client = config.get_client(environment)
+    results = xsoar_client.get_users()
+    users = json.loads(results)
+    click.echo(json.dumps(users, sort_keys=True, indent=4) + "\n")
+
+    config = get_xsoar_config(ctx)
+    xsoar_client: Client = config.get_client(environment)
+
+
+@click.option("--environment", default=None, help="Default environment set in config file.")
+@click.command()
+@click.pass_context
+@load_config
+@validate_xsoar_connectivity()
+def getusergroups(ctx: click.Context, environment: str | None) -> None:
+    """Dump all roles in your environment."""
+    config = get_xsoar_config(ctx)
+    xsoar_client: Client = config.get_client(environment)
+    if xsoar_client.config.server_version < 8:
+        click.echo("Errot: Command not supported for XSOAR server versions less than 8")
+        ctx.exit(1)
+    results = xsoar_client.get_user_groups()
+    user_groups = json.loads(results)
+    click.echo(json.dumps(user_groups, sort_keys=True, indent=4) + "\n")
+
+
+rbac.add_command(getroles)
+rbac.add_command(getusers)
+rbac.add_command(getusergroups)

xsoar_cli-1.3.2/tests/test_connection_errors.py

@@ -0,0 +1,129 @@
+"""Tests for ConnectionErrorHandler.
+
+Covers get_message and _extract_hostname using a single parametrized test method.
+Exception objects that require raise/except chains are built by module-level helpers
+and passed directly as parameter values.
+"""
+
+import socket
+from unittest.mock import MagicMock
+
+import pytest
+from urllib3.exceptions import NameResolutionError
+
+from xsoar_cli.connection_errors import ConnectionErrorHandler
+
+
+def _make_name_resolution_error(hostname: str, reason: str) -> NameResolutionError:
+    """Build a NameResolutionError for the given hostname and reason string.
+
+    Uses a MagicMock for the conn argument, with __str__ fixed to 'conn' so the
+    formatted message is predictable across test runs.
+    """
+    conn = MagicMock()
+    conn.__str__ = lambda self: "conn"
+    return NameResolutionError(hostname, conn, socket.gaierror(reason))
+
+
+def _chained_name_resolution_error() -> NameResolutionError:
+    """Return a NameResolutionError chained from an OSError root cause.
+
+    Represents the realistic urllib3 case where a NameResolutionError wraps a
+    lower-level socket error.
+    """
+    try:
+        try:
+            raise OSError("nodename nor servname provided, or not known")
+        except OSError as root:
+            raise _make_name_resolution_error("example.com", "nodename nor servname provided, or not known") from root
+    except NameResolutionError as exc:
+        return exc
+
+
+def _chained_without_name_resolution_error() -> RuntimeError:
+    """Return a RuntimeError chained from an OSError root cause, with no NameResolutionError in the chain.
+
+    Used to verify that get_message falls back to the root cause string when no
+    hostname can be extracted.
+    """
+    try:
+        try:
+            raise OSError("connection refused")
+        except OSError as root:
+            raise RuntimeError("operation failed") from root
+    except RuntimeError as exc:
+        return exc
+
+
+def _name_resolution_error_no_args() -> NameResolutionError:
+    """Return a NameResolutionError with an empty args tuple.
+
+    Bypasses the normal constructor to simulate a malformed exception object,
+    used to verify that _extract_hostname handles missing args gracefully.
+    """
+    exc = NameResolutionError.__new__(NameResolutionError)
+    exc.args = ()
+    return exc
+
+
+def _name_resolution_error_with_message(message: str) -> NameResolutionError:
+    """Return a NameResolutionError with args set to the given message string.
+
+    Bypasses the normal constructor so arbitrary message content can be injected,
+    used to test _extract_hostname's message parsing edge cases.
+    """
+    exc = NameResolutionError.__new__(NameResolutionError)
+    exc.args = (message,)
+    return exc
+
+
+handler = ConnectionErrorHandler()
+
+
+class TestConnectionErrorHandler:
+    """Tests for ConnectionErrorHandler.
+
+    Both get_message and _extract_hostname are exercised through a single
+    parametrized method. The method column selects which handler method to call
+    via getattr, keeping all cases in one place.
+    """
+
+    @pytest.mark.parametrize(
+        ("method", "exception", "expected"),
+        [
+            # get_message: simple cases
+            ("get_message", None, "Unknown error"),
+            ("get_message", ValueError("something went wrong"), "something went wrong"),
+            # get_message: exception chain without NameResolutionError
+            ("get_message", _chained_without_name_resolution_error(), "connection refused"),
+            # get_message: NameResolutionError with chained root cause
+            (
+                "get_message",
+                _chained_name_resolution_error(),
+                "Failed to resolve 'example.com' (nodename nor servname provided, or not known)",
+            ),
+            # _extract_hostname: valid hostnames
+            (
+                "_extract_hostname",
+                _make_name_resolution_error("example.com", "nodename nor servname provided, or not known"),
+                "example.com",
+            ),
+            ("_extract_hostname", _make_name_resolution_error("my-host.internal", "Name or service not known"), "my-host.internal"),
+            # _extract_hostname: no args
+            ("_extract_hostname", _name_resolution_error_no_args(), None),
+            # _extract_hostname: message without "Failed to resolve"
+            ("_extract_hostname", _name_resolution_error_with_message("some unrelated error message"), None),
+            ("_extract_hostname", _name_resolution_error_with_message("conn: Could not connect to host"), None),
+            # _extract_hostname: malformed quotes
+            ("_extract_hostname", _name_resolution_error_with_message("conn: Failed to resolve 'example.com"), None),
+        ],
+    )
+    def test_connection_error_handler(self, method: str, exception: BaseException | None, expected: str | None) -> None:
+        """Invoke the named handler method with exception and assert the result matches expected.
+
+        method:    name of the ConnectionErrorHandler method to call
+        exception: exception instance (or None) passed as the sole argument
+        expected:  expected return value; None for _extract_hostname failure cases
+        """
+        result = getattr(handler, method)(exception)
+        assert result == expected