added tests

Author: kevincobain2000

src/LaravelRequestDocs.php

@@ -86,10 +86,15 @@ public function getControllersInfo(): array
  }
  }
 
+ $middlewares = [];
+ if (!empty($route->action['middleware'])) {
+ $middlewares = !is_array($route->action['middleware']) ? [$route->action['middleware']] : $route->action['middleware'];
+ }
+
  $controllersInfo[] = [
  'uri' => $route->uri,
  'methods' => $route->methods,
- 'middlewares' => !is_array($route->action['middleware']) ? [$route->action['middleware']] : $route->action['middleware'],
+ 'middlewares' => $middlewares,
  'controller' => $controllerName,
  'controller_full_path' => $controllerFullPath,
  'method' => $method,

tests/LRDTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests;
+use Route;
+
+class LRDTest extends TestCase
+{
+ public function testDocsCount()
+ {
+ $docs = $this->lrd->getDocs();
+ $routes = collect(Route::getRoutes());
+
+ $this->assertSame($routes->count(), count($docs));
+ }
+
+ public function testDocsCanFetchAllMethods()
+ {
+ $docs = $this->lrd->getDocs();
+ $methods = [];
+ foreach ($docs as $doc) {
+ $methods = array_merge($methods, $doc['methods']);
+ }
+ $methods = array_unique($methods);
+ sort($methods);
+ $this->assertSame(['DELETE', 'GET', 'HEAD', 'POST', 'PUT'], $methods);
+ }
+
+ public function testDocsCanFetchInfo()
+ {
+ $docs = $this->lrd->getDocs();
+ foreach ($docs as $doc) {
+ $this->assertNotEmpty($doc['rules']);
+ $this->assertNotEmpty($doc['methods']);
+ // $this->assertNotEmpty($doc['middlewares']); //todo: add middlewares to test
+ $this->assertNotEmpty($doc['controller']);
+ $this->assertNotEmpty($doc['controller_full_path']);
+ $this->assertNotEmpty($doc['method']);
+ $this->assertNotEmpty($doc['httpMethod']);
+ $this->assertNotEmpty($doc['rules']);
+ }
+ }
+}

tests/TestCase.php

@@ -2,15 +2,20 @@
 
 namespace Rakutentech\LaravelRequestDocs\Tests;
 
-use Illuminate\Database\Eloquent\Factories\Factory;
 use Orchestra\Testbench\TestCase as Orchestra;
 use Rakutentech\LaravelRequestDocs\LaravelRequestDocsServiceProvider;
+use Rakutentech\LaravelRequestDocs\LaravelRequestDocs;
+use Illuminate\Support\Facades\Route;
+use Rakutentech\LaravelRequestDocs\Tests\TestControllers;
 
 class TestCase extends Orchestra
 {
+ protected LaravelRequestDocs $lrd;
  public function setUp(): void
  {
  parent::setUp();
+ $this->lrd = new LaravelRequestDocs();
+ $this->registerRoutes();
  }
 
  protected function getPackageProviders($app)
@@ -24,4 +29,12 @@ public function getEnvironmentSetUp($app)
  {
  config()->set('database.default', 'testing');
  }
+
+ public function registerRoutes() {
+ Route::get('/', [TestControllers\WelcomeController::class, 'index']);
+ Route::get('welcome', [TestControllers\WelcomeController::class, 'index']);
+ Route::post('welcome', [TestControllers\WelcomeController::class, 'store']);
+ Route::put('welcome', [TestControllers\WelcomeController::class, 'edit']);
+ Route::delete('welcome', [TestControllers\WelcomeController::class, 'destroy']);
+ }
 }

tests/TestControllers/WelcomeController.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests\TestControllers;
+
+use Rakutentech\LaravelRequestDocs\Tests\TestRequests\WelcomeIndexRequest;
+use Rakutentech\LaravelRequestDocs\Tests\TestRequests\WelcomeEditRequest;
+use Rakutentech\LaravelRequestDocs\Tests\TestRequests\WelcomeStoreRequest;
+use Rakutentech\LaravelRequestDocs\Tests\TestRequests\WelcomeDeleteRequest;
+
+class WelcomeController
+{
+ public function index(WelcomeIndexRequest $request)
+ {
+ return 1;
+ }
+
+ public function edit(WelcomeEditRequest $request)
+ {
+ return 1;
+ }
+
+ public function store(WelcomeStoreRequest $request)
+ {
+ return 1;
+ }
+
+ public function destroy(WelcomeDeleteRequest $request)
+ {
+ return 1;
+ }
+}

tests/TestRequests/WelcomeDeleteRequest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests\TestRequests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class WelcomeDeleteRequest extends FormRequest
+{
+ /**
+ * Determine if the user is authorized to make this request.
+ *
+ * @return bool
+ */
+ public function authorize()
+ {
+ return true;
+ }
+
+ protected function prepareForValidation()
+ {
+ }
+
+ /**
+ * Get the validation rules that apply to the request.
+ *
+ * @return array
+ */
+ public function rules()
+ {
+ return [
+ 'message_param' => 'nullable|string',
+ ];
+ }
+}

tests/TestRequests/WelcomeEditRequest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests\TestRequests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class WelcomeEditRequest extends FormRequest
+{
+ /**
+ * Determine if the user is authorized to make this request.
+ *
+ * @return bool
+ */
+ public function authorize()
+ {
+ return true;
+ }
+
+ protected function prepareForValidation()
+ {
+ }
+
+ /**
+ * Get the validation rules that apply to the request.
+ *
+ * @return array
+ */
+ public function rules()
+ {
+ return [
+ 'message_param' => 'nullable|string',
+ ];
+ }
+}

tests/TestRequests/WelcomeIndexRequest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests\TestRequests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class WelcomeIndexRequest extends FormRequest
+{
+ /**
+ * Determine if the user is authorized to make this request.
+ *
+ * @return bool
+ */
+ public function authorize()
+ {
+ return true;
+ }
+
+ protected function prepareForValidation()
+ {
+ }
+
+ /**
+ * Get the validation rules that apply to the request.
+ *
+ * @return array
+ */
+ public function rules()
+ {
+ return [
+ 'page' => 'nullable|integer|min:1',
+ 'per_page' => 'nullable|integer|min:1|max:100',
+ ];
+ }
+}

tests/TestRequests/WelcomeStoreRequest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests\TestRequests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class WelcomeStoreRequest extends FormRequest
+{
+ /**
+ * Determine if the user is authorized to make this request.
+ *
+ * @return bool
+ */
+ public function authorize()
+ {
+ return true;
+ }
+
+ protected function prepareForValidation()
+ {
+ }
+
+ /**
+ * Get the validation rules that apply to the request.
+ *
+ * @return array
+ */
+ public function rules()
+ {
+ return [
+ 'message_param' => 'nullable|string',
+ ];
+ }
+}