wip

Author: micheleorselli

tests/E2E/Cli/CheckCommandTest.php

@@ -252,16 +252,27 @@ public function test_gitlab_format_output_no_errors(): void
         self::assertJsonStringEqualsJsonString($expectedJson, $cmdTester->getDisplay());
     }
 
+    public function test_autoload_file(): void
+    {
+        $configFilePath = __DIR__.'/../_fixtures/autoload/phparkitect.php';
+
+        $cmdTester = $this->runCheck($configFilePath, null, null, false, false, false, 'text', __DIR__.'/../_fixtures/autoload/autoload.php');
+
+        self::assertCommandWasSuccessful($cmdTester);
+    }
+
     protected function runCheck(
         $configFilePath = null,
         ?bool $stopOnFailure = null,
         ?string $useBaseline = null,
         $generateBaseline = false,
         bool $skipBaseline = false,
         bool $ignoreBaselineNumbers = false,
-        string $format = 'text'
+        string $format = 'text',
+        ?string $autoloadFilePath = null
     ): ApplicationTester {
         $input = ['check'];
+
         if (null !== $configFilePath) {
             $input['--config'] = $configFilePath;
         }
@@ -286,6 +297,10 @@ protected function runCheck(
 
         $input['--format'] = $format;
 
+        if ($autoloadFilePath) {
+            $input['--autoload'] = $autoloadFilePath;
+        }
+
         $app = new PhpArkitectApplication();
         $app->setAutoExit(false);
 

tests/E2E/_fixtures/autoload/autoload.php

@@ -0,0 +1,22 @@
+<?php
+declare(strict_types=1);
+
+spl_autoload_register(function ($class) {
+    $classmap = [
+        'Autoload\Services\UserService' => __DIR__.'/src/Service/UserService.php',
+        'Autoload\Model\User' => __DIR__.'/src/Model/User.php',
+        'Autoload\Model\UserInterface' => __DIR__.'/src/Model/UserInterface.php',
+    ];
+
+    $path = $classmap[$class] ?? null;
+
+    if (null === $path) {
+        return;
+    }
+
+    if (!file_exists($path)) {
+        return;
+    }
+
+    return require $path;
+});

tests/E2E/_fixtures/autoload/phparkitect.php

@@ -0,0 +1,56 @@
+<?php
+declare(strict_types=1);
+
+use Arkitect\Analyzer\ClassDescription;
+use Arkitect\ClassSet;
+use Arkitect\CLI\Config;
+use Arkitect\Expression\Description;
+use Arkitect\Expression\Expression;
+use Arkitect\Expression\ForClasses\ResideInOneOfTheseNamespaces;
+use Arkitect\Rules\Rule;
+use Arkitect\Rules\Violation;
+use Arkitect\Rules\ViolationMessage;
+use Arkitect\Rules\Violations;
+
+return static function (Config $config): void {
+    // a dummy rule to check if the class is autoloaded
+    $autoload_rule = new class('Autoload\Model\UserInterface') implements Expression {
+        public string $implements;
+
+        public function __construct(string $implements)
+        {
+            $this->implements = $implements;
+        }
+
+        public function describe(ClassDescription $theClass, string $because): Description
+        {
+            return new Description("{$theClass->getFQCN()} should implement {$this->implements}", $because);
+        }
+
+        public function evaluate(ClassDescription $theClass, Violations $violations, string $because): void
+        {
+            if (is_a($theClass->getFQCN(), $this->implements, true)) {
+                return;
+            }
+
+            $violation = Violation::create(
+                $theClass->getFQCN(),
+                ViolationMessage::selfExplanatory($this->describe($theClass, $because)),
+                $theClass->getFilePath()
+            );
+
+            $violations->add($violation);
+        }
+    };
+
+    $mvc_class_set = ClassSet::fromDir(__DIR__.'/src');
+
+    $rule = Rule::allClasses()
+        ->except('Autoload\Model\UserInterface')
+        ->that(new ResideInOneOfTheseNamespaces('Autoload\Model'))
+        ->should($autoload_rule)
+        ->because('we want check if the class is autoloaded');
+
+    $config
+        ->add($mvc_class_set, $rule);
+};

tests/E2E/_fixtures/autoload/src/Model/User.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Autoload\Model;
+
+class User implements UserInterface
+{
+}

tests/E2E/_fixtures/autoload/src/Model/UserInterface.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Autoload\Model;
+
+interface UserInterface
+{
+}

tests/E2E/_fixtures/autoload/src/Service/UserService.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Autoload\Services;
+
+class UserService
+{
+}

tests/Unit/CLI/Printer/GitlabPrinterTest.php

@@ -27,8 +27,33 @@ public function test_print_with_violations(): void
 
         $result = $printer->print($violationsCollection);
 
-        self::assertSame(<<<JSON
-        [{"description":"Some error message","check_name":"RuleA.some-error-message","fingerprint":"7ddcfd42f5f2af3d00864ef959a0327f508cb5227aedca96d919d681a5dcde4a","severity":"major","location":{"path":"tests\/Unit\/CLI\/Printer\/GitlabPrinterTest.php","lines":{"begin":42}}},{"description":"Another error message","check_name":"RuleB.another-error-message","fingerprint":"800c2ceafbf4023e401200186ecabdfe59891c5d6670e86571e3c50339df07dc","severity":"major","location":{"path":"tests\/Unit\/CLI\/Printer\/GitlabPrinterTest.php","lines":{"begin":1}}}]
+        self::assertJsonStringEqualsJsonString(<<<JSON
+        [
+            {
+                "description": "Some error message",
+                "check_name": "RuleA.some-error-message",
+                "fingerprint": "7ddcfd42f5f2af3d00864ef959a0327f508cb5227aedca96d919d681a5dcde4a",
+                "severity": "major",
+                "location": {
+                    "path": "tests\/Unit\/CLI\/Printer\/GitlabPrinterTest.php",
+                    "lines": {
+                        "begin": 42
+                    }
+                }
+            },
+            {
+                "description": "Another error message",
+                "check_name": "RuleB.another-error-message",
+                "fingerprint": "800c2ceafbf4023e401200186ecabdfe59891c5d6670e86571e3c50339df07dc",
+                "severity": "major",
+                "location": {
+                    "path": "tests\/Unit\/CLI\/Printer\/GitlabPrinterTest.php",
+                    "lines": {
+                        "begin": 1
+                    }
+                }
+            }
+        ]
         JSON, $result);
     }