Merge branch '79-response-status-codes-are-not-the-codes-defined-in-spec' of github.com:php-openapi/yii2-openapi into fix-conflicting-pull-requests

Author: SOHELAHMED7

src/lib/generators/ControllersGenerator.php

@@ -59,7 +59,7 @@ public function generate():CodeFiles
             $controllerPath = $path;
             /**
              * @var RestAction|FractalAction $action
-            **/
+             **/
             $action = $actions[0];
             if ($action->prefix && !empty($action->prefixSettings)) {
                 $controllerNamespace = trim($action->prefixSettings['namespace'], '\\');
@@ -126,15 +126,31 @@ protected function makeCustomController(
         ];
         $reflection->addMethod('checkAccess', $params, AbstractMemberGenerator::FLAG_PUBLIC, '//TODO implement checkAccess');
         foreach ($abstractActions as $action) {
+            $responseHttpStatusCodes = '';
+            foreach ($this->config->getOpenApi()->paths->getPaths()[$action->urlPath]->getOperations() as $verb => $operation) {
+                $codes = array_keys($operation->responses->getResponses());
+
+                $only200OrDefault = false;
+                if ($codes === [200] || $codes === ['default']) {
+                    $only200OrDefault = true;
+                }
+                if (in_array('default', $codes) && in_array(200, $codes) && count($codes) === 2) {
+                    $only200OrDefault = true;
+                }
+
+                if ($verb === strtolower($action->requestMethod) && !$only200OrDefault) {
+                    $responseHttpStatusCodes = implode(', ', $codes);
+                }
+            }
+
             $params = array_map(static function ($param) {
                 return ['name' => $param];
             }, $action->getParamNames());
-
             $reflection->addMethod(
                 $action->actionMethodName,
                 $params,
                 AbstractMemberGenerator::FLAG_PUBLIC,
-                '//TODO implement ' . $action->actionMethodName
+                '//TODO implement ' . $action->actionMethodName . ($responseHttpStatusCodes ? PHP_EOL . '// In order to conform with OpenAPI spec, response of this action must have one of the following HTTP status code: ' . $responseHttpStatusCodes : '')
             );
         }
         $classFileGenerator->setClasses([$reflection]);

tests/specs/blog_v2/controllers/CommentController.php

@@ -18,6 +18,7 @@ public function actionListForPost($postId)
     public function actionCreateForPost($postId)
     {
         //TODO implement actionCreateForPost
+        // In order to conform with OpenAPI spec, response of this action must have one of the following HTTP status code: 201, default
     }
 
     public function actionViewForPost($slug, $id)
@@ -28,6 +29,7 @@ public function actionViewForPost($slug, $id)
     public function actionDeleteForPost($slug, $id)
     {
         //TODO implement actionDeleteForPost
+        // In order to conform with OpenAPI spec, response of this action must have one of the following HTTP status code: 204
     }
 
     public function actionUpdateForPost($slug, $id)

tests/specs/issue_fix/163_generator_crash_when_using_reference_inside_an_object/pgsql/controllers/ContactController.php

@@ -13,11 +13,13 @@ public function checkAccess($action, $model = null, $params = [])
     public function actionListForAccount($accountId)
     {
         //TODO implement actionListForAccount
+        // In order to conform with OpenAPI spec, response of this action must have one of the following HTTP status code: 200, 403
     }
 
     public function actionViewForAccount($accountId, $contactId)
     {
         //TODO implement actionViewForAccount
+        // In order to conform with OpenAPI spec, response of this action must have one of the following HTTP status code: 200, 403
     }
 
 

tests/specs/issue_fix/175_bug_allof_with_multiple_dollarrefs/pgsql/controllers/AccountController.php

@@ -13,6 +13,7 @@ public function checkAccess($action, $model = null, $params = [])
     public function actionView($id)
     {
         //TODO implement actionView
+        // In order to conform with OpenAPI spec, response of this action must have one of the following HTTP status code: 200, 404
     }
 
 

tests/specs/issue_fix/79_response_status_codes_are_not_the_codes_defined_in_spec/index.php

@@ -0,0 +1,13 @@
+<?php
+
+return [
+    'openApiPath' => '@specs/issue_fix/79_response_status_codes_are_not_the_codes_defined_in_spec/index.yml',
+    'generateUrls' => false,
+    'generateModels' => false,
+    'excludeModels' => [
+        'Error',
+    ],
+    'generateControllers' => true,
+    'generateMigrations' => false,
+    'generateModelFaker' => false,
+];

tests/specs/issue_fix/79_response_status_codes_are_not_the_codes_defined_in_spec/index.yml

@@ -0,0 +1,36 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: 79_response_status_codes_are_not_the_codes_defined_in_spec
+paths:
+  /mango/cake:
+    get:
+      responses:
+        '200':
+          description: The information
+        '403':
+          description: The information
+        '404':
+          description: The information
+    post:
+      responses:
+        '201':
+          description: The information
+        '403':
+          description: The information
+        '404':
+          description: The information
+        '422':
+          description: The information
+
+components:
+  schemas:
+    Address:
+      type: object
+      description: desc
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+          maxLength: 64

tests/specs/issue_fix/79_response_status_codes_are_not_the_codes_defined_in_spec/mysql/controllers/MangoController.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace app\controllers;
+
+class MangoController extends \app\controllers\base\MangoController
+{
+
+    public function checkAccess($action, $model = null, $params = [])
+    {
+        //TODO implement checkAccess
+    }
+
+    public function actionCake()
+    {
+        //TODO implement actionCake
+        // In order to conform with OpenAPI spec, response of this action must have one of the following HTTP status code: 200, 403, 404
+    }
+
+    public function actionCreateCake()
+    {
+        //TODO implement actionCreateCake
+        // In order to conform with OpenAPI spec, response of this action must have one of the following HTTP status code: 201, 403, 404, 422
+    }
+
+
+}
+

tests/specs/issue_fix/79_response_status_codes_are_not_the_codes_defined_in_spec/mysql/controllers/base/MangoController.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace app\controllers\base;
+
+abstract class MangoController extends \yii\rest\Controller
+{
+    public function actions()
+    {
+        return [
+            'options' => [
+                'class' => \yii\rest\OptionsAction::class,
+            ],
+        ];
+    }
+
+    /**
+     * Checks the privilege of the current user.
+     *
+     * This method checks whether the current user has the privilege
+     * to run the specified action against the specified data model.
+     * If the user does not have access, a [[ForbiddenHttpException]] should be thrown.
+     *
+     * @param string $action the ID of the action to be executed
+     * @param object $model the model to be accessed. If null, it means no specific model is being accessed.
+     * @param array $params additional parameters
+     * @throws \yii\web\ForbiddenHttpException if the user does not have access
+     */
+    abstract public function checkAccess($action, $model = null, $params = []);
+
+    abstract public function actionCake();
+
+    abstract public function actionCreateCake();
+
+}

tests/unit/IssueFixTest.php

@@ -1030,15 +1030,15 @@ public function test23ConsiderOpenapiExtensionXNoRelationAlsoInOtherPertinentPla
         $this->runActualMigrations();
     }
 
