/* * 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.translate.impl.write.registry; import static org.hamcrest.CoreMatchers.is; import static org.junit.Assert.assertThat; import static org.junit.Assert.fail; import static org.mockito.Matchers.any; import static org.mockito.Matchers.eq; import static org.mockito.Mockito.doThrow; 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 static org.mockito.Mockito.verifyZeroInteractions; import static org.mockito.Mockito.when; import com.google.common.collect.HashMultimap; import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableMultimap; import com.google.common.collect.Multimap; import io.fd.honeycomb.translate.util.DataObjects; import io.fd.honeycomb.translate.util.DataObjects.DataObject1; import io.fd.honeycomb.translate.write.DataObjectUpdate; import io.fd.honeycomb.translate.write.WriteContext; import io.fd.honeycomb.translate.write.Writer; import io.fd.honeycomb.translate.write.registry.WriterRegistry; import org.hamcrest.CoreMatchers; import org.junit.Before; import org.junit.Test; import org.mockito.InOrder; import org.mockito.Mock; import org.mockito.MockitoAnnotations; import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; public class FlatWriterRegistryTest { @Mock private Writer writer1; @Mock private Writer writer2; @Mock private Writer writer3; @Mock private Writer writer4; @Mock private WriteContext ctx; @Mock private WriteContext revertWriteContext; @Before public void setUp() throws Exception { MockitoAnnotations.initMocks(this); when(writer1.getManagedDataObjectType()).thenReturn(DataObjects.DataObject1.IID); when(writer2.getManagedDataObjectType()).thenReturn(DataObjects.DataObject2.IID); when(writer3.getManagedDataObjectType()).thenReturn(DataObjects.DataObject3.IID); } @Test public void testMultipleUpdatesForSingleWriter() throws Exception { final FlatWriterRegistry flatWriterRegistry = new FlatWriterRegistry(ImmutableMap.of(DataObjects.DataObject1.IID, writer1, DataObjects.DataObject2.IID, writer2)); final Multimap, DataObjectUpdate> updates = HashMultimap.create(); final InstanceIdentifier iid = InstanceIdentifier.create(DataObjects.DataObject1.class); final InstanceIdentifier iid2 = InstanceIdentifier.create(DataObjects.DataObject1.class); final DataObjects.DataObject1 dataObject = mock(DataObjects.DataObject1.class); updates.put(DataObjects.DataObject1.IID, DataObjectUpdate.create(iid, dataObject, dataObject)); updates.put(DataObjects.DataObject1.IID, DataObjectUpdate.create(iid2, dataObject, dataObject)); flatWriterRegistry.update(new WriterRegistry.DataObjectUpdates(updates, ImmutableMultimap.of()), ctx); verify(writer1).update(iid, dataObject, dataObject, ctx); verify(writer1).update(iid2, dataObject, dataObject, ctx); // Invoked when registry is being created verifyNoMoreInteractions(writer1); verifyZeroInteractions(writer2); } @Test public void testMultipleUpdatesForMultipleWriters() throws Exception { final FlatWriterRegistry flatWriterRegistry = new FlatWriterRegistry(ImmutableMap.of(DataObjects.DataObject1.IID, writer1, DataObjects.DataObject2.IID, writer2)); final Multimap, DataObjectUpdate> updates = HashMultimap.create(); final InstanceIdentifier iid = InstanceIdentifier.create(DataObjects.DataObject1.class); final DataObjects.DataObject1 dataObject = mock(DataObjects.DataObject1.class); updates.put(DataObjects.DataObject1.IID, DataObjectUpdate.create(iid, dataObject, dataObject)); final InstanceIdentifier iid2 = InstanceIdentifier.create(DataObjects.DataObject2.class); final DataObjects.DataObject2 dataObject2 = mock(DataObjects.DataObject2.class); updates.put(DataObjects.DataObject2.IID, DataObjectUpdate.create(iid2, dataObject2, dataObject2)); flatWriterRegistry.update(new WriterRegistry.DataObjectUpdates(updates, ImmutableMultimap.of()), ctx); final InOrder inOrder = inOrder(writer1, writer2); inOrder.verify(writer1).update(iid, dataObject, dataObject, ctx); inOrder.verify(writer2).update(iid2, dataObject2, dataObject2, ctx); verifyNoMoreInteractions(writer1); verifyNoMoreInteractions(writer2); } @Test public void testMultipleDeletesForMultipleWriters() throws Exception { final FlatWriterRegistry flatWriterRegistry = new FlatWriterRegistry(ImmutableMap.of(DataObjects.DataObject1.IID, writer1, DataObjects.DataObject2.IID, writer2)); final Multimap, DataObjectUpdate.DataObjectDelete> deletes = HashMultimap.create(); final InstanceIdentifier iid = InstanceIdentifier.create(DataObjects.DataObject1.class); final DataObjects.DataObject1 dataObject = mock(DataObjects.DataObject1.class); deletes.put(DataObjects.DataObject1.IID, ((DataObjectUpdate.DataObjectDelete) DataObjectUpdate.create(iid, dataObject, null))); final InstanceIdentifier iid2 = InstanceIdentifier.create(DataObjects.DataObject2.class); final DataObjects.DataObject2 dataObject2 = mock(DataObjects.DataObject2.class); deletes.put(DataObjects.DataObject2.IID, ((DataObjectUpdate.DataObjectDelete) DataObjectUpdate.create(iid2, dataObject2, null))); flatWriterRegistry.update(new WriterRegistry.DataObjectUpdates(ImmutableMultimap.of(), deletes), ctx); final InOrder inOrder = inOrder(writer1, writer2); // Reversed order of invocation, first writer2 and then writer1 inOrder.verify(writer2).update(iid2, dataObject2, null, ctx); inOrder.verify(writer1).update(iid, dataObject, null, ctx); verifyNoMoreInteractions(writer1); verifyNoMoreInteractions(writer2); } @Test public void testMultipleUpdatesAndDeletesForMultipleWriters() throws Exception { final FlatWriterRegistry flatWriterRegistry = new FlatWriterRegistry(ImmutableMap.of(DataObjects.DataObject1.IID, writer1, DataObjects.DataObject2.IID, writer2)); final Multimap, DataObjectUpdate.DataObjectDelete> deletes = HashMultimap.create(); final Multimap, DataObjectUpdate> updates = HashMultimap.create(); final InstanceIdentifier iid = InstanceIdentifier.create(DataObjects.DataObject1.class); final DataObjects.DataObject1 dataObject = mock(DataObjects.DataObject1.class); // Writer 1 delete deletes.put(DataObjects.DataObject1.IID, ((DataObjectUpdate.DataObjectDelete) DataObjectUpdate.create(iid, dataObject, null))); // Writer 1 update updates.put(DataObjects.DataObject1.IID, DataObjectUpdate.create(iid, dataObject, dataObject)); final InstanceIdentifier iid2 = InstanceIdentifier.create(DataObjects.DataObject2.class); final DataObjects.DataObject2 dataObject2 = mock(DataObjects.DataObject2.class); // Writer 2 delete deletes.put(DataObjects.DataObject2.IID, ((DataObjectUpdate.DataObjectDelete) DataObjectUpdate.create(iid2, dataObject2, null))); // Writer 2 update updates.put(DataObjects.DataObject2.IID, DataObjectUpdate.create(iid2, dataObject2, dataObject2)); flatWriterRegistry.update(new WriterRegistry.DataObjectUpdates(updates, deletes), ctx); final InOrder inOrder = inOrder(writer1, writer2); // Reversed order of invocation, first writer2 and then writer1 for deletes inOrder.verify(writer2).update(iid2, dataObject2, null, ctx); inOrder.verify(writer1).update(iid, dataObject, null, ctx); // Then also updates are processed inOrder.verify(writer1).update(iid, dataObject, dataObject, ctx); inOrder.verify(writer2).update(iid2, dataObject2, dataObject2, ctx); verifyNoMoreInteractions(writer1); verifyNoMoreInteractions(writer2); } @Test(expected = IllegalArgumentException.class) public void testMultipleUpdatesOneMissing() throws Exception { final FlatWriterRegistry flatWriterRegistry = new FlatWriterRegistry(ImmutableMap.of(DataObjects.DataObject1.IID, writer1)); final Multimap, DataObjectUpdate> updates = HashMultimap.create(); addUpdate(updates, DataObjects.DataObject1.class); addUpdate(updates, DataObjects.DataObject2.class); flatWriterRegistry.update(new WriterRegistry.DataObjectUpdates(updates, ImmutableMultimap.of()), ctx); } @Test public void testMultipleUpdatesOneFailing() throws Exception { final FlatWriterRegistry flatWriterRegistry = new FlatWriterRegistry(ImmutableMap.of(DataObjects.DataObject1.IID, writer1, DataObjects.DataObject2.IID, writer2)); // Writer1 always fails doThrow(new RuntimeException()).when(writer1) .update(any(InstanceIdentifier.class), any(DataObject.class), any(DataObject.class), any(WriteContext.class)); final Multimap, DataObjectUpdate> updates = HashMultimap.create(); addUpdate(updates, DataObjects.DataObject1.class); addUpdate(updates, DataObjects.DataObject2.class); try { flatWriterRegistry.update(new WriterRegistry.DataObjectUpdates(updates, ImmutableMultimap.of()), ctx); fail("Bulk update should have failed on writer1"); } catch (WriterRegistry.BulkUpdateException e) { assertThat(e.getFailedIds().size(), is(2)); assertThat(e.getFailedIds(), CoreMatchers.hasItem(InstanceIdentifier.create(DataObjects.DataObject2.class))); assertThat(e.getFailedIds(), CoreMatchers.hasItem(InstanceIdentifier.create(DataObjects.DataObject1.class))); } } @Test public void testMultipleUpdatesOneFailingThenRevertWithSuccess() throws Exception { final FlatWriterRegistry flatWriterRegistry = new FlatWriterRegistry( ImmutableMap.of(DataObjects.DataObject1.IID, writer1, DataObjects.DataObject2.IID, writer2, DataObjects.DataObject3.IID, writer3)); // Writer1 always fails doThrow(new RuntimeException()).when(writer3) .update(any(InstanceIdentifier.class), any(DataObject.class), any(DataObject.class), any(WriteContext.class)); final Multimap, DataObjectUpdate> updates = HashMultimap.create(); addUpdate(updates, DataObjects.DataObject1.class); addUpdate(updates, DataObjects.DataObject3.class); final InstanceIdentifier iid2 = InstanceIdentifier.create(DataObjects.DataObject2.class); final DataObjects.DataObject2 before2 = mock(DataObjects.DataObject2.class); final DataObjects.DataObject2 after2 = mock(DataObjects.DataObject2.class); updates.put(DataObjects.DataObject2.IID, DataObjectUpdate.create(iid2, before2, after2)); try { flatWriterRegistry.update(new WriterRegistry.DataObjectUpdates(updates, ImmutableMultimap.of()), ctx); fail("Bulk update should have failed on writer1"); } catch (WriterRegistry.BulkUpdateException e) { assertThat(e.getFailedIds().size(), is(1)); final InOrder inOrder = inOrder(writer1, writer2, writer3); inOrder.verify(writer1) .update(any(InstanceIdentifier.class), any(DataObject.class), any(DataObject.class), any(WriteContext.class)); inOrder.verify(writer2) .update(iid2, before2, after2, ctx); inOrder.verify(writer3) .update(any(InstanceIdentifier.class), any(DataObject.class), any(DataObject.class), any(WriteContext.class)); e.revertChanges(revertWriteContext); // Revert changes. Successful updates are iterated in reverse // also binding other write context,to verify if update context is not reused inOrder.verify(writer2) .update(iid2, after2, before2, revertWriteContext); inOrder.verify(writer1) .update(any(InstanceIdentifier.class), any(DataObject.class), any(DataObject.class), eq(revertWriteContext)); verifyNoMoreInteractions(writer3); } } @Test public void testMultipleUpdatesOneFailingThenRevertWithFail() throws Exception { final FlatWriterRegistry flatWriterRegistry = new FlatWriterRegistry( ImmutableMap.of(DataObjects.DataObject1.IID, writer1, DataObjects.DataObject2.IID, writer2, DataObjects.DataObject3.IID, writer3)); // Writer1 always fails doThrow(new RuntimeException()).when(writer3) .update(any(InstanceIdentifier.class), any(DataObject.class), any(DataObject.class), any(WriteContext.class)); final Multimap, DataObjectUpdate> updates = HashMultimap.create(); addUpdate(updates, DataObjects.DataObject1.class); addUpdate(updates, DataObjects.DataObject2.class); addUpdate(updates, DataObjects.DataObject3.class); try { flatWriterRegistry.update(new WriterRegistry.DataObjectUpdates(updates, ImmutableMultimap.of()), ctx); fail("Bulk update should have failed on writer1"); } catch (WriterRegistry.BulkUpdateException e) { // Writer1 always fails from now doThrow(new RuntimeException()).when(writer1) .update(any(InstanceIdentifier.class), any(DataObject.class), any(DataObject.class), any(WriteContext.class)); try { e.revertChanges(revertWriteContext); } catch (WriterRegistry.Reverter.RevertFailedException e1) { assertThat(e1.getNotRevertedChanges().size(), is(1)); assertThat(e1.getNotRevertedChanges(), CoreMatchers .hasItem(InstanceIdentifier.create(DataObjects.DataObject1.class))); } } } @Test public void testMutlipleUpdatesWithOneKeyedContainer() throws Exception { final InstanceIdentifier internallyKeyedIdentifier = InstanceIdentifier.create(DataObject1.class) .child(DataObjects.DataObject1ChildK.class, new DataObjects.DataObject1ChildKey()); final FlatWriterRegistry flatWriterRegistry = new FlatWriterRegistry( ImmutableMap.of(DataObjects.DataObject1.IID, writer1, DataObjects.DataObject1ChildK.IID,writer4)); // Writer1 always fails doThrow(new RuntimeException()).when(writer1) .update(any(InstanceIdentifier.class), any(DataObject.class), any(DataObject.class), any(WriteContext.class)); final Multimap, DataObjectUpdate> updates = HashMultimap.create(); addKeyedUpdate(updates,DataObjects.DataObject1ChildK.class); addUpdate(updates, DataObjects.DataObject1.class); try { flatWriterRegistry.update(new WriterRegistry.DataObjectUpdates(updates, ImmutableMultimap.of()), ctx); fail("Bulk update should have failed on writer1"); } catch (WriterRegistry.BulkUpdateException e) { // Writer1 always fails from now doThrow(new RuntimeException()).when(writer1) .update(any(InstanceIdentifier.class), any(DataObject.class), any(DataObject.class), any(WriteContext.class)); try { e.revertChanges(revertWriteContext); } catch (WriterRegistry.Reverter.RevertFailedException e1) { assertThat(e1.getNotRevertedChanges().size(), is(1)); assertThat(e1.getNotRevertedChanges(), CoreMatchers .hasItem(InstanceIdentifier.create(DataObjects.DataObject1.class))); } } } private void addKeyedUpdate(final Multimap, DataObjectUpdate> updates, final Class type) throws Exception { final InstanceIdentifier iid = (InstanceIdentifier) type.getDeclaredField("IID").get(null); final InstanceIdentifier keyedIid = (InstanceIdentifier) type.getDeclaredField("INTERNALLY_KEYED_IID").get(null); updates.put(iid, DataObjectUpdate.create(keyedIid, mock(type), mock(type))); } private void addUpdate(final Multimap, DataObjectUpdate> updates, final Class type) throws Exception { final InstanceIdentifier iid = (InstanceIdentifier) type.getDeclaredField("IID").get(null); updates.put(iid, DataObjectUpdate.create(iid, mock(type), mock(type))); } }