summaryrefslogtreecommitdiffstats
path: root/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf
diff options
context:
space:
mode:
authorMarco Platania <platania@research.att.com>2019-04-18 18:02:47 -0400
committerMarco Platania <platania@research.att.com>2019-04-18 18:02:47 -0400
commit149a1664fcb40e1ad83f48878a13d2aff0f65b75 (patch)
treee4d788a6da45d66f7d5afa0f39feafa4e7fa5ae2 /vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf
parent0443998090eb195b1e2de897201843b8a90ae037 (diff)
Update Honeycomb to Rel1810 for vFW
- Update Honeycomb version to 1810 to support ODL Fluorine - Migrate existing stream-count plugin to 1810 - Update POM structure - Update vPacketGen install file (including ARM64) Change-Id: I2866c80876550cb149cdb5fee3193d453643639c Issue-ID: INT-1035 Signed-off-by: Marco Platania <platania@research.att.com>
Diffstat (limited to 'vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf')
-rw-r--r--vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/CrudService.java64
-rw-r--r--vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/ElementCrudService.java103
-rw-r--r--vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/Module.java63
-rw-r--r--vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/ModuleConfiguration.java46
-rw-r--r--vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/write/ElementCustomizer.java96
-rw-r--r--vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/write/ModuleWriterFactory.java57
6 files changed, 429 insertions, 0 deletions
diff --git a/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/CrudService.java b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/CrudService.java
new file mode 100644
index 00000000..33b2e18f
--- /dev/null
+++ b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/CrudService.java
@@ -0,0 +1,64 @@
+/*
+ * 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 org.onap.vnf.vfw;
+
+import io.fd.honeycomb.translate.read.ReadFailedException;
+import io.fd.honeycomb.translate.write.WriteFailedException;
+import java.util.List;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Example of an aggregated access interface.
+ * <p/>
+ * Shared by all the customizers hiding the ugly details of our data management.
+ *
+ * TODO update javadoc
+ */
+public interface CrudService<T extends DataObject> {
+
+ /**
+ * Perform write of provided data.
+ */
+ void writeData(@Nonnull final InstanceIdentifier<T> identifier, @Nonnull final T data)
+ throws WriteFailedException;
+
+
+ /**
+ * Perform delete of existing data.
+ */
+ void deleteData(@Nonnull final InstanceIdentifier<T> identifier, @Nonnull final T data)
+ throws WriteFailedException;
+
+ /**
+ * Perform update of existing data.
+ */
+ void updateData(@Nonnull final InstanceIdentifier<T> identifier, @Nonnull final T dataOld,
+ @Nonnull final T dataNew)
+ throws WriteFailedException;
+
+ /**
+ * Read data identified by provided identifier.
+ */
+ T readSpecific(@Nonnull final InstanceIdentifier<T> identifier) throws ReadFailedException;
+
+ /**
+ * Read all nodes of type {@link T}.
+ */
+ List<T> readAll() throws ReadFailedException;
+}
diff --git a/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/ElementCrudService.java b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/ElementCrudService.java
new file mode 100644
index 00000000..945f992c
--- /dev/null
+++ b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/ElementCrudService.java
@@ -0,0 +1,103 @@
+/*
+ * 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.
+ */
+
+/*
+ * Modifications copyright (c) 2019 AT&T Intellectual Property
+ */
+
+package org.onap.vnf.vfw;
+
+import io.fd.honeycomb.translate.read.ReadFailedException;
+import io.fd.honeycomb.translate.write.WriteFailedException;
+import java.util.Collections;
+import java.util.List;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.stream.count.rev190118.StreamCountState;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.stream.count.rev190118.stream.count.params.Streams;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.stream.count.rev190118.stream.count.params.StreamsBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.stream.count.rev190118.StreamNum;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Simple example of class handling Crud operations for plugin.
+ * <p/>
+ * No real handling, serves just as an illustration.
+ *
+ * TODO update javadoc
+ */
+final class ElementCrudService implements CrudService<Streams> {
+
+ private static final Logger LOG = LoggerFactory.getLogger(ElementCrudService.class);
+
+ @Override
+ public void writeData(@Nonnull final InstanceIdentifier<Streams> identifier, @Nonnull final Streams data)
+ throws WriteFailedException {
+ if (data != null) {
+
+ // Performs any logic needed for persisting such data
+ LOG.info("Writing path[{}] / data [{}]", identifier, data);
+ } else {
+ throw new WriteFailedException.CreateFailedException(identifier, data,
+ new NullPointerException("Provided data are null"));
+ }
+ }
+
+ @Override
+ public void deleteData(@Nonnull final InstanceIdentifier<Streams> identifier, @Nonnull final Streams data)
+ throws WriteFailedException {
+ if (data != null) {
+
+ // Performs any logic needed for persisting such data
+ LOG.info("Removing path[{}] / data [{}]", identifier, data);
+ } else {
+ throw new WriteFailedException.DeleteFailedException(identifier,
+ new NullPointerException("Provided data are null"));
+ }
+ }
+
+ @Override
+ public void updateData(@Nonnull final InstanceIdentifier<Streams> identifier, @Nonnull final Streams dataOld,
+ @Nonnull final Streams dataNew) throws WriteFailedException {
+ if (dataOld != null && dataNew != null) {
+
+ // Performs any logic needed for persisting such data
+ LOG.info("Update path[{}] from [{}] to [{}]", identifier, dataOld, dataNew);
+ } else {
+ throw new WriteFailedException.DeleteFailedException(identifier,
+ new NullPointerException("Provided data are null"));
+ }
+ }
+
+ @Override
+ public Streams readSpecific(@Nonnull final InstanceIdentifier<Streams> identifier) throws ReadFailedException {
+
+ // load data by this key
+ // *Key class will always contain key of entity, in this case long value
+
+ return new StreamsBuilder()
+ .setActiveStreams(new StreamNum(1L))
+ .build();
+ }
+
+ @Override
+ public List<Streams> readAll() throws ReadFailedException {
+ // read all data under parent node,in this case {@link ModuleState}
+ return Collections.singletonList(
+ readSpecific(InstanceIdentifier.create(StreamCountState.class).child(Streams.class)));
+ }
+}
diff --git a/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/Module.java b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/Module.java
new file mode 100644
index 00000000..31ba56e1
--- /dev/null
+++ b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/Module.java
@@ -0,0 +1,63 @@
+/*
+ * 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.
+ */
+
+/*
+ * Modifications copyright (c) 2019 AT&T Intellectual Property
+ */
+
+package org.onap.vnf.vfw;
+
+import static org.onap.vnf.vfw.ModuleConfiguration.ELEMENT_SERVICE_NAME;
+
+import com.google.inject.AbstractModule;
+import com.google.inject.TypeLiteral;
+import com.google.inject.multibindings.Multibinder;
+import com.google.inject.name.Names;
+import org.onap.vnf.vfw.write.ModuleWriterFactory;
+import io.fd.honeycomb.data.init.DataTreeInitializer;
+import io.fd.honeycomb.translate.write.WriterFactory;
+import net.jmob.guice.conf.core.ConfigurationModule;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.stream.count.rev190118.stream.count.params.Streams;
+
+/**
+ * Module class instantiating stream-count plugin components.
+ */
+public final class Module extends AbstractModule {
+
+ // TODO This initiates all the plugin components, but it still needs to be registered/wired into an integration
+ // module producing runnable distributions. There is one such distribution in honeycomb project:
+ // vpp-integration/minimal-distribution
+ // In order to integrate this plugin with the distribution:
+ // 1. Add a dependency on this maven module to the the distribution's pom.xml
+ // 2. Add an instance of this module into the distribution in its Main class
+
+ @Override
+ protected void configure() {
+ // requests injection of properties
+ install(ConfigurationModule.create());
+ requestInjection(ModuleConfiguration.class);
+
+ // creates binding for interface implementation by name
+ bind(new TypeLiteral<CrudService<Streams>>(){})
+ .annotatedWith(Names.named(ELEMENT_SERVICE_NAME))
+ .to(ElementCrudService.class);
+
+ // create writer factory binding
+ // can hold multiple binding for separate yang modules
+ final Multibinder<WriterFactory> writerFactoryBinder = Multibinder.newSetBinder(binder(), WriterFactory.class);
+ writerFactoryBinder.addBinding().to(ModuleWriterFactory.class);
+ }
+}
diff --git a/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/ModuleConfiguration.java b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/ModuleConfiguration.java
new file mode 100644
index 00000000..c229c5ad
--- /dev/null
+++ b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/ModuleConfiguration.java
@@ -0,0 +1,46 @@
+/*
+ * 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 org.onap.vnf.vfw;
+
+import net.jmob.guice.conf.core.BindConfig;
+import net.jmob.guice.conf.core.InjectConfig;
+import net.jmob.guice.conf.core.Syntax;
+
+/**
+ * Class containing static configuration for stream-count module,<br>
+ * either loaded from property file stream-count.json from classpath.
+ * <p/>
+ * Further documentation for the configuration injection can be found at:
+ * https://github.com/yyvess/gconf
+ */
+@BindConfig(value = "stream-count", syntax = Syntax.JSON)
+public final class ModuleConfiguration {
+
+ // TODO change the sample property to real plugin configuration
+ // If there is no such configuration, remove this, stream-count.json resource and its wiring from Module class
+
+ /**
+ * Sample property that's injected from external json configuration file.
+ */
+ @InjectConfig("sample-prop")
+ public String sampleProp;
+
+ /**
+ * Constant name used to identify stream-count plugin specific components during dependency injection.
+ */
+ public static final String ELEMENT_SERVICE_NAME = "element-service";
+}
diff --git a/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/write/ElementCustomizer.java b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/write/ElementCustomizer.java
new file mode 100644
index 00000000..18329e84
--- /dev/null
+++ b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/write/ElementCustomizer.java
@@ -0,0 +1,96 @@
+/*
+ * 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.
+ */
+
+/*
+ * Modifications copyright (c) 2019 AT&T Intellectual Property
+ */
+
+package org.onap.vnf.vfw.write;
+
+import org.onap.vnf.vfw.CrudService;
+import io.fd.honeycomb.translate.spi.write.WriterCustomizer;
+import io.fd.honeycomb.translate.write.WriteContext;
+import io.fd.honeycomb.translate.write.WriteFailedException;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.stream.count.rev190118.stream.count.params.Streams;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import java.io.IOException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Writer for {@link Element} list node from our YANG model.
+ */
+public final class ElementCustomizer implements WriterCustomizer<Streams> {
+
+ private static final Logger LOG = LoggerFactory.getLogger(ElementCustomizer.class);
+
+ private final CrudService<Streams> crudService;
+
+ public ElementCustomizer(@Nonnull final CrudService<Streams> crudService) {
+ this.crudService = crudService;
+ }
+
+ @Override
+ public void writeCurrentAttributes(@Nonnull final InstanceIdentifier<Streams> id, @Nonnull final Streams dataAfter,
+ @Nonnull final WriteContext writeContext) throws WriteFailedException {
+ //perform write of data,or throw exception
+ //invoked by PUT operation,if provided data doesn't exist in Config data
+ crudService.writeData(id, dataAfter);
+ try {
+ runScript(dataAfter.getActiveStreams().getValue());
+ }
+ catch (IOException e) {
+ String message = "Write operation failed " + e;
+ LOG.error(message);
+ }
+ }
+
+ @Override
+ public void updateCurrentAttributes(@Nonnull final InstanceIdentifier<Streams> id,
+ @Nonnull final Streams dataBefore,
+ @Nonnull final Streams dataAfter, @Nonnull final WriteContext writeContext)
+ throws WriteFailedException {
+ //invoked by PUT operation,if provided data does exist in Config data
+ crudService.updateData(id, dataBefore, dataAfter);
+ try {
+ runScript(dataAfter.getActiveStreams().getValue());
+ }
+ catch (IOException e) {
+ String message = "Write operation failed " + e;
+ LOG.error(message);
+ }
+ }
+
+ @Override
+ public void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<Streams> id,
+ @Nonnull final Streams dataBefore,
+ @Nonnull final WriteContext writeContext) throws WriteFailedException {
+ //perform delete of data,or throw exception
+ // Not supported, throw exception
+ throw new WriteFailedException.DeleteFailedException(id,
+ new UnsupportedOperationException("Delete operation not supported"));
+ }
+
+ //Update the number of running streams running a custom script that uses the old vPacketGen REST APIs
+ private void runScript(long streams) throws IOException {
+
+ String script = new String("bash /opt/enable_disable_streams.sh " + streams);
+ Runtime.getRuntime().exec(script);
+ String message = "Number of running streams updated to " + streams;
+ LOG.info(message);
+ }
+} \ No newline at end of file
diff --git a/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/write/ModuleWriterFactory.java b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/write/ModuleWriterFactory.java
new file mode 100644
index 00000000..0bd7b8e1
--- /dev/null
+++ b/vnfs/honeycomb_plugin/stream-count/stream-count-impl/src/main/java/org/onap/vnf/vfw/write/ModuleWriterFactory.java
@@ -0,0 +1,57 @@
+/*
+ * 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.
+ */
+
+/*
+ * Modifications copyright (c) 2019 AT&T Intellectual Property
+ */
+
+package org.onap.vnf.vfw.write;
+
+import static org.onap.vnf.vfw.ModuleConfiguration.ELEMENT_SERVICE_NAME;
+
+import com.google.inject.Inject;
+import com.google.inject.name.Named;
+import org.onap.vnf.vfw.CrudService;
+import io.fd.honeycomb.translate.impl.write.GenericWriter;
+import io.fd.honeycomb.translate.write.WriterFactory;
+import io.fd.honeycomb.translate.write.registry.ModifiableWriterRegistryBuilder;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.stream.count.rev190118.StreamCount;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.stream.count.rev190118.stream.count.params.Streams;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Factory producing writers for stream-count plugin's data.
+ */
+public final class ModuleWriterFactory implements WriterFactory {
+
+ private static final InstanceIdentifier<StreamCount> ROOT_CONTAINER_ID = InstanceIdentifier.create(StreamCount.class);
+
+ /**
+ * Injected crud service to be passed to customizers instantiated in this factory.
+ */
+ @Inject
+ @Named(ELEMENT_SERVICE_NAME)
+ private CrudService<Streams> crudService;
+
+ @Override
+ public void init(@Nonnull final ModifiableWriterRegistryBuilder registry) {
+
+ //adds writer for child node
+ //no need to add writers for empty nodes
+ registry.add(new GenericWriter<>(ROOT_CONTAINER_ID.child(Streams.class), new ElementCustomizer(crudService)));
+ }
+}