Skip to content

JNI Mockability Layer for Unit Testing #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
millerjp merged 2 commits into from
Nov 26, 2025
Merged

JNI Mockability Layer for Unit Testing #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c751382
Step 3: Implement JNI mockability layer for unit testing
millerjp Nov 26, 2025
ef41e08
Rename JNI adapter classes for clearer semantics
millerjp Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions libre2-core/src/main/java/com/axonops/libre2/api/Matcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

package com.axonops.libre2.api;

import com.axonops.libre2.jni.RE2NativeJNI;
import com.axonops.libre2.metrics.RE2MetricsRegistry;
import com.axonops.libre2.metrics.MetricNames;

Expand Down Expand Up @@ -73,7 +72,7 @@ public boolean matches() {

long startNanos = System.nanoTime();

boolean result = RE2NativeJNI.fullMatch(pattern.getNativeHandle(), input);
boolean result = pattern.jni.fullMatch(pattern.getNativeHandle(), input);

long durationNanos = System.nanoTime() - startNanos;
metrics.recordTimer(MetricNames.MATCHING_FULL_MATCH_LATENCY, durationNanos);
Expand All @@ -87,7 +86,7 @@ public boolean find() {

long startNanos = System.nanoTime();

boolean result = RE2NativeJNI.partialMatch(pattern.getNativeHandle(), input);
boolean result = pattern.jni.partialMatch(pattern.getNativeHandle(), input);

long durationNanos = System.nanoTime() - startNanos;
metrics.recordTimer(MetricNames.MATCHING_PARTIAL_MATCH_LATENCY, durationNanos);
Expand Down
97 changes: 55 additions & 42 deletions libre2-core/src/main/java/com/axonops/libre2/api/Pattern.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@

import com.axonops.libre2.cache.PatternCache;
import com.axonops.libre2.cache.RE2Config;
import com.axonops.libre2.jni.RE2Native;
import com.axonops.libre2.jni.IRE2Native;
import com.axonops.libre2.jni.RE2LibraryLoader;
import com.axonops.libre2.jni.RE2NativeJNI;
import com.axonops.libre2.metrics.MetricNames;
import com.axonops.libre2.metrics.RE2MetricsRegistry;
import com.axonops.libre2.util.PatternHasher;
Expand Down Expand Up @@ -77,18 +78,22 @@ public static PatternCache getGlobalCache() {
private static final int maxMatchersPerPattern = RE2Config.DEFAULT.maxMatchersPerPattern();
private final long nativeMemoryBytes;

// JniAdapter for all JNI calls - allows mocking in tests
final IRE2Native jni;

Pattern(String patternString, boolean caseSensitive, long nativeHandle) {
this(patternString, caseSensitive, nativeHandle, false);
this(patternString, caseSensitive, nativeHandle, false, RE2Native.INSTANCE);
}

Pattern(String patternString, boolean caseSensitive, long nativeHandle, boolean fromCache) {
Pattern(String patternString, boolean caseSensitive, long nativeHandle, boolean fromCache, IRE2Native jni) {
this.patternString = Objects.requireNonNull(patternString);
this.caseSensitive = caseSensitive;
this.nativeHandle = nativeHandle;
this.fromCache = fromCache;
this.jni = jni;

// Query native memory size
this.nativeMemoryBytes = RE2NativeJNI.patternMemory(nativeHandle);
// Query native memory size using adapter
this.nativeMemoryBytes = jni.patternMemory(nativeHandle);

logger.trace("RE2: Pattern created - length: {}, caseSensitive: {}, fromCache: {}, nativeBytes: {}",
patternString.length(), caseSensitive, fromCache, nativeMemoryBytes);
Expand Down Expand Up @@ -128,21 +133,29 @@ public static Pattern compileWithoutCache(String pattern) {
*/
public static Pattern compileWithoutCache(String pattern, boolean caseSensitive) {
// Compile with fromCache=false so it can actually be closed
return doCompile(pattern, caseSensitive, false);
return doCompile(pattern, caseSensitive, false, RE2Native.INSTANCE);
}

/**
* Compiles a pattern for caching (internal use).
*/
private static Pattern compileUncached(String pattern, boolean caseSensitive) {
// Compile with fromCache=true so users can't close it (cache manages it)
return doCompile(pattern, caseSensitive, true);
return doCompile(pattern, caseSensitive, true, RE2Native.INSTANCE);
}

/**
* Package-private compile method for test injection of mock JniAdapter.
* Bypasses cache for full control in unit tests.
*/
static Pattern compileForTesting(String pattern, boolean caseSensitive, IRE2Native jni) {
return doCompile(pattern, caseSensitive, false, jni);
}

/**
* Actual compilation logic.
*/
private static Pattern doCompile(String pattern, boolean caseSensitive, boolean fromCache) {
private static Pattern doCompile(String pattern, boolean caseSensitive, boolean fromCache, IRE2Native jni) {
RE2MetricsRegistry metrics = cache.getConfig().metricsRegistry();
String hash = PatternHasher.hash(pattern);

Expand All @@ -160,10 +173,10 @@ private static Pattern doCompile(String pattern, boolean caseSensitive, boolean
boolean compilationSuccessful = false;

try {
handle = RE2NativeJNI.compile(pattern, caseSensitive);
handle = jni.compile(pattern, caseSensitive);

if (handle == 0 || !RE2NativeJNI.patternOk(handle)) {
String error = RE2NativeJNI.getError();
if (handle == 0 || !jni.patternOk(handle)) {
String error = jni.getError();

// Compilation failed - record error
metrics.incrementCounter(MetricNames.ERRORS_COMPILATION_FAILED);
Expand All @@ -177,7 +190,7 @@ private static Pattern doCompile(String pattern, boolean caseSensitive, boolean
metrics.recordTimer(MetricNames.PATTERNS_COMPILATION_LATENCY, durationNanos);
metrics.incrementCounter(MetricNames.PATTERNS_COMPILED);

Pattern compiled = new Pattern(pattern, caseSensitive, handle, fromCache);
Pattern compiled = new Pattern(pattern, caseSensitive, handle, fromCache, jni);
logger.trace("RE2: Pattern compiled - hash: {}, length: {}, caseSensitive: {}, fromCache: {}, nativeBytes: {}, timeNs: {}",
hash, pattern.length(), caseSensitive, fromCache, compiled.nativeMemoryBytes, durationNanos);

Expand All @@ -194,7 +207,7 @@ private static Pattern doCompile(String pattern, boolean caseSensitive, boolean
// Free handle if allocated
if (handle != 0) {
try {
RE2NativeJNI.freePattern(handle);
jni.freePattern(handle);
} catch (Exception e) {
// Silently ignore - best effort cleanup
}
Expand Down Expand Up @@ -269,7 +282,7 @@ public boolean matches(long address, int length) {
}

long startNanos = System.nanoTime();
boolean result = RE2NativeJNI.fullMatchDirect(nativeHandle, address, length);
boolean result = jni.fullMatchDirect(nativeHandle, address, length);
long durationNanos = System.nanoTime() - startNanos;

// Track metrics - GLOBAL (ALL) + SPECIFIC (Zero-Copy)
Expand Down Expand Up @@ -332,7 +345,7 @@ public boolean find(long address, int length) {
}

long startNanos = System.nanoTime();
boolean result = RE2NativeJNI.partialMatchDirect(nativeHandle, address, length);
boolean result = jni.partialMatchDirect(nativeHandle, address, length);
long durationNanos = System.nanoTime() - startNanos;

// Track metrics - GLOBAL (ALL) + SPECIFIC (Zero-Copy)
Expand Down Expand Up @@ -398,7 +411,7 @@ public MatchResult match(String input) {

long startNanos = System.nanoTime();

String[] groups = RE2NativeJNI.extractGroups(nativeHandle, input);
String[] groups = jni.extractGroups(nativeHandle, input);

if (groups == null) {
// No match - still track metrics (operation was attempted)
Expand Down Expand Up @@ -487,7 +500,7 @@ public MatchResult find(String input) {
long startNanos = System.nanoTime();

// RE2 extractGroups does UNANCHORED match, so it finds first occurrence
String[] groups = RE2NativeJNI.extractGroups(nativeHandle, input);
String[] groups = jni.extractGroups(nativeHandle, input);

long durationNanos = System.nanoTime() - startNanos;

Expand Down Expand Up @@ -556,7 +569,7 @@ public java.util.List<MatchResult> findAll(String input) {

long startNanos = System.nanoTime();

String[][] allMatches = RE2NativeJNI.findAllMatches(nativeHandle, input);
String[][] allMatches = jni.findAllMatches(nativeHandle, input);

long durationNanos = System.nanoTime() - startNanos;
int matchCount = (allMatches != null) ? allMatches.length : 0;
Expand Down Expand Up @@ -633,7 +646,7 @@ public MatchResult[] matchAllWithGroups(String[] inputs) {
MatchResult[] results = new MatchResult[inputs.length];

for (int i = 0; i < inputs.length; i++) {
String[] groups = RE2NativeJNI.extractGroups(nativeHandle, inputs[i]);
String[] groups = jni.extractGroups(nativeHandle, inputs[i]);
if (groups != null && groups.length > 0) {
results[i] = new MatchResult(inputs[i], groups, namedGroupMap);
} else {
Expand Down Expand Up @@ -699,7 +712,7 @@ public MatchResult match(long address, int length) {

long startNanos = System.nanoTime();

String[] groups = RE2NativeJNI.extractGroupsDirect(nativeHandle, address, length);
String[] groups = jni.extractGroupsDirect(nativeHandle, address, length);

long durationNanos = System.nanoTime() - startNanos;

Expand Down Expand Up @@ -758,7 +771,7 @@ public MatchResult match(ByteBuffer buffer) {
* Helper: Get named groups map for this pattern (lazy-loaded and cached).
*/
private Map<String, Integer> getNamedGroupsMap() {
String[] namedGroupsArray = RE2NativeJNI.getNamedGroups(nativeHandle);
String[] namedGroupsArray = jni.getNamedGroups(nativeHandle);

if (namedGroupsArray == null || namedGroupsArray.length == 0) {
return Collections.emptyMap();
Expand Down Expand Up @@ -798,7 +811,7 @@ public MatchResult matchWithGroups(long address, int length) {
}

long startNanos = System.nanoTime();
String[] groups = RE2NativeJNI.extractGroupsDirect(nativeHandle, address, length);
String[] groups = jni.extractGroupsDirect(nativeHandle, address, length);
long durationNanos = System.nanoTime() - startNanos;

// Track metrics - GLOBAL (ALL) + SPECIFIC (Zero-Copy)
Expand Down Expand Up @@ -862,7 +875,7 @@ public MatchResult findWithGroups(long address, int length) {
}

long startNanos = System.nanoTime();
String[] groups = RE2NativeJNI.extractGroupsDirect(nativeHandle, address, length);
String[] groups = jni.extractGroupsDirect(nativeHandle, address, length);
long durationNanos = System.nanoTime() - startNanos;

RE2MetricsRegistry metrics = cache.getConfig().metricsRegistry();
Expand Down Expand Up @@ -925,7 +938,7 @@ public java.util.List<MatchResult> findAllWithGroups(long address, int length) {
}

long startNanos = System.nanoTime();
String[][] allMatches = RE2NativeJNI.findAllMatchesDirect(nativeHandle, address, length);
String[][] allMatches = jni.findAllMatchesDirect(nativeHandle, address, length);
long durationNanos = System.nanoTime() - startNanos;

int matchCount = (allMatches != null) ? allMatches.length : 0;
Expand Down Expand Up @@ -1021,7 +1034,7 @@ public String replaceFirst(String input, String replacement) {

long startNanos = System.nanoTime();

String result = RE2NativeJNI.replaceFirst(nativeHandle, input, replacement);
String result = jni.replaceFirst(nativeHandle, input, replacement);

long durationNanos = System.nanoTime() - startNanos;

Expand Down Expand Up @@ -1083,7 +1096,7 @@ public String replaceAll(String input, String replacement) {

long startNanos = System.nanoTime();

String result = RE2NativeJNI.replaceAll(nativeHandle, input, replacement);
String result = jni.replaceAll(nativeHandle, input, replacement);

long durationNanos = System.nanoTime() - startNanos;

Expand Down Expand Up @@ -1138,7 +1151,7 @@ public String[] replaceAll(String[] inputs, String replacement) {

long startNanos = System.nanoTime();

String[] results = RE2NativeJNI.replaceAllBulk(nativeHandle, inputs, replacement);
String[] results = jni.replaceAllBulk(nativeHandle, inputs, replacement);

long durationNanos = System.nanoTime() - startNanos;
long perItemNanos = durationNanos / inputs.length;
Expand Down Expand Up @@ -1208,7 +1221,7 @@ public String replaceFirst(long address, int length, String replacement) {

long startNanos = System.nanoTime();

String result = RE2NativeJNI.replaceFirstDirect(nativeHandle, address, length, replacement);
String result = jni.replaceFirstDirect(nativeHandle, address, length, replacement);

long durationNanos = System.nanoTime() - startNanos;

Expand Down Expand Up @@ -1272,7 +1285,7 @@ public String replaceAll(long address, int length, String replacement) {

long startNanos = System.nanoTime();

String result = RE2NativeJNI.replaceAllDirect(nativeHandle, address, length, replacement);
String result = jni.replaceAllDirect(nativeHandle, address, length, replacement);

long durationNanos = System.nanoTime() - startNanos;

Expand Down Expand Up @@ -1347,7 +1360,7 @@ public String[] replaceAll(long[] addresses, int[] lengths, String replacement)

long startNanos = System.nanoTime();

String[] results = RE2NativeJNI.replaceAllDirectBulk(nativeHandle, addresses, lengths, replacement);
String[] results = jni.replaceAllDirectBulk(nativeHandle, addresses, lengths, replacement);

long durationNanos = System.nanoTime() - startNanos;
long perItemNanos = durationNanos / addresses.length;
Expand Down Expand Up @@ -1450,7 +1463,7 @@ public long getNativeMemoryBytes() {
*/
public int[] getProgramFanout() {
checkNotClosed();
return RE2NativeJNI.programFanout(nativeHandle);
return jni.programFanout(nativeHandle);
}

/**
Expand All @@ -1475,7 +1488,7 @@ public int[] getProgramFanout() {
* @since 1.2.0
*/
public static String quoteMeta(String text) {
return RE2NativeJNI.quoteMeta(text);
return RE2Native.INSTANCE.quoteMeta(text);
}

long getNativeHandle() {
Expand Down Expand Up @@ -1532,7 +1545,7 @@ public boolean isValid() {
return false;
}
try {
return RE2NativeJNI.patternOk(nativeHandle);
return jni.patternOk(nativeHandle);
} catch (Exception e) {
logger.warn("RE2: Exception while validating pattern", e);
return false;
Expand Down Expand Up @@ -1606,7 +1619,7 @@ public void forceClose(boolean releaseRegardless) {

// CRITICAL: Always track freed, even if freePattern throws
try {
RE2NativeJNI.freePattern(nativeHandle);
jni.freePattern(nativeHandle);
} catch (Exception e) {
logger.error("RE2: Error freeing pattern native handle", e);
} finally {
Expand Down Expand Up @@ -1771,7 +1784,7 @@ public boolean[] matchAll(String[] inputs) {
}

long startNanos = System.nanoTime();
boolean[] results = RE2NativeJNI.fullMatchBulk(nativeHandle, inputs);
boolean[] results = jni.fullMatchBulk(nativeHandle, inputs);
long durationNanos = System.nanoTime() - startNanos;

// Track metrics - GLOBAL (ALL) + SPECIFIC (String Bulk)
Expand Down Expand Up @@ -1828,7 +1841,7 @@ public boolean[] findAll(String[] inputs) {
}

long startNanos = System.nanoTime();
boolean[] results = RE2NativeJNI.partialMatchBulk(nativeHandle, inputs);
boolean[] results = jni.partialMatchBulk(nativeHandle, inputs);
long durationNanos = System.nanoTime() - startNanos;

// Track metrics - GLOBAL (ALL) + SPECIFIC (String Bulk)
Expand Down Expand Up @@ -1922,7 +1935,7 @@ public boolean[] matchAll(long[] addresses, int[] lengths) {
}

long startNanos = System.nanoTime();
boolean[] results = RE2NativeJNI.fullMatchDirectBulk(nativeHandle, addresses, lengths);
boolean[] results = jni.fullMatchDirectBulk(nativeHandle, addresses, lengths);
long durationNanos = System.nanoTime() - startNanos;

// Track metrics - GLOBAL (ALL) + SPECIFIC (Bulk Zero-Copy)
Expand Down Expand Up @@ -1972,7 +1985,7 @@ public boolean[] findAll(long[] addresses, int[] lengths) {
}

long startNanos = System.nanoTime();
boolean[] results = RE2NativeJNI.partialMatchDirectBulk(nativeHandle, addresses, lengths);
boolean[] results = jni.partialMatchDirectBulk(nativeHandle, addresses, lengths);
long durationNanos = System.nanoTime() - startNanos;

// Track metrics - GLOBAL (ALL) + SPECIFIC (Bulk Zero-Copy)
Expand Down Expand Up @@ -2129,7 +2142,7 @@ public String[] extractGroups(long address, int length) {
throw new IllegalArgumentException("Length must not be negative: " + length);
}

return RE2NativeJNI.extractGroupsDirect(nativeHandle, address, length);
return jni.extractGroupsDirect(nativeHandle, address, length);
}

/**
Expand All @@ -2154,7 +2167,7 @@ public String[][] findAllMatches(long address, int length) {
throw new IllegalArgumentException("Length must not be negative: " + length);
}

return RE2NativeJNI.findAllMatchesDirect(nativeHandle, address, length);
return jni.findAllMatchesDirect(nativeHandle, address, length);
}

// ========== ByteBuffer API (Automatic Zero-Copy Routing) ==========
Expand Down Expand Up @@ -2322,7 +2335,7 @@ private String[] extractGroupsFromByteBuffer(ByteBuffer buffer) {
byte[] bytes = new byte[buffer.remaining()];
buffer.duplicate().get(bytes);
String text = new String(bytes, StandardCharsets.UTF_8);
return RE2NativeJNI.extractGroups(nativeHandle, text);
return jni.extractGroups(nativeHandle, text);
}

/**
Expand All @@ -2332,7 +2345,7 @@ private String[][] findAllMatchesFromByteBuffer(ByteBuffer buffer) {
byte[] bytes = new byte[buffer.remaining()];
buffer.duplicate().get(bytes);
String text = new String(bytes, StandardCharsets.UTF_8);
return RE2NativeJNI.findAllMatches(nativeHandle, text);
return jni.findAllMatches(nativeHandle, text);
}

/**
Expand Down
2 changes: 0 additions & 2 deletions libre2-core/src/main/java/com/axonops/libre2/api/RE2.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@

package com.axonops.libre2.api;

import com.axonops.libre2.jni.RE2NativeJNI;

/**
* Main entry point for RE2 regex operations.
*
Expand Down
Loading