package io.fd.honeycomb.data.impl;
-import static org.hamcrest.CoreMatchers.is;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertThat;
-import static org.junit.Assert.assertTrue;
-import static org.mockito.Matchers.any;
-import static org.mockito.Matchers.anyListOf;
-import static org.mockito.Matchers.eq;
-import static org.mockito.Mockito.atLeastOnce;
-import static org.mockito.Mockito.atMost;
-import static org.mockito.Mockito.doAnswer;
-import static org.mockito.Mockito.doReturn;
-import static org.mockito.Mockito.inOrder;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.verifyNoMoreInteractions;
-
import com.google.common.base.Optional;
import com.google.common.collect.Lists;
import com.google.common.collect.Multimap;
import io.fd.honeycomb.translate.util.RWUtils;
import io.fd.honeycomb.translate.util.read.ReflexiveListReaderCustomizer;
import io.fd.honeycomb.translate.util.read.ReflexiveReaderCustomizer;
-import java.lang.reflect.InvocationTargetException;
-import java.util.List;
-import java.util.stream.Collectors;
-import javax.annotation.Nonnull;
import org.junit.Test;
import org.mockito.InOrder;
import org.mockito.Mock;
import org.mockito.exceptions.misusing.MockitoConfigurationException;
import org.mockito.invocation.InvocationOnMock;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.ComplexAugment;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.ComplexAugmentBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.ContainerWithList;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.ContainerWithListBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.SimpleAugment;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.SimpleAugmentBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.SimpleContainer;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.SimpleContainerBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.*;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.container.with.list.ListInContainer;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.container.with.list.ListInContainerBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hc.test.rev150105.container.with.list.ListInContainerKey;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import javax.annotation.Nonnull;
+import java.lang.reflect.InvocationTargetException;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.junit.Assert.*;
+import static org.mockito.Matchers.any;
+import static org.mockito.Matchers.anyListOf;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.*;
+
public class HoneycombReadInfraTest extends AbstractInfraTest {
@Mock
// 2.1
private ListReader<ListInContainer, ListInContainerKey, ListInContainerBuilder> listInContainerReader =
mockListReader(Ids.LIST_IN_CONTAINER_ID, this::readListInContainer, this::getListInContainerIds,
- ListInContainerBuilder.class);
+ ListInContainerBuilder.class, ctx);
// 2.1.1
private Reader<ContainerInList, ContainerInListBuilder> containerInListReader =
mockReader(Ids.CONTAINER_IN_LIST_ID, this::readContainerInList, ContainerInListBuilder.class);
// 2.1.1.1
private ListReader<NestedList, NestedListKey, NestedListBuilder> nestedListReader =
mockListReader(Ids.NESTED_LIST_ID, this::readNestedList, this::getNestedListIds,
- NestedListBuilder.class);
+ NestedListBuilder.class, ctx);
@Override
void postSetup() {
InstanceIdentifier<D> id,
CurrentAttributesReader<D, B> currentAttributesReader,
ListKeysReader<D, K> listKeysReader,
- Class<B> builderClass) {
+ Class<B> builderClass,
+ ReadContext ctx) {
ListReader<D, K, B> reflex = new GenericListReader<>(id,
- new ReflexiveListReaderCustomizer<D, K, B>(id.getTargetType(), builderClass) {
-
- @Nonnull
- @Override
- public List<K> getAllIds(@Nonnull final InstanceIdentifier<D> id, @Nonnull final ReadContext context)
- throws ReadFailedException {
- return listKeysReader.getAllIds(id, context);
- }
+ new ReflexiveListReaderCustomizer<D, K, B>(id.getTargetType(), builderClass, listKeysReader.getAllIds(id, ctx)) {
@Override
public void readCurrentAttributes(final InstanceIdentifier<D> id, final B builder,
import io.fd.honeycomb.translate.read.registry.ReaderRegistry;
import io.fd.honeycomb.translate.util.read.ReflexiveListReaderCustomizer;
import io.fd.honeycomb.translate.impl.read.registry.CompositeReaderRegistryBuilder;
+
+import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import javax.annotation.Nonnull;
private ListReader<ListInContainer, ListInContainerKey, ListInContainerBuilder> listInContainerReader =
new GenericListReader<>(Ids.LIST_IN_CONTAINER_ID,
- new ReflexiveListReaderCustomizer<ListInContainer, ListInContainerKey, ListInContainerBuilder>(Ids.LIST_IN_CONTAINER_ID.getTargetType(), ListInContainerBuilder.class) {
-
- @Nonnull
- @Override
- public List<ListInContainerKey> getAllIds(@Nonnull final InstanceIdentifier<ListInContainer> id,
- @Nonnull final ReadContext context)
- throws ReadFailedException {
- // This is the only way of extending subtree reader's list child
- // Reflexive list reader has to be used in place of the list(managed by subtree reader perent)
- // to enable further children readers. However, it will not work out of the box, because
- // reflexive list reader has no way to tell what are the IDs to correctly invoke its children.
- // Only way is to override the getAllIds method in reflexive reader and return the same list
- // as parent used (this can be done using cache or repeated dump call)
- return Lists.newArrayList(new ListInContainerKey(1L), new ListInContainerKey(2L));
- }
-
+ new ReflexiveListReaderCustomizer<ListInContainer, ListInContainerKey, ListInContainerBuilder>(Ids.LIST_IN_CONTAINER_ID.getTargetType(), ListInContainerBuilder.class,
+ Lists.newArrayList(new ListInContainerKey(1L), new ListInContainerKey(2L))) {
@Override
public void readCurrentAttributes(final InstanceIdentifier<ListInContainer> id,
final ListInContainerBuilder builder,
import javax.annotation.Nonnull;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.Identifiable;
+import org.opendaylight.yangtools.yang.binding.Identifier;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import java.util.List;
+
/**
* Mutable registry that allows adding new readers.
*/
*/
<D extends DataObject> void addStructuralReader(@Nonnull InstanceIdentifier<D> id,
@Nonnull Class<? extends Builder<D>> builderType);
+ /**
+ * Construct customizer that will always return static list of keys.
+ * */
+ <D extends DataObject & Identifiable<K>,K extends Identifier<D>> void addStructuralListReader(@Nonnull InstanceIdentifier<D> id,
+ @Nonnull Class<? extends Builder<D>> builderType,
+ @Nonnull List<K> staticKeys);
}
import io.fd.honeycomb.translate.read.ListReader;
import io.fd.honeycomb.translate.read.ReadContext;
import io.fd.honeycomb.translate.read.ReadFailedException;
+import io.fd.honeycomb.translate.read.Reader;
import io.fd.honeycomb.translate.spi.read.ListReaderCustomizer;
import io.fd.honeycomb.translate.util.RWUtils;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnull;
import javax.annotation.concurrent.ThreadSafe;
+
+import io.fd.honeycomb.translate.util.read.ReflexiveListReaderCustomizer;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.Identifiable;
public void merge(@Nonnull final Builder<? extends DataObject> builder, @Nonnull final List<C> readData) {
((ListReaderCustomizer<C, K, B>) customizer).merge(builder, readData);
}
+
+ public static <C extends DataObject & Identifiable<K>,K extends Identifier<C>, B extends Builder<C>> Reader<C, B> createReflexive(
+ final InstanceIdentifier<C> id, Class<B> builderClass,
+ final List<K> staticKeys) {
+ return new GenericListReader<>(id, new ReflexiveListReaderCustomizer<>(id.getTargetType(), builderClass, staticKeys));
+ }
}
package io.fd.honeycomb.translate.impl.read.registry;
import com.google.common.collect.ImmutableMap;
+import io.fd.honeycomb.translate.impl.read.GenericListReader;
import io.fd.honeycomb.translate.impl.read.GenericReader;
import io.fd.honeycomb.translate.read.InitReader;
import io.fd.honeycomb.translate.read.Initializer;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.Identifiable;
+import org.opendaylight.yangtools.yang.binding.Identifier;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@Override
public <D extends DataObject> void addStructuralReader(@Nonnull InstanceIdentifier<D> id,
@Nonnull Class<? extends Builder<D>> builderType) {
- // TODO https://jira.fd.io/browse/HONEYCOMB-344 provide variant of this method for list nodes
// prevent case to submit structural reader for list, which would cause fail because target setter consumes
- // List<TargetType>, not Target type. If node is static, customizer that handles it should return static list
- // of IDs.
- checkArgument(!Identifiable.class.isAssignableFrom(id.getTargetType()), "Structural readers cannot be used for keyed nodes[node type %s]", id.getTargetType());
+ // List<TargetType>, not Target type. If node is static list, addStructuralListReader should be used
+ checkArgument(!Identifiable.class.isAssignableFrom(id.getTargetType()), "Structural readers cannot be used for keyed nodes[node type %s], use addStructuralListReader()", id.getTargetType());
add(GenericReader.createReflexive(id, builderType));
}
+ @Override
+ public <D extends DataObject & Identifiable<K>, K extends Identifier<D>> void addStructuralListReader(@Nonnull InstanceIdentifier<D> id, @Nonnull Class<? extends Builder<D>> builderType, @Nonnull List<K> staticKeys) {
+ checkArgument(Identifiable.class.isAssignableFrom(id.getTargetType()), "Node %s is not keyed, use addStructuralReader()", id.getTargetType());
+ add(GenericListReader.createReflexive(id, builderType, staticKeys));
+ }
+
/**
* Create {@link CompositeReaderRegistry} with Readers ordered according to submitted relationships.
* <p/>
<artifactId>junit</artifactId>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.hamcrest</groupId>
+ <artifactId>hamcrest-all</artifactId>
+ <scope>test</scope>
+ </dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
package io.fd.honeycomb.translate.util.read;
-import static com.google.common.base.Preconditions.checkArgument;
-
import com.google.common.base.Optional;
+import io.fd.honeycomb.translate.read.ReadContext;
+import io.fd.honeycomb.translate.read.ReadFailedException;
import io.fd.honeycomb.translate.spi.read.ListReaderCustomizer;
import io.fd.honeycomb.translate.util.ReflectionUtils;
-import java.lang.reflect.InvocationTargetException;
-import java.lang.reflect.Method;
-import java.util.Collections;
-import java.util.List;
-import javax.annotation.Nonnull;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.Identifiable;
import org.opendaylight.yangtools.yang.binding.Identifier;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+import javax.annotation.Nonnull;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.Collections;
+import java.util.List;
+
+import static com.google.common.base.Preconditions.*;
/**
* Might be slow.
*/
-public abstract class ReflexiveListReaderCustomizer<C extends DataObject & Identifiable<K>, K extends Identifier<C>, B extends Builder<C>>
+public class ReflexiveListReaderCustomizer<C extends DataObject & Identifiable<K>, K extends Identifier<C>, B extends Builder<C>>
extends ReflexiveReaderCustomizer<C, B>
implements ListReaderCustomizer<C, K, B> {
+ private final List<K> staticKeys;
- public ReflexiveListReaderCustomizer(final Class<C> typeClass, final Class<B> builderClass) {
+ public ReflexiveListReaderCustomizer(@Nonnull final Class<C> typeClass, @Nonnull final Class<B> builderClass,
+ @Nonnull final List<K> staticKeys) {
super(typeClass, builderClass);
+ this.staticKeys = checkNotNull(staticKeys, "Static keys cannot be null");
+ checkState(!this.staticKeys.isEmpty(), "No static keys provided");
}
@Override
throw new IllegalArgumentException("Unable to set " + readData + " to " + parentBuilder, e);
}
}
+
+ @Nonnull
+ @Override
+ public List<K> getAllIds(@Nonnull InstanceIdentifier<C> id, @Nonnull ReadContext context) throws ReadFailedException {
+ return staticKeys;
+ }
}
--- /dev/null
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ *
+ * 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 io.fd.honeycomb.translate.util.read;
+
+import io.fd.honeycomb.translate.read.ReadContext;
+import io.fd.honeycomb.translate.read.ReadFailedException;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.opendaylight.yangtools.concepts.Builder;
+import org.opendaylight.yangtools.yang.binding.*;
+
+import java.util.Arrays;
+import java.util.List;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.contains;
+import static org.hamcrest.Matchers.hasSize;
+
+public class ReflexiveListReaderCustomizerTest {
+
+ static class TestingListObject implements DataObject, Identifiable<TestingListObject.TestingListKey> {
+
+ private final TestingListKey key;
+
+ TestingListObject(final TestingListKey key) {
+ this.key = key;
+ }
+
+ @Override
+ public Class<? extends DataContainer> getImplementedInterface() {
+ return DataObject.class;
+ }
+
+ @Override
+ public TestingListKey getKey() {
+ return key;
+ }
+
+ static class TestingListKey implements Identifier<TestingListObject> {
+
+ private final String value;
+
+ TestingListKey(final String value) {
+ this.value = value;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+
+ TestingListKey that = (TestingListKey) o;
+
+ return value.equals(that.value);
+ }
+
+ @Override
+ public int hashCode() {
+ return value.hashCode();
+ }
+ }
+ }
+
+ static class TestingListObjectBuilder implements Builder<TestingListObject> {
+
+ private final TestingListObject.TestingListKey key;
+
+ TestingListObjectBuilder(final TestingListObject.TestingListKey key) {
+ this.key = key;
+ }
+
+ @Override
+ public TestingListObject build() {
+ return new TestingListObject(key);
+ }
+ }
+
+ @Mock
+ private ReadContext readContext;
+
+ @Before
+ public void init() {
+ MockitoAnnotations.initMocks(this);
+ }
+
+ @Test
+ public void testStaticKeys() throws ReadFailedException {
+ final TestingListObject.TestingListKey keyOne = new TestingListObject.TestingListKey("1");
+ final TestingListObject.TestingListKey keyTwo = new TestingListObject.TestingListKey("2");
+ final List<TestingListObject.TestingListKey> staticKeys = Arrays.asList(keyOne, keyTwo);
+
+ final ReflexiveListReaderCustomizer<TestingListObject, TestingListObject.TestingListKey, TestingListObjectBuilder> customizer
+ = new ReflexiveListReaderCustomizer<>(TestingListObject.class, TestingListObjectBuilder.class, staticKeys);
+
+ final List<TestingListObject.TestingListKey> allIds = customizer.getAllIds(InstanceIdentifier.create(TestingListObject.class), readContext);
+
+ assertThat(allIds, hasSize(2));
+ assertThat(allIds, contains(keyOne, keyTwo));
+ }
+}
package io.fd.honeycomb.translate.util.read;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-import static org.mockito.Mockito.spy;
-import static org.mockito.Mockito.verifyZeroInteractions;
-
import com.google.common.collect.Lists;
import io.fd.honeycomb.translate.read.ReadContext;
-import io.fd.honeycomb.translate.read.ReadFailedException;
-import java.util.Collections;
-import java.util.List;
-import javax.annotation.Nonnull;
import org.junit.Test;
import org.mockito.Mock;
import org.opendaylight.yangtools.concepts.Builder;
-import org.opendaylight.yangtools.yang.binding.Augmentation;
-import org.opendaylight.yangtools.yang.binding.DataContainer;
-import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.binding.Identifiable;
-import org.opendaylight.yangtools.yang.binding.Identifier;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.binding.*;
+
+import javax.annotation.Nonnull;
+import java.util.Collections;
+import java.util.List;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.verifyZeroInteractions;
public class ReflexiveReaderCustomizerTest {
final ReflexiveListReaderCustomizer<TestingListObject, TestingListObject.TestingListKey, TestingListBuilder>
reflexReaderCustomizer =
new ReflexiveListReaderCustomizer<TestingListObject, TestingListObject.TestingListKey, TestingListBuilder>
- (TestingListObject.class, TestingListBuilder.class) {
-
- @Nonnull
- @Override
- public List<TestingListObject.TestingListKey> getAllIds(
- @Nonnull final InstanceIdentifier<TestingListObject> id,
- @Nonnull final ReadContext context) throws ReadFailedException {
- return Lists.newArrayList();
- }
- };
+ (TestingListObject.class, TestingListBuilder.class, Collections.singletonList(new TestingListObject.TestingListKey()));
final TestingBuilderParent parentBuilder = new TestingBuilderParent();
final List<TestingListObject> readValue = Lists.newArrayList(new TestingListObject(), new TestingListObject());