From 5062ef09b21798c178a8d8fb8d1edf3f9bc6a771 Mon Sep 17 00:00:00 2001 From: Maros Marsalek Date: Wed, 14 Sep 2016 16:27:04 +0200 Subject: HONEYCOMB-194 Raise unit test coverage of cfg-init to 80% Change-Id: Id90c291bb944387b1ffad15b40c08c32c518bb49 Signed-off-by: Maros Marsalek --- .../honeycomb/data/init/RestoringInitializer.java | 28 ++++- .../data/init/AbstractDataTreeConverterTest.java | 120 +++++++++++++++++++ .../data/init/RestoringInitializerTest.java | 129 +++++++++++++++++++++ 3 files changed, 273 insertions(+), 4 deletions(-) create mode 100644 infra/cfg-init/src/test/java/io/fd/honeycomb/data/init/AbstractDataTreeConverterTest.java create mode 100644 infra/cfg-init/src/test/java/io/fd/honeycomb/data/init/RestoringInitializerTest.java (limited to 'infra/cfg-init') diff --git a/infra/cfg-init/src/main/java/io/fd/honeycomb/data/init/RestoringInitializer.java b/infra/cfg-init/src/main/java/io/fd/honeycomb/data/init/RestoringInitializer.java index ed517b4f0..eaca0deba 100644 --- a/infra/cfg-init/src/main/java/io/fd/honeycomb/data/init/RestoringInitializer.java +++ b/infra/cfg-init/src/main/java/io/fd/honeycomb/data/init/RestoringInitializer.java @@ -18,6 +18,7 @@ package io.fd.honeycomb.data.init; import static com.google.common.base.Preconditions.checkArgument; +import com.google.common.annotations.VisibleForTesting; import io.fd.honeycomb.translate.util.JsonUtils; import java.io.IOException; import java.nio.file.Files; @@ -32,6 +33,7 @@ import org.opendaylight.controller.sal.core.api.model.SchemaService; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild; +import org.opendaylight.yangtools.yang.model.api.SchemaContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -44,17 +46,28 @@ public class RestoringInitializer implements DataTreeInitializer { private final DOMDataBroker dataTree; private final RestorationType restorationType; private final LogicalDatastoreType datastoreType; + private final JsonReader jsonReader; public RestoringInitializer(@Nonnull final SchemaService schemaService, @Nonnull final Path path, @Nonnull final DOMDataBroker dataTree, @Nonnull final RestorationType restorationType, - @Nonnull final LogicalDatastoreType datastoreType) { + @Nonnull final LogicalDatastoreType datastoreType, + @Nonnull final JsonReader jsonReader) { this.schemaService = schemaService; this.datastoreType = datastoreType; this.path = checkStorage(path); this.dataTree = dataTree; this.restorationType = restorationType; + this.jsonReader = jsonReader; + } + + public RestoringInitializer(@Nonnull final SchemaService schemaService, + @Nonnull final Path path, + @Nonnull final DOMDataBroker dataTree, + @Nonnull final RestorationType restorationType, + @Nonnull final LogicalDatastoreType datastoreType) { + this(schemaService, path, dataTree, restorationType, datastoreType, new JsonReader()); } private Path checkStorage(final Path path) { @@ -75,8 +88,7 @@ public class RestoringInitializer implements DataTreeInitializer { } try { - final ContainerNode containerNode = JsonUtils - .readJsonRoot(schemaService.getGlobalContext(), Files.newInputStream(path, StandardOpenOption.READ)); + final ContainerNode containerNode = jsonReader.readData(schemaService.getGlobalContext(), path); final DOMDataWriteTransaction domDataWriteTransaction = dataTree.newWriteOnlyTransaction(); for (DataContainerChild dataContainerChild : containerNode @@ -109,7 +121,15 @@ public class RestoringInitializer implements DataTreeInitializer { /** * Type of operation to use when writing restored data. */ - public static enum RestorationType { + public enum RestorationType { Put, Merge } + + @VisibleForTesting + static class JsonReader { + + public ContainerNode readData(final SchemaContext globalContext, final Path path) throws IOException { + return JsonUtils.readJsonRoot(globalContext, Files.newInputStream(path, StandardOpenOption.READ)); + } + } } diff --git a/infra/cfg-init/src/test/java/io/fd/honeycomb/data/init/AbstractDataTreeConverterTest.java b/infra/cfg-init/src/test/java/io/fd/honeycomb/data/init/AbstractDataTreeConverterTest.java new file mode 100644 index 000000000..c81f4cd00 --- /dev/null +++ b/infra/cfg-init/src/test/java/io/fd/honeycomb/data/init/AbstractDataTreeConverterTest.java @@ -0,0 +1,120 @@ +/* + * 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.data.init; + +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.times; +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.util.concurrent.Futures; +import org.junit.Before; +import org.junit.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.opendaylight.controller.md.sal.binding.api.DataBroker; +import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction; +import org.opendaylight.controller.md.sal.binding.api.WriteTransaction; +import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; +import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException; +import org.opendaylight.yangtools.yang.binding.DataContainer; +import org.opendaylight.yangtools.yang.binding.DataObject; +import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; + +public class AbstractDataTreeConverterTest { + + private static final InstanceIdentifier + OPER_ROOT_ID = InstanceIdentifier.create(Operational.class); + private static final InstanceIdentifier + CFG_ROOT_ID = InstanceIdentifier.create(Configuration.class); + @Mock + private DataBroker bindingDataBroker; + @Mock + private ReadOnlyTransaction readTx; + @Mock + private WriteTransaction writeTx; + + @Before + public void setUp() throws Exception { + MockitoAnnotations.initMocks(this); + when(bindingDataBroker.newReadOnlyTransaction()).thenReturn(readTx); + when(readTx.read(LogicalDatastoreType.OPERATIONAL, OPER_ROOT_ID)).thenReturn( + Futures.immediateCheckedFuture(Optional.of(Operational.instance))); + when(bindingDataBroker.newWriteOnlyTransaction()).thenReturn(writeTx); + when(writeTx.submit()).thenReturn(Futures.immediateCheckedFuture(null)); + } + + @Test + public void testConvert() throws Exception { + final TestingDataTreeConverter converter = new TestingDataTreeConverter(bindingDataBroker); + converter.initialize(); + + verify(bindingDataBroker).newReadOnlyTransaction(); + verify(readTx).read(LogicalDatastoreType.OPERATIONAL, OPER_ROOT_ID); + verify(bindingDataBroker).newWriteOnlyTransaction(); + verify(writeTx).merge(LogicalDatastoreType.CONFIGURATION, CFG_ROOT_ID, Configuration.instance); + } + + @Test + public void testReadFailNoop() throws Exception { + when(readTx.read(LogicalDatastoreType.OPERATIONAL, OPER_ROOT_ID)).thenReturn( + Futures.immediateFailedCheckedFuture(new ReadFailedException("failing"))); + + final TestingDataTreeConverter converter = new TestingDataTreeConverter(bindingDataBroker); + converter.initialize(); + + verify(bindingDataBroker).newReadOnlyTransaction(); + verify(readTx).read(LogicalDatastoreType.OPERATIONAL, OPER_ROOT_ID); + verify(bindingDataBroker, times(0)).newWriteOnlyTransaction(); + verifyZeroInteractions(writeTx); + } + + private static class Configuration implements DataObject { + + static final Configuration instance = mock(Configuration.class); + + @Override + public Class getImplementedInterface() { + return DataObject.class; + } + } + + private static class Operational implements DataObject { + + static final Operational instance = mock(Operational.class); + + @Override + public Class getImplementedInterface() { + return DataObject.class; + } + } + + private static class TestingDataTreeConverter extends AbstractDataTreeConverter { + + public TestingDataTreeConverter(final DataBroker bindingDataBroker) { + super(bindingDataBroker, OPER_ROOT_ID, CFG_ROOT_ID); + } + + @Override + protected Configuration convert( + final Operational operationalData) { + return Configuration.instance; + } + } +} \ No newline at end of file diff --git a/infra/cfg-init/src/test/java/io/fd/honeycomb/data/init/RestoringInitializerTest.java b/infra/cfg-init/src/test/java/io/fd/honeycomb/data/init/RestoringInitializerTest.java new file mode 100644 index 000000000..e4f163901 --- /dev/null +++ b/infra/cfg-init/src/test/java/io/fd/honeycomb/data/init/RestoringInitializerTest.java @@ -0,0 +1,129 @@ +/* + * 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.data.init; + +import static org.mockito.Matchers.any; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.verifyZeroInteractions; +import static org.mockito.Mockito.when; + +import com.google.common.util.concurrent.Futures; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.NoSuchFileException; +import java.nio.file.Path; +import java.util.Collections; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; +import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker; +import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction; +import org.opendaylight.controller.sal.core.api.model.SchemaService; +import org.opendaylight.yangtools.yang.common.QName; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; +import org.opendaylight.yangtools.yang.model.api.SchemaContext; + +public class RestoringInitializerTest { + + @Mock + private SchemaService schemaService; + @Mock + private DOMDataBroker dataTree; + @Mock + private RestoringInitializer.JsonReader jsonReader; + @Mock + private ContainerNode data; + @Mock + private DOMDataWriteTransaction writeTx; + private Path path; + private YangInstanceIdentifier.NodeIdentifier nodeId = + new YangInstanceIdentifier.NodeIdentifier(QName.create("namespace", "data")); + + @Before + public void setUp() throws Exception { + MockitoAnnotations.initMocks(this); + path = Files.createTempFile("hc", "restoretest"); + when(jsonReader.readData(any(SchemaContext.class), any(Path.class))).thenReturn(data); + when(dataTree.newWriteOnlyTransaction()).thenReturn(writeTx); + when(writeTx.submit()).thenReturn(Futures.immediateCheckedFuture(null)); + when(data.getValue()).thenReturn(Collections.singleton(data)); + when(data.getIdentifier()).thenReturn(nodeId); + } + + @After + public void tearDown() throws Exception { + try { + Files.delete(path); + } catch (NoSuchFileException e) { + // ignoring, if the file does not exist already, never mind + } + } + + @Test + public void testPutOper() throws Exception { + final RestoringInitializer init = + new RestoringInitializer(schemaService, path, dataTree, + RestoringInitializer.RestorationType.Put, LogicalDatastoreType.OPERATIONAL, jsonReader); + + init.initialize(); + + verify(schemaService).getGlobalContext(); + verify(jsonReader).readData(any(SchemaContext.class), any(Path.class)); + + verify(dataTree).newWriteOnlyTransaction(); + verify(writeTx).put(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.create(nodeId), data); + verify(writeTx).submit(); + } + + @Test + public void testMergeConfig() throws Exception { + final RestoringInitializer init = + new RestoringInitializer(schemaService, path, dataTree, + RestoringInitializer.RestorationType.Merge, LogicalDatastoreType.CONFIGURATION, jsonReader); + + init.initialize(); + + verify(writeTx).merge(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.create(nodeId), data); + } + + @Test + public void testNoRestore() throws Exception { + Files.delete(path); + final RestoringInitializer init = + new RestoringInitializer(schemaService, path, dataTree, + RestoringInitializer.RestorationType.Merge, LogicalDatastoreType.CONFIGURATION, jsonReader); + + init.initialize(); + + verifyZeroInteractions(writeTx); + } + + @Test(expected = DataTreeInitializer.InitializeException.class) + public void testFail() throws Exception { + when(jsonReader.readData(any(SchemaContext.class), any(Path.class))).thenThrow(new IOException("t")); + + final RestoringInitializer init = + new RestoringInitializer(schemaService, path, dataTree, + RestoringInitializer.RestorationType.Merge, LogicalDatastoreType.CONFIGURATION, jsonReader); + + init.initialize(); + } +} \ No newline at end of file -- cgit 1.2.3-korg