Test refactor and add test for recursive mode.

Author: danielhollas

fprettify/tests/__init__.py

@@ -52,12 +52,14 @@ def joinpath(path1, path2):
 RESULT_FILE = joinpath(RESULT_DIR, r'expected_results')
 FAILED_FILE = joinpath(RESULT_DIR, r'failed_results')
 
+TEMP_DIR = joinpath(MYPATH, r'tmp_test_dir/')
+
 RUNSCRIPT = joinpath(MYPATH, r"../../fprettify.py")
 
 fprettify.set_fprettify_logger(logging.ERROR)
 
 
-class AlienInvasion(Exception):
+class FileException(Exception):
     """Should not happen"""
     pass
 
@@ -85,6 +87,27 @@ def setUp(self):
         """
         self.maxDiff = None
 
+    def createTmpDir(self):
+        """
+        Create a temporary directory for IO tests
+        """
+        if os.path.lexists(TEMP_DIR):
+            raise FileException(
+                "remove directory %s" % TEMP_DIR)  # pragma: no cover
+        os.mkdir(TEMP_DIR)
+
+    def removeTmpDir(self):
+        """
+        Remove the temporary test directory and all its content.
+        """
+        if not os.path.isdir(TEMP_DIR):
+            return
+
+        for dirpath, _, files in os.walk(TEMP_DIR, topdown=False):
+            for f in files:
+                os.remove(joinpath(dirpath, f))
+            os.rmdir(dirpath)
+
     @classmethod
     def setUpClass(cls):
         """
@@ -258,10 +281,8 @@ def test_io(self):
         instring = "CALL  alien_invasion( 👽 )"
         outstring_exp = "CALL alien_invasion(👽)"
 
-        alien_file = "alien_invasion.f90"
-        if os.path.isfile(alien_file):
-            raise AlienInvasion(
-                "remove file alien_invasion.f90")  # pragma: no cover
+        self.createTmpDir()
+        alien_file = joinpath(TEMP_DIR, "alien_invasion.f90")
 
         try:
             with io.open(alien_file, 'w', encoding='utf-8') as infile:
@@ -289,12 +310,71 @@ def test_io(self):
             for outstr in outstring:
                 self.assertEqual(outstring_exp, outstr.strip())
         except:  # pragma: no cover
-            if os.path.isfile(alien_file):
-                os.remove(alien_file)
+            self.removeTmpDir()
             raise
         else:
-            os.remove(alien_file)
+            self.removeTmpDir()
 
+    def test_recursive_mode(self):
+        """test recursive mode which finds all fortran files in the tree"""
+
+        instring = "CALL  alien_invasion( x)"
+        formatted_string = "CALL alien_invasion(x)"
+
+        self.createTmpDir()
+
+        # We will create the following paths inside TEMP_DIR
+        # - alien_file.f90
+        # - excluded_alien_file.f90
+        # - subdir/alien_invasion.f90
+        # - subdir/excluded_alien_invasion.f90
+        # - excluded_subdir/alien_invasion.f90
+        alien_file = "alien_invasion.f90"
+        excluded_file = "excluded_alien_invasion.f90"
+        subdir = joinpath(TEMP_DIR, "subdir/")
+        excluded_subdir = joinpath(TEMP_DIR, "excluded_subdir/")
+        os.mkdir(subdir)
+        os.mkdir(excluded_subdir)
+
+        def create_file(fname):
+            with io.open(fname, 'w', encoding='utf-8') as infile:
+                infile.write(instring)
+
+        def check_output_file(fname, str_exp):
+            with io.open(fname, 'r', encoding='utf-8') as infile:
+                self.assertEqual(str_exp, infile.read().strip())
+
+        try:
+            create_file(joinpath(TEMP_DIR, alien_file))
+            create_file(joinpath(TEMP_DIR, excluded_file))
+            create_file(joinpath(subdir, alien_file))
+            create_file(joinpath(subdir, excluded_file))
+            create_file(joinpath(excluded_subdir, alien_file))
+
+            p1 = subprocess.Popen([
+                    RUNSCRIPT,
+                    '--recursive',
+                    '-e', 'excluded_*',
+                    TEMP_DIR],
+                    stdout=subprocess.PIPE)
+            p1.wait()
+
+            # Check files that should be formatted.
+            check_output_file(joinpath(TEMP_DIR, alien_file), formatted_string)
+            check_output_file(joinpath(subdir, alien_file), formatted_string)
+
+            # Check excluded files.
+            check_output_file(joinpath(TEMP_DIR, excluded_file), instring)
+            check_output_file(joinpath(subdir, excluded_file), instring)
+
+            # Check excluded directory.
+            check_output_file(joinpath(excluded_subdir, alien_file), instring)
+
+        except:  # pragma: no cover
+            self.removeTmpDir()
+            raise
+        else:
+            self.removeTmpDir()
 
     def test_config_file(self):
         """simple test for configuration file reading"""