-    // https://github.com/php-openapi/yii2-openapi/issues/96
-    public function test96ComponentSchemaShouldBeOptional()
+    // https://github.com/php-openapi/yii2-openapi/issues/79
+    public function test79ResponseStatusCodesAreNotTheCodesDefinedInSpec()
     {
-        $testFile = Yii::getAlias("@specs/issue_fix/96_component_schema_should_be_optional/index.php");
+        $testFile = Yii::getAlias("@specs/issue_fix/79_response_status_codes_are_not_the_codes_defined_in_spec/index.php");
         $this->runGenerator($testFile);
         $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [
             'recursive' => true,
         ]);
-        $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/96_component_schema_should_be_optional/mysql"), [
+        $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/79_response_status_codes_are_not_the_codes_defined_in_spec/mysql"), [
             'recursive' => true,
         ]);
         $this->checkFiles($actualFiles, $expectedFiles);
@@ -1058,4 +1058,18 @@ public function test87ImplementForJsonInIsrefpointertoschema()
         $this->checkFiles($actualFiles, $expectedFiles);
         $this->runActualMigrations();
     }
+
+    // https://github.com/php-openapi/yii2-openapi/issues/96
+    public function test96ComponentSchemaShouldBeOptional()
+    {
+        $testFile = Yii::getAlias("@specs/issue_fix/96_component_schema_should_be_optional/index.php");
+        $this->runGenerator($testFile);
+        $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [
+            'recursive' => true,
+        ]);
+        $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/96_component_schema_should_be_optional/mysql"), [
+            'recursive' => true,
+        ]);
+        $this->checkFiles($actualFiles, $expectedFiles);
+    }
 }