utils/yangutils/src/test/java/org/onosproject/yangutils/parser/impl/listeners/RangeRestrictionListenerTest.java

/*
 * Copyright 2016-present Open Networking Laboratory
 *
 * 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.
 */

package org.onosproject.yangutils.parser.impl.listeners;

import java.io.IOException;
import java.util.ListIterator;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.onosproject.yangutils.datamodel.YangDataTypes;
import org.onosproject.yangutils.datamodel.YangLeaf;
import org.onosproject.yangutils.datamodel.YangLeafList;
import org.onosproject.yangutils.datamodel.YangModule;
import org.onosproject.yangutils.datamodel.YangNode;
import org.onosproject.yangutils.datamodel.YangNodeType;
import org.onosproject.yangutils.datamodel.YangRangeInterval;
import org.onosproject.yangutils.datamodel.YangRangeRestriction;
import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.YangUtilsParserManager;
import org.onosproject.yangutils.utils.builtindatatype.YangInt32;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.Is.is;

/**
 * Test cases for range restriction listener.
 */
public class RangeRestrictionListenerTest {

    @Rule
    public ExpectedException thrown = ExpectedException.none();

    private final YangUtilsParserManager manager = new YangUtilsParserManager();

    /**
     * Checks valid range statement as sub-statement of leaf statement.
     */
    @Test
    public void processValidRangeStatement() throws IOException, ParserException {

        YangNode node = manager.getDataModel("src/test/resources/ValidRangeStatement.yang");

        assertThat((node instanceof YangModule), is(true));
        assertThat(node.getNodeType(), is(YangNodeType.MODULE_NODE));
        YangModule yangNode = (YangModule) node;
        assertThat(yangNode.getName(), is("Test"));

        ListIterator<YangLeaf> leafIterator = yangNode.getListOfLeaf().listIterator();
        YangLeaf leafInfo = leafIterator.next();

        assertThat(leafInfo.getName(), is("invalid-interval"));
        assertThat(leafInfo.getDataType().getDataTypeName(), is("int32"));
        assertThat(leafInfo.getDataType().getDataType(), is(YangDataTypes.INT32));
        YangRangeRestriction rangeRestriction = (YangRangeRestriction) leafInfo
                .getDataType().getDataTypeExtendedInfo();

        ListIterator<YangRangeInterval> rangeListIterator = rangeRestriction.getAscendingRangeIntervals()
                .listIterator();
        YangRangeInterval rangeInterval = rangeListIterator.next();
        assertThat(((YangInt32) rangeInterval.getStartValue()).getValue(), is(1));
        assertThat(((YangInt32) rangeInterval.getEndValue()).getValue(), is(4));
    }

    /**
     * Checks valid range statement as sub-statement of leaf-list.
     */
    @Test
    public void processRangeStatementInsideLeafList() throws IOException, ParserException {

        YangNode node = manager.getDataModel("src/test/resources/RangeStatementInsideLeafList.yang");

        assertThat((node instanceof YangModule), is(true));
        assertThat(node.getNodeType(), is(YangNodeType.MODULE_NODE));
        YangModule yangNode = (YangModule) node;
        assertThat(yangNode.getName(), is("Test"));

        ListIterator<YangLeafList> leafListIterator = yangNode.getListOfLeafList().listIterator();
        YangLeafList leafListInfo = leafListIterator.next();

        assertThat(leafListInfo.getName(), is("invalid-interval"));
        assertThat(leafListInfo.getDataType().getDataTypeName(), is("int32"));
        assertThat(leafListInfo.getDataType().getDataType(), is(YangDataTypes.INT32));
        YangRangeRestriction rangeRestriction = (YangRangeRestriction) leafListInfo
                .getDataType().getDataTypeExtendedInfo();

        ListIterator<YangRangeInterval> rangeListIterator = rangeRestriction.getAscendingRangeIntervals()
                .listIterator();
        YangRangeInterval rangeInterval = rangeListIterator.next();

        assertThat(((YangInt32) rangeInterval.getStartValue()).getValue(), is(1));
        assertThat(((YangInt32) rangeInterval.getEndValue()).getValue(), is(4));
    }

    /**
     * Checks valid range statement with one interval.
     */
    @Test
    public void processRangeWithOneInterval() throws IOException, ParserException {

        YangNode node = manager.getDataModel("src/test/resources/RangeWithOneInterval.yang");

        assertThat((node instanceof YangModule), is(true));
        assertThat(node.getNodeType(), is(YangNodeType.MODULE_NODE));
        YangModule yangNode = (YangModule) node;
        assertThat(yangNode.getName(), is("Test"));

        ListIterator<YangLeafList> leafListIterator = yangNode.getListOfLeafList().listIterator();
        YangLeafList leafListInfo = leafListIterator.next();

        assertThat(leafListInfo.getName(), is("invalid-interval"));
        assertThat(leafListInfo.getDataType().getDataTypeName(), is("int32"));
        assertThat(leafListInfo.getDataType().getDataType(), is(YangDataTypes.INT32));
        YangRangeRestriction rangeRestriction = (YangRangeRestriction) leafListInfo
                .getDataType().getDataTypeExtendedInfo();

        ListIterator<YangRangeInterval> rangeListIterator = rangeRestriction.getAscendingRangeIntervals()
                .listIterator();
        YangRangeInterval rangeInterval = rangeListIterator.next();

        assertThat(((YangInt32) rangeInterval.getStartValue()).getValue(), is(1));
        assertThat(((YangInt32) rangeInterval.getEndValue()).getValue(), is(1));
    }

