Test LRD response

Author: kitloong

tests/Controllers/LaravelRequestDocsControllerTest.php

@@ -5,6 +5,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\Str;
 use Rakutentech\LaravelRequestDocs\Tests\Stubs\TestControllers\API\Group1Controller;
@@ -16,8 +17,15 @@ class LaravelRequestDocsControllerTest extends TestCase
 {
     public function testApi()
     {
-        $this->get(route('request-docs.api'))
+        $response = $this->get(route('request-docs.api'))
             ->assertStatus(Response::HTTP_OK);
+
+        $expected = (array) json_decode(
+            File::get(base_path('tests/mocks/lrd-response.json')),
+            true,
+        );
+
+        $this->assertSame($expected, $response->json());
     }
 
     public function testApiCanHideMetadata()
@@ -383,7 +391,7 @@ public function testGroupByControllerFullPath()
 
     public function testOpenApi()
     {
-        $response = $this->get(route('request-docs.api') . '?openapi=true')
+        $this->get(route('request-docs.api') . '?openapi=true')
             ->assertStatus(Response::HTTP_OK);
     }
 }

tests/TestCase.php

@@ -31,6 +31,8 @@ protected function getPackageProviders($app)
 
     public function getEnvironmentSetUp($app)
     {
+        app()->setBasePath(__DIR__ . '/../');
+
         $app['config']->set('database.default', 'testing');
         $app['config']->set('app.debug', true);
     }

tests/mocks/lrd-response.json

@@ -0,0 +1 @@
+[{"uri":"\/","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"GET","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"\/","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"HEAD","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"welcome","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"GET","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"welcome","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"HEAD","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"welcome\/{id}","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"show","http_method":"GET","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"welcome\/{id}","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"show","http_method":"HEAD","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"welcome","middlewares":["auth:api"],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"store","http_method":"POST","rules":{"error":["string","exists:"],"message_param":["nullable|string"]},"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"welcome","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"edit","http_method":"PUT","rules":{"message_param":["nullable|string"],"search_string":["string"],"search_array":["array"],"search_integer":["integer"],"search_boolean":["boolean"]},"doc_block":"","responses":["200","400","401"]},{"uri":"welcome\/patch","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"edit","http_method":"PATCH","rules":{"message_param":["nullable|string"],"search_string":["string"],"search_array":["array"],"search_integer":["integer"],"search_boolean":["boolean"]},"doc_block":"","responses":["200","400","401"]},{"uri":"welcome","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"destroy","http_method":"DELETE","rules":{"message_param":["nullable|string"]},"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"health","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"health","http_method":"GET","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"health","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"health","http_method":"HEAD","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"single","middlewares":[],"controller":"SingleActionController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\SingleActionController","method":"__invoke","http_method":"GET","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"single","middlewares":[],"controller":"SingleActionController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\SingleActionController","method":"__invoke","http_method":"HEAD","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"welcome\/no-rules","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"noRules","http_method":"DELETE","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"closure","middlewares":[],"controller":"","controller_full_path":"","method":"","http_method":"GET","rules":[],"doc_block":"","responses":[]},{"uri":"closure","middlewares":[],"controller":"","controller_full_path":"","method":"","http_method":"HEAD","rules":[],"doc_block":"","responses":[]},{"uri":"accounts","middlewares":[],"controller":"AccountController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\AccountController","method":"index","http_method":"GET","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"accounts","middlewares":[],"controller":"AccountController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\AccountController","method":"index","http_method":"HEAD","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"accounts","middlewares":[],"controller":"AccountController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\AccountController","method":"store","http_method":"POST","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"accounts\/{account}","middlewares":[],"controller":"AccountController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\AccountController","method":"show","http_method":"GET","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"accounts\/{account}","middlewares":[],"controller":"AccountController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\AccountController","method":"show","http_method":"HEAD","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"accounts\/{account}","middlewares":[],"controller":"AccountController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\AccountController","method":"update","http_method":"PUT","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"accounts\/{account}","middlewares":[],"controller":"AccountController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\AccountController","method":"update","http_method":"PATCH","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"accounts\/{account}","middlewares":[],"controller":"AccountController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\AccountController","method":"destroy","http_method":"DELETE","rules":[],"doc_block":"","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"any","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"GET","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"any","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"HEAD","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"any","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"POST","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"any","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"PUT","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"any","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"PATCH","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"any","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"DELETE","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"match","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"GET","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"match","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"POST","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]},{"uri":"match","middlewares":[],"controller":"WelcomeController","controller_full_path":"Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestControllers\\WelcomeController","method":"index","http_method":"HEAD","rules":{"name":["nullable|string|min:5|max:255"],"title":["Rakutentech\\LaravelRequestDocs\\Tests\\Stubs\\TestRules\\Uppercase"],"file":["file"],"image":["image"],"page":["nullable|integer|min:1"],"per_page":["nullable|integer|min:1|max:100"]},"doc_block":"#Hello markdown\n## Documentation for \/my route\n","responses":["200","400","401","403","404","405","422","429","500","503"]}]