Add support for anyxml node code generation

This adds the support for generating OpaqueObject interfaces
based on anyxml nodes.

JIRA: MDSAL-437
Change-Id: Iee4f32449f73833b31444c7659047471758d0c88
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/AbstractTypeGenerator.java b/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/AbstractTypeGenerator.java
index 0a71a09518b5f17fbcc1a133dc856b0f9f11b177..79890b1fca8c41f9382ecb55530e189929c82245 100644 (file)
--- a/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/AbstractTypeGenerator.java
+++ b/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/AbstractTypeGenerator.java
@@ -30,6 +30,7 @@ import static org.opendaylight.mdsal.binding.model.util.BindingTypes.choiceIn;
 import static org.opendaylight.mdsal.binding.model.util.BindingTypes.identifiable;
 import static org.opendaylight.mdsal.binding.model.util.BindingTypes.identifier;
 import static org.opendaylight.mdsal.binding.model.util.BindingTypes.keyedListAction;
+import static org.opendaylight.mdsal.binding.model.util.BindingTypes.opaqueObject;
 import static org.opendaylight.mdsal.binding.model.util.BindingTypes.rpcResult;
 import static org.opendaylight.mdsal.binding.model.util.Types.BOOLEAN;
 import static org.opendaylight.mdsal.binding.model.util.Types.STRING;
@@ -88,6 +89,7 @@ import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.common.QNameModule;
 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
@@ -1050,8 +1052,10 @@ abstract class AbstractTypeGenerator {
                 listToGenType(context, typeBuilder, baseInterface, (ListSchemaNode) node, inGrouping);
             } else if (node instanceof ChoiceSchemaNode) {
                 choiceToGeneratedType(context, typeBuilder, (ChoiceSchemaNode) node, inGrouping);
+            } else if (node instanceof AnyXmlSchemaNode) {
+                // FIXME: MDSAL-438: also cover AnyDataSchemaNode
+                opaqueToGeneratedType(context, typeBuilder, (AnyXmlSchemaNode) node);
             } else {
-                // TODO: anyxml not yet supported
                 LOG.debug("Unable to add schema node {} as method in {}: unsupported type of node.", node.getClass(),
                         typeBuilder.getFullyQualifiedName());
             }