@@ -304,27 +384,31 @@ def test_config_file(self):
         outstring_with_config = "call alien_invasion(x)"
         outstring_without_config = "CALL alien_invasion(x)"
 
-        dirname = 'test_tmp/'
+        self.createTmpDir()
+        dirname = TEMP_DIR
 
-        if os.path.lexists(dirname):
-            raise AlienInvasion(
-                "remove directory test_tmp")  # pragma: no cover
+        alien_file = joinpath(dirname, "alien_invasion.f90")
+        excluded_file = joinpath(dirname, "excluded.f90")
+        config_file = joinpath(dirname, ".fprettify.rc")
+        conf_string = "case=[1,1,1,2]\nexclude=[excluded*]"
 
-        os.mkdir(dirname)
-        alien_file = os.path.join(dirname, "alien_invasion.f90")
-        excluded_file = os.path.join(dirname, "excluded.f90")
-        config_file = os.path.join(dirname, ".fprettify.rc")
-        configuration = "case=[1,1,1,2]\nexclude=[excluded.f90]"
+        def create_file(fname, string):
+            with io.open(fname, 'w', encoding='utf-8') as infile:
+                infile.write(string)
 
-        try:
-            with io.open(alien_file, 'w', encoding='utf-8') as infile:
-                infile.write(instring)
+        def check_output_file(fname, str_exp):
+            with io.open(fname, 'r', encoding='utf-8') as infile:
+                self.assertEqual(str_exp, infile.read().strip())
 
-            with io.open(excluded_file, 'w', encoding='utf-8') as infile:
-                infile.write(instring)
+        try:
+            create_file(alien_file, instring)
+            create_file(excluded_file, instring)
+            create_file(config_file, conf_string)
 
-            with io.open(config_file, 'w', encoding='utf-8') as infile:
-                infile.write(configuration)
+            excluded_subdir = joinpath(TEMP_DIR, 'excluded_subdir/')
+            os.mkdir(excluded_subdir)
+            file_in_excluded_subdir = joinpath(excluded_subdir, 'aliens.F90')
+            create_file(file_in_excluded_subdir, instring)
 
             # testing stdin --> stdout
             # In this case, the config file will not be read,
@@ -345,28 +429,18 @@ def test_config_file(self):
                                   stdout=subprocess.PIPE)
             p1.wait()
 
-            with io.open(alien_file, 'r', encoding='utf-8') as infile:
-                self.assertEqual(outstring_with_config, infile.read().strip())
-
+            check_output_file(alien_file, outstring_with_config)
             # Excluded file should not be touched at all.
-            with io.open(excluded_file, 'r', encoding='utf-8') as infile:
-                self.assertEqual(instring, infile.read().strip())
+            check_output_file(excluded_file, instring)
+            # File in excluded directory should not be touched at all.
+            # TODO: Make this work!
+            #check_output_file(file_in_excluded_subdir, instring)
 
         except:  # pragma: no cover
-            if os.path.isfile(alien_file):
-                os.remove(alien_file)
-            if os.path.isfile(excluded_file):
-                os.remove(excluded_file)
-            if os.path.isfile(config_file):
-                os.remove(config_file)
-            if os.path.isdir(dirname):
-                os.rmdir(dirname)
+            self.removeTmpDir()
             raise
         else:
-            os.remove(alien_file)
-            os.remove(excluded_file)
-            os.remove(config_file)
-            os.rmdir(dirname)
+            self.removeTmpDir()
 
     def test_multi_alias(self):
         """test for issue #11 (multiple alias and alignment)"""