fix: update static analysis (#224)

* fix: update .gitignore for vscode directory

* feat: enhance phpstan configuration and tests

* fix: update tests and phpcs configuration

* fix: add return type hints for FakeHttpClient and tests

* fix: remove unnecessary quotes in PHPStan command

* fix: simplify label assertions in theme tests

* refactor: update property type hints in test classes

* fix: add error message for missing PHPStan config

* fix: format file

Author: Morgy93

.ddev/commands/web/phpstan

@@ -25,8 +25,9 @@ if [[ ! -f vendor/bin/phpstan ]]; then
 	echo "PHPStan installation complete."
 fi
 
-# Default target: the module source, symlinked into vendor via the Composer path repository
-TARGET_PATH="vendor/openforgeproject/mageforge/src"
+# Default target: none — analyse the paths declared in phpstan.neon.
+# An explicit path argument overrides that default.
+TARGET_PATH=""
 if [[ $# -gt 0 ]] && [[ ! $1 =~ ^- ]]; then
 	TARGET_PATH="$1"
 	shift # Remove the first argument
@@ -37,16 +38,16 @@ if [[ $# -gt 0 ]] && [[ ! $1 =~ ^- ]]; then
 	fi
 fi
 
-# Determine config file location
-if [[ -f "vendor/openforgeproject/mageforge/phpstan.neon" ]]; then
-	PHPSTAN_CONFIG="vendor/openforgeproject/mageforge/phpstan.neon"
-elif [[ -f "../phpstan.neon" ]]; then
-	PHPSTAN_CONFIG="../phpstan.neon"
-else
-	echo "PHPStan config not found at vendor/openforgeproject/mageforge/phpstan.neon or ../phpstan.neon"
+PHPSTAN_CONFIG="vendor/openforgeproject/mageforge/phpstan.neon"
+if [[ ! -f ${PHPSTAN_CONFIG} ]]; then
+	echo "PHPStan config not found at ${PHPSTAN_CONFIG}. Run 'ddev install-magento' first."
 	exit 1
 fi
 
 # Run PHPStan with the same configuration as CI pipeline
 echo "Running PHPStan analysis..."
-vendor/bin/phpstan analyse -c "${PHPSTAN_CONFIG}" "$@" "${TARGET_PATH}"
+if [[ -n ${TARGET_PATH} ]]; then
+	vendor/bin/phpstan analyse -c "${PHPSTAN_CONFIG}" "$@" "${TARGET_PATH}"
+else
+	vendor/bin/phpstan analyse -c "${PHPSTAN_CONFIG}" "$@"
+fi

.github/workflows/static-analysis.yml

@@ -164,7 +164,7 @@ jobs:
       - name: Run PHPStan
         working-directory: magento2
         run: |
-          vendor/bin/phpstan analyse -c vendor/openforgeproject/mageforge/phpstan.neon vendor/openforgeproject/mageforge/src
+          vendor/bin/phpstan analyse -c vendor/openforgeproject/mageforge/phpstan.neon
 
   mago-analyze:
     name: Mago Analyze

.gitignore

@@ -9,7 +9,7 @@
 /.phpunit.cache/
 /reports/
 
-.vscode
+/.vscode/
 /magento/
 /magento-temp/
 

.vscode/settings.json

@@ -3,6 +3,7 @@
     <description>Magento2 coding standard with Mago-formatter compatibility.</description>
 
     <file>src/</file>
+    <file>tests/</file>
 
     <arg name="extensions" value="php,phtml"/>
 

phpcs.xml.dist

@@ -5,3 +5,4 @@ parameters:
     level: 9
     paths:
         - src
+        - tests

phpstan.neon

@@ -15,10 +15,25 @@
 
 class InspectorTest extends TestCase
 {
-    private Context&MockObject $context;
-    private State&MockObject $state;
-    private ScopeConfigInterface&MockObject $scopeConfig;
-    private DeveloperAccessChecker&MockObject $developerAccessChecker;
+    /**
+     * @var Context&MockObject
+     */
+    private $context;
+    /**
+     * @var State&MockObject
+     */
+    private $state;
+    /**
+     * @var ScopeConfigInterface&MockObject
+     */
+    private $scopeConfig;
+    /**
+     * @var DeveloperAccessChecker&MockObject
+     */
+    private $developerAccessChecker;
+    /**
+     * @var Inspector
+     */
     private Inspector $block;
 
     protected function setUp(): void

tests/Unit/Block/InspectorTest.php

@@ -17,6 +17,9 @@
 
 class AbstractCommandTest extends TestCase
 {
+    /**
+     * @var ConcreteTestCommand
+     */
     private ConcreteTestCommand $command;
 
     protected function setUp(): void
@@ -280,6 +283,7 @@ public function testSetPromptEnvironmentAppliesSanitizedTerminalDefaults(): void
         // setPromptEnvironment() itself triggers to capture the "original" values), so a
         // second getEnvVar() call would not reliably reflect writes made afterwards.
         $storage = $this->readPrivateProperty('secureEnvStorage');
+        $this->assertIsArray($storage);
         $this->assertSame('100', $storage['COLUMNS']);
         $this->assertSame('40', $storage['LINES']);
         $this->assertSame('xterm-256color', $storage['TERM']);
@@ -305,7 +309,9 @@ public function testResetPromptEnvironmentRemovesPreviouslyUnsetValues(): void
 
         $this->command->callResetPromptEnvironment();
 
-        $this->assertArrayNotHasKey('COLUMNS', $this->readPrivateProperty('secureEnvStorage'));
+        $storage = $this->readPrivateProperty('secureEnvStorage');
+        $this->assertIsArray($storage);
+        $this->assertArrayNotHasKey('COLUMNS', $storage);
         $this->assertNull($this->readPrivateProperty('cachedEnv'));
     }
 
@@ -316,7 +322,9 @@ public function testResetPromptEnvironmentRestoresPreviouslySetValue(): void
 
         $this->command->callResetPromptEnvironment();
 
-        $this->assertSame('75', $this->readPrivateProperty('secureEnvStorage')['COLUMNS']);
+        $storage = $this->readPrivateProperty('secureEnvStorage');
+        $this->assertIsArray($storage);
+        $this->assertSame('75', $storage['COLUMNS']);
     }
 
     public function testGetSecureEnvironmentValueShortCircuitsForNamesFailingTheAnchoredPattern(): void
@@ -365,7 +373,9 @@ public function testSetEnvVarStoresSanitizedValue(): void
     {
         $this->callPrivate('setEnvVar', ['TERM', 'xterm!256@color']);
 
-        $this->assertSame('xterm256color', $this->readPrivateProperty('secureEnvStorage')['TERM']);
+        $storage = $this->readPrivateProperty('secureEnvStorage');
+        $this->assertIsArray($storage);
+        $this->assertSame('xterm256color', $storage['TERM']);
     }
 
     public function testGetEnvVarReturnsSanitizedStoredValue(): void

tests/Unit/Console/Command/AbstractCommandTest.php

@@ -17,15 +17,33 @@
  */
 class ConcreteTestCommand extends AbstractCommand
 {
+    /**
+     * @var int
+     */
     private int $executeCommandReturn = Cli::RETURN_SUCCESS;
+    /**
+     * @var ?\Throwable
+     */
     private ?\Throwable $throwOnExecute = null;
+    /**
+     * @var ?bool
+     */
     private ?bool $realTtyAvailableOverride = null;
 
+    /**
+     * Configures the command name.
+     */
     protected function configure(): void
     {
         $this->setName('test:concrete-command');
     }
 
+    /**
+     * Returns the preconfigured exit code, or throws the preconfigured exception.
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     */
     protected function executeCommand(InputInterface $input, OutputInterface $output): int
     {
         if ($this->throwOnExecute !== null) {
@@ -35,60 +53,114 @@ protected function executeCommand(InputInterface $input, OutputInterface $output
         return $this->executeCommandReturn;
     }
 
+    /**
+     * Returns the overridden TTY availability, falling back to the parent implementation.
+     */
     protected function isRealTtyAvailable(): bool
     {
         return $this->realTtyAvailableOverride ?? parent::isRealTtyAvailable();
     }
 
+    /**
+     * Overrides the TTY availability reported to the command.
+     *
+     * @param ?bool $available
+     */
     public function setRealTtyAvailable(?bool $available): void
     {
         $this->realTtyAvailableOverride = $available;
     }
 
+    /**
+     * Sets the exit code returned by executeCommand().
+     *
+     * @param int $code
+     */
     public function setExecuteCommandReturn(int $code): void
     {
         $this->executeCommandReturn = $code;
     }
 
+    /**
+     * Makes executeCommand() throw the given exception.
+     *
+     * @param \Throwable $exception
+     */
     public function setThrowOnExecute(\Throwable $exception): void
     {
         $this->throwOnExecute = $exception;
     }
 
+    /**
+     * Injects the SymfonyStyle IO used by the command.
+     *
+     * @param SymfonyStyle $io
+     */
     public function setIoForTest(SymfonyStyle $io): void
     {
         $this->io = $io;
     }
 
+    /**
+     * Exposes the protected getCommandName().
+     *
+     * @param string $group
+     * @param string $command
+     */
     public function callGetCommandName(string $group, string $command): string
     {
         return $this->getCommandName($group, $command);
     }
 
+    /**
+     * Exposes the protected isVerbose().
+     *
+     * @param OutputInterface $output
+     */
     public function callIsVerbose(OutputInterface $output): bool
     {
         return $this->isVerbose($output);
     }
 
+    /**
+     * Exposes the protected isVeryVerbose().
+     *
+     * @param OutputInterface $output
+     */
     public function callIsVeryVerbose(OutputInterface $output): bool
     {
         return $this->isVeryVerbose($output);
     }
 
+    /**
+     * Exposes the protected isDebug().
+     *
+     * @param OutputInterface $output
+     */
     public function callIsDebug(OutputInterface $output): bool
     {
         return $this->isDebug($output);
     }
 
     /**
+     * Exposes the protected resolveVendorThemes().
+     *
      * @param array<string> $themeCodes
+     * @param ThemeList $themeList
      * @return array<string>
      */
     public function callResolveVendorThemes(array $themeCodes, ThemeList $themeList): array
     {
         return $this->resolveVendorThemes($themeCodes, $themeList);
     }
 
+    /**
+     * Exposes the protected handleInvalidThemeWithSuggestions().
+     *
+     * @param string $invalidTheme
+     * @param ThemeSuggester $themeSuggester
+     * @param OutputInterface $output
+     */
     public function callHandleInvalidThemeWithSuggestions(
         string $invalidTheme,
         ThemeSuggester $themeSuggester,
@@ -97,16 +169,27 @@ public function callHandleInvalidThemeWithSuggestions(
         return $this->handleInvalidThemeWithSuggestions($invalidTheme, $themeSuggester, $output);
     }
 
+    /**
+     * Exposes the protected isInteractiveTerminal().
+     *
+     * @param OutputInterface $output
+     */
     public function callIsInteractiveTerminal(OutputInterface $output): bool
     {
         return $this->isInteractiveTerminal($output);
     }
 
+    /**
+     * Exposes the protected setPromptEnvironment().
+     */
     public function callSetPromptEnvironment(): void
     {
         $this->setPromptEnvironment();
     }
 
+    /**
+     * Exposes the protected resetPromptEnvironment().
+     */
     public function callResetPromptEnvironment(): void
     {
         $this->resetPromptEnvironment();

tests/Unit/Console/Command/ConcreteTestCommand.php

@@ -17,10 +17,25 @@
 
 class InspectorCommandTest extends TestCase
 {
-    private WriterInterface&MockObject $configWriter;
-    private State&MockObject $state;
-    private CacheManager&MockObject $cacheManager;
-    private ScopeConfigInterface&MockObject $scopeConfig;
+    /**
+     * @var WriterInterface&MockObject
+     */
+    private $configWriter;
+    /**
+     * @var State&MockObject
+     */
+    private $state;
+    /**
+     * @var CacheManager&MockObject
+     */
+    private $cacheManager;
+    /**
+     * @var ScopeConfigInterface&MockObject
+     */
+    private $scopeConfig;
+    /**
+     * @var InspectorCommand
+     */
     private InspectorCommand $command;
 
     protected function setUp(): void
@@ -161,7 +176,8 @@ public function testEnableAnnouncesUsageAndCleansExactCacheTypes(): void
 
         $display = (string) preg_replace('/\s+/', ' ', $tester->getDisplay());
         $this->assertStringContainsString('MageForge Inspector has been enabled!', $display);
-        $this->assertStringContainsString('The inspector will now be active on the frontend for allowed IPs.', $display);
+        $activeHint = 'The inspector will now be active on the frontend for allowed IPs.';
+        $this->assertStringContainsString($activeHint, $display);
         $this->assertStringContainsString('Press Ctrl+Shift+I (or Cmd+Option+I on macOS)', $display);
         $this->assertStringContainsString('Hover over elements to see their template information', $display);
         $this->assertStringContainsString('Click to pin the inspector panel', $display);