diff options
Diffstat (limited to 'v3po/vpp-translate-utils')
26 files changed, 0 insertions, 1638 deletions
diff --git a/v3po/vpp-translate-utils/Readme.adoc b/v3po/vpp-translate-utils/Readme.adoc deleted file mode 100644 index 1aaaea181..000000000 --- a/v3po/vpp-translate-utils/Readme.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Honeycomb. VPP translation layer utils - -Provides utility classes useful in translation layer implementation for the VPP.
\ No newline at end of file diff --git a/v3po/vpp-translate-utils/pom.xml b/v3po/vpp-translate-utils/pom.xml deleted file mode 100644 index cc87e1647..000000000 --- a/v3po/vpp-translate-utils/pom.xml +++ /dev/null @@ -1,71 +0,0 @@ -<?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.0.0-SNAPSHOT</version> - <relativePath>../../common/impl-parent</relativePath> - </parent> - - <modelVersion>4.0.0</modelVersion> - <groupId>io.fd.honeycomb.v3po</groupId> - <artifactId>vpp-translate-utils</artifactId> - <version>1.0.0-SNAPSHOT</version> - <packaging>bundle</packaging> - - <dependencies> - <dependency> - <groupId>${project.groupId}</groupId> - <artifactId>translate-utils</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>${project.groupId}</groupId> - <artifactId>v3po-api</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>io.fd.vpp</groupId> - <artifactId>jvpp</artifactId> - <version>16.09-SNAPSHOT</version> - </dependency> - <dependency> - <groupId>org.opendaylight.mdsal.model</groupId> - <artifactId>ietf-interfaces</artifactId> - </dependency> - <dependency> - <groupId>io.fd.honeycomb.v3po</groupId> - <artifactId>data-api</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-all</artifactId> - <scope>test</scope> - </dependency> - - </dependencies> - -</project> diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/AbstractInterfaceTypeCustomizer.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/AbstractInterfaceTypeCustomizer.java deleted file mode 100644 index 1f2fbd838..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/AbstractInterfaceTypeCustomizer.java +++ /dev/null @@ -1,103 +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.util; - -import static com.google.common.base.Preconditions.checkArgument; -import static com.google.common.base.Preconditions.checkState; - -import com.google.common.base.Optional; -import io.fd.honeycomb.v3po.translate.spi.write.WriterCustomizer; -import io.fd.honeycomb.v3po.translate.write.WriteContext; -import io.fd.honeycomb.v3po.translate.write.WriteFailedException; -import javax.annotation.Nonnull; -import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType; -import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface; -import org.opendaylight.yangtools.yang.binding.DataObject; -import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; -import org.openvpp.jvpp.future.FutureJVpp; - -/** - * Validation WriteCustomizers for Interface subnodes. - * Validates the type of interface. - * - * TODO this should be validated on model/DataTree level. However DataTree does not enforce When conditions - * Delete this class when DataTree handles when constraints properly - */ -public abstract class AbstractInterfaceTypeCustomizer<D extends DataObject> - extends FutureJVppCustomizer implements WriterCustomizer<D> { - - protected AbstractInterfaceTypeCustomizer(final FutureJVpp futureJvpp) { - super(futureJvpp); - } - - private void checkProperInterfaceType(@Nonnull final WriteContext writeContext, - @Nonnull final InstanceIdentifier<D> id) { - final InstanceIdentifier<Interface> ifcTypeFromIid = id.firstIdentifierOf(Interface.class); - checkArgument(ifcTypeFromIid != null, "Instance identifier does not contain {} type", Interface.class); - checkArgument(id.firstKeyOf(Interface.class) != null, "Instance identifier does not contain keyed {} type", - Interface.class); - final Optional<Interface> interfaceConfig = writeContext.readAfter(ifcTypeFromIid); - checkState(interfaceConfig.isPresent(), - "Unable to get Interface configuration for an interface: %s currently being updated", ifcTypeFromIid); - - IllegalInterfaceTypeException - .checkInterfaceType(interfaceConfig.get(), getExpectedInterfaceType()); - } - - protected abstract Class<? extends InterfaceType> getExpectedInterfaceType(); - - /** - * Validate expected interface type - */ - @Override - public final void writeCurrentAttributes(@Nonnull final InstanceIdentifier<D> id, @Nonnull final D dataAfter, - @Nonnull final WriteContext writeContext) throws WriteFailedException { - checkProperInterfaceType(writeContext, id); - writeInterface(id, dataAfter, writeContext); - } - - protected abstract void writeInterface(final InstanceIdentifier<D> id, final D dataAfter, - final WriteContext writeContext) - throws WriteFailedException; - - // Validation for update and delete is not necessary - - /** - * Indicates unexpected interface type - */ - protected static final class IllegalInterfaceTypeException extends IllegalArgumentException { - - private IllegalInterfaceTypeException(final String msg) { - super(msg); - } - - /** - * Check the type of interface equals expected type - * - * @throws IllegalInterfaceTypeException if type of interface is null or not expected - */ - static void checkInterfaceType(@Nonnull final Interface ifc, - @Nonnull final Class<? extends InterfaceType> expectedType) { - if (ifc.getType() == null || !expectedType.equals(ifc.getType())) { - throw new IllegalInterfaceTypeException(String.format( - "Unexpected interface type: %s for interface: %s. Expected interface is: %s", ifc.getType(), - ifc.getName(), expectedType)); - } - } - - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/FutureJVppCustomizer.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/FutureJVppCustomizer.java deleted file mode 100644 index 3f4f1f5ce..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/FutureJVppCustomizer.java +++ /dev/null @@ -1,45 +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.util; - -import com.google.common.annotations.Beta; -import com.google.common.base.Preconditions; -import org.openvpp.jvpp.future.FutureJVpp; - -import javax.annotation.Nonnull; - -/** - * Abstract utility to hold the vppApi reference. - */ -@Beta -public abstract class FutureJVppCustomizer { - - private final FutureJVpp futureJvpp; - - public FutureJVppCustomizer(@Nonnull final FutureJVpp futureJvpp) { - this.futureJvpp = Preconditions.checkNotNull(futureJvpp, "futureJvpp should not be null"); - } - - /** - * Get vppApi reference - * - * @return vppApi reference - */ - public FutureJVpp getFutureJVpp() { - return futureJvpp; - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/NamingContext.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/NamingContext.java deleted file mode 100644 index f6e0e6d48..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/NamingContext.java +++ /dev/null @@ -1,188 +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.util; - -import static com.google.common.base.Preconditions.checkArgument; -import static com.google.common.base.Preconditions.checkState; - -import com.google.common.base.Optional; -import io.fd.honeycomb.v3po.translate.MappingContext; -import io.fd.honeycomb.v3po.translate.util.RWUtils; -import java.util.stream.Collector; -import javax.annotation.Nonnull; -import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.Contexts; -import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.NamingContextKey; -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.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.mappings.Mapping; -import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.mappings.MappingBuilder; -import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.mappings.MappingKey; -import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; -import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * Utility adapter on top of {@link MappingContext} storing integer to string mappings according to naming-context yang - * model - */ -public final class NamingContext implements AutoCloseable { - - private static final Logger LOG = LoggerFactory.getLogger(NamingContext.class); - - private final String artificialNamePrefix; - private final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.NamingContext, NamingContextKey> - namingContextIid; - - private static final Collector<Mapping, ?, Mapping> SINGLE_ITEM_COLLECTOR = RWUtils.singleItemCollector(); - - /** - * Create new naming context - * - * @param artificialNamePrefix artificial name to be used for items without a name in VPP (or not provided) - * @param instanceName name of this context instance. Will be used as list item identifier within context data tree - */ - public NamingContext(@Nonnull final String artificialNamePrefix, @Nonnull final String instanceName) { - this.artificialNamePrefix = artificialNamePrefix; - namingContextIid = InstanceIdentifier.create(Contexts.class).child( - org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.NamingContext.class, - new NamingContextKey(instanceName)); - } - - /** - * Retrieve name for mapping stored provided mappingContext instance. If not present, artificial name will be - * generated. - * - * @param index index of a mapped item - * @param mappingContext mapping context providing context data for current transaction - * - * @return name mapped to provided index - */ - @Nonnull - public synchronized String getName(final int index, @Nonnull final MappingContext mappingContext) { - if (!containsName(index, mappingContext)) { - final String artificialName = getArtificialName(index); - addName(index, artificialName, mappingContext); - } - - final Optional<Mappings> read = mappingContext.read(namingContextIid.child(Mappings.class)); - checkState(read.isPresent(), "Mapping for index: %s is not present. But should be", index); - - return read.get().getMapping().stream() - .filter(mapping -> mapping.getIndex().equals(index)) - .collect(SINGLE_ITEM_COLLECTOR).getName(); - } - - /** - * Retrieve name for mapping stored provided mappingContext instance. if present - * - * @param index index of a mapped item - * @param mappingContext mapping context providing context data for current transaction - * - * @return name mapped to provided index - */ - @Nonnull - public synchronized Optional<String> getNameIfPresent(final int index, - @Nonnull final MappingContext mappingContext) { - final Optional<Mappings> read = mappingContext.read(namingContextIid.child(Mappings.class)); - - return read.isPresent() - ? Optional.of(read.get().getMapping().stream() - .filter(mapping -> mapping.getIndex().equals(index)) - .collect(SINGLE_ITEM_COLLECTOR) - .getName()) - : Optional.absent(); - } - - /** - * Check whether mapping is present for index. - * - * @param index index of a mapped item - * @param mappingContext mapping context providing context data for current transaction - * - * @return true if present, false otherwise - */ - public synchronized boolean containsName(final int index, @Nonnull final MappingContext mappingContext) { - final Optional<Mappings> read = mappingContext.read(namingContextIid.child(Mappings.class)); - return read.isPresent() - ? read.get().getMapping().stream().anyMatch(mapping -> mapping.getIndex().equals(index)) - : false; - } - - - /** - * Add mapping to current context - * - * @param index index of a mapped item - * @param name name of a mapped item - * @param mappingContext mapping context providing context data for current transaction - */ - public synchronized void addName(final int index, final String name, final MappingContext mappingContext) { - final KeyedInstanceIdentifier<Mapping, MappingKey> mappingIid = getMappingIid(name); - mappingContext.put(mappingIid, new MappingBuilder().setIndex(index).setName(name).build()); - } - - private KeyedInstanceIdentifier<Mapping, MappingKey> getMappingIid(final String name) { - return namingContextIid.child(Mappings.class).child(Mapping.class, new MappingKey(name)); - } - - /** - * Remove mapping from current context - * - * @param name name of a mapped item - * @param mappingContext mapping context providing context data for current transaction - */ - public synchronized void removeName(final String name, final MappingContext mappingContext) { - mappingContext.delete(getMappingIid(name)); - } - - /** - * Returns index value associated with the given name. - * - * @param name the name whose associated index value is to be returned - * @param mappingContext mapping context providing context data for current transaction - * - * @return integer index value matching supplied name - * @throws IllegalArgumentException if name was not found - */ - public synchronized int getIndex(final String name, final MappingContext mappingContext) { - final Optional<Mapping> read = mappingContext.read(getMappingIid(name)); - checkArgument(read.isPresent(), "No mapping stored for name: %s", name); - return read.get().getIndex(); - - } - - /** - * Check whether mapping is present for name. - * - * @param name name of a mapped item - * @param mappingContext mapping context providing context data for current transaction - * - * @return true if present, false otherwise - */ - public synchronized boolean containsIndex(final String name, final MappingContext mappingContext) { - return mappingContext.read(getMappingIid(name)).isPresent(); - } - - private String getArtificialName(final int index) { - return artificialNamePrefix + index; - } - - @Override - public void close() throws Exception { - /// Not removing the mapping from backing storage - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/ReadTimeoutException.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/ReadTimeoutException.java deleted file mode 100644 index 654b13825..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/ReadTimeoutException.java +++ /dev/null @@ -1,33 +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.util; - -import com.google.common.annotations.Beta; -import io.fd.honeycomb.v3po.translate.read.ReadFailedException; -import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; - -/** - * Thrown when read method invocation times out. - */ -@Beta -public class ReadTimeoutException extends ReadFailedException { - - public ReadTimeoutException(final InstanceIdentifier<?> id, final Throwable cause) { - super(id, cause); - } - -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/SubInterfaceUtils.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/SubInterfaceUtils.java deleted file mode 100644 index 1df82af73..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/SubInterfaceUtils.java +++ /dev/null @@ -1,28 +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.util; - -public final class SubInterfaceUtils { - - private SubInterfaceUtils() { - throw new UnsupportedOperationException("Utility class cannot be instantiated."); - } - - public static String getSubInterfaceName(final String superIfName, final int subIfaceId) { - return String.format("%s.%d", superIfName, subIfaceId); - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/TagRewriteOperation.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/TagRewriteOperation.java deleted file mode 100644 index 316d1f8e2..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/TagRewriteOperation.java +++ /dev/null @@ -1,86 +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.util; - -import com.google.common.base.Preconditions; -import com.google.common.primitives.UnsignedBytes; -import javax.annotation.Nonnegative; -import javax.annotation.Nullable; - -/** - * Defines vlan tag rewrite config options for VPP - * - * TODO corresponding enum (defined in l2_vtr.h) should be defined in vpe.api - * (does vpp's IDL support enum type definition?) - * which would allow to generate this class in jvpp - */ -public enum TagRewriteOperation { - disabled(0), - push_1(0), - push_2(0), - pop_1(1), - pop_2(2), - translate_1_to_1(1), - translate_1_to_2(1), - translate_2_to_1(2), - translate_2_to_2(2); - - private final static int MAX_INDEX = 3; - private final int code; - private final byte popTags; - - TagRewriteOperation(final int popTags) { - this.code = this.ordinal(); - this.popTags = UnsignedBytes.checkedCast(popTags); - } - - private static TagRewriteOperation[][] translation = new TagRewriteOperation[][] { - {disabled, push_1, push_2}, - {pop_1, translate_1_to_1, translate_1_to_2}, - {pop_2, translate_2_to_1, translate_2_to_2} - }; - - /** - * Returns VPP tag rewrite operation for given number of tags to pop and tags to push. - * @param toPop number of tags to pop (0..2) - * @param toPush number of tags to push (0..2) - * @return vpp tag rewrite operation for given input parameters - */ - public static TagRewriteOperation get(@Nonnegative final int toPop, @Nonnegative final int toPush) { - Preconditions.checkElementIndex(toPop, MAX_INDEX, "Illegal number of tags to pop"); - Preconditions.checkElementIndex(toPush, MAX_INDEX, "Illegal number of tags to push"); - return translation[toPop][toPush]; - } - - /** - * Returns VPP tag rewrite operation for given operation code. - * @param code VPP tag rewrite operation code - * @return vpp tag rewrite operation for given input parameter - */ - @Nullable - public static TagRewriteOperation get(@Nonnegative final int code) { - for (TagRewriteOperation operation : TagRewriteOperation.values()) { - if (code == operation.code){ - return operation; - } - } - return null; - } - - public byte getPopTags() { - return popTags; - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/TranslateUtils.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/TranslateUtils.java deleted file mode 100644 index 1a6a50133..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/TranslateUtils.java +++ /dev/null @@ -1,225 +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.util; - -import static com.google.common.base.Preconditions.checkArgument; - -import com.google.common.base.Splitter; -import com.google.common.net.InetAddresses; -import java.net.UnknownHostException; -import java.util.Arrays; -import java.util.List; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import java.util.function.BiConsumer; -import javax.annotation.Nonnegative; -import javax.annotation.Nonnull; -import javax.annotation.Nullable; -import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone; -import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; -import org.openvpp.jvpp.VppBaseCallException; -import org.openvpp.jvpp.dto.JVppReply; - -public final class TranslateUtils { - - public static final Splitter COLON_SPLITTER = Splitter.on(':'); - public static final int DEFAULT_TIMEOUT_IN_SECONDS = 5; - - private TranslateUtils() { - } - - public static <REP extends JVppReply<?>> REP getReplyForWrite(@Nonnull Future<REP> future, - @Nonnull final InstanceIdentifier<?> replyType) - throws VppBaseCallException, WriteTimeoutException { - return getReplyForWrite(future, replyType, DEFAULT_TIMEOUT_IN_SECONDS); - } - - public static <REP extends JVppReply<?>> REP getReplyForWrite(@Nonnull Future<REP> future, - @Nonnull final InstanceIdentifier<?> replyType, - @Nonnegative final int timeoutInSeconds) - throws VppBaseCallException, WriteTimeoutException { - try { - return getReply(future, timeoutInSeconds); - } catch (TimeoutException e) { - throw new WriteTimeoutException(replyType, e); - } - } - - public static <REP extends JVppReply<?>> REP getReplyForRead(@Nonnull Future<REP> future, - @Nonnull final InstanceIdentifier<?> replyType) - throws VppBaseCallException, ReadTimeoutException { - return getReplyForRead(future, replyType, DEFAULT_TIMEOUT_IN_SECONDS); - } - - public static <REP extends JVppReply<?>> REP getReplyForRead(@Nonnull Future<REP> future, - @Nonnull final InstanceIdentifier<?> replyType, - @Nonnegative final int timeoutInSeconds) - throws VppBaseCallException, ReadTimeoutException { - try { - return getReply(future, timeoutInSeconds); - } catch (TimeoutException e) { - throw new ReadTimeoutException(replyType, e); - } - } - - public static <REP extends JVppReply<?>> REP getReply(@Nonnull Future<REP> future) - throws TimeoutException, VppBaseCallException { - return getReply(future, DEFAULT_TIMEOUT_IN_SECONDS); - } - - public static <REP extends JVppReply<?>> REP getReply(@Nonnull Future<REP> future, - @Nonnegative final int timeoutInSeconds) - throws TimeoutException, VppBaseCallException { - try { - checkArgument(timeoutInSeconds > 0, "Timeout cannot be < 0"); - return future.get(timeoutInSeconds, TimeUnit.SECONDS); - } catch (InterruptedException e) { - Thread.currentThread().interrupt(); - throw new IllegalStateException("Interrupted", e); - } catch (ExecutionException e) { - // Execution exception could generally contains any exception - // when using exceptions instead of return codes just rethrow it for processing on corresponding place - if (e instanceof ExecutionException && (e.getCause() instanceof VppBaseCallException)) { - throw (VppBaseCallException) (e.getCause()); - } - throw new IllegalStateException(e); - } - } - - /** - * Transform Ipv4 address to a byte array acceptable by VPP. VPP expects incoming byte array to be in the same order - * as the address. - * - * @return byte array with address bytes - */ - public static byte[] ipv4AddressNoZoneToArray(final Ipv4AddressNoZone ipv4Addr) { - byte[] retval = new byte[4]; - String[] dots = ipv4Addr.getValue().split("\\."); - - for (int d = 0; d < 4; d++) { - retval[d] = (byte) (Short.parseShort(dots[d]) & 0xff); - } - return retval; - } - - /** - * Parse byte array returned by VPP representing an Ipv4 address. Vpp returns IP byte arrays in reversed order. - * - * @return Ipv4AddressNoZone containing string representation of IPv4 address constructed from submitted bytes. No - * change in order. - */ - @Nonnull - public static Ipv4AddressNoZone arrayToIpv4AddressNoZone(@Nonnull byte[] ip) { - // VPP sends ipv4 in a 16 byte array - if (ip.length == 16) { - ip = Arrays.copyOfRange(ip, 0, 4); - } - try { - // Not reversing the byte array here!! because the IP coming from VPP is in reversed byte order - // compared to byte order it was submitted - return new Ipv4AddressNoZone(InetAddresses.toAddrString(InetAddresses.fromLittleEndianByteArray(ip))); - } catch (UnknownHostException e) { - throw new IllegalArgumentException("Unable to parse ipv4", e); - } - } - - /** - * Return (interned) string from byte array while removing \u0000. Strings represented as fixed length byte[] from - * vpp contain \u0000. - */ - public static String toString(final byte[] cString) { - return new String(cString).replaceAll("\\u0000", "").intern(); - } - - /** - * Parse string represented mac address (using ":" as separator) into a byte array - */ - @Nonnull - public static byte[] parseMac(@Nonnull final String macAddress) { - final List<String> parts = COLON_SPLITTER.splitToList(macAddress); - checkArgument(parts.size() == 6, "Mac address is expected to have 6 parts but was: %s", macAddress); - return parseMacLikeString(parts); - } - - private static byte[] parseMacLikeString(final List<String> strings) { - return strings.stream().limit(6).map(TranslateUtils::parseHexByte).collect( - () -> new byte[strings.size()], - new BiConsumer<byte[], Byte>() { - - private int i = -1; - - @Override - public void accept(final byte[] bytes, final Byte aByte) { - bytes[++i] = aByte; - } - }, - (bytes, bytes2) -> { - throw new UnsupportedOperationException("Parallel collect not supported"); - }); - } - - public static byte parseHexByte(final String aByte) { - return (byte) Integer.parseInt(aByte, 16); - } - - /** - * Returns 0 if argument is null or false, 1 otherwise. - * - * @param value Boolean value to be converted - * @return byte value equal to 0 or 1 - */ - public static byte booleanToByte(@Nullable final Boolean value) { - return value != null && value - ? (byte) 1 - : (byte) 0; - } - - /** - * Returns Boolean.TRUE if argument is 0, Boolean.FALSE otherwise. - * - * @param value byte value to be converted - * @return Boolean value - * @throws IllegalArgumentException if argument is neither 0 nor 1 - */ - @Nonnull - public static Boolean byteToBoolean(final byte value) { - if (value == 0) { - return Boolean.FALSE; - } else if (value == 1) { - return Boolean.TRUE; - } - throw new IllegalArgumentException(String.format("0 or 1 was expected but was %d", value)); - } - - /** - * Reverses bytes in the byte array - * - * @param bytes input array - * @return reversed array - */ - public static byte[] reverseBytes(final byte[] bytes) { - final byte[] reversed = new byte[bytes.length]; - int i = 1; - for (byte aByte : bytes) { - reversed[bytes.length - i++] = aByte; - } - - return reversed; - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/WriteTimeoutException.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/WriteTimeoutException.java deleted file mode 100644 index 9516459b2..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/WriteTimeoutException.java +++ /dev/null @@ -1,33 +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.util; - -import com.google.common.annotations.Beta; -import io.fd.honeycomb.v3po.translate.write.WriteFailedException; -import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; - -/** - * Thrown when write method invocation times out. - */ -@Beta -public class WriteTimeoutException extends WriteFailedException { - - public WriteTimeoutException(final InstanceIdentifier<?> id, final Throwable cause) { - super(id, cause); - } - -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/DumpCacheManager.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/DumpCacheManager.java deleted file mode 100644 index 9486ce171..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/DumpCacheManager.java +++ /dev/null @@ -1,124 +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.util.cache; - -import static com.google.common.base.Preconditions.checkNotNull; - -import com.google.common.base.Optional; -import io.fd.honeycomb.v3po.translate.ModificationCache; -import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.check.DumpCheckFailedException; -import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.execution.DumpExecutionFailedException; -import io.fd.honeycomb.v3po.translate.v3po.util.cache.noop.NoopDumpPostProcessingFunction; -import javax.annotation.Nonnull; -import org.openvpp.jvpp.dto.JVppReplyDump; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * Manager responsible for returning Data object dumps<br> either from cache or by invoking specified {@link - * EntityDumpExecutor} - */ -public final class DumpCacheManager<T extends JVppReplyDump, U> { - - private static final Logger LOG = LoggerFactory.getLogger(DumpCacheManager.class); - - private final EntityDumpExecutor<T, U> dumpExecutor; - private final EntityDumpNonEmptyCheck<T> dumpNonEmptyCheck; - private final EntityDumpPostProcessingFunction<T> postProcessor; - - private DumpCacheManager(DumpCacheManagerBuilder builder) { - this.dumpExecutor = builder.dumpExecutor; - this.dumpNonEmptyCheck = builder.dumpNonEmptyCheck; - this.postProcessor = builder.postProcessingFunction; - } - - /** - * Returns {@link Optional<T>} of dump - */ - public Optional<T> getDump(@Nonnull String entityKey, @Nonnull ModificationCache cache) - throws DumpExecutionFailedException { - - //this key binding to every log has its logic ,because every customizer have its own cache manager and if - //there is need for debugging/fixing some complex call with a lot of data,you can get lost in those logs - LOG.debug("Loading dump for KEY[{}]", entityKey); - - T dump = (T) cache.get(entityKey); - - if (dump == null) { - LOG.debug("Dump for KEY[{}] not present in cache,invoking dump executor", entityKey); - - dump = dumpExecutor.executeDump(); - - //this is not a critical exception, so its only logged here - try { - dumpNonEmptyCheck.assertNotEmpty(dump); - } catch (DumpCheckFailedException e) { - LOG.warn("Dump for KEY[{}] has been resolved as empty", entityKey, e); - return Optional.absent(); - } - - //no need to check if post processor active,if wasnt set,default no-op will be used - LOG.debug("Post-processing dump for KEY[{}]", entityKey); - dump = postProcessor.apply(dump); - - LOG.debug("Caching dump for KEY[{}]", entityKey); - cache.put(entityKey, dump); - return Optional.of(dump); - } else { - return Optional.of(dump); - } - } - - public static final class DumpCacheManagerBuilder<T extends JVppReplyDump, U> { - - private EntityDumpExecutor<T, U> dumpExecutor; - private EntityDumpNonEmptyCheck<T> dumpNonEmptyCheck; - private EntityDumpPostProcessingFunction<T> postProcessingFunction; - - public DumpCacheManagerBuilder() { - //for cases when user does not set specific post-processor - postProcessingFunction = new NoopDumpPostProcessingFunction<T>(); - } - - public DumpCacheManagerBuilder<T, U> withExecutor(@Nonnull EntityDumpExecutor<T, U> executor) { - this.dumpExecutor = executor; - return this; - } - - public DumpCacheManagerBuilder<T, U> withNonEmptyPredicate(@Nonnull EntityDumpNonEmptyCheck<T> check) { - this.dumpNonEmptyCheck = check; - return this; - } - - public DumpCacheManagerBuilder<T, U> withPostProcessingFunction( - EntityDumpPostProcessingFunction postProcessingFunction) { - this.postProcessingFunction = postProcessingFunction; - return this; - } - - public DumpCacheManager<T, U> build() { - checkNotNull(dumpExecutor, "Dump executor cannot be null"); - checkNotNull(dumpNonEmptyCheck, "Dump verifier cannot be null"); - checkNotNull(postProcessingFunction, - "Dump post-processor cannot be null cannot be null, default implementation is used if its not set"); - - return new DumpCacheManager<T, U>(this); - } - } -} - - diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/EntityDumpExecutor.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/EntityDumpExecutor.java deleted file mode 100644 index 82b30cf26..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/EntityDumpExecutor.java +++ /dev/null @@ -1,41 +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.util.cache; - -import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.execution.DumpExecutionFailedException; -import org.openvpp.jvpp.dto.JVppReplyDump; - -/** - * Generic interface for classes that return dumps for Data objects - */ -public interface EntityDumpExecutor<T extends JVppReplyDump, U> { - - /** - * Performs dump on {link T} entity - * - * @return dump of specified {@link T} entity - * @throws DumpExecutionFailedException when dump fails - */ - public T executeDump() throws DumpExecutionFailedException; - - /** - * Bind dumping params for executor - */ - default public void bindDumpParams(U params) { - throw new UnsupportedOperationException("You should override this method if you need to bind dumping params"); - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/EntityDumpNonEmptyCheck.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/EntityDumpNonEmptyCheck.java deleted file mode 100644 index 6fb404a7a..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/EntityDumpNonEmptyCheck.java +++ /dev/null @@ -1,33 +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.util.cache; - -import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.check.DumpCheckFailedException; -import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.check.i.DumpEmptyException; -import org.openvpp.jvpp.dto.JVppReplyDump; - -/** - * Generic interface for classes that verifies if dump of data object is non-empty - */ -public interface EntityDumpNonEmptyCheck<T extends JVppReplyDump> { - - /** - * Verifies if data are non-empty,if not throws {@link DumpEmptyException} - * @throws DumpEmptyException - */ - public void assertNotEmpty(T data) throws DumpCheckFailedException; -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/EntityDumpPostProcessingFunction.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/EntityDumpPostProcessingFunction.java deleted file mode 100644 index 3d0040ea6..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/EntityDumpPostProcessingFunction.java +++ /dev/null @@ -1,36 +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.util.cache; - -import java.util.function.Function; -import org.openvpp.jvpp.dto.JVppReplyDump; - -/** - * Generic interface for class that are post-processing data dumped from vpp - */ -@FunctionalInterface -public interface EntityDumpPostProcessingFunction<T extends JVppReplyDump> extends Function<T, T> { - - - /** - * Performs postprocessing on dumped data - * - * @return Post-processed data - */ - @Override - T apply(T t); -}
\ No newline at end of file diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/check/DumpCheckFailedException.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/check/DumpCheckFailedException.java deleted file mode 100644 index f3f8f7fef..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/check/DumpCheckFailedException.java +++ /dev/null @@ -1,31 +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.util.cache.exceptions.check; - -/** - * Abstract parent of exceptions thrown while checking if dump is not empty - */ -public abstract class DumpCheckFailedException extends Exception { - - public DumpCheckFailedException(String message) { - super(message); - } - - public DumpCheckFailedException(String message, Exception cause) { - super(message, cause); - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/check/i/DumpEmptyException.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/check/i/DumpEmptyException.java deleted file mode 100644 index a5a228823..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/check/i/DumpEmptyException.java +++ /dev/null @@ -1,40 +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.util.cache.exceptions.check.i; - -import io.fd.honeycomb.v3po.translate.v3po.util.cache.EntityDumpNonEmptyCheck; -import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.check.DumpCheckFailedException; - -/** - * This exception occurs when dump is resolved as empty by {@link EntityDumpNonEmptyCheck} - */ -public class DumpEmptyException extends DumpCheckFailedException { - - /** - * Creates {@link DumpEmptyException} with specified reason - */ - public DumpEmptyException(String reason) { - super(reason); - } - - /** - * Creates {@link DumpEmptyException} with specified reason and sub-exception - */ - public DumpEmptyException(String reason, Exception e) { - super(reason, e); - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/execution/DumpExecutionFailedException.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/execution/DumpExecutionFailedException.java deleted file mode 100644 index 5f4939cfb..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/execution/DumpExecutionFailedException.java +++ /dev/null @@ -1,27 +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.util.cache.exceptions.execution; - -/** - * Default parent for all exceptions connected to dumping of VPP data - */ -public abstract class DumpExecutionFailedException extends Exception { - - public DumpExecutionFailedException(String message, Exception cause) { - super(message, cause); - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/execution/i/DumpCallFailedException.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/execution/i/DumpCallFailedException.java deleted file mode 100644 index 9b92409f5..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/execution/i/DumpCallFailedException.java +++ /dev/null @@ -1,34 +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.util.cache.exceptions.execution.i; - -import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.execution.DumpExecutionFailedException; -import org.openvpp.jvpp.VppBaseCallException; - -/** - * Wrapper exception for {@link org.openvpp.jvpp.VppBaseCallException} during dumping - */ -public class DumpCallFailedException extends DumpExecutionFailedException { - - public DumpCallFailedException(String message, VppBaseCallException cause) { - super(message, cause); - } - - public static final DumpCallFailedException wrapFailedCallException(String message, VppBaseCallException cause) { - return new DumpCallFailedException(message, cause); - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/execution/i/DumpTimeoutException.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/execution/i/DumpTimeoutException.java deleted file mode 100644 index afb278c9d..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/exceptions/execution/i/DumpTimeoutException.java +++ /dev/null @@ -1,35 +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.util.cache.exceptions.execution.i; - -import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.execution.DumpExecutionFailedException; -import java.util.concurrent.TimeoutException; - -/** - * Exception thrown when dump call ends in timeout - */ -public class DumpTimeoutException extends DumpExecutionFailedException { - - public DumpTimeoutException(String message, TimeoutException cause) { - super(message, cause); - - } - - public static final DumpTimeoutException wrapTimeoutException(String message, TimeoutException cause) { - return new DumpTimeoutException(message, cause); - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/noop/NoopDumpPostProcessingFunction.java b/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/noop/NoopDumpPostProcessingFunction.java deleted file mode 100644 index 5efe439ab..000000000 --- a/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/noop/NoopDumpPostProcessingFunction.java +++ /dev/null @@ -1,33 +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.util.cache.noop; - -import io.fd.honeycomb.v3po.translate.v3po.util.cache.EntityDumpPostProcessingFunction; -import org.openvpp.jvpp.dto.JVppReplyDump; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -public class NoopDumpPostProcessingFunction<T extends JVppReplyDump> implements EntityDumpPostProcessingFunction<T> { - - private static final Logger LOG = LoggerFactory.getLogger(NoopDumpPostProcessingFunction.class); - - @Override - public T apply(final T t) { - LOG.debug("Default post processing function called for {}", t); - return t; - } -} diff --git a/v3po/vpp-translate-utils/src/main/java/org/opendaylight/yang/gen/v1/urn/honeycomb/params/xml/ns/yang/vpp/util/rev160406/NamingContextImplModule.java b/v3po/vpp-translate-utils/src/main/java/org/opendaylight/yang/gen/v1/urn/honeycomb/params/xml/ns/yang/vpp/util/rev160406/NamingContextImplModule.java deleted file mode 100644 index 60a816d89..000000000 --- a/v3po/vpp-translate-utils/src/main/java/org/opendaylight/yang/gen/v1/urn/honeycomb/params/xml/ns/yang/vpp/util/rev160406/NamingContextImplModule.java +++ /dev/null @@ -1,26 +0,0 @@ -package org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.vpp.util.rev160406; - -import io.fd.honeycomb.v3po.translate.v3po.util.NamingContext; - -public class NamingContextImplModule extends org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.vpp.util.rev160406.AbstractNamingContextImplModule { - public NamingContextImplModule(org.opendaylight.controller.config.api.ModuleIdentifier identifier, org.opendaylight.controller.config.api.DependencyResolver dependencyResolver) { - super(identifier, dependencyResolver); - } - - public NamingContextImplModule(org.opendaylight.controller.config.api.ModuleIdentifier identifier, org.opendaylight.controller.config.api.DependencyResolver dependencyResolver, org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.vpp.util.rev160406.NamingContextImplModule oldModule, java.lang.AutoCloseable oldInstance) { - super(identifier, dependencyResolver, oldModule, oldInstance); - } - - @Override - public void customValidation() { - // add custom validation form module attributes here. - } - - @Override - public java.lang.AutoCloseable createInstance() { - return new NamingContext( - getArtificialNamePrefix(), - getIdentifier().getInstanceName()); - } - -} diff --git a/v3po/vpp-translate-utils/src/main/java/org/opendaylight/yang/gen/v1/urn/honeycomb/params/xml/ns/yang/vpp/util/rev160406/NamingContextImplModuleFactory.java b/v3po/vpp-translate-utils/src/main/java/org/opendaylight/yang/gen/v1/urn/honeycomb/params/xml/ns/yang/vpp/util/rev160406/NamingContextImplModuleFactory.java deleted file mode 100644 index c777dafa1..000000000 --- a/v3po/vpp-translate-utils/src/main/java/org/opendaylight/yang/gen/v1/urn/honeycomb/params/xml/ns/yang/vpp/util/rev160406/NamingContextImplModuleFactory.java +++ /dev/null @@ -1,13 +0,0 @@ -/* -* Generated file -* -* Generated from: yang module name: vpp-util yang module local name: naming-context-impl -* Generated by: org.opendaylight.controller.config.yangjmxgenerator.plugin.JMXGenerator -* Generated at: Mon May 02 10:57:32 CEST 2016 -* -* Do not modify this file unless it is present under src/main directory -*/ -package org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.vpp.util.rev160406; -public class NamingContextImplModuleFactory extends org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.vpp.util.rev160406.AbstractNamingContextImplModuleFactory { - -} diff --git a/v3po/vpp-translate-utils/src/main/yang/vpp-util.yang b/v3po/vpp-translate-utils/src/main/yang/vpp-util.yang deleted file mode 100644 index 23615d09e..000000000 --- a/v3po/vpp-translate-utils/src/main/yang/vpp-util.yang +++ /dev/null @@ -1,37 +0,0 @@ -module vpp-util { - yang-version 1; - namespace "urn:honeycomb:params:xml:ns:yang:vpp:util"; - prefix "vpp-u"; - - import config { prefix config; revision-date 2013-04-05; } - import data-api { prefix dapi; revision-date 2016-04-11; } - - description - "This module contains utilities for vpp readers/writers"; - - revision "2016-04-06" { - description - "Initial revision."; - } - - identity naming-context { - base "config:service-type"; - config:java-class io.fd.honeycomb.v3po.translate.v3po.util.NamingContext; - } - - identity naming-context-impl { - base config:module-type; - config:provided-service naming-context; - } - - augment "/config:modules/config:module/config:configuration" { - case naming-context-impl { - when "/config:modules/config:module/config:type = 'naming-context-impl'"; - - leaf artificial-name-prefix { - type string; - } - } - } - -}
\ No newline at end of file diff --git a/v3po/vpp-translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/v3po/util/SubinterfaceUtilsTest.java b/v3po/vpp-translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/v3po/util/SubinterfaceUtilsTest.java deleted file mode 100644 index a61dfea90..000000000 --- a/v3po/vpp-translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/v3po/util/SubinterfaceUtilsTest.java +++ /dev/null @@ -1,32 +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.util; - -import static org.junit.Assert.assertEquals; - -import org.junit.Test; - -public class SubinterfaceUtilsTest { - - @Test - public void testGetSubInterfaceName() throws Exception { - final String superIfName = "GigabitEthernet0/9/0"; - final int subIfaceId = 123; - final String expectedSubIfaceName = "GigabitEthernet0/9/0.123"; - assertEquals(expectedSubIfaceName, SubInterfaceUtils.getSubInterfaceName(superIfName, subIfaceId)); - } -}
\ No newline at end of file diff --git a/v3po/vpp-translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/v3po/util/TranslateUtilsTest.java b/v3po/vpp-translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/v3po/util/TranslateUtilsTest.java deleted file mode 100644 index 334887430..000000000 --- a/v3po/vpp-translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/v3po/util/TranslateUtilsTest.java +++ /dev/null @@ -1,137 +0,0 @@ -package io.fd.honeycomb.v3po.translate.v3po.util; - -import static io.fd.honeycomb.v3po.translate.v3po.util.TranslateUtils.reverseBytes; -import static org.junit.Assert.assertArrayEquals; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; -import static org.junit.Assert.fail; -import static org.mockito.Matchers.anyLong; -import static org.mockito.Matchers.eq; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.when; - -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import org.junit.Test; -import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone; -import org.opendaylight.yangtools.yang.binding.DataContainer; -import org.opendaylight.yangtools.yang.binding.DataObject; -import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; -import org.openvpp.jvpp.dto.JVppReply; - -public class TranslateUtilsTest { - - private static class AnDataObject implements DataObject { - @Override - public Class<? extends DataContainer> getImplementedInterface() { - return null; - } - } - - @Test - public void testGetReplyForWriteTimeout() throws Exception { - final Future<JVppReply<?>> future = mock(Future.class); - when(future.get(anyLong(), eq(TimeUnit.SECONDS))).thenThrow(TimeoutException.class); - final InstanceIdentifier<AnDataObject> replyType = InstanceIdentifier.create(AnDataObject.class); - try { - TranslateUtils.getReplyForWrite(future, replyType); - } catch (WriteTimeoutException e) { - assertTrue(e.getCause() instanceof TimeoutException); - assertEquals(replyType, e.getFailedId()); - return; - } - fail("WriteTimeoutException was expected"); - } - - @Test - public void testGetReplyForReadTimeout() throws Exception { - final Future<JVppReply<?>> future = mock(Future.class); - final InstanceIdentifier<AnDataObject> replyType = InstanceIdentifier.create(AnDataObject.class); - when(future.get(anyLong(), eq(TimeUnit.SECONDS))).thenThrow(TimeoutException.class); - try { - TranslateUtils.getReplyForRead(future, replyType); - } catch (ReadTimeoutException e) { - assertTrue(e.getCause() instanceof TimeoutException); - assertEquals(replyType, e.getFailedId()); - return; - } - fail("ReadTimeoutException was expected"); - } - - @Test - public void testIpv4NoZone() throws Exception { - final Ipv4AddressNoZone ipv4Addr = new Ipv4AddressNoZone("192.168.1.1"); - byte[] bytes = TranslateUtils.ipv4AddressNoZoneToArray(ipv4Addr); - assertEquals((byte)192, bytes[0]); - // Simulating the magic of VPP - bytes = reverseBytes(bytes); - final Ipv4AddressNoZone ipv4AddressNoZone = TranslateUtils.arrayToIpv4AddressNoZone(bytes); - assertEquals(ipv4Addr, ipv4AddressNoZone); - } - - @Test - public void testToString() { - final byte[] expected = "test".getBytes(); - final byte[] cString = new byte[expected.length + 10]; - System.arraycopy(expected, 0, cString, 0, expected.length); - final String jString = TranslateUtils.toString(cString); - assertArrayEquals(expected, jString.getBytes()); - } - - @Test - public void testParseMac() throws Exception { - byte[] bytes = TranslateUtils.parseMac("00:fF:7f:15:5e:A9"); - assertMac(bytes); - } - - private void assertMac(final byte[] bytes) { - assertEquals(6, bytes.length); - assertEquals((byte) 0, bytes[0]); - assertEquals((byte) 255, bytes[1]); - assertEquals((byte) 127, bytes[2]); - assertEquals((byte) 21, bytes[3]); - assertEquals((byte) 94, bytes[4]); - assertEquals((byte) 169, bytes[5]); - } - - @Test(expected = IllegalArgumentException.class) - public void testParseMacLonger() throws Exception { - byte[] bytes = TranslateUtils.parseMac("00:fF:7f:15:5e:A9:88:77"); - assertMac(bytes); - } - - @Test(expected = IllegalArgumentException.class) - public void testParseMacShorter() throws Exception { - TranslateUtils.parseMac("00:fF:7f"); - } - - @Test(expected = IllegalArgumentException.class) - public void testParseRandomString() throws Exception { - TranslateUtils.parseMac("random{}}@$*&*!"); - } - - @Test(expected = NumberFormatException.class) - public void testParseMacNumberFormatEx() throws Exception { - TranslateUtils.parseMac("00:XX:7f:15:5e:77\""); - } - - @Test - public void testBooleanToByte() { - assertEquals(0, TranslateUtils.booleanToByte(null)); - assertEquals(0, TranslateUtils.booleanToByte(false)); - assertEquals(1, TranslateUtils.booleanToByte(true)); - } - - @Test - public void testByteToBoolean() { - assertEquals(Boolean.FALSE, TranslateUtils.byteToBoolean((byte) 0)); - assertEquals(Boolean.TRUE, TranslateUtils.byteToBoolean((byte) 1)); - } - - @Test(expected = IllegalArgumentException.class) - public void testByteToBooleanFailed() { - TranslateUtils.byteToBoolean((byte) 123); - } - -}
\ No newline at end of file diff --git a/v3po/vpp-translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/DumpCacheManagerTest.java b/v3po/vpp-translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/DumpCacheManagerTest.java deleted file mode 100644 index 9cbbda8ad..000000000 --- a/v3po/vpp-translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/DumpCacheManagerTest.java +++ /dev/null @@ -1,144 +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.util.cache; - - -import static org.junit.Assert.assertEquals; -import static org.mockito.Mockito.when; - -import com.google.common.base.Optional; -import io.fd.honeycomb.v3po.translate.ModificationCache; -import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.check.i.DumpEmptyException; -import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.execution.DumpExecutionFailedException; -import org.junit.Before; -import org.junit.Test; -import org.mockito.Mock; -import org.mockito.MockitoAnnotations; -import org.openvpp.jvpp.dto.IpDetails; -import org.openvpp.jvpp.dto.IpDetailsReplyDump; - -public class DumpCacheManagerTest { - - private static final String KEY = "cacheKey"; - - @Mock - private EntityDumpExecutor<IpDetailsReplyDump, Void> executor; - - private DumpCacheManager<IpDetailsReplyDump, Void> managerPositive; - private DumpCacheManager<IpDetailsReplyDump, Void> managerPositiveWithPostProcessing; - private DumpCacheManager<IpDetailsReplyDump, Void> managerNegative; - private ModificationCache cache; - - @Before - public void init() { - MockitoAnnotations.initMocks(this); - managerPositive = - new DumpCacheManager.DumpCacheManagerBuilder<IpDetailsReplyDump, Void>() - .withExecutor(executor) - .withNonEmptyPredicate(createPositivePredicate()) - .build(); - - managerPositiveWithPostProcessing = new DumpCacheManager.DumpCacheManagerBuilder<IpDetailsReplyDump, Void>() - .withExecutor(executor) - .withNonEmptyPredicate(createPositivePredicate()) - .withPostProcessingFunction(createPostProcessor()) - .build(); - - managerNegative = - new DumpCacheManager.DumpCacheManagerBuilder<IpDetailsReplyDump, Void>() - .withExecutor(executor) - .withNonEmptyPredicate(createNegativePredicate()) - .build(); - - cache = new ModificationCache(); - } - - /** - * This test verify full dump-caching cycle - */ - @Test - public void testCaching() throws DumpExecutionFailedException { - - - Optional<IpDetailsReplyDump> stage1Optional = managerNegative.getDump(KEY, cache); - - //this is first call so instance should be from executor - assertEquals(false, stage1Optional.isPresent()); - assertEquals(false, cache.containsKey(KEY)); - - //rebind executor with other data - IpDetailsReplyDump stage2LoadedDump = new IpDetailsReplyDump(); - when(executor.executeDump()).thenReturn(stage2LoadedDump); - - Optional<IpDetailsReplyDump> stage2Optional = managerPositive.getDump(KEY, cache); - - assertEquals(true, stage2Optional.isPresent()); - assertEquals(stage2LoadedDump, stage2Optional.get()); - - //rebind executor with other data - IpDetailsReplyDump stage3LoadedDump = new IpDetailsReplyDump(); - when(executor.executeDump()).thenReturn(stage3LoadedDump); - - Optional<IpDetailsReplyDump> stage3Optional = managerPositive.getDump(KEY, cache); - assertEquals(true, stage3Optional.isPresent()); - //check if it returns instance cached from previous stage - assertEquals(stage2LoadedDump, stage3Optional.get()); - } - - @Test - public void testPostprocessing() throws DumpExecutionFailedException { - IpDetailsReplyDump dump = new IpDetailsReplyDump(); - IpDetails details = new IpDetails(); - details.swIfIndex = 2; - dump.ipDetails.add(details); - - when(executor.executeDump()).thenReturn(dump); - - Optional<IpDetailsReplyDump> optionalDump = managerPositiveWithPostProcessing.getDump(KEY, cache); - - assertEquals(true, optionalDump.isPresent()); - assertEquals(1, optionalDump.get().ipDetails.size()); - assertEquals(7, optionalDump.get().ipDetails.get(0).swIfIndex); - } - - private EntityDumpNonEmptyCheck<IpDetailsReplyDump> createNegativePredicate() { - return data -> { - throw new DumpEmptyException("Empty dump", new IllegalArgumentException()); - }; - } - - private EntityDumpNonEmptyCheck<IpDetailsReplyDump> createPositivePredicate() { - return data -> { - //DO NOTHING - }; - } - - private EntityDumpPostProcessingFunction<IpDetailsReplyDump> createPostProcessor() { - return ipDetailsReplyDump -> { - IpDetailsReplyDump modified = new IpDetailsReplyDump(); - - for (IpDetails detail : ipDetailsReplyDump.ipDetails) { - IpDetails modifiedDetail = new IpDetails(); - modifiedDetail.swIfIndex = detail.swIfIndex + 5; - - modified.ipDetails.add(modifiedDetail); - } - - return modified; - }; - } -}
\ No newline at end of file |