AugmentProcessTest.java

/*
 * Copyright (c) 2016 Cisco Systems, Inc. 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.yangtools.yang.stmt;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.opendaylight.yangtools.yang.stmt.StmtTestUtils.sourceForResource;

import java.net.URI;
import org.junit.Test;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
import org.opendaylight.yangtools.yang.parser.spi.meta.SomeModifiersUnresolvedException;
import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangInferencePipeline;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveSchemaContext;

public class AugmentProcessTest {

    private static final StatementStreamSource AUGMENTED = sourceForResource("/stmt-test/augments/augmented.yang");
    private static final StatementStreamSource ROOT = sourceForResource("/stmt-test/augments/aug-root.yang");

    private static final QNameModule ROOT_QNAME_MODULE = QNameModule.create(
            URI.create("root"), SimpleDateFormatUtil.DEFAULT_DATE_REV);
    private static final QNameModule AUGMENTED_QNAME_MODULE = QNameModule
            .create(URI.create("aug"), SimpleDateFormatUtil.DEFAULT_DATE_REV);

    private final QName augParent1 = QName.create(AUGMENTED_QNAME_MODULE,
            "aug-parent1");
    private final QName augParent2 = QName.create(AUGMENTED_QNAME_MODULE,
            "aug-parent2");
    private final QName contTarget = QName.create(AUGMENTED_QNAME_MODULE,
            "cont-target");

    private final QName contAdded1 = QName.create(ROOT_QNAME_MODULE,
            "cont-added1");
    private final QName contAdded2 = QName.create(ROOT_QNAME_MODULE,
            "cont-added2");

    private final QName list1 = QName.create(ROOT_QNAME_MODULE, "list1");
    private final QName axml = QName.create(ROOT_QNAME_MODULE, "axml");

    private final QName contGrp = QName.create(ROOT_QNAME_MODULE,
            "cont-grp");
    private final QName axmlGrp = QName.create(ROOT_QNAME_MODULE,
            "axml-grp");

    private final QName augCont1 = QName.create(ROOT_QNAME_MODULE, "aug-cont1");
    private final QName augCont2 = QName.create(ROOT_QNAME_MODULE, "aug-cont2");

    private final QName grpCont2 = QName.create(ROOT_QNAME_MODULE, "grp-cont2");
    private final QName grpCont22 = QName.create(ROOT_QNAME_MODULE,
            "grp-cont22");
    private final QName grpAdd = QName.create(ROOT_QNAME_MODULE, "grp-add");

    private static final StatementStreamSource MULTIPLE_AUGMENT = sourceForResource(
            "/stmt-test/augments/multiple-augment-test.yang");

    private static final StatementStreamSource MULTIPLE_AUGMENT_ROOT = sourceForResource(
            "/stmt-test/augments/multiple-augment-root.yang");
    private static final StatementStreamSource MULTIPLE_AUGMENT_IMPORTED = sourceForResource(
            "/stmt-test/augments/multiple-augment-imported.yang");
    private static final StatementStreamSource MULTIPLE_AUGMENT_SUBMODULE = sourceForResource(
            "/stmt-test/augments/multiple-augment-submodule.yang");

    private static final StatementStreamSource MULTIPLE_AUGMENT_INCORRECT = sourceForResource(
            "/stmt-test/augments/multiple-augment-incorrect.yang");

    private static final StatementStreamSource MULTIPLE_AUGMENT_INCORRECT2 = sourceForResource(
            "/stmt-test/augments/multiple-augment-incorrect2.yang");

    @Test
    public void multipleAugmentsAndMultipleModulesTest() throws SourceException, ReactorException {
        final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR
                .newBuild();
        addSources(reactor, MULTIPLE_AUGMENT_ROOT, MULTIPLE_AUGMENT_IMPORTED,
                MULTIPLE_AUGMENT_SUBMODULE);

        EffectiveSchemaContext result = null;
        result = reactor.buildEffective();
        assertNotNull(result);
    }

    @Test
    public void multipleAugmentTest() throws SourceException, ReactorException {
        final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR
                .newBuild();
        addSources(reactor, MULTIPLE_AUGMENT);

        EffectiveSchemaContext result = null;
        result = reactor.buildEffective();
        assertNotNull(result);
    }

    @Test(expected = SomeModifiersUnresolvedException.class)
    public void multipleAugmentIncorrectPathTest() throws SourceException, ReactorException {
        final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR
                .newBuild();
        addSources(reactor, MULTIPLE_AUGMENT_INCORRECT);

        EffectiveSchemaContext result = null;
        result = reactor.buildEffective();
        assertNull(result);
    }

    @Test(expected = SomeModifiersUnresolvedException.class)
    public void multipleAugmentIncorrectPathAndGrpTest() throws SourceException, ReactorException {
        final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR
                .newBuild();
        addSources(reactor, MULTIPLE_AUGMENT_INCORRECT2);
        EffectiveSchemaContext result = null;
        result = reactor.buildEffective();
        assertNull(result);
    }

    @Test
    public void readAndParseYangFileTest() throws SourceException, ReactorException {
        final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR
                .newBuild();
        addSources(reactor, AUGMENTED, ROOT);

        final EffectiveSchemaContext root = reactor.buildEffective();
        assertNotNull(root);

        final Module augmentedModule = root.findModuleByName("augmented", null);
        assertNotNull(augmentedModule);

        final ContainerSchemaNode augParent1Node = (ContainerSchemaNode) root
                .getDataChildByName(augParent1);
        final ContainerSchemaNode augParent2Node = (ContainerSchemaNode) augParent1Node
                .getDataChildByName(augParent2);
        final ContainerSchemaNode targetContNode = (ContainerSchemaNode) augParent2Node
                .getDataChildByName(contTarget);
        assertNotNull(targetContNode);

        assertNotNull(targetContNode.getChildNodes());
        assertEquals(3, targetContNode.getChildNodes().size());

        final ContainerSchemaNode contAdded1Node = (ContainerSchemaNode) targetContNode
                .getDataChildByName(contAdded1);
        assertNotNull(contAdded1Node);
        final ListSchemaNode list1Node = (ListSchemaNode) contAdded1Node
                .getDataChildByName(list1);
        assertNotNull(list1Node);

        final ContainerSchemaNode contAdded2Node = (ContainerSchemaNode) targetContNode
                .getDataChildByName(contAdded2);
        assertNotNull(contAdded2Node);
        final AnyXmlSchemaNode axmlNode = (AnyXmlSchemaNode) contAdded2Node
                .getDataChildByName(axml);
        assertNotNull(axmlNode);

        final ContainerSchemaNode contGrpNode = (ContainerSchemaNode) targetContNode
                .getDataChildByName(contGrp);
        assertNotNull(contGrpNode);
        final AnyXmlSchemaNode axmlGrpNode = (AnyXmlSchemaNode) contGrpNode
                .getDataChildByName(axmlGrp);
        assertNotNull(axmlGrpNode);

        final ContainerSchemaNode augCont1Node = (ContainerSchemaNode) root
                .getDataChildByName(augCont1);
        final ContainerSchemaNode augCont2Node = (ContainerSchemaNode) augCont1Node
                .getDataChildByName(augCont2);
        assertNotNull(augCont2Node);

        final ContainerSchemaNode grpCont2Node = (ContainerSchemaNode) augCont2Node
                .getDataChildByName(grpCont2);
        final ContainerSchemaNode grpCont22Node = (ContainerSchemaNode) grpCont2Node
                .getDataChildByName(grpCont22);
        assertNotNull(grpCont22Node);

        final ContainerSchemaNode grpAddNode = (ContainerSchemaNode) grpCont22Node
                .getDataChildByName(grpAdd);
        assertNotNull(grpAddNode);
    }

    private static void addSources(final CrossSourceStatementReactor.BuildAction reactor,
            final StatementStreamSource... sources) {
        for (final StatementStreamSource source : sources) {
            reactor.addSource(source);
        }
    }

    @Test
    public void caseShortHandAugmentingTest() throws Exception {
        final SchemaContext context = StmtTestUtils.parseYangSources("/choice-case-type-test-models");

        assertNotNull(context);

        final String rev = "2013-07-01";
        final String ns = "urn:ietf:params:xml:ns:yang:choice-monitoring";
        final String nsAug = "urn:ietf:params:xml:ns:yang:augment-monitoring";

        final ContainerSchemaNode netconf = (ContainerSchemaNode) context.getDataChildByName(QName.create(ns, rev,
                "netconf-state"));
        final ContainerSchemaNode datastores = (ContainerSchemaNode) netconf.getDataChildByName(QName.create(ns, rev,
                "datastores"));
        final ListSchemaNode datastore = (ListSchemaNode) datastores.getDataChildByName(QName.create(ns, rev,
                "datastore"));
        final ContainerSchemaNode locks = (ContainerSchemaNode) datastore.getDataChildByName(QName.create(ns, rev,
                "locks"));
        final ChoiceSchemaNode lockType = (ChoiceSchemaNode) locks.getDataChildByName(QName
                .create(ns, rev, "lock-type"));

        final ChoiceCaseNode leafAugCase = lockType.getCaseNodeByName("leaf-aug-case");
        assertTrue(leafAugCase.isAugmenting());
        final DataSchemaNode leafAug = leafAugCase.getDataChildByName(QName.create(nsAug, rev, "leaf-aug-case"));
        assertFalse(leafAug.isAugmenting());
    }

}