Mechanism to add Port annotation via netcfg
- intended to be used for driver to support ONOS-5895
Change-Id: Iddcf6f1b99273e8f8670b5f64fc9831e5f4ce3cd
diff --git a/core/net/src/main/java/org/onosproject/net/config/impl/BasicNetworkConfigs.java b/core/net/src/main/java/org/onosproject/net/config/impl/BasicNetworkConfigs.java
index 0bd8b91..5cabfbd 100644
--- a/core/net/src/main/java/org/onosproject/net/config/impl/BasicNetworkConfigs.java
+++ b/core/net/src/main/java/org/onosproject/net/config/impl/BasicNetworkConfigs.java
@@ -36,6 +36,7 @@
import org.onosproject.net.config.basics.BasicLinkConfig;
import org.onosproject.net.config.basics.BasicRegionConfig;
import org.onosproject.net.config.basics.BasicUiTopoLayoutConfig;
+import org.onosproject.net.config.basics.PortAnnotationConfig;
import org.onosproject.net.config.basics.SubjectFactories;
import org.onosproject.net.region.RegionId;
import org.onosproject.ui.model.topo.UiTopoLayoutId;
@@ -112,6 +113,14 @@
public BasicUiTopoLayoutConfig createConfig() {
return new BasicUiTopoLayoutConfig();
}
+ },
+ new ConfigFactory<ConnectPoint, PortAnnotationConfig>(CONNECT_POINT_SUBJECT_FACTORY,
+ PortAnnotationConfig.class,
+ PortAnnotationConfig.CONFIG_KEY) {
+ @Override
+ public PortAnnotationConfig createConfig() {
+ return new PortAnnotationConfig();
+ }
}
);
diff --git a/core/net/src/main/java/org/onosproject/net/device/impl/DeviceManager.java b/core/net/src/main/java/org/onosproject/net/device/impl/DeviceManager.java
index a3dbcad..6fbb21c 100644
--- a/core/net/src/main/java/org/onosproject/net/device/impl/DeviceManager.java
+++ b/core/net/src/main/java/org/onosproject/net/device/impl/DeviceManager.java
@@ -58,6 +58,7 @@
import org.onosproject.net.config.PortConfigOperator;
import org.onosproject.net.config.PortConfigOperatorRegistry;
import org.onosproject.net.config.basics.BasicDeviceConfig;
+import org.onosproject.net.config.basics.PortAnnotationConfig;
import org.onosproject.net.device.DefaultPortDescription;
import org.onosproject.net.device.DeviceAdminService;
import org.onosproject.net.device.DeviceDescription;
@@ -148,6 +149,9 @@
= synchronizedListMultimap(
newListMultimap(new ConcurrentHashMap<>(), CopyOnWriteArrayList::new));
+ // not part of portOps. must be executed at the end
+ private PortAnnotationOperator portAnnotationOp;
+
/**
* Local storage for connectivity status of devices.
*/
@@ -165,6 +169,9 @@
@Activate
public void activate() {
+ portAnnotationOp = new PortAnnotationOperator(networkConfigService);
+ portOpsIndex.put(PortAnnotationConfig.class, portAnnotationOp);
+
backgroundService = newSingleThreadScheduledExecutor(
groupedThreads("onos/device", "manager-background", log));
localNodeId = clusterService.getLocalNode().id();
@@ -976,7 +983,7 @@
for (PortConfigOperator portOp : portOps) {
work = portOp.combine(cpt, work);
}
- return work;
+ return portAnnotationOp.combine(cpt, work);
}
}
diff --git a/core/net/src/main/java/org/onosproject/net/device/impl/PortAnnotationOperator.java b/core/net/src/main/java/org/onosproject/net/device/impl/PortAnnotationOperator.java
new file mode 100644
index 0000000..3041a07
--- /dev/null
+++ b/core/net/src/main/java/org/onosproject/net/device/impl/PortAnnotationOperator.java
@@ -0,0 +1,77 @@
+/*
+ * Copyright 2017-present Open Networking Laboratory
+ *
+ * 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.net.device.impl;
+
+import java.util.Map;
+
+import org.onosproject.net.ConnectPoint;
+import org.onosproject.net.DefaultAnnotations;
+import org.onosproject.net.DefaultAnnotations.Builder;
+import org.onosproject.net.config.NetworkConfigService;
+import org.onosproject.net.config.PortConfigOperator;
+import org.onosproject.net.config.basics.PortAnnotationConfig;
+import org.onosproject.net.device.DefaultPortDescription;
+import org.onosproject.net.device.PortDescription;
+
+/**
+ * Implementations of {@link PortConfigOperator} to weave
+ * annotations added via {@link PortAnnotationConfig}.
+ */
+public class PortAnnotationOperator implements PortConfigOperator {
+
+ private NetworkConfigService networkConfigService;
+
+ /**
+ * Creates {@link PortAnnotationOperator} instance.
+ */
+ public PortAnnotationOperator() {
+ }
+
+ PortAnnotationOperator(NetworkConfigService networkConfigService) {
+ bindService(networkConfigService);
+ }
+
+ @Override
+ public void bindService(NetworkConfigService networkConfigService) {
+ this.networkConfigService = networkConfigService;
+ }
+
+ private PortAnnotationConfig lookupConfig(ConnectPoint cp) {
+ if (networkConfigService == null) {
+ return null;
+ }
+ return networkConfigService.getConfig(cp, PortAnnotationConfig.class);
+ }
+
+ @Override
+ public PortDescription combine(ConnectPoint cp, PortDescription descr) {
+ PortAnnotationConfig cfg = lookupConfig(cp);
+ if (cfg == null) {
+ return descr;
+ }
+ Map<String, String> annotations = cfg.annotations();
+ if (annotations.isEmpty()) {
+ return descr;
+ }
+
+ Builder builder = DefaultAnnotations.builder();
+ builder.putAll(descr.annotations());
+ builder.putAll(annotations);
+
+ return DefaultPortDescription.copyReplacingAnnotation(descr, builder.build());
+ }
+
+}
diff --git a/core/net/src/test/java/org/onosproject/net/config/basics/PortAnnotationConfigTest.java b/core/net/src/test/java/org/onosproject/net/config/basics/PortAnnotationConfigTest.java
new file mode 100644
index 0000000..48e3ce3
--- /dev/null
+++ b/core/net/src/test/java/org/onosproject/net/config/basics/PortAnnotationConfigTest.java
@@ -0,0 +1,169 @@
+/*
+ * Copyright 2017-present Open Networking Laboratory
+ *
+ * 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.net.config.basics;
+
+import static org.hamcrest.Matchers.is;
+import static org.junit.Assert.*;
+import static org.onosproject.net.ConnectPoint.deviceConnectPoint;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Map;
+
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.onlab.junit.TestUtils;
+import org.onlab.junit.TestUtils.TestUtilsException;
+import org.onlab.osgi.ServiceDirectory;
+import org.onlab.osgi.TestServiceDirectory;
+import org.onosproject.codec.CodecService;
+import org.onosproject.codec.impl.CodecManager;
+import org.onosproject.net.ConnectPoint;
+import org.onosproject.net.config.BaseConfig;
+import org.onosproject.net.config.ConfigApplyDelegate;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.JsonNodeFactory;
+import com.fasterxml.jackson.databind.node.NumericNode;
+import com.google.common.collect.ImmutableMap;
+
+public class PortAnnotationConfigTest {
+
+ private static final String SAMPLE_JSONFILE = "port_annotation_config.json";
+
+ private static TestServiceDirectory directory;
+ private static ServiceDirectory original;
+
+ private ObjectMapper mapper;
+
+ private final ConfigApplyDelegate noopDelegate = cfg -> { };
+
+ /**
+ * {@value #SAMPLE_JSONFILE} after parsing.
+ */
+ private JsonNode node;
+
+ // sample data
+ private final ConnectPoint cp = deviceConnectPoint("of:0000000000000001/2");
+
+ private final String key = "foo";
+ private final String value = "bar";
+
+
+ // TODO consolidate code-clone in ProtectionConfigTest, and define constants for field name
+ @BeforeClass
+ public static void setUpClass() throws TestUtilsException {
+ directory = new TestServiceDirectory();
+
+ CodecManager codecService = new CodecManager();
+ codecService.activate();
+ directory.add(CodecService.class, codecService);
+
+ // replace service directory used by BaseConfig
+ original = TestUtils.getField(BaseConfig.class, "services");
+ TestUtils.setField(BaseConfig.class, "services", directory);
+ }
+
+ @AfterClass
+ public static void tearDownClass() throws TestUtilsException {
+ TestUtils.setField(BaseConfig.class, "services", original);
+ }
+
+ @Before
+ public void setUp() throws JsonProcessingException, IOException, TestUtilsException {
+
+ mapper = new ObjectMapper();
+ // Jackson configuration for ease of Numeric node comparison
+ // - treat integral number node as long node
+ mapper.enable(DeserializationFeature.USE_LONG_FOR_INTS);
+ mapper.setNodeFactory(new JsonNodeFactory(false) {
+ @Override
+ public NumericNode numberNode(int v) {
+ return super.numberNode((long) v);
+ }
+ @Override
+ public NumericNode numberNode(short v) {
+ return super.numberNode((long) v);
+ }
+ });
+
+ InputStream stream = PortAnnotationConfig.class
+ .getResourceAsStream(SAMPLE_JSONFILE);
+ JsonNode tree = mapper.readTree(stream);
+
+ node = tree.path("ports")
+ .path(cp.toString())
+ .path(PortAnnotationConfig.CONFIG_KEY);
+ assertTrue(node.isObject());
+ }
+
+ @Test
+ public void readTest() {
+ PortAnnotationConfig sut = new PortAnnotationConfig();
+ sut.init(cp, PortAnnotationConfig.CONFIG_KEY, node, mapper, noopDelegate);
+
+ assertThat(sut.subject(), is(cp));
+ Map<String, String> annotations = sut.annotations();
+ assertThat(annotations.size(), is(1));
+ assertThat(annotations.get(key), is(value));
+ }
+
+ public void writeEntryTest() throws JsonProcessingException, IOException {
+
+ PortAnnotationConfig w = new PortAnnotationConfig();
+ w.init(cp, PortAnnotationConfig.CONFIG_KEY, mapper.createObjectNode(), mapper, noopDelegate);
+
+ // write equivalent to sample
+ w.annotation(key, value);
+
+ // reparse JSON
+ JsonNode r = mapper.readTree(mapper.writeValueAsString(w.node()));
+
+ PortAnnotationConfig sut = new PortAnnotationConfig();
+ sut.init(cp, PortAnnotationConfig.CONFIG_KEY, r, mapper, noopDelegate);
+
+ assertThat(sut.subject(), is(cp));
+ Map<String, String> annotations = sut.annotations();
+ assertThat(annotations.size(), is(1));
+ assertThat(annotations.get(key), is(value));
+ }
+
+ public void writeMapTest() throws JsonProcessingException, IOException {
+
+ PortAnnotationConfig w = new PortAnnotationConfig();
+ w.init(cp, PortAnnotationConfig.CONFIG_KEY, mapper.createObjectNode(), mapper, noopDelegate);
+
+ // write equivalent to sample
+ w.annotations(ImmutableMap.of(key, value));
+
+ // reparse JSON
+ JsonNode r = mapper.readTree(mapper.writeValueAsString(w.node()));
+
+ PortAnnotationConfig sut = new PortAnnotationConfig();
+ sut.init(cp, PortAnnotationConfig.CONFIG_KEY, r, mapper, noopDelegate);
+
+ assertThat(sut.subject(), is(cp));
+ Map<String, String> annotations = sut.annotations();
+ assertThat(annotations.size(), is(1));
+ assertThat(annotations.get(key), is(value));
+ }
+
+}
diff --git a/core/net/src/test/resources/org/onosproject/net/config/basics/port_annotation_config.json b/core/net/src/test/resources/org/onosproject/net/config/basics/port_annotation_config.json
new file mode 100644
index 0000000..8a88ed8
--- /dev/null
+++ b/core/net/src/test/resources/org/onosproject/net/config/basics/port_annotation_config.json
@@ -0,0 +1,11 @@
+{
+ "ports" : {
+ "of:0000000000000001/2" : {
+ "annotations" : {
+ "entries" : {
+ "foo" : "bar"
+ }
+ }
+ }
+ }
+}