NEW Source Control module: git add/commit/push

lib/ansible/modules/source_control/git_acp.py

@@ -0,0 +1,260 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2016, Cumulus Networks <ce-ceng@cumulusnetworks.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+DOCUMENTATION = '''
+---
+module: git_acp
+author:
+    - "Federico Olivieri (@Federico87)"
+version_added: "2.10"
+short_description: Perform git commiit and/or git push perations.
+description:
+    - Manage git commits and git push on local git directory
+options:
+    folder_path:
+        description:
+            - full folder path where .git/ is located.
+        required: true
+        type: str
+    user:
+        description:
+            - git username for https operations.
+        type: str
+    token:
+        description:
+            - git API token for https operations.
+        type: str
+    comment:
+        description:
+            - git commit comment. Same as "git commit -m".
+        type: str
+        required: true
+    add:
+        description:
+            - list of files to be staged. Same as "git add ."
+              Asterisx values not accepted. i.e. "./*" or "*".
+        type: list
+        default: ["."]
+        elements: str
+    branch:
+        description:
+            - git branch where perform git push.
+        required: True
+        type: str
+    push_option:
+        description:
+            - git push options. Same as "git --push-option=option".
+        type: str
+    mode:
+        description:
+            - git operations are performend eithr over ssh channel or https.
+              Same as "git@git..." or "https://user:token@git..."
+        choices: ['ssh', 'https']
+        default: ssh
+        type: str
+    url:
+        description:
+            - git repo URL. If not provided, the module will use the same mode used by "git clone".
+        type: str
+requirements:
+    - git>=2.19.0 (the command line tool)
+'''
+
+EXAMPLES = '''
+
+# Commit and push changes via https.
+- git_acp:
+    folder_path: /Users/federicoolivieri/git/git_test_module
+    user: Federico87
+    token: m1Ap!T0k3n!!!
+    comment: My amazing backup
+    add: ['test.txt', 'txt.test']
+    branch: master
+    push: true
+    commit: true
+    mode: https
+    url: https://gitlab.com/networkAutomation/git_test_module
+
+# Push changes via ssh using some defaults.
+- git_acp:
+    folder_path: /Users/federicoolivieri/git/git_test_module
+    comment: My amazing backup
+    branch: master
+    push: true
+    commit: false
+    url: git@gitlab.com/networkAutomation/git_test_module
+
+# Commit and push changes using only defaults.
+- git_acp:
+    folder_path: /Users/federicoolivieri/git/git_test_module
+    comment: My amazing backup
+    branch: master
+'''
+
+RETURN = '''
+output:
+    description: list of git cli commands stdout
+    type: list
+    returned: always
+    sample: [
+        "[master 99830f4] Remove [ test.txt, tax.txt ]\n 4 files changed, 26 insertions(+)...",
+        "To https://gitlab.com/networkAutomation/git_test_module.git\n   372db19..99830f4  master -> master\n"
+    ]
+'''
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'core'}
+
+import os
+
+from ansible.module_utils.basic import AnsibleModule
+
+
+def git_commit(module):
+
+    commands = list()
+
+    add = module.params.get('add')
+    folder_path = module.params.get('folder_path')
+    comment = module.params.get('comment')
+
+    if add:
+        commands.append('git -C {0} add {1}'.format(
+            folder_path,
+            ' '.join(add)
+        ))
+
+    if comment:
+        commands.append('git -C {0} commit -m "{1}"'.format(
+            folder_path,
+            comment
+        ))
+
+    return commands
+
+
+def git_push(module):
+
+    commands = list()
+
+    folder_path = module.params.get('folder_path')
+    url = module.params.get('url')
+    user = module.params.get('user')
+    token = module.params.get('token')
+    branch = module.params.get('branch')
+    push_option = module.params.get('push_option')
+    mode = module.params.get('mode')
+
+    def https(folder_path, user, token, url, branch, push_option):
+        if url.startswith('https://'):
+            remote_add = 'git -C {folder_path} remote set-url origin https://{user}:{token}@{url}'.format(
+                folder_path=folder_path,
+                url=url[8:],
+                user=user,
+                token=token,
+            )
+            cmd = 'git -C {folder_path} push origin {branch}'.format(
+                folder_path=folder_path,
+                branch=branch,
+            )
+
+        if push_option:
+            index = cmd.find('origin')
+            return [remote_add, cmd[:index] + '--push-option={option} '.format(option=push_option) + cmd[index:]]
+
+        if not push_option:
+            return [remote_add, cmd]
+
+    if mode == 'https':
+        for cmd in https(folder_path, user, token, url, branch, push_option):
+            commands.append(cmd)
+
+    if mode == 'ssh':
+        if 'https' in url:
+            module.fail_json(msg='SSH mode selected but HTTPS URL provided')
+
+        remote_add = 'git -C {folder_path} remote set-url origin {url}'.format(
+            folder_path=folder_path,
+            url=url,
+        )
+        cmd = 'git -C {folder_path} push origin {branch}'.format(
+            folder_path=folder_path,
+            branch=branch
+        )
+        commands.append(remote_add)
+
+        if push_option:
+            index = cmd.find('origin')
+            commands.append(cmd[:index] + '--push-option={option} '.format(option=push_option) + cmd[index:])
+
+        if not push_option:
+            commands.append(cmd)
+
+    return commands
+
+
+def main():
+
+    argument_spec = dict(
+        folder_path=dict(required=True),
+        user=dict(),
+        token=dict(),
+        comment=dict(required=True),
+        add=dict(type="list", elements='str', default=["."]),
+        branch=dict(required=True),
+        push_option=dict(),
+        mode=dict(choices=["ssh", "https"], default='ssh'),
+        url=dict(),
+    )
+
+    required_if = [
+        ("mode", "https", ["user", "token"]),
+    ]
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        required_if=required_if,
+    )
+
+    result = dict(changed=False)
+
+    git_commands = git_commit(module) + git_push(module)
+
+    result_output = list()
+
+    for cmd in git_commands:
+        _rc, output, error = module.run_command(cmd, check_rc=False)
+
+        if output:
+            if 'no changes added to commit' in output:
+                module.fail_json(msg=output)
+            elif 'nothing to commit, working tree clean' in output:
+                module.fail_json(msg=output)
+            else:
+                result_output.append(output)
+
+        if error:
+            if 'error:' in error:
+                module.fail_json(msg=error)
+            elif 'fatal:' in error:
+                module.fail_json(msg=error)
+            else:
+                result_output.append(error)
+
+    if result_output:
+        result.update(output=result_output)
+        result.update(changed=True)
+
+    module.exit_json(**result)
+
+
+if __name__ == "__main__":
+    main()

