diff options
Diffstat (limited to 'vpp-common/vpp-common-integration')
10 files changed, 423 insertions, 0 deletions
diff --git a/vpp-common/vpp-common-integration/asciidoc/Readme.adoc b/vpp-common/vpp-common-integration/asciidoc/Readme.adoc new file mode 100644 index 000000000..8c18a3eb2 --- /dev/null +++ b/vpp-common/vpp-common-integration/asciidoc/Readme.adoc @@ -0,0 +1,3 @@ += vpp-common-integration + +Overview of vpp-common-integration
\ No newline at end of file diff --git a/vpp-common/vpp-common-integration/pom.xml b/vpp-common/vpp-common-integration/pom.xml new file mode 100644 index 000000000..2cb031ec8 --- /dev/null +++ b/vpp-common/vpp-common-integration/pom.xml @@ -0,0 +1,116 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2015 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. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <parent> + <groupId>io.fd.honeycomb.common</groupId> + <artifactId>impl-parent</artifactId> + <version>1.16.12-SNAPSHOT</version> + <relativePath>../../common/impl-parent</relativePath> + </parent> + + <modelVersion>4.0.0</modelVersion> + <groupId>io.fd.honeycomb.vpp</groupId> + <artifactId>vpp-common-integration</artifactId> + <version>1.16.12-SNAPSHOT</version> + + <properties> + <honeycomb.min.distro.version>1.16.12-SNAPSHOT</honeycomb.min.distro.version> + <jvpp.version>16.12-SNAPSHOT</jvpp.version> + <hamcrest.version>1.3</hamcrest.version> + </properties> + + <build> + <plugins> + <plugin> + <artifactId>maven-compiler-plugin</artifactId> + </plugin> + <plugin> + <groupId>org.codehaus.gmaven</groupId> + <artifactId>groovy-maven-plugin</artifactId> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jar-plugin</artifactId> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-dependency-plugin</artifactId> + </plugin> + <plugin> + <artifactId>maven-assembly-plugin</artifactId> + </plugin> + </plugins> + </build> + + <dependencies> + <dependency> + <groupId>io.fd.honeycomb</groupId> + <artifactId>minimal-distribution</artifactId> + <version>${honeycomb.min.distro.version}</version> + </dependency> + <dependency> + <groupId>${project.groupId}</groupId> + <artifactId>naming-context-api</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>${project.groupId}</groupId> + <artifactId>naming-context-impl</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>io.fd.vpp</groupId> + <artifactId>jvpp-registry</artifactId> + <version>${jvpp.version}</version> + </dependency> + <dependency> + <groupId>io.fd.vpp</groupId> + <artifactId>jvpp-core</artifactId> + <version>${jvpp.version}</version> + </dependency> + <dependency> + <groupId>${project.groupId}</groupId> + <artifactId>vpp-translate-utils</artifactId> + <version>${project.version}</version> + </dependency> + + <!-- Testing Dependencies --> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.mockito</groupId> + <artifactId>mockito-core</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>com.google.inject.extensions</groupId> + <artifactId>guice-testlib</artifactId> + <version>${guice.version}</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.hamcrest</groupId> + <artifactId>hamcrest-all</artifactId> + <version>${hamcrest.version}</version> + <scope>test</scope> + </dependency> + </dependencies> +</project> diff --git a/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/ContextsReaderFactoryProvider.java b/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/ContextsReaderFactoryProvider.java new file mode 100644 index 000000000..d33b8b717 --- /dev/null +++ b/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/ContextsReaderFactoryProvider.java @@ -0,0 +1,40 @@ +/* + * 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.vpp.common.integration; + +import com.google.inject.Inject; +import com.google.inject.name.Named; +import io.fd.honeycomb.infra.distro.ProviderTrait; +import io.fd.honeycomb.infra.distro.data.context.ContextPipelineModule; +import io.fd.honeycomb.translate.read.ReaderFactory; +import io.fd.honeycomb.vpp.context.ContextsReaderFactory; +import org.opendaylight.controller.md.sal.binding.api.DataBroker; + +/** + * Mirror of org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.context.impl.rev141210.ContextReaderModule + */ +public final class ContextsReaderFactoryProvider extends ProviderTrait<ReaderFactory> { + + @Inject + @Named(ContextPipelineModule.HONEYCOMB_CONTEXT) + private DataBroker contextDataBroker; + + @Override + protected ContextsReaderFactory create() { + return new ContextsReaderFactory(contextDataBroker); + } +} diff --git a/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/JVppCoreProvider.java b/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/JVppCoreProvider.java new file mode 100644 index 000000000..bbd30fbfb --- /dev/null +++ b/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/JVppCoreProvider.java @@ -0,0 +1,61 @@ +/* + * 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.vpp.common.integration; + +import com.google.inject.Inject; +import io.fd.honeycomb.infra.distro.ProviderTrait; +import java.io.IOException; +import io.fd.vpp.jvpp.JVppRegistry; +import io.fd.vpp.jvpp.core.JVppCoreImpl; +import io.fd.vpp.jvpp.core.future.FutureJVppCore; +import io.fd.vpp.jvpp.core.future.FutureJVppCoreFacade; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Provides future API for jvpp-core plugin. Must be a singleton due to shutdown hook usage. Registers shutdown hook to + * free plugin's resources on shutdown. + */ +public final class JVppCoreProvider extends ProviderTrait<FutureJVppCore> { + + private static final Logger LOG = LoggerFactory.getLogger(JVppCoreProvider.class); + + @Inject + private JVppRegistry registry; + + @Override + protected FutureJVppCoreFacade create() { + try { + final JVppCoreImpl jVpp = new JVppCoreImpl(); + // Free jvpp-core plugin's resources on shutdown + Runtime.getRuntime().addShutdownHook(new Thread() { + + @Override + public void run() { + LOG.info("Unloading jvpp-core plugin"); + jVpp.close(); + LOG.info("Successfully unloaded jvpp-core plugin"); + } + }); + + LOG.info("Successfully loaded jvpp-core plugin"); + return new FutureJVppCoreFacade(registry, jVpp); + } catch (IOException e) { + throw new IllegalStateException("Unable to open VPP management connection", e); + } + } +} diff --git a/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/JVppRegistryProvider.java b/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/JVppRegistryProvider.java new file mode 100644 index 000000000..fa1d47480 --- /dev/null +++ b/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/JVppRegistryProvider.java @@ -0,0 +1,72 @@ +/* + * 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.vpp.common.integration; + +import com.google.inject.Inject; +import io.fd.honeycomb.infra.distro.ProviderTrait; +import io.fd.honeycomb.translate.vpp.util.VppStatusListener; +import java.io.IOException; +import io.fd.vpp.jvpp.JVppRegistry; +import io.fd.vpp.jvpp.JVppRegistryImpl; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Provides JVppRegistry. Must be a singleton due to shutdown hook usage. Registers shutdown hook to disconnect from + * VPP. + */ +public final class JVppRegistryProvider extends ProviderTrait<JVppRegistry> { + + private static final Logger LOG = LoggerFactory.getLogger(JVppRegistryProvider.class); + + @Inject + private VppConfigAttributes config; + @Inject + private VppStatusListener vppStatus; + + @Override + protected JVppRegistryImpl create() { + try { + final JVppRegistryImpl registry = new JVppRegistryImpl(config.jvppConnectionName); + + // Closing JVpp connection with shutdown hook to erase the connection from VPP so HC will be able + // to connect next time. If JVM is force closed, this will not be executed and VPP connection + // with name from config will stay open and prevent next startup of HC to success + Runtime.getRuntime().addShutdownHook(new Thread() { + @Override + public void run() { + LOG.info("Disconnecting from VPP"); + if (vppStatus.isDown()) { + LOG.info("VPP is down. JVppRegistry cleanup is not needed. Exiting"); + return; + } + try { + registry.close(); + LOG.info("Successfully disconnected from VPP as {}", config.jvppConnectionName); + } catch (Exception e) { + LOG.warn("Unable to properly close jvpp registry", e); + } + } + }); + + LOG.info("JVpp connection opened successfully as: {}", config.jvppConnectionName); + return registry; + } catch (IOException e) { + throw new IllegalStateException("Unable to open VPP management connection", e); + } + } +} diff --git a/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/VppCommonModule.java b/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/VppCommonModule.java new file mode 100644 index 000000000..9bdba1b14 --- /dev/null +++ b/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/VppCommonModule.java @@ -0,0 +1,44 @@ +/* + * 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.vpp.common.integration; + +import com.google.inject.AbstractModule; +import com.google.inject.Singleton; +import com.google.inject.multibindings.Multibinder; +import io.fd.honeycomb.translate.read.ReaderFactory; +import io.fd.honeycomb.translate.vpp.util.VppStatusListener; +import net.jmob.guice.conf.core.ConfigurationModule; +import io.fd.vpp.jvpp.JVppRegistry; +import io.fd.vpp.jvpp.core.future.FutureJVppCore; + +public final class VppCommonModule extends AbstractModule { + protected void configure() { + + install(ConfigurationModule.create()); + // Inject non-dependency configuration + requestInjection(VppConfigAttributes.class); + + bind(VppStatusListener.class).toInstance(new VppStatusListener()); + bind(JVppRegistry.class).toProvider(JVppRegistryProvider.class).in(Singleton.class); + bind(FutureJVppCore.class).toProvider(JVppCoreProvider.class).in(Singleton.class); + + // Naming contexts reader exposing context storage over REST/HONEYCOMB_NETCONF + final Multibinder<ReaderFactory> readerBinder = Multibinder.newSetBinder(binder(), ReaderFactory.class); + readerBinder.addBinding().toProvider(ContextsReaderFactoryProvider.class).in(Singleton.class); + } + +} diff --git a/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/VppConfigAttributes.java b/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/VppConfigAttributes.java new file mode 100644 index 000000000..af06e05db --- /dev/null +++ b/vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/VppConfigAttributes.java @@ -0,0 +1,28 @@ +/* + * 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.vpp.common.integration; + +import net.jmob.guice.conf.core.BindConfig; +import net.jmob.guice.conf.core.InjectConfig; +import net.jmob.guice.conf.core.Syntax; + +@BindConfig(value = "jvpp", syntax = Syntax.JSON) +public class VppConfigAttributes { + + @InjectConfig("jvpp-connection-name") + public String jvppConnectionName; +} diff --git a/vpp-common/vpp-common-integration/src/main/resources/honeycomb-minimal-resources/config/jvpp.json b/vpp-common/vpp-common-integration/src/main/resources/honeycomb-minimal-resources/config/jvpp.json new file mode 100644 index 000000000..1d411872e --- /dev/null +++ b/vpp-common/vpp-common-integration/src/main/resources/honeycomb-minimal-resources/config/jvpp.json @@ -0,0 +1,3 @@ +{ + "jvpp-connection-name": "honeycomb" +}
\ No newline at end of file diff --git a/vpp-common/vpp-common-integration/src/test/java/io/fd/honeycomb/vpp/common/integration/VppCommonModuleTest.java b/vpp-common/vpp-common-integration/src/test/java/io/fd/honeycomb/vpp/common/integration/VppCommonModuleTest.java new file mode 100644 index 000000000..476e15919 --- /dev/null +++ b/vpp-common/vpp-common-integration/src/test/java/io/fd/honeycomb/vpp/common/integration/VppCommonModuleTest.java @@ -0,0 +1,53 @@ +/* + * 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.vpp.common.integration; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.not; +import static org.hamcrest.Matchers.empty; +import static org.junit.Assert.assertThat; +import static org.mockito.MockitoAnnotations.initMocks; + +import com.google.inject.Guice; +import com.google.inject.Inject; +import com.google.inject.name.Named; +import com.google.inject.testing.fieldbinder.Bind; +import com.google.inject.testing.fieldbinder.BoundFieldModule; +import io.fd.honeycomb.translate.read.ReaderFactory; +import java.util.HashSet; +import java.util.Set; +import org.junit.Test; +import org.mockito.Mock; +import org.opendaylight.controller.md.sal.binding.api.DataBroker; + +public class VppCommonModuleTest { + + @Named("honeycomb-context") + @Bind + @Mock + private DataBroker honeycombContext; + + @Inject + private Set<ReaderFactory> readerFactories = new HashSet<>(); + + @Test + public void testConfigure() throws Exception { + initMocks(this); + Guice.createInjector(new VppCommonModule(), BoundFieldModule.of(this)).injectMembers(this); + assertThat(readerFactories, is(not(empty()))); + } +}
\ No newline at end of file diff --git a/vpp-common/vpp-common-integration/src/test/resources/jvpp.json b/vpp-common/vpp-common-integration/src/test/resources/jvpp.json new file mode 100644 index 000000000..1d411872e --- /dev/null +++ b/vpp-common/vpp-common-integration/src/test/resources/jvpp.json @@ -0,0 +1,3 @@ +{ + "jvpp-connection-name": "honeycomb" +}
\ No newline at end of file |