zosmfrestapi 0.1.0__tar.gz → 0.2.0__tar.gz

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zosmfrestapi
-Version: 0.1.0
+Version: 0.2.0
 Summary: A Python wrapper for the z/OSMF REST API
 License-Expression: MIT
 License-File: LICENSE
@@ -13,49 +13,43 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: zcrypto
 Requires-Dist: dacite (>=1.9.2,<2.0.0)
 Requires-Dist: httpx2 (>=2.12.0,<3.0.0)
 Requires-Dist: pendulum (>=3.2.0,<4.0.0)
+Requires-Dist: py_zcrypto ; extra == "zcrypto"
 Project-URL: Homepage, https://sr.ht/~ocurero/zosmfrestapi/
 Project-URL: PyPI, https://pypi.org/project/zosmfrestapi/
 Project-URL: Repository, https://sr.ht/~ocurero/zosmfrestapi/
 Description-Content-Type: text/markdown
 
-A Python wrapper for the z/OSMF© REST API
-=========================================
+# A Python wrapper for the z/OSMF© REST API
 
-[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![builds.sr.ht status](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml.svg)](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml?) ![z/OS](https://img.shields.io/badge/works%20on-z/OS-8A2BE2)
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![builds.sr.ht status](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml.svg)](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml?)
+![z/OS](https://img.shields.io/badge/works%20on-z/OS-8A2BE2)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 * Open Source: MIT License.
 * Website: <https://sr.ht/~ocurero/zosmfrestapi/>
 * Pypi: <https://pypi.org/project/zosmfrestapi/>
+* Changelog: [CHANGELOG.md](CHANGELOG.md)
+* Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
+
+Key features:
+* **Pure Python**: Package and its dependencies are 100% pure Python (no C extensions required).
+* **Cross-platform**: Works on Windows, Linux, macOS, and z/OS UNIX System Services.
+* **Flexible authentication**: Supports user/password, LTPA and JWT tokens, and mutual TLS (mTLS).
+* **Proxy ready**: Full support for standard HTTP/HTTPS proxies as well as authenticated proxies.
 
 
 Install
 -------
 
 **zosmfrestapi** requires Python 3.12 or newer and access to a z/OSMF server.
-You can check your Python version with:
-
-```console
-python --version
-```
-
-It is a good idea to use a virtual environment so this package does not affect
-other Python projects. From a terminal, create and activate one in your project
-folder:
-
-```console
-# Windows (PowerShell)
-py -3.12 -m venv .venv
-.venv\Scripts\Activate.ps1
-
-# macOS or Linux
-python3 -m venv .venv
-source .venv/bin/activate
-```
 
-Then install the package from PyPI:
+Install the package from PyPI:
 
 ```console
 python -m pip install zosmfrestapi

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/README.md

@@ -1,38 +1,30 @@
-A Python wrapper for the z/OSMF© REST API
-=========================================
+# A Python wrapper for the z/OSMF© REST API
 
-[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![builds.sr.ht status](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml.svg)](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml?) ![z/OS](https://img.shields.io/badge/works%20on-z/OS-8A2BE2)
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![builds.sr.ht status](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml.svg)](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml?)
+![z/OS](https://img.shields.io/badge/works%20on-z/OS-8A2BE2)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 * Open Source: MIT License.
 * Website: <https://sr.ht/~ocurero/zosmfrestapi/>
 * Pypi: <https://pypi.org/project/zosmfrestapi/>
+* Changelog: [CHANGELOG.md](CHANGELOG.md)
+* Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
+
+Key features:
+* **Pure Python**: Package and its dependencies are 100% pure Python (no C extensions required).
+* **Cross-platform**: Works on Windows, Linux, macOS, and z/OS UNIX System Services.
+* **Flexible authentication**: Supports user/password, LTPA and JWT tokens, and mutual TLS (mTLS).
+* **Proxy ready**: Full support for standard HTTP/HTTPS proxies as well as authenticated proxies.
 
 
 Install
 -------
 
 **zosmfrestapi** requires Python 3.12 or newer and access to a z/OSMF server.
-You can check your Python version with:
-
-```console
-python --version
-```
-
-It is a good idea to use a virtual environment so this package does not affect
-other Python projects. From a terminal, create and activate one in your project
-folder:
-
-```console
-# Windows (PowerShell)
-py -3.12 -m venv .venv
-.venv\Scripts\Activate.ps1
-
-# macOS or Linux
-python3 -m venv .venv
-source .venv/bin/activate
-```
 
-Then install the package from PyPI:
+Install the package from PyPI:
 
 ```console
 python -m pip install zosmfrestapi

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "zosmfrestapi"
-version = "0.1.0"
+version = "0.2.0"
 description = "A Python wrapper for the z/OSMF REST API"
 readme = "README.md"
 authors = [
@@ -27,6 +27,11 @@ Homepage = "https://sr.ht/~ocurero/zosmfrestapi/"
 Repository = "https://sr.ht/~ocurero/zosmfrestapi/"
 PyPI = "https://pypi.org/project/zosmfrestapi/"
 
+[project.optional-dependencies]
+zcrypto = [
+    "py_zcrypto",
+]
+
 [dependency-groups]
 dev = [
     "pytest (>=9.1.1,<10.0.0)",
@@ -34,15 +39,57 @@ dev = [
     "pytest-recording (>=0.14.0,<0.15.0)",
     "pytest-httpx2 (>=1.0.0,<2.0.0)",
     "pytest-cov (>=7.1.0,<8.0.0)",
+    "flake8 (>=7.5.0,<8.0.0)",
+    "flake8-pyproject (>=1.2.4,<2.0.0)",
+    "mypy (>=2.4.1,<3.0.0)",
+    "poethepoet (>=0.49.0,<0.50.0)",
+    "pyright (>=1.1.414,<2.0.0)",
+]
+zcrypto-dev = [
+    "cryptography (>=50.0.2,<51.0.0)"
 ]
 
 [tool.black]
-line-length = 88
-target-version = ["py312"]
+line-length = 96
+
+[tool.flake8]
+max-line-length = 96
+extend-ignore = ["E203", "W503"]
+per-file-ignores = "tests/*.py:E501"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
-addopts = ["-ra", "--record-mode=none", "--cov-fail-under=100", "--cov=zosmfrestapi"]
+addopts = ["-ra",
+           "--record-mode=none",
+           "--cov-fail-under=100",
+           "--cov=zosmfrestapi",
+           ]
+
+
+[tool.poe.tasks]
+format = "black ."
+
+lint = [
+    { cmd = "black --check ." },
+    { cmd = "flake8" },
+    { cmd = "mypy zosmfrestapi" },
+    { cmd = "pyright --warnings" }
+
+]
+
+test = "pytest"
+
+check = [
+    { cmd = "black --check ." },
+    { cmd = "flake8 zosmfrestapi" },
+    { cmd = "pyright --warnings" },
+    { cmd = "mypy zosmfrestapi" },
+    { cmd = "pytest" }
+]
+
+[[tool.mypy.overrides]]
+module = ["OpenSSL.*", "py_zcrypto.*"]
+ignore_missing_imports = true
 
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/__init__.py

@@ -1,8 +1,8 @@
 """Synchronous Python client for the z/OSMF REST API.
 
-The package root re-exports :class:`ZosmfClient`, response models, and public
-exceptions. Create one client per server/configuration and use it as a context
-manager to close the shared HTTP session when finished.
+The package root re-exports :class:`ZosmfClient`, :class:`ZosmfZcryptoClient`,
+response models, and public exceptions. Create one client per server/configuration and
+use it as a context manager to close the shared HTTP session when finished.
 """
 
 from zosmfrestapi.client import ZosmfClient
@@ -48,9 +48,11 @@ from zosmfrestapi.models.workflow import (
     WorkflowItem,
     WorkflowListItem,
 )
+from zosmfrestapi.zcrypto_client import ZosmfZcryptoClient
 
 __all__ = [
     "ZosmfClient",
+    "ZosmfZcryptoClient",
     "LoginOk",
     "ZosmfDatasetNotFoundError",
     "ZosmfError",

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/client.py

@@ -41,6 +41,7 @@ class ZosmfClient(
 
             with ZosmfClient("https://zosmf.example",
                              username="demouser", password="DEMOPASS",
-                             cert=("/path/to/cert", "/path/to/key")) as client:
+                             cert=("/path/to/cert", "/path/to/key"),
+                             key_password="secret") as client:
                 systems = client.get_systems()
     """

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/models/software.py

@@ -1,4 +1,4 @@
-from dataclasses import dataclass, field, fields, is_dataclass
+from dataclasses import dataclass, field
 from typing import Any
 
 import pendulum

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/models/software_updates.py

@@ -1,10 +1,7 @@
-from dataclasses import dataclass, field, fields, is_dataclass
-from typing import Any
+from dataclasses import dataclass, field
 
 import pendulum
 
-from zosmfrestapi.models.software import DataSet
-
 
 @dataclass
 class UpdateSelection:

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/models/topology.py

@@ -1,7 +1,4 @@
-from dataclasses import dataclass, field, fields, is_dataclass
-from typing import Any
-
-import pendulum
+from dataclasses import dataclass, field
 
 
 @dataclass

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/models/workflow.py

@@ -1,8 +1,6 @@
-from dataclasses import dataclass, field, fields, is_dataclass
+from dataclasses import dataclass, field
 from typing import Any
 
-import pendulum
-
 
 @dataclass
 class WorkflowAutomationStatus:

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/services/__init__.py

@@ -4,7 +4,6 @@ from types import TracebackType
 from typing import Literal, Self
 
 import httpx2
-
 from zosmfrestapi.exceptions import ZosmfAuthError, ZosmfError
 
 logger = logging.getLogger(__name__)
@@ -25,6 +24,7 @@ class ZosmfBase:
         username: str | None = None,
         password: str | None = None,
         cert: str | tuple[str, str] | None = None,
+        key_password: str | None = None,
         ltpa_token: str | None = None,
         jwt_token: str | None = None,
         jwt_cookie_name: str = "jwtToken",
@@ -49,6 +49,8 @@ class ZosmfBase:
                 PEM file containing both the certificate and private key, or
                 a ``(certificate_path, private_key_path)`` tuple for separate
                 files.
+            key_password: Optional private key password. Pass the private key
+                password if the key is password protected.
             ltpa_token: Optional LTPA token sent as the ``LtpaToken2`` cookie.
             jwt_token: Optional JWT sent as the cookie named by
                 ``jwt_cookie_name``. If both token types are provided, both
@@ -69,30 +71,28 @@ class ZosmfBase:
             ZosmfError: If ``insecure`` is combined with ``cert`` or ``cafile``.
         """
         if insecure and (cafile or cert):
-            raise ZosmfError(
-                "Cannot set insecure mode when cafile or cert is provided."
-            )
+            raise ZosmfError("Cannot set insecure mode when cafile or cert is provided.")
 
-        ctx = ssl.create_default_context()
-        if isinstance(cert, tuple):
-            certfile, keyfile = cert
-            ctx.load_cert_chain(certfile=certfile, keyfile=keyfile)
-        elif cert:
-            ctx.load_cert_chain(certfile=cert)
-        if cafile:
-            ctx.load_verify_locations(cafile=cafile)
+        verify: bool | ssl.SSLContext
         if insecure:
-            logger.debug(
-                "Insecure mode enabled, TLS certificate verification is disabled."
-            )
-            ctx = False
+            logger.debug("Insecure mode enabled, TLS certificate verification is disabled.")
+            verify = False
+        else:
+            ctx = ssl.create_default_context()
+            if isinstance(cert, tuple):
+                certfile, keyfile = cert
+                ctx.load_cert_chain(certfile=certfile, keyfile=keyfile, password=key_password)
+            elif cert:
+                ctx.load_cert_chain(certfile=cert)
+            if cafile:
+                ctx.load_verify_locations(cafile=cafile)
+            verify = ctx  # <------ linea 88
+
         proxy_config: str | httpx2.Proxy | None = proxy
         if proxy:
             proxy_config = httpx2.Proxy(proxy)
             proxy_config.auth = (
-                (proxyusername, proxypassword)
-                if proxyusername or proxypassword
-                else None
+                (proxyusername, proxypassword) if proxyusername or proxypassword else None
             )
         auth = (username, password) if username and password else None
         headers = {}
@@ -101,13 +101,11 @@ class ZosmfBase:
         if jwt_token:
             headers = {"Cookie": f"{jwt_cookie_name}={jwt_token}"}
         if ltpa_token and jwt_token:
-            headers = {
-                "Cookie": f"LtpaToken2={ltpa_token}; {jwt_cookie_name}={jwt_token}"
-            }
+            headers = {"Cookie": f"LtpaToken2={ltpa_token}; {jwt_cookie_name}={jwt_token}"}
         self.http = httpx2.Client(
             base_url=server,
             proxy=proxy_config,
-            verify=ctx,
+            verify=verify,
             auth=auth,
             headers=headers,
         )

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/services/authentication.py

@@ -26,18 +26,16 @@ class AuthenticationServices(ZosmfBase):
         token cookies.
 
         Returns:
-            A ``LoginOk`` with the response return/reason codes and message,
-            plus any LTPA or JWT tokens returned as response cookies, when the
-            endpoint responds with HTTP 200. A successful non-200 response
-            returns ``None``.
+            A ``LoginOk`` containing the response return/reason codes and
+            message, plus any LTPA or JWT tokens returned as response cookies.
 
         Raises:
             ZosmfLoginError: If z/OSMF responds with HTTP 401.
             ZosmfAuthError: If another unsuccessful HTTP status is returned.
             httpx2.RequestError: If the request fails before an HTTP response
-                is received.
+            is received.
         """
-        logger.debug(f"Authenticating with z/OSMF using all available methods")
+        logger.debug("Authenticating with z/OSMF using all available methods")
         resp = self.http.post("/zosmf/services/authenticate")
         if resp.status_code == 200:
             logger.debug("Authentication succeeded with z/OSMF")
@@ -47,7 +45,8 @@ class AuthenticationServices(ZosmfBase):
                 jwt_token=resp.cookies.get(self.jwt_cookie_name, self.jwt_token),
             )
         elif resp.status_code == 401:
-            logger.debug(f"Authentication failed with z/OSMF")
+            logger.debug("Authentication failed with z/OSMF")
             raise ZosmfLoginError(resp)
-        logger.debug(f"Unexpected authentication failure with z/OSMF")
+        logger.debug("Unexpected authentication failure with z/OSMF")
         self._raise_for_status(resp, exc_handler=ZosmfAuthError)
+        raise AssertionError("Unreachable")  # pragma: no cover

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/services/software.py

@@ -125,9 +125,7 @@ class SoftwareServices(ZosmfBase):
 
     def _get_swi_datasets(self, path: str) -> dict[
         str,
-        list[SmpeManagedDataset]
-        | list[SmpeManagedUnixDataset]
-        | list[NonSmpeManagedDataset],
+        list[SmpeManagedDataset] | list[SmpeManagedUnixDataset] | list[NonSmpeManagedDataset],
     ]:
         resp = self.http.post(path)
         if resp.status_code == 404:
@@ -156,9 +154,7 @@ class SoftwareServices(ZosmfBase):
 
     def get_swi_datasets_by_uuid(self, swiuuid: str) -> dict[
         str,
-        list[SmpeManagedDataset]
-        | list[SmpeManagedUnixDataset]
-        | list[NonSmpeManagedDataset],
+        list[SmpeManagedDataset] | list[SmpeManagedUnixDataset] | list[NonSmpeManagedDataset],
     ]:
         """Retrieve dataset inventories for a software instance by UUID.
 
@@ -185,9 +181,7 @@ class SoftwareServices(ZosmfBase):
 
     def get_swi_datasets_by_name(self, name: str, system: str) -> dict[
         str,
-        list[SmpeManagedDataset]
-        | list[SmpeManagedUnixDataset]
-        | list[NonSmpeManagedDataset],
+        list[SmpeManagedDataset] | list[SmpeManagedUnixDataset] | list[NonSmpeManagedDataset],
     ]:
         """Retrieve dataset inventories for a software instance by name.
 
@@ -264,9 +258,7 @@ class SoftwareServices(ZosmfBase):
                     else []
                 ),
                 "workflows": (
-                    [asdict(workflow) for workflow in swi.workflows]
-                    if swi.workflows
-                    else []
+                    [asdict(workflow) for workflow in swi.workflows] if swi.workflows else []
                 ),
             },
         )
@@ -333,9 +325,7 @@ class SoftwareServices(ZosmfBase):
         wait: bool,
     ) -> list[CsiEntry] | dict[str, Any]:
         if "*" in entries and len(entries) > 1:
-            raise ZosmfSoftwareManagementError(
-                "'*' cannot be combined with other entry types."
-            )
+            raise ZosmfSoftwareManagementError("'*' cannot be combined with other entry types.")
         elif "*" in subentries and len(subentries) > 1:
             raise ZosmfSoftwareManagementError(
                 "'*' cannot be combined with other subentry types."
@@ -484,6 +474,4 @@ class SoftwareServices(ZosmfBase):
             while status["status"] == "running":
                 time.sleep(2)
                 status = self._get_query_csi_status(statusurl)
-        return [
-            from_dict(data_class=CsiEntry, data=entry) for entry in status["entries"]
-        ]
+        return [from_dict(data_class=CsiEntry, data=entry) for entry in status["entries"]]

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/services/software_updates.py

@@ -47,9 +47,7 @@ class SoftwareUpdatesServices(ZosmfBase):
             for upd in resp.json()["update-processes"]
         ]
 
-    def list_sw_updates_by_uuid(
-        self, swiuuid: str, last: bool = False
-    ) -> list[UpdateProcess]:
+    def list_sw_updates_by_uuid(self, swiuuid: str, last: bool = False) -> list[UpdateProcess]:
         """List update processes for a software instance identified by UUID.
 
         If z/OSMF reports that the software instance has no update-process
@@ -102,9 +100,7 @@ class SoftwareUpdatesServices(ZosmfBase):
             f"/zosmf/swmgmt/swi/{system}/{name}/swupdate{'' if last else '/all'}"
         )
 
-    def get_sw_updates(
-        self, process_id: int, wait: bool = False
-    ) -> list[UpdateProcess]:
+    def get_sw_updates(self, process_id: int, wait: bool = False) -> list[UpdateProcess]:
         """Get the update-process records for a process ID.
 
         Args:
@@ -158,9 +154,7 @@ class SoftwareUpdatesServices(ZosmfBase):
         while status.json()["status"] == "running":
             time.sleep(2)
             status = self.http.get(status_monitor_url)
-            self._raise_for_status(
-                status, exc_handler=ZosmfSoftwareManagementRequestError
-            )
+            self._raise_for_status(status, exc_handler=ZosmfSoftwareManagementRequestError)
         if updates:
             return {
                 "lastholdrecvdate": pendulum.parse(status.json()["lastholdrecvdate"]),
@@ -396,9 +390,7 @@ class SoftwareUpdatesServices(ZosmfBase):
         while status.json()["status"] == "running":
             time.sleep(2)
             status = self.http.get(status_monitor_url)
-            self._raise_for_status(
-                status, exc_handler=ZosmfSoftwareManagementRequestError
-            )
+            self._raise_for_status(status, exc_handler=ZosmfSoftwareManagementRequestError)
         return [
             from_dict(
                 data_class=SoftwareUpdate,
@@ -658,9 +650,7 @@ class SoftwareUpdatesServices(ZosmfBase):
             httpx2.RequestError: If the request fails before an HTTP response
                 is received.
         """
-        return self._cancel_sw_update(
-            f"/zosmf/swmgmt/swi/{system}/{name}/swupdate/cancel"
-        )
+        return self._cancel_sw_update(f"/zosmf/swmgmt/swi/{system}/{name}/swupdate/cancel")
 
     def _resume_sw_update(
         self,
@@ -882,16 +872,12 @@ class SoftwareUpdatesServices(ZosmfBase):
             for process in resp.json()["update-processes"]
         ]
 
-    def _copy_output_sw_update(
-        self, path: str, output_dir: str
-    ) -> list[dict[str, Any]]:
+    def _copy_output_sw_update(self, path: str, output_dir: str) -> list[dict[str, Any]]:
         resp = self.http.put(path, params={"dir": output_dir})
         self._raise_for_status(resp, exc_handler=ZosmfSoftwareManagementError)
         return resp.json()["files"]
 
-    def copy_output_sw_update_by_uuid(
-        self, uuid: str, output_dir: str
-    ) -> list[dict[str, Any]]:
+    def copy_output_sw_update_by_uuid(self, uuid: str, output_dir: str) -> list[dict[str, Any]]:
         """Copy output files for a software instance identified by UUID.
 
         Args:

{zosmfrestapi-0.1.0 → zosmfrestapi-0.2.0}/zosmfrestapi/services/workflow.py

@@ -26,9 +26,7 @@ class WorkflowServices(ZosmfBase):
     an iterator so callers can observe each status update while polling.
     """
 
-    def _get_workflow(
-        self, workflow_id: str, steps: bool, variables: bool
-    ) -> dict[str, Any]:
+    def _get_workflow(self, workflow_id: str, steps: bool, variables: bool) -> dict[str, Any]:
         """Fetch the raw workflow response, optionally including steps/variables.
 
         This internal helper returns the JSON object before model conversion.
@@ -187,9 +185,7 @@ class WorkflowServices(ZosmfBase):
             httpx2.RequestError: If either request fails before an HTTP response
                 is received.
         """
-        resp = self.http.post(
-            "/zosmf/workflow/rest/1.0/workflows", json=to_dict(workflow)
-        )
+        resp = self.http.post("/zosmf/workflow/rest/1.0/workflows", json=to_dict(workflow))
         self._raise_for_status(resp, exc_handler=ZosmfWorkflowError)
         return self.get_workflow(resp.json()["workflowKey"])
 

zosmfrestapi-0.2.0/zosmfrestapi/testing/__init__.py

@@ -0,0 +1,11 @@
+# flake8: noqa
+
+from zosmfrestapi.testing.authentication import *
+from zosmfrestapi.testing.software import *
+from zosmfrestapi.testing.software_updates import *
+from zosmfrestapi.testing.topology import *
+from zosmfrestapi.testing.workflows import *
+
+__all__ = [
+    name for name in globals() if name.startswith("make_")
+]  # pyright: ignore[reportUnsupportedDunderAll]

zosmfrestapi-0.2.0/zosmfrestapi/testing/authentication.py

@@ -0,0 +1,48 @@
+from unittest.mock import ANY
+
+from zosmfrestapi.models.authentication import LoginOk
+
+ltpa_token = "x2q29998U26AwfYy4vc0GlK5zItaZkkXEbGQ/...<REDACTED>.../NiM1t3FQpvWRbzTsmyr2"
+
+jwt_token = (
+    "eyJraWQiOiJBTk9OWU1JWkVEX0tJRCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJ0b2tlbl90"
+    "eXBlIjoiQmVhcmVyIiwic3ViIjoiPFVTRVI+IiwidXBuIjoiPFVTRVI+IiwiZ3JvdXBzIjpbIkdST1VQX"
+    "0EiLCJHUk9VUF9CIiwiR1JPVVBfQyJdLCJyZWFsbSI6IjxSRUFMTT4iLCJpc3MiOiI8SVNTVUVSPiIsImV"
+    "4cCI6MTIzNDU2Nzg5MCwiaWF0IjoxMjM0NTYwMDAwfQ.<SIGNATURE_REDACTED>"
+)
+
+
+def make_loginok():
+    return LoginOk(
+        returnCode=0,
+        reasonCode=0,
+        message="Success.",
+        ltpa_token=ANY,
+        jwt_token=ANY,
+    )
+
+
+def make_loginok_ltpa():
+    return LoginOk(
+        returnCode=0,
+        reasonCode=0,
+        message="Success.",
+        ltpa_token=ltpa_token,
+        jwt_token=ANY,
+    )
+
+
+def make_loginok_jwt():
+    return LoginOk(
+        returnCode=0, reasonCode=0, message="Success.", ltpa_token=None, jwt_token=jwt_token
+    )
+
+
+def make_loginok_ltpa_jwt():
+    return LoginOk(
+        returnCode=0,
+        reasonCode=0,
+        message="Success.",
+        ltpa_token=ltpa_token,
+        jwt_token=jwt_token,
+    )

zosmfrestapi-0.2.0/zosmfrestapi/testing/helpers.py

@@ -0,0 +1,9 @@
+# tests/helpers.py
+
+import pendulum
+
+
+def pdt(value: str) -> pendulum.DateTime:
+    result = pendulum.parse(value)
+    assert isinstance(result, pendulum.DateTime)
+    return result