You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by li...@apache.org on 2023/08/16 01:37:42 UTC

[servicecomb-java-chassis] 09/12: [SCB-2803]fix problems in demo pojo test case

This is an automated email from the ASF dual-hosted git repository.

liubao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-java-chassis.git

commit b5d46255329232b3b5d81ac11947b31b8919c87c
Author: liubao <bi...@qq.com>
AuthorDate: Mon Aug 14 19:28:56 2023 +0800

    [SCB-2803]fix problems in demo pojo test case
---
 .../provider/pojo/definition/PojoConsumerMeta.java |  8 ---
 .../swagger/generator/OperationGenerator.java      |  2 -
 .../generator/core/AbstractOperationGenerator.java | 10 ----
 .../generator/pojo/PojoOperationGenerator.java     |  7 ++-
 .../swagger/generator/core/TestPojo.java}          | 55 ++++++++-------------
 .../resources/schemas/ParameterAnnotation.yaml     | 57 ++++++++++++++++++++++
 .../src/test/resources/schemas/Schema.yaml         |  2 +-
 .../producer/ProducerArgumentsMapperCreator.java   |  2 +-
 8 files changed, 86 insertions(+), 57 deletions(-)

diff --git a/providers/provider-pojo/src/main/java/org/apache/servicecomb/provider/pojo/definition/PojoConsumerMeta.java b/providers/provider-pojo/src/main/java/org/apache/servicecomb/provider/pojo/definition/PojoConsumerMeta.java
index 1b1451d29..336f0d46d 100644
--- a/providers/provider-pojo/src/main/java/org/apache/servicecomb/provider/pojo/definition/PojoConsumerMeta.java
+++ b/providers/provider-pojo/src/main/java/org/apache/servicecomb/provider/pojo/definition/PojoConsumerMeta.java
@@ -28,8 +28,6 @@ import org.apache.servicecomb.core.definition.SchemaMeta;
 import org.apache.servicecomb.core.provider.consumer.MicroserviceReferenceConfig;
 import org.apache.servicecomb.swagger.engine.SwaggerConsumer;
 import org.apache.servicecomb.swagger.engine.SwaggerConsumerOperation;
-import org.apache.servicecomb.swagger.generator.OperationGenerator;
-import org.apache.servicecomb.swagger.generator.SwaggerGenerator;
 import org.apache.servicecomb.swagger.invocation.exception.InvocationException;
 
 import jakarta.ws.rs.core.Response.Status;