@@ -1076,8 +1080,6 @@ abstract class AbstractTypeGenerator {
      */
     private void choiceToGeneratedType(final ModuleContext context, final GeneratedTypeBuilder parent,
             final ChoiceSchemaNode choiceNode, final boolean inGrouping) {
-        checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
-
         if (!choiceNode.isAddedByUses()) {
             final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(
                 JavaTypeName.create(packageNameForGeneratedType(context.modulePackageName(), choiceNode.getPath()),
@@ -1093,6 +1095,21 @@ abstract class AbstractTypeGenerator {
         }
     }
 
+    private void opaqueToGeneratedType(final ModuleContext context, final GeneratedTypeBuilder parent,
+            final AnyXmlSchemaNode anyxmlNode) {
+        if (!anyxmlNode.isAddedByUses()) {
+            final GeneratedTypeBuilder anyxmlTypeBuilder = addRawInterfaceDefinition(
+                JavaTypeName.create(packageNameForGeneratedType(context.modulePackageName(), anyxmlNode.getPath()),
+                BindingMapping.getClassName(anyxmlNode.getQName())), anyxmlNode);
+            anyxmlTypeBuilder.addImplementsType(opaqueObject(anyxmlTypeBuilder)).addImplementsType(childOf(parent));
+            defaultImplementedInterace(anyxmlTypeBuilder);
+            annotateDeprecatedIfNecessary(anyxmlNode.getStatus(), anyxmlTypeBuilder);
+            context.addChildNodeType(anyxmlNode, anyxmlTypeBuilder);
+
+            constructGetter(parent, anyxmlTypeBuilder.build(), anyxmlNode);
+        }
+    }
+
     /**
      * Converts <code>caseNodes</code> set to list of corresponding generated types. For every <i>case</i> which is not
      * added through augment or <i>uses</i> is created generated type builder. The package names for the builder is

diff --git a/binding/mdsal-binding-generator-impl/src/test/java/org/opendaylight/mdsal/binding/generator/impl/Mdsal437Test.java b/binding/mdsal-binding-generator-impl/src/test/java/org/opendaylight/mdsal/binding/generator/impl/Mdsal437Test.java
new file mode 100644 (file)
index 0000000..98963cb
--- /dev/null
+++ b/binding/mdsal-binding-generator-impl/src/test/java/org/opendaylight/mdsal/binding/generator/impl/Mdsal437Test.java
@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2019 PANTHEON.tech, s.r.o. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.mdsal.binding.generator.impl;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
+import java.util.Iterator;
+import java.util.List;
+import java.util.Optional;
+import org.junit.Test;
+import org.opendaylight.mdsal.binding.model.api.GeneratedType;
+import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
+import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
+import org.opendaylight.mdsal.binding.model.api.Type;
+import org.opendaylight.yangtools.yang.binding.ChildOf;
+import org.opendaylight.yangtools.yang.binding.OpaqueObject;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
+
+public class Mdsal437Test {
+
+    @Test
+    public void generateAnyxmlTest() {
+        final SchemaContext context = YangParserTestUtils.parseYangResource("/mdsal437.yang");
+
+        final List<Type> types = new BindingGeneratorImpl().generateTypes(context);
+        assertNotNull(types);
+        assertEquals(7, types.size());
+
+        assertXmlNode(types, "", "Any");
+        assertXmlNode(types, ".cont", "Cont");
+        assertXmlNode(types, ".grp", "Grp");
+
+    }
+
+    private static void assertXmlNode(final List<Type> types, final String pkg, final String name) {
+        final JavaTypeName typeName = JavaTypeName.create("org.opendaylight.yang.gen.v1.mdsal437.norev" + pkg, name);
+        final Optional<Type> optType = types.stream().filter(t -> typeName.equals(t.getIdentifier())).findFirst();
+        assertTrue(optType.isPresent());
+        final Type type = optType.get();
+        assertTrue(type instanceof GeneratedType);
+        final GeneratedType genType = (GeneratedType) type;
+        final Iterator<Type> it = genType.getImplements().iterator();
+        final Type first = it.next();
+        assertTrue(first instanceof ParameterizedType);
+        assertEquals(JavaTypeName.create(OpaqueObject.class), ((ParameterizedType) first).getRawType().getIdentifier());
+
+        final Type second = it.next();
+        assertTrue(second instanceof ParameterizedType);
+        assertEquals(JavaTypeName.create(ChildOf.class), ((ParameterizedType) second).getRawType().getIdentifier());
+
+        assertFalse(it.hasNext());
+    }
+}

diff --git a/binding/mdsal-binding-generator-impl/src/test/resources/mdsal437.yang b/binding/mdsal-binding-generator-impl/src/test/resources/mdsal437.yang
new file mode 100644 (file)
index 0000000..baf2809
--- /dev/null
+++ b/binding/mdsal-binding-generator-impl/src/test/resources/mdsal437.yang
@@ -0,0 +1,21 @@
+module mdsal437 {
+    prefix mdsal437;
+    namespace mdsal437;
+
+    grouping grp {
+        anyxml grp;
+    }
+
+    container cont {
+        anyxml cont;
+
+        uses grp;
+    }
+
+    list lst {
+        uses grp;
+    }
+
+    anyxml any;
+}
+

diff --git a/binding/mdsal-binding-generator-util/src/main/java/org/opendaylight/mdsal/binding/model/util/BindingTypes.java b/binding/mdsal-binding-generator-util/src/main/java/org/opendaylight/mdsal/binding/model/util/BindingTypes.java
index 46d487a9c485f28c68c0b9e96aa2bc379a06e42c..4cfc2e9e4bbca4f33c83eed2012b81d5f78e11b0 100644 (file)
--- a/binding/mdsal-binding-generator-util/src/main/java/org/opendaylight/mdsal/binding/model/util/BindingTypes.java
+++ b/binding/mdsal-binding-generator-util/src/main/java/org/opendaylight/mdsal/binding/model/util/BindingTypes.java
@@ -30,6 +30,7 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.binding.KeyedListAction;
 import org.opendaylight.yangtools.yang.binding.Notification;
 import org.opendaylight.yangtools.yang.binding.NotificationListener;
+import org.opendaylight.yangtools.yang.binding.OpaqueObject;
 import org.opendaylight.yangtools.yang.binding.RpcInput;
 import org.opendaylight.yangtools.yang.binding.RpcOutput;
 import org.opendaylight.yangtools.yang.binding.RpcService;
@@ -68,6 +69,7 @@ public final class BindingTypes {
     private static final ConcreteType CHILD_OF = typeForClass(ChildOf.class);
     private static final ConcreteType CHOICE_IN = typeForClass(ChoiceIn.class);
     private static final ConcreteType KEYED_LIST_ACTION = typeForClass(KeyedListAction.class);
+    private static final ConcreteType OPAQUE_OBJECT = typeForClass(OpaqueObject.class);
     private static final ConcreteType RPC_RESULT = typeForClass(RpcResult.class);
 
     private BindingTypes() {
@@ -168,6 +170,17 @@ public final class BindingTypes {
         return parameterizedTypeFor(INSTANCE_IDENTIFIER, type);
     }
 
+    /**
+     * Type specializing {@link OpaqueObject} for a particular type.
+     *
+     * @param type Type for which to specialize
+     * @return A parameterized type corresponding to {@code OpaqueObject<Type>}
+     * @throws NullPointerException if {@code type} is null
+     */
+    public static ParameterizedType opaqueObject(final Type type) {
+        return parameterizedTypeFor(OPAQUE_OBJECT, type);
+    }
+
     /**
      * Type specializing {@link RpcResult} for a particular type.
      *

diff --git a/binding/mdsal-binding-test-model/src/main/yang/mdsal437.yang b/binding/mdsal-binding-test-model/src/main/yang/mdsal437.yang
new file mode 100644 (file)
index 0000000..aaddf1a
--- /dev/null
+++ b/binding/mdsal-binding-test-model/src/main/yang/mdsal437.yang
@@ -0,0 +1,20 @@
+module mdsal437 {
+    prefix mdsal437;
+    namespace mdsal437;
+
+    grouping grp {
+        anyxml grp-any;
+    }
+
+    container cont {
+        anyxml cont-any;
+        uses grp;
+    }
+
+    list lst {
+        uses grp;
+    }
+
+    anyxml any;
+}
+