feat(deploy): add optional commit message argument

Feat/deploy commit message

Author: m4rc0z

docs/commands/deploy.md

@@ -71,6 +71,28 @@ Date:   Thu Mar 12 15:30:00 2020 +0100
     backend.env.[0].value: 'bar'
 ```
 
+### Specific Commit Message
+
+If you want to specify the commit message of the deployment then you can use the following param:
+
+`--commit-message`
+
+```bash
+gitopscli deploy \
+  --git-provider-url https://bitbucket.baloise.dev \
+  --username $GIT_USERNAME \
+  --password $GIT_PASSWORD \
+  --git-user "GitOps CLI" \
+  --git-email "gitopscli@baloise.dev" \
+  --organisation "deployment" \
+  --repository-name "myapp-non-prod" \
+  --commit-message "test commit message" \
+  --file "example/values.yaml" \
+  --values "{frontend.tag: 1.1.0, backend.tag: 1.1.0, backend.env.[0].value: bar}"
+```
+
+This will end up in one single commit with your specified commit-message.
+
 ### Create Pull Request
 
 In some cases you might want to create a pull request for your updates. You can achieve this by adding `--create-pr` to the command. The pull request can be left open or merged directly with `--auto-merge`.

gitopscli/cliparser.py

@@ -45,6 +45,9 @@ def __add_deploy_command_parser(subparsers):
         const=True,
         default=False,
     )
+    deploy_p.add_argument(
+        "--commit-message", help="Specify exact commit message of deployment commit", type=str, default=None,
+    )
 
     __add_git_parser_args(deploy_p)
     __add_branch_pr_parser_args(deploy_p)

gitopscli/commands/deploy.py

@@ -23,6 +23,7 @@ def deploy_command(
     repository_name,
     git_provider,
     git_provider_url,
+    commit_message=None,
 ):
     assert command == "deploy"
 
@@ -49,7 +50,7 @@ def deploy_command(
             git.new_branch(config_branch)
             logging.info("Created branch %s", config_branch)
 
-        updated_values = __update_values(git, file, values, single_commit)
+        updated_values = __update_values(git, file, values, single_commit, commit_message)
         if not updated_values:
             logging.info("All values already up-to-date. I'm done here")
             return
@@ -63,7 +64,7 @@ def deploy_command(
         __create_pr(git, config_branch, file, updated_values, auto_merge)
 
 
-def __update_values(git, file, values, single_commit):
+def __update_values(git, file, values, single_commit, commit_message):
     full_file_path = git.get_full_file_path(file)
     if not os.path.isfile(full_file_path):
         raise GitOpsException(f"No such file: {file}")
@@ -81,10 +82,10 @@ def __update_values(git, file, values, single_commit):
         logging.info("Updated yaml property %s to %s", key, value)
         updated_values[key] = value
 
-        if not single_commit:
+        if not single_commit and commit_message is None:
             git.commit(f"changed '{key}' to '{value}' in {file}")
 
-    if updated_values and single_commit:
+    if updated_values and single_commit and commit_message is None:
         if len(updated_values) == 1:
             key, value = list(updated_values.items())[0]
             git.commit(f"changed '{key}' to '{value}' in {file}")
@@ -93,6 +94,9 @@ def __update_values(git, file, values, single_commit):
             msg += f"\n\n{yaml_dump(updated_values)}"
             git.commit(msg)
 
+    if updated_values and commit_message is not None:
+        git.commit(commit_message)
+
     return updated_values
 
 

tests/commands/test_deploy.py

@@ -218,6 +218,44 @@ def test_single_commit_happy_flow(self):
             call.delete_tmp_dir("/tmp/created-tmp-dir"),
         ]
 
+    def test_commit_message_happy_flow(self):
+        deploy_command(
+            command="deploy",
+            file="test/file.yml",
+            values={"a.b.c": "foo", "a.b.d": "bar"},
+            username="USERNAME",
+            password="PASSWORD",
+            git_user="GIT_USER",
+            git_email="GIT_EMAIL",
+            create_pr=False,
+            auto_merge=False,
+            single_commit=False,
+            organisation="ORGA",
+            repository_name="REPO",
+            git_provider="github",
+            git_provider_url=None,
+            commit_message="testcommit",
+        )
+
+        assert self.mock_manager.mock_calls == [
+            call.create_tmp_dir(),
+            call.create_git(
+                "USERNAME", "PASSWORD", "GIT_USER", "GIT_EMAIL", "ORGA", "REPO", "github", None, "/tmp/created-tmp-dir"
+            ),
+            call.git_util.checkout("master"),
+            call.logging.info("Master checkout successful"),
+            call.git_util.get_full_file_path("test/file.yml"),
+            call.os.path.isfile("/tmp/created-tmp-dir/test/file.yml"),
+            call.update_yaml_file("/tmp/created-tmp-dir/test/file.yml", "a.b.c", "foo"),
+            call.logging.info("Updated yaml property %s to %s", "a.b.c", "foo"),
+            call.update_yaml_file("/tmp/created-tmp-dir/test/file.yml", "a.b.d", "bar"),
+            call.logging.info("Updated yaml property %s to %s", "a.b.d", "bar"),
+            call.git_util.commit("testcommit"),
+            call.git_util.push("master"),
+            call.logging.info("Pushed branch %s", "master"),
+            call.delete_tmp_dir("/tmp/created-tmp-dir"),
+        ]
+
     def test_checkout_error(self):
         checkout_exception = GitOpsException("dummy checkout error")
         self.git_util_mock.checkout.side_effect = checkout_exception

tests/test_cliparser.py

@@ -244,7 +244,8 @@
 
 EXPECTED_DEPLOY_NO_ARGS_ERROR = """\
 usage: gitopscli deploy [-h] --file FILE --values VALUES
-                        [--single-commit [SINGLE_COMMIT]] --username USERNAME
+                        [--single-commit [SINGLE_COMMIT]]
+                        [--commit-message COMMIT_MESSAGE] --username USERNAME
                         --password PASSWORD [--git-user GIT_USER]
                         [--git-email GIT_EMAIL] --organisation ORGANISATION
                         --repository-name REPOSITORY_NAME
@@ -257,7 +258,8 @@
 
 EXPECTED_DEPLOY_HELP = """\
 usage: gitopscli deploy [-h] --file FILE --values VALUES
-                        [--single-commit [SINGLE_COMMIT]] --username USERNAME
+                        [--single-commit [SINGLE_COMMIT]]
+                        [--commit-message COMMIT_MESSAGE] --username USERNAME
                         --password PASSWORD [--git-user GIT_USER]
                         [--git-email GIT_EMAIL] --organisation ORGANISATION
                         --repository-name REPOSITORY_NAME
@@ -273,6 +275,8 @@
                         desired value as value
   --single-commit [SINGLE_COMMIT]
                         Create only single commit for all updates
+  --commit-message COMMIT_MESSAGE
+                        Specify exact commit message of deployment commit
   --username USERNAME   Git username
   --password PASSWORD   Git password or token
   --git-user GIT_USER   Git Username