@@ -46,16 +44,10 @@ public class PojoConsumerMeta {
     this.microserviceReferenceConfig = microserviceReferenceConfig;
     this.schemaMeta = schemaMeta;
 
-    SwaggerGenerator intfSwaggerGenerator = SwaggerGenerator.create(swaggerConsumer.getConsumerIntf());
-    intfSwaggerGenerator.scanClassAnnotation();
     for (SwaggerConsumerOperation swaggerConsumerOperation : swaggerConsumer.getOperations().values()) {
       String operationId = swaggerConsumerOperation.getSwaggerOperation().getOperationId();
       // SwaggerConsumer has make sure can find operationMeta
       OperationMeta operationMeta = schemaMeta.ensureFindOperation(operationId);
-
-      OperationGenerator intfOperationGenerator = intfSwaggerGenerator
-          .createOperationGenerator(swaggerConsumerOperation.getConsumerMethod());
-      intfOperationGenerator.generateResponse();
       PojoConsumerOperationMeta pojoConsumerOperationMeta = new PojoConsumerOperationMeta(this, operationMeta,
           swaggerConsumerOperation);
 
diff --git a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/OperationGenerator.java b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/OperationGenerator.java
index 1d5bec48c..c7aff4c80 100644
--- a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/OperationGenerator.java
+++ b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/OperationGenerator.java
@@ -35,8 +35,6 @@ public interface OperationGenerator {
 
   void setPath(String value);
 
-  void generateResponse();
-
   OperationGeneratorContext getOperationGeneratorContext();
 
   /**
diff --git a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/AbstractOperationGenerator.java b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/AbstractOperationGenerator.java
index 4d89a1d38..dbbc9ec14 100644
--- a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/AbstractOperationGenerator.java
+++ b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/AbstractOperationGenerator.java
@@ -64,7 +64,6 @@ import io.swagger.v3.oas.models.PathItem;
 import io.swagger.v3.oas.models.Paths;
 import io.swagger.v3.oas.models.media.Content;
 import io.swagger.v3.oas.models.media.Schema;
-import io.swagger.v3.oas.models.parameters.RequestBody;
 import io.swagger.v3.oas.models.responses.ApiResponse;
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import jakarta.servlet.http.HttpServletResponse;
@@ -87,8 +86,6 @@ public abstract class AbstractOperationGenerator implements OperationGenerator {
 
   protected Operation swaggerOperation;
 
-  protected RequestBody bodyParameter;
-
   protected OperationGeneratorContext operationGeneratorContext;
 
   public AbstractOperationGenerator(AbstractSwaggerGenerator swaggerGenerator, Method method) {
@@ -144,13 +141,6 @@ public abstract class AbstractOperationGenerator implements OperationGenerator {
     this.path = path;
   }
 
-  @Override
-  public void generateResponse() {
-    scanMethodAnnotation();
-    scanResponse();
-    correctOperation();
-  }
-
   public void generate() {
     scanMethodAnnotation();
     scanMethodParameters();
diff --git a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/pojo/PojoOperationGenerator.java b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/pojo/PojoOperationGenerator.java
index c36f56cc6..ffc7e540a 100644
--- a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/pojo/PojoOperationGenerator.java
+++ b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/pojo/PojoOperationGenerator.java
@@ -82,12 +82,17 @@ public class PojoOperationGenerator extends AbstractOperationGenerator {
   }
 
   private void wrapParametersToBody(List<ParameterGenerator> bodyFields) {
+    // process annotations like parameter name
+    for (ParameterGenerator parameterGenerator : bodyFields) {
+      scanMethodParameter(parameterGenerator);
+    }
+
     String simpleRef = MethodUtils.findSwaggerMethodName(method) + "Body";
 
     Schema<?> bodyModel = new ObjectSchema();
     for (ParameterGenerator parameterGenerator : bodyFields) {
       bodyModel.addProperty(parameterGenerator.getParameterGeneratorContext().getParameterName(),
-          SwaggerUtils.resolveTypeSchemas(swagger, parameterGenerator.getGenericType()));
+          parameterGenerator.getParameterGeneratorContext().getSchema());
     }
 
     swagger.getComponents().addSchemas(simpleRef, bodyModel);
diff --git a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/OperationGenerator.java b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/TestPojo.java
similarity index 52%
copy from swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/OperationGenerator.java
copy to swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/TestPojo.java
index 1d5bec48c..d733d0250 100644
--- a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/OperationGenerator.java
+++ b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/TestPojo.java
@@ -14,38 +14,25 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.servicecomb.swagger.generator;
-
-
-import org.apache.servicecomb.swagger.generator.core.OperationGeneratorContext;
-
-import io.swagger.v3.oas.models.OpenAPI;
-import io.swagger.v3.oas.models.Operation;
-
-public interface OperationGenerator {
-  OpenAPI getSwagger();
-
-  Operation getOperation();
-
-  void setHttpMethod(String httpMethod);
-
-  String getHttpMethod();
-
-  void addOperationToSwagger();
-
-  void setPath(String value);
-
-  void generateResponse();
-
-  OperationGeneratorContext getOperationGeneratorContext();
-
-  /**
-   * Used to check if one of operation has form parameter
-   */
-  boolean isForm();
-
-  /**
-   * Used to check if one of operation form parameter is binary
-   */
-  boolean isBinary();
+package org.apache.servicecomb.swagger.generator.core;
+
+import org.apache.servicecomb.swagger.generator.core.unittest.UnitTestSwaggerUtils;
+import org.junit.jupiter.api.Test;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+
+public class TestPojo {
+  @SuppressWarnings("unused")
+  public static class ParameterAnnotation {
+    @Operation(summary = "differentName", operationId = "differentName")
+    public int operationIdAndParameter(@Parameter(name = "x") int a, @Parameter(name = "y") int b) {
+      return a * 2 + b;
+    }
+  }
+
+  @Test
+  public void testResponseEntity() {
+    UnitTestSwaggerUtils.testSwagger("schemas/ParameterAnnotation.yaml", ParameterAnnotation.class);
+  }
 }
diff --git a/swagger/swagger-generator/generator-core/src/test/resources/schemas/ParameterAnnotation.yaml b/swagger/swagger-generator/generator-core/src/test/resources/schemas/ParameterAnnotation.yaml
new file mode 100644
index 000000000..5c2ffe0ee
--- /dev/null
+++ b/swagger/swagger-generator/generator-core/src/test/resources/schemas/ParameterAnnotation.yaml
@@ -0,0 +1,57 @@
+## ---------------------------------------------------------------------------
+## Licensed to the Apache Software Foundation (ASF) under one or more
+## contributor license agreements.  See the NOTICE file distributed with
+## this work for additional information regarding copyright ownership.
+## The ASF licenses this file to You under the Apache License, Version 2.0
+## (the "License"); you may not use this file except in compliance with
+## the License.  You may obtain a copy of the License at
+##
+##      http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+## ---------------------------------------------------------------------------
+
+---
+openapi: 3.0.1
+info:
+  title: swagger definition for org.apache.servicecomb.swagger.generator.core.TestPojo$ParameterAnnotation
+  version: 1.0.0
+servers:
+- url: /ParameterAnnotation
+paths:
+  /differentName:
+    post:
+      summary: differentName
+      operationId: differentName
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/differentNameBody'
+          application/protobuf:
+            schema:
+              $ref: '#/components/schemas/differentNameBody'
+        x-name: differentNameBody
+      responses:
+        "200":
+          description: response of 200
+          content:
+            application/json:
+              schema:
+                type: integer
+                format: int32
+components:
+  schemas:
+    differentNameBody:
+      type: object
+      properties:
+        x:
+          type: integer
+          format: int32
+        "y":
+          type: integer
+          format: int32
\ No newline at end of file
diff --git a/swagger/swagger-generator/generator-core/src/test/resources/schemas/Schema.yaml b/swagger/swagger-generator/generator-core/src/test/resources/schemas/Schema.yaml
index 133803a55..44d2ad5bf 100644
--- a/swagger/swagger-generator/generator-core/src/test/resources/schemas/Schema.yaml
+++ b/swagger/swagger-generator/generator-core/src/test/resources/schemas/Schema.yaml
@@ -870,6 +870,6 @@ components:
     wrapToBodyWithDescBody:
       type: object
       properties:
-        value:
+        desc:
           type: integer
           format: int32
\ No newline at end of file
diff --git a/swagger/swagger-invocation/invocation-core/src/main/java/org/apache/servicecomb/swagger/invocation/arguments/producer/ProducerArgumentsMapperCreator.java b/swagger/swagger-invocation/invocation-core/src/main/java/org/apache/servicecomb/swagger/invocation/arguments/producer/ProducerArgumentsMapperCreator.java
index 1932162a5..a58662ca0 100644
--- a/swagger/swagger-invocation/invocation-core/src/main/java/org/apache/servicecomb/swagger/invocation/arguments/producer/ProducerArgumentsMapperCreator.java
+++ b/swagger/swagger-invocation/invocation-core/src/main/java/org/apache/servicecomb/swagger/invocation/arguments/producer/ProducerArgumentsMapperCreator.java
@@ -70,7 +70,7 @@ public class ProducerArgumentsMapperCreator extends AbstractArgumentsMapperCreat
       String parameterName) {
     throw new IllegalStateException(String
         .format("failed to find producer parameter in contract, method=%s:%s, parameter name=%s.",
-            providerMethod.getDeclaringClass().getName(), providerMethod.getName(), parameterName));
+            providerMethod.getDeclaringClass().getSimpleName(), providerMethod.getName(), parameterName));
   }
 
   @Override