Merge lp:~javier.collado/checkbox-editor/bug984724 into lp:checkbox-editor

[Javier Collado]

This merge request fixes bug#984724

Instead of trying to parse each line, it goes directly to the interesting place using `re.search`.

Besides this,
- Here documents (<<) are ignored
- Only one pattern is expected after `cat` command
The initial design supported suites that included multiple files, but this has never been used, so this is a good opportunity to remove part of that code to simplify the implementation.

[Sylvain Pineau (sylvain-pineau)]

Thanks for the here documents filter, it works perfectly.

review: Approve

=== modified file 'checkbox_editor/preferences.py'
--- checkbox_editor/preferences.py	2011-11-10 08:33:28 +0000
+++ checkbox_editor/preferences.py	2012-04-19 11:23:26 +0000
@@ -208,62 +208,52 @@
         force: Used to return a filename for a pattern
         even when the file doesn't exist
         """
-        logging.debug('Parsing command: {0}'.format(command))
-        try:
-            fragments = shlex.split(command)
-        except ValueError:
-            # Return nothing is shlex.split failed
-            problem = ('Command parsing error', command)
-            if problem not in self.problems:
-                self.problems.append(problem)
-            return []
-
-        if not fragments[0] == 'cat':
-            logging.warning("'cat' command not found: {0!r}".format(command))
-            problem = ('Command parsing error', command)
-            if problem not in self.problems:
-                self.problems.append(problem)
-            return []
-        elif len(fragments) > 2:
-            logging.warning("Unexpected command: {0!r}".format(command))
-            problem = ('Command parsing error', command)
-            if problem not in self.problems:
-                self.problems.append(problem)
-            return []
-
-
-        # Iterate through all environment variables found in the path
+        match = re.search('cat\s+(?P<pattern>\S+)', command)
+        if not match:
+            return []
+
+        filename_pattern = match.group('pattern')
+
+        # Skip here documents
+        # (test suites embedded in the same file)
+        if filename_pattern.startswith('<<'):
+            return []
+
+        filename_pattern = self.expand(filename_pattern)
+
+        # patch to support for extglob patterns
+        filename_pattern = filename_pattern.replace('?(.in)', '*')
+
         all_filenames = []
-        for filename_pattern in self.expand(command).split()[1:]:
-            filenames = [filename
-                         for filename in glob(filename_pattern)
-                         if not filename.endswith('~')]
-
-            if not filenames and force:
-                directory = os.path.dirname(filename_pattern)
-                rootname, extension_pattern = os.path.splitext(os.path.basename(filename_pattern))
-
-                if not self.ENV_VAR_REGEX.match(directory):
-                    directory = os.path.realpath(directory)
-
-                if extension_pattern == '.txt*':
-                    if any(glob(os.path.join(directory, '*.txt.in'))):
-                        extension = '.txt.in'
-                    else:
-                        extension = '.txt'
-
-                    all_filenames.append(os.path.join(directory,
-                                                      '{0}{1}'.format(rootname, extension)))
-
-            for filename in filenames:
-                if not self.ENV_VAR_REGEX.match(filename):
-                    filename = os.path.realpath(filename)
-
-                if not os.path.isfile(filename):
-                    logging.error('File not found: (filename: {0}, command: {1}) '
-                                  .format(filename, command))
-                    continue
-                all_filenames.append(filename)
+        filenames = [filename
+                     for filename in glob(filename_pattern)
+                     if not filename.endswith('~')]
+
+        if not filenames and force:
+            directory = os.path.dirname(filename_pattern)
+            rootname, extension_pattern = os.path.splitext(os.path.basename(filename_pattern))
+
+            if not self.ENV_VAR_REGEX.match(directory):
+                directory = os.path.realpath(directory)
+
+            if extension_pattern == '.txt*':
+                if any(glob(os.path.join(directory, '*.txt.in'))):
+                    extension = '.txt.in'
+                else:
+                    extension = '.txt'
+
+                all_filenames.append(os.path.join(directory,
+                                                  '{0}{1}'.format(rootname, extension)))
+
+        for filename in filenames:
+            if not self.ENV_VAR_REGEX.match(filename):
+                filename = os.path.realpath(filename)
+
+            if not os.path.isfile(filename):
+                logging.error('File not found: (filename: {0}, command: {1}) '
+                              .format(filename, command))
+                continue
+            all_filenames.append(filename)
 
         logging.debug('Filenames found in command: {0}'.format(all_filenames))
         return all_filenames