ConfigFlowRuleProgrammable

- FlowRuleProgrammable implementation which acts as it has accepted any FlowRule request.

-- To be used for a device which exist in-line transparently (e.g., Amplifier ONOS-6067)

Change-Id: Ief09297eb900b804b1c8eb4d6705bbad85a552ad
diff --git a/drivers/optical/src/test/java/org/onosproject/driver/optical/config/BaseConfigTestHelper.java b/drivers/optical/src/test/java/org/onosproject/driver/optical/config/BaseConfigTestHelper.java
new file mode 100644
index 0000000..d607689
--- /dev/null
+++ b/drivers/optical/src/test/java/org/onosproject/driver/optical/config/BaseConfigTestHelper.java
@@ -0,0 +1,117 @@
+/*
+ * 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.driver.optical.config;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+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.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;
+
+/**
+ * Common utility required for testing BaseConfig instance.
+ */
+public class BaseConfigTestHelper {
+
+    /**
+     * {@link ServiceDirectory} to be used by BaseConfig.
+     */
+    protected static TestServiceDirectory directory;
+
+    /**
+     * No-op ConfigApplyDelegate.
+     */
+    protected final ConfigApplyDelegate noopDelegate = cfg -> { };
+
+    private static ServiceDirectory original;
+
+
+    @BeforeClass
+    public static void setUpBaseConfigClass() 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 tearDownBaseConfigClass() throws TestUtilsException {
+        TestUtils.setField(BaseConfig.class, "services", original);
+    }
+
+    /**
+     * Returns ObjectMapper configured for ease of testing.
+     * <p>
+     * It will treat all integral number node as long node.
+     *
+     * @return mapper
+     */
+    public static ObjectMapper testFriendlyMapper() {
+        ObjectMapper 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);
+            }
+        });
+
+        return mapper;
+    }
+
+    /**
+     * Load JSON file from resource.
+     *
+     * @param filename JSON file name
+     * @param mapper to use to read file.
+     * @return JSON node
+     * @throws JsonProcessingException
+     * @throws IOException
+     */
+    public JsonNode loadJsonFromResource(String filename, ObjectMapper mapper)
+                throws JsonProcessingException, IOException {
+
+        InputStream stream = getClass().getResourceAsStream(filename);
+        JsonNode tree = mapper.readTree(stream);
+        return tree;
+    }
+}
diff --git a/drivers/optical/src/test/java/org/onosproject/driver/optical/config/FlowTableConfigTest.java b/drivers/optical/src/test/java/org/onosproject/driver/optical/config/FlowTableConfigTest.java
new file mode 100644
index 0000000..c8622bb
--- /dev/null
+++ b/drivers/optical/src/test/java/org/onosproject/driver/optical/config/FlowTableConfigTest.java
@@ -0,0 +1,131 @@
+/*
+ * 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.driver.optical.config;
+
+import static org.hamcrest.Matchers.*;
+import static org.junit.Assert.*;
+import static org.onosproject.net.PortNumber.portNumber;
+import static org.onosproject.net.flow.instructions.Instructions.modL0Lambda;
+
+import java.io.IOException;
+import java.util.Set;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.CoreService;
+import org.onosproject.core.CoreServiceAdapter;
+import org.onosproject.core.DefaultApplicationId;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.OchSignal;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.flow.DefaultFlowRule;
+import org.onosproject.net.flow.DefaultTrafficSelector;
+import org.onosproject.net.flow.DefaultTrafficTreatment;
+import org.onosproject.net.flow.FlowRule;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.collect.ImmutableSet;
+
+public class FlowTableConfigTest extends BaseConfigTestHelper {
+
+    private static final String SAMPLE = "flow_table_config.json";
+
+
+    private static final DeviceId DID = DeviceId.deviceId("of:0000000000000001");
+    private static final PortNumber PN_1 = portNumber(1);
+    private static final PortNumber PN_2 = portNumber(2);
+    private static final int FLOW_ID_3 = 3;
+    private static final int PRIO_4 = 4;
+
+    private static final DefaultApplicationId APP_ID =
+                new DefaultApplicationId(FLOW_ID_3 >>> 48, "test");
+
+    private static final OchSignal LAMBDA_42 = OchSignal.newFlexGridSlot(42);
+
+    private static final FlowRule FLOW_RULE = DefaultFlowRule.builder()
+                        .forDevice(DID)
+                        .withCookie(FLOW_ID_3)
+                        .makePermanent()
+                        .withPriority(PRIO_4)
+                        .withSelector(DefaultTrafficSelector.builder()
+                                          .matchInPort(PN_1)
+                                          .build())
+                        .withTreatment(DefaultTrafficTreatment.builder()
+                                           .setOutput(PN_2)
+                                           .add(modL0Lambda(LAMBDA_42))
+                                           .build())
+                        .build();
+
+
+    private ObjectMapper mapper;
+
+
+    private JsonNode cfgnode;
+
+    @Before
+    public void setUp() throws Exception {
+
+        directory.add(CoreService.class, new CoreServiceAdapter() {
+            @Override
+            public ApplicationId getAppId(Short id) {
+                return APP_ID;
+            }
+
+            @Override
+            public ApplicationId registerApplication(String name) {
+                return APP_ID;
+            }
+        });
+
+        mapper = testFriendlyMapper();
+        JsonNode sample = loadJsonFromResource(SAMPLE, mapper);
+
+        cfgnode = sample.path("devices")
+                                    .path(DID.toString())
+                                       .path(FlowTableConfig.CONFIG_KEY);
+
+    }
+
+    @After
+    public void tearDown() throws Exception {
+    }
+
+    @Test
+    public void readTest() throws JsonProcessingException, IOException {
+
+        FlowTableConfig sut = new FlowTableConfig();
+        sut.init(DID, FlowTableConfig.CONFIG_KEY, cfgnode, mapper, noopDelegate);
+
+        assertThat(sut.flowtable(), is(equalTo(ImmutableSet.of(FLOW_RULE))));
+    }
+
+    @Test
+    public void writeTest() throws JsonProcessingException, IOException {
+
+        FlowTableConfig w = new FlowTableConfig();
+        w.init(DID, FlowTableConfig.CONFIG_KEY, mapper.createObjectNode(), mapper, noopDelegate);
+
+        Set<FlowRule> table = ImmutableSet.of(FLOW_RULE);
+        w.flowtable(table);
+
+        assertEquals(cfgnode, w.node());
+    }
+
+}