Merge master

arrilot · arrilot · commit bf4ddc7c3c1d · 2022-02-11T16:24:39.000+03:00
diff --git a/.git_hooks/external_runtime b/.git_hooks/external_runtime
@@ -0,0 +1,37 @@
+#!/bin/bash
+
+###############################################################################
+# External Runtime - вспомогательный скрипт для запуска хуков в отдельной     #
+# среде, например в контейнере.                                               #
+# Использование:                                                              #
+# 1. Подключите этот файл в скрипт хука:                                      #
+#    source . $(pwd)/.git_hooks/external_runtime                              #
+# 2. Создайте выше по файловой системе файл .external-runtime,                #
+#    содержащий переменную EXTERNAL_RUNTIME_COMMAND, например:                #
+#    EXTERNAL_RUNTIME_COMMAND="ensi exec-script"
+#    Этот файл должен отсутствовать в среде запуска.
+###############################################################################
+
+EXTERNAL_RUNTIME_FILE=".external-runtime"
+
+ESC_SEQ="\x1b["
+COL_RESET=$ESC_SEQ"39;49;00m"
+COL_BLUE=$ESC_SEQ"0;34m"
+
+findUp () {
+  path=$(pwd)
+  while [[ "$path" != "" && ! -e "$path/$1" ]]; do
+    path=${path%/*}
+  done
+  echo "$path"
+}
+
+# search external runtime file
+rcpath=$(findUp "$EXTERNAL_RUNTIME_FILE")
+if [[ "$rcpath" != "" ]]; then
+    # source it and run hook in via runtime command
+    . $rcpath/$EXTERNAL_RUNTIME_FILE
+    printf "$COL_BLUE%s$COL_RESET\n" "External runtime has been found. Running hook with '$EXTERNAL_RUNTIME_COMMAND' command"
+    $EXTERNAL_RUNTIME_COMMAND $0
+    exit $?
+fi
diff --git a/.git_hooks/post-checkout/install-dependencies.sh b/.git_hooks/post-checkout/install-dependencies.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+source $(pwd)/.git_hooks/external_runtime
+
 ESC_SEQ="\x1b["
 COL_RESET=$ESC_SEQ"39;49;00m"
 COL_RED=$ESC_SEQ"0;31m"
diff --git a/.git_hooks/post-merge/install-dependencies.sh b/.git_hooks/post-merge/install-dependencies.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+source $(pwd)/.git_hooks/external_runtime
+
 ESC_SEQ="\x1b["
 COL_RESET=$ESC_SEQ"39;49;00m"
 COL_RED=$ESC_SEQ"0;31m"
diff --git a/.git_hooks/pre-commit/lint-php.sh b/.git_hooks/pre-commit/lint-php.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+source $(pwd)/.git_hooks/external_runtime
+
 ROOT_DIR="$(pwd)/"
 LIST=$(git diff-index --cached --name-only --diff-filter=ACMR HEAD)
 ERRORS_BUFFER=""
diff --git a/.git_hooks/pre-commit/php-cs-fixer.sh b/.git_hooks/pre-commit/php-cs-fixer.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+source $(pwd)/.git_hooks/external_runtime
+
 EXECUTABLE_NAME=php-cs-fixer
 EXECUTABLE_COMMAND=fix
 CONFIG_FILE=.php-cs-fixer.php
diff --git a/.git_hooks/pre-push/composer-validate.sh b/.git_hooks/pre-push/composer-validate.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+source $(pwd)/.git_hooks/external_runtime
+
 # validate composer 
 
 ESC_SEQ="\x1b["
diff --git a/.git_hooks/pre-push/test-code.sh b/.git_hooks/pre-push/test-code.sh
@@ -0,0 +1,20 @@
+#!/bin/bash
+
+source $(pwd)/.git_hooks/external_runtime
+
+ESC_SEQ="\x1b["
+COL_RESET=$ESC_SEQ"39;49;00m"
+COL_RED=$ESC_SEQ"0;31m"
+COL_GREEN=$ESC_SEQ"0;32m"
+COL_YELLOW=$ESC_SEQ"0;33m"
+
+echo
+printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-push hook: \"test-code\""
+
+if composer test; then
+    echo "Okay"
+    exit 0
+else
+    printf "$COL_RED%s$COL_RESET\r\n" "Tests failed."
+    exit 1
+fi
diff --git a/.git_hooks/pre-push/var-dump-checker.sh b/.git_hooks/pre-push/var-dump-checker.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+source $(pwd)/.git_hooks/external_runtime
+
 ESC_SEQ="\x1b["
 COL_RESET=$ESC_SEQ"39;49;00m"
 COL_RED=$ESC_SEQ"0;31m"
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,4 @@ build
 generated
 vendor
 node_modules
+coverage
diff --git a/.huskyrc.json b/.huskyrc.json
@@ -3,6 +3,6 @@
         "post-checkout": ".git_hooks/post-checkout/install-dependencies.sh",
         "post-merge": ".git_hooks/post-merge/install-dependencies.sh",
         "pre-commit": ".git_hooks/pre-commit/lint-php.sh && .git_hooks/pre-commit/php-cs-fixer.sh",
-        "pre-push": ".git_hooks/pre-push/composer-validate.sh && .git_hooks/pre-push/var-dump-checker.sh && composer test"
+        "pre-push": ".git_hooks/pre-push/composer-validate.sh && .git_hooks/pre-push/var-dump-checker.sh && .git_hooks/pre-push/test-code.sh"
     }
 }
diff --git a/composer.json b/composer.json
@@ -1,54 +1,56 @@
 {
-  "name": "ensi/laravel-openapi-server-generator",
-  "description": "",
-  "type": "library",
-  "authors": [
-    {
-      "name": "Nekrasov Ilya",
-      "email": "nekrasov@greensight.ru"
+    "name": "ensi/laravel-openapi-server-generator",
+    "description": "",
+    "type": "library",
+    "authors": [
+        {
+            "name": "Nekrasov Ilya",
+            "email": "nekrasov@greensight.ru"
+        }
+    ],
+    "license": "MIT",
+    "require": {
+        "php": "^8.1",
+        "cebe/php-openapi": ">=1.4.2 <1.6.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Ensi\\LaravelOpenApiServerGenerator\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Ensi\\LaravelOpenApiServerGenerator\\Tests\\": "tests"
+        }
+    },
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.2",
+        "mockery/mockery": ">=1.3.2",
+        "nunomaduro/collision": "^5.3",
+        "pestphp/pest": "^1.18",
+        "pestphp/pest-plugin-laravel": "^1.1",
+        "php-parallel-lint/php-var-dump-check": "^0.5.0",
+        "spatie/laravel-ray": "^1.23",
+        "orchestra/testbench": "^6.15",
+        "vimeo/psalm": "^4.8"
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Ensi\\LaravelOpenApiServerGenerator\\LaravelOpenApiServerGeneratorServiceProvider"
+            ]
+        }
+    },
+    "scripts": {
+        "cs": "php-cs-fixer fix --config .php-cs-fixer.php",
+        "test": "./vendor/bin/pest --no-coverage",
+        "test-coverage": "XDEBUG_MODE=coverage ./vendor/bin/pest --coverage"
+    },
+    "config": {
+        "sort-packages": true,
+        "allow-plugins": {
+            "composer/package-versions-deprecated": true,
+            "pestphp/pest-plugin": true
+        }
     }
-  ],
-  "license": "MIT",
-  "require": {
-    "php": "^8.1",
-    "cebe/php-openapi": "^1.5"
-  },
-  "autoload": {
-    "psr-4": {
-      "Ensi\\LaravelOpenApiServerGenerator\\": "src/"
-    }
-  },
-  "autoload-dev": {
-    "psr-4": {
-        "Ensi\\LaravelOpenApiServerGenerator\\Tests\\": "tests"
-    }
-  },
-  "require-dev": {
-    "nunomaduro/collision": "^5.3",
-    "orchestra/testbench": "^6.15",
-    "pestphp/pest": "^1.18",
-    "pestphp/pest-plugin-laravel": "^1.1",
-    "spatie/laravel-ray": "^1.23",
-    "vimeo/psalm": "^4.8",
-    "friendsofphp/php-cs-fixer": "^3.2",
-    "php-parallel-lint/php-var-dump-check": "^0.5.0"
-  },
-  "extra": {
-    "laravel": {
-      "providers": [
-        "Ensi\\LaravelOpenApiServerGenerator\\LaravelOpenApiServerGeneratorServiceProvider"
-      ]
-    }
-  },
-  "scripts": {
-    "cs": "php-cs-fixer fix --config .php-cs-fixer.php",
-    "test": "./vendor/bin/pest --no-coverage",
-    "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
-  },
-  "config": {
-    "allow-plugins": {
-      "pestphp/pest-plugin": true,
-      "composer/package-versions-deprecated": true
-    }
-  }
 }
diff --git a/src/Generators/BaseGenerator.php b/src/Generators/BaseGenerator.php
@@ -9,6 +9,7 @@
 use Ensi\LaravelOpenApiServerGenerator\Utils\TypesMapper;
 use Illuminate\Filesystem\Filesystem;
 use InvalidArgumentException;
+use RuntimeException;
 
 class BaseGenerator
 {
@@ -41,7 +42,20 @@ protected function trimPath(string $path): string
         return $path === '/' ? $path : ltrim($path, '/');
     }
 
-    protected function getNamespacedFilePath(string $fileName, string $namespace, ): string
+    protected function getReplacedNamespace(?string $baseNamespace, string $replaceFromNamespace, string $replaceToNamespace): ?string
+    {
+        if ($baseNamespace) {
+            if (!str_contains($baseNamespace, $replaceFromNamespace)) {
+                throw new RuntimeException("Can't replace namespace");
+            }
+
+            return str_replace($replaceFromNamespace, $replaceToNamespace, $baseNamespace);
+        }
+
+        return null;
+    }
+
+    protected function getNamespacedFilePath(string $fileName, ?string $namespace): string
     {
         $toDir = $this->psr4PathConverter->namespaceToPath($namespace);
 
diff --git a/src/Generators/RequestsGenerator.php b/src/Generators/RequestsGenerator.php
@@ -4,6 +4,7 @@
 
 use cebe\openapi\SpecObjectInterface;
 use InvalidArgumentException;
+use RuntimeException;
 
 class RequestsGenerator extends BaseGenerator implements GeneratorInterface
 {
@@ -40,11 +41,13 @@ protected function extractRequests(SpecObjectInterface $specObject, array $names
                 }
 
                 $handler = $this->routeHandlerParser->parse($route->{'x-lg-handler'});
-                if (!$handler->namespace || !str_contains($handler->namespace, $replaceFromNamespace)) {
+
+                try {
+                    $newNamespace = $this->getReplacedNamespace($handler->namespace, $replaceFromNamespace, $replaceToNamespace);
+                } catch (RuntimeException) {
                     continue;
                 }
 
-                $newNamespace = str_replace($replaceFromNamespace, $replaceToNamespace, $handler->namespace);
                 $className = $route->{'x-lg-request-class-name'} ?? ucfirst($route->operationId) . 'Request';
                 if (!$className) {
                     continue;
diff --git a/src/Generators/TestsGenerator.php b/src/Generators/TestsGenerator.php
@@ -4,6 +4,7 @@
 
 use cebe\openapi\SpecObjectInterface;
 use InvalidArgumentException;
+use RuntimeException;
 use stdClass;
 
 abstract class TestsGenerator extends BaseGenerator implements GeneratorInterface
@@ -47,17 +48,23 @@ protected function constructTests(stdClass $openApiData, array $namespaceData):
                 }
 
                 $handler = $this->routeHandlerParser->parse($route->{'x-lg-handler'});
-                if (!$handler->namespace || !str_contains($handler->namespace, $replaceFromNamespace)) {
+
+                try {
+                    $newNamespace = $this->getReplacedNamespace($handler->namespace, $replaceFromNamespace, $replaceToNamespace);
+                } catch (RuntimeException) {
                     continue;
                 }
 
-                $newNamespace = str_replace($replaceFromNamespace, $replaceToNamespace, $handler->namespace);
+
                 $className = str_replace("Controller", "", $handler->class) . "ComponentTest";
                 if (!$className) {
                     continue;
                 }
 
-                $firstResponse = current((array)$route?->responses) ?? null;
+                $firstResponse = null;
+                if (isset($route->responses)) {
+                    $firstResponse = current((array)$route->responses) ?? null;
+                }
                 if (!$firstResponse) {
                     continue;
                 }
@@ -75,7 +82,7 @@ protected function constructTests(stdClass $openApiData, array $namespaceData):
                     'method' => $method,
                     'path' => $path,
                     'responseCodes' => $route->responses ? array_keys(get_object_vars($route->responses)) : [],
-                    'responseContentType' => $firstResponse->content ? array_keys(get_object_vars($firstResponse->content))[0] : "",
+                    'responseContentType' => isset($firstResponse->content) ? array_keys(get_object_vars($firstResponse->content))[0] : "",
                 ];
             }
         }
diff --git a/src/Utils/PSR4PathConverter.php b/src/Utils/PSR4PathConverter.php
@@ -19,8 +19,11 @@ public function addMappings(array $mappings): static
         return $this;
     }
 
-    public function namespaceToPath(string $namespace): string
+    public function namespaceToPath(?string $namespace): string
     {
+        if (is_null($namespace)) {
+            return '';
+        }
         foreach ($this->mappings as $mappingNamescape => $mappingPath) {
             if (str_starts_with($namespace, $mappingNamescape)) {
                 $namespaceWithoutBase = substr($namespace, strlen($mappingNamescape));
diff --git a/tests/GenerateServerTest.php b/tests/GenerateServerTest.php
@@ -0,0 +1,52 @@
+<?php
+
+use Ensi\LaravelOpenApiServerGenerator\Commands\GenerateServer;
+use Ensi\LaravelOpenApiServerGenerator\Tests\TestCase;
+use Illuminate\Filesystem\Filesystem;
+use Illuminate\Support\Facades\Config;
+use function Pest\Laravel\artisan;
+use function PHPUnit\Framework\assertEqualsCanonicalizing;
+
+test("Command GenerateServer success", 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');
+    $appRoot = realpath($this->makeFilePath(__DIR__ . '/../vendor/orchestra/testbench-core/laravel/'));
+    $putFiles = [];
+    $filesystem->shouldReceive('put')->withArgs(function ($path, $content) use (&$putFiles, $appRoot) {
+        $putFiles[] = $this->makeFilePath(str_replace($appRoot, '', $path));
+
+        return true;
+    });
+
+    artisan(GenerateServer::class);
+
+    assertEqualsCanonicalizing([
+        $this->makeFilePath('/app/Http/ApiV1/OpenApiGenerated/routes.php'),
+
+        $this->makeFilePath('/app/Http/Controllers/ResourcesController.php'),
+        $this->makeFilePath('/app/Http/Requests/TestFullGenerateRequest.php'),
+        $this->makeFilePath('/app/Http/Tests/ResourcesComponentTest.php'),
+        $this->makeFilePath('/app/Http/Requests/TestFooRenameRequest.php'),
+
+        $this->makeFilePath('/app/Http/Controllers/WithoutResponsesController.php'),
+
+        $this->makeFilePath('/WithoutNamespaceController.php'),
+        $this->makeFilePath('/WithoutNamespaceRequest.php'),
+        $this->makeFilePath('/WithoutNamespaceComponentTest.php'),
+
+        $this->makeFilePath('/app/Http/ApiV1/OpenApiGenerated/Enums/TestIntegerEnum.php'),
+        $this->makeFilePath('/app/Http/ApiV1/OpenApiGenerated/Enums/TestStringEnum.php'),
+    ], $putFiles);
+});
diff --git a/tests/TestCase.php b/tests/TestCase.php
diff --git a/tests/resources/index.yaml b/tests/resources/index.yaml

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,6 @@`
`3`	`3`	`"post-checkout": ".git_hooks/post-checkout/install-dependencies.sh",`
`4`	`4`	`"post-merge": ".git_hooks/post-merge/install-dependencies.sh",`
`5`	`5`	`"pre-commit": ".git_hooks/pre-commit/lint-php.sh && .git_hooks/pre-commit/php-cs-fixer.sh",`
`6`		`- "pre-push": ".git_hooks/pre-push/composer-validate.sh && .git_hooks/pre-push/var-dump-checker.sh && composer test"`
	`6`	`+ "pre-push": ".git_hooks/pre-push/composer-validate.sh && .git_hooks/pre-push/var-dump-checker.sh && .git_hooks/pre-push/test-code.sh"`
`7`	`7`	`}`
`8`	`8`	`}`