Assert readable directory in NsDirUtil::iterate().

Author: donquixote

src/NsDirUtil.php

@@ -43,9 +43,28 @@ public static function terminateNamespace(string $namespace): string {
   public static function iterate(string $dir, string $terminatedNamespace): \Iterator {
     assert(!str_ends_with($dir, '/'));
     assert(str_ends_with($terminatedNamespace, '\\') || $terminatedNamespace === '');
+    self::assertReadableDirectory($dir);
     return self::doIterateRecursively($dir, $terminatedNamespace);
   }
 
+  /**
+   * Asserts that a path is a readable directory.
+   *
+   * @param string $dir
+   *   Directory path.
+   */
+  public static function assertReadableDirectory(string $dir): void {
+    if (!is_dir($dir)) {
+      if (!file_exists($dir)) {
+        throw new \RuntimeException("Directory '$dir' does not exist.");
+      }
+      throw new \RuntimeException("Path '$dir' is not a directory.");
+    }
+    if (!is_readable($dir)) {
+      throw new \RuntimeException("Directory '$dir' is not readable.");
+    }
+  }
+
   /**
    * Recursively iterates over class files.
    *

tests/src/ClassFilesIATest.php

@@ -109,7 +109,7 @@ public function testGetIterator(): void {
       __DIR__ . '/Fixtures/Acme/Plant/Tree/Fig.php' => Fig::class,
       __DIR__ . '/Fixtures/Acme/Plant/VenusFlyTrap.php' => VenusFlyTrap::class,
     ], $classFiles);
-    $this->callAndAssertException(\RuntimeException::class, ClassFilesIA_NamespaceDirectoryPsr4::create(__DIR__ . '/non/existing/subdir', 'Acme\\Zoo')->getIterator()->valid(...));
+    $this->callAndAssertException(\RuntimeException::class, ClassFilesIA_NamespaceDirectoryPsr4::create(__DIR__ . '/non/existing/subdir', 'Acme\\Zoo')->getIterator(...));
   }
 
   public function testEmpty(): void {

tests/src/NamespaceDirectoryTest.php

@@ -445,7 +445,7 @@ public function testGetIterator(): void {
       iterator_to_array($nsdir->getIterator()),
     );
     $bad_nsdir = $this->nsdir(__DIR__ . '/non/existing/subdir', 'Acme\Missing');
-    $this->callAndAssertException(\RuntimeException::class, $bad_nsdir->getIterator()->valid(...));
+    $this->callAndAssertException(\RuntimeException::class, $bad_nsdir->getIterator(...));
   }
 
   public function testGetElements(): void {

tests/src/NsDirUtilTest.php

@@ -40,7 +40,7 @@ public function testIterate(): void {
       iterator_to_array(NsDirUtil::iterate($nsdir->getDirectory(), $nsdir->getTerminatedNamespace())),
     );
 
-    $assert_exception = fn (string $path) => $this->callAndAssertException(\RuntimeException::class, NsDirUtil::iterate($path, '')->valid(...));
+    $assert_exception = fn (string $path) => $this->callAndAssertException(\RuntimeException::class, fn () => NsDirUtil::iterate($path, ''));
 
     $assert_exception(__DIR__ . '/NonExistingSubdir');
     $assert_exception(__FILE__);
@@ -62,6 +62,29 @@ public function testIterate(): void {
     $this->assertFalse(@include $file);
   }
 
+  public function testAssertReadableDirectory(): void {
+    $f = NsDirUtil::assertReadableDirectory(...);
+    $assert_exception = fn(string $path) => $this->callAndAssertException(\RuntimeException::class, fn () => $f($path));
+
+    $f(__DIR__);
+    $assert_exception(__DIR__ . '/NonExistingSubdir');
+    $assert_exception(__FILE__);
+
+    mkdir($dir = sys_get_temp_dir() . '/test-dir-' . uniqid());
+    $perms = fileperms($dir) & 0777;
+    touch($file = $dir . '/Test.php');
+    $f($dir);
+
+    // Write and "execute" permissions.
+    chmod($dir, $perms & 0333);
+    $assert_exception($dir);
+
+    // Only read permissions, no execute bit.
+    // The directory will appear as empty.
+    chmod($dir, $perms & 0444);
+    $f($dir);
+  }
+
   public function testScanKnownDir(): void {
     $f = NsDirUtil::scanKnownDir(...);
     $this->callAndAssertException(\RuntimeException::class, fn () => $f(__DIR__ . '/NonExistingDir'));