Improve test coverage (#43)

Author: xen0l

CHANGELOG.md

@@ -3,6 +3,7 @@
 
 * Use default region and profile in list command
 * Always use own version of session-manager-plugin if available
+* Improve tests coverage
 
 0.4.1 (2019-08-12)
 ------------------

aws_gate/__init__.py

@@ -1,2 +1,5 @@
 __version__ = '0.4.1'
 __description__ = 'aws-gate - AWS SSM Session Manager client CLI'
+__author__ = 'Adam Stevko'
+__author_email__ = '[email protected]'
+__url__ = 'https://github.com/xen0l/aws-gate'

aws_gate/cli.py

@@ -22,14 +22,14 @@
 
 def _get_profile(args, config, default):
     profile = None
-    if 'profile' in args:
+    if hasattr(args, 'profile'):
         profile = args.profile
     return profile or config.default_profile or default
 
 
 def _get_region(args, config, default):
     region = None
-    if 'region' in args:
+    if hasattr(args, 'region'):
         region = args.region
     return region or config.default_region or default
 
@@ -103,11 +103,13 @@ def main():
     try:
         config = load_config_from_files()
     except (ValidationError, ScannerError) as e:
-        raise ValueError('Invalid configuration provided: {}'.format(e.message))
+        raise ValueError('Invalid configuration provided: {}'.format(e))
 
     profile = _get_profile(args=args, config=config, default=default_profile)
     region = _get_region(args=args, config=config, default=default_region)
 
+    logger.debug('Using AWS profile "%s" in region "%s"', profile, region)
+
     if args.subcommand == 'bootstrap':
         bootstrap(force=args.force)
     if args.subcommand == 'session':

setup.py

@@ -2,7 +2,7 @@
 import os
 from setuptools import setup, find_packages
 
-from aws_gate import __version__, __description__
+from aws_gate import __version__, __description__, __author__, __author_email__, __url__
 
 __location__ = os.path.join(
     os.getcwd(), os.path.dirname(inspect.getfile(inspect.currentframe()))
@@ -17,25 +17,39 @@ def get_install_requirements(path):
     return requires
 
 
+NAME = 'aws-gate'
+PROJECT_URLS = {
+    "Bug Tracker": "https://github.com/xen0l/aws-gate/issues",
+    "Source Code": "https://github.com/xen0l/aws-gate",
+}
+CLASSIFIERS = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Topic :: System :: Systems Administration",
+]
+INSTALL_REQUIRES = get_install_requirements('requirements/requirements.txt')
+EXTRA_REQUIRES = {
+    'tests': get_install_requirements('requirements/requirements_dev.txt')
+}
+SCRIPTS = [
+    'bin/aws-gate'
+]
+
 setup(
-    name='aws-gate',
+    name=NAME,
     version=__version__,
     description=__description__,
     long_description=open('README.md').read(),
     long_description_content_type="text/markdown",
-    include_package_data=True,
-    author='Adam Stevko',
-    author_email='[email protected]',
+    url=__url__,
+    project_urls=PROJECT_URLS,
+    author=__author__,
+    author_email=__author_email__,
     packages=find_packages(),
-    url='https://github.com/xen0l/aws-gate',
-    install_requires=get_install_requirements('requirements/requirements.txt'),
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: BSD License",
-        "Operating System :: OS Independent",
-        "Topic :: System :: Systems Administration",
-    ],
-    scripts=[
-        'bin/aws-gate',
-    ],
+    classifiers=CLASSIFIERS,
+    install_requires=INSTALL_REQUIRES,
+    extra_requires=EXTRA_REQUIRES,
+    include_package_data=True,
+    scripts=SCRIPTS
 )

test/unit/test_cli.py

@@ -1,11 +1,70 @@
+import argparse
 import unittest
-import unittest.mock
+from unittest.mock import patch, MagicMock, create_autospec
 
-from aws_gate.cli import main
+from marshmallow import ValidationError
+
+from aws_gate.cli import main, _get_profile, _get_region
 
 
 class TestCli(unittest.TestCase):
+    def setUp(self):
+        self._args = MagicMock(profile='args_profile', region='args_region')
+        self._config = MagicMock(default_profile='config_profile', default_region='config_region')
+        self._default_region = 'default_region'
+        self._default_profile = 'default_profile'
 
     def test_cli_param_error(self):
         with self.assertRaises(SystemExit):
             main()
