Limit amount of attempts and test error conditions

Author: Flamefire

easybuild/tools/filetools.py

@@ -2485,14 +2485,11 @@ def create_unused_dir(parent_folder, name):
         parent_folder = os.path.abspath(parent_folder)
 
     start_path = os.path.join(parent_folder, name)
-    number = None
-    while True:
-        if number is None:
+    for number in range(-1, 10000):  # Start with no suffix and limit the number of attempts
+        if number < 0:
             path = start_path
-            number = 0
         else:
             path = start_path + '_' + str(number)
-            number += 1
         try:
             os.mkdir(path)
             break

test/framework/filetools.py

@@ -2889,6 +2889,7 @@ def test_locate_files(self):
         self.assertErrorRegex(EasyBuildError, error_pattern, ft.locate_files, ['2.txt'], [])
 
     def test_create_unused_dir(self):
+        """Test create_unused_dir function."""
         path = ft.create_unused_dir(self.test_prefix, 'folder')
         self.assertEqual(path, os.path.join(self.test_prefix, 'folder'))
         self.assertTrue(os.path.exists(path))
@@ -2905,6 +2906,21 @@ def test_create_unused_dir(self):
             path = ft.create_unused_dir(self.test_prefix, 'folder2')
             self.assertEqual(path, os.path.join(self.test_prefix, 'folder2_%s' % i))
             self.assertTrue(os.path.exists(path))
+        # Fail cleanly if passed a readonly folder
+        readonly_dir = os.path.join(self.test_prefix, 'ro_folder')
+        os.mkdir(readonly_dir)
+        old_perms = os.lstat(readonly_dir)[stat.ST_MODE]
+        os.chmod(readonly_dir, stat.S_IREAD | stat.S_IEXEC)
+        try:
+            self.assertErrorRegex(EasyBuildError, 'Failed to create directory',
+                                  ft.create_unused_dir, readonly_dir, 'new_folder')
+        finally:
+            os.chmod(readonly_dir, old_perms)
+        # Ignore files same as folders. So first just create a file with no contents
+        open(os.path.join(self.test_prefix, 'file'), 'w').close()
+        path = ft.create_unused_dir(self.test_prefix, 'file')
+        self.assertEqual(path, os.path.join(self.test_prefix, 'file_0'))
+        self.assertTrue(os.path.exists(path))
 
 
 def suite():