From 277b5e8492aa4a321e764b57c76255bef2a434bf Mon Sep 17 00:00:00 2001
From: Bartosz Firyn <bartoszfiryn@gmail.com>
Date: Mon, 12 Jan 2015 16:59:24 +0100
Subject: [PATCH] More unit tests for WebcamLock, etc

---
 pom.xml                                       |  17 ++
 webcam-capture/pom.xml                        |  26 +-
 .../com/github/sarxos/webcam/WebcamLock.java  |  31 ++-
 .../github/sarxos/webcam/WebcamLockTest.java  |  64 +++++
 .../sarxos/webcam/WebcamStaticsTest.java      | 190 +++++++++++++
 .../com/github/sarxos/webcam/WebcamTest.java  | 260 +++++-------------
 6 files changed, 381 insertions(+), 207 deletions(-)
 create mode 100644 webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamLockTest.java
 create mode 100644 webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamStaticsTest.java

diff --git a/pom.xml b/pom.xml
index f41f3a69..78b54fb4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -94,21 +94,37 @@
 				<groupId>junit</groupId>
 				<artifactId>junit</artifactId>
 				<version>4.11</version>
+				<scope>test</scope>
 			</dependency>
 			<dependency>
 				<groupId>org.easymock</groupId>
 				<artifactId>easymock</artifactId>
 				<version>3.2</version>
+				<scope>test</scope>
 			</dependency>
 			<dependency>
 				<groupId>org.powermock</groupId>
 				<artifactId>powermock-module-junit4</artifactId>
 				<version>1.5.5</version>
+				<scope>test</scope>
 			</dependency>
 			<dependency>
 				<groupId>org.powermock</groupId>
 				<artifactId>powermock-api-easymock</artifactId>
 				<version>1.5.5</version>
+				<scope>test</scope>
+			</dependency>
+			<dependency>
+				<groupId>org.assertj</groupId>
+				<artifactId>assertj-core</artifactId>
+				<version>1.6.1</version>
+				<scope>test</scope>
+			</dependency>
+			<dependency>
+				<groupId>com.jayway.awaitility</groupId>
+				<artifactId>awaitility</artifactId>
+				<version>1.6.2</version>
+				<scope>test</scope>
 			</dependency>
 			<dependency>
 				<groupId>org.slf4j</groupId>
@@ -119,6 +135,7 @@
 				<groupId>ch.qos.logback</groupId>
 				<artifactId>logback-classic</artifactId>
 				<version>1.0.9</version>
+				<scope>provided</scope>
 			</dependency>
 		</dependencies>
 	</dependencyManagement>
diff --git a/webcam-capture/pom.xml b/webcam-capture/pom.xml
index 7a255ff3..78a36471 100644
--- a/webcam-capture/pom.xml
+++ b/webcam-capture/pom.xml
@@ -29,10 +29,10 @@
 			<artifactId>bridj</artifactId>
 			<version>0.6.3-SNAPSHOT</version>
 			<exclusions>
-			    <exclusion>
-			        <artifactId>dx</artifactId>
-			        <groupId>com.google.android.tools</groupId>
-			    </exclusion>
+				<exclusion>
+					<artifactId>dx</artifactId>
+					<groupId>com.google.android.tools</groupId>
+				</exclusion>
 			</exclusions>
 		</dependency>
 		<dependency>
@@ -44,11 +44,29 @@
 			<artifactId>logback-classic</artifactId>
 			<scope>provided</scope>
 		</dependency>
+
+		<!-- unit tests -->
 		<dependency>
 			<groupId>junit</groupId>
 			<artifactId>junit</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.assertj</groupId>
+			<artifactId>assertj-core</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.easymock</groupId>
+			<artifactId>easymock</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>com.jayway.awaitility</groupId>
+			<artifactId>awaitility</artifactId>
+			<scope>test</scope>
+		</dependency>
+
 	</dependencies>
 
 	<!-- 