test/integration/targets/git_acp/aliases

@@ -0,0 +1,2 @@
+shippable/posix/group4
+skip/aix

test/integration/targets/git_acp/meta/main.yml

@@ -0,0 +1,2 @@
+dependencies:
+  - prepare_tests

test/integration/targets/git_acp/tasks/https.yml

@@ -0,0 +1,53 @@
+- name: set first random file name.
+  delegate_to: 127.0.0.1
+  set_fact:
+    first_file_name: "{{ lookup('pipe','date +%s%N') }}.txt"
+
+- name: set second random file name.
+  delegate_to: 127.0.0.1
+  set_fact:
+    second_file_name: "{{ lookup('pipe','date +%s%N') }}.txt"
+
+- name: touch file1 and file2
+  file:
+    path: "{{ playbook_dir }}/test_directory/{{ item }}"
+    state: touch
+  loop:
+    - "{{ first_file_name }}"
+    - "{{ second_file_name }}"
+
+- name: HTTPS +add +mode -push_option
+  register: result
+  git_acp:
+    folder_path: "{{ playbook_dir }}/test_directory"
+    user: Federico87
+    token: ZwM9RMWz4cEGwiynxtcw
+    comment: Add file1 and file2
+    add: [ "{{ first_file_name }}", "{{ second_file_name }}" ]
+    branch: master
+    mode: https
+    url: https://gitlab.com/networkAutomation/git_test_module.git
+
+- assert: { that: "result.changed == true" }
+
+- name: rm file1 and file2
+  file:
+    path: "{{ playbook_dir }}/test_directory/{{ item }}"
+    state: absent
+  loop:
+    - "{{ first_file_name }}"
+    - "{{ second_file_name }}"
+
+- name: HTTPS -add +mode +push_option
+  register: result
+  git_acp:
+    folder_path: "{{ playbook_dir }}/test_directory"
+    user: Federico87
+    token: ZwM9RMWz4cEGwiynxtcw
+    comment: Remove file1 and file2
+    branch: master
+    push_option: ci.skip
+    mode: https
+    url: https://gitlab.com/networkAutomation/git_test_module.git
+
+- assert: { that: "result.changed == true" }

test/integration/targets/git_acp/tasks/main.yml

@@ -0,0 +1,2 @@
+- include_tasks: setup.yml
+- include_tasks: https.yml

test/integration/targets/git_acp/tasks/setup.yml

@@ -0,0 +1,43 @@
+- name: SETUP | update git to the latest
+  package:
+    name: git
+    state: latest
+  when: ansible_distribution != "MacOSX"
+
+- name: SETUP | check git version
+  shell: git --version | grep 'git version' | sed 's/git version //'
+  register: git_version
+
+- name: SETUP | edit git version variable
+  set_fact:
+    git_int: "{{  git_version | replace('.', '') }}"
+
+- name: SETUP | end play if git is not >=2.19
+  meta: end_play
+  when: git_int.stdout | int < 2100
+
+- name: SETUP | create test directory
+  file: 
+    path: "{{ playbook_dir }}/test_directory" 
+    state: directory
+
+- name: SETUP | generate rundom number
+  set_fact:
+    random: "{{ 60 | random }}"
+    run_once: yes
+
+- name: SETUP | Wait random seconds to avoid git conflict
+  pause:
+    seconds: "{{ random | int }}"
+
+- name: SETUP | clone repo into test directory
+  git:
+    repo: "https://Federico87:ZwM9RMWz4cEGwiynxtcw@gitlab.com/networkAutomation/git_test_module.git"
+    dest: "{{ playbook_dir }}/test_directory"
+    clone: yes
+
+- name: SETUP | set git global user.email if not already set
+  shell: git config --global user.email || git config --global user.email "noreply@example.com"
+
+- name: SETUP | set git global user.name if not already set
+  shell: git config --global user.name  || git config --global user.name  "Ansible Test Runner"