- Supported platforms are Linux (x86 32/64 bit, ARM 32 bit), - OS X (x86 32/64 bit) and + Supported platforms are Linux (x86 32/64 bit, ARM 32/64 bit), + OS X (x86 64 bit) and Windows (x86 32/64 bit). But other platforms may work - as well (as long as they have at least Java 6 and are supported by + as well (as long as they have at least Java 6 and are supported by libusb) by compiling the JNI library manually.
- +- When you are using Maven then you can add the necessary dependencies + When you are using Maven then you can add the necessary dependencies like this:
-<repositories> - <repository> - <id>ailis</id> - <name>Ailis Maven Releases</name> - <url>http://nexus.ailis.de/content/groups/public/</url> - </repository> -</repositories> - -<-- For using just usb4java without javax-usb --> +- +<-- For using just usb4java without javax-usb --> <dependencies> <dependency> <groupId>${project.groupId}</groupId> @@ -66,50 +52,63 @@ <dependency> <groupId>${project.groupId}</groupId> <artifactId>${project.artifactId}-javax</artifactId> - <version>${usb4javaJavaxVersion}</version> + <version>${project.version}</version> </dependency> </dependencies>- + - This library is free software: you can redistribute it and/or modify - it under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation, either version 3 of the - License, or (at your option) any later version. + Copyright (C) 2011 Klaus Reimer, k@ailis.de
+ +
+ Copyright (C) 2013 Luca Longinotti, l@longi.li ++ Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: +
++ The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software.
- This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Lesser General Public License for more - details. + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE.
- + - Read the quick start guide and the + Read the quick start guide and the FAQ. There are also some low-level (libusb) examples - and + and high-level (javax-usb) examples available.
diff --git a/src/test/java/org/usb4java/DeviceListIteratorTest.java b/src/test/java/org/usb4java/DeviceListIteratorTest.java index a78f057..212735a 100644 --- a/src/test/java/org/usb4java/DeviceListIteratorTest.java +++ b/src/test/java/org/usb4java/DeviceListIteratorTest.java @@ -24,7 +24,7 @@ public class DeviceListIteratorTest { /** The test subject. */ private DeviceListIterator iterator; - + /** * Setup test. */ @@ -51,11 +51,11 @@ public void tearDown() LibUsb.exit(null); } } - + /** * Tests the {@link DeviceListIterator#hasNext()} method. It just checks * that this call doesn't crash because we can't assume that a device is - * connected at all. + * connected at all. */ @Test public void testHasNext() @@ -63,7 +63,7 @@ public void testHasNext() assumeUsbTestsEnabled(); this.iterator.hasNext(); } - + /** * Tests the {@link DeviceListIterator#next()} method. */ @@ -74,21 +74,23 @@ public void testNext() while (this.iterator.hasNext()) { assertNotNull(this.iterator.next()); - } + } } - + /** * Ensures that {@link DeviceListIterator#next()} method throws * a {@link NoSuchElementException} when accessing elements after the end */ @Test(expected = NoSuchElementException.class) - public void testNextAfterend() + public void testNextAfterEnd() { assumeUsbTestsEnabled(); - while (this.iterator.hasNext()) this.iterator.next(); + while (this.iterator.hasNext()) { + this.iterator.next(); + } this.iterator.next(); } - + /** * Ensures that {@link DeviceListIterator#remove()} throws an exception * because the list is read-only. @@ -96,6 +98,7 @@ public void testNextAfterend() @Test(expected = UnsupportedOperationException.class) public void testRemove() { + assumeUsbTestsEnabled(); this.iterator.remove(); } } diff --git a/src/test/java/org/usb4java/DeviceListTest.java b/src/test/java/org/usb4java/DeviceListTest.java index 090abdc..5a0bd1b 100644 --- a/src/test/java/org/usb4java/DeviceListTest.java +++ b/src/test/java/org/usb4java/DeviceListTest.java @@ -76,7 +76,7 @@ public void testEquals() LibUsb.freeDeviceList(b, true); } } - + /** * Tests the {@link DeviceList#hashCode()} method. */ @@ -95,7 +95,7 @@ public void testHashCode() LibUsb.freeDeviceList(list, true); } } - + /** * Tests the {@link DeviceList#toString()} method */ @@ -115,7 +115,7 @@ public void testToString() LibUsb.freeDeviceList(list, true); } } - + /** * Tests the {@link DeviceList#getPointer()} method */ diff --git a/src/test/java/org/usb4java/LibUsbDeviceTest.java b/src/test/java/org/usb4java/LibUsbDeviceTest.java index 85356bb..6253ee5 100644 --- a/src/test/java/org/usb4java/LibUsbDeviceTest.java +++ b/src/test/java/org/usb4java/LibUsbDeviceTest.java @@ -9,8 +9,11 @@ import static org.usb4java.test.UsbAssume.isUsbTestsEnabled; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; import static org.junit.Assert.fail; +import static org.junit.Assume.assumeFalse; import static org.junit.Assume.assumeNotNull; import java.nio.ByteBuffer; @@ -38,7 +41,7 @@ */ public class LibUsbDeviceTest { - /** The libusb contxet. */ + /** The libusb context. */ private Context context; /** The device to run the tests on. */ @@ -120,7 +123,7 @@ private Device findTestDevice() { final InterfaceDescriptor ifaceDescriptor = iface .altsetting()[k]; - if (ifaceDescriptor.bNumEndpoints() > 1) + if (ifaceDescriptor.bNumEndpoints() > 0) { this.endpoint = ifaceDescriptor.endpoint()[0] .bEndpointAddress(); @@ -193,7 +196,7 @@ public void testGetPortNumbers() assumeNotNull(this.device); final ByteBuffer path = BufferUtils.allocateByteBuffer(8); final int result = LibUsb.getPortNumbers(this.device, path); - assertTrue(result > 0); + assertTrue(result >= 0); assertTrue(result <= path.capacity()); } @@ -208,7 +211,7 @@ public void testGetPortNumbersWithTooSmallBuffer() assumeNotNull(this.device); final ByteBuffer path = BufferUtils.allocateByteBuffer(0); final int result = LibUsb.getPortNumbers(this.device, path); - assertEquals(LibUsb.ERROR_OVERFLOW, result); + assertEquals(LibUsb.ERROR_INVALID_PARAM, result); } /** @@ -436,7 +439,7 @@ public void testUnrefDeviceWithoutDevice() * Tests the {@link LibUsb#open(Device, DeviceHandle)} method. This can't be * really tested in a simple unit test like this. Most likely the user has * no access to the device. So this test succeeds on SUCCESS and on - * ERROR_ACCESS. At least we have to make sure then open() method doesn't + * ERROR_ACCESS. At least we have to make sure that the open() method doesn't * crash. */ @Test @@ -785,7 +788,7 @@ private void validateInterfaceDescriptor(final InterfaceDescriptor desc) } /** - * Validates the specified endpoint desriptor. + * Validates the specified endpoint descriptor. * * @param desc * The endpoint descriptor to validate. @@ -1212,4 +1215,114 @@ public void testGetAndFreeDeviceListWithDefaultContext() LibUsb.exit(null); } } + + /** + * Tests the {@link LibUsb#getPollfds()} and {@link LibUsb#freePollfds()} methods. + */ + @Test + public void testGetAndFreePollfds() + { + assumeUsbTestsEnabled(); + + final Pollfds pollfds = LibUsb.getPollfds(this.context); + try { + if (System.getProperty("os.name").toLowerCase().contains("windows")) { + assertNull(pollfds); + } else { + assertNotNull(pollfds); + assertTrue("Size must be >= 0", pollfds.getSize() >= 0); + int i = 0; + for (Pollfd pollfd : pollfds) { + assertEquals(pollfds.get(i), pollfd); + assertTrue("File descriptor must be > 0", pollfd.fd() > 0); + assertTrue("Events must be > 0", pollfd.events() > 0); + i++; + } + } + } finally { + LibUsb.freePollfds(pollfds); + } + } + + /** + * Tests the {@link LibUsb#getPollfds()} and {@link LibUsb#freePollfds()} methods with the default context. + */ + @Test + public void testGetAndFreePollfdsWithDefaultContext() + { + assumeUsbTestsEnabled(); + + assertEquals(0, LibUsb.init(null)); + try + { + final Pollfds pollfds = LibUsb.getPollfds(null); + try { + if (System.getProperty("os.name").toLowerCase().contains("windows")) { + assertNull(pollfds); + } else { + assertNotNull(pollfds); + assertTrue("Size must be >= 0", pollfds.getSize() >= 0); + int i = 0; + for (Pollfd pollfd : pollfds) { + assertEquals(pollfds.get(i), pollfd); + assertTrue("File descriptor must be > 0", pollfd.fd() > 0); + assertTrue("Events must be > 0", pollfd.events() > 0); + i++; + } + } + } finally { + LibUsb.freePollfds(pollfds); + } + } + finally + { + LibUsb.exit(null); + } + } + + /** + * Ensures that {@link LibUsb#freePollfds()} doesn't throw an error when called with null argument. + */ + @Test + public void testFreePollfdsWithNullArgument() + { + LibUsb.freePollfds(null); + } + + /** + * Ensures that {@link LibUsb#freePollfds()} doesn't crash when called twice and throws an IllegalStateException + * instead. + */ + @Test(expected = IllegalStateException.class) + public void testDoubleFreePollfds() + { + assumeFalse(System.getProperty("os.name").toLowerCase().contains("windows")); + assumeUsbTestsEnabled(); + final Pollfds pollfds = LibUsb.getPollfds(this.context); + LibUsb.freePollfds(pollfds); + LibUsb.freePollfds(pollfds); + } + + /** + * Ensures that accessing Pollfds properties after calling {@link LibUsb#freePollfds()} doesn't crash and + * throws an IllegalStateException instead. + */ + @Test(expected = IllegalStateException.class) + public void testPollfdsAccessAfterFree() + { + assumeFalse(System.getProperty("os.name").toLowerCase().contains("windows")); + assumeUsbTestsEnabled(); + assertEquals(0, LibUsb.init(null)); + try + { + final Pollfds pollfds = LibUsb.getPollfds(null); + assertNotNull(pollfds); + LibUsb.freePollfds(pollfds); + assertNotNull(pollfds.get(0)); + } + finally + { + LibUsb.exit(null); + } + } } diff --git a/src/test/java/org/usb4java/LibUsbGlobalTest.java b/src/test/java/org/usb4java/LibUsbGlobalTest.java index 84c8ecd..10c74fd 100644 --- a/src/test/java/org/usb4java/LibUsbGlobalTest.java +++ b/src/test/java/org/usb4java/LibUsbGlobalTest.java @@ -27,7 +27,7 @@ */ public class LibUsbGlobalTest { - /** The libusb contxet. */ + /** The libusb context. */ private Context context; /** @@ -63,6 +63,7 @@ public void tearDown() * Tests the {@link LibUsb#setDebug(Context, int)} method. */ @Test + @Deprecated public void testSetDebug() { assumeUsbTestsEnabled(); diff --git a/src/test/java/org/usb4java/LibUsbHotplugTest.java b/src/test/java/org/usb4java/LibUsbHotplugTest.java index 1eaadfc..dafa218 100644 --- a/src/test/java/org/usb4java/LibUsbHotplugTest.java +++ b/src/test/java/org/usb4java/LibUsbHotplugTest.java @@ -18,12 +18,12 @@ /** * Tests the hotplug part of the {@link LibUsb} class. - * + * * @author Klaus Reimer (k@ailis.de) */ public class LibUsbHotplugTest { - /** The libusb contxet. */ + /** The libusb context. */ private Context context; /** @@ -95,7 +95,7 @@ public int processEvent(Context context, Device device, } /** - * Ensures that no hotplug event is fired when enumeration is deactived. + * Ensures that no hotplug event is fired when enumeration is deactivated. * When no devices are connected then this test is pretty much useless but * won't fail because of that. */ diff --git a/src/test/java/org/usb4java/LibUsbTest.java b/src/test/java/org/usb4java/LibUsbTest.java index 34cd154..a798a33 100644 --- a/src/test/java/org/usb4java/LibUsbTest.java +++ b/src/test/java/org/usb4java/LibUsbTest.java @@ -192,6 +192,54 @@ public void testGetApiVersion() assertTrue(LibUsb.getApiVersion() >= 0x1000102); } + /** + * Tests the {@link LibUsb#setOption(Context, int, int)} method with valid options and values. + */ + @Test + public void testSetOption() + { + assumeUsbTestsEnabled(); + final Context context = new Context(); + assertEquals(LibUsb.SUCCESS, LibUsb.init(context)); + try + { + if (System.getProperty("os.name").toLowerCase().contains("windows")) { + // On Windows this is either a success when USBDK is found or ERROR_NOT_FOUND when not + final int result = LibUsb.setOption(context, LibUsb.OPTION_USE_USBDK); + assertTrue(result == LibUsb.SUCCESS || result == LibUsb.ERROR_NOT_FOUND); + } else { + // On other operating systems it is always ERROR_NOT_SUPPORTED + assertEquals(LibUsb.ERROR_NOT_SUPPORTED, LibUsb.setOption(context, LibUsb.OPTION_USE_USBDK)); + } + assertEquals(LibUsb.SUCCESS, LibUsb.setOption(context, LibUsb.OPTION_LOG_LEVEL, LibUsb.LOG_LEVEL_NONE)); + assertEquals(LibUsb.SUCCESS, LibUsb.setOption(context, LibUsb.OPTION_LOG_LEVEL, LibUsb.LOG_LEVEL_DEBUG)); + } + finally + { + LibUsb.exit(context); + } + } + + /** + * Tests the {@link LibUsb#setOption(Context, int, int)} method with invalid options and values. + */ + @Test + public void testSetOptionWithInvalidParameters() + { + assumeUsbTestsEnabled(); + final Context context = new Context(); + assertEquals(LibUsb.SUCCESS, LibUsb.init(context)); + try + { + assertEquals(LibUsb.ERROR_INVALID_PARAM, LibUsb.setOption(context, LibUsb.OPTION_LOG_LEVEL, 234)); + assertEquals(LibUsb.ERROR_INVALID_PARAM, LibUsb.setOption(context, 123)); + } + finally + { + LibUsb.exit(context); + } + } + /** * Tests the initialization and deinitialization of libusb with default * context. @@ -254,6 +302,7 @@ public void testExitWithUninitializedContext() * context */ @Test(expected = IllegalStateException.class) + @Deprecated public void testSetDebugWithUninitializedContext() { assumeUsbTestsEnabled(); @@ -262,8 +311,60 @@ public void testSetDebugWithUninitializedContext() } /** - * Tests {@link LibUsb#getDeviceList(Context, DeviceList)} method with - * uninitialized USB context. + * Tests {@link LibUsb#setOption(Context, int, int)} method with uninitialized USB context. + */ + @Test(expected = IllegalStateException.class) + @Deprecated + public void testSetOptionWithUninitializedContext() + { + assumeUsbTestsEnabled(); + final Context context = new Context(); + LibUsb.setOption(context, 0); + } + + /** + * Tests {@link LibUsb#getDeviceList(Context, DeviceList)} method. + */ + @Test + public void testGetDeviceList() + { + assumeUsbTestsEnabled(); + final Context context = new Context(); + final DeviceList deviceList = new DeviceList(); + LibUsb.init(context); + try + { + assertTrue(LibUsb.getDeviceList(context, deviceList) >= 0); + LibUsb.freeDeviceList(deviceList, true); + } + finally + { + LibUsb.exit(context); + } + } + + /** + * Tests {@link LibUsb#getDeviceList(Context, DeviceList)} method with the default context. + */ + @Test + public void testGetDeviceListFromDefaultContext() + { + assumeUsbTestsEnabled(); + final DeviceList deviceList = new DeviceList(); + LibUsb.init(null); + try + { + assertTrue(LibUsb.getDeviceList(null, deviceList) >= 0); + LibUsb.freeDeviceList(deviceList, true); + } + finally + { + LibUsb.exit(null); + } + } + + /** + * Tests {@link LibUsb#getDeviceList(Context, DeviceList)} method with uninitialized USB context. */ @Test(expected = IllegalStateException.class) public void testGetDeviceListWithUninitializedContext() @@ -273,6 +374,16 @@ public void testGetDeviceListWithUninitializedContext() LibUsb.getDeviceList(context, new DeviceList()); } + /** + * Tests {@link LibUsb#getDeviceList(Context, DeviceList)} method with uninitialized default USB context. + */ + @Test(expected = IllegalStateException.class) + public void testGetDeviceListWithUninitializedDefaultContext() + { + assumeUsbTestsEnabled(); + LibUsb.getDeviceList(null, new DeviceList()); + } + /** * Tests {@link LibUsb#freeDeviceList(DeviceList, boolean)} method with * uninitialized list. @@ -1052,6 +1163,17 @@ public void testEventHandlerActiveWithUninitializedContext() LibUsb.eventHandlerActive(context); } + /** + * Tests {@link LibUsb#interruptEventHandler(Context)} with uninitialized USB context. + */ + @Test(expected = IllegalStateException.class) + public void testInterruptEventHandlerWithUninitializedContext() + { + assumeUsbTestsEnabled(); + final Context context = new Context(); + LibUsb.interruptEventHandler(context); + } + /** * Tests {@link LibUsb#lockEventWaiters(Context)} with uninitialized USB * context. @@ -1210,45 +1332,71 @@ public void testPollFdNotifiers() final PollfdListenerMock listener = new PollfdListenerMock(); final Context context = new Context(); LibUsb.init(context); - LibUsb.setPollfdNotifiers(context, listener, "test"); - - FileDescriptor fd = new FileDescriptor(); - LibUsb.triggerPollfdAdded(fd, 53, context.getPointer()); - assertEquals(53, listener.addedEvents); - assertSame(fd, listener.addedFd); - assertSame("test", listener.addedUserData); - assertNull(listener.removedFd); - assertNull(listener.removedUserData); - - listener.reset(); - - fd = new FileDescriptor(); - LibUsb.triggerPollfdRemoved(fd, context.getPointer()); - assertEquals(0, listener.addedEvents); - assertNull(listener.addedFd); - assertNull(listener.addedUserData); - assertSame(fd, listener.removedFd); - assertSame("test", listener.removedUserData); - - LibUsb.setPollfdNotifiers(context, null, null); - listener.reset(); - - fd = new FileDescriptor(); - LibUsb.triggerPollfdAdded(fd, 53, context.getPointer()); - assertEquals(0, listener.addedEvents); - assertNull(listener.addedFd); - assertNull(listener.addedUserData); - assertNull(listener.removedFd); - assertNull(listener.removedUserData); - - listener.reset(); - - fd = new FileDescriptor(); - LibUsb.triggerPollfdRemoved(fd, context.getPointer()); - assertEquals(0, listener.addedEvents); - assertNull(listener.addedFd); - assertNull(listener.addedUserData); - assertNull(listener.removedFd); - assertNull(listener.removedUserData); + try + { + LibUsb.setPollfdNotifiers(context, listener, "test"); + + FileDescriptor fd = new FileDescriptor(); + LibUsb.triggerPollfdAdded(fd, 53, context.getPointer()); + assertEquals(53, listener.addedEvents); + assertSame(fd, listener.addedFd); + assertSame("test", listener.addedUserData); + assertNull(listener.removedFd); + assertNull(listener.removedUserData); + + listener.reset(); + + fd = new FileDescriptor(); + LibUsb.triggerPollfdRemoved(fd, context.getPointer()); + assertEquals(0, listener.addedEvents); + assertNull(listener.addedFd); + assertNull(listener.addedUserData); + assertSame(fd, listener.removedFd); + assertSame("test", listener.removedUserData); + + LibUsb.setPollfdNotifiers(context, null, null); + listener.reset(); + + fd = new FileDescriptor(); + LibUsb.triggerPollfdAdded(fd, 53, context.getPointer()); + assertEquals(0, listener.addedEvents); + assertNull(listener.addedFd); + assertNull(listener.addedUserData); + assertNull(listener.removedFd); + assertNull(listener.removedUserData); + + listener.reset(); + + fd = new FileDescriptor(); + LibUsb.triggerPollfdRemoved(fd, context.getPointer()); + assertEquals(0, listener.addedEvents); + assertNull(listener.addedFd); + assertNull(listener.addedUserData); + assertNull(listener.removedFd); + assertNull(listener.removedUserData); + } + finally + { + LibUsb.exit(context); + } + } + + /** + * Tests the {@link LibUsb#interruptEventHandler(Context)} method. Must not crash. + */ + @Test + public void testInterruptEventHandler() + { + assumeUsbTestsEnabled(); + final Context context = new Context(); + assertEquals(LibUsb.SUCCESS, LibUsb.init(context)); + try + { + LibUsb.interruptEventHandler(context); + } + finally + { + LibUsb.exit(context); + } } } diff --git a/src/test/java/org/usb4java/TransferTest.java b/src/test/java/org/usb4java/TransferTest.java index facb0e8..c2d852e 100644 --- a/src/test/java/org/usb4java/TransferTest.java +++ b/src/test/java/org/usb4java/TransferTest.java @@ -30,7 +30,7 @@ */ public class TransferTest { - /** The libusb contxet. */ + /** The libusb context. */ private Context context; /** diff --git a/src/test/java/org/usb4java/test/UsbAssume.java b/src/test/java/org/usb4java/test/UsbAssume.java index 1b9f22f..7445ce8 100644 --- a/src/test/java/org/usb4java/test/UsbAssume.java +++ b/src/test/java/org/usb4java/test/UsbAssume.java @@ -15,7 +15,7 @@ /** * USB-related assumptions. - * + * * @author Klaus Reimer (k@ailis.de) */ public class UsbAssume @@ -25,16 +25,16 @@ public class UsbAssume /** If TCK tests are to be executed. */ private static Boolean tckTests; - + /** * Check if USB tests are enabled. - * + * * USB tests can be controlled with the system property USB_TESTS. When * set to true then USB tests are always run, if set to false then they * are never run. If this property is not set then the command-line tool * lsusb is called. If this tool returned at least two lines of text then * USB tests are enabled. In all other cases they are disabled. - * + * * @return True if USB tests are enabled, false if not. */ public static boolean isUsbTestsEnabled() @@ -86,7 +86,7 @@ public static boolean isUsbTestsEnabled() * Assume that USB tests are enabled. Call this in the first line of * tests method or preparation methods when you want to ignore the * tests when the system is not able to run the tests anyway. - * + * * USB tests can be controlled with the system property USB_TESTS. When * set to true then USB tests are always run, if set to false then they * are never run. If this property is not set then the command-line tool @@ -117,7 +117,7 @@ public static void assumeHotplugAvailable() * Assume that TCK tests are enabled. Call this in the first line of * tests method or preparation methods when you want to ignore the * tests when the system is not able to run the TCK tests anyway. - * + * * TCK tests can be controlled with the system property TCK_TESTS. When * set to true then TCK tests are always run, if set to false then they * are never run. If this property is not set then the command-line tool - For questions and discussions please use the - usb4java mailing list + For questions and discussions please use the + usb4java mailing list (Google group). - You can subscribe to it via email by sending a mail to + You can subscribe to it via email by sending a mail to usb4java+subscribe@googlegroups.com.
-+
If you have found a bug in the software or this web site (even if it's just a typo) then please create - an issue on GitHub. + an issue on GitHub.