Sketching out device driver subsystem to allow extensible device management functions to be made available to applications.
Revising some implementations and adding tests.
Removing fingerprint and extension concept for now.
Change-Id: Id50faf29e4590b08e0c2b385ae8d4bb0c453f37e
diff --git a/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverDataTest.java b/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverDataTest.java
new file mode 100644
index 0000000..40e9bb1
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverDataTest.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright 2015 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.driver;
+
+import com.google.common.collect.ImmutableMap;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.junit.Assert.*;
+
+public class DefaultDriverDataTest {
+
+ DefaultDriver ddc;
+ DefaultDriverData data;
+
+ @Before
+ public void setUp() {
+ ddc = new DefaultDriver("foo.bar", "Circus", "lux", "1.2a",
+ ImmutableMap.of(TestBehaviour.class,
+ TestBehaviourImpl.class),
+ ImmutableMap.of("foo", "bar"));
+ data = new DefaultDriverData(ddc);
+ }
+
+ @Test
+ public void basics() {
+ assertSame("incorrect type", ddc, data.type());
+ assertTrue("incorrect toString", data.toString().contains("foo.bar"));
+ }
+
+ @Test
+ public void behaviour() {
+ TestBehaviour behaviour = data.behaviour(TestBehaviour.class);
+ assertTrue("incorrect behaviour", behaviour instanceof TestBehaviourImpl);
+ }
+
+ @Test
+ public void setAndClearAnnotations() {
+ data.set("croc", "aqua");
+ data.set("roo", "mars");
+ data.set("dingo", "bat");
+ assertEquals("incorrect property", "bat", data.value("dingo"));
+ data.clear("dingo", "roo");
+ assertNull("incorrect property", data.value("dingo"));
+ assertNull("incorrect property", data.value("root"));
+ assertEquals("incorrect property", "aqua", data.value("croc"));
+ assertEquals("incorrect properties", 1, data.keys().size());
+ }
+
+ @Test
+ public void clearAllAnnotations() {
+ data.set("croc", "aqua");
+ data.set("roo", "mars");
+ data.set("dingo", "bat");
+ assertEquals("incorrect property", "bat", data.value("dingo"));
+ data.clear();
+ assertEquals("incorrect properties", 0, data.keys().size());
+ }
+
+}
\ No newline at end of file
diff --git a/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverHandlerTest.java b/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverHandlerTest.java
new file mode 100644
index 0000000..e9a6165
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverHandlerTest.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright 2015 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.driver;
+
+import com.google.common.collect.ImmutableMap;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.junit.Assert.assertSame;
+import static org.junit.Assert.assertTrue;
+
+public class DefaultDriverHandlerTest {
+
+ DefaultDriver ddc;
+ DefaultDriverData data;
+ DefaultDriverHandler handler;
+
+ @Before
+ public void setUp() {
+ ddc = new DefaultDriver("foo.bar", "Circus", "lux", "1.2a",
+ ImmutableMap.of(TestBehaviour.class,
+ TestBehaviourImpl.class,
+ TestBehaviourTwo.class,
+ TestBehaviourTwoImpl.class),
+ ImmutableMap.of("foo", "bar"));
+ data = new DefaultDriverData(ddc);
+ handler = new DefaultDriverHandler(data);
+ }
+
+ @Test
+ public void basics() {
+ assertSame("incorrect data", data, handler.data());
+ assertTrue("incorrect toString", handler.toString().contains("1.2a"));
+ }
+
+ @Test
+ public void behaviour() {
+ TestBehaviourTwo behaviour = handler.behaviour(TestBehaviourTwo.class);
+ assertTrue("incorrect behaviour", behaviour instanceof TestBehaviourTwoImpl);
+ }
+
+}
\ No newline at end of file
diff --git a/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverProviderTest.java b/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverProviderTest.java
new file mode 100644
index 0000000..adfa486
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverProviderTest.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2015 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.driver;
+
+import com.google.common.collect.ImmutableMap;
+import org.junit.Test;
+
+import java.util.Set;
+
+import static com.google.common.collect.ImmutableSet.of;
+import static org.junit.Assert.assertEquals;
+
+public class DefaultDriverProviderTest {
+
+ @Test
+ public void basics() {
+ DefaultDriverProvider ddp = new DefaultDriverProvider();
+ DefaultDriver one = new DefaultDriver("foo.bar", "Circus", "lux", "1.2a",
+ ImmutableMap.of(TestBehaviour.class,
+ TestBehaviourImpl.class),
+ ImmutableMap.of("foo", "bar"));
+ DefaultDriver two = new DefaultDriver("foo.bar", "", "", "",
+ ImmutableMap.of(TestBehaviourTwo.class,
+ TestBehaviourTwoImpl.class),
+ ImmutableMap.of("goo", "wee"));
+ DefaultDriver three = new DefaultDriver("goo.foo", "BigTop", "better", "2.2",
+ ImmutableMap.of(TestBehaviourTwo.class,
+ TestBehaviourTwoImpl.class),
+ ImmutableMap.of("goo", "gee"));
+
+ ddp.addDrivers(of(one, two, three));
+
+ Set<Driver> drivers = ddp.getDrivers();
+ assertEquals("incorrect types", 2, drivers.size());
+ }
+}
\ No newline at end of file
diff --git a/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverTest.java b/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverTest.java
new file mode 100644
index 0000000..f10602a
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/net/driver/DefaultDriverTest.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright 2015 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.driver;
+
+import com.google.common.collect.ImmutableMap;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+public class DefaultDriverTest {
+
+ @Test
+ public void basics() {
+ DefaultDriver ddc = new DefaultDriver("foo.bar", "Circus", "lux", "1.2a",
+ ImmutableMap.of(TestBehaviour.class,
+ TestBehaviourImpl.class),
+ ImmutableMap.of("foo", "bar"));
+ assertEquals("incorrect name", "foo.bar", ddc.name());
+ assertEquals("incorrect mfr", "Circus", ddc.manufacturer());
+ assertEquals("incorrect hw", "lux", ddc.hwVersion());
+ assertEquals("incorrect sw", "1.2a", ddc.swVersion());
+
+ assertEquals("incorrect behaviour count", 1, ddc.behaviours().size());
+ assertTrue("incorrect behaviour", ddc.hasBehaviour(TestBehaviour.class));
+
+ assertEquals("incorrect property count", 1, ddc.properties().size());
+ assertEquals("incorrect key count", 1, ddc.keys().size());
+ assertEquals("incorrect property", "bar", ddc.value("foo"));
+
+ assertTrue("incorrect toString", ddc.toString().contains("lux"));
+ }
+
+ @Test
+ public void merge() {
+ DefaultDriver one = new DefaultDriver("foo.bar", "Circus", "lux", "1.2a",
+ ImmutableMap.of(TestBehaviour.class,
+ TestBehaviourImpl.class),
+ ImmutableMap.of("foo", "bar"));
+ DefaultDriver ddc =
+ one.merge(new DefaultDriver("foo.bar", "", "", "",
+ ImmutableMap.of(TestBehaviourTwo.class,
+ TestBehaviourTwoImpl.class),
+ ImmutableMap.of("goo", "wee")));
+
+ assertEquals("incorrect name", "foo.bar", ddc.name());
+ assertEquals("incorrect mfr", "Circus", ddc.manufacturer());
+ assertEquals("incorrect hw", "lux", ddc.hwVersion());
+ assertEquals("incorrect sw", "1.2a", ddc.swVersion());
+
+ assertEquals("incorrect behaviour count", 2, ddc.behaviours().size());
+ assertTrue("incorrect behaviour", ddc.hasBehaviour(TestBehaviourTwo.class));
+
+ assertEquals("incorrect property count", 2, ddc.properties().size());
+ assertEquals("incorrect key count", 2, ddc.keys().size());
+ assertEquals("incorrect property", "wee", ddc.value("goo"));
+
+ assertTrue("incorrect toString", ddc.toString().contains("Circus"));
+ }
+}
\ No newline at end of file
diff --git a/core/api/src/test/java/org/onosproject/net/driver/TestBehaviour.java b/core/api/src/test/java/org/onosproject/net/driver/TestBehaviour.java
new file mode 100644
index 0000000..632fae1
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/net/driver/TestBehaviour.java
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2015 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.driver;
+
+/**
+ * Test behaviour.
+ */
+public interface TestBehaviour extends Behaviour {
+}
diff --git a/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourImpl.java b/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourImpl.java
new file mode 100644
index 0000000..ec5c66b
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourImpl.java
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2015 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.driver;
+
+/**
+ * Test behaviour.
+ */
+public class TestBehaviourImpl extends AbstractBehaviour implements TestBehaviour {
+}
diff --git a/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourNoConstructorImpl.java b/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourNoConstructorImpl.java
new file mode 100644
index 0000000..2045236
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourNoConstructorImpl.java
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2015 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.driver;
+
+/**
+ * Bad test behaviour.
+ */
+public final class TestBehaviourNoConstructorImpl
+ extends AbstractBehaviour implements TestBehaviour {
+ private TestBehaviourNoConstructorImpl() {
+
+ }
+}
diff --git a/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourTwo.java b/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourTwo.java
new file mode 100644
index 0000000..3399f00
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourTwo.java
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2015 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.driver;
+
+/**
+ * Test behaviour.
+ */
+public interface TestBehaviourTwo extends HandlerBehaviour {
+}
diff --git a/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourTwoImpl.java b/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourTwoImpl.java
new file mode 100644
index 0000000..502d385
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/net/driver/TestBehaviourTwoImpl.java
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2015 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.driver;
+
+/**
+ * Test behaviour.
+ */
+public class TestBehaviourTwoImpl extends AbstractBehaviour implements TestBehaviourTwo {
+}
diff --git a/core/api/src/test/java/org/onosproject/net/driver/XmlDriverLoaderTest.java b/core/api/src/test/java/org/onosproject/net/driver/XmlDriverLoaderTest.java
new file mode 100644
index 0000000..2ad64f5
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/net/driver/XmlDriverLoaderTest.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright 2015 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.driver;
+
+import org.junit.Test;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * Tests of the XML driver loader implementation.
+ */
+public class XmlDriverLoaderTest {
+
+ @Test
+ public void basics() throws IOException {
+ XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader());
+ InputStream stream = getClass().getResourceAsStream("drivers.1.xml");
+ DriverProvider provider = loader.loadDrivers(stream);
+ System.out.println(provider);
+ assertEquals("incorrect driver count", 1, provider.getDrivers().size());
+
+ Driver driver = provider.getDrivers().iterator().next();
+ assertEquals("incorrect driver name", "foo.1", driver.name());
+ assertEquals("incorrect driver mfg", "Circus", driver.manufacturer());
+ assertEquals("incorrect driver hw", "1.2a", driver.hwVersion());
+ assertEquals("incorrect driver sw", "2.2", driver.swVersion());
+
+ assertEquals("incorrect driver behaviours", 2, driver.behaviours().size());
+ assertTrue("incorrect driver behaviour", driver.hasBehaviour(TestBehaviour.class));
+
+ assertEquals("incorrect driver properties", 2, driver.properties().size());
+ assertTrue("incorrect driver property", driver.properties().containsKey("p1"));
+ }
+
+ @Test(expected = IOException.class)
+ public void badXML() throws IOException {
+ XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader());
+ loader.loadDrivers(getClass().getResourceAsStream("drivers.bad.xml"));
+ }
+
+ @Test(expected = IllegalArgumentException.class)
+ public void noClass() throws IOException {
+ XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader());
+ loader.loadDrivers(getClass().getResourceAsStream("drivers.noclass.xml"));
+ }
+
+ @Test(expected = IllegalArgumentException.class)
+ public void noConstructor() throws IOException {
+ XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader());
+ InputStream stream = getClass().getResourceAsStream("drivers.noconstructor.xml");
+ DriverProvider provider = loader.loadDrivers(stream);
+ Driver driver = provider.getDrivers().iterator().next();
+ driver.createBehaviour(new DefaultDriverData(driver), TestBehaviour.class, false);
+ }
+
+}
\ No newline at end of file