Add unittest helper (#89)

* Use a git log command that works on git 1.8.x and 2.x

* Use a git log command that works on git 1.8.x and 2.x

* Use a git log command that works on git 1.8.x and 2.x

* Use a git log command that works on git 1.8.x and 2.x

* Use a git log command that works on git 1.8.x and 2.x

* Add type check fixes.

* Add type check fixes.

* build fix

* build fix

* build fix

* Add release tagging

* Add release tagging

Minor updates

* Add release tagging

* Add release tagging

* Bandit checks

* Git tagging fix

* Git tagging fix

* Git tagging fix

* Make tagging work if ssh is setup by the screwdriver server setup.

* Support the old package publish environment setting variable so old templates don't break.

* Don't run the validation on centos 5 since it doesn't work.

* Don't run the validation on centos 5 since it doesn't work.

* Remove debug print

* Don't override the package version

* Display a message when changing the metadata in screwdriver.

* - Make the release tagger use the Versioner class to get the metadata version so there aren't
multiple implementations of the same thing.
- Update the Versioner base class to allow specifying the meta command as an argument.  To simplify writing tests.

* Don't output the bytestring as output but the string instead

* Don't run the validation on centos 5 since it doesn't work.

* Type validation fix and codestyle fix

Author: dwighthubbard

changelog.d/75.feature.md

@@ -0,0 +1 @@
+Added new validation script screwdrivercd_validate_unittest that will run tests using tox.

docs/Validation_Helpers.md

@@ -103,3 +103,39 @@ This example runs the type check with enforcement enabled.
 | --------- | ----------- |
 | reports/type_validation | Report files generated by the mypy command |
 
+## Unit Test Validation - screwdrivercd_validate_unittest
+ 
+The `screwdrivercd_validate_unittest` command runs unittests via the [tox](https://tox.readthedocs.io) tool.
+
+### Environment Settings
+
+All settings for the `scrwedrivercd_validate_unittest` command are specified via environment variables.
+
+The following settings are supported:
+
+| Setting                  | Default Value               | Description                                         |
+| ------------------------ | --------------------------- | --------------------------------------------------- |
+| BASE_PYTHON              | python3                     | Python interpreter to use                           |
+| TOX_ARGS                 |                             | Additional tox command arguments                    |
+| TOX_ENVLIST              |                             | Only run tests with specific envlist from the tox configuration |
+
+### Example
+
+This example runs the tox command only using a python 3.8 (py38) virtualenv.
+
+!!! note "screwdriver.yaml - With unittest check"
+    ```yaml
+    version: 4
+    jobs:
+        type_check:
+            template: python/validate_unittest
+            environment:
+                TOX_ARGS: -v
+                TOX_ENVLIST: py38
+    ```
+
+### Artifacts
+
+| Directory | Description |
+| --------- | ----------- |
+| logs/tox  | All of the tox log files |

screwdriver.yaml

@@ -49,7 +49,7 @@ jobs:
             DOCUMENTATION_PUBLISH: False
         requires: [~pr]
 
-    generate_version:
+    version:
         template: python/generate_version
         requires: [validate_test, validate_lint, validate_codestyle, validate_dependencies, validate_security, validate_type]
 
@@ -58,7 +58,7 @@ jobs:
         environment:
             PUBLISH: True
             TWINE_REPOSITORY_URL: https://test.pypi.org/legacy/
-        requires: [generate_version]
+        requires: [version]
 
     verify_test_package:
         template: python/validate_pypi_package

setup.cfg

@@ -76,6 +76,7 @@ console_scripts =
 	screwdrivercd_validate_package_quality=screwdrivercd.validation.validate_package_quality:main
 	screwdrivercd_validate_style=screwdrivercd.validation.validate_style:main
 	screwdrivercd_validate_type=screwdrivercd.validation.validate_type:main
+	screwdrivercd_validate_unittest=screwdrivercd.validation.validate_unittest:main
 
 screwdrivercd.documentation.plugin =
 	base   = screwdrivercd.documentation.plugin:DocumentationPlugin

src/screwdrivercd/changelog/__main__.py

@@ -3,7 +3,7 @@
 """
 screwdrivercd.changelog module entrypoint
 """
-from .generate import main
 
 
-main()
+def main():
+    pass

src/screwdrivercd/documentation/plugin.py

@@ -224,7 +224,7 @@ def get_clone_dir(self) -> str:
 
     def git_add_all(self):
         """
-        Run 'git add' on all the files in the currecnt directory.
+        Run 'git add' on all the files in the current directory.
         """
         self._log_message('\n- Adding all files in the current directory to git', self.publish_log_filename)
         for filename in os.listdir('.'):

src/screwdrivercd/installdeps/installer.py

@@ -20,7 +20,7 @@
 class Installer():
     """Generic Package Installer
     """
-    name: str = 'generic'
+    name: str = 'echo'
     """:str: The name of the installer class"""
 
     install_command: List[str] = ['echo', 'fake', 'install']
@@ -91,7 +91,7 @@ def deps_config_keys(self):
         return ['deps']
 
     @property
-    def has_dependencies(self) -> bool:
+    def has_dependencies(self) -> bool:  # pragma: no cover
         """
         Check if the installer has dependencies to install in the current environment.
 
@@ -109,7 +109,7 @@ def has_dependencies(self) -> bool:
         return False
 
     @property
-    def is_supported(self) -> bool:
+    def is_supported(self) -> bool:  # pragma: no cover
         """
         Check for the installer utility and return True if it's present, False otherwise
 
@@ -124,7 +124,7 @@ def is_supported(self) -> bool:
         return False
 
     @property
-    def plugin_configuration(self):
+    def plugin_configuration(self):  # pragma: no cover
         """
         Return the plugin configuration dictionary if it is found
 
@@ -151,13 +151,14 @@ def _handle_custom_settings(self):
         -------
         """
 
-    def add_repos(self):
+    def add_repos(self):  # pragma: no cover
         """
         Add repositories to the host configuration
         """
         if not self.supports_repositories:
             LOG.debug(f'Install plugin {self.config_section} does not support repositories')
             return
+
         repos = copy.copy(self.default_repos)
         repos.update(self.plugin_configuration.get('repos', {}))
 
@@ -192,13 +193,13 @@ def add_repo(self, repo_name, repo_url):  # pragma: no cover
 
     def determine_bin_directory(self):
         """
-        Determine the bin_dir for the default pip command based on the environment
+        Determine the bin_dir for the default install command based on the environment
         """
         if self.bin_dir or self.install_command[0].startswith('/'):
             LOG.debug(f'The command bin_dir {self.bin_dir} is already set')
             return
 
-        if self.plugin_configuration and self.plugin_configuration.get('bin_dir', None):
+        if self.plugin_configuration and self.plugin_configuration.get('bin_dir', None):  # pragma: no cover
             LOG.debug('Setting the configuartion directory from the configuration')
             self.bin_dir = self.plugin_configuration['bin_dir']
 
@@ -276,19 +277,20 @@ def install_dependencies(self) -> List[str]:
                 # LOG.debug(f'Processing dependencies {dependencies!r}')
                 invalid += self.invalid_dependencies(dependencies, config_key=config_key)
                 if invalid:
-                    if self.print_error_output:
+                    if self.print_error_output:  # pragma: no cover
                         print(colored('Invalid %r dependencies %r specified' % (config_key, invalid), 'red'), flush=True)
                     else:
                         LOG.error(colored('Invalid %r dependencies %r specified' % (config_key, invalid), 'red'))
                     if self.exit_on_missing:
                         break
                     dependencies = list(set(dependencies) - set(invalid))
 
-                if self.print_output:
-                    print(f'Installing dependencies {dependencies!r}')
-                else:
-                    LOG.debug(f'Installing dependencies: {dependencies!r}')
-                installed += self.install(dependencies, config_key=config_key)
+                if dependencies:
+                    if self.print_output:
+                        print(f'Installing dependencies {dependencies!r}')
+                    else:
+                        LOG.debug(f'Installing dependencies: {dependencies!r}')
+                    installed += self.install(dependencies, config_key=config_key)
         return installed
 
     def install(self, dependencies, config_key=None):
@@ -315,7 +317,7 @@ def install(self, dependencies, config_key=None):
             LOG.debug('Running command: %r', ' '.join(command))
         try:
             output = subprocess.check_output(command, stderr=subprocess.STDOUT)  # nosec - All subprocess calls use full path
-        except subprocess.CalledProcessError as error:
+        except subprocess.CalledProcessError as error:  # pragma: no cover
             if self.print_error_output:
                 print(colored(f'Install command {" ".join(command)!r} failed', "red"), flush=True)
                 print(error.stdout.decode().strip())
@@ -326,7 +328,7 @@ def install(self, dependencies, config_key=None):
                 LOG.error(error.stdout.decode.strip())
             return []
 
-        if self.print_output:
+        if self.print_output:  # pragma: no cover
             print(output.decode().strip())
         else:  # pragma: no cover
             LOG.debug(output.decode().strip())

src/screwdrivercd/repo/release.py

@@ -51,7 +51,8 @@ def main(meta_command: str='meta') -> int:
         print('Tagging is disabled for this job')
         return 0
 
-    if not os.environ.get('SSH_AUTH_SOCK', ''):  # If ssh-agent isn't already configured, we use the GIT_DEPLOY_KEY
+    # If ssh-agent isn't already configured, use the GIT_DEPLOY_KEY
+    if not os.environ.get('SSH_AUTH_SOCK', ''):  # pragma: no cover
         if not os.environ.get('GIT_DEPLOY_KEY', ''):
             print('Git deployment key is not present, cannot commit tags to the git repo')
             return 0

src/screwdrivercd/utility/__init__.py

@@ -7,4 +7,4 @@
 from .screwdriver import create_artifact_directory
 
 
-__all__ = ['contextmanagers', 'environment', 'exceptions', 'package', 'run', 'screwdriver']
+__all__ = ['contextmanagers', 'environment', 'exceptions', 'output', 'package', 'run', 'screwdriver', 'tox']

src/screwdrivercd/utility/contextmanagers.py

@@ -5,8 +5,13 @@
 """
 import logging
 import os
-from contextlib import contextmanager
+import signal
+from contextlib import contextmanager, ContextDecorator
+from datetime import timedelta
 from tempfile import TemporaryDirectory
+from typing import Optional, Union
+
+from .exceptions import TimeoutError
 
 
 logger = logging.getLogger(__name__)
@@ -57,3 +62,42 @@ def InTemporaryDirectory():
     with TemporaryDirectory() as tempdir:
         with working_dir(tempdir):
             yield tempdir
+
+
+class Timeout(ContextDecorator):
+    """
+    A contextmanager that will timeout after a specific datetime.timedelta
+    """
+    use_alarm: Union[bool, None] = False
+    _old_handler = None
+
+    def __init__(self, timeout: Optional[timedelta]=None, use_alarm: Union[bool, None]=None):
+        self.timeout = timeout
+        self.use_alarm = use_alarm
+        if use_alarm is None:
+            # use_alarm wasn't specified, set the value based on support for signal.setitimer()
+            if hasattr(signal, 'setitimer'):
+                self.use_alarm = False
+            else:  # pragma: no cover
+                self.use_alarm = True
+
+    def _timeout_handler(self, signum, frame):
+        raise TimeoutError(f'Timeout after {self.timeout}')
+
+    def __enter__(self):
+        if self.timeout:
+            if self.use_alarm:
+                self._old_handler = signal.signal(signal.SIGALRM, self._timeout_handler)
+                signal.alarm(self.timeout.seconds)
+            else:
+                self._old_handler = signal.signal(signal.SIGALRM, self._timeout_handler)
+                signal.setitimer(signal.ITIMER_REAL, float(self.timeout.microseconds) / 1000000)
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if self.timeout:
+            if self.use_alarm:
+                signal.alarm(0)
+            else:
+                signal.setitimer(signal.ITIMER_REAL, 0)
+        if self._old_handler:
+            signal.signal(signal.SIGALRM, self._old_handler)