DeclaredStatementsTest.java example

Explorer
yangtools-master
/*
 * 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.assertTrue;
import static org.opendaylight.yangtools.yang.stmt.StmtTestUtils.sourceForResource;

import java.text.ParseException;
import java.util.Collection;
import java.util.Date;
import java.util.Set;
import java.util.function.Predicate;
import org.junit.Test;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.opendaylight.yangtools.yang.model.api.Status;
import org.opendaylight.yangtools.yang.model.api.stmt.AnyxmlStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ArgumentStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.CaseStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ContainerStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.DefaultStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ErrorAppTagStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ErrorMessageStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ExtensionStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.FeatureStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.IdentityStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.IncludeStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ModuleStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.MustStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.NamespaceStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.PresenceStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.RevisionStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionStatement;
import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.AnyXmlEffectiveStatementImpl;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.AugmentEffectiveStatementImpl;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ChoiceEffectiveStatementImpl;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ContainerEffectiveStatementImpl;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ModuleEffectiveStatementImpl;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.SubmoduleEffectiveStatementImpl;

public class DeclaredStatementsTest {

    @Test
    public void testDeclaredAnyXml() throws ReactorException {
        final StatementStreamSource anyxmlStmtModule =
                sourceForResource("/declared-statements-test/anyxml-declared-test.yang");

        final SchemaContext schemaContext = StmtTestUtils.parseYangSources(anyxmlStmtModule);
        assertNotNull(schemaContext);

        final Module testModule = schemaContext.findModuleByName("anyxml-declared-test", null);
        assertNotNull(testModule);

        final AnyXmlSchemaNode anyxmlSchemaNode = (AnyXmlSchemaNode) testModule.getDataChildByName(
                QName.create(testModule.getQNameModule(), "foobar"));
        assertNotNull(anyxmlSchemaNode);
        final AnyxmlStatement anyxmlStatement = ((AnyXmlEffectiveStatementImpl) anyxmlSchemaNode).getDeclared();

        final QName name = anyxmlStatement.getName();
        assertNotNull(name);

        final WhenStatement whenStatement = anyxmlStatement.getWhenStatement();
        assertNotNull(whenStatement);
        final RevisionAwareXPath whenRevisionAwareXPath = whenStatement.getCondition();
        assertNotNull(whenRevisionAwareXPath);
        final DescriptionStatement whenStatementDescription = whenStatement.getDescription();
        assertNotNull(whenStatementDescription);
        final ReferenceStatement whenStatementReference = whenStatement.getReference();
        assertNotNull(whenStatementReference);

        final Collection<? extends IfFeatureStatement> ifFeatureStatements = anyxmlStatement.getIfFeatures();
        assertNotNull(ifFeatureStatements);
        assertEquals(1, ifFeatureStatements.size());
        final Predicate<Set<QName>> ifFeaturePredicate = ifFeatureStatements.iterator().next().getIfFeaturePredicate();
        assertNotNull(ifFeaturePredicate);

        final Collection<? extends MustStatement> mustStatements = anyxmlStatement.getMusts();
        assertNotNull(mustStatements);
        assertEquals(1, mustStatements.size());
        final MustStatement mustStatement = mustStatements.iterator().next();
        final RevisionAwareXPath mustRevisionAwareXPath = mustStatement.getCondition();
        assertNotNull(mustRevisionAwareXPath);
        final ErrorAppTagStatement errorAppTagStatement = mustStatement.getErrorAppTagStatement();
        assertNotNull(errorAppTagStatement);
        final ErrorMessageStatement errorMessageStatement = mustStatement.getErrorMessageStatement();
        assertNotNull(errorMessageStatement);
        final DescriptionStatement mustStatementDescription = mustStatement.getDescription();
        assertNotNull(mustStatementDescription);
        final ReferenceStatement mustStatementReference = mustStatement.getReference();
        assertNotNull(mustStatementReference);

        final ConfigStatement configStatement = anyxmlStatement.getConfig();
        assertNotNull(configStatement);
        assertFalse(configStatement.getValue());

        final StatusStatement statusStatement = anyxmlStatement.getStatus();
        assertNotNull(statusStatement);
        final Status status = statusStatement.getValue();
        assertNotNull(status);

        final DescriptionStatement descriptionStatement = anyxmlStatement.getDescription();
        assertNotNull(descriptionStatement);
        assertEquals("anyxml description", descriptionStatement.getText());

        final ReferenceStatement referenceStatement = anyxmlStatement.getReference();
        assertNotNull(referenceStatement);
        assertEquals("anyxml reference", referenceStatement.getText());

        final MandatoryStatement mandatoryStatement = anyxmlStatement.getMandatory();
        assertNotNull(mandatoryStatement);
    }

    @Test
    public void testDeclaredChoice() throws ReactorException {
        final StatementStreamSource choiceStmtModule =
                sourceForResource("/declared-statements-test/choice-declared-test.yang");

        final SchemaContext schemaContext = StmtTestUtils.parseYangSources(choiceStmtModule);
        assertNotNull(schemaContext);

        final Module testModule = schemaContext.findModuleByName("choice-declared-test", null);
        assertNotNull(testModule);

        final ChoiceSchemaNode choiceSchemaNode = (ChoiceSchemaNode) testModule.getDataChildByName(
                QName.create(testModule.getQNameModule(), "test-choice"));
        assertNotNull(choiceSchemaNode);
        final ChoiceStatement choiceStatement = ((ChoiceEffectiveStatementImpl) choiceSchemaNode).getDeclared();

        final QName name = choiceStatement.getName();
        assertNotNull(name);

        final DefaultStatement defaultStatement = choiceStatement.getDefault();
        assertNotNull(defaultStatement);
        assertEquals("case-two", defaultStatement.getValue());

        final ConfigStatement configStatement = choiceStatement.getConfig();
        assertNotNull(configStatement);

        final MandatoryStatement mandatoryStatement = choiceStatement.getMandatory();
        assertNotNull(mandatoryStatement);

        final Collection<? extends CaseStatement> caseStatements = choiceStatement.getCases();
        assertNotNull(caseStatements);
        assertEquals(3, caseStatements.size());
        final CaseStatement caseStatement = caseStatements.iterator().next();
        final QName caseStatementName = caseStatement.getName();
        assertNotNull(caseStatementName);
        final WhenStatement caseStatementWhen = caseStatement.getWhenStatement();
        assertNotNull(caseStatementWhen);
        final Collection<? extends IfFeatureStatement> caseStatementIfFeatures = caseStatement.getIfFeatures();
        assertNotNull(caseStatementIfFeatures);
        assertEquals(1, caseStatementIfFeatures.size());
        final Collection<? extends DataDefinitionStatement> caseStatementDataDefinitions = caseStatement.getDataDefinitions();
        assertNotNull(caseStatementDataDefinitions);
        assertEquals(1, caseStatementDataDefinitions.size());
        final StatusStatement caseStatementStatus = caseStatement.getStatus();
        assertNotNull(caseStatementStatus);
        final DescriptionStatement caseStatementDescription = caseStatement.getDescription();
        assertNotNull(caseStatementDescription);
        final ReferenceStatement caseStatementReference = caseStatement.getReference();
        assertNotNull(caseStatementReference);

        final WhenStatement whenStatement = choiceStatement.getWhenStatement();
        assertNotNull(whenStatement);

        final Collection<? extends IfFeatureStatement> ifFeatureStatements = choiceStatement.getIfFeatures();
        assertNotNull(ifFeatureStatements);
        assertEquals(1, ifFeatureStatements.size());

        final StatusStatement statusStatement = choiceStatement.getStatus();
        assertNotNull(statusStatement);

        final DescriptionStatement descriptionStatement = choiceStatement.getDescription();
        assertNotNull(descriptionStatement);

        final ReferenceStatement referenceStatement = choiceStatement.getReference();
        assertNotNull(referenceStatement);
    }

    @Test
    public void testDeclaredAugment() throws ReactorException {
        final StatementStreamSource augmentStmtModule =
                sourceForResource("/declared-statements-test/augment-declared-test.yang");

        final SchemaContext schemaContext = StmtTestUtils.parseYangSources(augmentStmtModule);
        assertNotNull(schemaContext);

        final Module testModule = schemaContext.findModuleByName("augment-declared-test", null);
        assertNotNull(testModule);

        final Set<AugmentationSchema> augmentationSchemas = testModule.getAugmentations();
        assertNotNull(augmentationSchemas);
        assertEquals(1, augmentationSchemas.size());

        final AugmentationSchema augmentationSchema = augmentationSchemas.iterator().next();
        final AugmentStatement augmentStatement = ((AugmentEffectiveStatementImpl) augmentationSchema).getDeclared();

        final SchemaNodeIdentifier targetNode = augmentStatement.getTargetNode();
        assertNotNull(targetNode);

        final Collection<? extends DataDefinitionStatement> augmentStatementDataDefinitions =
                augmentStatement.getDataDefinitions();
        assertNotNull(augmentStatementDataDefinitions);
        assertEquals(1, augmentStatementDataDefinitions.size());
    }

    @Test
    public void testDeclaredModuleAndSubmodule() throws ReactorException {
        final StatementStreamSource parentModule =
                sourceForResource("/declared-statements-test/parent-module-declared-test.yang");

        final StatementStreamSource childModule =
                sourceForResource("/declared-statements-test/child-module-declared-test.yang");

        final SchemaContext schemaContext = StmtTestUtils.parseYangSources(parentModule, childModule);
        assertNotNull(schemaContext);

        final Module testModule = schemaContext.findModuleByName("parent-module-declared-test", null);
        assertNotNull(testModule);

        final ModuleStatement moduleStatement = ((ModuleEffectiveStatementImpl) testModule).getDeclared();

        final String moduleStatementName = moduleStatement.getName();
        assertNotNull(moduleStatementName);

        final YangVersionStatement moduleStatementYangVersion = moduleStatement.getYangVersion();
        assertNotNull(moduleStatementYangVersion);
        assertNotNull(moduleStatementYangVersion.getValue());

        final NamespaceStatement moduleStatementNamspace = moduleStatement.getNamespace();
        assertNotNull(moduleStatementNamspace);
        assertNotNull(moduleStatementNamspace.getUri());

        final PrefixStatement moduleStatementPrefix= moduleStatement.getPrefix();
        assertNotNull(moduleStatementPrefix);
        assertNotNull(moduleStatementPrefix.getValue());

        assertEquals(1, moduleStatement.getIncludes().size());
        final IncludeStatement includeStatement = moduleStatement.getIncludes().iterator().next();
        assertEquals("child-module-declared-test", includeStatement.getModule());

        final Set<Module> submodules = testModule.getSubmodules();
        assertNotNull(submodules);
        assertEquals(1, submodules.size());

        final Module submodule = submodules.iterator().next();
        final SubmoduleStatement submoduleStatement = ((SubmoduleEffectiveStatementImpl) submodule).getDeclared();

        final String submoduleStatementName = submoduleStatement.getName();
        assertNotNull(submoduleStatementName);

        final YangVersionStatement submoduleStatementYangVersion = submoduleStatement.getYangVersion();
        assertNotNull(submoduleStatementYangVersion);

        final BelongsToStatement belongsToStatement = submoduleStatement.getBelongsTo();
        assertNotNull(belongsToStatement);
        assertNotNull(belongsToStatement.getModule());
        assertNotNull(belongsToStatement.getPrefix());
    }

    @Test
    public void testDeclaredModule() throws ReactorException, ParseException {
        final StatementStreamSource rootModule =
                sourceForResource("/declared-statements-test/root-module-declared-test.yang");

        final StatementStreamSource importedModule =
                sourceForResource("/declared-statements-test/imported-module-declared-test.yang");

        final SchemaContext schemaContext = StmtTestUtils.parseYangSources(rootModule, importedModule);
        assertNotNull(schemaContext);

        final Date revision = SimpleDateFormatUtil.getRevisionFormat().parse("2016-09-28");

        final Module testModule = schemaContext.findModuleByName("root-module-declared-test", revision);
        assertNotNull(testModule);

        final ModuleStatement moduleStatement = ((ModuleEffectiveStatementImpl) testModule).getDeclared();

        assertEquals(1, moduleStatement.getImports().size());
        final ImportStatement importStatement = moduleStatement.getImports().iterator().next();
        assertEquals("imported-module-declared-test", importStatement.getModule());
        assertEquals("imdt", importStatement.getPrefix().getValue());
        assertEquals(revision, importStatement.getRevisionDate().getDate());

        assertEquals("test description", moduleStatement.getDescription().getText());
        assertEquals("test reference", moduleStatement.getReference().getText());
        assertEquals("test organization", moduleStatement.getOrganization().getText());
        assertEquals("test contact", moduleStatement.getContact().getText());

        assertEquals(1, moduleStatement.getRevisions().size());
        final RevisionStatement revisionStatement = moduleStatement.getRevisions().iterator().next();
        assertEquals(revision, revisionStatement.getDate());
        assertEquals("test description", revisionStatement.getDescription().getText());
        assertEquals("test reference", revisionStatement.getReference().getText());

        assertEquals(1, moduleStatement.getExtensions().size());
        final ExtensionStatement extensionStatement = moduleStatement.getExtensions().iterator().next();
        assertEquals(Status.CURRENT, extensionStatement.getStatus().getValue());
        assertEquals("test description", extensionStatement.getDescription().getText());
        assertEquals("test reference", extensionStatement.getReference().getText());
        final ArgumentStatement argumentStatement = extensionStatement.getArgument();
        assertEquals("ext-argument", argumentStatement.getName().getLocalName());
        assertTrue(argumentStatement.getYinElement().getValue());

        assertEquals(1, moduleStatement.getFeatures().size());
        final FeatureStatement featureStatement = moduleStatement.getFeatures().iterator().next();
        assertEquals(Status.CURRENT, featureStatement.getStatus().getValue());
        assertEquals("test description", featureStatement.getDescription().getText());
        assertEquals("test reference", featureStatement.getReference().getText());
        assertEquals("test-feature", featureStatement.getName().getLocalName());
        assertEquals(1, featureStatement.getIfFeatures().size());

        assertEquals(2, moduleStatement.getIdentities().size());
        IdentityStatement identityStatement = null;
        for (final IdentityStatement identity : moduleStatement.getIdentities()) {
            if (identity.getName().getLocalName().equals("test-id")) {
                identityStatement = identity;
            }
        }

        assertEquals("test-base-id", identityStatement.getBase().getName().getLocalName());
        assertEquals(Status.CURRENT, identityStatement.getStatus().getValue());
        assertEquals("test description", identityStatement.getDescription().getText());
        assertEquals("test reference", identityStatement.getReference().getText());
        assertEquals("test-id", identityStatement.getName().getLocalName());

        assertEquals(1, moduleStatement.getTypedefs().size());
        final TypedefStatement typedefStatement = moduleStatement.getTypedefs().iterator().next();
        assertEquals(Status.CURRENT, typedefStatement.getStatus().getValue());
        assertEquals("test description", typedefStatement.getDescription().getText());
        assertEquals("test reference", typedefStatement.getReference().getText());
        assertEquals("test-typedef", typedefStatement.getName().getLocalName());
        assertEquals("int32", typedefStatement.getType().getName());
        assertEquals("meter", typedefStatement.getUnits().getName());
    }

    @Test
    public void testDeclaredContainer() throws ReactorException {
        final StatementStreamSource containerStmtModule =
                sourceForResource("/declared-statements-test/container-declared-test.yang");

        final SchemaContext schemaContext = StmtTestUtils.parseYangSources(containerStmtModule);
        assertNotNull(schemaContext);

        final Module testModule = schemaContext.findModuleByName("container-declared-test", null);
        assertNotNull(testModule);

        final ContainerSchemaNode containerSchemaNode = (ContainerSchemaNode) testModule.getDataChildByName(
                QName.create(testModule.getQNameModule(), "test-container"));
        assertNotNull(containerSchemaNode);
        final ContainerStatement containerStatement = ((ContainerEffectiveStatementImpl) containerSchemaNode).getDeclared();

        final QName name = containerStatement.getName();
        assertNotNull(name);

        final WhenStatement containerStatementWhen = containerStatement.getWhenStatement();
        assertNotNull(containerStatementWhen);

        final Collection<? extends IfFeatureStatement> containerStatementIfFeatures = containerStatement.getIfFeatures();
        assertNotNull(containerStatementIfFeatures);
        assertEquals(1, containerStatementIfFeatures.size());

        final Collection<? extends MustStatement> containerStatementMusts = containerStatement.getMusts();
        assertNotNull(containerStatementMusts);
        assertEquals(1, containerStatementMusts.size());

        final PresenceStatement containerStatementPresence = containerStatement.getPresence();
        assertNotNull(containerStatementPresence);
        assertNotNull(containerStatementPresence.getValue());

        final ConfigStatement containerStatementConfig = containerStatement.getConfig();
        assertNotNull(containerStatementConfig);

        final StatusStatement containerStatementStatus = containerStatement.getStatus();
        assertNotNull(containerStatementStatus);

        final DescriptionStatement containerStatementDescription = containerStatement.getDescription();
        assertNotNull(containerStatementDescription);

        final ReferenceStatement containerStatementReference = containerStatement.getReference();
        assertNotNull(containerStatementReference);

        final Collection<? extends TypedefStatement> containerStatementTypedefs = containerStatement.getTypedefs();
        assertNotNull(containerStatementTypedefs);
        assertEquals(1, containerStatementTypedefs.size());

        final Collection<? extends GroupingStatement> containerStatementGroupings = containerStatement.getGroupings();
        assertNotNull(containerStatementGroupings);
        assertEquals(1, containerStatementGroupings.size());

        final Collection<? extends DataDefinitionStatement> containerStatementDataDefinitions =
                containerStatement.getDataDefinitions();

        assertNotNull(containerStatementDataDefinitions);
        assertEquals(1, containerStatementDataDefinitions.size());
    }
}