More toxification

- Move pylint tests to tox
- Move yamllint tests to tox
- Create separate tox config (and setup.py) for root
- bump ansible requirement
- unify pylint config
- add docs
- remove git directory containing old testing tools
- install python-six if not present for openshift-facts
- add python-six as a dependency for openshift-ansible-utils

1 files changed, 191 insertions, 0 deletions

diff --git a/setup.py b/setup.py
new file mode 100644
index 000000000..e598c3502
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,191 @@
+"""A setuptools based setup module.
+
+"""
+from __future__ import print_function
+
+import os
+import fnmatch
+import re
+
+import yaml
+
+# Always prefer setuptools over distutils
+from setuptools import setup, Command
+from setuptools_lint.setuptools_command import PylintCommand
+from six import string_types
+from yamllint.config import YamlLintConfig
+from yamllint.cli import Format
+from yamllint import linter
+
+def find_files(base_dir, exclude_dirs, include_dirs, file_regex):
+    ''' find files matching file_regex '''
+    found = []
+    exclude_regex = ''
+    include_regex = ''
+
+    if exclude_dirs is not None:
+        exclude_regex = r'|'.join([fnmatch.translate(x) for x in exclude_dirs]) or r'$.'
+
+    if include_dirs is not None:
+        include_regex = r'|'.join([fnmatch.translate(x) for x in include_dirs]) or r'$.'
+
+    for root, dirs, files in os.walk(base_dir):
+        if exclude_dirs is not None:
+            # filter out excludes for dirs
+            dirs[:] = [d for d in dirs if not re.match(exclude_regex, d)]
+
+        if include_dirs is not None:
+            # filter for includes for dirs
+            dirs[:] = [d for d in dirs if re.match(include_regex, d)]
+
+        matches = [os.path.join(root, f) for f in files if re.search(file_regex, f) is not None]
+        found.extend(matches)
+
+    return found
+
+
+class OpenShiftAnsibleYamlLint(Command):
+    ''' Command to run yamllint '''
+    description = "Run yamllint tests"
+    user_options = [
+        ('excludes=', 'e', 'directories to exclude'),
+        ('config-file=', 'c', 'config file to use'),
+        ('format=', 'f', 'format to use (standard, parsable)'),
+    ]
+
+    def initialize_options(self):
+        ''' initialize_options '''
+        # Reason: Defining these attributes as a part of initialize_options is
+        # consistent with upstream usage
+        # Status: permanently disabled
+        # pylint: disable=attribute-defined-outside-init
+        self.excludes = None
+        self.config_file = None
+        self.format = None
+
+    def finalize_options(self):
+        ''' finalize_options '''
+        # Reason: These attributes are defined in initialize_options and this
+        # usage is consistant with upstream usage
+        # Status: permanently disabled
+        # pylint: disable=attribute-defined-outside-init
+        if isinstance(self.excludes, string_types):
+            self.excludes = self.excludes.split(',')
+        if self.format is None:
+            self.format = 'standard'
+        assert (self.format in ['standard', 'parsable']), (
+            'unknown format {0}.'.format(self.format))
+        if self.config_file is None:
+            self.config_file = '.yamllint'
+        assert os.path.isfile(self.config_file), (
+            'yamllint config file {0} does not exist.'.format(self.config_file))
+
+    def run(self):
+        ''' run command '''
+        if self.excludes is not None:
+            print("Excludes:\n{0}".format(yaml.dump(self.excludes, default_flow_style=False)))
+
+        config = YamlLintConfig(file=self.config_file)
+
+        has_errors = False
+        has_warnings = False
+
+        if self.format == 'parsable':
+            format_method = Format.parsable
+        else:
+            format_method = Format.standard_color
+
+        for yaml_file in find_files(os.getcwd(), self.excludes, None, r'\.ya?ml$'):
+            first = True
+            with open(yaml_file, 'r') as contents:
+                for problem in linter.run(contents, config):
+                    if first and self.format != 'parsable':
+                        print('\n{0}:'.format(os.path.relpath(yaml_file)))
+                        first = False
+
+                    print(format_method(problem, yaml_file))
+                    if problem.level == linter.PROBLEM_LEVELS['error']:
+                        has_errors = True
+                    elif problem.level == linter.PROBLEM_LEVELS['warning']:
+                        has_warnings = True
+
+        assert not has_errors, 'yamllint errors found'
+        assert not has_warnings, 'yamllint warnings found'
+
+
+class OpenShiftAnsiblePylint(PylintCommand):
+    ''' Class to override the default behavior of PylintCommand '''
+
+    # Reason: This method needs to be an instance method to conform to the
+    # overridden method's signature
+    # Status: permanently disabled
+    # pylint: disable=no-self-use
+    def find_all_modules(self):
+        ''' find all python files to test '''
+        exclude_dirs = ['.tox', 'utils', 'test', 'tests', 'git']
+        modules = []
+        for match in find_files(os.getcwd(), exclude_dirs, None, r'\.py$'):
+            package = os.path.basename(match).replace('.py', '')
+            modules.append(('openshift_ansible', package, match))
+        return modules
+
+    def get_finalized_command(self, cmd):
+        ''' override get_finalized_command to ensure we use our
+        find_all_modules method '''
+        if cmd == 'build_py':
+            return self
+
+    # Reason: This method needs to be an instance method to conform to the
+    # overridden method's signature
+    # Status: permanently disabled
+    # pylint: disable=no-self-use
+    def with_project_on_sys_path(self, func, func_args, func_kwargs):
+        ''' override behavior, since we don't need to build '''
+        return func(*func_args, **func_kwargs)
+
+
+class UnsupportedCommand(Command):
+    ''' Basic Command to override unsupported commands '''
+    user_options = []
+
+    # Reason: This method needs to be an instance method to conform to the
+    # overridden method's signature
+    # Status: permanently disabled
+    # pylint: disable=no-self-use
+    def initialize_options(self):
+        ''' initialize_options '''
+        pass
+
+    # Reason: This method needs to be an instance method to conform to the
+    # overridden method's signature
+    # Status: permanently disabled
+    # pylint: disable=no-self-use
+    def finalize_options(self):
+        ''' initialize_options '''
+        pass
+
+    # Reason: This method needs to be an instance method to conform to the
+    # overridden method's signature
+    # Status: permanently disabled
+    # pylint: disable=no-self-use
+    def run(self):
+        ''' run command '''
+        print("Unsupported command for openshift-ansible")
+
+
+setup(
+    name='openshift-ansible',
+    license="Apache 2.0",
+    cmdclass={
+        'install': UnsupportedCommand,
+        'develop': UnsupportedCommand,
+        'build': UnsupportedCommand,
+        'build_py': UnsupportedCommand,
+        'build_ext': UnsupportedCommand,
+        'egg_info': UnsupportedCommand,
+        'sdist': UnsupportedCommand,
+        'lint': OpenShiftAnsiblePylint,
+        'yamllint': OpenShiftAnsibleYamlLint,
+    },
+    packages=[],
+)