[ONOS-6170] Implement codec for various MappingAddress primitives
Change-Id: I0f31408593d73c251d9ef84b4df5f6136d0f4b2f
diff --git a/apps/mappingmanagement/web/src/test/java/org/onosproject/mapping/web/codec/MappingAddressCodecTest.java b/apps/mappingmanagement/web/src/test/java/org/onosproject/mapping/web/codec/MappingAddressCodecTest.java
new file mode 100644
index 0000000..0d004b0
--- /dev/null
+++ b/apps/mappingmanagement/web/src/test/java/org/onosproject/mapping/web/codec/MappingAddressCodecTest.java
@@ -0,0 +1,152 @@
+/*
+ * 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.mapping.web.codec;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.onlab.packet.IpPrefix;
+import org.onlab.packet.MacAddress;
+import org.onosproject.codec.CodecContext;
+import org.onosproject.codec.CodecService;
+import org.onosproject.codec.JsonCodec;
+import org.onosproject.codec.impl.CodecManager;
+import org.onosproject.mapping.addresses.MappingAddress;
+import org.onosproject.mapping.addresses.MappingAddresses;
+import org.onosproject.mapping.web.MappingCodecRegistrator;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.notNullValue;
+import static org.onosproject.mapping.web.codec.MappingAddressJsonMatcher.matchesMappingAddress;
+
+/**
+ * Unit tests for MappingAddressCodec.
+ */
+public class MappingAddressCodecTest {
+
+ private CodecContext context;
+ private JsonCodec<MappingAddress> addressCodec;
+ MappingCodecRegistrator registrator;
+ private static final IpPrefix IPV4_PREFIX = IpPrefix.valueOf("10.1.1.0/24");
+ private static final IpPrefix IPV6_PREFIX = IpPrefix.valueOf("fe80::/64");
+ private static final MacAddress MAC = MacAddress.valueOf("00:00:11:00:00:01");
+ private static final String DN = "onos";
+ private static final String AS = "AS1000";
+
+ /**
+ * Sets up for each test.
+ * Creates a context and fetches the mapping address codec.
+ */
+ @Before
+ public void setUp() {
+ CodecManager manager = new CodecManager();
+ registrator = new MappingCodecRegistrator();
+ registrator.codecService = manager;
+ registrator.activate();
+
+ context = new MappingTestContext(registrator.codecService);
+
+ addressCodec = context.codec(MappingAddress.class);
+ assertThat(addressCodec, notNullValue());
+ }
+
+ @After
+ public void tearDown() {
+ registrator.deactivate();
+ }
+
+ /**
+ * Tests AS mapping address.
+ */
+ @Test
+ public void asMappingAddressTest() {
+ MappingAddress address = MappingAddresses.asMappingAddress(AS);
+ ObjectNode result = addressCodec.encode(address, context);
+ assertThat(result, matchesMappingAddress(address));
+ }
+
+ /**
+ * Tests DN mapping address.
+ */
+ @Test
+ public void dnMappingAddressTest() {
+ MappingAddress address = MappingAddresses.dnMappingAddress(DN);
+ ObjectNode result = addressCodec.encode(address, context);
+ assertThat(result, matchesMappingAddress(address));
+ }
+
+ /**
+ * Tests IPv4 mapping address.
+ */
+ @Test
+ public void ipv4MappingAddressTest() {
+ MappingAddress address = MappingAddresses.ipv4MappingAddress(IPV4_PREFIX);
+ ObjectNode result = addressCodec.encode(address, context);
+ assertThat(result, matchesMappingAddress(address));
+ }
+
+ /**
+ * Tests IPv6 mapping address.
+ */
+ @Test
+ public void ipv6MappingAddressTest() {
+ MappingAddress address = MappingAddresses.ipv6MappingAddress(IPV6_PREFIX);
+ ObjectNode result = addressCodec.encode(address, context);
+ assertThat(result, matchesMappingAddress(address));
+ }
+
+ /**
+ * Tests Ethernet mapping address.
+ */
+ @Test
+ public void ethMappingAddressTest() {
+ MappingAddress address = MappingAddresses.ethMappingAddress(MAC);
+ ObjectNode result = addressCodec.encode(address, context);
+ assertThat(result, matchesMappingAddress(address));
+ }
+
+ /**
+ * Test mapping codec context.
+ */
+ private class MappingTestContext implements CodecContext {
+ private final ObjectMapper mapper = new ObjectMapper();
+ private final CodecService manager;
+
+ /**
+ * Constructs a new mock codec context.
+ */
+ public MappingTestContext(CodecService manager) {
+ this.manager = manager;
+ }
+
+ @Override
+ public ObjectMapper mapper() {
+ return mapper;
+ }
+
+ @Override
+ public <T> JsonCodec<T> codec(Class<T> entityClass) {
+ return manager.getCodec(entityClass);
+ }
+
+ @Override
+ public <T> T getService(Class<T> serviceClass) {
+ return null;
+ }
+ }
+}
diff --git a/apps/mappingmanagement/web/src/test/java/org/onosproject/mapping/web/codec/MappingAddressJsonMatcher.java b/apps/mappingmanagement/web/src/test/java/org/onosproject/mapping/web/codec/MappingAddressJsonMatcher.java
new file mode 100644
index 0000000..ba496e9
--- /dev/null
+++ b/apps/mappingmanagement/web/src/test/java/org/onosproject/mapping/web/codec/MappingAddressJsonMatcher.java
@@ -0,0 +1,164 @@
+/*
+ * 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.mapping.web.codec;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import org.hamcrest.Description;
+import org.hamcrest.TypeSafeDiagnosingMatcher;
+import org.onosproject.mapping.addresses.ASMappingAddress;
+import org.onosproject.mapping.addresses.DNMappingAddress;
+import org.onosproject.mapping.addresses.EthMappingAddress;
+import org.onosproject.mapping.addresses.IPMappingAddress;
+import org.onosproject.mapping.addresses.MappingAddress;
+
+/**
+ * Hamcrest matcher for mapping objects.
+ */
+public final class MappingAddressJsonMatcher extends
+ TypeSafeDiagnosingMatcher<JsonNode> {
+
+ private final MappingAddress address;
+ private Description description;
+ private JsonNode node;
+
+ /**
+ * Constructs a matcher object.
+ *
+ * @param address mapping address to match
+ */
+ private MappingAddressJsonMatcher(MappingAddress address) {
+ this.address = address;
+ }
+
+ /**
+ * Factory to allocate a mapping address matcher.
+ *
+ * @param address mapping address object we are looking for
+ * @return matcher
+ */
+ public static MappingAddressJsonMatcher matchesMappingAddress(MappingAddress address) {
+ return new MappingAddressJsonMatcher(address);
+ }
+
+ /**
+ * Matches an AS mapping address object,
+ *
+ * @param address mapping address to match
+ * @return true if the JSON matches the mapping address, false otherwise
+ */
+ private boolean matchMappingAddress(ASMappingAddress address) {
+ final String as = address.asNumber();
+ final String jsonAs = node.get(MappingAddressCodec.AS).textValue();
+ if (!as.equals(jsonAs)) {
+ description.appendText("AS was " + jsonAs);
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * Matches a Distinguished Name mapping address object.
+ *
+ * @param address mapping address to match
+ * @return true if the JSON matches the mapping address, false otherwise
+ */
+ private boolean matchMappingAddress(DNMappingAddress address) {
+ final String dn = address.name();
+ final String jsonDn = node.get(MappingAddressCodec.DN).textValue();
+ if (!dn.equals(jsonDn)) {
+ description.appendText("Distinguished Name was " + jsonDn);
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * Matches an IP mapping address object.
+ *
+ * @param address mapping address to match
+ * @return true if the JSON matches the mapping address, false otherwise
+ */
+ private boolean matchMappingAddress(IPMappingAddress address) {
+ final String ip = address.ip().toString();
+ String jsonIp = null;
+ if (address.type() == MappingAddress.Type.IPV4) {
+ jsonIp = node.get(MappingAddressCodec.IPV4).textValue();
+
+ } else if (address.type() == MappingAddress.Type.IPV6) {
+ jsonIp = node.get(MappingAddressCodec.IPV6).textValue();
+ }
+ if (!ip.equals(jsonIp)) {
+ description.appendText("IP was " + jsonIp);
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * Matches a MAC mapping address object.
+ *
+ * @param address mapping address to match
+ * @return true if the JSON matches the mapping address, false otherwise
+ */
+ private boolean matchMappingAddress(EthMappingAddress address) {
+ final String mac = address.mac().toString();
+ final String jsonMac = node.get(MappingAddressCodec.MAC).textValue();
+ if (!mac.equals(jsonMac)) {
+ description.appendText("MAC was " + jsonMac);
+ return false;
+ }
+ return true;
+ }
+
+ @Override
+ protected boolean matchesSafely(JsonNode jsonNode, Description description) {
+
+ this.description = description;
+ this.node = jsonNode;
+ final String type = address.type().name();
+ final String jsonType = jsonNode.get(MappingAddressCodec.TYPE).asText();
+ if (!type.equals(jsonType)) {
+ description.appendText("type was " + type);
+ return false;
+ }
+
+ switch (address.type()) {
+
+ case IPV4:
+ case IPV6:
+ return matchMappingAddress((IPMappingAddress) address);
+
+ case AS:
+ return matchMappingAddress((ASMappingAddress) address);
+
+ case DN:
+ return matchMappingAddress((DNMappingAddress) address);
+
+ case ETH:
+ return matchMappingAddress((EthMappingAddress) address);
+
+ default:
+ // Don't know how to format this type
+ description.appendText("unknown criterion type " + address.type());
+ return false;
+ }
+ }
+
+ @Override
+ public void describeTo(Description description) {
+ description.appendText(address.toString());
+ }
+}