Py4HEAppE 3.0.0__tar.gz → 3.1.0__tar.gz

{py4heappe-3.0.0 → py4heappe-3.1.0}/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 3.1.0
+
+### Added
+- CLI integration tests (live CLI examples) under `tests/` with helper `tests/live_cli_support.py` and a `tests/.env` template to simplify running live examples.
+- Updated README with instructions for running CLI tests and environment setup.
+
+### Changed
+- Documented test-runner defaults (use Python's `unittest`) and optional `pytest` support.
+
+
 ## 3.0.0
 
 ### Compatible with HEAppE V6.5.X, V6.4.X, V6.3.X, V6.2.X, V6.2.1, V5.0.X, V4.3.X and V4.2.X

{py4heappe-3.0.0 → py4heappe-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Py4HEAppE
-Version: 3.0.0
+Version: 3.1.0
 Summary: Py4HEAppE is client library for easy access to HEAppE Middleware
 Author-email: IT4Innovations <support.heappe@it4i.cz>
 License-Expression: MIT
@@ -22,11 +22,14 @@ Requires-Dist: click>=8.1.0
 Requires-Dist: typer>=0.15.0
 Requires-Dist: python-dotenv>=0.21.1
 Requires-Dist: validators==0.35.0
+Requires-Dist: typing-extensions==4.16.0
 Dynamic: license-file
 
 <img align="right" width="35%" src="https://raw.githubusercontent.com/It4innovations/Py4HEAppE/refs/heads/master/docs/imgs/logo.png">
 
 # Py4HEAppE (Python for HEAppE Middleware)
+Release: 3.1.0
+
 Py4HEAppE provides both a command-line interface and versioned Python wrappers for the [HEAppE](https://heappe.eu) middleware API.
 
 You can use it in two ways:
@@ -36,7 +39,7 @@ You can use it in two ways:
 ## Supported HEAppE Versions
 | Py4HEAppE | HEAppE Version                                         | Notes |
 |:---------:|:-------------------------------------------------------| :---- |
-|   3.0.X   | 6.5.X, 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X | Without Admin CLI section |
+|   3.1.X   | 6.5.X, 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X | Without Admin CLI section |
 |   2.9.X   | 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X        | Without Admin CLI section |
 |   2.8.X   | 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X        | Without Admin CLI section |
 |   2.7.X   | 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X        | Without Admin CLI section |
@@ -330,6 +333,26 @@ finally:
     api_client.pool.join()
 ```
 
+## Running CLI tests
+
+The repository includes live CLI integration tests under `tests/` that require a reachable HEAppE instance and several environment variables.
+
+Quick steps:
+
+- Create a `tests/.env` from the example and edit it:
+  - Unix: `cp tests/.env.example tests/.env`
+  - Windows (PowerShell): `Copy-Item tests\.env.example tests\.env`
+- Populate required values in `tests/.env` (or export the variables). At minimum set `PY4HEAPPE_RUN_LIVE_CLI_TESTS=1` and `PY4HEAPPE_TEST_URL` and `PY4HEAPPE_TEST_PROJECT`. To allow tests that change remote state also set `PY4HEAPPE_TEST_RUN_MUTATING_COMMANDS=1`.
+- Run the CLI tests (default, using the standard library's unittest):
+  - Run all CLI tests: `python -m unittest discover -s tests -p "test_cli_*.py" -v`
+  - Run a single test module: `python -m unittest tests.test_cli_auth -v`
+
+- Optional: run with pytest (pytest can run unittest-style tests and offers improved output):
+  - Install pytest: `python -m pip install -U pytest`
+  - Run with pytest: `python -m pytest -q tests/test_cli_*.py`
+
+Do NOT commit `tests/.env` with real credentials or session tokens.
+
 ## Notes
 
 - CLI configuration is stored locally after `py4heappe Conf Init`.

{py4heappe-3.0.0 → py4heappe-3.1.0}/README.md

@@ -1,6 +1,8 @@
 <img align="right" width="35%" src="https://raw.githubusercontent.com/It4innovations/Py4HEAppE/refs/heads/master/docs/imgs/logo.png">
 
 # Py4HEAppE (Python for HEAppE Middleware)
+Release: 3.1.0
+
 Py4HEAppE provides both a command-line interface and versioned Python wrappers for the [HEAppE](https://heappe.eu) middleware API.
 
 You can use it in two ways:
@@ -10,7 +12,7 @@ You can use it in two ways:
 ## Supported HEAppE Versions
 | Py4HEAppE | HEAppE Version                                         | Notes |
 |:---------:|:-------------------------------------------------------| :---- |
-|   3.0.X   | 6.5.X, 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X | Without Admin CLI section |
+|   3.1.X   | 6.5.X, 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X | Without Admin CLI section |
 |   2.9.X   | 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X        | Without Admin CLI section |
 |   2.8.X   | 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X        | Without Admin CLI section |
 |   2.7.X   | 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X        | Without Admin CLI section |
@@ -304,6 +306,26 @@ finally:
     api_client.pool.join()
 ```
 
+## Running CLI tests
+
+The repository includes live CLI integration tests under `tests/` that require a reachable HEAppE instance and several environment variables.
+
+Quick steps:
+
+- Create a `tests/.env` from the example and edit it:
+  - Unix: `cp tests/.env.example tests/.env`
+  - Windows (PowerShell): `Copy-Item tests\.env.example tests\.env`
+- Populate required values in `tests/.env` (or export the variables). At minimum set `PY4HEAPPE_RUN_LIVE_CLI_TESTS=1` and `PY4HEAPPE_TEST_URL` and `PY4HEAPPE_TEST_PROJECT`. To allow tests that change remote state also set `PY4HEAPPE_TEST_RUN_MUTATING_COMMANDS=1`.
+- Run the CLI tests (default, using the standard library's unittest):
+  - Run all CLI tests: `python -m unittest discover -s tests -p "test_cli_*.py" -v`
+  - Run a single test module: `python -m unittest tests.test_cli_auth -v`
+
+- Optional: run with pytest (pytest can run unittest-style tests and offers improved output):
+  - Install pytest: `python -m pip install -U pytest`
+  - Run with pytest: `python -m pytest -q tests/test_cli_*.py`
+
+Do NOT commit `tests/.env` with real credentials or session tokens.
+
 ## Notes
 
 - CLI configuration is stored locally after `py4heappe Conf Init`.

{py4heappe-3.0.0 → py4heappe-3.1.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "Py4HEAppE"
 authors = [{name = "IT4Innovations", email = "support.heappe@it4i.cz"}]
 description = "Py4HEAppE is client library for easy access to HEAppE Middleware"
-version = "3.0.0"
+version = "3.1.0"
 license = "MIT"
 readme = "README.md"
 requires-python = ">=3.11"

py4heappe-3.0.0/src/Py4HEAppE.egg-info/requires.txt → py4heappe-3.1.0/requirements.txt

@@ -7,3 +7,4 @@ click>=8.1.0
 typer>=0.15.0
 python-dotenv>=0.21.1
 validators==0.35.0
+typing-extensions==4.16.0

{py4heappe-3.0.0 → py4heappe-3.1.0}/src/Py4HEAppE.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Py4HEAppE
-Version: 3.0.0
+Version: 3.1.0
 Summary: Py4HEAppE is client library for easy access to HEAppE Middleware
 Author-email: IT4Innovations <support.heappe@it4i.cz>
 License-Expression: MIT
@@ -22,11 +22,14 @@ Requires-Dist: click>=8.1.0
 Requires-Dist: typer>=0.15.0
 Requires-Dist: python-dotenv>=0.21.1
 Requires-Dist: validators==0.35.0
+Requires-Dist: typing-extensions==4.16.0
 Dynamic: license-file
 
 <img align="right" width="35%" src="https://raw.githubusercontent.com/It4innovations/Py4HEAppE/refs/heads/master/docs/imgs/logo.png">
 
 # Py4HEAppE (Python for HEAppE Middleware)
+Release: 3.1.0
+
 Py4HEAppE provides both a command-line interface and versioned Python wrappers for the [HEAppE](https://heappe.eu) middleware API.
 
 You can use it in two ways:
@@ -36,7 +39,7 @@ You can use it in two ways:
 ## Supported HEAppE Versions
 | Py4HEAppE | HEAppE Version                                         | Notes |
 |:---------:|:-------------------------------------------------------| :---- |
-|   3.0.X   | 6.5.X, 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X | Without Admin CLI section |
+|   3.1.X   | 6.5.X, 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X | Without Admin CLI section |
 |   2.9.X   | 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X        | Without Admin CLI section |
 |   2.8.X   | 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X        | Without Admin CLI section |
 |   2.7.X   | 6.4.X, 6.3.X, 6.2.X, 6.2.1, 5.0.X, 4.3.X, 4.2.X        | Without Admin CLI section |
@@ -330,6 +333,26 @@ finally:
     api_client.pool.join()
 ```
 
+## Running CLI tests
+
+The repository includes live CLI integration tests under `tests/` that require a reachable HEAppE instance and several environment variables.
+
+Quick steps:
+
+- Create a `tests/.env` from the example and edit it:
+  - Unix: `cp tests/.env.example tests/.env`
+  - Windows (PowerShell): `Copy-Item tests\.env.example tests\.env`
+- Populate required values in `tests/.env` (or export the variables). At minimum set `PY4HEAPPE_RUN_LIVE_CLI_TESTS=1` and `PY4HEAPPE_TEST_URL` and `PY4HEAPPE_TEST_PROJECT`. To allow tests that change remote state also set `PY4HEAPPE_TEST_RUN_MUTATING_COMMANDS=1`.
+- Run the CLI tests (default, using the standard library's unittest):
+  - Run all CLI tests: `python -m unittest discover -s tests -p "test_cli_*.py" -v`
+  - Run a single test module: `python -m unittest tests.test_cli_auth -v`
+
+- Optional: run with pytest (pytest can run unittest-style tests and offers improved output):
+  - Install pytest: `python -m pip install -U pytest`
+  - Run with pytest: `python -m pytest -q tests/test_cli_*.py`
+
+Do NOT commit `tests/.env` with real credentials or session tokens.
+
 ## Notes
 
 - CLI configuration is stored locally after `py4heappe Conf Init`.

{py4heappe-3.0.0 → py4heappe-3.1.0}/src/Py4HEAppE.egg-info/SOURCES.txt

@@ -681,4 +681,13 @@ src/py4heappe/heappe_v6/core/models/vault_.py
 src/py4heappe/heappe_v6/core/models/vault_credential_counts_ext_.py
 src/py4heappe/heappe_v6/core/models/vault_info_.py
 src/py4heappe/heappe_v6/core/models/version_information_ext.py
-tests/__init__.py
+tests/.env.example
+tests/__init__.py
+tests/live_cli_support.py
+tests/test_cli_auth.py
+tests/test_cli_command_template.py
+tests/test_cli_configuration.py
+tests/test_cli_file_transfer.py
+tests/test_cli_information.py
+tests/test_cli_job_management.py
+tests/test_cli_report.py

py4heappe-3.0.0/requirements.txt → py4heappe-3.1.0/src/Py4HEAppE.egg-info/requires.txt

@@ -6,4 +6,5 @@ six>=1.16.0
 click>=8.1.0
 typer>=0.15.0
 python-dotenv>=0.21.1
-validators==0.35.0
+validators==0.35.0
+typing-extensions==4.16.0

{py4heappe-3.0.0 → py4heappe-3.1.0}/src/py4heappe/heappe_v6/cli/auth.py

@@ -7,9 +7,8 @@ import py4heappe.heappe_v6.core.base.utils as utils
 import py4heappe.heappe_v6.core as heappeCore
 
 from py4heappe.heappe_v6.core.base import exceptions
-from py4heappe.heappe_v6.core  import rest 
-# from py4lexis.session import LexisSession
-
+from py4heappe.heappe_v6.core  import rest
+#from py4lexis import LexisSession
 
 app = typer.Typer(name="HEAppEAuthCLI", no_args_is_help=True, pretty_exceptions_short=True)
 
@@ -45,9 +44,6 @@ def authentication_credentials():
         if "CREDENTIALS_PASSWORD" in os.environ:
             print(session_code)
 
-        utils.print_and_log("User was authenticated.")
-        utils.store_session(session_code)
-
     except rest.ApiException as exception:
         try:
             response_data = json.loads(exception.body)
@@ -64,6 +60,11 @@ def authentication_credentials():
     except Exception as exception:
         raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
 
+    else:
+        utils.print_and_log("User was authenticated.")
+        utils.store_session(session_code)
+
+
 @app.command(name="OpenId")
 def authentication_openid():
     """OpenID authentication"""

{py4heappe-3.0.0 → py4heappe-3.1.0}/src/py4heappe/heappe_v6/cli/configuration.py

@@ -2,12 +2,15 @@ import dotenv
 import os
 import typer
 import validators
+from pathlib import Path
 
 import py4heappe.heappe_v6.core as hp
 import py4heappe.heappe_v6.core.base.utils as utils
 from py4heappe.heappe_v6.core.base import exceptions
 from urllib.parse import urlparse
 
+ENV_FILE_PATH = Path(__file__).with_name(".env")
+
 app = typer.Typer(
     name="HEAppEConfigurationCLI",
     no_args_is_help=True,
@@ -16,8 +19,8 @@ app = typer.Typer(
 
 
 def get_api_instance():
-    dotenv.load_dotenv(os.path.join(os.path.dirname(__file__), ".env"))
-    url: str = os.environ.get("url")
+    dotenv.load_dotenv(ENV_FILE_PATH)
+    url = os.environ.get("url")
 
     if url is None:
         raise exceptions.Py4HEAppEInternalException(
@@ -31,9 +34,9 @@ def get_api_instance():
 
 
 def get_project_from_configuration():
-    dotenv.load_dotenv(os.path.join(os.path.dirname(__file__), ".env"))
+    dotenv.load_dotenv(ENV_FILE_PATH)
 
-    computationalProject: str = os.environ.get("project")
+    computationalProject = os.environ.get("project")
     if computationalProject is None:
         raise exceptions.Py4HEAppEInternalException(
             "Py4HEappE is not configured. Please check Conf option."
@@ -46,10 +49,10 @@ def get_project_from_configuration():
 def environment_preparation():
     """Initialization"""
     utils.print_and_log("Preparation of Py4HEAppE Environment ...")
-    dotenv.load_dotenv()
+    dotenv.load_dotenv(ENV_FILE_PATH)
 
-    url: str = os.environ.get("url")
-    computationalProject: str = os.environ.get("project")
+    url = os.environ.get("url")
+    computationalProject = os.environ.get("project")
 
     if url is not None or computationalProject is not None:
         reconfigure = typer.confirm(
@@ -82,9 +85,9 @@ def environment_preparation():
         "Enter HEAppE accounting string", confirmation_prompt=True
     )
 
-    dotenv.set_key(os.path.join(os.path.dirname(__file__), ".env"), "url", normalized)
+    dotenv.set_key(ENV_FILE_PATH, "url", normalized)
     dotenv.set_key(
-        os.path.join(os.path.dirname(__file__), ".env"),
+        ENV_FILE_PATH,
         "project",
         computationalProject.upper(),
     )

py4heappe-3.1.0/tests/.env.example

@@ -0,0 +1,62 @@
+# Example environment variables for running live CLI tests
+# Populate values in tests/.env or export the variables in your environment.
+
+# Test control
+PY4HEAPPE_RUN_LIVE_CLI_TESTS=
+PY4HEAPPE_TEST_RUN_MUTATING_COMMANDS=
+PY4HEAPPE_TEST_SESSION_CODE=
+
+# Core required values
+PY4HEAPPE_TEST_URL=
+PY4HEAPPE_TEST_PROJECT=
+
+# Auth / CLI config
+# Credentials used by auth-related CLI tests. Do NOT commit real secrets.
+CREDENTIALS_USERNAME=
+CREDENTIALS_PASSWORD=
+CREDENTIALS_TOKEN=
+
+# Job management & transfer
+PY4HEAPPE_TEST_JOB_SPEC_FILE=
+PY4HEAPPE_TEST_SUBMIT_JOB_ID=
+PY4HEAPPE_TEST_CANCEL_JOB_ID=
+PY4HEAPPE_TEST_DELETE_JOB_ID=
+PY4HEAPPE_TEST_INFO_JOB_ID=
+PY4HEAPPE_TEST_COPY_TO_TEMP_JOB_ID=
+PY4HEAPPE_TEST_COPY_TO_TEMP_PATH=
+PY4HEAPPE_TEST_COPY_FROM_TEMP_JOB_ID=
+PY4HEAPPE_TEST_TEMP_SESSION_CODE=
+PY4HEAPPE_TEST_SUBMITTED_TASK_ID=
+
+# File transfer specific
+PY4HEAPPE_TEST_SINGLE_TRANSFER_JOB_ID=
+PY4HEAPPE_TEST_SINGLE_TRANSFER_TASK_ID=   # Semicolon-separated list supported
+PY4HEAPPE_TEST_INTERACTIVE_TRANSFER_JOB_ID=
+PY4HEAPPE_TEST_INTERACTIVE_TRANSFER_TASK_ID=
+PY4HEAPPE_TEST_DOWNLOAD_JOB_ID=
+PY4HEAPPE_TEST_DOWNLOAD_RELATIVE_FILE_PATH=
+PY4HEAPPE_TEST_DOWNLOAD_PARTS_JOB_ID=
+PY4HEAPPE_TEST_TASK_FILE_OFFSETS=          # Semicolon-separated offsets for partial downloads
+PY4HEAPPE_TEST_LIST_CHANGED_JOB_ID=
+PY4HEAPPE_TEST_STREAM_JOB_ID=
+PY4HEAPPE_TEST_STREAM_TASK_ID=
+
+# Command templates and parameters
+PY4HEAPPE_TEST_CLUSTER_NODE_TYPE_ID=
+PY4HEAPPE_TEST_GENERIC_COMMAND_TEMPLATE_ID=
+PY4HEAPPE_TEST_MODIFY_COMMAND_TEMPLATE_ID=
+PY4HEAPPE_TEST_MODIFY_FROM_GENERIC_COMMAND_TEMPLATE_ID=
+PY4HEAPPE_TEST_REMOVE_COMMAND_TEMPLATE_ID=
+PY4HEAPPE_TEST_COMMAND_TEMPLATE_PARAMETER_ID=
+PY4HEAPPE_TEST_CREATE_PARAMETER_COMMAND_TEMPLATE_ID=
+PY4HEAPPE_TEST_MODIFY_PARAMETER_ID=
+PY4HEAPPE_TEST_REMOVE_PARAMETER_ID=
+
+# Reporting & information
+PY4HEAPPE_TEST_USER_ID=
+PY4HEAPPE_TEST_GROUP_ID=
+PY4HEAPPE_TEST_REPORT_JOB_ID=
+
+# Notes:
+# - Leave values blank if not applicable for the subset of tests you plan to run.
+# - Do NOT commit real credentials or session tokens into source control.

py4heappe-3.1.0/tests/live_cli_support.py

@@ -0,0 +1,154 @@
+import os
+import subprocess
+import sys
+import unittest
+from pathlib import Path
+
+from dotenv import load_dotenv
+
+load_dotenv(dotenv_path=Path(__file__).parent / ".env")
+
+REPO_ROOT = Path(__file__).resolve().parents[1]
+SRC_DIR = REPO_ROOT / "src"
+CLI_CONFIG_PATH = SRC_DIR / "py4heappe" / "heappe_v6" / "cli" / ".env"
+
+LIVE_FLAG = "PY4HEAPPE_RUN_LIVE_CLI_TESTS"
+MUTATING_FLAG = "PY4HEAPPE_TEST_RUN_MUTATING_COMMANDS"
+SESSION_CODE_ENV = "PY4HEAPPE_TEST_SESSION_CODE"
+
+
+def _set_or_remove_env_var(env, key, value):
+    matching_keys = [existing_key for existing_key in env if existing_key.lower() == key.lower()]
+    for matching_key in matching_keys:
+        env.pop(matching_key, None)
+
+    if value is not None:
+        env[key] = value
+
+
+def run_py4heappe_command(args, *, input_text=None, extra_env=None):
+    env = os.environ.copy()
+    python_path = env.get("PYTHONPATH")
+    env["PYTHONPATH"] = (
+        str(SRC_DIR) if not python_path else f"{SRC_DIR}{os.pathsep}{python_path}"
+    )
+    env["PYTHONIOENCODING"] = "utf-8"
+
+    for key, value in (extra_env or {}).items():
+        _set_or_remove_env_var(env, key, value)
+
+    return subprocess.run(
+        [sys.executable, "-m", "py4heappe_cli", *args],
+        cwd=REPO_ROOT,
+        input=input_text,
+        capture_output=True,
+        text=True,
+        encoding="utf-8",
+        errors="replace",
+        env=env,
+    )
+
+
+class LiveCliExampleTestCase(unittest.TestCase):
+    _config_existed: bool = False
+    _config_content: str = ""
+    _cli_configured: bool = False
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls._config_existed = CLI_CONFIG_PATH.exists()
+        if cls._config_existed:
+            cls._config_content = CLI_CONFIG_PATH.read_text(encoding="utf-8")
+        else:
+            cls._config_content = ""
+        cls._cli_configured = False
+
+    @classmethod
+    def tearDownClass(cls):
+        try:
+            if cls._config_existed:
+                CLI_CONFIG_PATH.write_text(cls._config_content, encoding="utf-8")
+            elif CLI_CONFIG_PATH.exists():
+                CLI_CONFIG_PATH.unlink()
+        finally:
+            super().tearDownClass()
+
+    @classmethod
+    def ensure_live_enabled(cls):
+        if os.environ.get(LIVE_FLAG) != "1":
+            raise AssertionError(
+                f"Set {LIVE_FLAG}=1 to run live CLI example tests."
+            )
+
+    @classmethod
+    def ensure_mutating_commands_enabled(cls):
+        if os.environ.get(MUTATING_FLAG) != "1":
+            raise AssertionError(
+                f"Set {MUTATING_FLAG}=1 to run mutating CLI example tests."
+            )
+
+    @classmethod
+    def require_env(cls, *names):
+        missing = [name for name in names if not os.environ.get(name)]
+        if missing:
+            raise AssertionError(
+                "Missing required environment variable(s): "
+                + ", ".join(missing)
+            )
+        return {name: os.environ[name] for name in names}
+
+    @classmethod
+    def session_env(cls):
+        return {"sessionCode": cls.require_env(SESSION_CODE_ENV)[SESSION_CODE_ENV]}
+
+    @classmethod
+    def ensure_cli_configured(cls):
+        if cls._cli_configured:
+            return
+
+        env_values = cls.require_env("PY4HEAPPE_TEST_URL", "PY4HEAPPE_TEST_PROJECT")
+        if CLI_CONFIG_PATH.exists():
+            CLI_CONFIG_PATH.unlink()
+
+        result = run_py4heappe_command(
+            ["Conf", "Init"],
+            input_text=(
+                f"{env_values['PY4HEAPPE_TEST_URL']}\n"
+                f"{env_values['PY4HEAPPE_TEST_PROJECT']}\n"
+                f"{env_values['PY4HEAPPE_TEST_PROJECT']}\n"
+            ),
+            extra_env={"url": None, "project": None},
+        )
+        cls.assert_command_succeeded(result, ["Conf", "Init"])
+        cls._cli_configured = True
+
+    @staticmethod
+    def split_env_list(name):
+        raw_value = os.environ.get(name, "")
+        return [item.strip() for item in raw_value.split(";") if item.strip()]
+
+    @staticmethod
+    def append_repeated_option(args, option_name, values):
+        for value in values:
+            args.extend([option_name, value])
+
+    @classmethod
+    def assert_command_succeeded(cls, result, args):
+        if result.returncode == 0:
+            return
+
+        formatted_command = " ".join(args)
+        raise AssertionError(
+            f"Command failed: py4heappe {formatted_command}\n"
+            f"exit code: {result.returncode}\n"
+            f"stdout:\n{result.stdout}\n"
+            f"stderr:\n{result.stderr}"
+        )
+
+    def run_cli(self, *args, input_text=None, extra_env=None):
+        result = run_py4heappe_command(
+            list(args), input_text=input_text, extra_env=extra_env
+        )
+        self.assert_command_succeeded(result, list(args))
+        return result

py4heappe-3.1.0/tests/test_cli_auth.py

@@ -0,0 +1,25 @@
+from tests.live_cli_support import LiveCliExampleTestCase
+
+
+class AuthCliExampleTests(LiveCliExampleTestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.ensure_live_enabled()
+        cls.ensure_cli_configured()
+
+    def test_auth_userpass_example(self):
+        env_values = self.require_env("CREDENTIALS_USERNAME", "CREDENTIALS_PASSWORD")
+        result = self.run_cli("Auth", "UserPass", extra_env=env_values,
+                input_text=(
+                f"{env_values['CREDENTIALS_USERNAME']}\n"
+                f"{env_values['CREDENTIALS_PASSWORD']}\n"
+            ),)
+
+        self.assertIn("User was authenticated.", result.stdout)
+
+    # def test_auth_openid_example(self):
+    #     env_values = self.require_env("CREDENTIALS_TOKEN")
+    #     result = self.run_cli("Auth", "OpenId", extra_env=env_values)
+    #
+    #     self.assertIn("User was authenticated.", result.stdout)