[servicecomb-java-chassis] branch master updated: [SCB-1392]Mutiple classes have the same APIModel, and class will occur when generating schemaid.

[li...@apache.org]

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


The following commit(s) were added to refs/heads/master by this push:
     new bc333c5  [SCB-1392]Mutiple classes have the same APIModel,and class will occur when generating schemaid.
bc333c5 is described below

commit bc333c5a976202f6d7f0945726b3d420f86edde3
Author: GuoYL <gy...@gmail.com>
AuthorDate: Wed Jul 24 17:30:28 2019 +0800

    [SCB-1392]Mutiple classes have the same APIModel,and class will occur when generating schemaid.
---
 .../swagger/generator/core/utils/ParamUtils.java   | 12 +++++
 .../swagger/generator/core/TestParamUtils.java     | 55 ++++++++++++++++++++++
 .../swagger/generator/core/pojo/TestType1.java     | 25 ++++++++++
 .../swagger/generator/core/pojo/TestType2.java     | 25 ++++++++++
 4 files changed, 117 insertions(+)

diff --git a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/utils/ParamUtils.java b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/utils/ParamUtils.java
index 6f9354b..79a579c 100644
--- a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/utils/ParamUtils.java
+++ b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/utils/ParamUtils.java
@@ -25,6 +25,8 @@ import java.util.Map;
 
 import org.apache.commons.lang3.StringUtils;
 import org.apache.servicecomb.swagger.generator.core.OperationGenerator;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.core.DefaultParameterNameDiscoverer;
 import org.springframework.core.MethodParameter;
 
@@ -46,6 +48,8 @@ import io.swagger.models.properties.StringProperty;
 public final class ParamUtils {
   private static DefaultParameterNameDiscoverer parameterNameDiscoverer = new DefaultParameterNameDiscoverer();
 
+  private static final Logger LOGGER = LoggerFactory.getLogger(ParamUtils.class);
+
   private ParamUtils() {
 
   }
@@ -115,10 +119,18 @@ public final class ParamUtils {
   public static void addDefinitions(Swagger swagger, Type paramType) {
     Map<String, Model> models = ModelConverters.getInstance().readAll(paramType);
     for (Map.Entry<String, Model> entry : models.entrySet()) {
+      if (null != swagger.getDefinitions()) {
+        Model tempModel = swagger.getDefinitions().get(entry.getKey());
+        if (null != tempModel && !tempModel.equals(entry.getValue())) {
+          LOGGER.warn("duplicate param model: " + entry.getKey());
+          throw new IllegalArgumentException("duplicate param model: " + entry.getKey());
+        }
+      }
       swagger.addDefinition(entry.getKey(), entry.getValue());
     }
   }
 
+
   public static void setParameterType(Swagger swagger, Method method, int paramIdx,
       AbstractSerializableParameter<?> parameter) {
     Type paramType = ParamUtils.getGenericParameterType(method, paramIdx);
diff --git a/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/TestParamUtils.java b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/TestParamUtils.java
index b116174..cc5d4ad 100644
--- a/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/TestParamUtils.java
+++ b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/TestParamUtils.java
@@ -17,12 +17,22 @@
 
 package org.apache.servicecomb.swagger.generator.core;
 
+import static junit.framework.TestCase.fail;
+import static org.hamcrest.Matchers.containsString;
+import static org.junit.Assert.assertThat;
 import static org.mockito.Mockito.when;
 
+import java.lang.reflect.Field;
+import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
+import io.swagger.models.Swagger;
+
+import org.apache.servicecomb.swagger.generator.core.pojo.TestType1;
+import org.apache.servicecomb.swagger.generator.core.pojo.TestType2;
 import org.apache.servicecomb.swagger.generator.core.utils.ClassUtils;
 import org.apache.servicecomb.swagger.generator.core.utils.ParamUtils;
 import org.junit.Assert;
@@ -95,4 +105,49 @@ public class TestParamUtils {
           + "param name is [testName]", e.getMessage());
     }
   }
+
+  private static class AllTypeTest1 {
+    TestType1 t1;
+
+    List<TestType1> t2;
+
+    Map<String, TestType1> t3;
+
+    TestType1[] t4;
+  }
+
+  private static class AllTypeTest2 {
+    TestType2 t1;
+
+    List<TestType2> t2;
+
+    Map<String, TestType2> t3;
+
+    TestType2[] t4;
+  }
+
+  @Test
+  public void testAddDefinitions() {
+    Field[] fields1 = AllTypeTest1.class.getDeclaredFields();
+    Field[] fields2 = AllTypeTest2.class.getDeclaredFields();
+    for (int i = 0; i < fields1.length; i++) {
+      for (int j = 0; j < fields2.length; j++) {
+        if (fields1[i].isSynthetic() || fields2[j].isSynthetic()) {
+          continue;
+        }
+        try {
+          testExcep(fields1[i].getGenericType(), fields2[j].getGenericType());
+          fail("IllegalArgumentException expected");
+        } catch (IllegalArgumentException e) {
+          assertThat(e.getMessage(), containsString("duplicate param model:"));
+        }
+      }
+    }
+  }
+
+  private void testExcep(Type f1, Type f2) {
+    Swagger swagger = new Swagger();
+    ParamUtils.addDefinitions(swagger, f1);
+    ParamUtils.addDefinitions(swagger, f2);
+  }
 }
diff --git a/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/pojo/TestType1.java b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/pojo/TestType1.java
new file mode 100644
index 0000000..ffaf29f
--- /dev/null
+++ b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/pojo/TestType1.java
@@ -0,0 +1,25 @@
+/*
+ * 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.
+ */
+
+package org.apache.servicecomb.swagger.generator.core.pojo;
+
+import io.swagger.annotations.ApiModel;
+
+@ApiModel("XXX")
+public class TestType1 {
+  Integer val1;
+}
diff --git a/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/pojo/TestType2.java b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/pojo/TestType2.java
new file mode 100644
index 0000000..9dab202
--- /dev/null
+++ b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/generator/core/pojo/TestType2.java
@@ -0,0 +1,25 @@
+/*
+ * 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.
+ */
+
+package org.apache.servicecomb.swagger.generator.core.pojo;
+
+import io.swagger.annotations.ApiModel;
+
+@ApiModel("XXX")
+public class TestType2 {
+  String val2;
+}