Move Rules classes into the rules directory from init (aws-cloudformation#1098)

Author: kddejong

docs/getting_started/rules.md

@@ -56,8 +56,8 @@ Use the following skeleton code as a starting point of your new rule:
   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
   SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 """
-from cfnlint import CloudFormationLintRule
-from cfnlint import RuleMatch
+from cfnlint.rules import CloudFormationLintRule
+from cfnlint.rules import RuleMatch
 
 
 class MyNewRule(CloudFormationLintRule):

examples/rules/PropertiesTagsIncluded.py

@@ -14,8 +14,8 @@
   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
   SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 """
-from cfnlint import CloudFormationLintRule
-from cfnlint import RuleMatch
+from cfnlint.rules import CloudFormationLintRule
+from cfnlint.rules import RuleMatch
 import cfnlint.helpers
 
 

examples/rules/PropertiesTagsRequired.py

@@ -14,8 +14,8 @@
   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
   SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 """
-from cfnlint import CloudFormationLintRule
-from cfnlint import RuleMatch
+from cfnlint.rules import CloudFormationLintRule
+from cfnlint.rules import RuleMatch
 
 
 class PropertiesTagsRequired(CloudFormationLintRule):

src/cfnlint/__init__.py

@@ -18,7 +18,7 @@
 import os
 import sys
 from jsonschema.exceptions import ValidationError
-from cfnlint import RulesCollection
+from cfnlint.rules import RulesCollection
 import cfnlint.config
 import cfnlint.formatters
 import cfnlint.decode

src/cfnlint/core.py

@@ -23,8 +23,8 @@
     JSONDecodeError = ValueError
 from yaml.parser import ParserError, ScannerError
 from yaml import YAMLError
-import cfnlint.decode.cfn_yaml
-import cfnlint.decode.cfn_json
+from cfnlint.decode import cfn_yaml, cfn_json
+from cfnlint.rules import Match, ParseError
 
 
 LOGGER = logging.getLogger(__name__)
@@ -37,24 +37,32 @@ def decode(filename, ignore_bad_template):
     template = None
     matches = []
     try:
-        template = cfnlint.decode.cfn_yaml.load(filename)
+        template = cfn_yaml.load(filename)
     except IOError as e:
         if e.errno == 2:
             LOGGER.error('Template file not found: %s', filename)
-            matches.append(create_match_file_error(filename, 'Template file not found: %s' % filename))
+            matches.append(create_match_file_error(
+                filename, 'Template file not found: %s' % filename))
         elif e.errno == 21:
-            LOGGER.error('Template references a directory, not a file: %s', filename)
-            matches.append(create_match_file_error(filename, 'Template references a directory, not a file: %s' % filename))
+            LOGGER.error('Template references a directory, not a file: %s',
+                         filename)
+            matches.append(create_match_file_error(
+                filename,
+                'Template references a directory, not a file: %s' % filename))
         elif e.errno == 13:
-            LOGGER.error('Permission denied when accessing template file: %s', filename)
-            matches.append(create_match_file_error(filename, 'Permission denied when accessing template file: %s' % filename))
+            LOGGER.error('Permission denied when accessing template file: %s',
+                         filename)
+            matches.append(create_match_file_error(
+                filename,
+                'Permission denied when accessing template file: %s' % filename))
 
         if matches:
             return(None, matches)
     except UnicodeDecodeError as err:
         LOGGER.error('Cannot read file contents: %s', filename)
-        matches.append(create_match_file_error(filename, 'Cannot read file contents: %s' % filename))
-    except cfnlint.decode.cfn_yaml.CfnParseError as err:
+        matches.append(create_match_file_error(
+            filename, 'Cannot read file contents: %s' % filename))
+    except cfn_yaml.CfnParseError as err:
         err.match.Filename = filename
         matches = [err.match]
     except ParserError as err:
@@ -64,28 +72,36 @@ def decode(filename, ignore_bad_template):
                 'found character \'\\t\' that cannot start any token',
                 'found unknown escape character']:
             try:
-                template = cfnlint.decode.cfn_json.load(filename)
-            except cfnlint.decode.cfn_json.JSONDecodeError as json_err:
+                template = cfn_json.load(filename)
+            except cfn_json.JSONDecodeError as json_err:
                 json_err.match.filename = filename
                 matches = [json_err.match]
             except JSONDecodeError as json_err:
                 matches = [create_match_json_parser_error(json_err, filename)]
             except Exception as json_err:  # pylint: disable=W0703
                 if ignore_bad_template:
-                    LOGGER.info('Template %s is malformed: %s', filename, err.problem)
-                    LOGGER.info('Tried to parse %s as JSON but got error: %s', filename, str(json_err))
+                    LOGGER.info('Template %s is malformed: %s',
+                                filename, err.problem)
+                    LOGGER.info('Tried to parse %s as JSON but got error: %s',
+                                filename, str(json_err))
                 else:
-                    LOGGER.error('Template %s is malformed: %s', filename, err.problem)
-                    LOGGER.error('Tried to parse %s as JSON but got error: %s', filename, str(json_err))
-                    return(None, [create_match_file_error(filename, 'Tried to parse %s as JSON but got error: %s' % (filename, str(json_err)))])
+                    LOGGER.error(
+                        'Template %s is malformed: %s', filename, err.problem)
+                    LOGGER.error('Tried to parse %s as JSON but got error: %s',
+                                 filename, str(json_err))
+                    return (None, [create_match_file_error(
+                        filename,
+                        'Tried to parse %s as JSON but got error: %s' % (
+                            filename, str(json_err)))])
         else:
             matches = [create_match_yaml_parser_error(err, filename)]
     except YAMLError as err:
         matches = [create_match_file_error(filename, err)]
 
     if not isinstance(template, dict) and not matches:
         # Template isn't a dict which means nearly nothing will work
-        matches = [cfnlint.Match(1, 1, 1, 1, filename, cfnlint.ParseError(), message='Template needs to be an object.')]
+        matches = [Match(1, 1, 1, 1, filename, ParseError(),
+                         message='Template needs to be an object.')]
     return (template, matches)
 
 
@@ -94,16 +110,16 @@ def create_match_yaml_parser_error(parser_error, filename):
     lineno = parser_error.problem_mark.line + 1
     colno = parser_error.problem_mark.column + 1
     msg = parser_error.problem
-    return cfnlint.Match(
+    return Match(
         lineno, colno, lineno, colno + 1, filename,
-        cfnlint.ParseError(), message=msg)
+        ParseError(), message=msg)
 
 
 def create_match_file_error(filename, msg):
     """Create a Match for a parser error"""
-    return cfnlint.Match(
+    return Match(
         linenumber=1, columnnumber=1, linenumberend=1, columnnumberend=2,
-        filename=filename, rule=cfnlint.ParseError(), message=msg)
+        filename=filename, rule=ParseError(), message=msg)
 
 
 def create_match_json_parser_error(parser_error, filename):
@@ -116,5 +132,5 @@ def create_match_json_parser_error(parser_error, filename):
         lineno = 1
         colno = 1
         msg = parser_error.message
-    return cfnlint.Match(
-        lineno, colno, lineno, colno + 1, filename, cfnlint.ParseError(), message=msg)
+    return Match(
+        lineno, colno, lineno, colno + 1, filename, ParseError(), message=msg)

src/cfnlint/decode/__init__.py

@@ -74,9 +74,9 @@ def __init__(self, msg, doc, pos, key=' '):
         self.pos = pos
         self.lineno = lineno
         self.colno = colno
-        self.match = cfnlint.Match(
+        self.match = cfnlint.rules.Match(
             lineno, colno + 1, lineno,
-            colno + 1 + len(key), '', cfnlint.ParseError(), message=msg)
+            colno + 1 + len(key), '', cfnlint.rules.ParseError(), message=msg)
 
     def __reduce__(self):
         return self.__class__, (self.msg, self.doc, self.pos)

src/cfnlint/decode/cfn_json.py

@@ -47,6 +47,7 @@ class CfnParseError(ConstructorError):
     """
     Error thrown when the template contains Cfn Error
     """
+
     def __init__(self, filename, message, line_number, column_number, key=' '):
 
         # Call the base class constructor with the parameters it needs
@@ -57,9 +58,9 @@ def __init__(self, filename, message, line_number, column_number, key=' '):
         self.line_number = line_number
         self.column_number = column_number
         self.message = message
-        self.match = cfnlint.Match(
+        self.match = cfnlint.rules.Match(
             line_number + 1, column_number + 1, line_number + 1,
-            column_number + 1 + len(key), filename, cfnlint.ParseError(), message=message)
+            column_number + 1 + len(key), filename, cfnlint.rules.ParseError(), message=message)
 
 
 class NodeConstructor(SafeConstructor):
@@ -91,7 +92,8 @@ def construct_yaml_map(self, node):
             if key in mapping:
                 raise CfnParseError(
                     self.filename,
-                    'Duplicate resource found "{}" (line {})'.format(key, key_node.start_mark.line + 1),
+                    'Duplicate resource found "{}" (line {})'.format(
+                        key, key_node.start_mark.line + 1),
                     key_node.start_mark.line, key_node.start_mark.column, key)
             mapping[key] = value
 
@@ -112,7 +114,8 @@ def construct_yaml_null_error(self, node):
         """Throw a null error"""
         raise CfnParseError(
             self.filename,
-            'Null value at line {0} column {1}'.format(node.start_mark.line + 1, node.start_mark.column + 1),
+            'Null value at line {0} column {1}'.format(
+                node.start_mark.line + 1, node.start_mark.column + 1),
             node.start_mark.line, node.start_mark.column, ' ')
 
 
@@ -138,6 +141,7 @@ class MarkedLoader(Reader, Scanner, Parser, Composer, NodeConstructor, Resolver)
     Class for marked loading YAML
     """
     # pylint: disable=non-parent-init-called,super-init-not-called
+
     def __init__(self, stream, filename):
         Reader.__init__(self, stream)
         Scanner.__init__(self)

src/cfnlint/decode/cfn_yaml.py

@@ -15,7 +15,8 @@
   SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 """
 import json
-from cfnlint import Match
+from cfnlint.rules import Match
+
 
 class BaseFormatter(object):
     """Base Formatter class"""

src/cfnlint/formatters/__init__.py

@@ -292,7 +292,7 @@ def onerror(os_error):
                 mod = imp.load_module(pluginname, fh, filename, desc)
                 for _, clazz in inspect.getmembers(mod, inspect.isclass):
                     method_resolution = inspect.getmro(clazz)
-                    if [clz for clz in method_resolution[1:] if clz.__module__ == 'cfnlint' and clz.__name__ == 'CloudFormationLintRule']:
+                    if [clz for clz in method_resolution[1:] if clz.__module__ in ('cfnlint', 'cfnlint.rules') and clz.__name__ == 'CloudFormationLintRule']:
                         # create and instance of subclasses of CloudFormationLintRule
                         obj = clazz()
                         result.append(obj)