|
| 1 | +#!/usr/bin/python |
| 2 | + |
| 3 | +# copyright (c) 2026, Chris Taylor |
| 4 | +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) |
| 5 | + |
| 6 | + |
| 7 | +DOCUMENTATION = r""" |
| 8 | +--- |
| 9 | +module: deb_package |
| 10 | +short_description: Manage deb packages of a pulp api server instance |
| 11 | +description: |
| 12 | + - "This performs Create/Read/Remove operations on deb packages in the context of a repository." |
| 13 | +options: |
| 14 | + sha256: |
| 15 | + description: |
| 16 | + - sha256 digest of the deb package content to query or manipulate |
| 17 | + type: str |
| 18 | + aliases: |
| 19 | + - digest |
| 20 | + file: |
| 21 | + description: |
| 22 | + - A path to a file to be uploaded as the new package. |
| 23 | + - Alternatively this is used to calculate the checksum of the file to be removed. |
| 24 | + type: path |
| 25 | + chunk_size: |
| 26 | + description: |
| 27 | + - Chunk size in bytes used to upload the file. |
| 28 | + type: int |
| 29 | + default: 33554432 |
| 30 | + repository: |
| 31 | + description: |
| 32 | + - The repository in which the content should be present or absent. |
| 33 | + type: str |
| 34 | +extends_documentation_fragment: |
| 35 | + - pulp.squeezer.pulp.entity_state |
| 36 | + - pulp.squeezer.pulp |
| 37 | +author: |
| 38 | + - Chris Taylor (@chtaylo2) |
| 39 | + - Jacob Floyd (@cognifloyd) |
| 40 | + - Daniel Ziegenberg (@ziegenberg) |
| 41 | + - Matthias Dellweg (@mdellweg) |
| 42 | +""" |
| 43 | + |
| 44 | +EXAMPLES = r""" |
| 45 | +- name: "Read list of deb packages from pulp api server" |
| 46 | + deb_package: |
| 47 | + api_url: "localhost:24817" |
| 48 | + username: "admin" |
| 49 | + password: "password" |
| 50 | + register: "content_status" |
| 51 | +- name: "Report pulp deb packages" |
| 52 | + debug: |
| 53 | + var: "content_status" |
| 54 | +- name: "Create a deb package" |
| 55 | + deb_package: |
| 56 | + api_url: "localhost:24817" |
| 57 | + username: "admin" |
| 58 | + password: "password" |
| 59 | + sha256: "0000111122223333444455556666777788889999aaaabbbbccccddddeeeeffff" |
| 60 | + file: "data/important_package.deb" |
| 61 | + repository: "target_repository" |
| 62 | + state: "present" |
| 63 | +""" |
| 64 | + |
| 65 | +RETURN = r""" |
| 66 | + packages: |
| 67 | + description: "List of deb packages" |
| 68 | + type: "list" |
| 69 | + returned: "when digest and file are not given" |
| 70 | + package: |
| 71 | + description: "The deb package details" |
| 72 | + type: "dict" |
| 73 | + returned: "when digest or file are given" |
| 74 | +""" |
| 75 | + |
| 76 | +import os |
| 77 | +import traceback |
| 78 | + |
| 79 | +from ansible_collections.pulp.squeezer.plugins.module_utils.pulp_glue import ( |
| 80 | + PulpEntityAnsibleModule, |
| 81 | + SqueezerException, |
| 82 | +) |
| 83 | + |
| 84 | +try: |
| 85 | + from pulp_glue.deb.context import PulpAptRepositoryContext, PulpDebPackageContext |
| 86 | + |
| 87 | + PULP_GLUE_IMPORT_ERR = None |
| 88 | + |
| 89 | +except ImportError: |
| 90 | + PULP_GLUE_IMPORT_ERR = traceback.format_exc() |
| 91 | + PulpDebPackageContext = None |
| 92 | + |
| 93 | + |
| 94 | +def main(): |
| 95 | + with PulpEntityAnsibleModule( |
| 96 | + context_class=PulpDebPackageContext, |
| 97 | + entity_singular="package", |
| 98 | + entity_plural="packages", |
| 99 | + import_errors=[("pulp-glue-deb", PULP_GLUE_IMPORT_ERR)], |
| 100 | + argument_spec={ |
| 101 | + "sha256": {"aliases": ["digest"]}, |
| 102 | + "file": {"type": "path"}, |
| 103 | + "chunk_size": {"type": "int", "default": 33554432}, |
| 104 | + "repository": {}, |
| 105 | + }, |
| 106 | + required_if=[ |
| 107 | + ("state", "present", ["file", "repository"]), |
| 108 | + ("state", "absesent", ["repository"]), |
| 109 | + ], |
| 110 | + ) as module: |
| 111 | + sha256 = module.params["sha256"] |
| 112 | + if module.params["file"]: |
| 113 | + if not os.path.exists(module.params["file"]): |
| 114 | + raise SqueezerException("File not found.") |
| 115 | + file_sha256 = module.sha256(module.params["file"]) |
| 116 | + if sha256: |
| 117 | + if sha256 != file_sha256: |
| 118 | + raise SqueezerException("File checksum mismatch.") |
| 119 | + else: |
| 120 | + sha256 = file_sha256 |
| 121 | + |
| 122 | + if sha256 is None and module.state == "absent": |
| 123 | + raise SqueezerException( |
| 124 | + "One of 'file' and 'sha256' is required if 'state' is 'absent'." |
| 125 | + ) |
| 126 | + |
| 127 | + natural_key = { |
| 128 | + "sha256": sha256, |
| 129 | + } |
| 130 | + desired_attributes = {} |
| 131 | + defaults = { |
| 132 | + "file": module.params["file"], |
| 133 | + "chunk_size": module.params["chunk_size"], |
| 134 | + } |
| 135 | + |
| 136 | + if module.params["repository"]: |
| 137 | + module.context.repository_ctx = PulpAptRepositoryContext( |
| 138 | + module.pulp_ctx, entity={"name": module.params["repository"]} |
| 139 | + ) |
| 140 | + |
| 141 | + module.process(natural_key, desired_attributes, defaults=defaults) |
| 142 | + |
| 143 | + |
| 144 | +if __name__ == "__main__": |
| 145 | + main() |
0 commit comments