Merge branch 'dev_openapiplugin' into master

devonfw · Sep 14, 2020 · 54cab73 · 54cab73
2 parents 2faaef0 + 844ee8d
commit 54cab73
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 48 deletions.
diff --git a/cobigen/cobigen-openapiplugin-parent/cobigen-openapiplugin-model/pom.xml b/cobigen/cobigen-openapiplugin-parent/cobigen-openapiplugin-model/pom.xml
@@ -1,7 +1,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <artifactId>openapiplugin-model</artifactId>
-  <version>2.4.0</version>
+  <version>7.0.0</version>
   <name>CobiGen Openapiplugin Model</name>
   <packaging>jar</packaging>
   <description>CobiGen - OpenAPI Plug-in Model</description>

diff --git a/cobigen/cobigen-openapiplugin-parent/cobigen-openapiplugin/pom.xml b/cobigen/cobigen-openapiplugin-parent/cobigen-openapiplugin/pom.xml
@@ -2,7 +2,7 @@
   <modelVersion>4.0.0</modelVersion>
   <artifactId>openapiplugin</artifactId>
   <name>CobiGen - Open API Plug-in</name>
-  <version>2.4.0</version>
+  <version>7.0.0</version>
   <packaging>jar</packaging>
   <description>CobiGen - OpenAPI Plug-in</description>
 
@@ -17,16 +17,16 @@
   </properties>
 
   <dependencies>
-  <dependency>
+    <dependency>
       <groupId>com.devonfw.cobigen</groupId>
       <artifactId>openapiplugin-model</artifactId>
       <version>${project.version}</version>
     </dependency>
-    
+
     <dependency>
       <groupId>com.devonfw.cobigen</groupId>
       <artifactId>core-api</artifactId>
-      <version>5.3.0</version>
+      <version>[7.0.0,)</version>
     </dependency>
     <dependency>
       <groupId>com.reprezen.kaizen</groupId>
@@ -43,31 +43,31 @@
     <dependency>
       <groupId>com.devonfw.cobigen</groupId>
       <artifactId>core-test</artifactId>
-      <version>6.0.0</version>
+      <version>7.0.0</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>com.devonfw.cobigen</groupId>
       <artifactId>core</artifactId>
-      <version>6.0.0</version>
+      <version>7.0.0</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>com.devonfw.cobigen</groupId>
       <artifactId>tempeng-freemarker</artifactId>
-      <version>2.0.0</version>
+      <version>7.0.0</version>
       <scope>test</scope>
     </dependency>
   </dependencies>
   <build>
-  <resources> 
-    <resource>
-      <directory>src/main/resources</directory>
-      <filtering>false</filtering>
-      <excludes>
-        <exclude>**/META-INF/LICENSEP2BUNDLE.html</exclude>
-      </excludes>
-    </resource>
-  </resources>
-</build>
+    <resources>
+      <resource>
+        <directory>src/main/resources</directory>
+        <filtering>false</filtering>
+        <excludes>
+          <exclude>**/META-INF/LICENSEP2BUNDLE.html</exclude>
+        </excludes>
+      </resource>
+    </resources>
+  </build>
 </project>
diff --git a/...openapiplugin/src/main/java/com/devonfw/cobigen/openapiplugin/OpenAPIPluginActivator.java b/...openapiplugin/src/main/java/com/devonfw/cobigen/openapiplugin/OpenAPIPluginActivator.java
@@ -2,14 +2,17 @@
 
 import java.util.List;
 
+import com.devonfw.cobigen.api.annotation.Activation;
 import com.devonfw.cobigen.api.extension.GeneratorPluginActivator;
 import com.devonfw.cobigen.api.extension.Merger;
 import com.devonfw.cobigen.api.extension.TriggerInterpreter;
+import com.devonfw.cobigen.openapiplugin.inputreader.OpenAPIInputReader;
 import com.google.common.collect.Lists;
 
 /**
  * Plug-in activator to be registered at CobiGen.
  */
+@Activation(byFileExtension = { OpenAPIInputReader.VALID_EXTENSION_YAML, OpenAPIInputReader.VALID_EXTENSION_YML })
 public class OpenAPIPluginActivator implements GeneratorPluginActivator {
 
     /**

diff --git a/...napiplugin/src/main/java/com/devonfw/cobigen/openapiplugin/OpenAPITriggerInterpreter.java b/...napiplugin/src/main/java/com/devonfw/cobigen/openapiplugin/OpenAPITriggerInterpreter.java
@@ -1,14 +1,17 @@
 package com.devonfw.cobigen.openapiplugin;
 
+import com.devonfw.cobigen.api.annotation.ReaderPriority;
 import com.devonfw.cobigen.api.extension.InputReader;
 import com.devonfw.cobigen.api.extension.MatcherInterpreter;
+import com.devonfw.cobigen.api.extension.Priority;
 import com.devonfw.cobigen.api.extension.TriggerInterpreter;
 import com.devonfw.cobigen.openapiplugin.inputreader.OpenAPIInputReader;
 import com.devonfw.cobigen.openapiplugin.matcher.OpenAPIMatcher;
 
 /**
  * {@link TriggerInterpreter} implementation of a Swagger Interpreter
  */
+@ReaderPriority(Priority.LOW)
 public class OpenAPITriggerInterpreter implements TriggerInterpreter {
 
     /**

diff --git a/...lugin/src/main/java/com/devonfw/cobigen/openapiplugin/inputreader/OpenAPIInputReader.java b/...lugin/src/main/java/com/devonfw/cobigen/openapiplugin/inputreader/OpenAPIInputReader.java
@@ -33,7 +33,6 @@
 import com.devonfw.cobigen.openapiplugin.model.ResponseDef;
 import com.devonfw.cobigen.openapiplugin.model.ServerDef;
 import com.devonfw.cobigen.openapiplugin.util.constants.Constants;
-import com.jayway.jsonpath.Configuration;
 import com.reprezen.jsonoverlay.JsonOverlay;
 import com.reprezen.jsonoverlay.Overlay;
 import com.reprezen.jsonoverlay.Reference;
@@ -55,6 +54,12 @@
  */
 public class OpenAPIInputReader implements InputReader {
 
+    /** Valid extensions for the input reader */
+    public static final String VALID_EXTENSION_YAML = "yaml";
+
+    /** Valid extensions for the input reader */
+    public static final String VALID_EXTENSION_YML = "yml";
+
     /**
      * Components retrieved from an EntityDef. Used for not executing multiple times the retrieval of
      * components
@@ -215,7 +220,6 @@ private ComponentDef getComponent(String componentName) {
      * @return list of entities
      */
     private List<EntityDef> extractComponents(OpenApi3 openApi) {
-        Object document = Configuration.defaultConfiguration().jsonProvider().parse(Overlay.toJson(openApi).toString());
         HeaderDef header = new HeaderDef();
         header.setServers(extractServers(openApi));
         header.setInfo(extractInfo(openApi));
@@ -227,7 +231,7 @@ private List<EntityDef> extractComponents(OpenApi3 openApi) {
             entityDef.setName(key);
             entityDef.setDescription(openApi.getSchema(key).getDescription());
             ComponentDef componentDef = new ComponentDef();
-            entityDef.setProperties(extractProperties(openApi, document, key));
+            entityDef.setProperties(extractProperties(openApi, key));
 
             // If no x-component tag was found on the input file, throw invalid configuration
             if (openApi.getSchema(key).getExtensions().get(Constants.COMPONENT_EXT) == null) {
@@ -348,13 +352,11 @@ private PropertyDef extractReferenceProperty(OpenApi3 openApi, Schema componentS
      *
      * @param openApi
      *            the OpenApi3 model
-     * @param jsonDocument
-     *            parsed JSON document
      * @param componentName
      *            entity name
      * @return List of {@link PropertyDef}'s
      */
-    private List<PropertyDef> extractProperties(OpenApi3 openApi, Object jsonDocument, String componentName) {
+    private List<PropertyDef> extractProperties(OpenApi3 openApi, String componentName) {
         Schema componentSchema = openApi.getSchema(componentName);
         Map<String, ? extends Schema> properties = componentSchema.getProperties();
         List<PropertyDef> objects = new LinkedList<>();
@@ -698,7 +700,7 @@ public Object read(java.nio.file.Path path, Charset inputCharset, Object... addi
 
     @Override
     public boolean isMostLikelyReadable(java.nio.file.Path path) {
-        List<String> validExtensions = Arrays.asList("yaml", "yml");
+        List<String> validExtensions = Arrays.asList(VALID_EXTENSION_YAML, VALID_EXTENSION_YML);
         String fileExtension = FilenameUtils.getExtension(path.toString()).toLowerCase();
         return validExtensions.contains(fileExtension);
     }

diff --git a/...c/test/java/com/devonfw/cobigen/openapiplugin/integrationtest/InputReaderMatcherTest.java b/...c/test/java/com/devonfw/cobigen/openapiplugin/integrationtest/InputReaderMatcherTest.java
@@ -15,7 +15,6 @@
 import com.devonfw.cobigen.api.to.GenerationReportTo;
 import com.devonfw.cobigen.api.to.TemplateTo;
 import com.devonfw.cobigen.impl.CobiGenFactory;
-import com.devonfw.cobigen.openapiplugin.model.OpenAPIFile;
 import com.devonfw.cobigen.openapiplugin.util.TestConstants;
 
 import junit.framework.AssertionFailedError;
@@ -42,8 +41,7 @@ public class InputReaderMatcherTest {
     public void testBasicElementMatcher_oneComponent() throws Exception {
         CobiGen cobigen = CobiGenFactory.create(Paths.get(testdataRoot, "templates").toUri());
 
-        Object openApiFile =
-            cobigen.read("openapi", Paths.get(testdataRoot, "one-component.yaml"), TestConstants.UTF_8);
+        Object openApiFile = cobigen.read(Paths.get(testdataRoot, "one-component.yaml"), TestConstants.UTF_8);
         assertThat(openApiFile).isNotNull();
 
         List<Object> inputObjects = cobigen.resolveContainers(openApiFile);
@@ -59,8 +57,7 @@ public void testBasicElementMatcher_oneComponent() throws Exception {
     public void testBasicElementMatcher_twoComponents() throws Exception {
         CobiGen cobigen = CobiGenFactory.create(Paths.get(testdataRoot, "templates").toUri());
 
-        Object openApiFile =
-            cobigen.read("openapi", Paths.get(testdataRoot, "two-components.yaml"), TestConstants.UTF_8);
+        Object openApiFile = cobigen.read(Paths.get(testdataRoot, "two-components.yaml"), TestConstants.UTF_8);
         assertThat(openApiFile).isNotNull();
 
         List<Object> inputObjects = cobigen.resolveContainers(openApiFile);
@@ -76,8 +73,7 @@ public void testBasicElementMatcher_twoComponents() throws Exception {
     public void testVariableAssignment_propertyName() throws Exception {
         CobiGen cobigen = CobiGenFactory.create(Paths.get(testdataRoot, "templates").toUri());
 
-        Object openApiFile =
-            cobigen.read("openapi", Paths.get(testdataRoot, "one-component.yaml"), TestConstants.UTF_8);
+        Object openApiFile = cobigen.read(Paths.get(testdataRoot, "one-component.yaml"), TestConstants.UTF_8);
         List<Object> inputObjects = cobigen.resolveContainers(openApiFile);
 
         String templateName = "testVariableAssignment_propertyName.txt";
@@ -101,8 +97,7 @@ public void testVariableAssignment_propertyName() throws Exception {
     public void testVariableAssignment_rootPackage() throws Exception {
         CobiGen cobigen = CobiGenFactory.create(Paths.get(testdataRoot, "templates").toUri());
 
-        Object openApiFile = cobigen.read("openapi", Paths.get(testdataRoot, "root-package.yaml"), TestConstants.UTF_8);
-        OpenAPIFile inputFile = (OpenAPIFile) openApiFile;
+        Object openApiFile = cobigen.read(Paths.get(testdataRoot, "root-package.yaml"), TestConstants.UTF_8);
 
         // Previous version: List<Object> inputObjects = cobigen.getInputObjects(openApiFile,
         // TestConstants.UTF_8);
@@ -119,18 +114,18 @@ public void testVariableAssignment_rootPackage() throws Exception {
             .hasContent("testingRootName");
     }
 
-    /*
+    /**
      * Tests variable assignment resolution of ROOTPACKAGE type, thus that the user can define the root
      * package in the "info" part of the OpenAPI file
      *
-     * @throws Exception test fails
+     * @throws Exception
+     *             test fails
      */
     @Test
     public void testVariableAssignment_rootComponent() throws Exception {
         CobiGen cobigen = CobiGenFactory.create(Paths.get(testdataRoot, "templates").toUri());
 
-        Object openApiFile = cobigen.read("openapi", Paths.get(testdataRoot, "root-package.yaml"), TestConstants.UTF_8);
-        OpenAPIFile inputFile = (OpenAPIFile) openApiFile;
+        Object openApiFile = cobigen.read(Paths.get(testdataRoot, "root-package.yaml"), TestConstants.UTF_8);
 
         // Previous version: List<Object> inputObjects = cobigen.getInputObjects(openApiFile,
         // TestConstants.UTF_8);
@@ -160,9 +155,7 @@ public void testVariableAssignment_rootComponent() throws Exception {
     public void testVariableAssignment_attribute() throws Exception {
         CobiGen cobigen = CobiGenFactory.create(Paths.get(testdataRoot, "templates").toUri());
 
-        Object openApiFile =
-            cobigen.read("openapi", Paths.get(testdataRoot, "two-components.yaml"), TestConstants.UTF_8);
-        OpenAPIFile inputFile = (OpenAPIFile) openApiFile;
+        Object openApiFile = cobigen.read(Paths.get(testdataRoot, "two-components.yaml"), TestConstants.UTF_8);
 
         // Previous version: List<Object> inputObjects = cobigen.getInputObjects(openApiFile,
         // TestConstants.UTF_8);
@@ -201,8 +194,7 @@ public void testVariableAssignment_noAttributeFound() throws Exception {
         CobiGen cobigen = CobiGenFactory.create(Paths.get(testdataRoot, "templates").toUri());
 
         Object openApiFile =
-            cobigen.read("openapi", Paths.get(testdataRoot, "two-components-no-attribute.yaml"), TestConstants.UTF_8);
-        OpenAPIFile inputFile = (OpenAPIFile) openApiFile;
+            cobigen.read(Paths.get(testdataRoot, "two-components-no-attribute.yaml"), TestConstants.UTF_8);
 
         // Previous version: List<Object> inputObjects = cobigen.getInputObjects(openApiFile,
         // TestConstants.UTF_8);

diff --git a/cobigen/cobigen-openapiplugin-parent/pom.xml b/cobigen/cobigen-openapiplugin-parent/pom.xml
@@ -1,9 +1,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
-  <groupId>com.devonfw.cobigen</groupId>
   <artifactId>openapiplugin-parent</artifactId>
-  <version>dev-SNAPSHOT</version>
   <packaging>pom</packaging>
   <name>CobiGen Openapiplugin Parent</name>
 

diff --git a/cobigen/pom.xml b/cobigen/pom.xml
@@ -101,7 +101,7 @@
 
   <profiles>
     <profile>
-      <id>p2-bundle</id>      <!-- Bundle and P2 -->
+      <id>p2-bundle</id> <!-- Bundle and P2 -->
       <build>
         <plugins>
           <plugin>
@@ -139,7 +139,7 @@
                 <Embed-Transitive>true</Embed-Transitive>
                 <Bundle-Name>${project.name}</Bundle-Name>
                 <Include-Resource>
-                  {maven-resources}, {maven-dependencies}, {META-INF/LICENSE.html=src/main/resources/META-INF/LICENSEP2BUNDLE.html}
+		    {maven-resources}, {maven-dependencies}, {META-INF/LICENSE.html=src/main/resources/META-INF/LICENSEP2BUNDLE.html}
                 </Include-Resource>
                 <niceManifest>true</niceManifest>
                 <Import-Package></Import-Package>

diff --git a/documentation/master-cobigen.asciidoc b/documentation/master-cobigen.asciidoc
@@ -25,7 +25,7 @@ DISCLAIMER: All Cobigen plugins are compatible with the latest release of Devonf
 * CobiGen - Text Merger v2.1.0
 * CobiGen - JSON Plug-in v7.0.0
 * CobiGen - HTML Plug-in v7.0.0
-* CobiGen - Open API Plug-in v2.4.0
+* CobiGen - Open API Plug-in v7.0.0
 * CobiGen - FreeMaker Template Engine v7.0.0
 * CobiGen - Velocity Template Engine v7.0.0