add support for pulp_labels key to deb_repository

Author: philnewm

plugins/modules/deb_repository.py

@@ -23,6 +23,11 @@
     description:
       - An optional remote to use by default when syncing
     type: str
+  pulp_labels:
+    description:
+      - A dictionary assigning pulp labels using strings for keys and values
+    type: dict
+    version_added: "0.4.0"
 extends_documentation_fragment:
   - pulp.squeezer.pulp.entity_state
   - pulp.squeezer.pulp
@@ -113,6 +118,7 @@ def main():
             "name": {},
             "description": {},
             "remote": {},
+            "pulp_labels": {"type": "dict"},
         },
         required_if=[("state", "present", ["name"]), ("state", "absent", ["name"])],
     ) as module:
@@ -130,6 +136,16 @@ def main():
         if module.params["description"] is not None:
             desired_attributes["description"] = module.params["description"]
 
+        if module.params["pulp_labels"] is not None:
+            labels = module.params["pulp_labels"]
+
+            # Ensure `pulp_labels` contains only strings for keys and values
+            if not all(isinstance(k, str) and isinstance(v, str) for k, v in labels.items()):
+                module.fail_json(
+                    msg="pulp_labels must be a dictionary with strings as keys and values"
+                )
+            desired_attributes["pulp_labels"] = labels
+
         module.process(natural_key, desired_attributes)
 
 

tests/fixtures/deb_repository-0.yml

@@ -2,14 +2,22 @@ interactions:
 - request:
     body: null
     headers:
-      Accept:
-      - application/json
+      ? !!python/object/new:multidict._multidict_py.istr
+        args:
+        - Accept
+        state:
+          __istr_identity__: Accept
+      : - application/json
       Accept-Encoding:
-      - gzip, deflate
+      - gzip, deflate, zstd
       Connection:
       - keep-alive
-      User-Agent:
-      - Squeezer/0.3.0-dev
+      ? !!python/object/new:multidict._multidict_py.istr
+        args:
+        - User-Agent
+        state:
+          __istr_identity__: User-Agent
+      : - Squeezer/0.4.0-dev
     method: GET
     uri: http://pulp.example.org/pulp/api/v3/repositories/deb/apt/?name=test_deb_repository&offset=0&limit=1
   response:
@@ -27,11 +35,11 @@ interactions:
       Content-Type:
       - application/json
       Correlation-ID:
-      - a2e44d4612a1493c8b719f92aa6fe9ad
+      - 9f23225ad146416ba1d4d24f3d818a4a
       Cross-Origin-Opener-Policy:
       - same-origin
       Date:
-      - Mon, 27 Oct 2025 11:43:30 GMT
+      - Tue, 26 May 2026 10:57:20 GMT
       Referrer-Policy:
       - same-origin
       Server:
@@ -48,25 +56,33 @@ interactions:
 - request:
     body: '{"description": null, "name": "test_deb_repository"}'
     headers:
-      Accept:
-      - application/json
+      ? !!python/object/new:multidict._multidict_py.istr
+        args:
+        - Accept
+        state:
+          __istr_identity__: Accept
+      : - application/json
       Accept-Encoding:
-      - gzip, deflate
+      - gzip, deflate, zstd
       Connection:
       - keep-alive
       Content-Length:
       - '52'
       Correlation-Id:
-      - a2e44d4612a1493c8b719f92aa6fe9ad
-      User-Agent:
-      - Squeezer/0.3.0-dev
+      - 9f23225ad146416ba1d4d24f3d818a4a
+      ? !!python/object/new:multidict._multidict_py.istr
+        args:
+        - User-Agent
+        state:
+          __istr_identity__: User-Agent
+      : - Squeezer/0.4.0-dev
       content-type:
       - application/json
     method: POST
     uri: http://pulp.example.org/pulp/api/v3/repositories/deb/apt/
   response:
     body:
