Test the warnings for container not initialized

Author: mglaman

src/Drupal/Bootstrap.php

@@ -230,9 +230,11 @@ protected function loadAndCatchErrors(string $path): void
         try {
             require $path;
         } catch (ContainerNotInitializedException $e) {
+            $path = str_replace(dirname($this->drupalRoot) . '/', '', $path);
             // This can happen when drupal_get_path or drupal_get_filename are used outside of the scope of a function.
-            @trigger_error("$path invoked the Drupal container outside of the scope of a function or class method. It was skipped for analysis.", E_USER_WARNING);
+            @trigger_error("$path invoked the Drupal container outside of the scope of a function or class method. It was not loaded.", E_USER_WARNING);
         } catch (\Throwable $e) {
+            $path = str_replace(dirname($this->drupalRoot) . '/', '', $path);
             // Something prevented the extension file from loading.
             @trigger_error("$path failed loading due to {$e->getMessage()}", E_USER_WARNING);
         }

tests/src/BootstrapTest.php

@@ -0,0 +1,73 @@
+<?php declare(strict_types=1);
+
+namespace PHPStan\Drupal;
+
+use Drupal\Core\DependencyInjection\ContainerNotInitializedException;
+use PHPStan\DependencyInjection\ContainerFactory;
+use PHPStan\File\FileHelper;
+use PHPUnit\Framework\TestCase;
+
+final class BootstrapTest extends TestCase
+{
+    private $previousErrorHandler;
+    private $gatheredWarnings = [];
+
+    public function testContainerNotInitializedExceptionCatch() {
+        $this->previousErrorHandler = set_error_handler([$this, 'handleError']);
+        $this->doDrupalBootstrap();
+        restore_error_handler();
+
+        $this->assertNotEmpty($this->gatheredWarnings);
+        $expectedWarnings = [
+            'drupal/modules/contained_not_initialized/contained_not_initialized.install invoked the Drupal container outside of the scope of a function or class method. It was not loaded.',
+            'drupal/modules/contained_not_initialized/contained_not_initialized.post_update.php invoked the Drupal container outside of the scope of a function or class method. It was not loaded.',
+            'drupal/modules/contained_not_initialized/contained_not_initialized.views.inc invoked the Drupal container outside of the scope of a function or class method. It was not loaded.',
+            'drupal/modules/contained_not_initialized/contained_not_initialized.views_execution.inc invoked the Drupal container outside of the scope of a function or class method. It was not loaded.',
+            'drupal/modules/contained_not_initialized/contained_not_initialized.tokens.inc invoked the Drupal container outside of the scope of a function or class method. It was not loaded.',
+            'drupal/modules/contained_not_initialized/contained_not_initialized.search_api.inc invoked the Drupal container outside of the scope of a function or class method. It was not loaded.',
+            'drupal/modules/contained_not_initialized/contained_not_initialized.pathauto.inc invoked the Drupal container outside of the scope of a function or class method. It was not loaded.',
+        ];
+        $this->assertEquals($expectedWarnings, $this->gatheredWarnings);
+    }
+
+    public function handleError($type, $msg, $file, $line, $context = array()): void
+    {
+        if (E_USER_WARNING !== $type) {
+            $h = $this->previousErrorHandler;
+            if (\is_callable($h)) {
+                $h($type, $msg, $file, $line, $context);
+            }
+        } else {
+            $this->gatheredWarnings[] = $msg;
+        }
+    }
+
+    private function doDrupalBootstrap()
+    {
+        $rootDir = __DIR__ . '/../fixtures/drupal';
+        $tmpDir = sys_get_temp_dir() . '/' . time() . 'phpstan';
+        $containerFactory = new ContainerFactory($rootDir);
+        $container = $containerFactory->create(
+            $tmpDir,
+            [__DIR__ . '/../fixtures/config/phpunit-drupal-phpstan.neon'],
+            []
+        );
+        $fileHelper = $container->getByType(FileHelper::class);
+        assert($fileHelper !== null);
+
+        $bootstrapFile = $container->parameters['bootstrap'];
+        $this->assertEquals(dirname(__DIR__, 2) . '/phpstan-bootstrap.php', $bootstrapFile);
+        // Mock the autoloader.
+        $GLOBALS['drupalVendorDir'] = dirname(__DIR__, 2) . '/vendor';
+        if ($bootstrapFile !== null) {
+            $bootstrapFile = $fileHelper->normalizePath($bootstrapFile);
+            if (!is_file($bootstrapFile)) {
+                $this->fail('Bootstrap file not found');
+            }
+            (static function (string $file): void {
+                require_once $file;
+            })($bootstrapFile);
+        }
+    }
+
+}