[ONOS-6169] Implement codec for LispAsAddress with unit test
Change-Id: I4abda8bb48298a1af9a1bc314d5d090a2eca82d3
diff --git a/drivers/lisp/src/main/java/org/onosproject/drivers/lisp/extensions/LispMappingExtensionCodecRegistrator.java b/drivers/lisp/src/main/java/org/onosproject/drivers/lisp/extensions/LispMappingExtensionCodecRegistrator.java
index adc7e8d..3fa316f 100644
--- a/drivers/lisp/src/main/java/org/onosproject/drivers/lisp/extensions/LispMappingExtensionCodecRegistrator.java
+++ b/drivers/lisp/src/main/java/org/onosproject/drivers/lisp/extensions/LispMappingExtensionCodecRegistrator.java
@@ -22,6 +22,7 @@
import org.apache.felix.scr.annotations.ReferenceCardinality;
import org.onosproject.codec.CodecService;
import org.onosproject.drivers.lisp.extensions.codec.LispAppDataAddressCodec;
+import org.onosproject.drivers.lisp.extensions.codec.LispAsAddressCodec;
import org.onosproject.mapping.web.MappingCodecRegistrator;
import org.slf4j.Logger;
@@ -48,6 +49,7 @@
registrator.activate();
codecService.registerCodec(LispAppDataAddress.class, new LispAppDataAddressCodec());
+ codecService.registerCodec(LispAsAddress.class, new LispAsAddressCodec());
log.info("Started");
}
@@ -55,6 +57,7 @@
@Deactivate
public void deactivate() {
codecService.unregisterCodec(LispAppDataAddress.class);
+ codecService.unregisterCodec(LispAsAddress.class);
registrator.deactivate();
registrator = null;
diff --git a/drivers/lisp/src/main/java/org/onosproject/drivers/lisp/extensions/codec/LispAsAddressCodec.java b/drivers/lisp/src/main/java/org/onosproject/drivers/lisp/extensions/codec/LispAsAddressCodec.java
new file mode 100644
index 0000000..add4fd3
--- /dev/null
+++ b/drivers/lisp/src/main/java/org/onosproject/drivers/lisp/extensions/codec/LispAsAddressCodec.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.drivers.lisp.extensions.codec;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.onosproject.codec.CodecContext;
+import org.onosproject.codec.JsonCodec;
+import org.onosproject.drivers.lisp.extensions.LispAsAddress;
+import org.onosproject.mapping.addresses.MappingAddress;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.onlab.util.Tools.nullIsIllegal;
+
+/**
+ * LISP AS address codec.
+ */
+public final class LispAsAddressCodec extends JsonCodec<LispAsAddress> {
+
+ protected static final String AS_NUMBER = "asNumber";
+ protected static final String ADDRESS = "address";
+ private static final String MISSING_MEMBER_MESSAGE =
+ " member is required in LispAsAddress";
+
+ @Override
+ public ObjectNode encode(LispAsAddress address, CodecContext context) {
+ checkNotNull(address, "LispAsAddress cannot be null");
+
+ final ObjectNode result = context.mapper().createObjectNode()
+ .put(AS_NUMBER, address.getAsNumber());
+
+ if (address.getAddress() != null) {
+ final JsonCodec<MappingAddress> addressCodec =
+ context.codec(MappingAddress.class);
+ ObjectNode addressNode = addressCodec.encode(address.getAddress(), context);
+ result.set(ADDRESS, addressNode);
+ }
+
+ return result;
+ }
+
+ @Override
+ public LispAsAddress decode(ObjectNode json, CodecContext context) {
+ if (json == null || !json.isObject()) {
+ return null;
+ }
+
+ int asNumber = nullIsIllegal(json.get(AS_NUMBER),
+ AS_NUMBER + MISSING_MEMBER_MESSAGE).asInt();
+
+ ObjectNode addressJson = get(json, ADDRESS);
+ MappingAddress mappingAddress = null;
+
+ if (addressJson != null) {
+ final JsonCodec<MappingAddress> addressCodec =
+ context.codec(MappingAddress.class);
+ mappingAddress = addressCodec.decode(addressJson, context);
+ }
+
+ return new LispAsAddress.Builder()
+ .withAsNumber(asNumber)
+ .withAddress(mappingAddress)
+ .build();
+ }
+}
diff --git a/drivers/lisp/src/test/java/org/onosproject/drivers/lisp/extensions/codec/LispAppDataAddressCodecTest.java b/drivers/lisp/src/test/java/org/onosproject/drivers/lisp/extensions/codec/LispAppDataAddressCodecTest.java
index dddb6a0..d1fa5bd 100644
--- a/drivers/lisp/src/test/java/org/onosproject/drivers/lisp/extensions/codec/LispAppDataAddressCodecTest.java
+++ b/drivers/lisp/src/test/java/org/onosproject/drivers/lisp/extensions/codec/LispAppDataAddressCodecTest.java
@@ -233,8 +233,8 @@
InputStream jsonStream = LispAppDataAddressCodecTest.class.getResourceAsStream(resourceName);
JsonNode json = context.mapper().readTree(jsonStream);
assertThat(json, notNullValue());
- LispAppDataAddress nextObjective = appDataAddressCodec.decode((ObjectNode) json, context);
- assertThat(nextObjective, notNullValue());
- return nextObjective;
+ LispAppDataAddress appDataAddress = appDataAddressCodec.decode((ObjectNode) json, context);
+ assertThat(appDataAddress, notNullValue());
+ return appDataAddress;
}
}
diff --git a/drivers/lisp/src/test/java/org/onosproject/drivers/lisp/extensions/codec/LispAsAddressCodecTest.java b/drivers/lisp/src/test/java/org/onosproject/drivers/lisp/extensions/codec/LispAsAddressCodecTest.java
new file mode 100644
index 0000000..191b27e
--- /dev/null
+++ b/drivers/lisp/src/test/java/org/onosproject/drivers/lisp/extensions/codec/LispAsAddressCodecTest.java
@@ -0,0 +1,168 @@
+/*
+ * 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.drivers.lisp.extensions.codec;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.hamcrest.Description;
+import org.hamcrest.TypeSafeDiagnosingMatcher;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.onlab.packet.IpPrefix;
+import org.onosproject.codec.CodecContext;
+import org.onosproject.codec.JsonCodec;
+import org.onosproject.codec.impl.CodecManager;
+import org.onosproject.drivers.lisp.extensions.LispAsAddress;
+import org.onosproject.drivers.lisp.extensions.LispMappingExtensionCodecRegistrator;
+import org.onosproject.mapping.addresses.MappingAddresses;
+import org.onosproject.mapping.web.codec.MappingAddressJsonMatcher;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.notNullValue;
+
+/**
+ * Unit tests for LispAsAddressCodec.
+ */
+public class LispAsAddressCodecTest {
+
+ private static final int AS_NUMBER = 1;
+ private static final IpPrefix IPV4_PREFIX = IpPrefix.valueOf("10.1.1.0/24");
+
+ private CodecContext context;
+ private JsonCodec<LispAsAddress> asAddressCodec;
+ private LispMappingExtensionCodecRegistrator registrator;
+
+ /**
+ * Sets up for each test.
+ * Creates a context and fetches the LispAsAddress codec.
+ */
+ @Before
+ public void setUp() {
+ CodecManager manager = new CodecManager();
+ registrator = new LispMappingExtensionCodecRegistrator();
+ registrator.codecService = manager;
+ registrator.activate();
+
+ context = new LispMappingExtensionCodecContextAdapter(registrator.codecService);
+ asAddressCodec = context.codec(LispAsAddress.class);
+ assertThat("AS address codec should not be null", asAddressCodec, notNullValue());
+ }
+
+ /**
+ * Deactivates the codec registrator.
+ */
+ @After
+ public void tearDown() {
+ registrator.deactivate();
+ }
+
+ /**
+ * Tests encoding of a LispAsAddress object.
+ */
+ @Test
+ public void testLispAsAddressEncode() {
+ LispAsAddress address = new LispAsAddress.Builder()
+ .withAsNumber(AS_NUMBER)
+ .withAddress(MappingAddresses.ipv4MappingAddress(IPV4_PREFIX))
+ .build();
+ ObjectNode addressJson = asAddressCodec.encode(address, context);
+ assertThat("errors in encoding AS address JSON",
+ addressJson, LispAsAddressJsonMatcher.matchesAsAddress(address));
+ }
+
+ /**
+ * Tests decoding of a LispAsAddress JSON object.
+ */
+ @Test
+ public void testLispAsAddressDecode() throws IOException {
+ LispAsAddress address = getLispAsAddress("LispAsAddress.json");
+
+ assertThat("incorrect AS number", address.getAsNumber(), is(AS_NUMBER));
+ assertThat("incorrect mapping address", address.getAddress(),
+ is(MappingAddresses.ipv4MappingAddress(IPV4_PREFIX)));
+ }
+
+ /**
+ * Hamcrest matcher for LispAsAddress.
+ */
+ public static final class LispAsAddressJsonMatcher
+ extends TypeSafeDiagnosingMatcher<JsonNode> {
+
+ private final LispAsAddress address;
+
+ /**
+ * Default constructor.
+ *
+ * @param address LispAsAddress object
+ */
+ private LispAsAddressJsonMatcher(LispAsAddress address) {
+ this.address = address;
+ }
+
+ @Override
+ protected boolean matchesSafely(JsonNode jsonNode, Description description) {
+
+ // check protocol
+ int jsonAsNumber = jsonNode.get(LispAsAddressCodec.AS_NUMBER).asInt();
+ int asNumber = address.getAsNumber();
+ if (jsonAsNumber != asNumber) {
+ description.appendText("AsNumber was " + jsonAsNumber);
+ return false;
+ }
+
+ // check address
+ MappingAddressJsonMatcher addressMatcher =
+ MappingAddressJsonMatcher.matchesMappingAddress(address.getAddress());
+ return addressMatcher.matches(jsonNode.get(LispAppDataAddressCodec.ADDRESS));
+ }
+
+ @Override
+ public void describeTo(Description description) {
+ description.appendText(address.toString());
+ }
+
+ /**
+ * Factory to allocate a LispAsAddress matcher.
+ *
+ * @param address LispAsAddress object we are looking for
+ * @return matcher
+ */
+ public static LispAsAddressJsonMatcher matchesAsAddress(LispAsAddress address) {
+ return new LispAsAddressJsonMatcher(address);
+ }
+ }
+
+ /**
+ * Reads in a LispAsAddress from the given resource and decodes it.
+ *
+ * @param resourceName resource to use to read the JSON for the rule
+ * @return decoded LispAsAddress
+ * @throws IOException if processing the resource fails
+ */
+ private LispAsAddress getLispAsAddress(String resourceName) throws IOException {
+ InputStream jsonStream = LispAsAddressCodecTest.class.getResourceAsStream(resourceName);
+ JsonNode json = context.mapper().readTree(jsonStream);
+ assertThat("JSON string should not be null", json, notNullValue());
+ LispAsAddress asAddress = asAddressCodec.decode((ObjectNode) json, context);
+ assertThat("Decoded address should not be null", asAddress, notNullValue());
+ return asAddress;
+ }
+}
diff --git a/drivers/lisp/src/main/java/org/onosproject/drivers/lisp/extensions/codec/LispMappingExtensionCodecContextAdapter.java b/drivers/lisp/src/test/java/org/onosproject/drivers/lisp/extensions/codec/LispMappingExtensionCodecContextAdapter.java
similarity index 100%
rename from drivers/lisp/src/main/java/org/onosproject/drivers/lisp/extensions/codec/LispMappingExtensionCodecContextAdapter.java
rename to drivers/lisp/src/test/java/org/onosproject/drivers/lisp/extensions/codec/LispMappingExtensionCodecContextAdapter.java
diff --git a/drivers/lisp/src/test/resources/org/onosproject/drivers/lisp/extensions/codec/LispAsAddress.json b/drivers/lisp/src/test/resources/org/onosproject/drivers/lisp/extensions/codec/LispAsAddress.json
new file mode 100644
index 0000000..fc02655
--- /dev/null
+++ b/drivers/lisp/src/test/resources/org/onosproject/drivers/lisp/extensions/codec/LispAsAddress.json
@@ -0,0 +1,7 @@
+{
+ "asNumber": 1,
+ "address": {
+ "type": "IPV4",
+ "ipv4": "10.1.1.0/24"
+ }
+}
\ No newline at end of file