[ONOS-7905] Add manager and store for k8s network and ports with unit tests
Change-Id: Idd7a8762edbc4bc6d14fd7b22d2218897e7ea0c0
diff --git a/apps/k8s-networking/app/src/main/java/org/onosproject/k8snetworking/codec/K8sNetworkCodec.java b/apps/k8s-networking/app/src/main/java/org/onosproject/k8snetworking/codec/K8sNetworkCodec.java
index e6e646b..b9984bf 100644
--- a/apps/k8s-networking/app/src/main/java/org/onosproject/k8snetworking/codec/K8sNetworkCodec.java
+++ b/apps/k8s-networking/app/src/main/java/org/onosproject/k8snetworking/codec/K8sNetworkCodec.java
@@ -35,6 +35,7 @@
private final Logger log = getLogger(getClass());
private static final String NETWORK_ID = "networkId";
+ private static final String NAME = "name";
private static final String TYPE = "type";
private static final String MTU = "mtu";
private static final String SEGMENT_ID = "segmentId";
@@ -49,6 +50,7 @@
ObjectNode result = context.mapper().createObjectNode()
.put(NETWORK_ID, network.networkId())
+ .put(NAME, network.name())
.put(TYPE, network.type().name())
.put(SEGMENT_ID, network.segmentId())
.put(GATEWAY_IP, network.gatewayIp().toString())
@@ -69,6 +71,8 @@
String networkId = nullIsIllegal(json.get(NETWORK_ID).asText(),
NETWORK_ID + MISSING_MESSAGE);
+ String name = nullIsIllegal(json.get(NAME).asText(),
+ NAME + MISSING_MESSAGE);
String type = nullIsIllegal(json.get(TYPE).asText(),
TYPE + MISSING_MESSAGE);
String segmentId = nullIsIllegal(json.get(SEGMENT_ID).asText(),
@@ -80,6 +84,7 @@
DefaultK8sNetwork.Builder networkBuilder = DefaultK8sNetwork.builder()
.networkId(networkId)
+ .name(name)
.type(K8sNetwork.Type.valueOf(type))
.segmentId(segmentId)
.gatewayIp(IpAddress.valueOf(gatewayIp))
diff --git a/apps/k8s-networking/app/src/main/java/org/onosproject/k8snetworking/impl/DistributedK8sNetworkStore.java b/apps/k8s-networking/app/src/main/java/org/onosproject/k8snetworking/impl/DistributedK8sNetworkStore.java
new file mode 100644
index 0000000..8e54bef
--- /dev/null
+++ b/apps/k8s-networking/app/src/main/java/org/onosproject/k8snetworking/impl/DistributedK8sNetworkStore.java
@@ -0,0 +1,276 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * 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.onosproject.k8snetworking.impl;
+
+import com.google.common.collect.ImmutableSet;
+import org.onlab.util.KryoNamespace;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.CoreService;
+import org.onosproject.k8snetworking.api.DefaultK8sNetwork;
+import org.onosproject.k8snetworking.api.DefaultK8sPort;
+import org.onosproject.k8snetworking.api.K8sNetwork;
+import org.onosproject.k8snetworking.api.K8sNetworkEvent;
+import org.onosproject.k8snetworking.api.K8sNetworkStore;
+import org.onosproject.k8snetworking.api.K8sNetworkStoreDelegate;
+import org.onosproject.k8snetworking.api.K8sPort;
+import org.onosproject.store.AbstractStore;
+import org.onosproject.store.serializers.KryoNamespaces;
+import org.onosproject.store.service.ConsistentMap;
+import org.onosproject.store.service.MapEvent;
+import org.onosproject.store.service.MapEventListener;
+import org.onosproject.store.service.Serializer;
+import org.onosproject.store.service.StorageService;
+import org.onosproject.store.service.Versioned;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.annotations.ReferenceCardinality;
+import org.slf4j.Logger;
+
+import java.util.Collection;
+import java.util.Set;
+import java.util.concurrent.ExecutorService;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.concurrent.Executors.newSingleThreadExecutor;
+import static org.onlab.util.Tools.groupedThreads;
+import static org.onosproject.k8snetworking.api.K8sNetworkEvent.Type.K8S_NETWORK_CREATED;
+import static org.onosproject.k8snetworking.api.K8sNetworkEvent.Type.K8S_NETWORK_REMOVED;
+import static org.onosproject.k8snetworking.api.K8sNetworkEvent.Type.K8S_NETWORK_UPDATED;
+import static org.onosproject.k8snetworking.api.K8sNetworkEvent.Type.K8S_PORT_CREATED;
+import static org.onosproject.k8snetworking.api.K8sNetworkEvent.Type.K8S_PORT_REMOVED;
+import static org.onosproject.k8snetworking.api.K8sNetworkEvent.Type.K8S_PORT_UPDATED;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Implementation of kubernetes network store using consistent map.
+ */
+@Component(immediate = true, service = K8sNetworkStore.class)
+public class DistributedK8sNetworkStore
+ extends AbstractStore<K8sNetworkEvent, K8sNetworkStoreDelegate>
+ implements K8sNetworkStore {
+
+ private final Logger log = getLogger(getClass());
+
+ private static final String ERR_NOT_FOUND = " does not exist";
+ private static final String ERR_DUPLICATE = " already exists";
+ private static final String APP_ID = "org.onosproject.k8snetwork";
+
+ private static final KryoNamespace
+ SERIALIZER_K8S_NETWORK_PORT = KryoNamespace.newBuilder()
+ .register(KryoNamespaces.API)
+ .register(K8sNetwork.class)
+ .register(K8sNetwork.Type.class)
+ .register(DefaultK8sNetwork.class)
+ .register(K8sPort.class)
+ .register(K8sPort.State.class)
+ .register(DefaultK8sPort.class)
+ .register(Collection.class)
+ .build();
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected CoreService coreService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected StorageService storageService;
+
+ private final ExecutorService eventExecutor = newSingleThreadExecutor(
+ groupedThreads(this.getClass().getSimpleName(), "event-handler", log));
+
+ private final MapEventListener<String, K8sNetwork> networkMapListener =
+ new K8sNetworkMapListener();
+ private final MapEventListener<String, K8sPort> portMapListener =
+ new K8sPortMapListener();
+
+ private ConsistentMap<String, K8sNetwork> networkStore;
+ private ConsistentMap<String, K8sPort> portStore;
+
+ @Activate
+ protected void activate() {
+ ApplicationId appId = coreService.registerApplication(APP_ID);
+ networkStore = storageService.<String, K8sNetwork>consistentMapBuilder()
+ .withSerializer(Serializer.using(SERIALIZER_K8S_NETWORK_PORT))
+ .withName("k8s-networkstore")
+ .withApplicationId(appId)
+ .build();
+ portStore = storageService.<String, K8sPort>consistentMapBuilder()
+ .withSerializer(Serializer.using(SERIALIZER_K8S_NETWORK_PORT))
+ .withName("k8s-portstore")
+ .withApplicationId(appId)
+ .build();
+ networkStore.addListener(networkMapListener);
+ portStore.addListener(portMapListener);
+ log.info("Started");
+ }
+
+ @Deactivate
+ protected void deactivate() {
+ networkStore.removeListener(networkMapListener);
+ portStore.removeListener(portMapListener);
+ eventExecutor.shutdown();
+ log.info("Stopped");
+ }
+
+ @Override
+ public void createNetwork(K8sNetwork network) {
+ networkStore.compute(network.networkId(), (networkId, existing) -> {
+ final String error = network.networkId() + ERR_DUPLICATE;
+ checkArgument(existing == null, error);
+ return network;
+ });
+ }
+
+ @Override
+ public void updateNetwork(K8sNetwork network) {
+ networkStore.compute(network.networkId(), (networkId, existing) -> {
+ final String error = network.networkId() + ERR_NOT_FOUND;
+ checkArgument(existing != null, error);
+ return network;
+ });
+ }
+
+ @Override
+ public K8sNetwork removeNetwork(String networkId) {
+ Versioned<K8sNetwork> network = networkStore.remove(networkId);
+ if (network == null) {
+ final String error = networkId + ERR_NOT_FOUND;
+ throw new IllegalArgumentException(error);
+ }
+ return network.value();
+ }
+
+ @Override
+ public K8sNetwork network(String networkId) {
+ return networkStore.asJavaMap().get(networkId);
+ }
+
+ @Override
+ public Set<K8sNetwork> networks() {
+ return ImmutableSet.copyOf(networkStore.asJavaMap().values());
+ }
+
+ @Override
+ public void createPort(K8sPort port) {
+ portStore.compute(port.portId(), (portId, existing) -> {
+ final String error = port.portId() + ERR_DUPLICATE;
+ checkArgument(existing == null, error);
+ return port;
+ });
+ }
+
+ @Override
+ public void updatePort(K8sPort port) {
+ portStore.compute(port.portId(), (portId, existing) -> {
+ final String error = port.portId() + ERR_NOT_FOUND;
+ checkArgument(existing != null, error);
+ return port;
+ });
+ }
+
+ @Override
+ public K8sPort removePort(String portId) {
+ Versioned<K8sPort> port = portStore.remove(portId);
+ if (port == null) {
+ final String error = portId + ERR_NOT_FOUND;
+ throw new IllegalArgumentException(error);
+ }
+ return port.value();
+ }
+
+ @Override
+ public Set<K8sPort> ports() {
+ return ImmutableSet.copyOf(portStore.asJavaMap().values());
+ }
+
+ @Override
+ public K8sPort port(String portId) {
+ return portStore.asJavaMap().get(portId);
+ }
+
+ @Override
+ public void clear() {
+ portStore.clear();
+ networkStore.clear();
+ }
+
+ private class K8sNetworkMapListener implements MapEventListener<String, K8sNetwork> {
+
+ @Override
+ public void event(MapEvent<String, K8sNetwork> event) {
+
+ switch (event.type()) {
+ case INSERT:
+ log.debug("Kubernetes network created {}", event.newValue());
+ eventExecutor.execute(() ->
+ notifyDelegate(new K8sNetworkEvent(
+ K8S_NETWORK_CREATED, event.newValue().value())));
+ break;
+ case UPDATE:
+ log.debug("Kubernetes network updated {}", event.newValue());
+ eventExecutor.execute(() ->
+ notifyDelegate(new K8sNetworkEvent(
+ K8S_NETWORK_UPDATED, event.newValue().value())));
+ break;
+ case REMOVE:
+ log.debug("Kubernetes network removed {}", event.oldValue());
+ eventExecutor.execute(() ->
+ notifyDelegate(new K8sNetworkEvent(
+ K8S_NETWORK_REMOVED, event.oldValue().value())));
+ break;
+ default:
+ // do nothing
+ break;
+ }
+ }
+ }
+
+ private class K8sPortMapListener implements MapEventListener<String, K8sPort> {
+
+ @Override
+ public void event(MapEvent<String, K8sPort> event) {
+
+ switch (event.type()) {
+ case INSERT:
+ log.debug("Kubernetes port created");
+ eventExecutor.execute(() ->
+ notifyDelegate(new K8sNetworkEvent(
+ K8S_PORT_CREATED,
+ network(event.newValue().value().networkId()),
+ event.newValue().value())));
+ break;
+ case UPDATE:
+ log.debug("Kubernetes port updated");
+ eventExecutor.execute(() ->
+ notifyDelegate(new K8sNetworkEvent(
+ K8S_PORT_UPDATED,
+ network(event.newValue().value().networkId()),
+ event.newValue().value())));
+ break;
+ case REMOVE:
+ log.debug("Kubernetes port removed");
+ notifyDelegate(new K8sNetworkEvent(
+ K8S_PORT_REMOVED,
+ network(event.oldValue().value().networkId()),
+ event.oldValue().value()));
+ break;
+ default:
+ // do nothing
+ break;
+ }
+ }
+ }
+}
diff --git a/apps/k8s-networking/app/src/main/java/org/onosproject/k8snetworking/impl/K8sNetworkManager.java b/apps/k8s-networking/app/src/main/java/org/onosproject/k8snetworking/impl/K8sNetworkManager.java
new file mode 100644
index 0000000..2a6890e
--- /dev/null
+++ b/apps/k8s-networking/app/src/main/java/org/onosproject/k8snetworking/impl/K8sNetworkManager.java
@@ -0,0 +1,238 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * 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.onosproject.k8snetworking.impl;
+
+import com.google.common.base.Strings;
+import com.google.common.collect.ImmutableSet;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.CoreService;
+import org.onosproject.event.ListenerRegistry;
+import org.onosproject.k8snetworking.api.K8sNetwork;
+import org.onosproject.k8snetworking.api.K8sNetwork.Type;
+import org.onosproject.k8snetworking.api.K8sNetworkAdminService;
+import org.onosproject.k8snetworking.api.K8sNetworkEvent;
+import org.onosproject.k8snetworking.api.K8sNetworkListener;
+import org.onosproject.k8snetworking.api.K8sNetworkService;
+import org.onosproject.k8snetworking.api.K8sNetworkStore;
+import org.onosproject.k8snetworking.api.K8sNetworkStoreDelegate;
+import org.onosproject.k8snetworking.api.K8sPort;
+import org.onosproject.k8snetworking.api.K8sPort.State;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.annotations.ReferenceCardinality;
+import org.slf4j.Logger;
+
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.onosproject.k8snetworking.api.Constants.K8S_NETWORKING_APP_ID;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Provides implementation of administering and interfacing kubernetes network,
+ * and port.
+ */
+@Component(
+ immediate = true,
+ service = {K8sNetworkAdminService.class, K8sNetworkService.class }
+)
+public class K8sNetworkManager
+ extends ListenerRegistry<K8sNetworkEvent, K8sNetworkListener>
+ implements K8sNetworkAdminService, K8sNetworkService {
+
+ protected final Logger log = getLogger(getClass());
+
+ private static final String MSG_NETWORK = "Kubernetes network %s %s";
+ private static final String MSG_PORT = "Kubernetes port %s %s";
+ private static final String MSG_CREATED = "created";
+ private static final String MSG_UPDATED = "updated";
+ private static final String MSG_REMOVED = "removed";
+
+ private static final String ERR_NULL_NETWORK = "Kubernetes network cannot be null";
+ private static final String ERR_NULL_NETWORK_ID = "Kubernetes network ID cannot be null";
+ private static final String ERR_NULL_PORT = "Kubernetes port cannot be null";
+ private static final String ERR_NULL_PORT_ID = "Kubernetes port ID cannot be null";
+ private static final String ERR_NULL_PORT_NET_ID = "Kubernetes port network ID cannot be null";
+
+ private static final String ERR_IN_USE = " still in use";
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected CoreService coreService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected K8sNetworkStore k8sNetworkStore;
+
+ private final K8sNetworkStoreDelegate
+ delegate = new InternalNetworkStorageDelegate();
+
+ private ApplicationId appId;
+
+ @Activate
+ protected void activate() {
+ appId = coreService.registerApplication(K8S_NETWORKING_APP_ID);
+
+ k8sNetworkStore.setDelegate(delegate);
+ log.info("Started");
+ }
+
+ @Deactivate
+ protected void deactivate() {
+ k8sNetworkStore.unsetDelegate(delegate);
+ log.info("Stopped");
+ }
+
+ @Override
+ public void createNetwork(K8sNetwork network) {
+ checkNotNull(network, ERR_NULL_NETWORK);
+ checkArgument(!Strings.isNullOrEmpty(network.networkId()), ERR_NULL_NETWORK_ID);
+
+ k8sNetworkStore.createNetwork(network);
+
+ log.info(String.format(MSG_NETWORK, network.name(), MSG_CREATED));
+ }
+
+ @Override
+ public void updateNetwork(K8sNetwork network) {
+ checkNotNull(network, ERR_NULL_NETWORK);
+ checkArgument(!Strings.isNullOrEmpty(network.networkId()), ERR_NULL_NETWORK_ID);
+
+ k8sNetworkStore.updateNetwork(network);
+
+ log.info(String.format(MSG_NETWORK, network.networkId(), MSG_UPDATED));
+ }
+
+ @Override
+ public void removeNetwork(String networkId) {
+ checkArgument(!Strings.isNullOrEmpty(networkId), ERR_NULL_NETWORK_ID);
+
+ synchronized (this) {
+ if (isNetworkInUse(networkId)) {
+ final String error = String.format(MSG_NETWORK, networkId, ERR_IN_USE);
+ throw new IllegalStateException(error);
+ }
+ K8sNetwork network = k8sNetworkStore.removeNetwork(networkId);
+
+ if (network != null) {
+ log.info(String.format(MSG_NETWORK, network.name(), MSG_REMOVED));
+ }
+ }
+ }
+
+ @Override
+ public K8sNetwork network(String networkId) {
+ checkArgument(!Strings.isNullOrEmpty(networkId), ERR_NULL_NETWORK_ID);
+ return k8sNetworkStore.network(networkId);
+ }
+
+ @Override
+ public Set<K8sNetwork> networks() {
+ return ImmutableSet.copyOf(k8sNetworkStore.networks());
+ }
+
+ @Override
+ public Set<K8sNetwork> networks(Type type) {
+ return ImmutableSet.copyOf(k8sNetworkStore.networks().stream()
+ .filter(n -> n.type() == type).collect(Collectors.toSet()));
+ }
+
+ @Override
+ public void createPort(K8sPort port) {
+ checkNotNull(port, ERR_NULL_PORT);
+ checkArgument(!Strings.isNullOrEmpty(port.portId()), ERR_NULL_PORT_ID);
+ checkArgument(!Strings.isNullOrEmpty(port.networkId()), ERR_NULL_PORT_NET_ID);
+
+ k8sNetworkStore.createPort(port);
+ log.info(String.format(MSG_PORT, port.portId(), MSG_CREATED));
+ }
+
+ @Override
+ public void updatePort(K8sPort port) {
+ checkNotNull(port, ERR_NULL_PORT);
+ checkArgument(!Strings.isNullOrEmpty(port.portId()), ERR_NULL_PORT_ID);
+ checkArgument(!Strings.isNullOrEmpty(port.networkId()), ERR_NULL_PORT_NET_ID);
+
+ k8sNetworkStore.updatePort(port);
+ log.info(String.format(MSG_PORT, port.portId(), MSG_UPDATED));
+ }
+
+ @Override
+ public void removePort(String portId) {
+ checkArgument(!Strings.isNullOrEmpty(portId), ERR_NULL_PORT_ID);
+ synchronized (this) {
+ if (isPortInUse(portId)) {
+ final String error = String.format(MSG_PORT, portId, ERR_IN_USE);
+ throw new IllegalStateException(error);
+ }
+ K8sPort port = k8sNetworkStore.removePort(portId);
+ if (port != null) {
+ log.info(String.format(MSG_PORT, port.portId(), MSG_REMOVED));
+ }
+ }
+ }
+
+ @Override
+ public K8sPort port(String portId) {
+ checkArgument(!Strings.isNullOrEmpty(portId), ERR_NULL_PORT_ID);
+ return k8sNetworkStore.port(portId);
+ }
+
+ @Override
+ public Set<K8sPort> ports() {
+ return ImmutableSet.copyOf(k8sNetworkStore.ports());
+ }
+
+ @Override
+ public Set<K8sPort> ports(State state) {
+ return ImmutableSet.copyOf(k8sNetworkStore.ports().stream()
+ .filter(p -> p.state() == state).collect(Collectors.toSet()));
+ }
+
+ @Override
+ public Set<K8sPort> ports(String networkId) {
+ checkArgument(!Strings.isNullOrEmpty(networkId), ERR_NULL_PORT_NET_ID);
+ return ImmutableSet.copyOf(k8sNetworkStore.ports().stream()
+ .filter(p -> p.networkId().equals(networkId))
+ .collect(Collectors.toSet()));
+ }
+
+ @Override
+ public void clear() {
+ k8sNetworkStore.clear();
+ }
+
+ private boolean isNetworkInUse(String networkId) {
+ return !ports(networkId).isEmpty();
+ }
+
+ private boolean isPortInUse(String portId) {
+ return false;
+ }
+
+ private class InternalNetworkStorageDelegate implements K8sNetworkStoreDelegate {
+
+ @Override
+ public void notify(K8sNetworkEvent event) {
+ if (event != null) {
+ log.trace("send kubernetes networking event {}", event);
+ process(event);
+ }
+ }
+ }
+}