HONEYCOMB-94 Reimplement writer registry with better ordering options

Now the registry is flat and allows for full control of writer execution order

Change-Id: I864e1d676588ffe59b596145e0829e81b1a1ed2f
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>

2 files changed, 0 insertions, 334 deletions

diff --git a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vpp/VppTest.java b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vpp/VppTest.java
deleted file mode 100644
index e713c623d..000000000
--- a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vpp/VppTest.java
+++ /dev/null
@@ -1,271 +0,0 @@
-/*
- * Copyright (c) 2016 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.v3po.translate.v3po.vpp;
-
-import static io.fd.honeycomb.v3po.translate.v3po.test.ContextTestUtils.getMapping;
-import static io.fd.honeycomb.v3po.translate.v3po.test.ContextTestUtils.getMappingIid;
-import static org.junit.Assert.assertEquals;
-import static org.mockito.Matchers.any;
-import static org.mockito.Mockito.doReturn;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.verifyZeroInteractions;
-import static org.mockito.Mockito.when;
-
-import com.google.common.base.Optional;
-import com.google.common.collect.Iterators;
-import com.google.common.collect.Lists;
-import io.fd.honeycomb.v3po.translate.MappingContext;
-import io.fd.honeycomb.v3po.translate.ModificationCache;
-import io.fd.honeycomb.v3po.translate.impl.write.CompositeRootWriter;
-import io.fd.honeycomb.v3po.translate.util.write.DelegatingWriterRegistry;
-import io.fd.honeycomb.v3po.translate.v3po.util.NamingContext;
-import io.fd.honeycomb.v3po.translate.write.WriteContext;
-import io.fd.honeycomb.v3po.translate.write.Writer;
-import java.util.Collections;
-import java.util.List;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.CompletionStage;
-import java.util.concurrent.ExecutionException;
-import org.junit.Before;
-import org.junit.Test;
-import org.mockito.ArgumentCaptor;
-import org.mockito.Mock;
-import org.mockito.MockitoAnnotations;
-import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.Mappings;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.Vpp;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VppBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.BridgeDomains;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.BridgeDomainsBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.bridge.domains.BridgeDomain;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.bridge.domains.BridgeDomainBuilder;
-import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.openvpp.jvpp.VppInvocationException;
-import org.openvpp.jvpp.dto.BridgeDomainAddDel;
-import org.openvpp.jvpp.dto.BridgeDomainAddDelReply;
-import org.openvpp.jvpp.future.FutureJVpp;
-
-public class VppTest {
-
-    private static final byte ADD_OR_UPDATE_BD = 1;
-    private static final byte ZERO = 0;
-    private static final String BD_NAME = "bdn1";
-    private static final String BD_CONTEXT_NAME = "test-instance";
-
-    @Mock
-    private FutureJVpp api;
-    @Mock
-    private WriteContext ctx;
-    @Mock
-    private MappingContext mappingContext;
-
-    private DelegatingWriterRegistry rootRegistry;
-    private CompositeRootWriter<Vpp> vppWriter;
-
-    @Before
-    public void setUp() throws Exception {
-        MockitoAnnotations.initMocks(this);
-        NamingContext bdContext = new NamingContext("generatedBdName", BD_CONTEXT_NAME);
-        final ModificationCache toBeReturned = new ModificationCache();
-        doReturn(toBeReturned).when(ctx).getModificationCache();
-        doReturn(mappingContext).when(ctx).getMappingContext();
-
-        vppWriter = VppUtils.getVppWriter(api, bdContext);
-        rootRegistry = new DelegatingWriterRegistry(
-            Collections.<Writer<? extends DataObject>>singletonList(vppWriter));
-    }
-
-    private BridgeDomains getBridgeDomains(String... name) {
-        final List<BridgeDomain> bdmns = Lists.newArrayList();
-        for (String s : name) {
-            bdmns.add(new BridgeDomainBuilder()
-                .setName(s)
-                .setArpTermination(false)
-                .setFlood(true)
-                .setForward(false)
-                .setLearn(true)
-                .build());
-        }
-        return new BridgeDomainsBuilder()
-            .setBridgeDomain(bdmns)
-            .build();
-    }
-
-    private void whenBridgeDomainAddDelThenSuccess()
-        throws ExecutionException, VppInvocationException, InterruptedException {
-        final CompletionStage<BridgeDomainAddDelReply> replyCs = mock(CompletionStage.class);
-        final CompletableFuture<BridgeDomainAddDelReply> replyFuture = mock(CompletableFuture.class);
-        when(replyCs.toCompletableFuture()).thenReturn(replyFuture);
-        final BridgeDomainAddDelReply reply = new BridgeDomainAddDelReply();
-        when(replyFuture.get()).thenReturn(reply);
-        when(api.bridgeDomainAddDel(any(BridgeDomainAddDel.class))).thenReturn(replyCs);
-    }
-
-    private void verifyBridgeDomainAddDel(final BridgeDomain bd, final int bdId) throws VppInvocationException {
-        final byte arpTerm = BridgeDomainTestUtils.booleanToByte(bd.isArpTermination());
-        final byte flood = BridgeDomainTestUtils.booleanToByte(bd.isFlood());
-        final byte forward = BridgeDomainTestUtils.booleanToByte(bd.isForward());
-        final byte learn = BridgeDomainTestUtils.booleanToByte(bd.isLearn());
-        final byte uuf = BridgeDomainTestUtils.booleanToByte(bd.isUnknownUnicastFlood());
-
-        // TODO adding equals methods for jvpp DTOs would make ArgumentCaptor usage obsolete
-        ArgumentCaptor<BridgeDomainAddDel> argumentCaptor = ArgumentCaptor.forClass(BridgeDomainAddDel.class);
-        verify(api).bridgeDomainAddDel(argumentCaptor.capture());
-        final BridgeDomainAddDel actual = argumentCaptor.getValue();
-        assertEquals(arpTerm, actual.arpTerm);
-        assertEquals(flood, actual.flood);
-        assertEquals(forward, actual.forward);
-        assertEquals(learn, actual.learn);
-        assertEquals(uuf, actual.uuFlood);
-        assertEquals(ADD_OR_UPDATE_BD, actual.isAdd);
-        assertEquals(bdId, actual.bdId);
-    }
-
-    private void verifyBridgeDomainDeleteWasInvoked(final int bdId) throws VppInvocationException {
-        ArgumentCaptor<BridgeDomainAddDel> argumentCaptor = ArgumentCaptor.forClass(BridgeDomainAddDel.class);
-        verify(api).bridgeDomainAddDel(argumentCaptor.capture());
-        final BridgeDomainAddDel actual = argumentCaptor.getValue();
-        assertEquals(bdId, actual.bdId);
-        assertEquals(ZERO, actual.arpTerm);
-        assertEquals(ZERO, actual.flood);
-        assertEquals(ZERO, actual.forward);
-        assertEquals(ZERO, actual.learn);
-        assertEquals(ZERO, actual.uuFlood);
-        assertEquals(ZERO, actual.isAdd);
-    }
-
-    @Test
-    public void writeVppUsingRootRegistry() throws Exception {
-        final int bdId = 1;
-        final BridgeDomains bdn1 = getBridgeDomains(BD_NAME);
-        whenBridgeDomainAddDelThenSuccess();
-
-        // Returning no Mappings for "test-instance" makes bdContext.containsName() return false
-        doReturn(Optional.absent()).when(mappingContext)
-            .read(getMappingIid(BD_NAME, BD_CONTEXT_NAME).firstIdentifierOf(Mappings.class));
-        // Make bdContext.containsIndex() return false
-        doReturn(Optional.absent()).when(mappingContext)
-            .read(getMappingIid(BD_NAME, BD_CONTEXT_NAME));
-
-        rootRegistry.update(
-            InstanceIdentifier.create(Vpp.class),
-            null,
-            new VppBuilder().setBridgeDomains(bdn1).build(),
-            ctx);
-
-        verifyBridgeDomainAddDel(Iterators.getOnlyElement(bdn1.getBridgeDomain().iterator()), bdId);
-    }
-
-    @Test
-    public void writeVppUsingVppWriter() throws Exception {
-        final int bdId = 1;
-        final BridgeDomains bdn1 = getBridgeDomains(BD_NAME);
-        whenBridgeDomainAddDelThenSuccess();
-
-        // Returning no Mappings for "test-instance" makes bdContext.containsName() return false
-        doReturn(Optional.absent()).when(mappingContext)
-            .read(getMappingIid(BD_NAME, BD_CONTEXT_NAME).firstIdentifierOf(Mappings.class));
-        // Make bdContext.containsIndex() return false
-        doReturn(Optional.absent()).when(mappingContext)
-            .read(getMappingIid(BD_NAME, BD_CONTEXT_NAME));
-
-        vppWriter.update(InstanceIdentifier.create(Vpp.class),
-            null,
-            new VppBuilder().setBridgeDomains(bdn1).build(),
-            ctx);
-
-        verifyBridgeDomainAddDel(Iterators.getOnlyElement(bdn1.getBridgeDomain().iterator()), bdId);
-        verify(mappingContext).put(getMappingIid(BD_NAME, BD_CONTEXT_NAME), getMapping(BD_NAME, 1).get());
-    }
-
-    @Test
-    public void writeVppFromRoot() throws Exception {
-        final BridgeDomains bdn1 = getBridgeDomains(BD_NAME);
-        final int bdId = 1;
-        final Vpp vpp = new VppBuilder().setBridgeDomains(bdn1).build();
-        whenBridgeDomainAddDelThenSuccess();
-
-        // Returning no Mappings for "test-instance" makes bdContext.containsName() return false
-        doReturn(Optional.absent()).when(mappingContext)
-            .read(getMappingIid(BD_NAME, BD_CONTEXT_NAME).firstIdentifierOf(Mappings.class));
-        // Make bdContext.containsIndex() return false
-        doReturn(Optional.absent()).when(mappingContext)
-            .read(getMappingIid(BD_NAME, BD_CONTEXT_NAME));
-
-        rootRegistry.update(Collections.emptyMap(),
-            Collections.<InstanceIdentifier<?>, DataObject>singletonMap(InstanceIdentifier.create(Vpp.class),
-                vpp), ctx);
-
-        verifyBridgeDomainAddDel(Iterators.getOnlyElement(bdn1.getBridgeDomain().iterator()), bdId);
-    }
-
-    @Test
-    public void deleteVpp() throws Exception {
-        final BridgeDomains bdn1 = getBridgeDomains(BD_NAME);
-        final int bdId = 1;
-        whenBridgeDomainAddDelThenSuccess();
-        doReturn(getMapping(BD_NAME, bdId)).when(mappingContext).read(getMappingIid(BD_NAME, BD_CONTEXT_NAME));
-
-        rootRegistry.update(
-            InstanceIdentifier.create(Vpp.class),
-            new VppBuilder().setBridgeDomains(bdn1).build(),
-            null,
-            ctx);
-
-        verifyBridgeDomainDeleteWasInvoked(bdId);
-    }
-
-    @Test
-    public void updateVppNoActualChange() throws Exception {
-        rootRegistry.update(
-            InstanceIdentifier.create(Vpp.class),
-            new VppBuilder().setBridgeDomains(getBridgeDomains(BD_NAME)).build(),
-            new VppBuilder().setBridgeDomains(getBridgeDomains(BD_NAME)).build(),
-            ctx);
-
-        verifyZeroInteractions(api);
-    }
-
-    @Test
-    public void writeUpdate() throws Exception {
-        final int bdn1Id = 1;
-        doReturn(getMapping(BD_NAME, bdn1Id)).when(mappingContext).read(getMappingIid(BD_NAME, BD_CONTEXT_NAME));
-
-        final BridgeDomains domainsBefore = getBridgeDomains(BD_NAME);
-        final BridgeDomain bdn1Before = domainsBefore.getBridgeDomain().get(0);
-
-        final BridgeDomain bdn1After = new BridgeDomainBuilder(bdn1Before).setFlood(!bdn1Before.isFlood()).build();
-        final BridgeDomains domainsAfter = new BridgeDomainsBuilder()
-            .setBridgeDomain(Collections.singletonList(bdn1After))
-            .build();
-
-        whenBridgeDomainAddDelThenSuccess();
-
-        rootRegistry.update(
-            InstanceIdentifier.create(Vpp.class),
-            new VppBuilder().setBridgeDomains(domainsBefore).build(),
-            new VppBuilder().setBridgeDomains(domainsAfter).build(),
-            ctx);
-
-        // bdn1 is created with negated flood value
-        verifyBridgeDomainAddDel(bdn1After, bdn1Id);
-    }
-
-    // TODO test unkeyed list
-    // TODO test update of a child without dedicated writer
-}
\ No newline at end of file
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vpp/VppUtils.java b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vpp/VppUtils.java
deleted file mode 100644
index 4b3eb5adc..000000000
--- a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vpp/VppUtils.java
+++ /dev/null
@@ -1,63 +0,0 @@
-/*
- * Copyright (c) 2016 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.v3po.translate.v3po.vpp;
-
-import io.fd.honeycomb.v3po.translate.impl.write.CompositeChildWriter;
-import io.fd.honeycomb.v3po.translate.impl.write.CompositeListWriter;
-import io.fd.honeycomb.v3po.translate.impl.write.CompositeRootWriter;
-import io.fd.honeycomb.v3po.translate.util.RWUtils;
-import io.fd.honeycomb.v3po.translate.util.write.NoopWriterCustomizer;
-import io.fd.honeycomb.v3po.translate.util.write.ReflexiveChildWriterCustomizer;
-import io.fd.honeycomb.v3po.translate.v3po.util.NamingContext;
-import io.fd.honeycomb.v3po.translate.write.ChildWriter;
-import java.util.ArrayList;
-import java.util.List;
-import javax.annotation.Nonnull;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.Vpp;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.BridgeDomains;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.bridge.domains.BridgeDomain;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.bridge.domains.BridgeDomainKey;
-import org.opendaylight.yangtools.yang.binding.ChildOf;
-import org.openvpp.jvpp.future.FutureJVpp;
-
-final class VppUtils {
-
-    public VppUtils() {}
-
-    /**
-     * Create root Vpp writer with all its children wired
-     */
-    static CompositeRootWriter<Vpp> getVppWriter(@Nonnull final FutureJVpp vppApi, final NamingContext bdContext) {
-
-        final CompositeListWriter<BridgeDomain, BridgeDomainKey> bridgeDomainWriter = new CompositeListWriter<>(
-            BridgeDomain.class,
-            new BridgeDomainCustomizer(vppApi, bdContext));
-
-        final ChildWriter<BridgeDomains> bridgeDomainsReader = new CompositeChildWriter<>(
-            BridgeDomains.class,
-            RWUtils.singletonChildWriterList(bridgeDomainWriter),
-            new ReflexiveChildWriterCustomizer<BridgeDomains>());
-
-        final List<ChildWriter<? extends ChildOf<Vpp>>> childWriters = new ArrayList<>();
-        childWriters.add(bridgeDomainsReader);
-
-        return new CompositeRootWriter<>(
-            Vpp.class,
-            childWriters,
-            new NoopWriterCustomizer<Vpp>());
-    }
-}