Add functional tests (#6)

Author: frankdekker

.github/workflows/test.yml

@@ -17,9 +17,6 @@ jobs:
       matrix:
         php-versions: [ '8.1', '8.2', '8.3' ]
         composer-flags: [ '', '--prefer-lowest' ]
-        exclude:
-          - php-versions: 8.3
-            composer-flags: ''
     steps:
       - uses: actions/checkout@v4
 
@@ -33,7 +30,7 @@ jobs:
         run: composer validate
 
       - name: Install dependencies
-        run: composer update --prefer-dist --no-progress --no-suggest --prefer-stable ${{ matrix.composer-flags }}
+        run: composer update --prefer-dist --no-progress --prefer-stable ${{ matrix.composer-flags }}
 
       - name: Run test suite
         run: composer test
@@ -51,7 +48,7 @@ jobs:
           coverage: pcov
 
       - name: Install dependencies
-        run: composer update --prefer-dist --no-progress --no-suggest --prefer-stable
+        run: composer update --prefer-dist --no-progress --prefer-stable
 
       - name: Run test suite
         run: php -dpcov.enabled=1 -dpcov.exclude="~vendor~" vendor/bin/phpunit --testsuite unit,integration --coverage-clover ./.coverage/coverage.xml

.gitignore

@@ -1,7 +1,8 @@
 /.idea
-/vendor
-/composer.lock
-/phpunit.xml
 /.phpunit.result.cache
+/composer.lock
 /dev/public/bundles
 /dev/var
+/phpunit.xml
+/tests/.kernel
+/vendor

composer.json

@@ -28,12 +28,12 @@
     "require": {
         "php": ">=8.1",
         "ext-json": "*",
-        "symfony/asset": "^6.0||^7.0",
+        "psr/clock": "^1.0",
         "symfony/config": "^6.0||^7.0",
         "symfony/dependency-injection": "^6.0||^7.0",
+        "symfony/filesystem": "^6.0||^7.0",
         "symfony/finder": "^6.0||^7.0",
         "symfony/framework-bundle": "^6.0||^7.0",
-        "symfony/filesystem": "^6.0||^7.0",
         "symfony/http-foundation": "^6.0||^7.0",
         "symfony/http-kernel": "^6.0||^7.0",
         "symfony/routing": "^6.0||^7.0",
@@ -58,7 +58,7 @@
         "symfony/css-selector": "^6.0||^7.0",
         "symfony/monolog-bridge": "^6.0||^7.0",
         "symfony/monolog-bundle": "^3.10",
-        "symfony/phpunit-bridge": "^6.0||^7.0",
+        "symfony/phpunit-bridge": "^6.4||^7.0",
         "symfony/runtime": "^6.0||^7.0",
         "symfony/templating": "^6.0||^7.0",
         "symfony/twig-bundle": "^6.0||^7.0",

dev/config/config.yml

@@ -24,6 +24,7 @@ web_profiler:
   intercept_redirects: false
 
 twig:
+  debug: false
   strict_variables: true
 
 monolog:

docs/configuration.md

@@ -21,6 +21,7 @@ fd_log_viewer:
       start_of_line_pattern: '/^\[\d{4}-\d{2}-\d{2}[^]]*]\s+\S+\.\S+:/'
       log_message_pattern: '/^\[(?P<date>[^\]]+)\]\s+(?P<channel>[^\.]+)\.(?P<severity>[^:]+):\s+(?P<message>.*)\s+(?P<context>[[{].*?[\]}])\s+(?P<extra>[[{].*?[\]}])\s+$/s'
       date_format: "Y-m-d H:i:s"
+  enable_default_monolog: true
 ```
 
 ## Configuration reference
@@ -112,3 +113,8 @@ If you use a custom monolog format, adjust this pattern to your needs.
 ### log_files.date_format <small>`string`</small>
 
 This is the date format that will be used to format the date in frontend. Default: `Y-m-d H:i:s`
+
+
+### enable_default_monolog <small>`boolean`</small>
+
+Should the default monolog configuration be enabled? Default: `true`

phpunit.xml.dist

@@ -11,7 +11,13 @@
          beStrictAboutTodoAnnotatedTests="true"
          executionOrder="defects"
 >
+    <php>
+        <env name="KERNEL_CLASS" value="FD\LogViewer\Tests\Utility\TestKernel"/>
+    </php>
     <testsuites>
+        <testsuite name="functional">
+            <directory>tests/Functional</directory>
+        </testsuite>
         <testsuite name="integration">
             <directory>tests/Integration</directory>
         </testsuite>

src/Controller/IndexController.php

@@ -6,13 +6,15 @@
 use FD\LogViewer\Entity\Output\DirectionEnum;
 use FD\LogViewer\Routing\RouteService;
 use FD\LogViewer\Service\Folder\LogFolderOutputProvider;
+use FD\LogViewer\Service\JsonManifestAssetLoader;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
 use Throwable;
 
 class IndexController extends AbstractController
 {
     public function __construct(
+        private readonly JsonManifestAssetLoader $assetLoader,
         private readonly RouteService $routeService,
         private readonly LogFolderOutputProvider $folderOutputProvider
     ) {
@@ -29,6 +31,16 @@ public function __invoke(): Response
         // retrieve all log files and folders
         $folders = $this->folderOutputProvider->provide(DirectionEnum::Desc);
 
-        return $this->render('@FdLogViewer/index.html.twig', ['base_uri' => $baseUri, 'folders' => $folders]);
+        return $this->render(
+            '@FdLogViewer/index.html.twig',
+            [
+                'base_uri' => $baseUri,
+                'folders'  => $folders,
+                'assets'   => [
+                    'style' => $this->assetLoader->getUrl('style.css'),
+                    'js'    => $this->assetLoader->getUrl('src/main.ts')
+                ],
+            ]
+        );
     }
 }

src/DependencyInjection/Configuration.php

@@ -21,6 +21,10 @@ public function getConfigTreeBuilder(): TreeBuilder
         $rootNode = $tree->getRootNode();
 
         $rootNode->children()
+            ->scalarNode('enable_default_monolog')
+                ->info('Enable default monolog configuration')
+                ->defaultTrue()
+            ->end()
             ->arrayNode('log_files')
                 ->info('List of log files to show')
                 ->useAttributeAsKey('log_name')
@@ -62,6 +66,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->end()
             ->end();
 
+
         return $tree;
     }
 }

src/DependencyInjection/Extension.php

@@ -5,11 +5,9 @@
 
 use FD\LogViewer\Entity\Config\FinderConfig;
 use FD\LogViewer\Entity\Config\LogFilesConfig;
-use FD\LogViewer\Service\JsonManifestVersionStrategy;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension as BaseExtension;
-use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
 use Throwable;
@@ -18,7 +16,7 @@
  * @codeCoverageIgnore
  * @internal
  */
-final class Extension extends BaseExtension implements PrependExtensionInterface
+final class Extension extends BaseExtension
 {
     /**
      * @inheritDoc
@@ -32,19 +30,8 @@ public function load(array $configs, ContainerBuilder $container): void
         $mergedConfigs = $this->processConfiguration(new Configuration(), $configs);
 
         // add defaults
-        if (count($mergedConfigs['log_files']) === 0) {
-            $mergedConfigs['log_files']['monolog'] = [
-                'type'         => 'monolog',
-                'name'         => 'Monolog',
-                'finder'       => [
-                    'in'                   => '%kernel.logs_dir%',
-                    'name'                 => '*.log',
-                    'ignoreUnreadableDirs' => true,
-                    'followLinks'          => false
-                ],
-                'downloadable' => false,
-                'deletable'    => false,
-            ];
+        if ($mergedConfigs['enable_default_monolog']) {
+            $mergedConfigs = self::addMonologDefault($mergedConfigs);
         }
 
         foreach ($mergedConfigs['log_files'] as $key => $config) {
@@ -76,22 +63,25 @@ public function getAlias(): string
     }
 
     /**
-     * @inheritdoc
+     * @template T of array
+     * @phpstan-param T $configs
+     *
+     * @phpstan-return T
      */
-    public function prepend(ContainerBuilder $container): void
+    private static function addMonologDefault(array $configs): array
     {
-        $container->prependExtensionConfig(
-            'framework',
-            [
-                'assets' => [
-                    'enabled'  => true,
-                    'packages' => [
-                        'fd_symfony_log_viewer' => [
-                            'version_strategy' => JsonManifestVersionStrategy::class
-                        ],
-                    ],
-                ],
-            ]
-        );
+        // monolog
+        $configs['log_files']['monolog']['type']         ??= 'monolog';
+        $configs['log_files']['monolog']['name']         ??= 'Monolog';
+        $configs['log_files']['monolog']['downloadable'] ??= false;
+        $configs['log_files']['monolog']['deletable']    ??= false;
+
+        // finder
+        $configs['log_files']['monolog']['finder']['in']                   ??= '%kernel.logs_dir%';
+        $configs['log_files']['monolog']['finder']['name']                 ??= '*.log';
+        $configs['log_files']['monolog']['finder']['ignoreUnreadableDirs'] ??= true;
+        $configs['log_files']['monolog']['finder']['followLinks']          ??= false;
+
+        return $configs;
     }
 }

src/Entity/TempFile.php

@@ -6,6 +6,7 @@
 use RuntimeException;
 use SplFileInfo;
 
+use function register_shutdown_function;
 use function sys_get_temp_dir;
 use function tempnam;
 use function unlink;
@@ -21,9 +22,12 @@ public function __construct()
             // @codeCoverageIgnoreEnd
         }
         parent::__construct($path);
+
+        // cleanup temp file when script ends (and not when object lifecycle ends)
+        register_shutdown_function(fn() => $this->destruct());
     }
 
-    public function __destruct()
+    public function destruct(): void
     {
         if ($this->isFile()) {
             @unlink($this->getPathname());