[PR #6605/9f47cdde backport][stable-7] New module: gitlab_merge_request.py (#6692)

New module: gitlab_merge_request.py (#6605)

* feat(gitlab_merge_request): initial module version

* feat(gitlab_merge_request): adding assignees & reviewers

* fix(gitlab_merge_request): sanity fixes

* chore(gitlab_merge_request): adding BOTMETA record

* chore(gitlab_merge_request): integration tests

* docs(gitlab_merge_request): updating modules documentation

* fix(gitlab_merge_request): proper module return values

* fix(gitlab_merge_request): remove duplicate target_branch query

* docs(gitlab_merge_request): apply improvements suggested from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

* docs(gitlab_merge_request): updates to description and minor fixes based on code review

Co-authored-by: Felix Fontein <felix@fontein.de>

* chore(gitlab_merge_request): add aliases file for integration tests

* fix(gitlab_merge_request): use with syntax for IOErrors handling

Co-authored-by: Léo GATELLIER <26511053+lgatellier@users.noreply.github.com>

* fix(gitlab_merge_request): inverted message parameters

* refactor(gitlab_merge_request): use shared find_project method

* refactor(gitlab_merge_request): use username filter for user retrieval

* fix(gitlab_merge_request): handling of empty user search result

* test(gitlab_merge_request): extends integration tests suite for merge request changes

* chore(gitlab_merge_request): sanity validation & licensing fixes

* docs(gitlab_merge_request): formatting changes to documentation

Co-authored-by: Felix Fontein <felix@fontein.de>

* chore(gitlab_merge_request): licensing of test files fixed

Co-authored-by: Felix Fontein <felix@fontein.de>

* docs(gitlab_merge_request): extends description & adds code comments

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Léo GATELLIER <26511053+lgatellier@users.noreply.github.com>
(cherry picked from commit 9f47cdde32)

Co-authored-by: Ondrej Zvara <zvara.ondrej@gmail.com>

.github/BOTMETA.yml

@@ -532,6 +532,8 @@ files:
     notify: jlozadad
   $modules/gitlab_branch.py:
     maintainers: paytroff
+  $modules/gitlab_merge_request.py:
+    maintainers: zvaraondrej
   $modules/gitlab_project_variable.py:
     maintainers: markuman
   $modules/gitlab_instance_variable.py:

plugins/modules/gitlab_merge_request.py

@@ -0,0 +1,417 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2023, Ondrej Zvara (ozvara1@gmail.com)
+# Based on code:
+# Copyright (c) 2021, Lennert Mertens (lennert@nubera.be)
+# Copyright (c) 2021, Werner Dijkerman (ikben@werner-dijkerman.nl)
+# Copyright (c) 2015, Werner Dijkerman (ikben@werner-dijkerman.nl)
+# Copyright (c) 2019, Guillaume Martinez (lunik@tiwabbit.fr)
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+DOCUMENTATION = '''
+module: gitlab_merge_request
+short_description: Create, update, or delete GitLab merge requests
+version_added: 7.1.0
+description:
+  - Creates a merge request if it does not exist.
+  - When a single merge request does exist, it will be updated if the provided parameters are different.
+  - When a single merge request does exist and O(state=absent), the merge request will be deleted.
+  - When multiple merge requests are detected, the task fails.
+  - Existing merge requests are matched based on O(title), O(source_branch), O(target_branch),
+    and O(state_filter) filters.
+author:
+  - zvaraondrej (@zvaraondrej)
+requirements:
+  - Python >= 2.7
+  - python-gitlab >= 2.3.0
+extends_documentation_fragment:
+  - community.general.auth_basic
+  - community.general.gitlab
+  - community.general.attributes
+
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
+
+options:
+  state:
+    description:
+      - Create or delete merge request.
+    default: present
+    type: str
+    choices: ["present", "absent"]
+  project:
+    description:
+      - The path or name of the project.
+    required: true
+    type: str
+  source_branch:
+    description:
+      - Merge request's source branch.
+      - Ignored while updating existing merge request.
+    required: true
+    type: str
+  target_branch:
+    description:
+      - Merge request's target branch.
+    required: true
+    type: str
+  title:
+    description:
+      - A title for the merge request.
+    type: str
+    required: true
+  description:
+    description:
+      - A description for the merge request.
+      - Gets overriden by a content of file specified at O(description_path), if found.
+    type: str
+  description_path:
+    description:
+      - A path of file containing merge request's description.
+      - Accepts MarkDown formatted files.
+    type: path
+  labels:
+    description:
+      - Comma separated list of label names.
+    type: str
+    default: ""
+  remove_source_branch:
+    description:
+      - Flag indicating if a merge request should remove the source branch when merging.
+    type: bool
+    default: false
+  state_filter:
+    description:
+      - Filter specifying state of merge requests while searching.
+    type: str
+    choices: ["opened", "closed", "locked", "merged"]
+    default: opened
+  assignee_ids:
+    description:
+      - Comma separated list of assignees usernames omitting C(@) character.
+      - Set to empty string to unassign all assignees.
+    type: str
+  reviewer_ids:
+    description:
+      - Comma separated list of reviewers usernames omitting C(@) character.
+      - Set to empty string to unassign all reviewers.
+    type: str
+'''
+
+
+EXAMPLES = '''
+- name: Create Merge Request from branch1 to branch2
+  community.general.gitlab_merge_request:
+    api_url: https://gitlab.com
+    api_token: secret_access_token
+    project: "group1/project1"
+    source_branch: branch1
+    target_branch: branch2
+    title: "Ansible demo MR"
+    description: "Demo MR description"
+    labels: "Ansible,Demo"
+    state_filter: "opened"
+    remove_source_branch: True
+    state: present
+
+- name: Delete Merge Request from branch1 to branch2
+  community.general.gitlab_merge_request:
+    api_url: https://gitlab.com
+    api_token: secret_access_token
+    project: "group1/project1"
+    source_branch: branch1
+    target_branch: branch2
+    title: "Ansible demo MR"
+    state_filter: "opened"
+    state: absent
+'''
+
+RETURN = r'''
+msg:
+  description: Success or failure message.
+  returned: always
+  type: str
+  sample: "Success"
+
+mr:
+  description: API object.
+  returned: success
+  type: dict
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.api import basic_auth_argument_spec
+from ansible.module_utils.common.text.converters import to_native, to_text
+
+from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from ansible_collections.community.general.plugins.module_utils.gitlab import (
+    auth_argument_spec, gitlab_authentication, gitlab, ensure_gitlab_package, find_project
+)
+
+
+class GitlabMergeRequest(object):
+
+    def __init__(self, module, project, gitlab_instance):
+        self._gitlab = gitlab_instance
+        self._module = module
+        self.project = project
+
+    '''
+    @param branch Name of the branch
+    '''
+    def get_branch(self, branch):
+        try:
+            return self.project.branches.get(branch)
+        except gitlab.exceptions.GitlabGetError as e:
+            self._module.fail_json(msg="Failed to get the branch: %s" % to_native(e))
+
+    '''
+    @param title Title of the Merge Request
+    @param source_branch Merge Request's source branch
+    @param target_branch Merge Request's target branch
+    @param state_filter Merge Request's state to filter on
+    '''
+    def get_mr(self, title, source_branch, target_branch, state_filter):
+        mrs = []
+        try:
+            mrs = self.project.mergerequests.list(search=title, source_branch=source_branch, target_branch=target_branch, state=state_filter)
+        except gitlab.exceptions.GitlabGetError as e:
+            self._module.fail_json(msg="Failed to list the Merge Request: %s" % to_native(e))
+
+        if len(mrs) > 1:
+            self._module.fail_json(msg="Multiple Merge Requests matched search criteria.")
+        if len(mrs) == 1:
+            try:
+                return self.project.mergerequests.get(id=mrs[0].iid)
+            except gitlab.exceptions.GitlabGetError as e:
+                self._module.fail_json(msg="Failed to get the Merge Request: %s" % to_native(e))
+
+    '''
+    @param username Name of the user
+    '''
+    def get_user(self, username):
+        users = []
+        try:
+            users = [user for user in self.project.users.list(username=username, all=True) if user.username == username]
+        except gitlab.exceptions.GitlabGetError as e:
+            self._module.fail_json(msg="Failed to list the users: %s" % to_native(e))
+
+        if len(users) > 1:
+            self._module.fail_json(msg="Multiple Users matched search criteria.")
+        elif len(users) < 1:
+            self._module.fail_json(msg="No User matched search criteria.")
+        else:
+            return users[0]
+
+    '''
+    @param users List of usernames
+    '''
+    def get_user_ids(self, users):
+        return [self.get_user(user).id for user in users]
+
+    '''
+    @param options Options of the Merge Request
+    '''
+    def create_mr(self, options):
+        if self._module.check_mode:
+            self._module.exit_json(changed=True, msg="Successfully created the Merge Request %s" % options["title"])
+
+        try:
+            return self.project.mergerequests.create(options)
+        except gitlab.exceptions.GitlabCreateError as e:
+            self._module.fail_json(msg="Failed to create Merge Request: %s " % to_native(e))
+
+    '''
+    @param mr Merge Request object to delete
+    '''
+    def delete_mr(self, mr):
+        if self._module.check_mode:
+            self._module.exit_json(changed=True, msg="Successfully deleted the Merge Request %s" % mr["title"])
+
+        try:
+            return mr.delete()
+        except gitlab.exceptions.GitlabDeleteError as e:
+            self._module.fail_json(msg="Failed to delete Merge Request: %s " % to_native(e))
+
+    '''
+    @param mr Merge Request object to update
+    '''
+    def update_mr(self, mr, options):
+        if self._module.check_mode:
+            self._module.exit_json(changed=True, msg="Successfully updated the Merge Request %s" % mr["title"])
+
+        try:
+            return self.project.mergerequests.update(mr.iid, options)
+        except gitlab.exceptions.GitlabUpdateError as e:
+            self._module.fail_json(msg="Failed to update Merge Request: %s " % to_native(e))
+
+    '''
+    @param mr Merge Request object to evaluate
+    @param options New options to update MR with
+    '''
+    def mr_has_changed(self, mr, options):
+        for key, value in options.items():
+            if value is not None:
+                # see https://gitlab.com/gitlab-org/gitlab-foss/-/issues/27355
+                if key == 'remove_source_branch':
+                    key = 'force_remove_source_branch'
+
+                if key == 'assignee_ids':
+                    if options[key] != sorted([user["id"] for user in getattr(mr, 'assignees')]):
+                        return True
+
+                elif key == 'reviewer_ids':
+                    if options[key] != sorted([user["id"] for user in getattr(mr, 'reviewers')]):
+                        return True
+
+                elif key == 'labels':
+                    if options[key] != sorted(getattr(mr, key)):
+                        return True
+
+                elif getattr(mr, key) != value:
+                    return True
+
+        return False
+
+
+def main():
+    argument_spec = basic_auth_argument_spec()
+    argument_spec.update(auth_argument_spec())
+    argument_spec.update(
+        project=dict(type='str', required=True),
+        source_branch=dict(type='str', required=True),
+        target_branch=dict(type='str', required=True),
+        title=dict(type='str', required=True),
+        description=dict(type='str', required=False),
+        labels=dict(type='str', default="", required=False),
+        description_path=dict(type='path', required=False),
+        remove_source_branch=dict(type='bool', default=False, required=False),
+        state_filter=dict(type='str', default="opened", choices=["opened", "closed", "locked", "merged"]),
+        assignee_ids=dict(type='str', required=False),
+        reviewer_ids=dict(type='str', required=False),
+        state=dict(type='str', default="present", choices=["absent", "present"]),
+    )
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        mutually_exclusive=[
+            ['api_username', 'api_token'],
+            ['api_username', 'api_oauth_token'],
+            ['api_username', 'api_job_token'],
+            ['api_token', 'api_oauth_token'],
+            ['api_token', 'api_job_token'],
+            ['description', 'description_path'],
+        ],
+        required_together=[
+            ['api_username', 'api_password'],
+        ],
+        required_one_of=[
+            ['api_username', 'api_token', 'api_oauth_token', 'api_job_token']
+        ],
+        required_if=[
+            ['state', 'present', ['source_branch', 'target_branch', 'title'], True],
+            ['state', 'absent', ['source_branch', 'target_branch', 'title'], True],
+        ],
+        supports_check_mode=True
+    )
+    ensure_gitlab_package(module)
+
+    project = module.params['project']
+    source_branch = module.params['source_branch']
+    target_branch = module.params['target_branch']
+    title = module.params['title']
+    description = module.params['description']
+    labels = module.params['labels']
+    description_path = module.params['description_path']
+    remove_source_branch = module.params['remove_source_branch']
+    state_filter = module.params['state_filter']
+    assignee_ids = module.params['assignee_ids']
+    reviewer_ids = module.params['reviewer_ids']
+    state = module.params['state']
+
+    gitlab_version = gitlab.__version__
+    if LooseVersion(gitlab_version) < LooseVersion('2.3.0'):
+        module.fail_json(msg="community.general.gitlab_merge_request requires python-gitlab Python module >= 2.3.0 (installed version: [%s])."
+                             " Please upgrade python-gitlab to version 2.3.0 or above." % gitlab_version)
+
+    gitlab_instance = gitlab_authentication(module)
+
+    this_project = find_project(gitlab_instance, project)
+    if this_project is None:
+        module.fail_json(msg="Failed to get the project: %s" % project)
+
+    this_gitlab = GitlabMergeRequest(module=module, project=this_project, gitlab_instance=gitlab_instance)
+
+    r_source_branch = this_gitlab.get_branch(source_branch)
+    if not r_source_branch:
+        module.fail_json(msg="Source branch {b} not exist.".format(b=r_source_branch))
+
+    r_target_branch = this_gitlab.get_branch(target_branch)
+    if not r_target_branch:
+        module.fail_json(msg="Destination branch {b} not exist.".format(b=r_target_branch))
+
+    this_mr = this_gitlab.get_mr(title, source_branch, target_branch, state_filter)
+
+    if state == "present":
+        if description_path:
+            try:
+                with open(description_path, 'rb') as f:
+                    description = to_text(f.read(), errors='surrogate_or_strict')
+            except IOError as e:
+                module.fail_json(msg='Cannot open {0}: {1}'.format(description_path, e))
+
+        # sorting necessary in order to properly detect changes, as we don't want to get false positive
+        # results due to differences in ids ordering; see `mr_has_changed()`
+        assignee_ids = sorted(this_gitlab.get_user_ids(assignee_ids.split(","))) if assignee_ids else []
+        reviewer_ids = sorted(this_gitlab.get_user_ids(reviewer_ids.split(","))) if reviewer_ids else []
+        labels = sorted(labels.split(",")) if labels else []
+
+        options = {
+            "target_branch": target_branch,
+            "title": title,
+            "description": description,
+            "labels": labels,
+            "remove_source_branch": remove_source_branch,
+            "reviewer_ids": reviewer_ids,
+            "assignee_ids": assignee_ids,
+        }
+
+        if not this_mr:
+            options["source_branch"] = source_branch
+
+            mr = this_gitlab.create_mr(options)
+            module.exit_json(
+                changed=True, msg="Created the Merge Request {t} from branch {s} to branch {d}.".format(t=title, d=target_branch, s=source_branch),
+                mr=mr.asdict()
+            )
+        else:
+            if this_gitlab.mr_has_changed(this_mr, options):
+                mr = this_gitlab.update_mr(this_mr, options)
+                module.exit_json(
+                    changed=True, msg="Merge Request {t} from branch {s} to branch {d} updated.".format(t=title, d=target_branch, s=source_branch),
+                    mr=mr
+                )
+            else:
+                module.exit_json(
+                    changed=False, msg="Merge Request {t} from branch {s} to branch {d} already exist".format(t=title, d=target_branch, s=source_branch),
+                    mr=this_mr.asdict()
+                )
+    elif this_mr and state == "absent":
+        mr = this_gitlab.delete_mr(this_mr)
+        module.exit_json(
+            changed=True, msg="Merge Request {t} from branch {s} to branch {d} deleted.".format(t=title, d=target_branch, s=source_branch),
+            mr=mr
+        )
+    else:
+        module.exit_json(changed=False, msg="No changes are needed.", mr=this_mr.asdict())
+
+
+if __name__ == '__main__':
+    main()

tests/integration/targets/gitlab_merge_request/aliases

@@ -0,0 +1,6 @@
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+gitlab/ci
+disabled

tests/integration/targets/gitlab_merge_request/defaults/main.yml

@@ -0,0 +1,14 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+gitlab_source_branch: ansible_test_source_branch
+gitlab_target_branch: ansible_test_target_project
+gitlab_project_name: ansible_test_project
+gitlab_project_group: ansible_test_group
+gitlab_host: ansible_test_host
+gitlab_api_token: ansible_test_api_token
+gitlab_labels: ansible_test_label
+gitlab_assignee_ids: ansible_test_assignee_ids
+gitlab_description_path: ansible_test_description_path

tests/integration/targets/gitlab_merge_request/files/description.md

@@ -0,0 +1,9 @@
+<!--
+Copyright (c) Ansible Project
+GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
+
+### Description
+
+Merge Request test description

tests/integration/targets/gitlab_merge_request/tasks/main.yml

@@ -0,0 +1,129 @@
+---
+####################################################################
+# WARNING: These are designed specifically for Ansible tests       #
+# and should not be used as examples of how to write Ansible roles #
+####################################################################
+
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: Install required libs
+  pip:
+    name: python-gitlab
+    state: present
+
+- block:
+  - name: Create {{ gitlab_project_name }}
+    gitlab_project:
+      api_url: "{{ gitlab_host }}"
+      validate_certs: true
+      api_token: "{{ gitlab_api_token }}"
+      name: "{{ gitlab_project_name }}"
+      group: "{{ gitlab_project_group }}"
+      default_branch: "{{ gitlab_target_branch }}"
+      initialize_with_readme: true
+      state: present
+
+  - name: Create branch {{ gitlab_source_branch }}
+    gitlab_branch:
+      api_url: "{{ gitlab_host }}"
+      api_token: "{{ gitlab_api_token }}"
+      project: "{{ gitlab_project_group }}/{{ gitlab_project_name }}"
+      branch: "{{ gitlab_source_branch }}"
+      ref_branch: "{{ gitlab_target_branch }}"
+      state: present
+
+  - name: Create Merge Request
+    gitlab_merge_request:
+      api_url: "{{ gitlab_host }}"
+      api_token: "{{ gitlab_api_token }}"
+      project: "{{ gitlab_project_group }}/{{ gitlab_project_name }}"
+      source_branch: "{{gitlab_source_branch}}"
+      target_branch: "{{gitlab_target_branch}}"
+      title: "Ansible test merge request"
+      description: "Test description"
+      labels: ""
+      state_filter: "opened"
+      assignee_ids: ""
+      reviewer_ids: ""
+      remove_source_branch: True
+      state: present
+    register: gitlab_merge_request_create
+
+  - name: Test Merge Request Created
+    assert:
+      that:
+        - gitlab_merge_request_create is changed
+
+  - name: Create Merge Request ( Idempotency test )
+    gitlab_merge_request:
+      api_url: "{{ gitlab_host }}"
+      api_token: "{{ gitlab_api_token }}"
+      project: "{{ gitlab_project_group }}/{{ gitlab_project_name }}"
+      source_branch: "{{gitlab_source_branch}}"
+      target_branch: "{{gitlab_target_branch}}"
+      title: "Ansible test merge request"
+      description: "Test description"
+      labels: ""
+      state_filter: "opened"
+      assignee_ids: ""
+      reviewer_ids: ""
+      remove_source_branch: True
+      state: present
+    register: gitlab_merge_request_create_idempotence
+
+  - name: Test module is idempotent
+    assert:
+      that:
+        - gitlab_merge_request_create_idempotence is not changed
+
+  - name: Update Merge Request Test
+    gitlab_merge_request:
+      api_url: "{{ gitlab_host }}"
+      api_token: "{{ gitlab_api_token }}"
+      project: "{{ gitlab_project_group }}/{{ gitlab_project_name }}"
+      source_branch: "{{gitlab_source_branch}}"
+      target_branch: "{{gitlab_target_branch}}"
+      title: "Ansible test merge request"
+      description_path: "{{gitlab_description_path}}"
+      labels: "{{ gitlab_labels }}"
+      state_filter: "opened"
+      assignee_ids: "{{ gitlab_assignee_ids }}"
+      reviewer_ids: ""
+      remove_source_branch: True
+      state: present
+    register: gitlab_merge_request_udpate
+
+  - name: Test merge request updated
+    assert:
+      that:
+        - gitlab_merge_request_udpate.mr.labels[0] == "{{ gitlab_labels }}"
+        - gitlab_merge_request_udpate.mr.assignees[0].username == "{{ gitlab_assignee_ids }}"
+        - "'### Description\n\nMerge Request test description' in gitlab_merge_request_udpate.mr.description"
+
+  - name: Delete Merge Request
+    gitlab_merge_request:
+      api_url: "{{ gitlab_host }}"
+      api_token: "{{ gitlab_api_token }}"
+      project: "{{ gitlab_project_group }}/{{ gitlab_project_name }}"
+      source_branch: "{{gitlab_source_branch}}"
+      target_branch: "{{gitlab_target_branch}}"
+      title: "Ansible test merge request"
+      state: absent
+    register: gitlab_merge_request_delete
+
+  - name: Test merge request is deleted
+    assert:
+      that:
+        - gitlab_merge_request_delete is changed
+
+  always:
+  - name: Clean up {{ gitlab_project_name }}
+    gitlab_project:
+      api_url: "{{ gitlab_host }}"
+      validate_certs: false
+      api_token: "{{ gitlab_api_token }}"
+      name: "{{ gitlab_project_name }}"
+      group: "{{ gitlab_project_group }}"
+      state: absent