deb_distribution.py

#!/usr/bin/python

# copyright (c) 2020, Matthias Dellweg
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)


DOCUMENTATION = r"""
---
module: deb_distribution
short_description: Manage deb distributions of a pulp api server instance
description:
  - "This performs CRUD operations on deb distributions in a pulp api server instance."
options:
  name:
    description:
      - Name of the distribution to query or manipulate
    type: str
    required: false
  base_path:
    description:
      - Base path to distribute a publication
    type: str
    required: false
  publication:
    description:
      - Href of the publication to be served
    type: str
    required: false
  repository:
    description:
      - Name of the repository to be served
    type: str
    required: false
    version_added: "0.2.4"
  content_guard:
    description:
      - Name of the content guard for the served content
      - "Warning: This feature is not yet supported."
    type: str
    required: false
extends_documentation_fragment:
  - pulp.squeezer.pulp.entity_state
  - pulp.squeezer.pulp
author:
  - Matthias Dellweg (@mdellweg)
"""

EXAMPLES = r"""
- name: Read list of deb distributions from pulp api server
  pulp.squeezer.deb_distribution:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
  register: distribution_status
- name: Report pulp deb distributions
  debug:
    var: distribution_status

- name: Create a deb distribution
  pulp.squeezer.deb_distribution:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
    name: new_deb_distribution
    base_path: new/deb/dist
    publication: /pub/api/v3/publications/deb/deb/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/
    state: present

- name: Delete a deb distribution
  pulp.squeezer.deb_distribution:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
    name: new_deb_distribution
    state: absent
"""

RETURN = r"""
  distributions:
    description: List of deb distributions
    type: list
    returned: when no name is given
  distribution:
    description: Deb distribution details
    type: dict
    returned: when name is given
"""


import traceback

from ansible_collections.pulp.squeezer.plugins.module_utils.pulp_glue import (
    GLUE_DEB_VERSION_SPEC,
    PulpEntityAnsibleModule,
    assert_version,
)

try:
    from pulp_glue.core.context import PulpContentGuardContext

    PULP_GLUE_IMPORT_ERR = None
except ImportError:
    PULP_GLUE_IMPORT_ERR = traceback.format_exc()

try:
    from pulp_glue.deb import __version__ as pulp_glue_deb_version
    from pulp_glue.deb.context import PulpAptDistributionContext, PulpAptRepositoryContext

    assert_version(GLUE_DEB_VERSION_SPEC, pulp_glue_deb_version, "pulp-glue-deb")
    PULP_GLUE_DEB_IMPORT_ERR = None
except ImportError:
    PULP_GLUE_DEB_IMPORT_ERR = traceback.format_exc()
    PulpAptDistributionContext = None


def main():
    with PulpEntityAnsibleModule(
        context_class=PulpAptDistributionContext,
        entity_singular="distribution",
        entity_plural="distributions",
        import_errors=[
            ("pulp-glue", PULP_GLUE_IMPORT_ERR),
            ("pulp-glue-deb", PULP_GLUE_DEB_IMPORT_ERR),
        ],
        argument_spec={
            "name": {},
            "base_path": {},
            "publication": {},
            "repository": {},
            "content_guard": {},
        },
        required_if=[
            ("state", "present", ["name", "base_path"]),
            ("state", "absent", ["name"]),
        ],
    ) as module:
        content_guard_name = module.params["content_guard"]
        repository_name = module.params["repository"]

        natural_key = {"name": module.params["name"]}
        desired_attributes = {
            key: module.params[key]
            for key in ["base_path", "publication"]
            if module.params[key] is not None
        }

        if repository_name is not None:
            if repository_name:
                repository_ctx = PulpAptRepositoryContext(
                    module.pulp_ctx, entity={"name": repository_name}
                )
                desired_attributes["repository"] = repository_ctx.pulp_href
            else:
                desired_attributes["repository"] = ""

        if content_guard_name is not None:
            if content_guard_name:
                content_guard_ctx = PulpContentGuardContext(
                    module.pulp_ctx, entity={"name": content_guard_name}
                )
                desired_attributes["content_guard"] = content_guard_ctx.pulp_href
            else:
                desired_attributes["content_guard"] = ""

        module.process(natural_key, desired_attributes)


if __name__ == "__main__":
    main()