python-rundeck 2.0.0__py3-none-any.whl → 2.0.1__py3-none-any.whl

{python_rundeck-2.0.0.dist-info → python_rundeck-2.0.1.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: python-rundeck
-Version: 2.0.0
-Summary: Python client for the Rundeck Community API (v14-v59).
+Version: 2.0.1
+Summary: Python client for the Rundeck Community API (v14-v60, default v59).
 License-Expression: MIT
 License-File: LICENSE
 Keywords: rundeck,api,client
@@ -21,12 +21,12 @@ Classifier: Topic :: System :: Systems Administration
 Classifier: Typing :: Typed
 Provides-Extra: dev
 Requires-Dist: bandit (>=1.7.9,<2.0.0) ; extra == "dev"
-Requires-Dist: black (>=25.11.0,<26.0.0) ; extra == "dev"
+Requires-Dist: black (>=26.3.1,<27.0.0) ; extra == "dev"
 Requires-Dist: flake8 (>=7.0.0,<8.0.0) ; extra == "dev"
 Requires-Dist: isort (>=7.0.0,<8.0.0) ; extra == "dev"
-Requires-Dist: pytest (>=9.0.2,<10.0.0) ; extra == "dev"
+Requires-Dist: pytest (>=9.0.3,<10.0.0) ; extra == "dev"
 Requires-Dist: pytest-cov (>=5.0.0,<6.0.0) ; extra == "dev"
-Requires-Dist: requests (>=2.32.5,<3.0.0)
+Requires-Dist: requests (>=2.33.0,<3.0.0)
 Requires-Dist: ruff (>=0.7.0,<1.0.0) ; extra == "dev"
 Requires-Dist: safety (>=3.2.0,<4.0.0) ; extra == "dev"
 Project-URL: Changelog, https://gitlab.com/pascal.seckinger/python-rundeck/-/blob/main/CHANGELOG.md
@@ -43,7 +43,7 @@ python-rundeck
 ![License](https://img.shields.io/pypi/l/python-rundeck)
 ![Downloads](https://static.pepy.tech/badge/python-rundeck)
 
-Python client for the Rundeck Community API (v14-v59), inspired by the python-gitlab architecture. The default API version is v59; current Rundeck servers require v17 or later and versions below v34 are deprecated. Provides typed managers for Community resources (projects, jobs, executions, tokens, users, system) and SCM (import/export).
+Python client for the Rundeck Community API (v14-v60), inspired by the python-gitlab architecture. Rundeck Community 6.3.0 is the integration reference. The default API version remains v59; use `api_version=60` explicitly with 6.3.0. Current Rundeck servers require v17 or later and versions below v34 are deprecated. Provides typed managers for Community resources (projects, jobs, executions, tokens, users, system) and SCM (import/export).
 
 Version 2.0 removes commercial-only Config Management and job-tag endpoints. Cluster schedule listing and takeover are Community operations and remain available. The authorization-evaluation endpoints are experimental in Rundeck and are exposed as such by this client.
 
@@ -158,6 +158,16 @@ Utility managers:
 Note: `project.webhooks.create(...)` returns the raw API response (e.g., `{"msg": "Saved webhook"}`)
 because the Rundeck API does not return the created webhook object.
 
+Compatibility with Community 6.3.0 (2.0.1)
+---------------------------------------
+- API v60 is recognized; the default stays v59 to retain compatibility with Community 6.2.1. The new v60 cluster endpoints are Enterprise-only and excluded.
+- ACL creation and updates send the YAML text inside a JSON `contents` envelope and request JSON responses. Reads still request YAML and unwrap legacy JSON responses from older project ACL controllers. Python signatures and resource return conventions are unchanged.
+- `job.meta(meta="executionAclValid")` and `project.jobs.browse(meta="executionAclValid")` expose the server's saved-user authorization warning. It does not block execution. Plugin `outputs` and property `outputMetadata` are preserved when returned by the server.
+- Archive imports with `importConfig=True` or `importNodesSources=True` also require project `configure` authorization on 6.3.0. Use explicit `False` values for jobs-only imports. Authorization failures retain the server response in `RundeckAuthenticationError.response_body`.
+- Webhook tokens remain opaque public secrets. The server handles hashing and migration; callers must continue sending the original secret.
+- Session authentication uses standard cookie handling; 6.3.0 fixes direct HTTP authentication when the public URL is HTTPS behind forwarded headers.
+- The stable 6.3.0 sources restore the trailing slash on `${job.serverUrl}` (RUN-5051), despite the earlier release-note wording. The client does not rewrite job context URLs.
+
 Migration from 1.1.0
 -------------------
 - Set `api_version=59` explicitly when upgrading a server/client pair gradually; the default is now 59.
@@ -526,8 +536,11 @@ Development and testing
 - Formatting/Lint: `black src/rundeck tests/`, `ruff check src/rundeck tests/`
 - Typing: `mypy src/rundeck/`
 - Tests: `pytest`
-- Local integration tests: `scripts/run-integration.sh` starts Rundeck Community 6.2.1 by default with API v59. Use `RUNDECK_IMAGE=rundeck/rundeck:6.0.1 RUNDECK_API_VERSION=58` or `RUNDECK_IMAGE=rundeck/rundeck:5.18.0 RUNDECK_API_VERSION=56` for compatibility runs. Add `KEEP_STACK=1` to keep the instance running after tests. Dedicated teardown script: `scripts/stop-integration.sh`.
+- Local integration tests: `scripts/run-integration.sh` starts `rundeck/rundeck:6.3.0-20261022` with API v59. Each run has an isolated Compose project and cleans up even when tests fail. With `KEEP_STACK=1`, the script prints the project name needed by `scripts/stop-integration.sh`.
+- GitLab runs five integration targets: 6.3.0/API 59, 6.3.0/API 60, 6.2.1/API 59, 6.0.1/API 58 and 5.18.0/API 56. Set `RUNDECK_IMAGE` and `RUNDECK_API_VERSION` to run each target locally. Python compatibility tests retain 3.11–3.15 (3.15-rc Docker image).
+- To exercise the 6.3.0 session regression and legacy metrics: `RUNDECK_PUBLIC_URL=https://rundeck.example.invalid RUNDECK_METRICS_LEGACY_ENABLED=true scripts/run-integration.sh`. The client still connects to `RUNDECK_URL` (default `http://localhost:4440`). The public URL defaults to the client URL, ensuring session redirects also work on older servers. Optional `RUNDECK_HTTP_PORT` changes the published port; set `RUNDECK_URL` accordingly.
 - The docker compose stack mounts `tokens.properties` at the repo root to seed a local admin token for integration tests. This file is only intended for local testing.
+- Run local compatibility targets sequentially, stopping each stack before starting the next. This keeps at most one Rundeck JVM and one PostgreSQL container active.
 
 Code structure
 --------------

{python_rundeck-2.0.0.dist-info → python_rundeck-2.0.1.dist-info}/RECORD

@@ -2,13 +2,13 @@ rundeck/__init__.py,sha256=M413mLKjB08nWuo5godsAmk2ly9vEYw5Xzc-Pt4Pqds,951
 rundeck/base.py,sha256=TGqxLj9F4Y0x7nQGqkjuw7xitzxWOa2fn4apkjpckwE,7119
 rundeck/client.py,sha256=r3LNO9TDqjiwT-XZI_xFQeWXaajPV9AxFtBUlqe-pOc,11433
 rundeck/config.py,sha256=bVCuqD6Nk6RDS-WAt81uMh6PfQ2ocZDN51Aspjnhjxc,5331
-rundeck/const.py,sha256=UWVLKGIvC-h19Bfddehy8oRvkkQNDmPA3Q5wfMxisV4,1619
+rundeck/const.py,sha256=uDE6Qt1_RrpzuRG9xHIlv5q4tKVtpuN_zKrZYMpqVPo,1681
 rundeck/exceptions.py,sha256=3XVZi9mnsDYPqmFI-yV0wxNaTy3bdsrTRwWJKt8rqf8,4778
 rundeck/py.typed,sha256=3Q9vdii9v-_pbj9sglgDzJAIelvARaYaDJlB2u-NDqg,38
 rundeck/utils.py,sha256=L4ohGScvN1lj3HM0A1mdxEEEm3GMJ3ISm_UjBPeXQmo,940
 rundeck/v1/__init__.py,sha256=stKy-CO4DYAq_xa35LOgghZQ6LtrDcZ5WkuffNPGR0I,13
 rundeck/v1/objects/__init__.py,sha256=5n01WuyYDbuLLGGKoqO342Nb15Qgk3s5MUpJKp-o8Ko,21
-rundeck/v1/objects/acl.py,sha256=5oe-jnpSN25OVolidBkzZCus1Nd7TbE7IbBX-0e5WiY,761
+rundeck/v1/objects/acl.py,sha256=sTdOxdmsb0DL3OAQNtzZvdxDdTRkKIRZm_UpipMdpI4,1227
 rundeck/v1/objects/adhoc.py,sha256=E5cYrQfI1_fi4ReVTRAX6zcP8fZn77uc3K4XICc2E_4,2787
 rundeck/v1/objects/authorizations.py,sha256=dugrkboWxkQ0phv15CTXTwTfaJKwRRi9UK8zPWoVlmo,1751
 rundeck/v1/objects/executions.py,sha256=amX2zYZkEqwGwLXOGDoA0gdtpS57xzO-pTtvdgPvF_Q,14752
@@ -18,14 +18,14 @@ rundeck/v1/objects/key_storage.py,sha256=mPZYqgqeeI_ujvwXHGLjTwxbgoMk_Pw7ND-dlob
 rundeck/v1/objects/metrics.py,sha256=Q4amOwyZyRQltozxCiYYLWxhCdps7kN74nXDmSz2FFI,2909
 rundeck/v1/objects/plugins.py,sha256=a2vGsiQGz8V5gXNepj2KP98M926zzxRpksddKtZy5N8,1124
 rundeck/v1/objects/project_plugins.py,sha256=Ecy-kWIlUKuFspXbcH8neTYu_0qr2_XE0Pb8DzVnfBc,871
-rundeck/v1/objects/projects.py,sha256=qBoO9Eja65c_bEBUtsZJ-DluO9XEryhYVwnbQRg10dM,18586
+rundeck/v1/objects/projects.py,sha256=0D1BAzBrHzTV0pcHa1wzA5skOGGEqmV5_OsQ2NkZzQU,18645
 rundeck/v1/objects/scheduler.py,sha256=yUG_vF5SdP7g0nEkwQ5D4WfA7xeer3blAaHdp7LsnVs,2033
 rundeck/v1/objects/scm.py,sha256=Fobtecr-7GH71nTCn5Jf-6RANMVdnVQDzoFaFsrH9y8,7940
-rundeck/v1/objects/system.py,sha256=EBMO--46su825jKbVntLzv5RmDIHTIGKlZJc2KvvRWM,5004
+rundeck/v1/objects/system.py,sha256=h1sJ2fXxKp9PLL4Mz1fxMYjUe0oyjsXMSbMD20ExTas,4897
 rundeck/v1/objects/tokens.py,sha256=R36R7z8jSsRUYDmuihE8b9er7uYcyoQw3n5HbveAE5E,2578
 rundeck/v1/objects/users.py,sha256=hJFMvO1_L_Qql2_K3VvS3EXOxZow4ucQ8yLijziOL8s,3870
 rundeck/v1/objects/webhooks.py,sha256=F_HzNvlBRPvS_viu2reCRc7ECqRSUhp5RfD_G3r-ZZk,3358
-python_rundeck-2.0.0.dist-info/METADATA,sha256=Exd_mlSRz0SVVSQryk2TJRPlKIJKO05_byHdqsi8EpQ,20665
-python_rundeck-2.0.0.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
-python_rundeck-2.0.0.dist-info/licenses/LICENSE,sha256=3X-BjvCzow8iLfLMykDaEAXjE9JvDrEHPkH9UK7MMMA,1073
-python_rundeck-2.0.0.dist-info/RECORD,,
+python_rundeck-2.0.1.dist-info/METADATA,sha256=AfKPQ4AREsjZHliQ3N0LbNPWrAClq45e0CyMiBt_WmQ,23062
+python_rundeck-2.0.1.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
+python_rundeck-2.0.1.dist-info/licenses/LICENSE,sha256=3X-BjvCzow8iLfLMykDaEAXjE9JvDrEHPkH9UK7MMMA,1073
+python_rundeck-2.0.1.dist-info/RECORD,,

rundeck/const.py

@@ -40,13 +40,14 @@ FORMAT_JSON = "json"
 
 # API versions. The library remains compatible with legacy Rundeck servers
 # using v14, while current Rundeck servers require at least v17.
-API_VERSION_CURRENT = "59"
+API_VERSION_CURRENT = "60"
 API_VERSION_MIN = "14"
 API_VERSION_SERVER_MIN = "17"
 API_VERSION_DEPRECATION = "34"
 
 # Defaults
-DEFAULT_API_VERSION = API_VERSION_CURRENT
+# v60 adds Enterprise endpoints only; keep the Community-compatible default.
+DEFAULT_API_VERSION = "59"
 DEFAULT_TIMEOUT = 30
 USER_AGENT = "python-rundeck"
 

rundeck/v1/objects/acl.py

@@ -6,19 +6,32 @@ from rundeck.utils import build_headers
 
 
 class YamlPolicyMixin:
-    _yaml_content_type = "application/yaml"
+    def _get_yaml(self, path: str) -> str:
+        response = self.rd.http_get(
+            path, raw=True, headers={"Accept": "application/yaml"}
+        )
+        # Some older project ACL controllers return a JSON envelope despite Accept.
+        if (
+            "application/json"
+            in getattr(response, "headers", {}).get("Content-Type", "").lower()
+        ):
+            result = response.json()
+            if isinstance(result, dict) and isinstance(result.get("contents"), str):
+                return result["contents"]
+        return response.text
 
     def _yaml_headers(self) -> dict[str, str]:
-        headers = build_headers(
-            accept=self._yaml_content_type, content_type=self._yaml_content_type
+        return (
+            build_headers(accept="application/json", content_type="application/json")
+            or {}
         )
-        return headers or {
-            "Accept": self._yaml_content_type,
-            "Content-Type": self._yaml_content_type,
-        }
 
     def _post_yaml(self, path: str, content: Any) -> Any:
-        return self.rd.http_post(path, data=content, headers=self._yaml_headers())
+        return self.rd.http_post(
+            path, json={"contents": content}, headers=self._yaml_headers()
+        )
 
     def _put_yaml(self, path: str, content: Any) -> Any:
-        return self.rd.http_put(path, data=content, headers=self._yaml_headers())
+        return self.rd.http_put(
+            path, json={"contents": content}, headers=self._yaml_headers()
+        )

rundeck/v1/objects/projects.py

@@ -193,10 +193,7 @@ class ProjectACLManager(YamlPolicyMixin, RundeckObjectManager):
     def get(self, policy_name: str) -> str:
         """Récupère une politique ACL projet (contenu texte)."""
         path = self._build_path(policy_name)
-        response = self.rd.http_get(
-            path, raw=True, headers={"Accept": "application/yaml"}
-        )
-        return response.text
+        return self._get_yaml(path)
 
     def create(self, policy_name: str, content: str) -> dict[str, Any]:
         """Crée une politique ACL projet."""
@@ -484,6 +481,9 @@ class ProjectArchiveManager(RundeckObjectManager):
     ) -> Any:
         """
         Importe une archive ZIP dans le projet.
+
+        Community 6.3+ exige aussi le droit configure lorsque importConfig ou
+        importNodesSources est activé. Les options et refus sont transmis tels quels.
         """
         params = compact(
             component_options,

rundeck/v1/objects/system.py

@@ -67,10 +67,7 @@ class SystemACLManager(YamlPolicyMixin, RundeckObjectManager[SystemACL]):
     def get(self, policy_name: str) -> SystemACL:
         """Récupère une politique ACL (contenu texte)."""
         path = self._build_path(policy_name)
-        response = self.rd.http_get(
-            path, raw=True, headers={"Accept": "application/yaml"}
-        )
-        return self._wrap({"name": policy_name, "content": response.text})
+        return self._wrap({"name": policy_name, "content": self._get_yaml(path)})
 
     def create(self, policy_name: str, content: str) -> SystemACL:
         """Crée une politique ACL système."""