    /**
     * Checks valid range statement with min and max.
     */
    @Test
    public void processRangeWithMinMax() throws IOException, ParserException {

        YangNode node = manager.getDataModel("src/test/resources/RangeWithMinMax.yang");

        assertThat((node instanceof YangModule), is(true));
        assertThat(node.getNodeType(), is(YangNodeType.MODULE_NODE));
        YangModule yangNode = (YangModule) node;
        assertThat(yangNode.getName(), is("Test"));

        ListIterator<YangLeafList> leafListIterator = yangNode.getListOfLeafList().listIterator();
        YangLeafList leafListInfo = leafListIterator.next();

        assertThat(leafListInfo.getName(), is("invalid-interval"));
        assertThat(leafListInfo.getDataType().getDataTypeName(), is("int32"));
        assertThat(leafListInfo.getDataType().getDataType(), is(YangDataTypes.INT32));
        YangRangeRestriction rangeRestriction = (YangRangeRestriction) leafListInfo
                .getDataType().getDataTypeExtendedInfo();

        ListIterator<YangRangeInterval> rangeListIterator = rangeRestriction.getAscendingRangeIntervals()
                .listIterator();
        YangRangeInterval rangeInterval = rangeListIterator.next();

        assertThat(((YangInt32) rangeInterval.getStartValue()).getValue(), is(-2147483648));
        assertThat(((YangInt32) rangeInterval.getEndValue()).getValue(), is(2147483647));
    }

    /**
     * Checks valid range statement with invalid integer pattern.
     */
    @Test
    public void processRangeWithInvalidIntegerPattern() throws IOException, ParserException {
        thrown.expect(ParserException.class);
        thrown.expectMessage("YANG file error : Input value \"a\" is not a valid int32.");
        YangNode node = manager.getDataModel("src/test/resources/RangeWithInvalidIntegerPattern.yang");
    }

    /**
     * Checks valid range statement with description.
     */
    @Test
    public void processRangeSubStatements() throws IOException, ParserException {

        YangNode node = manager.getDataModel("src/test/resources/RangeSubStatements.yang");

        assertThat((node instanceof YangModule), is(true));
        assertThat(node.getNodeType(), is(YangNodeType.MODULE_NODE));
        YangModule yangNode = (YangModule) node;
        assertThat(yangNode.getName(), is("Test"));

        ListIterator<YangLeaf> leafIterator = yangNode.getListOfLeaf().listIterator();
        YangLeaf leafInfo = leafIterator.next();

        assertThat(leafInfo.getName(), is("invalid-interval"));
        assertThat(leafInfo.getDataType().getDataTypeName(), is("int32"));
        assertThat(leafInfo.getDataType().getDataType(), is(YangDataTypes.INT32));
        YangRangeRestriction rangeRestriction = (YangRangeRestriction) leafInfo
                .getDataType().getDataTypeExtendedInfo();

        assertThat(rangeRestriction.getDescription(), is("\"range description\""));
        assertThat(rangeRestriction.getReference(), is("\"range reference\""));

        ListIterator<YangRangeInterval> rangeListIterator = rangeRestriction.getAscendingRangeIntervals()
                .listIterator();
        YangRangeInterval rangeInterval = rangeListIterator.next();
        assertThat(((YangInt32) rangeInterval.getStartValue()).getValue(), is(1));
        assertThat(((YangInt32) rangeInterval.getEndValue()).getValue(), is(4));
        assertThat(((YangInt32) rangeInterval.getEndValue()).getValue(), is(4));
    }

    /**
     * Checks whether space can be allowed when range statement is present.
     */
    @Test
    public void processRangeStatementWithSpace() throws IOException, ParserException {

        YangNode node = manager.getDataModel("src/test/resources/RangeStatementWithSpace.yang");

        assertThat((node instanceof YangModule), is(true));
        assertThat(node.getNodeType(), is(YangNodeType.MODULE_NODE));
        YangModule yangNode = (YangModule) node;
        assertThat(yangNode.getName(), is("Test"));

        ListIterator<YangLeaf> leafIterator = yangNode.getListOfLeaf().listIterator();
        YangLeaf leafInfo = leafIterator.next();

        assertThat(leafInfo.getName(), is("invalid-interval"));
        assertThat(leafInfo.getDataType().getDataTypeName(), is("int32"));
        assertThat(leafInfo.getDataType().getDataType(), is(YangDataTypes.INT32));
        YangRangeRestriction rangeRestriction = (YangRangeRestriction) leafInfo
                .getDataType().getDataTypeExtendedInfo();

        ListIterator<YangRangeInterval> rangeListIterator = rangeRestriction.getAscendingRangeIntervals()
                .listIterator();
        YangRangeInterval rangeInterval = rangeListIterator.next();
        assertThat(((YangInt32) rangeInterval.getStartValue()).getValue(), is(1));
        assertThat(((YangInt32) rangeInterval.getEndValue()).getValue(), is(4));
    }
}