diff --git a/webcam-capture/src/main/java/com/github/sarxos/webcam/WebcamLock.java b/webcam-capture/src/main/java/com/github/sarxos/webcam/WebcamLock.java
index b052389e..82b40130 100644
--- a/webcam-capture/src/main/java/com/github/sarxos/webcam/WebcamLock.java
+++ b/webcam-capture/src/main/java/com/github/sarxos/webcam/WebcamLock.java
@@ -14,13 +14,12 @@
 
 
 /**
- * This class is used as a global (system) lock preventing other processes from
- * using the same camera while it's open. Whenever webcam is open there is a
- * thread running in background which updates the lock once per 2 seconds. Lock
- * is being released whenever webcam is either closed or completely disposed.
- * Lock will remain for at least 2 seconds in case when JVM has not been
+ * This class is used as a global (system) lock preventing other processes from using the same
+ * camera while it's open. Whenever webcam is open there is a thread running in background which
+ * updates the lock once per 2 seconds. Lock is being released whenever webcam is either closed or
+ * completely disposed. Lock will remain for at least 2 seconds in case when JVM has not been
  * gracefully terminated (due to SIGSEGV, SIGTERM, etc).
- * 
+ *
  * @author Bartosz Firyn (sarxos)
  */
 public class WebcamLock {
@@ -37,7 +36,7 @@ public class WebcamLock {
 
 	/**
 	 * Used to update lock state.
-	 * 
+	 *
 	 * @author sarxos
 	 */
 	private class LockUpdater extends Thread {
@@ -80,21 +79,21 @@ public void run() {
 	/**
 	 * Is webcam locked (local, not cross-VM variable).
 	 */
-	private AtomicBoolean locked = new AtomicBoolean(false);
+	private final AtomicBoolean locked = new AtomicBoolean(false);
 
 	/**
 	 * Is lock completely disabled.
 	 */
-	private AtomicBoolean disabled = new AtomicBoolean(false);
+	private final AtomicBoolean disabled = new AtomicBoolean(false);
 
 	/**
 	 * Lock file.
 	 */
-	private File lock = null;
+	private final File lock;
 
 	/**
 	 * Creates global webcam lock.
-	 * 
+	 *
 	 * @param webcam the webcam instance to be locked
 	 */
 	protected WebcamLock(Webcam webcam) {
@@ -299,8 +298,8 @@ public void lock() {
 	}
 
 	/**
-	 * Completely disable locking mechanism. After this method is invoked, the
-	 * lock will not have any effect on the webcam runtime.
+	 * Completely disable locking mechanism. After this method is invoked, the lock will not have
+	 * any effect on the webcam runtime.
 	 */
 	public void disable() {
 		if (disabled.compareAndSet(false, true)) {
@@ -339,7 +338,7 @@ public void unlock() {
 
 	/**
 	 * Check if webcam is locked.
-	 * 
+	 *
 	 * @return True if webcam is locked, false otherwise
 	 */
 	public boolean isLocked() {
@@ -373,4 +372,8 @@ public boolean isLocked() {
 
 		return false;
 	}
+
+	public File getLockFile() {
+		return lock;
+	}
 }
diff --git a/webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamLockTest.java b/webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamLockTest.java
new file mode 100644
index 00000000..70ff32b7
--- /dev/null
+++ b/webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamLockTest.java
@@ -0,0 +1,64 @@
+package com.github.sarxos.webcam;
+
+import org.assertj.core.api.Assertions;
+import org.easymock.EasyMock;
+import org.easymock.EasyMockRunner;
+import org.easymock.EasyMockSupport;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+
+/**
+ * This test case is to cover {@link WebcamLock} class.
+ *
+ * @author Bartosz Firyn (sarxos)
+ */
+@RunWith(EasyMockRunner.class)
+public class WebcamLockTest extends EasyMockSupport {
+
+	Webcam webcam;
+
+	@Before
+	public void before() {
+
+		webcam = createNiceMock(Webcam.class);
+
+		EasyMock
+			.expect(webcam.getName())
+			.andReturn("test-webcam")
+			.anyTimes();
+
+		replayAll();
+	}
+
+	@Test
+	public void test_lock() {
+
+		WebcamLock lock = new WebcamLock(webcam);
+		lock.lock();
+
+		Assertions
+			.assertThat(lock.isLocked())
+			.isTrue();
+
+		lock.unlock();
+
+		Assertions
+			.assertThat(lock.isLocked())
+			.isFalse();
+	}
+
+	@Test
+	public void test_lock2() {
+
+		WebcamLock first = new WebcamLock(webcam);
+		WebcamLock second = new WebcamLock(webcam);
+
+		first.lock();
+
+		Assertions
+			.assertThat(second.isLocked())
+			.isTrue();
+	}
+}
diff --git a/webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamStaticsTest.java b/webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamStaticsTest.java
new file mode 100644
index 00000000..92ed3cc3
--- /dev/null
+++ b/webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamStaticsTest.java
@@ -0,0 +1,190 @@
+package com.github.sarxos.webcam;
+
+import java.awt.Dimension;
+import java.awt.Image;
+import java.util.List;
+
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import com.github.sarxos.webcam.ds.test.DummyDriver;
+import com.github.sarxos.webcam.ds.test.DummyDriver2;
+import com.github.sarxos.webcam.ds.test.DummyDriver3;
+
+
+/**
+ * @author bfiryn
+ */
+public class WebcamStaticsTest {
+
+	@Before
+	public void prepare() {
+		Webcam.resetDriver();
+		System.out.println(Thread.currentThread().getName() + ": Register dummy driver");
+		Webcam.registerDriver(DummyDriver.class);
+	}
+
+	@After
+	public void cleanup() {
+		System.out.println(Thread.currentThread().getName() + ": Reset driver");
+		for (Webcam webcam : Webcam.getWebcams()) {
+			webcam.close();
+		}
+		Webcam.resetDriver();
+	}
+
+	@Test
+	public void test_getWebcams() {
+
+		System.out.println(Thread.currentThread().getName() + ": test_getWebcams() start");
+
+		List<Webcam> webcams = Webcam.getWebcams();
+		List<WebcamDevice> devices = DummyDriver.getInstance().getDevices();
+
+		Assert.assertTrue(webcams.size() > 0);
+		Assert.assertEquals(devices.size(), webcams.size());
+
+		System.out.println(Thread.currentThread().getName() + ": test_getWebcams() end");
+	}
+
+	@Test
+	public void test_getDefault() {
+
+		System.out.println(Thread.currentThread().getName() + ": test_getDefault() start");
+
+		List<Webcam> webcams = Webcam.getWebcams();
+		List<WebcamDevice> devices = DummyDriver.getInstance().getDevices();
+
+		Assert.assertNotNull(Webcam.getDefault());
+		Assert.assertSame(webcams.get(0), Webcam.getDefault());
+		Assert.assertSame(devices.get(0), Webcam.getDefault().getDevice());
+
+		System.out.println(Thread.currentThread().getName() + ": test_getDefault() end");
+	}
+
+	@Test
+	public void test_open() {
+
+		System.out.println(Thread.currentThread().getName() + ": test_open() start");
+
+		Webcam webcam = Webcam.getDefault();
+		webcam.open();
+
+		Assert.assertTrue(webcam.isOpen());
+		webcam.open();
+		Assert.assertTrue(webcam.isOpen());
+
+		System.out.println(Thread.currentThread().getName() + ": test_open() end");
+	}
+
+	@Test
+	public void test_close() {
+
+		System.out.println(Thread.currentThread().getName() + ": test_close() start");
+
+		Webcam webcam = Webcam.getDefault();
+		webcam.open();
+
+		Assert.assertSame(DummyDriver.class, Webcam.getDriver().getClass());
+
+		Assert.assertTrue(webcam.isOpen());
+		webcam.close();
+		Assert.assertFalse(webcam.isOpen());
+		webcam.close();
+		Assert.assertFalse(webcam.isOpen());
+
+		System.out.println(Thread.currentThread().getName() + ": test_close() end");
+	}
+
+	@Test
+	public void test_getImage() {
+
+		System.out.println(Thread.currentThread().getName() + ": test_getImage() start");
+
+		Webcam webcam = Webcam.getDefault();
+		webcam.open();
+
+		Assert.assertSame(DummyDriver.class, Webcam.getDriver().getClass());
+
+		Image image = webcam.getImage();
+
+		Assert.assertNotNull(image);
+
+		System.out.println(Thread.currentThread().getName() + ": test_getImage() end");
+	}
+
+	@Test
+	public void test_getSizes() {
+
+		System.out.println(Thread.currentThread().getName() + ": test_getSizes() start");
+
+		Dimension[] sizes = Webcam.getDefault().getViewSizes();
+
+		Assert.assertSame(DummyDriver.class, Webcam.getDriver().getClass());
+
+		Assert.assertNotNull(sizes);
+		Assert.assertEquals(2, sizes.length);
+
+		System.out.println(Thread.currentThread().getName() + ": test_getSizes() end");
+	}
+
+	@Test
+	public void test_setSize() {
+
+		Webcam webcam = Webcam.getDefault();
+		Dimension[] sizes = webcam.getViewSizes();
+		webcam.setViewSize(sizes[0]);
+
+		Assert.assertNotNull(webcam.getViewSize());
+		Assert.assertSame(sizes[0], webcam.getViewSize());
+	}
+
+	@Test
+	public void test_setDriver() throws InstantiationException {
+
+		Webcam.setDriver(DummyDriver2.class);
+		WebcamDriver driver2 = Webcam.getDriver();
+
+		Assert.assertSame(DummyDriver2.class, driver2.getClass());
+
+		WebcamDriver driver3 = new DummyDriver3();
+		Webcam.setDriver(driver3);
+
+		Assert.assertSame(driver3, Webcam.getDriver());
+	}
+
+	@Test
+	public void test_registerDriver() {
+
+		Webcam.resetDriver();
+
+		Webcam.registerDriver(DummyDriver.class);
+		Webcam.getWebcams();
+		WebcamDriver driver = Webcam.getDriver();
+
+		Assert.assertSame(DummyDriver.class, driver.getClass());
+	}
+
+	@Test
+	public void test_GetWebcamByName() throws InstantiationException {
+		Webcam.setDriver(new DummyDriver());
+		for (Webcam webcam : Webcam.getWebcams()) {
+			Assert.assertEquals(webcam.getName(), Webcam.getWebcamByName(webcam.getName()).getName());
+		}
+	}
+
+	@Test
+	public void test_GetWebcamByNameWithNotExistingWebcamName() throws InstantiationException {
+		Webcam.setDriver(new DummyDriver());
+		Assert.assertNull(Webcam.getWebcamByName("DatCameraDoesNotExist"));
+	}
+
+	@Test(expected = IllegalArgumentException.class)
+	public void test_GetWebcamByNameWithNullArgument() throws InstantiationException {
+		Webcam.setDriver(new DummyDriver());
+		Webcam.getWebcamByName(null);
+	}
+
+}
diff --git a/webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamTest.java b/webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamTest.java
index e8d041a9..68d60d2a 100644
--- a/webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamTest.java
+++ b/webcam-capture/src/test/java/com/github/sarxos/webcam/WebcamTest.java
@@ -1,189 +1,71 @@
-package com.github.sarxos.webcam;
-
-import java.awt.Dimension;
-import java.awt.Image;
-import java.util.List;
-
-import org.junit.After;
-import org.junit.Assert;
-import org.junit.Before;
-import org.junit.Test;
-
-import com.github.sarxos.webcam.ds.test.DummyDriver;
-import com.github.sarxos.webcam.ds.test.DummyDriver2;
-import com.github.sarxos.webcam.ds.test.DummyDriver3;
-
-
-/**
- * @author bfiryn
- */
-public class WebcamTest {
-
-	@Before
-	public void prepare() {
-		System.out.println(Thread.currentThread().getName() + ": Register dummy driver");
-		Webcam.registerDriver(DummyDriver.class);
-	}
-
-	@After
-	public void cleanup() {
-		System.out.println(Thread.currentThread().getName() + ": Reset driver");
-		for (Webcam webcam : Webcam.getWebcams()) {
-			webcam.close();
-		}
-		Webcam.resetDriver();
-	}
-
-	@Test
-	public void test_getWebcams() {
-
-		System.out.println(Thread.currentThread().getName() + ": test_getWebcams() start");
-
-		List<Webcam> webcams = Webcam.getWebcams();
-		List<WebcamDevice> devices = DummyDriver.getInstance().getDevices();
-
-		Assert.assertTrue(webcams.size() > 0);
-		Assert.assertEquals(devices.size(), webcams.size());
-
-		System.out.println(Thread.currentThread().getName() + ": test_getWebcams() end");
-	}
-
-	@Test
-	public void test_getDefault() {
-
-		System.out.println(Thread.currentThread().getName() + ": test_getDefault() start");
-
-		List<Webcam> webcams = Webcam.getWebcams();
-		List<WebcamDevice> devices = DummyDriver.getInstance().getDevices();
-
-		Assert.assertNotNull(Webcam.getDefault());
-		Assert.assertSame(webcams.get(0), Webcam.getDefault());
-		Assert.assertSame(devices.get(0), Webcam.getDefault().getDevice());
-
-		System.out.println(Thread.currentThread().getName() + ": test_getDefault() end");
-	}
-
-	@Test
-	public void test_open() {
-
-		System.out.println(Thread.currentThread().getName() + ": test_open() start");
-
-		Webcam webcam = Webcam.getDefault();
-		webcam.open();
-
-		Assert.assertTrue(webcam.isOpen());
-		webcam.open();
-		Assert.assertTrue(webcam.isOpen());
-
-		System.out.println(Thread.currentThread().getName() + ": test_open() end");
-	}
-
-	@Test
-	public void test_close() {
-
-		System.out.println(Thread.currentThread().getName() + ": test_close() start");
-
-		Webcam webcam = Webcam.getDefault();
-		webcam.open();
-
-		Assert.assertSame(DummyDriver.class, Webcam.getDriver().getClass());
-
-		Assert.assertTrue(webcam.isOpen());
-		webcam.close();
-		Assert.assertFalse(webcam.isOpen());
-		webcam.close();
-		Assert.assertFalse(webcam.isOpen());
-
-		System.out.println(Thread.currentThread().getName() + ": test_close() end");
-	}
-
-	@Test
-	public void test_getImage() {
-
-		System.out.println(Thread.currentThread().getName() + ": test_getImage() start");
-
-		Webcam webcam = Webcam.getDefault();
-		webcam.open();
-
-		Assert.assertSame(DummyDriver.class, Webcam.getDriver().getClass());
-
-		Image image = webcam.getImage();
-
-		Assert.assertNotNull(image);
-
-		System.out.println(Thread.currentThread().getName() + ": test_getImage() end");
-	}
-
-	@Test
-	public void test_getSizes() {
-
-		System.out.println(Thread.currentThread().getName() + ": test_getSizes() start");
-
-		Dimension[] sizes = Webcam.getDefault().getViewSizes();
-
-		Assert.assertSame(DummyDriver.class, Webcam.getDriver().getClass());
-
-		Assert.assertNotNull(sizes);
-		Assert.assertEquals(2, sizes.length);
-
-		System.out.println(Thread.currentThread().getName() + ": test_getSizes() end");
-	}
-
-	@Test
-	public void test_setSize() {
-
-		Webcam webcam = Webcam.getDefault();
-		Dimension[] sizes = webcam.getViewSizes();
-		webcam.setViewSize(sizes[0]);
-
-		Assert.assertNotNull(webcam.getViewSize());
-		Assert.assertSame(sizes[0], webcam.getViewSize());
-	}
-
-	@Test
-	public void test_setDriver() throws InstantiationException {
-
-		Webcam.setDriver(DummyDriver2.class);
-		WebcamDriver driver2 = Webcam.getDriver();
-
-		Assert.assertSame(DummyDriver2.class, driver2.getClass());
-
-		WebcamDriver driver3 = new DummyDriver3();
-		Webcam.setDriver(driver3);
-
-		Assert.assertSame(driver3, Webcam.getDriver());
-	}
-
-	@Test
-	public void test_registerDriver() {
-
-		Webcam.resetDriver();
-
-		Webcam.registerDriver(DummyDriver.class);
-		Webcam.getWebcams();
-		WebcamDriver driver = Webcam.getDriver();
-
-		Assert.assertSame(DummyDriver.class, driver.getClass());
-	}
-
-	@Test
-	public void test_GetWebcamByName() throws InstantiationException {
-		Webcam.setDriver(new DummyDriver());
-		for (Webcam webcam : Webcam.getWebcams()) {
-			Assert.assertEquals(webcam.getName(), Webcam.getWebcamByName(webcam.getName()).getName());
-		}
-	}
-
-	@Test
-	public void test_GetWebcamByNameWithNotExistingWebcamName() throws InstantiationException {
-		Webcam.setDriver(new DummyDriver());
-		Assert.assertNull(Webcam.getWebcamByName("DatCameraDoesNotExist"));
-	}
-
-	@Test(expected = IllegalArgumentException.class)
-	public void test_GetWebcamByNameWithNullArgument() throws InstantiationException {
-		Webcam.setDriver(new DummyDriver());
-		Webcam.getWebcamByName(null);
-	}
-
-}
+package com.github.sarxos.webcam;
+
+import java.awt.Dimension;
+import java.util.ArrayList;
+import java.util.Arrays;
+
+import org.easymock.EasyMock;
+import org.easymock.EasyMockRunner;
+import org.easymock.EasyMockSupport;
+import org.easymock.Mock;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+
+@RunWith(EasyMockRunner.class)
+public class WebcamTest extends EasyMockSupport {
+
+	@Mock
+	WebcamDriver driver;
+
+	@Mock
+	WebcamDevice device;
+
+	@Test
+	public void test_open() {
+
+		EasyMock
+			.expect(device.getName())
+			.andReturn("HD Mock Device")
+			.anyTimes();
+
+		EasyMock
+			.expect(device.isOpen())
+			.andReturn(false)
+			.once();
+
+		EasyMock
+			.expect(device.getResolution())
+			.andReturn(new Dimension(1024, 768))
+			.once();
+
+		device.open();
+		EasyMock
+			.expectLastCall()
+			.once();
+
+		device.dispose();
+		EasyMock
+			.expectLastCall()
+			.anyTimes();
+
+		EasyMock
+			.expect(driver.getDevices())
+			.andReturn(new ArrayList<WebcamDevice>(Arrays.asList(device)))
+			.anyTimes();
+
+		EasyMock
+			.expect(driver.isThreadSafe())
+			.andReturn(true)
+			.anyTimes();
+
+		replayAll();
+
+		Webcam.setDriver(driver);
+
+		Webcam webcam = Webcam.getDefault();
+		webcam.open();
+
+		verifyAll();
+	}
+}