#103127 Refactoring, add tests & fix bugs

mtyrtov · mtyrtov · commit 771d3310e83a · 2023-03-09T16:38:50.000+03:00
diff --git a/src/Generators/PoliciesGenerator.php b/src/Generators/PoliciesGenerator.php
@@ -3,7 +3,9 @@
 namespace Ensi\LaravelOpenApiServerGenerator\Generators;
 
 use cebe\openapi\SpecObjectInterface;
+use Ensi\LaravelOpenApiServerGenerator\DTO\ParsedRouteHandler;
 use RuntimeException;
+use stdClass;
 
 class PoliciesGenerator extends BaseGenerator implements GeneratorInterface
 {
@@ -13,7 +15,6 @@ public function generate(SpecObjectInterface $specObject): void
         $this->createPoliciesFiles($policies, $this->templatesManager->getTemplate('Policy.template'));
     }
 
-    // TODO: предварительная версия, необходим рефакторинг и доп. проверки
     protected function extractPolicies(SpecObjectInterface $specObject): array
     {
         $openApiData = $specObject->getSerializableData();
@@ -22,36 +23,31 @@ protected function extractPolicies(SpecObjectInterface $specObject): array
         $paths = $openApiData->paths ?: [];
         foreach ($paths as $routes) {
             foreach ($routes as $route) {
-                if (!empty($route->{'x-lg-skip-policy-generation'})) {
+                if (!$this->routeValidation($route)) {
                     continue;
                 }
 
-                if (empty($route->{'x-lg-handler'})) {
-                    continue;
-                }
-
-                $response = $route->responses->{403} ?? null;
-                if (!$response) {
+                $handler = $this->routeHandlerParser->parse($route->{'x-lg-handler'});
+                if (!$this->handlerValidation($handler)) {
                     continue;
                 }
 
-                $handler = $this->routeHandlerParser->parse($route->{'x-lg-handler'});
-
                 try {
-                    $namespace = $this->getReplacedNamespace($handler->namespace, 'Controllers', 'Policies');
-                    $className = $handler->class . 'Policy';
+                    $namespace = $this->getReplacedNamespace(
+                        $handler->namespace,
+                        'Controllers',
+                        'Policies'
+                    );
                 } catch (RuntimeException) {
                     continue;
                 }
 
-                if (empty($handler->method)) {
-                    continue;
-                }
+                $className = $handler->class . 'Policy';
+                $methods = [$handler->method];
 
                 if (isset($policies["$namespace\\$className"])) {
-                    $policies["$namespace\\$className"]['methods'][] = $handler->method;
+                    $policies["$namespace\\$className"]['methods'][] = $methods[0];
                 } else {
-                    $methods = [$handler->method];
                     $policies["$namespace\\$className"] = compact('className', 'namespace', 'methods');
                 }
             }
@@ -60,7 +56,6 @@ protected function extractPolicies(SpecObjectInterface $specObject): array
         return $policies;
     }
 
-    // TODO: протестировать
     protected function createPoliciesFiles(array $policies, string $template): void
     {
         foreach ($policies as ['className' => $className, 'namespace' => $namespace, 'methods' => $methods]) {
@@ -74,24 +69,40 @@ protected function createPoliciesFiles(array $policies, string $template): void
                 $this->replacePlaceholders($template, [
                     '{{ namespace }}' => $namespace,
                     '{{ className }}' => $className,
-                    '{{ methods }}' => $this->convertToString($methods),
+                    '{{ methods }}' => $this->convertMethodsToString($methods),
                 ])
             );
-
-            die();
         }
     }
 
-    private function convertToString(array $methods): string
+    private function routeValidation(stdClass $route): bool
+    {
+        return match (true) {
+            !empty($route->{'x-lg-skip-policy-generation'}),
+            empty($route->{'x-lg-handler'}),
+            empty($route->responses->{403}) => false,
+            default => true
+        };
+    }
+
+    private function handlerValidation(ParsedRouteHandler $handler): bool
+    {
+        return match (true) {
+            empty($handler->namespace),
+            empty($handler->class),
+            empty($handler->method) => false,
+            default => true
+        };
+    }
+
+    private function convertMethodsToString(array $methods): string
     {
         $methodsStrings = [];
 
         foreach ($methods as $method) {
             $methodsStrings[] = $this->replacePlaceholders(
                 $this->templatesManager->getTemplate('PolicyGate.template'),
-                [
-                    '{{ method }}' => $method,
-                ]
+                ['{{ method }}' => $method]
             );
         }
 
diff --git a/templates/Policy.template b/templates/Policy.template
@@ -2,8 +2,7 @@
 
 namespace {{ namespace }};
 
-use App\Domain\Auth\Models\User;
-use Ensi\AdminAuthClient\Dto\RightsAccessEnum;
+use App\Models\User;
 use Illuminate\Auth\Access\HandlesAuthorization;
 use Illuminate\Auth\Access\Response;
 
diff --git a/templates/PolicyGate.template b/templates/PolicyGate.template
@@ -1,6 +1,4 @@
 public function {{ method }}(User $user): Response
     {
-        return $user->allowOneOf([
-            // add rights access from RightsAccessEnum
-        ]);
+        return Response::allow();
     }
diff --git a/tests/GenerateServerTest.php b/tests/GenerateServerTest.php
@@ -58,6 +58,10 @@
         $this->makeFilePath('/app/Http/Resources/ResourcesResource.php'),
         $this->makeFilePath('/app/Http/Resources/ResourcesDataDataResource.php'),
         $this->makeFilePath('/app/Http/Resources/ResourceRootResource.php'),
+
+        $this->makeFilePath('/app/Http/Controllers/PoliciesController.php'),
+        $this->makeFilePath('/app/Http/Tests/PoliciesComponentTest.php'),
+        $this->makeFilePath('/app/Http/Policies/PoliciesControllerPolicy.php'),
     ], $putFiles);
 });
 