-      string: '{"pulp_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/","prn":"prn:deb.aptrepository:019a257b-06c2-7a0e-aa73-d444977f24ee","pulp_created":"2025-10-27T11:43:31.011084Z","pulp_last_updated":"2025-10-27T11:43:31.014854Z","versions_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/versions/","pulp_labels":{},"latest_version_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/versions/0/","name":"test_deb_repository","description":null,"retain_repo_versions":null,"remote":null,"publish_upstream_release_fields":true,"signing_service":null,"signing_service_release_overrides":{}}'
+      string: '{"pulp_href":"/pulp/api/v3/repositories/deb/apt/019e63ee-9688-783a-b803-3075d01e6c85/","prn":"prn:deb.aptrepository:019e63ee-9688-783a-b803-3075d01e6c85","pulp_created":"2026-05-26T10:57:21.033732Z","pulp_last_updated":"2026-05-26T10:57:21.040401Z","versions_href":"/pulp/api/v3/repositories/deb/apt/019e63ee-9688-783a-b803-3075d01e6c85/versions/","pulp_labels":{},"latest_version_href":"/pulp/api/v3/repositories/deb/apt/019e63ee-9688-783a-b803-3075d01e6c85/versions/0/","name":"test_deb_repository","description":null,"retain_repo_versions":null,"retain_checkpoints":null,"remote":null,"autopublish":false,"publish_upstream_release_fields":true,"signing_service":null,"signing_service_release_overrides":{}}'
     headers:
       Access-Control-Expose-Headers:
       - Correlation-ID
@@ -75,17 +91,17 @@ interactions:
       Connection:
       - keep-alive
       Content-Length:
-      - '663'
+      - '709'
       Content-Type:
       - application/json
       Correlation-ID:
-      - a2e44d4612a1493c8b719f92aa6fe9ad
+      - 9f23225ad146416ba1d4d24f3d818a4a
       Cross-Origin-Opener-Policy:
       - same-origin
       Date:
-      - Mon, 27 Oct 2025 11:43:31 GMT
+      - Tue, 26 May 2026 10:57:21 GMT
       Location:
-      - /pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/
+      - /pulp/api/v3/repositories/deb/apt/019e63ee-9688-783a-b803-3075d01e6c85/
       Referrer-Policy:
       - same-origin
       Server:

tests/fixtures/deb_repository-1.yml

@@ -2,20 +2,28 @@ interactions:
 - request:
     body: null
     headers:
-      Accept:
-      - application/json
+      ? !!python/object/new:multidict._multidict_py.istr
+        args:
+        - Accept
+        state:
+          __istr_identity__: Accept
+      : - application/json
       Accept-Encoding:
-      - gzip, deflate
+      - gzip, deflate, zstd
       Connection:
       - keep-alive
-      User-Agent:
-      - Squeezer/0.3.0-dev
+      ? !!python/object/new:multidict._multidict_py.istr
+        args:
+        - User-Agent
+        state:
+          __istr_identity__: User-Agent
+      : - Squeezer/0.4.0-dev
     method: GET
-    uri: http://pulp.example.org/pulp/api/v3/repositories/deb/apt/?name=test_deb_repository&offset=0&limit=1
+    uri: http://pulp.example.org/pulp/api/v3/repositories/deb/apt/?offset=0&limit=1000
   response:
     body:
