NEW Source Control module: git add/commit/push

plugins/modules/git_commit.py

@@ -0,0 +1 @@
+./source_control/git/git_commit.py

plugins/modules/git_push.py

@@ -0,0 +1 @@
+./source_control/git/git_push.py

plugins/modules/source_control/git/git_commit.py

@@ -0,0 +1,135 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2020, Federico Olivieri (lvrfrc87@gmail.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_commit
+author:
+    - "Federico Olivieri (@Federico87)"
+version_added: "2.10"
+short_description: Perform git and and git commit operations.
+description:
+    - Manage git add and git commit on local git repository.
+options:
+    path:
+        description:
+            - Folder path where .git/ is located.
+        required: true
+        type: path
+    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
+requirements:
+    - git>=2.10.0 (the command line tool)
+'''
+
+EXAMPLES = '''
+- name: Add and commit 2 files.
+  community.general.git_commit:
+    path: /Users/federicoolivieri/git/git_test_module
+    comment: My amazing backup
+    add: ['test.txt', 'txt.test']
+
+- name: Add all files using default and commit.
+  community.general.git_commit:
+    path: /Users/federicoolivieri/git/git_test_module
+    comment: My amazing backup
+'''
+
+RETURN = '''
+output:
+    description: list of git cli command stdout
+    type: list
+    returned: always
+    sample: [
+        "[master 99830f4] Remove [ test.txt, tax.txt ]\n 4 files changed, 26 insertions(+)..."
+    ]
+'''
+
+import os
+from ansible.module_utils.basic import AnsibleModule
+
+
+def git_commit(module):
+
+    commands = list()
+
+    add = module.params.get('add')
+    path = module.params.get('path')
+    comment = module.params.get('comment')
+
+    if add:
+        commands.append('git -C {path} add {add}'.format(
+            path=path,
+            add=' '.join(add),
+        ))
+
+    if comment:
+        commands.append('git -C {path} commit -m "{comment}"'.format(
+            path=path,
+            comment=comment,
+        ))
+
+    return commands
+
+
+def main():
+
+    argument_spec = dict(
+        path=dict(required=True, type="path"),
+        comment=dict(required=True),
+        add=dict(type="list", elements='str', default=["."]),
+    )
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+    )
+
+    result_output = list()
+    result = dict(changed=False)
+
+    for cmd in git_commit(module):
+        _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)
+                result.update(changed=True)
+
+        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)
+                result.update(changed=True)
+
+    if result_output:
+        result.update(output=result_output)
+
+    module.exit_json(**result)
+
+
+if __name__ == "__main__":
+    main()

plugins/modules/source_control/git/git_push.py

@@ -0,0 +1,235 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2020, Federico Olivieri (lvrfrc87@gmail.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_push
+author:
+    - "Federico Olivieri (@Federico87)"
+version_added: "2.10"
+short_description: Perform git push operations.
+description:
+    - Manage git push on local or remote git repository.
+options:
+    path:
+        description:
+            - Folder path where .git/ is located.
+        required: true
+        type: path
+    user:
+        description:
+            - Git username for https operations.
+        type: str
+    token:
+        description:
+            - Git API token for https operations.
+        type: 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, https or local.
+              Same as "git@git..." or "https://user:token@git..." or "git init --bare"
+        choices: ['ssh', 'https', 'local']
+        default: ssh
+        type: str
+    url:
+        description:
+            - Git repo URL.
+        required: True
+        type: str
+requirements:
+    - git>=2.10.0 (the command line tool)
+'''
+
+EXAMPLES = '''
+
+- name: Push changes via HTTPs.
+  community.general.git_push:
+    path: /Users/federicoolivieri/git/git_test_module
+    user: Federico87
+    token: m1Ap!T0k3n!!!
+    branch: master
+    mode: https
+    url: https://gitlab.com/networkAutomation/git_test_module
+
+- name: Push changes via SSH.
+  community.general.git_push:
+    path: /Users/federicoolivieri/git/git_test_module
+    branch: master
+    mode: ssh
+    url: https://gitlab.com/networkAutomation/git_test_module
+
+- name: Push changes on local repo.
+  community.general.git_push:
+    path: /Users/federicoolivieri/git/git_test_module
+    comment: My amazing backup
+    branch: master
+    url: /Users/federicoolivieri/git/local_repo
+'''
+
+RETURN = '''
+output:
+    description: list of git cli commands stdout
+    type: list
+    returned: always
+    sample: [
+        "To https://gitlab.com/networkAutomation/git_test_module.git\n   372db19..99830f4  master -> master\n"
+    ]
+'''
+
+import os
+from ansible.module_utils.basic import AnsibleModule
+
+
+def git_push(module):
+
+    commands = list()
+
+    path = module.params.get('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(path, user, token, url, branch, push_option):
+        if url.startswith('https://'):
+            remote_add = 'git -C {path} remote set-url origin https://{user}:{token}@{url}'.format(
+                path=path,
+                url=url[8:],
+                user=user,
+                token=token,
+            )
+            cmd = 'git -C {path} push origin {branch}'.format(
+                path=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 == 'local':
+        if 'https' in url or 'ssh' in url:
+            module.fail_json(msg='SSH or HTTPS mode selected but repo is LOCAL')
+
+        remote_add = 'git -C {path} remote set-url origin {url}'.format(
+            path=path,
+            url=url
+        )
+        cmd = "git -C {path} push origin {branch}".format(
+            path=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(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 {path} remote set-url origin {url}'.format(
+            path=path,
+            url=url,
+        )
+        cmd = 'git -C {path} push origin {branch}'.format(
+            path=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(
+        path=dict(required=True, type="path"),
+        user=dict(),
+        token=dict(),
+        branch=dict(required=True),
+        push_option=dict(),
+        mode=dict(choices=["ssh", "https", "local"], default='ssh'),
+        url=dict(required=True),
+    )
+
+    required_if = [
+        ("mode", "https", ["user", "token"]),
+    ]
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        required_if=required_if,
+    )
+
+    result = dict(changed=False)
+
+    result_output = list()
+
+    for cmd in git_push(module):
+        _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)
+                result.update(changed=True)
+
+        if error:
+            if 'error:' in error:
+                module.fail_json(msg=error)
+            elif 'fatal:' in error:
+                module.fail_json(msg=error)
+            elif 'Everything up-to-date' in error:
+                result_output.append(error)
+                result.update(changed=True)
+            else:
+                result_output.append(error)
+                result.update(changed=True)
+
+    if result_output:
+        result.update(output=result_output)
+
+    module.exit_json(**result)
+
+
+if __name__ == "__main__":
+    main()

tests/integration/targets/git_commit/aliases

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

tests/integration/targets/git_commit/meta/main.yml

@@ -0,0 +1,3 @@
+dependencies:
+  - prepare_tests
+  - setup_pkg_mgr