Initial add of APPC client libraries

Issue-ID: APPC-180
Change-Id: Ie0be2b518b90bb7f9996e9260c43fef75d1a5821
Signed-off-by: Skip Wonnell <kw5258@att.com>

3 files changed, 404 insertions, 0 deletions

diff --git a/appc-client/client-kit/src/test/java/json2java/Json2JavaGeneratorTest.java b/appc-client/client-kit/src/test/java/json2java/Json2JavaGeneratorTest.java
new file mode 100644
index 000000000..b5ded0283
--- /dev/null
+++ b/appc-client/client-kit/src/test/java/json2java/Json2JavaGeneratorTest.java
@@ -0,0 +1,171 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP : APPC
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Copyright (C) 2017 Amdocs
+ * =============================================================================
+ * Licensed 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.
+ * 
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ * ============LICENSE_END=========================================================
+ */
+
+package json2java;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+import org.openecomp.appc.generator.JsonHelper;
+
+import java.io.File;
+import java.io.IOException;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.util.*;
+import java.util.regex.Pattern;
+
+public class Json2JavaGeneratorTest {
+
+    private static JsonNode jsonNode = null;
+    private static final String MODEL_PACKAGE = "org.openecomp.appc.client.lcm.model";
+    private static final String GENERATED_LCM_API_CLASS = "org.openecomp.appc.client.lcm.api.LifeCycleManagerStateful";
+
+    //@Before
+    public void readIOfiles() throws IOException{
+        if(jsonNode == null){
+            jsonRead();
+        }
+
+    }
+
+    //@Test
+    public void testGeneratedJavaModel() {
+        Iterator<Map.Entry<String, JsonNode>> definitions = jsonNode.get("definitions").fields();
+        for (; definitions.hasNext(); ) {
+            Map.Entry<String, JsonNode> definitionEntry = definitions.next();
+            String definitionEntryKey = definitionEntry.getKey();
+            String className = MODEL_PACKAGE + "." + definitionEntryKey;
+            Class<?> generatedClass = null;
+            String errMsg = "the " + className + " was supposed to be generated, but not found";
+            try {
+                generatedClass = Class.forName(className);
+                Assert.assertNotNull(errMsg, generatedClass);
+            } catch (ClassNotFoundException e) {
+                Assert.fail(errMsg);
+            }
+
+            JsonNode properties = definitionEntry.getValue().get("properties");
+            if (generatedClass != null && properties != null && properties.fields() != null) {
+                Field[] declaredFields = generatedClass.getDeclaredFields();
+                Set<String> generatedFieldNames = new HashSet();
+                for(Field field : declaredFields){
+                    generatedFieldNames.add(field.getName().toLowerCase());
+                }
+                Iterator<Map.Entry<String, JsonNode>> propertiesFields = properties.fields();
+                int totalExpectedFields = 0;
+                for (; propertiesFields.hasNext(); ) {
+                    totalExpectedFields++;
+                    Map.Entry<String, JsonNode> propertyEntry = propertiesFields.next();
+                    String propertyEntryKey = propertyEntry.getKey();
+                    String fieldNameFromJson = propertyEntryKey.replaceAll(Pattern.quote("-"),"").toLowerCase();
+                    errMsg = "the field " + propertyEntryKey + " for " + className + " was supposed to be generated, but not found";
+                    boolean contains = generatedFieldNames.contains(fieldNameFromJson);
+                    Assert.assertTrue(errMsg, contains);
+                }
+                Assert.assertEquals("number of fields in "+className+" are not as expected!",totalExpectedFields,generatedFieldNames.size());
+            }
+        }
+    }
+
+    //@Test
+    public void testGeneratedJavaAPI() {
+        Map<String/*rpcOperation*/,Set<String> /*bodyInputParams*/> jsonBodyInputParams = new HashMap();
+        Map<String/*rpcOperation*/,Set<String> /*bodyOutputParams*/> jsonBodyOutputParams= new HashMap();
+        JsonHelper.populateRpcInputOutputSchemaRefFromJson(jsonNode,jsonBodyInputParams, jsonBodyOutputParams);
+        Assert.assertFalse(jsonBodyInputParams.isEmpty());
+        Assert.assertFalse(jsonBodyOutputParams.isEmpty());
+
+        //verify LifecycleManagementStatefulService was generated
+        Class<?> generatedClass = null;
+        String errMsg = "the " + GENERATED_LCM_API_CLASS + " was supposed to be generated, but not found";
+        try {
+            generatedClass = Class.forName(GENERATED_LCM_API_CLASS);
+            Assert.assertNotNull(errMsg, generatedClass);
+        } catch (ClassNotFoundException e) {
+            Assert.fail(errMsg);
+        }
+
+        //verify LifecycleManagementStatefulService was generated with methods
+        Method[] declaredMethods = generatedClass.getDeclaredMethods();
+        Assert.assertNotNull("no method was generated for "+GENERATED_LCM_API_CLASS,declaredMethods);
+
+        //verify correctness of input parameters and return type of each method
+        Set<String> generatedNonVoidMethods = new HashSet();
+        Set<String> generatedVoidMethods = new HashSet();
+        for(Method method : declaredMethods){
+            String returnType = method.getReturnType().getName();
+            Class<?>[] parameterTypes = method.getParameterTypes();
+            String methodName = method.getName().toLowerCase();
+            if(returnType.equals("void")){
+                generatedVoidMethods.add(methodName);
+            }else {
+                generatedNonVoidMethods.add(methodName);
+                //verify correctness of return type
+                String returnTypeSuffix = JsonHelper.getStringSuffix(returnType,".");
+                Set<String> jsonOutputParams = jsonBodyOutputParams.get(methodName);
+                Assert.assertNotNull(methodName+ " was not expected to return anything!",jsonOutputParams);
+                boolean contains = jsonOutputParams.contains(returnTypeSuffix);
+                Assert.assertTrue(methodName+ " was not expected to be with "+returnTypeSuffix+" return type!", contains);
+            }
+            //verify correctness of method input parameters
+            for (Class<?> parameterType :parameterTypes){
+                String parameterTypeSuffix = JsonHelper.getStringSuffix(parameterType.getName(), ".");
+                if(returnType.equals("void") && parameterTypeSuffix.equals("ResponseHandler")){
+                    continue;
+                }
+                Set<String> jsonInputParams = jsonBodyInputParams.get(methodName);
+                Assert.assertNotNull(methodName+ " was not expected to be with any input parameter!",jsonInputParams);
+                boolean contains = jsonInputParams.contains(parameterTypeSuffix);
+                Assert.assertTrue(methodName+ " was not expected to be with "+parameterTypeSuffix+" parameter!", contains);
+            }
+
+        }
+
+        //verify total number of generated methods is same as expected
+        Assert.assertEquals("Total number of generated methods are not as expected!!",jsonBodyInputParams.size()*2,declaredMethods.length);
+        //verify all expected methods(void and non void) were generated
+        for(Map.Entry<String, Set<String>> rpcInputParams : jsonBodyInputParams.entrySet()){
+            errMsg = "none void method " + rpcInputParams.getKey() + "(case insensitive) for " + GENERATED_LCM_API_CLASS + " was supposed to be generated, but not found";
+            boolean contains = generatedNonVoidMethods.contains(rpcInputParams.getKey());
+            Assert.assertTrue(errMsg, contains);
+
+            errMsg = "void method " + rpcInputParams.getKey() + "(case insensitive) for " + GENERATED_LCM_API_CLASS + " was supposed to be generated, but not found";
+            contains = generatedVoidMethods.contains(rpcInputParams.getKey());
+            Assert.assertTrue(errMsg, contains);
+        }
+
+    }
+
+
+    private static void jsonRead ()throws IOException {
+        String jsonFilePath = System.getProperty("outputFile");
+        File file = new File(jsonFilePath);
+        ObjectMapper mapper = new ObjectMapper();
+        jsonNode = mapper.readTree(file);
+    }
+
+}
diff --git a/appc-client/client-kit/src/test/java/org/openecomp/appc/generator/JsonHelper.java b/appc-client/client-kit/src/test/java/org/openecomp/appc/generator/JsonHelper.java
new file mode 100644
index 000000000..6d9bf628f
--- /dev/null
+++ b/appc-client/client-kit/src/test/java/org/openecomp/appc/generator/JsonHelper.java
@@ -0,0 +1,93 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP : APPC
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Copyright (C) 2017 Amdocs
+ * =============================================================================
+ * Licensed 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.
+ * 
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.appc.generator;
+
+import com.fasterxml.jackson.databind.JsonNode;
+
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Set;
+import java.util.regex.Pattern;
+
+public class JsonHelper {
+
+    private enum PopulateType{
+        PARAMETER,
+        SCHEMA_REF,
+        ;
+    }
+
+    public static void populateRpcInputOutputParamsFromJson(final JsonNode jsonNode, Map<String, Set<String>> jsonBodyInputParams, Map<String, Set<String>> jsonBodyOutputParams) {
+        populateRpcInputOutputParamsFromJson(jsonNode,jsonBodyInputParams, jsonBodyOutputParams,PopulateType.PARAMETER,false);
+    }
+    public static void populateRpcInputOutputSchemaRefFromJson(final JsonNode jsonNode, Map<String, Set<String>> jsonBodyInputParams, Map<String, Set<String>> jsonBodyOutputParams) {
+        populateRpcInputOutputParamsFromJson(jsonNode,jsonBodyInputParams, jsonBodyOutputParams,PopulateType.SCHEMA_REF,true);
+    }
+    public static void populateRpcInputOutputParamsFromJson(final JsonNode jsonNode, Map<String, Set<String>> jsonBodyInputParams, Map<String, Set<String>> jsonBodyOutputParams,PopulateType populateType,boolean normalizeRpcOperation) {
+        //get all yang2json Input and output Params and populate jsonBodyInputParams & jsonBodyOutputParams
+        for(Iterator<JsonNode> pathsElements = jsonNode.get("paths").elements(); pathsElements.hasNext(); ){
+            JsonNode pathNode = pathsElements.next();
+            String rpcOperation = pathNode.get("post").get("operationId").textValue();
+            String bodyInputSchemaRef = pathNode.get("post").get("parameters").get(0).get("schema").get("properties").get("input").get("$ref").textValue();
+            String bodyInputSchemaRefSuffix = JsonHelper.getStringSuffix(bodyInputSchemaRef,"/");
+            rpcOperation = normalizeRpcOperation ? rpcOperation.replaceAll(Pattern.quote("-"),"").toLowerCase() : rpcOperation;
+
+            String bodyOutputSchemaRef = pathNode.get("post").get("responses").get("200").get("schema").get("properties").get("output").get("$ref").textValue();
+            String bodyOutputSchemaRefSuffix = JsonHelper.getStringSuffix(bodyOutputSchemaRef,"/");
+
+            Set<String> inputParametersOrSchemaRef;
+            Set<String> outputParametersOrSchemaRef;
+            if(populateType == PopulateType.SCHEMA_REF){
+                inputParametersOrSchemaRef = new HashSet();
+                inputParametersOrSchemaRef.add(bodyInputSchemaRefSuffix);
+
+                outputParametersOrSchemaRef = new HashSet();
+                outputParametersOrSchemaRef.add(bodyOutputSchemaRefSuffix);
+            }else{
+                inputParametersOrSchemaRef = extractParams(jsonNode,bodyInputSchemaRefSuffix);
+                outputParametersOrSchemaRef = extractParams(jsonNode,bodyOutputSchemaRefSuffix);
+            }
+            jsonBodyInputParams.put(rpcOperation,inputParametersOrSchemaRef);
+            jsonBodyOutputParams.put(rpcOperation,outputParametersOrSchemaRef);
+        }
+    }
+
+    private static Set<String> extractParams(final JsonNode jsonNode,String schemaRefName) {
+        Iterator<Map.Entry<String, JsonNode>> fields = jsonNode.get("definitions").get(schemaRefName).get("properties").fields();
+        Set<String> params = new HashSet();
+        for( ;fields.hasNext(); ){
+            Map.Entry<String, JsonNode> fieldEntry = fields.next();
+            params.add(fieldEntry.getKey());
+        }
+        return params;
+    }
+
+    public static String getStringSuffix(String input, String afterString){
+        int indexOf = input.lastIndexOf(afterString);
+        String stringSuffix = (indexOf > -1) ? input.substring(indexOf+1) : input;
+        return stringSuffix;
+    }
+}
diff --git a/appc-client/client-kit/src/test/java/org/openecomp/appc/generator/yang2json/Yang2JsonGeneratorTest.java b/appc-client/client-kit/src/test/java/org/openecomp/appc/generator/yang2json/Yang2JsonGeneratorTest.java
new file mode 100644
index 000000000..2e8ef9577
--- /dev/null
+++ b/appc-client/client-kit/src/test/java/org/openecomp/appc/generator/yang2json/Yang2JsonGeneratorTest.java
@@ -0,0 +1,140 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP : APPC
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Copyright (C) 2017 Amdocs
+ * =============================================================================
+ * Licensed 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.
+ * 
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.appc.generator.yang2json;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.base.Optional;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
+import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException;
+import org.opendaylight.yangtools.yang.parser.repo.YangTextSchemaContextResolver;
+import org.openecomp.appc.generator.JsonHelper;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.*;
+
+public class Yang2JsonGeneratorTest {
+
+    private static SchemaContext yangSchema = null;
+    private static JsonNode jsonNode = null;
+
+    public void readIOfiles() throws IOException{
+        if(yangSchema == null){
+            yangParse();
+        }
+        if(jsonNode == null){
+            jsonRead();
+        }
+
+    }
+
+    public void testJsonRpcNum(){
+
+        int rpcYangNum = yangSchema.getModules().iterator().next().getRpcs().size();
+        int rpcJsonNum = jsonNode.get("paths").size();
+        Assert.assertTrue(rpcYangNum == rpcJsonNum);
+    }
+
+    public void testJsonRpcsAndInOutParams(){
+
+        Map<String/*rpcOperation*/,Set<String> /*bodyInputParams*/> jsonBodyInputParams = new HashMap();
+        Map<String/*rpcOperation*/,Set<String> /*bodyOutputParams*/> jsonBodyOutputParams= new HashMap();
+        JsonHelper.populateRpcInputOutputParamsFromJson(jsonNode,jsonBodyInputParams, jsonBodyOutputParams);
+
+        Set<RpcDefinition> rpcDefinitions = yangSchema.getModules().iterator().next().getRpcs();
+        for(RpcDefinition rpcDef : rpcDefinitions){
+            String rpcOperation = rpcDef.getQName().getLocalName();
+            //verify all yang rpc operations & all input yang params/groupings exist in yang2json
+            Assert.assertTrue(jsonBodyInputParams.containsKey(rpcOperation));
+            Collection<DataSchemaNode> inputChildNodes = rpcDef.getInput().getChildNodes();
+            if(inputChildNodes != null || !inputChildNodes.isEmpty()) {
+                Assert.assertTrue(rpcOperation+": yang and yang2json input params size is not equal!",jsonBodyInputParams.get(rpcOperation).size() == inputChildNodes.size());
+                Set<String> inputYangParams = getYangParams(inputChildNodes);
+                Assert.assertTrue(rpcOperation+": yang and yang2json input params are not same!",jsonBodyInputParams.get(rpcOperation).containsAll(inputYangParams));
+            }
+
+            //verify all yang rpc operations & all output yang params/groupings exist in yang2json
+            Assert.assertTrue(jsonBodyOutputParams.containsKey(rpcOperation));
+            Collection<DataSchemaNode> outputChildNodes = rpcDef.getOutput().getChildNodes();
+            if(outputChildNodes != null || !outputChildNodes.isEmpty()) {
+                Assert.assertTrue(rpcOperation+": yang and yang2json output params size is not equal!",jsonBodyOutputParams.get(rpcOperation).size()== outputChildNodes.size());
+                Set<String> outputYangParams = getYangParams(outputChildNodes);
+                Assert.assertTrue(rpcOperation+": yang and yang2json output params are not same!",jsonBodyOutputParams.get(rpcOperation).containsAll(outputYangParams));
+            }
+        }
+    }
+
+
+    private Set<String> getYangParams(Collection<DataSchemaNode> dataSchemaNodes) {
+        Set<String> yangParams = new HashSet();
+        for(DataSchemaNode child : dataSchemaNodes){
+            yangParams.add(child.getQName().getLocalName());
+        }
+        return yangParams;
+    }
+
+
+
+    private static void yangParse(){
+
+        try {
+            //sourceFileName
+            String yangFileName = System.getProperty("inputFile");
+            YangTextSchemaContextResolver yangContextResolver = null;
+            yangContextResolver = YangTextSchemaContextResolver.create("yang-context-resolver");
+            URL url = new File(yangFileName).toURI().toURL();
+            yangContextResolver.registerSource(url);
+            Optional<SchemaContext> yangSchemaContext = yangContextResolver.getSchemaContext();
+            yangSchema = yangSchemaContext.get();
+        } catch (MalformedURLException e) {
+            e.printStackTrace();
+        } catch (YangSyntaxErrorException e) {
+            e.printStackTrace();
+        } catch (IOException e) {
+            e.printStackTrace();
+        } catch (SchemaSourceException e) {
+            e.printStackTrace();
+        }
+
+
+    }
+
+
+    private static void jsonRead ()throws IOException {
+        String jsonFilePath = System.getProperty("outputFile");
+        File file = new File(jsonFilePath);
+        ObjectMapper mapper = new ObjectMapper();
+        jsonNode = mapper.readTree(file);
+    }
+}