binding/mdsal-binding-dom-adapter/src/test/java/org/opendaylight/mdsal/binding/dom/adapter/query/QueryBuilderTest.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.dom.adapter.query;
   9
  10 import static org.junit.Assert.assertEquals;
  11
  12 import com.google.common.base.Stopwatch;
  13 import java.util.List;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.junit.AfterClass;
  16 import org.junit.Before;
  17 import org.junit.BeforeClass;
  18 import org.junit.Test;
  19 import org.opendaylight.mdsal.binding.api.query.QueryExecutor;
  20 import org.opendaylight.mdsal.binding.api.query.QueryExpression;
  21 import org.opendaylight.mdsal.binding.api.query.QueryFactory;
  22 import org.opendaylight.mdsal.binding.api.query.QueryResult;
  23 import org.opendaylight.mdsal.binding.api.query.QueryResult.Item;
  24 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
  25 import org.opendaylight.mdsal.binding.dom.codec.impl.DefaultBindingCodecTreeFactory;
  26 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
  27 import org.opendaylight.yang.gen.v1.mdsal.query.norev.Foo;
  28 import org.opendaylight.yang.gen.v1.mdsal.query.norev.FooBuilder;
  29 import org.opendaylight.yang.gen.v1.mdsal.query.norev.first.grp.System;
  30 import org.opendaylight.yang.gen.v1.mdsal.query.norev.first.grp.SystemBuilder;
  31 import org.opendaylight.yang.gen.v1.mdsal.query.norev.first.grp.SystemKey;
  32 import org.opendaylight.yang.gen.v1.mdsal.query.norev.second.grp.Alarms;
  33 import org.opendaylight.yang.gen.v1.mdsal.query.norev.second.grp.AlarmsBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.Top;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.two.level.list.TopLevelList;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.two.level.list.top.level.list.NestedList;
  37 import org.opendaylight.yangtools.yang.binding.DataObject;
  38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.binding.util.BindingMap;
  40 import org.opendaylight.yangtools.yang.common.Empty;
  41 import org.opendaylight.yangtools.yang.common.Uint64;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 public class QueryBuilderTest {
  46     private static final Logger LOG = LoggerFactory.getLogger(QueryBuilderTest.class);
  47     private static BindingCodecTree CODEC;
  48
  49     private final QueryFactory factory = new DefaultQueryFactory(CODEC);
  50     private QueryExecutor executor;
  51
  52     @BeforeClass
  53     public static final void beforeClass() {
  54         CODEC = new DefaultBindingCodecTreeFactory().create(BindingRuntimeHelpers.createRuntimeContext());
  55     }
  56
  57     @AfterClass
  58     public static final void afterClass() {
  59         CODEC = null;
  60     }
  61
  62     @Before
  63     public void before() {
  64         executor = SimpleQueryExecutor.builder(CODEC)
  65             .add(new FooBuilder()
  66                 .setSystem(BindingMap.of(
  67                     new SystemBuilder().setName("first").setAlarms(BindingMap.of(
  68                         new AlarmsBuilder()
  69                             .setId(Uint64.ZERO)
  70                             .setCritical(Empty.getInstance())
  71                             .setAffectedUsers(BindingMap.of(
  72                                 // TODO: fill
  73                             )).build(),
  74                         new AlarmsBuilder()
  75                             .setId(Uint64.ONE)
  76                             .setAffectedUsers(BindingMap.of(
  77                                 // TODO: fill
  78                             )).build(),
  79                         new AlarmsBuilder()
  80                             .setId(Uint64.TWO)
  81                             .setCritical(Empty.getInstance())
  82                             .setAffectedUsers(BindingMap.of(
  83                                 // TODO: fill
  84                                 )).build())).build(),
  85                     new SystemBuilder().setName("second").setAlarms(BindingMap.of(
  86                         new AlarmsBuilder()
  87                         .setId(Uint64.ZERO)
  88                         .setCritical(Empty.getInstance())
  89                         .setAffectedUsers(BindingMap.of(
  90                             // TODO: fill
  91                         )).build())).build()
  92                     ))
  93                 .build())
  94             .build();
  95     }
  96
  97     @Test
  98     public void bar() {
  99         final Stopwatch sw = Stopwatch.createStarted();
 100         final QueryExpression<TopLevelList> query = factory.querySubtree(InstanceIdentifier.create(Top.class))
 101                 .extractChild(TopLevelList.class)
 102                 .matching()
 103                     .childObject(NestedList.class)
 104                     .leaf(NestedList::getName).contains("foo")
 105                     .and().leaf(TopLevelList::getName).valueEquals("bar")
 106                 .build();
 107         LOG.info("Query built in {}", sw);
 108
 109         assertEquals(0, execute(query).getItems().size());
 110     }
 111
 112     @Test
 113     public void testFindCriticalAlarms() {
 114         final Stopwatch sw = Stopwatch.createStarted();
 115         final QueryExpression<Alarms> query = factory.querySubtree(InstanceIdentifier.create(Foo.class))
 116             .extractChild(System.class)
 117             .extractChild(Alarms.class)
 118                 .matching()
 119                     .leaf(Alarms::getCritical).nonNull()
 120                 .build();
 121         LOG.info("Query built in {}", sw);
 122
 123         final List<? extends Item<@NonNull Alarms>> items = execute(query).getItems();
 124         assertEquals(3, items.size());
 125     }
 126
 127     @Test
 128     public void testFindNonCriticalAlarms() {
 129         final Stopwatch sw = Stopwatch.createStarted();
 130         final QueryExpression<Alarms> query = factory.querySubtree(InstanceIdentifier.create(Foo.class))
 131             .extractChild(System.class)
 132             .extractChild(Alarms.class)
 133                 .matching()
 134                     .leaf(Alarms::getCritical).isNull()
 135                 .build();
 136         LOG.info("Query built in {}", sw);
 137
 138         final List<? extends Item<@NonNull Alarms>> items = execute(query).getItems();
 139         assertEquals(1, items.size());
 140     }
 141
 142     @Test
 143     public void testFindZeroAlarms() {
 144         final Stopwatch sw = Stopwatch.createStarted();
 145         final QueryExpression<Alarms> query = factory.querySubtree(InstanceIdentifier.create(Foo.class))
 146             .extractChild(System.class)
 147             .extractChild(Alarms.class)
 148                 .matching()
 149                     .leaf(Alarms::getId).valueEquals(Uint64.ZERO)
 150                 .build();
 151         LOG.info("Query built in {}", sw);
 152
 153         final List<? extends Item<@NonNull Alarms>> items = execute(query).getItems();
 154         assertEquals(2, items.size());
 155     }
 156
 157     @Test
 158     public void testFindSystemFirstAlarmOne() {
 159         final Stopwatch sw = Stopwatch.createStarted();
 160         final QueryExpression<Alarms> query = factory.querySubtree(InstanceIdentifier.create(Foo.class))
 161             .extractChild(System.class, new SystemKey("first"))
 162             .extractChild(Alarms.class)
 163                 .matching()
 164                     .leaf(Alarms::getId).valueEquals(Uint64.ZERO)
 165                 .build();
 166         LOG.info("Query built in {}", sw);
 167
 168         final List<? extends Item<@NonNull Alarms>> items = execute(query).getItems();
 169         assertEquals(1, items.size());
 170     }
 171
 172     @Test
 173     public void testFindSystemFirstWithAlarmOne() {
 174         final Stopwatch sw = Stopwatch.createStarted();
 175         final QueryExpression<System> query = factory.querySubtree(InstanceIdentifier.create(Foo.class))
 176             .extractChild(System.class, new SystemKey("first"))
 177                 .matching()
 178                     .childObject(Alarms.class)
 179                         .leaf(Alarms::getId).valueEquals(Uint64.ZERO)
 180                 .build();
 181         LOG.info("Query built in {}", sw);
 182
 183         final List<? extends Item<@NonNull System>> items = execute(query).getItems();
 184         assertEquals(1, items.size());
 185     }
 186
 187
 188     private <T extends @NonNull DataObject> QueryResult<T> execute(final QueryExpression<T> query) {
 189         final Stopwatch sw = Stopwatch.createStarted();
 190         final QueryResult<T> result = executor.executeQuery(query);
 191         LOG.info("Query executed in {}", sw);
 192         return result;
 193     }
 194 }