introduce phpstan

Author: akondas

composer.json

@@ -27,7 +27,9 @@
         "symfony/browser-kit": "^6.4",
         "symfony/framework-bundle": "^6.4",
         "symfony/http-kernel": "^6.4",
-        "symfony/stopwatch": "^6.4"
+        "symfony/stopwatch": "^6.4",
+        "phpstan/phpstan": "^1.11",
+        "phpstan/phpstan-symfony": "^1.4"
     },
     "autoload": {
         "psr-4": {
@@ -43,6 +45,7 @@
         "ci": [
             "composer validate",
             "@check-cs",
+            "@phpstan",
             "@phpunit"
         ],
         "check-cs": [
@@ -53,6 +56,9 @@
         ],
         "phpunit": [
             "phpunit"
+        ],
+        "phpstan": [
+            "phpstan analyse -c phpstan.neon"
         ]
     },
     "config": {

composer.lock

@@ -0,0 +1,13 @@
+includes:
+	- vendor/phpstan/phpstan/conf/bleedingEdge.neon
+	- vendor/phpstan/phpstan-symfony/extension.neon
+	- vendor/phpstan/phpstan-symfony/rules.neon
+
+parameters:
+	phpVersion: 80100
+	level: max
+	paths:
+		- src
+		- tests
+	symfony:
+		containerXmlPath: var/cache/test/Chaos_Monkey_Symfony_Tests_Symfony_KernelTestDebugContainer.xml

phpstan.neon

@@ -9,20 +9,42 @@
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
+/**
+ * @phpstan-type ConfigArray array{
+ *     enabled: bool,
+ *     probability: int,
+ *     assaults: array{
+ *      latency: array{active: bool, minimum: int, maximum: int},
+ *      memory: array{active: bool, fill_fraction: float},
+ *      exception: array{active: bool, class: class-string<\Throwable>},
+ *      kill_app: array{active: bool}
+ *     },
+ *     watchers: array{
+ *      request: array{enabled: bool, priority: int}
+ *     }
+ * }
+ */
 class ChaosMonkeyExtension extends Extension
 {
-    public function load(array $configs, ContainerBuilder $container)
+    /**
+     * @param array<array<mixed>> $configs
+     */
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');
 
         $configuration = new Configuration();
+        /** @var ConfigArray $config */
         $config = $this->processConfiguration($configuration, $configs);
 
         $this->setChaosMonkeySettings($container, $config);
         $this->enableWatchers($container, $config);
     }
 
+    /**
+     * @param ConfigArray $config
+     */
     private function setChaosMonkeySettings(ContainerBuilder $container, array $config): void
     {
         $definition = $container->getDefinition('chaos_monkey.settings');
@@ -42,6 +64,9 @@ private function setChaosMonkeySettings(ContainerBuilder $container, array $conf
         $definition->addMethodCall('setKillAppActive', [$config['assaults']['kill_app']['active']]);
     }
 
+    /**
+     * @param ConfigArray $config
+     */
     private function enableWatchers(ContainerBuilder $container, array $config): void
     {
         if ($config['watchers']['request']['enabled'] === true) {

src/DependencyInjection/ChaosMonkeyExtension.php

@@ -5,16 +5,9 @@
 namespace Chaos\Monkey\Symfony\Tests\Controller;
 
 use Chaos\Monkey\Settings;
-use Chaos\Monkey\Symfony\ChaosMonkeyBundle;
+use Chaos\Monkey\Symfony\Tests\Symfony\Kernel;
 use PHPUnit\Framework\TestCase;
-use Psr\Log\NullLogger;
-use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
-use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
 use Symfony\Bundle\FrameworkBundle\KernelBrowser;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Kernel;
-use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
 use Symfony\Component\Stopwatch\Stopwatch;
 
 class SymfonyControllerTest extends TestCase
@@ -23,7 +16,7 @@ class SymfonyControllerTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->client = new KernelBrowser($kernel = new SymfonyControllerKernel('test', false));
+        $this->client = new KernelBrowser($kernel = new Kernel('test', true));
         $this->client->disableReboot();
         $kernel->boot();
     }
@@ -92,35 +85,3 @@ private function chaosMonkeySettings(): Settings
         return $this->client->getContainer()->get('chaos_monkey')->settings();
     }
 }
-
-class SymfonyControllerKernel extends Kernel
-{
-    use MicroKernelTrait;
-
-    public function registerBundles(): iterable
-    {
-        return [
-            new FrameworkBundle(),
-            new ChaosMonkeyBundle(),
-        ];
-    }
-
-    protected function configureContainer(ContainerConfigurator $c): void
-    {
-        $c->extension('framework', [
-            'secret' => 'S0ME_SECRET',
-        ]);
-
-        $c->services()->set('logger', NullLogger::class);
-    }
-
-    protected function configureRoutes(RoutingConfigurator $routes)
-    {
-        $routes->add('home', '/hello')->controller([$this, 'hello']);
-    }
-
-    public function hello(): Response
-    {
-        return new Response('Hello world');
-    }
-}

tests/Controller/SymfonyControllerTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Chaos\Monkey\Symfony\Tests\Symfony;
+
+use Chaos\Monkey\Symfony\ChaosMonkeyBundle;
+use Psr\Log\NullLogger;
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Kernel as SymfonyKernel;
+use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
+
+final class Kernel extends SymfonyKernel
+{
+    use MicroKernelTrait;
+
+    public function registerBundles(): iterable
+    {
+        return [
+            new FrameworkBundle(),
+            new ChaosMonkeyBundle(),
+        ];
+    }
+
+    protected function configureContainer(ContainerConfigurator $container): void
+    {
+        $container->extension('framework', [
+            'secret' => 'S0ME_SECRET',
+        ]);
+
+        $container->services()->set('logger', NullLogger::class);
+    }
+
+    protected function configureRoutes(RoutingConfigurator $routes): void
+    {
+        $routes->add('home', '/hello')->controller([$this, 'hello']);
+    }
+
+    public function hello(): Response
+    {
+        return new Response('Hello world');
+    }
+}