Rename package

gcatanese · gcatanese · commit 6d3b8b2db10f · 2023-12-27T16:48:56.000+01:00
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
          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.github</groupId>
+    <groupId>com.apiflows</groupId>
     <artifactId>openapi-workflow-parser</artifactId>
     <version>1.0.0-SNAPSHOT</version>
 
diff --git a/src/main/java/com/apiflows/model/Components.java b/src/main/java/com/apiflows/model/Components.java
@@ -1,4 +1,4 @@
-package com.github.model;
+package com.apiflows.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
diff --git a/src/main/java/com/apiflows/model/Info.java b/src/main/java/com/apiflows/model/Info.java
@@ -1,4 +1,4 @@
-package com.github.model;
+package com.apiflows.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
diff --git a/src/main/java/com/apiflows/model/InputComponent.java b/src/main/java/com/apiflows/model/InputComponent.java
@@ -1,4 +1,4 @@
-package com.github.model;
+package com.apiflows.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
diff --git a/src/main/java/com/apiflows/model/OpenAPIWorkflow.java b/src/main/java/com/apiflows/model/OpenAPIWorkflow.java
@@ -1,14 +1,15 @@
-package com.github.model;
+package com.apiflows.model;
 
+import java.util.ArrayList;
 import java.util.List;
 
 public class OpenAPIWorkflow {
 
     private String location;
     private String workflowsSpec;
     private Info info;
-    private List<SourceDescription> sourceDescriptions;
-    private List<Workflow> workflows;
+    private List<SourceDescription> sourceDescriptions = new ArrayList<>();
+    private List<Workflow> workflows = new ArrayList<>();
     private Components components;
 
     public String getLocation() {
diff --git a/src/main/java/com/apiflows/model/Outputs.java b/src/main/java/com/apiflows/model/Outputs.java
@@ -0,0 +1,17 @@
+package com.apiflows.model;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class Outputs {
+
+    private Map<String, String> outputs = new HashMap<>();
+
+    public Map<String, String> getOutputs() {
+        return outputs;
+    }
+
+    public void setOutputs(Map<String, String> outputs) {
+        this.outputs = outputs;
+    }
+}
diff --git a/src/main/java/com/apiflows/model/Parameter.java b/src/main/java/com/apiflows/model/Parameter.java
@@ -1,4 +1,4 @@
-package com.github.model;
+package com.apiflows.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
diff --git a/src/main/java/com/apiflows/model/ParameterComponent.java b/src/main/java/com/apiflows/model/ParameterComponent.java
@@ -1,4 +1,4 @@
-package com.github.model;
+package com.apiflows.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
diff --git a/src/main/java/com/apiflows/model/SourceDescription.java b/src/main/java/com/apiflows/model/SourceDescription.java
@@ -1,4 +1,4 @@
-package com.github.model;
+package com.apiflows.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
diff --git a/src/main/java/com/apiflows/model/Step.java b/src/main/java/com/apiflows/model/Step.java
@@ -1,9 +1,11 @@
-package com.github.model;
+package com.apiflows.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.swagger.v3.oas.models.Operation;
 
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 public class Step {
 
@@ -17,7 +19,7 @@ public class Step {
     private String dependsOn;
     private List<Parameter> parameters;
     private List<SuccessCriterion> successCriteria;
-    private Outputs outputs;
+    private Map<String, String> outputs = new HashMap<>();
 
     @JsonProperty("stepId")
     public String getStepId() {
@@ -104,12 +106,11 @@ public void setSuccessCriteria(List<SuccessCriterion> successCriteria) {
         this.successCriteria = successCriteria;
     }
 
-    @JsonProperty("outputs")
-    public Outputs getOutputs() {
+    public Map<String, String> getOutputs() {
         return outputs;
     }
 
-    public void setOutputs(Outputs outputs) {
+    public void setOutputs(Map<String, String> outputs) {
         this.outputs = outputs;
     }
 }
diff --git a/src/main/java/com/apiflows/model/SuccessCriterion.java b/src/main/java/com/apiflows/model/SuccessCriterion.java
@@ -1,4 +1,4 @@
-package com.github.model;
+package com.apiflows.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
diff --git a/src/main/java/com/apiflows/model/Workflow.java b/src/main/java/com/apiflows/model/Workflow.java
@@ -1,17 +1,21 @@
-package com.github.model;
+package com.apiflows.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.models.media.Schema;
 
+import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 public class Workflow {
 
     private String workflowId;
     private String summary;
     private String description;
-    private Inputs inputs;
-    private List<Step> steps;
-    private Outputs outputs;
+    private Schema inputs;
+    private List<Step> steps = new ArrayList<>();
+    private Map<String, String> outputs = new HashMap<>();
 
     @JsonProperty("workflowId")
     public String getWorkflowId() {
@@ -41,11 +45,11 @@ public void setDescription(String description) {
     }
 
     @JsonProperty("inputs")
-    public Inputs getInputs() {
+    public Schema getInputs() {
         return inputs;
     }
 
-    public void setInputs(Inputs inputs) {
+    public void setInputs(Schema inputs) {
         this.inputs = inputs;
     }
 
@@ -59,11 +63,11 @@ public void setSteps(List<Step> steps) {
     }
 
     @JsonProperty("outputs")
-    public Outputs getOutputs() {
+    public Map<String, String> getOutputs() {
         return outputs;
     }
 
-    public void setOutputs(Outputs outputs) {
+    public void setOutputs(Map<String, String> outputs) {
         this.outputs = outputs;
     }
 }
diff --git a/src/main/java/com/apiflows/parser/OpenAPIWorkflowParser.java b/src/main/java/com/apiflows/parser/OpenAPIWorkflowParser.java
@@ -1,22 +1,18 @@
-package com.github.parser;
+package com.apiflows.parser;
 
+import com.apiflows.model.OpenAPIWorkflow;
+import com.apiflows.parser.source.OperationBinder;
+import com.apiflows.parser.source.WorkflowBinder;
+import com.apiflows.parser.util.HttpUtil;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
-import com.github.model.OpenAPIWorkflow;
-import com.github.parser.source.OperationBinder;
-import com.github.parser.source.WorkflowBinder;
-import com.github.parser.util.HttpUtil;
-import com.github.parser.util.PathUtil;
+import com.apiflows.parser.util.PathUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.io.IOException;
-import java.nio.file.Files;
-import java.nio.file.Paths;
-
 public class OpenAPIWorkflowParser {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(OpenAPIWorkflowParser.class);
diff --git a/src/main/java/com/apiflows/parser/OpenAPIWorkflowParserResult.java b/src/main/java/com/apiflows/parser/OpenAPIWorkflowParserResult.java
@@ -1,6 +1,6 @@
-package com.github.parser;
+package com.apiflows.parser;
 
-import com.github.model.OpenAPIWorkflow;
+import com.apiflows.model.OpenAPIWorkflow;
 
 public class OpenAPIWorkflowParserResult {
 
diff --git a/src/main/java/com/apiflows/parser/OpenAPIWorkflowValidator.java b/src/main/java/com/apiflows/parser/OpenAPIWorkflowValidator.java
@@ -1,9 +1,9 @@
-package com.github.parser;
+package com.apiflows.parser;
 
-import com.github.model.OpenAPIWorkflow;
-import com.github.model.SourceDescription;
-import com.github.model.Step;
-import com.github.model.Workflow;
+import com.apiflows.model.Step;
+import com.apiflows.model.Workflow;
+import com.apiflows.model.OpenAPIWorkflow;
+import com.apiflows.model.SourceDescription;
 
 public class OpenAPIWorkflowValidator {
 
diff --git a/src/main/java/com/apiflows/parser/source/OperationBinder.java b/src/main/java/com/apiflows/parser/source/OperationBinder.java
@@ -1,12 +1,9 @@
-package com.github.parser.source;
-
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.node.TextNode;
-import com.github.model.OpenAPIWorkflow;
-import com.github.model.SourceDescription;
-import com.github.model.Step;
-import com.github.model.Workflow;
+package com.apiflows.parser.source;
+
+import com.apiflows.model.OpenAPIWorkflow;
+import com.apiflows.model.SourceDescription;
+import com.apiflows.model.Step;
+import com.apiflows.model.Workflow;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.PathItem;
@@ -16,9 +13,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.io.IOException;
-import java.net.MalformedURLException;
-import java.net.URL;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.ArrayList;
diff --git a/src/main/java/com/apiflows/parser/source/WorkflowBinder.java b/src/main/java/com/apiflows/parser/source/WorkflowBinder.java
@@ -1,8 +1,8 @@
-package com.github.parser.source;
+package com.apiflows.parser.source;
 
-import com.github.model.OpenAPIWorkflow;
-import com.github.model.Step;
-import com.github.model.Workflow;
+import com.apiflows.model.Step;
+import com.apiflows.model.OpenAPIWorkflow;
+import com.apiflows.model.Workflow;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
diff --git a/src/main/java/com/apiflows/parser/util/HttpUtil.java b/src/main/java/com/apiflows/parser/util/HttpUtil.java
@@ -1,4 +1,4 @@
-package com.github.parser.util;
+package com.apiflows.parser.util;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
diff --git a/src/main/java/com/apiflows/parser/util/PathUtil.java b/src/main/java/com/apiflows/parser/util/PathUtil.java
@@ -1,4 +1,4 @@
-package com.github.parser.util;
+package com.apiflows.parser.util;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
diff --git a/src/main/java/com/github/model/Inputs.java b/src/main/java/com/github/model/Inputs.java
diff --git a/src/main/java/com/github/model/Outputs.java b/src/main/java/com/github/model/Outputs.java
diff --git a/src/test/java/com/apiflows/parser/OpenAPIWorkflowParserTest.java b/src/test/java/com/apiflows/parser/OpenAPIWorkflowParserTest.java
@@ -0,0 +1,68 @@
+package com.apiflows.parser;
+
+import com.apiflows.model.Step;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
+
+class OpenAPIWorkflowParserTest {
+
+    private OpenAPIWorkflowParser parser = new OpenAPIWorkflowParser();
+
+    @Test
+    void parse() {
+        final String WORKFLOWS_SPEC_FILE = "src/test/resources/1.0.0/pet-coupons.workflow.yaml";
+
+        OpenAPIWorkflowParserResult result = parser.parse(WORKFLOWS_SPEC_FILE);
+        assertNotNull(result.getOpenAPIWorkflow());
+        assertEquals("1.0.0", result.getOpenAPIWorkflow().getWorkflowsSpec());
+        assertNotNull(result.getOpenAPIWorkflow().getInfo());
+        assertEquals("Petstore - Apply Coupons", result.getOpenAPIWorkflow().getInfo().getTitle());
+        assertNotNull(result.getOpenAPIWorkflow().getComponents());
+
+        assertNotNull(result.getOpenAPIWorkflow().getWorkflows());
+        assertNotNull(result.getOpenAPIWorkflow().getWorkflows().get(0));
+        // inputs
+        assertNotNull(result.getOpenAPIWorkflow().getWorkflows().get(0).getInputs());
+        assertNotNull(result.getOpenAPIWorkflow().getWorkflows().get(0).getInputs().get$ref());
+        assertNull(result.getOpenAPIWorkflow().getWorkflows().get(0).getInputs().getProperties());
+
+    }
+
+    @Test
+    void parseFromUrl() {
+        final String WORKFLOWS_SPEC_FILE = "https://raw.githubusercontent.com/OAI/sig-workflows/main/examples/1.0.0/pet-coupons.workflow.yaml";
+
+        OpenAPIWorkflowParserResult result = parser.parse(WORKFLOWS_SPEC_FILE);
+        assertNotNull(result.getOpenAPIWorkflow());
+        assertEquals("1.0.0", result.getOpenAPIWorkflow().getWorkflowsSpec());
+        assertNotNull(result.getOpenAPIWorkflow().getInfo());
+        assertEquals("Petstore - Apply Coupons", result.getOpenAPIWorkflow().getInfo().getTitle());
+    }
+
+    @Test
+    void simpleWorkflow() {
+        final String WORKFLOWS_SPEC_FILE = "./src/test/resources/1.0.0/simple.workflow.yaml";
+
+        OpenAPIWorkflowParserResult result = parser.parse(WORKFLOWS_SPEC_FILE);
+        assertNotNull(result.getOpenAPIWorkflow());
+        assertNotNull(result.getOpenAPIWorkflow().getInfo());
+        assertEquals("simple", result.getOpenAPIWorkflow().getInfo().getTitle());
+
+        assertNotNull(result.getOpenAPIWorkflow().getWorkflows());
+        assertEquals(1, result.getOpenAPIWorkflow().getWorkflows().size());
+        // 2 inputs
+        assertNotNull(result.getOpenAPIWorkflow().getWorkflows().get(0).getInputs());
+        assertEquals(2, result.getOpenAPIWorkflow().getWorkflows().get(0).getInputs().getProperties().size());
+        // 1 output
+        assertNotNull(result.getOpenAPIWorkflow().getWorkflows().get(0).getOutputs());
+        assertEquals(1, result.getOpenAPIWorkflow().getWorkflows().get(0).getOutputs().size());
+        // 1 step
+        assertNotNull(result.getOpenAPIWorkflow().getWorkflows().get(0).getSteps());
+        assertEquals(1, result.getOpenAPIWorkflow().getWorkflows().get(0).getSteps().size());
+        Step step = result.getOpenAPIWorkflow().getWorkflows().get(0).getSteps().get(0);
+        assertNotNull(step);
+        assertEquals(2, step.getOutputs().size());
+    }
+
+
+}
diff --git a/src/test/java/com/apiflows/parser/source/OperationBinderTest.java b/src/test/java/com/apiflows/parser/source/OperationBinderTest.java
diff --git a/src/test/java/com/apiflows/parser/source/WorkflowBinderTest.java b/src/test/java/com/apiflows/parser/source/WorkflowBinderTest.java
diff --git a/src/test/java/com/apiflows/parser/util/HttpUtilTest.java b/src/test/java/com/apiflows/parser/util/HttpUtilTest.java
diff --git a/src/test/java/com/apiflows/parser/util/PathUtilTest.java b/src/test/java/com/apiflows/parser/util/PathUtilTest.java
diff --git a/src/test/java/com/github/parser/OpenAPIWorkflowParserTest.java b/src/test/java/com/github/parser/OpenAPIWorkflowParserTest.java
diff --git a/src/test/resources/1.0.0/pet-coupons.openapi.yaml b/src/test/resources/1.0.0/pet-coupons.openapi.yaml
diff --git a/src/test/resources/1.0.0/pet-coupons.workflow.yaml b/src/test/resources/1.0.0/pet-coupons.workflow.yaml
diff --git a/src/test/resources/1.0.0/simple.workflow.yaml b/src/test/resources/1.0.0/simple.workflow.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.github.model;`
	`1`	`+package com.apiflows.model;`
`2`	`2`
`3`	`3`	`import com.fasterxml.jackson.annotation.JsonProperty;`
`4`	`4`