Fix file_rules globbing (#1453)

* Issue#1446: Fixed comment indentation at end of scope

* config: Refactored glob_filenames

* config: Fixed error message construction in validate_file_exists

* config: Fixed process_file_list_key to use key parameter

* Issue#1425: Fixed missing globbing of "file_rules"

* Adding tests.

* Revert "Issue#1446: Fixed comment indentation at end of scope"

This reverts commit 7106e12.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>

Author: benthie

tests/vsg/config_file_rules_w_globbing.yaml

@@ -0,0 +1,24 @@
+---
+rule:
+  entity_008:
+    disable : True
+  entity_012:
+    disable : True
+  port_010:
+    disable : True
+  architecture_011:
+    disable : True
+  architecture_013:
+    disable : True
+  architecture_014:
+    disable : True
+file_rules:
+  - tests/**/entity1.vhd :
+      rule:
+         port_007:
+            disable : True
+  - tests/**/*2.vhd :
+      rule:
+         port_008:
+            disable : True
+...

tests/vsg/test_vsg.py

@@ -565,6 +565,21 @@ def test_configuration_with_file_rules_and_no_file_list_entity1(self):
 
         self.assertEqual(lActual, lExpected)
 
+    def test_configuration_with_globbing_in_file_rules(self):
+        lExpected = []
+
+        lActual = []
+
+        try:
+            subprocess.check_output(
+                [*utils.vsg_exec(), "--configuration", "tests/vsg/config_file_rules_w_globbing.yaml", "-f", "tests/vsg/*.vhd", "--output_format", "syntastic"],
+            )
+        except subprocess.CalledProcessError as e:
+            lActual = str(e.output.decode("utf-8")).splitlines()
+            iExitStatus = e.returncode
+
+        self.assertEqual(lActual, lExpected)
+
     def test_file_as_stdin(self):
         with open("tests/vsg/entity1.vhd") as file1:
             lExpected = []

vsg/config.py

@@ -54,9 +54,9 @@ def validate_file_exists(sFilename, sConfigName):
         sExpandedFilename = list(sFilename.keys())[0]
     else:
         sExpandedFilename = sFilename
-    lFileNames = glob.glob(utils.expand_filename(sExpandedFilename), recursive=True)
+    lFileNames = glob_filenames(sExpandedFilename)
     if len(lFileNames) == 0:
-        print("ERROR: Could not find file " + sFilename + " in configuration file " + sConfigName)
+        print("ERROR: Could not find file " + sExpandedFilename + " in configuration file " + sConfigName)
         sys.exit(1)
 
 
@@ -75,9 +75,8 @@ def read_configuration_files(dStyle, commandLineArguments):
 def process_config_file(dConfiguration, tempConfiguration, sConfigFilename):
     dReturn = dConfiguration
     for sKey in tempConfiguration.keys():
-        if sKey == "file_list":
+        if sKey == "file_list" or sKey == "file_rules":
             dReturn = process_file_list_key(dReturn, tempConfiguration, sKey, sConfigFilename)
-
         elif sKey == "rule":
             for sRule in tempConfiguration[sKey]:
                 try:
@@ -135,25 +134,29 @@ def search_list(lDict, lDeprecatedKeys, sConfigFilename, lMessages):
 
 def process_file_list_key(dConfig, tempConfiguration, sKey, sConfigFilename):
     dReturn = dConfig
-    if "file_list" not in dConfig:
-        dReturn["file_list"] = []
-    for iIndex, sFilename in enumerate(tempConfiguration["file_list"]):
+    if sKey not in dConfig:
+        dReturn[sKey] = []
+    for iIndex, sFilename in enumerate(tempConfiguration[sKey]):
         validate_file_exists(sFilename, sConfigFilename)
         try:
-            for sGlobbedFilename in glob_filenames(sFilename):
-                dReturn["file_list"].append(sGlobbedFilename)
+            for sGlobbedFilename in glob_filenames_clean(sFilename):
+                dReturn[sKey].append(sGlobbedFilename)
         except TypeError:
-            sKey = list(sFilename.keys())[0]
-            for sGlobbedFilename in glob_filenames(sKey):
+            sFilename = list(sFilename.keys())[0]
+            for sGlobbedFilename in glob_filenames_clean(sFilename):
                 dTemp = {}
                 dTemp[sGlobbedFilename] = {}
-                dTemp[sGlobbedFilename].update(tempConfiguration["file_list"][iIndex][sKey])
-                dReturn["file_list"].append(dTemp)
+                dTemp[sGlobbedFilename].update(tempConfiguration[sKey][iIndex][sFilename])
+                dReturn[sKey].append(dTemp)
     return dReturn
 
 
 def glob_filenames(sFilename):
-    files = glob.glob(utils.expand_filename(sFilename), recursive=True)
+    return glob.glob(utils.expand_filename(sFilename), recursive=True)
+
+
+def glob_filenames_clean(sFilename):
+    files = glob_filenames(sFilename)
     return replace_backslash_with_forward_slash(files)
 
 
@@ -378,12 +381,12 @@ def update_command_line_arguments(commandLineArguments, configuration):
             if isinstance(sFilename, dict):
                 sFilename = list(sFilename.keys())[0]
             try:
-                lFileNames = glob.glob(utils.expand_filename(sFilename), recursive=True)
+                lFileNames = glob_filenames(sFilename)
                 for sFileName in lFileNames:
                     if sFileName not in commandLineArguments.filename:
                         commandLineArguments.filename.append(sFileName)
             except:
-                commandLineArguments.filename = glob.glob(utils.expand_filename(sFilename), recursive=True)
+                commandLineArguments.filename = glob_filenames(sFilename)
 
     if "local_rules" in configuration:
         commandLineArguments.local_rules = utils.expand_filename(configuration["local_rules"])