diff --git a/tests/PolicyGenerationTest.php b/tests/PolicyGenerationTest.php
@@ -7,7 +7,41 @@
 
 use function Pest\Laravel\artisan;
 use function PHPUnit\Framework\assertEqualsCanonicalizing;
+use function PHPUnit\Framework\assertNotEqualsCanonicalizing;
 
-test('can generate policy', function () {
-    \PHPUnit\Framework\assertIsBool(true);
+test('Correct methods in generated policy', function () {
+    /** @var TestCase $this */
+    $mapping = Config::get('openapi-server-generator.api_docs_mappings');
+    $mappingValue = current($mapping);
+    $mapping = [$this->makeFilePath(__DIR__ . '/resources/index.yaml') => $mappingValue];
+    Config::set('openapi-server-generator.api_docs_mappings', $mapping);
+
+    $filesystem = $this->mock(Filesystem::class);
+    $filesystem->shouldReceive('exists')->andReturn(false);
+    $filesystem->shouldReceive('get')->withArgs(function ($path) {
+        return (bool)strstr($path, '.template');
+    })->andReturnUsing(function ($path) {
+        return file_get_contents($path);
+    });
+    $filesystem->shouldReceive('cleanDirectory', 'ensureDirectoryExists');
+
+    $policies = [];
+    $filesystem->shouldReceive('put')->withArgs(function ($path, $content) use (&$policies) {
+        if (str_contains($path, 'Policy.php')) {
+            $policies[pathinfo($path, PATHINFO_BASENAME)] = $content;
+        }
+
+        return true;
+    });
+
+    artisan(GenerateServer::class);
+
+    foreach ($policies as $key => $content) {
+        $methods = [];
+        preg_match_all('~public function (.*)\(~', $content, $methods);
+        $policies[$key] = $methods[1];
+    }
+
+    assertEqualsCanonicalizing(['methodFoo', 'methodBar'], $policies['PoliciesControllerPolicy.php']);
+    assertNotEqualsCanonicalizing(['methodWithoutForbiddenResponse'], $policies['PoliciesControllerPolicy.php']);
 });
diff --git a/tests/resources/index.yaml b/tests/resources/index.yaml
@@ -60,6 +60,7 @@ paths:
       x-lg-skip-controller-generation: true
       x-lg-skip-request-generation: true
       x-lg-skip-tests-generation: true
+      x-lg-skip-policy-generation: true
       responses:
         "200":
           description: Успешный ответ
@@ -146,7 +147,30 @@ paths:
             application/json:
               schema:
                 $ref: './schemas/test_resource_generation.yaml#/GenerateResourceWithoutPropertiesResponse'
-
+  /policies:test-generate-policy-method-foo:
+    post:
+      operationId: generatePolicyMethodFoo
+      x-lg-handler: '\App\Http\Controllers\PoliciesController@methodFoo'
+      x-lg-skip-request-generation: true
+      responses:
+        "403":
+          description: Ошибка прав доступа
+  /policies:test-generate-policy-method-bar:
+    post:
+      operationId: generatePolicyMethodBar
+      x-lg-handler: '\App\Http\Controllers\PoliciesController@methodBar'
+      x-lg-skip-request-generation: true
+      responses:
+        "403":
+          description: Ошибка прав доступа
+  /policies:test-generate-policy-method-without-forbidden-response:
+    post:
+      operationId: generatePolicyMethodWithoutForbiddenResponse
+      x-lg-handler: '\App\Http\Controllers\PoliciesController@methodWithoutForbiddenResponse'
+      x-lg-skip-request-generation: true
+      responses:
+        "200":
+          description: Успешный ответ c контекстом
 components:
   responses:
     ServerError:

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,4 @@`
`1`	`1`	`public function {{ method }}(User $user): Response`
`2`	`2`	`{`
`3`		`- return $user->allowOneOf([`
`4`		`- // add rights access from RightsAccessEnum`
`5`		`- ]);`
	`3`	`+ return Response::allow();`
`6`	`4`	`}`