Merge pull request #83 from baloise/feat/version-command

Add version command

Author: christiansiegel

CHANGELOG.md

@@ -5,6 +5,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- `version` command
 
 ## [3.0.1] - 2020-04-09
 

docs/commands/version.md

@@ -0,0 +1,17 @@
+# version
+
+The `version` command shows the GitOps CLI version information.
+
+## Example
+
+```bash
+gitopscli version
+```
+
+## Usage
+```
+usage: gitopscli version [-h]
+
+optional arguments:
+  -h, --help  show this help message and exit
+```

gitopscli/__main__.py

@@ -2,11 +2,14 @@
 import sys
 
 from gitopscli.cliparser import create_cli
-from gitopscli.commands.add_pr_comment import pr_comment_command
-from gitopscli.commands.create_preview import create_preview_command
-from gitopscli.commands.delete_preview import delete_preview_command
-from gitopscli.commands.deploy import deploy_command
-from gitopscli.commands.sync_apps import sync_apps_command
+from gitopscli.commands import (
+    pr_comment_command,
+    create_preview_command,
+    delete_preview_command,
+    deploy_command,
+    sync_apps_command,
+    version_command,
+)
 from gitopscli.gitops_exception import GitOpsException
 
 
@@ -24,9 +27,14 @@ def main():
         command = create_preview_command
     elif args.command == "delete-preview":
         command = delete_preview_command
-
-    verbose = args.verbose
-    del args.verbose
+    elif args.command == "version":
+        command = version_command
+
+    if "verbose" in args:
+        verbose = args.verbose
+        del args.verbose
+    else:
+        verbose = False
 
     try:
         command(**vars(args))

gitopscli/cliparser.py

@@ -11,6 +11,7 @@ def create_cli(args):
     __add_pr_comment_command_parser(subparsers)
     __add_create_preview_command_parser(subparsers)
     __add_delete_preview_command_parser(subparsers)
+    __add_version_command_parser(subparsers)
 
     if len(args) == 0:
         parser.print_help(sys.stderr)
@@ -84,6 +85,10 @@ def __add_delete_preview_command_parser(subparsers):
     __add_verbose_parser(add_delete_preview_p)
 
 
+def __add_version_command_parser(subparsers):
+    subparsers.add_parser("version", help="Show the GitOps CLI version information")
+
+
 def __add_git_parser_args(deploy_p, api_only=False):
     deploy_p.add_argument("--username", help="Git username", required=True)
     deploy_p.add_argument("--password", help="Git password or token", required=True)

gitopscli/commands/__init__.py

@@ -0,0 +1,6 @@
+from .add_pr_comment import pr_comment_command
+from .create_preview import create_preview_command
+from .delete_preview import delete_preview_command
+from .deploy import deploy_command
+from .sync_apps import sync_apps_command
+from .version import version_command

gitopscli/commands/version.py

@@ -0,0 +1,7 @@
+import pkg_resources
+
+
+def version_command(command):
+    assert command == "version"
+    version = pkg_resources.require("gitopscli")[0].version
+    print(f"GitOps CLI version {version}")

mkdocs.yml

@@ -18,6 +18,7 @@ nav:
     - delete-preview: commands/delete-preview.md
     - deploy: commands/deploy.md
     - sync-apps: commands/sync-apps.md
+    - version: commands/version.md
   - Changelog: changelog.md
   - Contributing: contributing.md
   - License: license.md

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="gitopscli",
-    version="3.0.0",
+    version="3.0.1",
     packages=find_packages(),
     entry_points={"console_scripts": ["gitopscli = gitopscli.__main__:main"]},
     setup_requires=["wheel"],

tests/commands/test_version.py

@@ -0,0 +1,30 @@
+import re
+import sys
+import unittest
+from contextlib import contextmanager
+from io import StringIO
+import pytest
+
+from gitopscli.commands.version import version_command
+
+
+@contextmanager
+def captured_output():
+    new_out = StringIO()
+    old_out = sys.stdout
+    try:
+        sys.stdout = new_out
+        yield sys.stdout
+    finally:
+        sys.stdout = old_out
+
+
+class VersionCommandTest(unittest.TestCase):
+    def test_output(self):
+        with captured_output() as stdout:
+            version_command("version")
+        assert re.match(r"^GitOps CLI version \d+\.\d+\.\d+\n$", stdout.getvalue())
+
+    def test_wrong_command_arg(self):
+        with pytest.raises(AssertionError):
+            version_command("foo")

tests/test_cliparser.py

@@ -8,7 +8,7 @@
 
 EXPECTED_GITOPSCLI_HELP = """\
 usage: gitopscli [-h]
-                 {deploy,sync-apps,add-pr-comment,create-preview,delete-preview}
+                 {deploy,sync-apps,add-pr-comment,create-preview,delete-preview,version}
                  ...
 
 GitOps CLI
@@ -17,13 +17,14 @@
   -h, --help            show this help message and exit
 
 commands:
-  {deploy,sync-apps,add-pr-comment,create-preview,delete-preview}
+  {deploy,sync-apps,add-pr-comment,create-preview,delete-preview,version}
     deploy              Trigger a new deployment by changing YAML values
     sync-apps           Synchronize applications (= every directory) from apps
                         config repository to apps root config
     add-pr-comment      Create a comment on the pull request
     create-preview      Create a preview environment
     delete-preview      Delete a preview environment
+    version             Show the GitOps CLI version information
 """
 
 EXPECTED_ADD_PR_COMMENT_NO_ARGS_ERROR = """\
@@ -261,6 +262,13 @@
                         Root config repository name
 """
 
+EXPECTED_VERSION_HELP = """\
+usage: gitopscli version [-h]
+
+optional arguments:
+  -h, --help  show this help message and exit
+"""
+
 
 @contextmanager
 def captured_output():
@@ -795,3 +803,13 @@ def test_sync_apps_all_args(self):
         self.assertEqual(cli.git_provider, "GIT_PROVIDER")
         self.assertEqual(cli.git_provider_url, "GIT_PROVIDER_URL")
         self.assertTrue(cli.verbose)
+
+    def test_version_args(self):
+        cli = create_cli(["version"])
+        self.assertEqual(cli.command, "version")
+
+    def test_version_help(self):
+        exit_code, stdout, stderr = self._capture_create_cli(["version", "--help"])
+        self.assertEqual(exit_code, 0)
+        self.assertEqual(EXPECTED_VERSION_HELP, stdout)
+        self.assertEqual("", stderr)