From f53d699725f15a8bb356b6afa81f27937db54173 Mon Sep 17 00:00:00 2001 From: Mark Nolan Date: Thu, 1 Oct 2026 11:45:02 +0100 Subject: [PATCH] DEV-1124: honour the hardware in ShimmerVerObject.compareVersions The static compareVersions(svo, hardwareVersion, fwId, ...) and the instance compareVersions(hardwareVersion, fwId, ...) that delegates to it never passed the hardware on, so a gate written as "Shimmer3 LogAndStream >= x" also matched a Shimmer3R. The two platforms' LogAndStream versions overlap, which is exactly where the hardware check matters. It now calls the hardware-aware UtilShimmer.compareVersions, where ANY_VERSION still matches every hardware. No existing caller changes result: each already checks isShimmerGen3() or isShimmerGen3R() alongside, or uses firmware that exists on only one hardware. API_00023 covers both overloads, ANY_VERSION, and the one gate that reached it with a hardware it relied on being ignored (isSupportedDerivedSensors). Co-Authored-By: Claude Opus 5.5 --- .../driverUtilities/ShimmerVerObject.java | 9 ++- ...0023_ShimmerVerObjectHardwareGateTest.java | 79 +++++++++++++++++++ 2 files changed, 86 insertions(+), 2 deletions(-) create mode 100644 ShimmerDriver/src/test/java/com/shimmerresearch/driverUtilities/API_00023_ShimmerVerObjectHardwareGateTest.java diff --git a/ShimmerDriver/src/main/java/com/shimmerresearch/driverUtilities/ShimmerVerObject.java b/ShimmerDriver/src/main/java/com/shimmerresearch/driverUtilities/ShimmerVerObject.java index 19299843f..05c046afd 100644 --- a/ShimmerDriver/src/main/java/com/shimmerresearch/driverUtilities/ShimmerVerObject.java +++ b/ShimmerDriver/src/main/java/com/shimmerresearch/driverUtilities/ShimmerVerObject.java @@ -692,9 +692,14 @@ public static boolean compareVersions(ShimmerVerObject svo, int firmwareIdentifi firmwareIdentifier, firmwareVersionMajor, firmwareVersionMinor, firmwareVersionInternal); } + /** Hardware-aware: a hardwareVersion other than + * {@link ShimmerVerDetails#ANY_VERSION} must match the device's. This + * matters because Shimmer3 and Shimmer3R LogAndStream version numbers + * overlap, so the firmware version alone cannot tell them apart. Until + * DEV-1124 the hardware argument was silently ignored. */ public static boolean compareVersions(ShimmerVerObject svo, int hardwareVersion, int firmwareIdentifier, int firmwareVersionMajor, int firmwareVersionMinor, int firmwareVersionInternal) { - return UtilShimmer.compareVersions(svo.getFirmwareIdentifier(), svo.getFirmwareVersionMajor(), svo.getFirmwareVersionMinor(), svo.getFirmwareVersionInternal(), - firmwareIdentifier, firmwareVersionMajor, firmwareVersionMinor, firmwareVersionInternal); + return UtilShimmer.compareVersions(svo.getHardwareVersion(), svo.getFirmwareIdentifier(), svo.getFirmwareVersionMajor(), svo.getFirmwareVersionMinor(), svo.getFirmwareVersionInternal(), + hardwareVersion, firmwareIdentifier, firmwareVersionMajor, firmwareVersionMinor, firmwareVersionInternal); } public int getShimmerExpansionBoardId() { diff --git a/ShimmerDriver/src/test/java/com/shimmerresearch/driverUtilities/API_00023_ShimmerVerObjectHardwareGateTest.java b/ShimmerDriver/src/test/java/com/shimmerresearch/driverUtilities/API_00023_ShimmerVerObjectHardwareGateTest.java new file mode 100644 index 000000000..37a3a1dd7 --- /dev/null +++ b/ShimmerDriver/src/test/java/com/shimmerresearch/driverUtilities/API_00023_ShimmerVerObjectHardwareGateTest.java @@ -0,0 +1,79 @@ +package com.shimmerresearch.driverUtilities; + +import static org.junit.Assert.*; + +import org.junit.Test; + +import com.shimmerresearch.driver.ShimmerDevice; +import com.shimmerresearch.driverUtilities.ShimmerVerDetails.FW_ID; +import com.shimmerresearch.driverUtilities.ShimmerVerDetails.HW_ID; + +/** + * The hardware-taking {@link ShimmerVerObject#compareVersions} overloads must + * check the hardware. Shimmer3 and Shimmer3R LogAndStream version numbers + * overlap (both FW_ID 3), so a "Shimmer3R LogAndStream >= x" gate built on a + * version comparison alone would also match a Shimmer3 - which is what these + * overloads did until DEV-1124. + * + * @author Mark Nolan + */ +public class API_00023_ShimmerVerObjectHardwareGateTest { + + private static final int ANY = ShimmerVerDetails.ANY_VERSION; + + private static ShimmerVerObject shimmer3(int major, int minor, int internal) { + return new ShimmerVerObject(HW_ID.SHIMMER_3, FW_ID.LOGANDSTREAM, major, minor, internal); + } + + private static ShimmerVerObject shimmer3r(int major, int minor, int internal) { + return new ShimmerVerObject(HW_ID.SHIMMER_3R, FW_ID.LOGANDSTREAM, major, minor, internal); + } + + @Test + public void staticOverloadRejectsOtherHardware() { + ShimmerVerObject s3 = shimmer3(1, 1, 5); + ShimmerVerObject s3r = shimmer3r(1, 1, 17); + + assertTrue(ShimmerVerObject.compareVersions(s3, HW_ID.SHIMMER_3, FW_ID.LOGANDSTREAM, 1, 1, 5)); + assertFalse("a Shimmer3 must not pass a Shimmer3R gate", + ShimmerVerObject.compareVersions(s3, HW_ID.SHIMMER_3R, FW_ID.LOGANDSTREAM, 1, 1, 5)); + + assertTrue(ShimmerVerObject.compareVersions(s3r, HW_ID.SHIMMER_3R, FW_ID.LOGANDSTREAM, 1, 1, 17)); + assertFalse("a Shimmer3R must not pass a Shimmer3 gate", + ShimmerVerObject.compareVersions(s3r, HW_ID.SHIMMER_3, FW_ID.LOGANDSTREAM, 1, 1, 17)); + } + + @Test + public void instanceOverloadRejectsOtherHardware() { + assertTrue(shimmer3(1, 1, 5).compareVersions(HW_ID.SHIMMER_3, FW_ID.LOGANDSTREAM, 1, 0, 4)); + assertFalse(shimmer3(1, 1, 5).compareVersions(HW_ID.SHIMMER_3R, FW_ID.LOGANDSTREAM, 1, 0, 40)); + assertTrue(shimmer3r(1, 1, 17).compareVersions(HW_ID.SHIMMER_3R, FW_ID.LOGANDSTREAM, 1, 0, 40)); + assertFalse(shimmer3r(1, 1, 17).compareVersions(HW_ID.SHIMMER_3, FW_ID.LOGANDSTREAM, 1, 0, 4)); + } + + @Test + public void anyVersionHardwareMatchesBoth() { + assertTrue(ShimmerVerObject.compareVersions(shimmer3(1, 1, 5), ANY, FW_ID.LOGANDSTREAM, 1, 1, 5)); + assertTrue(ShimmerVerObject.compareVersions(shimmer3r(1, 1, 17), ANY, FW_ID.LOGANDSTREAM, 1, 1, 17)); + } + + @Test + public void versionAndFirmwareStillDecide() { + // The right hardware is necessary, not sufficient. + assertFalse("older than the gate", + ShimmerVerObject.compareVersions(shimmer3(1, 1, 5), HW_ID.SHIMMER_3, FW_ID.LOGANDSTREAM, 1, 1, 6)); + assertFalse("different firmware", + ShimmerVerObject.compareVersions(shimmer3(1, 1, 5), HW_ID.SHIMMER_3, FW_ID.BTSTREAM, 0, 7, 0)); + } + + @Test + public void existingDerivedSensorsGateUnchanged() { + // isSupportedDerivedSensors is the one existing gate that reaches the + // static overload with a hardware it relied on not being checked; it + // also ORs isShimmerGen3R(), so both platforms must still pass. + assertTrue(ShimmerDevice.isSupportedDerivedSensors(shimmer3(0, 3, 17))); + assertTrue(ShimmerDevice.isSupportedDerivedSensors(shimmer3(1, 1, 5))); + assertTrue(ShimmerDevice.isSupportedDerivedSensors(shimmer3r(1, 0, 0))); + assertFalse(ShimmerDevice.isSupportedDerivedSensors(shimmer3(0, 3, 16))); + } +}