-      string: '{"count":1,"next":null,"previous":null,"results":[{"pulp_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/","prn":"prn:deb.aptrepository:019a257b-06c2-7a0e-aa73-d444977f24ee","pulp_created":"2025-10-27T11:43:31.011084Z","pulp_last_updated":"2025-10-27T11:43:32.854212Z","versions_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/versions/","pulp_labels":{},"latest_version_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/versions/0/","name":"test_deb_repository","description":"repository
-        created via ansible","retain_repo_versions":null,"remote":"/pulp/api/v3/remotes/deb/apt/019a257a-fb12-7498-9bc2-5bac5ad0bd5c/","publish_upstream_release_fields":true,"signing_service":null,"signing_service_release_overrides":{}}]}'
+      string: '{"count":1,"next":null,"previous":null,"results":[{"pulp_href":"/pulp/api/v3/repositories/deb/apt/019e63ee-9688-783a-b803-3075d01e6c85/","prn":"prn:deb.aptrepository:019e63ee-9688-783a-b803-3075d01e6c85","pulp_created":"2026-05-26T10:57:21.033732Z","pulp_last_updated":"2026-05-26T10:57:26.342006Z","versions_href":"/pulp/api/v3/repositories/deb/apt/019e63ee-9688-783a-b803-3075d01e6c85/versions/","pulp_labels":{"test_label":"1"},"latest_version_href":"/pulp/api/v3/repositories/deb/apt/019e63ee-9688-783a-b803-3075d01e6c85/versions/0/","name":"test_deb_repository","description":"repository
+        created via ansible","retain_repo_versions":null,"retain_checkpoints":null,"remote":"/pulp/api/v3/remotes/deb/apt/019e63ee-8f11-7942-9aac-75e8f23f355c/","autopublish":false,"publish_upstream_release_fields":true,"signing_service":null,"signing_service_release_overrides":{}}]}'
     headers:
       Access-Control-Expose-Headers:
       - Correlation-ID
@@ -24,163 +32,15 @@ interactions:
       Connection:
       - keep-alive
       Content-Length:
-      - '807'
-      Content-Type:
-      - application/json
-      Correlation-ID:
-      - 29a42fc86676483c922f8f4e831d898c
-      Cross-Origin-Opener-Policy:
-      - same-origin
-      Date:
-      - Mon, 27 Oct 2025 11:43:34 GMT
-      Referrer-Policy:
-      - same-origin
-      Server:
-      - nginx/1.22.1
-      Vary:
-      - Accept
-      X-Content-Type-Options:
-      - nosniff
-      X-Frame-Options:
-      - DENY
-    status:
-      code: 200
-      message: OK
-- request:
-    body: '{"description": null}'
-    headers:
-      Accept:
-      - application/json
-      Accept-Encoding:
-      - gzip, deflate
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '21'
-      Correlation-Id:
-      - 29a42fc86676483c922f8f4e831d898c
-      User-Agent:
-      - Squeezer/0.3.0-dev
-      content-type:
-      - application/json
-    method: PATCH
-    uri: http://pulp.example.org/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/
-  response:
-    body:
-      string: '{"task":"/pulp/api/v3/tasks/019a257b-15dc-7190-8cc8-67af6a574b0a/"}'
-    headers:
-      Access-Control-Expose-Headers:
-      - Correlation-ID
-      Allow:
-      - GET, PUT, PATCH, DELETE, HEAD, OPTIONS
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '67'
-      Content-Type:
-      - application/json
-      Correlation-ID:
-      - 29a42fc86676483c922f8f4e831d898c
-      Cross-Origin-Opener-Policy:
-      - same-origin
-      Date:
-      - Mon, 27 Oct 2025 11:43:34 GMT
-      Referrer-Policy:
-      - same-origin
-      Server:
-      - nginx/1.22.1
-      Vary:
-      - Accept
-      X-Content-Type-Options:
-      - nosniff
-      X-Frame-Options:
-      - DENY
-    status:
-      code: 202
-      message: Accepted
-- request:
-    body: null
-    headers:
-      Accept:
-      - application/json
-      Accept-Encoding:
-      - gzip, deflate
-      Connection:
-      - keep-alive
-      Correlation-Id:
-      - 29a42fc86676483c922f8f4e831d898c
-      User-Agent:
-      - Squeezer/0.3.0-dev
-    method: GET
-    uri: http://pulp.example.org/pulp/api/v3/tasks/019a257b-15dc-7190-8cc8-67af6a574b0a/
-  response:
-    body:
-      string: '{"pulp_href":"/pulp/api/v3/tasks/019a257b-15dc-7190-8cc8-67af6a574b0a/","prn":"prn:core.task:019a257b-15dc-7190-8cc8-67af6a574b0a","pulp_created":"2025-10-27T11:43:34.877686Z","pulp_last_updated":"2025-10-27T11:43:34.876376Z","state":"completed","name":"pulpcore.app.tasks.base.ageneral_update","logging_cid":"29a42fc86676483c922f8f4e831d898c","created_by":"/pulp/api/v3/users/1/","unblocked_at":"2025-10-27T11:43:34.883927Z","started_at":"2025-10-27T11:43:34.884699Z","finished_at":"2025-10-27T11:43:34.892733Z","error":null,"worker":null,"parent_task":null,"child_tasks":[],"task_group":null,"progress_reports":[],"created_resources":[],"reserved_resources_record":["prn:deb.aptrepository:019a257b-06c2-7a0e-aa73-d444977f24ee","shared:prn:core.domain:9f85dc51-beb2-4a9e-978e-41fef887ee2f"],"result":{"prn":"prn:deb.aptrepository:019a257b-06c2-7a0e-aa73-d444977f24ee","name":"test_deb_repository","remote":"/pulp/api/v3/remotes/deb/apt/019a257a-fb12-7498-9bc2-5bac5ad0bd5c/","pulp_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/","description":null,"pulp_labels":{},"pulp_created":"2025-10-27T11:43:31.011084Z","versions_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/versions/","signing_service":null,"pulp_last_updated":"2025-10-27T11:43:34.888315Z","latest_version_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/versions/0/","retain_repo_versions":null,"publish_upstream_release_fields":true,"signing_service_release_overrides":{}}}'
-    headers:
-      Access-Control-Expose-Headers:
-      - Correlation-ID
-      Allow:
-      - GET, PATCH, DELETE, HEAD, OPTIONS
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '1529'
-      Content-Type:
-      - application/json
-      Correlation-ID:
-      - 29a42fc86676483c922f8f4e831d898c
-      Cross-Origin-Opener-Policy:
-      - same-origin
-      Date:
-      - Mon, 27 Oct 2025 11:43:34 GMT
-      Referrer-Policy:
-      - same-origin
-      Server:
-      - nginx/1.22.1
-      Vary:
-      - Accept
-      X-Content-Type-Options:
-      - nosniff
-      X-Frame-Options:
-      - DENY
-    status:
-      code: 200
-      message: OK
-- request:
-    body: null
-    headers:
-      Accept:
-      - application/json
-      Accept-Encoding:
-      - gzip, deflate
-      Connection:
-      - keep-alive
-      Correlation-Id:
-      - 29a42fc86676483c922f8f4e831d898c
-      User-Agent:
-      - Squeezer/0.3.0-dev
-    method: GET
-    uri: http://pulp.example.org/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/
-  response:
-    body:
-      string: '{"pulp_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/","prn":"prn:deb.aptrepository:019a257b-06c2-7a0e-aa73-d444977f24ee","pulp_created":"2025-10-27T11:43:31.011084Z","pulp_last_updated":"2025-10-27T11:43:34.888315Z","versions_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/versions/","pulp_labels":{},"latest_version_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/versions/0/","name":"test_deb_repository","description":null,"retain_repo_versions":null,"remote":"/pulp/api/v3/remotes/deb/apt/019a257a-fb12-7498-9bc2-5bac5ad0bd5c/","publish_upstream_release_fields":true,"signing_service":null,"signing_service_release_overrides":{}}'
-    headers:
-      Access-Control-Expose-Headers:
-      - Correlation-ID
-      Allow:
-      - GET, PUT, PATCH, DELETE, HEAD, OPTIONS
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '727'
+      - '869'
       Content-Type:
       - application/json
       Correlation-ID:
-      - 29a42fc86676483c922f8f4e831d898c
+      - 3d73c5ecc4a541988b350ac04424fa48
       Cross-Origin-Opener-Policy:
       - same-origin
       Date:
-      - Mon, 27 Oct 2025 11:43:35 GMT
+      - Tue, 26 May 2026 10:57:28 GMT
       Referrer-Policy:
       - same-origin
       Server:

tests/fixtures/deb_repository-10.yml

@@ -2,19 +2,28 @@ interactions:
 - request:
     body: null
     headers:
-      Accept:
-      - application/json
+      ? !!python/object/new:multidict._multidict_py.istr
+        args:
+        - Accept
+        state:
+          __istr_identity__: Accept
+      : - application/json
       Accept-Encoding:
-      - gzip, deflate
+      - gzip, deflate, zstd
       Connection:
       - keep-alive
-      User-Agent:
-      - Squeezer/0.3.0-dev
+      ? !!python/object/new:multidict._multidict_py.istr
+        args:
+        - User-Agent
+        state:
+          __istr_identity__: User-Agent
+      : - Squeezer/0.4.0-dev
     method: GET
     uri: http://pulp.example.org/pulp/api/v3/repositories/deb/apt/?name=test_deb_repository&offset=0&limit=1
   response:
     body:
-      string: '{"count":1,"next":null,"previous":null,"results":[{"pulp_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/","prn":"prn:deb.aptrepository:019a257b-06c2-7a0e-aa73-d444977f24ee","pulp_created":"2025-10-27T11:43:31.011084Z","pulp_last_updated":"2025-10-27T11:43:34.888315Z","versions_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/versions/","pulp_labels":{},"latest_version_href":"/pulp/api/v3/repositories/deb/apt/019a257b-06c2-7a0e-aa73-d444977f24ee/versions/0/","name":"test_deb_repository","description":null,"retain_repo_versions":null,"remote":"/pulp/api/v3/remotes/deb/apt/019a257a-fb12-7498-9bc2-5bac5ad0bd5c/","publish_upstream_release_fields":true,"signing_service":null,"signing_service_release_overrides":{}}]}'
+      string: '{"count":1,"next":null,"previous":null,"results":[{"pulp_href":"/pulp/api/v3/repositories/deb/apt/019e63ee-9688-783a-b803-3075d01e6c85/","prn":"prn:deb.aptrepository:019e63ee-9688-783a-b803-3075d01e6c85","pulp_created":"2026-05-26T10:57:21.033732Z","pulp_last_updated":"2026-05-26T10:57:26.342006Z","versions_href":"/pulp/api/v3/repositories/deb/apt/019e63ee-9688-783a-b803-3075d01e6c85/versions/","pulp_labels":{"test_label":"1"},"latest_version_href":"/pulp/api/v3/repositories/deb/apt/019e63ee-9688-783a-b803-3075d01e6c85/versions/0/","name":"test_deb_repository","description":"repository
+        created via ansible","retain_repo_versions":null,"retain_checkpoints":null,"remote":"/pulp/api/v3/remotes/deb/apt/019e63ee-8f11-7942-9aac-75e8f23f355c/","autopublish":false,"publish_upstream_release_fields":true,"signing_service":null,"signing_service_release_overrides":{}}]}'
     headers:
       Access-Control-Expose-Headers:
       - Correlation-ID
@@ -23,15 +32,15 @@ interactions:
       Connection:
       - keep-alive
       Content-Length:
-      - '779'
+      - '869'
       Content-Type:
       - application/json
       Correlation-ID:
-      - b80bf7dd567a4c648ec7cd2d4f4eb2b5
+      - 7655612813264db49c23b8a0c456f972
       Cross-Origin-Opener-Policy:
       - same-origin
       Date:
-      - Mon, 27 Oct 2025 11:43:35 GMT
+      - Tue, 26 May 2026 10:57:28 GMT
       Referrer-Policy:
       - same-origin
       Server: