Work on #51 - Replace shared API classes with codegen from OpenAPI/JSON schema - implemented FtgoApiDependencyResolverPlugin to 'download' and unpack API specification JARs

Author: cer

buildSrc/src/main/groovy/FtgoApiDependencyResolverPlugin.groovy

@@ -0,0 +1,21 @@
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+
+class FtgoApiDependencyResolverPlugin implements Plugin<Project> {
+
+    @Override
+    void apply(Project project) {
+
+        project.ext.ftgoApiSpecsDir = "${project.buildDir}/ftgo-api-specs"
+
+        def c = project.configurations.create('ftgoApiSpecification')
+
+        project.configurations.implementation.extendsFrom(c)
+
+        project.task("ftgoResolveAPIDependencies",
+                type: FtgoResolveAPIDependencies,
+                group: 'build setup',
+                description: "fetch API dependencies")
+    }
+
+}

buildSrc/src/main/groovy/FtgoJSONSchema2PojoPlugin.groovy

@@ -5,6 +5,9 @@ class FtgoJSONSchema2PojoPlugin implements Plugin<Project> {
 
     @Override
     void apply(Project project) {
+
+        project.apply(plugin: FtgoApiDependencyResolverPlugin)
+
         def jsonSchemaSources = project.container(JSONSchemaSource)
         project.extensions.add('ftgoJsonSchema2Pojo', jsonSchemaSources)
 
@@ -19,6 +22,7 @@ class FtgoJSONSchema2PojoPlugin implements Plugin<Project> {
 
             source.codeGen.targetDirectory = new File(project.buildDir, "generated-js2p-code-${source.name}")
 
+            source.codeGen.dependsOn(project.tasks.ftgoResolveAPIDependencies)
 
             project.afterEvaluate {
                 project.sourceSets[source.sourceSet].java.srcDirs += [source.codeGen.targetDirectory]

buildSrc/src/main/groovy/FtgoResolveAPIDependencies.groovy

@@ -0,0 +1,21 @@
+import org.gradle.api.tasks.Sync
+
+class FtgoResolveAPIDependencies extends Sync {
+
+    FtgoResolveAPIDependencies() {
+
+
+        from {
+            project.configurations.ftgoApiSpecification.resolve().collect {
+                project.zipTree(it)
+            }
+        }
+        include("**/*.json")
+        exclude("**/META-INF/**")
+        into(project.ext.ftgoApiSpecsDir )
+
+        includeEmptyDirs = false
+
+    }
+
+}

ftgo-accounting-service-api/src/main/resources/messages/AuthorizeCommand.json renamed to ftgo-accounting-service-api-spec/src/main/resources/messages/AuthorizeCommand.json

@@ -10,6 +10,16 @@
             </basic>
         </attributes>
     </embeddable>
+    <embeddable class="net.chrisrichardson.ftgo.common.PersonName" access="FIELD">
+        <attributes>
+            <basic name="firstName">
+                <column name="firstName"/>
+            </basic>
+            <basic name="lastName">
+                <column name="lastName"/>
+            </basic>
+        </attributes>
+    </embeddable>
     <embeddable class="net.chrisrichardson.ftgo.common.Address" access="FIELD">
         <attributes>
             <basic name="street1">

ftgo-common-jpa/src/main/resources/META-INF/orm.xml

@@ -4,6 +4,8 @@ dependencies {
 
     compile "org.springframework.boot:spring-boot-starter-data-jpa:$springBootVersion"
 
+    // compile "org.springframework.boot:spring-boot-starter:$springBootVersion"
+
     compile "io.eventuate.common:eventuate-common-json-mapper:$eventuateCommonVersion"
 
     testCompile "org.springframework.boot:spring-boot-starter-test:$springBootVersion"

ftgo-common/build.gradle

@@ -1,8 +1,5 @@
 package net.chrisrichardson.ftgo.common;
 
-import javax.persistence.Embeddable;
-
-@Embeddable
 public class PersonName {
   private String firstName;
   private String lastName;

ftgo-common/src/main/java/net/chrisrichardson/ftgo/common/PersonName.java

@@ -16,6 +16,7 @@ dependencies {
 
     compile project(":common-swagger")
     compile project(":ftgo-consumer-service-api")
+    compile project(":ftgo-consumer-service-api-spec")
 
     compile "org.springframework.boot:spring-boot-starter-data-jpa:$springBootVersion"
     compile "org.springframework.boot:spring-boot-starter-web:$springBootVersion"

ftgo-consumer-service-api/src/main/resources/ValidateOrderByConsumer.json renamed to ftgo-consumer-service-api-spec/src/main/resources/ValidateOrderByConsumer.json

@@ -6,6 +6,7 @@
 import org.everit.json.schema.loader.SchemaLoader;
 import org.json.JSONObject;
 import org.json.JSONTokener;
+import org.springframework.util.Assert;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -23,6 +24,8 @@ public ValidatingJSONMapper(Schema schema) {
   public static ValidatingJSONMapper forSchema(String schemaPath) {
     Schema schema;
     try (InputStream inputStream = ValidatingJSONMapper.class.getResourceAsStream(schemaPath)) {
+      if (inputStream == null)
+        fail("Can't find schema: " + schemaPath);
       JSONObject rawSchema = new JSONObject(new JSONTokener(inputStream));
       schema = SchemaLoader.load(rawSchema);
     } catch (IOException e) {

ftgo-consumer-service-api/src/main/resources/ftgo-consumer-service-swagger.json renamed to ftgo-consumer-service-api-spec/src/main/resources/ftgo-consumer-service-swagger.json

@@ -3,14 +3,15 @@ plugins {
 }
 
 apply plugin: 'docker-compose'
+apply plugin: FtgoApiDependencyResolverPlugin
 
 dependencies {
   swaggerCodegen 'org.openapitools:openapi-generator-cli:3.3.4'     // or OpenAPI Generator
 }
 
 swaggerSources {
   consumerService {
-    inputFile = file('../ftgo-consumer-service-api/src/main/resources/ftgo-consumer-service-swagger.json')
+    inputFile = file("${ftgoApiSpecsDir}/ftgo-consumer-service-swagger.json")
     code {
       language = 'java'
       configFile = file('swagger-codegen-config/consumer-service.json')
@@ -20,6 +21,8 @@ swaggerSources {
   }
 }
 
+swaggerSources.consumerService.code.dependsOn ftgoResolveAPIDependencies
+
 compileJava.dependsOn swaggerSources.consumerService.code
 
 sourceSets.main.java.srcDir "${swaggerSources.consumerService.code.outputDir}/src/main/java"
@@ -29,6 +32,8 @@ sourceSets.main.java.srcDir "${swaggerSources.consumerService.code.outputDir}/sr
 sourceSets.main.resources.srcDir "${swaggerSources.consumerService.code.outputDir}/src/main/resources"
 
 dependencies {
+    ftgoApiSpecification project(":ftgo-consumer-service-api-spec")
+
     compile project(":ftgo-accounting-service-api")
     compile project(":ftgo-consumer-service-api")
     compile project(":ftgo-kitchen-service-api")

ftgo-consumer-service/build.gradle

@@ -35,7 +35,6 @@ apply plugin: ComponentTestsPlugin
 
 apply plugin: FtgoJSONSchema2PojoPlugin
 
-
 dependencyManagement {
     imports {
         mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:$springCloudContractDependenciesVersion"
@@ -114,9 +113,10 @@ idea {
     }
 }
 
-
 dependencies {
 
+    ftgoApiSpecification project(":ftgo-consumer-service-api-spec")
+    ftgoApiSpecification project(":ftgo-accounting-service-api-spec")
 
     compile project(":common-swagger")
     compile project(":ftgo-common-jpa")
@@ -133,6 +133,7 @@ dependencies {
     compile project(":ftgo-restaurant-service-api")
     compile project(":ftgo-order-service-api")
 
+
     compile "org.springframework.boot:spring-boot-starter-data-jpa:$springBootVersion"
     compile "org.springframework.boot:spring-boot-starter-actuator:$springBootVersion"
     compile "io.micrometer:micrometer-registry-prometheus:$micrometerVersion"
@@ -182,14 +183,14 @@ dependencies {
 ftgoJsonSchema2Pojo {
 
     ftgoConsumerService {
-        source = files("../ftgo-consumer-service-api/src/main/resources/ValidateOrderByConsumer.json")
+        source = files("${ftgoApiSpecsDir}/ValidateOrderByConsumer.json")
         targetPackage = "net.chrisrichardson.ftgo.consumerservice.api"
         includeAdditionalProperties = false
         generateBuilders = true
         useLongIntegers = true
     }
     ftgoAccountingService {
-        source = files("../ftgo-accounting-service-api/src/main/resources/messages")
+        source = files("${ftgoApiSpecsDir}/messages")
         targetPackage = "net.chrisrichardson.ftgo.accountservice.api"
         includeAdditionalProperties = false
         generateBuilders = true

ftgo-consumer-service/src/test/java/net/chrisrichardson/ftgo/consumerservice/api/ValidatingJSONMapper.java

@@ -15,10 +15,12 @@ include "ftgo-kitchen-service"
 include "ftgo-kitchen-service-contracts"
 
 include "ftgo-accounting-service-api"
+include "ftgo-accounting-service-api-spec"
 include "ftgo-accounting-service"
 include "ftgo-accounting-service-contracts"
 
 include "ftgo-consumer-service-api"
+include "ftgo-consumer-service-api-spec"
 include "ftgo-consumer-service"
 include "ftgo-consumer-service-contracts"