+
+    def test_get_profile_from_args(self):
+        self.assertEqual(_get_profile(args=self._args, config=self._config,
+                                      default=self._default_profile), 'args_profile')
+
+    def test_get_profile_from_config(self):
+        self.assertEqual(_get_profile(args=create_autospec(argparse.Namespace), config=self._config,
+                                      default=self._default_profile), 'config_profile')
+
+    def test_get_profile_from_default(self):
+        self.assertEqual(_get_profile(args=create_autospec(argparse.Namespace), config=MagicMock(default_profile=None),
+                                      default=self._default_profile), 'default_profile')
+
+    def test_get_region_from_args(self):
+        self.assertEqual(_get_region(args=self._args, config=self._config,
+                                     default=self._default_region), 'args_region')
+
+    def test_get_region_from_config(self):
+        self.assertEqual(_get_region(args=create_autospec(argparse.Namespace), config=self._config,
+                                     default=self._default_region), 'config_region')
+
+    def test_get_region_from_default(self):
+        self.assertEqual(_get_region(args=create_autospec(argparse.Namespace), config=MagicMock(default_region=None),
+                                     default=self._default_region), 'default_region')
+
+    def test_cli_invalid_config(self):
+        with patch('aws_gate.cli.parse_arguments', return_value=MagicMock(subcommand='bootstrap')), \
+                patch('aws_gate.cli.load_config_from_files', side_effect=ValidationError(message='error')):
+            with self.assertRaises(ValueError):
+                main()
+
+    def test_cli_bootstrap(self):
+        with patch('aws_gate.cli.parse_arguments', return_value=MagicMock(subcommand='bootstrap')), \
+                patch('aws_gate.cli.bootstrap') as m:
+            main()
+
+            self.assertTrue(m.called)
+
+    def test_cli_session(self):
+        with patch('aws_gate.cli.parse_arguments', return_value=MagicMock(subcommand='session')), \
+                patch('aws_gate.cli.session') as m:
+            main()
+
+            self.assertTrue(m.called)
+
+    def test_cli_list(self):
+        with patch('aws_gate.cli.parse_arguments', return_value=MagicMock(subcommand='list')), \
+                patch('aws_gate.cli.list_instances') as m:
+            main()
+
+            self.assertTrue(m.called)

test/unit/test_config.py

@@ -5,7 +5,8 @@
 from marshmallow import ValidationError
 
 from aws_gate.constants import DEFAULT_GATE_CONFIG_PATH, DEFAULT_GATE_CONFIGD_PATH
-from aws_gate.config import GateConfig, EmptyConfigurationError, load_config_from_files, _locate_config_files
+from aws_gate.config import GateConfig, EmptyConfigurationError, load_config_from_files, _locate_config_files, \
+    validate_profile, validate_region
 
 
 class TestConfig(unittest.TestCase):
@@ -129,3 +130,13 @@ def test_config_get_host(self):
 
             self.assertEqual(config.get_host('foobar'), expected_host)
             self.assertEqual(config.get_host('non-existent'), {})
+
+    def test_validate_profile(self):
+        with patch('aws_gate.config.is_existing_profile', return_value=False):
+            with self.assertRaises(ValidationError):
+                validate_profile('test-profile')
+
+    def test_validate_region(self):
+        with patch('aws_gate.config.is_existing_region', return_value=False):
+            with self.assertRaises(ValidationError):
+                validate_region('test-region')

test/unit/test_decorators.py

@@ -1,11 +1,18 @@
 
 import unittest
-from unittest.mock import patch
+from unittest.mock import patch, call
 
-from aws_gate.decorators import plugin_required, plugin_version
+from aws_gate.decorators import plugin_required, plugin_version, _plugin_exists
 
 
 class TestDecorators(unittest.TestCase):
+    def test_plugin_exists(self):
+        with patch('aws_gate.decorators.os.path.exists') as m:
+            _plugin_exists('foo')
+
+            self.assertTrue(m.called)
+            self.assertEqual(m.call_args, call('foo'))
+
     def test_plugin_required(self):
         with patch('aws_gate.decorators._plugin_exists', return_value=True):
             @plugin_required