Fix listener cleanup, reload monitoring, settings and commands

This commit is contained in:
eyck committed 2026-11-15 09:22:55 +01:00
1 parent 7bceaa0635
commit 4824d48828
17 files changed
+872 -245

No files matched your search

@@ -0,0 +1,145 @@
package com.minres.scviewer.e4.application.handlers;
import static org.junit.Assert.*;
import java.lang.reflect.Proxy;
import java.util.List;
import java.util.concurrent.atomic.AtomicReference;
import org.eclipse.e4.ui.model.application.ui.basic.MPart;
import org.eclipse.e4.ui.workbench.modeling.EPartService;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.junit.Test;
import com.minres.scviewer.database.IWaveform;
import com.minres.scviewer.database.IWaveformDb;
import com.minres.scviewer.database.WaveformType;
import com.minres.scviewer.database.ui.TrackEntry;
import com.minres.scviewer.e4.application.parts.DesignBrowser;
import com.minres.scviewer.e4.application.parts.WaveformViewer;
public class CommandHandlersTest {
private static class Viewer extends WaveformViewer {
ISelection selection = StructuredSelection.EMPTY;
DesignBrowser browser;
IWaveform[] added;
boolean insert;
int searches;
final IWaveformDb db = (IWaveformDb) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveformDb.class},
(proxy, method, args) -> method.getName().equals("isLoaded") ? true : null);
@Override public ISelection getSelection() { return selection; }
@Override public IWaveformDb getDatabase() { return db; }
@Override public DesignBrowser getDesignBrowser() { return browser; }
@Override public void addStreamsToList(IWaveform[] waveforms, boolean before) { added = waveforms; insert = before; }
@Override public void focusTransactionSearch() { searches++; }
}
private DesignBrowser browser(Viewer viewer, Object... entries) {
return new DesignBrowser() {
@Override public WaveformViewer getActiveWaveformViewerPart() { return viewer; }
@Override public Object[] getFilteredChildren() { return entries; }
};
}
private IWaveform waveform(WaveformType type) {
return (IWaveform) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveform.class},
(proxy, method, args) -> switch (method.getName()) {
case "getType" -> type;
case "getChildNodes" -> List.of();
default -> null;
});
}
private MPart part(Object object) {
return (MPart) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{MPart.class},
(proxy, method, args) -> method.getName().equals("getObject") ? object : null);
}
private EPartService parts(AtomicReference<MPart> active) {
return (EPartService) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{EPartService.class},
(proxy, method, args) -> method.getName().equals("getActivePart") ? active.get() : null);
}
@Test
public void addAllUsesFilteredChildrenWithoutASelectionAndFollowsActiveTab() {
Viewer first = new Viewer(), second = new Viewer();
IWaveform a = waveform(WaveformType.STREAM), b = waveform(WaveformType.STREAM);
first.browser = browser(first, a, "unrelated"); second.browser = browser(second, b);
AtomicReference<MPart> active = new AtomicReference<>(part(first));
EPartService service = parts(active);
AddWaveformHandler handler = new AddWaveformHandler();
try {
assertTrue(handler.canExecute("after", "true", service, null));
handler.execute("after", "true", service, null);
assertArrayEquals(new IWaveform[]{a}, first.added);
active.set(part(second));
handler.execute("after", "true", service, null);
assertArrayEquals(new IWaveform[]{b}, second.added);
assertFalse(second.insert);
} finally { first.closeDatabase(); second.closeDatabase(); }
}
@Test
public void staleBrowserFromPreviousTabCannotReceiveAddCommands() {
Viewer previous = new Viewer(), activeViewer = new Viewer();
IWaveform wave = waveform(WaveformType.STREAM);
activeViewer.browser = browser(previous, wave);
EPartService service = parts(new AtomicReference<>(part(activeViewer)));
AddWaveformHandler handler = new AddWaveformHandler();
try {
assertFalse(handler.canExecute("after", "true", service, null));
handler.execute("after", "true", service, null);
assertNull(previous.added);
assertNull(activeViewer.added);
} finally { previous.closeDatabase(); activeViewer.closeDatabase(); }
}
@Test
public void executeRechecksInsertionAndRejectsMissingOrUnrelatedSelection() {
Viewer viewer = new Viewer();
IWaveform wave = waveform(WaveformType.STREAM);
viewer.browser = browser(viewer, wave);
EPartService service = parts(new AtomicReference<>(part(viewer)));
AddWaveformHandler handler = new AddWaveformHandler();
try {
handler.execute("before", "true", service, null);
assertNull(viewer.added);
assertFalse(handler.canExecute("after", "false", service, new StructuredSelection("unrelated")));
handler.execute("after", "false", service, null);
assertNull(viewer.added);
viewer.selection = new StructuredSelection(new TrackEntry(wave, null));
handler.execute("before", "false", service, new StructuredSelection(wave));
assertArrayEquals(new IWaveform[]{wave}, viewer.added);
assertTrue(viewer.insert);
} finally { viewer.closeDatabase(); }
}
@Test
public void searchRevealsExistingControlsOnlyForTransactionTracks() {
Viewer viewer = new Viewer();
SearchHandler handler = new SearchHandler();
MPart part = part(viewer);
try {
viewer.selection = new StructuredSelection(new TrackEntry(waveform(WaveformType.SIGNAL), null));
handler.execute(null, part);
assertEquals(0, viewer.searches);
viewer.selection = new StructuredSelection(new TrackEntry(waveform(WaveformType.STREAM), null));
assertTrue(handler.evaluate(part));
handler.execute(null, part);
assertEquals(1, viewer.searches);
assertFalse(handler.evaluate(null));
} finally { viewer.closeDatabase(); }
}
@Test
public void missingActivePartIsSafeDuringCommandExecution() {
EPartService service = parts(new AtomicReference<>());
AddWaveformHandler add = new AddWaveformHandler();
assertFalse(add.canExecute("after", "true", service, null));
add.execute("after", "true", service, null);
new ReloadHandler().execute(null, null, null, service);
new LoadStoreSettingsHandler().execute("load", null, null, null, service);
new SearchHandler().execute(null, null);
}
}
@@ -0,0 +1,50 @@
package com.minres.scviewer.e4.application.internal.util;
import static org.junit.Assert.*;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.FileTime;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import org.junit.Test;
public class FileMonitorTest {
@Test
public void collidingListenersAreIndependentAndCancelledCheckersStayInactive() throws Exception {
FileMonitor monitor = new FileMonitor();
Path file = Files.createTempFile("scviewer-watch", ".tmp");
AtomicInteger first = new AtomicInteger();
AtomicInteger second = new AtomicInteger();
IFileChangeListener a = listener(first);
IFileChangeListener b = listener(second);
try {
List<java.io.File> files = new ArrayList<>(List.of(file.toFile()));
IModificationChecker ca = monitor.addFileChangeListener(a, files, 60000);
IModificationChecker cb = monitor.addFileChangeListener(b, files, 60000);
files.clear();
Files.setLastModifiedTime(file, FileTime.fromMillis(Files.getLastModifiedTime(file).toMillis() + 10000));
ca.check(); cb.check();
assertEquals(1, first.get()); assertEquals(1, second.get());
monitor.removeFileChangeListener(a);
Files.setLastModifiedTime(file, FileTime.fromMillis(Files.getLastModifiedTime(file).toMillis() + 10000));
ca.check(); cb.check();
assertEquals(1, first.get()); assertEquals(2, second.get());
monitor.dispose();
monitor.setEnabled(true);
assertFalse(monitor.isEnabled());
Files.setLastModifiedTime(file, FileTime.fromMillis(Files.getLastModifiedTime(file).toMillis() + 10000));
cb.check();
assertEquals(2, second.get());
} finally { monitor.dispose(); Files.deleteIfExists(file); }
}
private IFileChangeListener listener(AtomicInteger count) {
return new IFileChangeListener() {
@Override public void fileChanged(List<java.io.File> files) { count.incrementAndGet(); }
@Override public int hashCode() { return 1; }
};
}
}
@@ -0,0 +1,125 @@
package com.minres.scviewer.e4.application.parts;
import static org.junit.Assert.*;
import java.lang.reflect.Proxy;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.FileTime;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.e4.ui.di.UISynchronize;
import org.eclipse.e4.ui.workbench.modeling.EPartService;
import org.junit.Test;
import com.minres.scviewer.database.IWaveformDb;
import com.minres.scviewer.database.ui.IWaveformView;
import com.minres.scviewer.e4.application.elements.RelationTypeToolControl;
import com.minres.scviewer.e4.application.internal.util.DatabaseLoadSession;
import com.minres.scviewer.e4.application.internal.util.IModificationChecker;
public class ViewerLifecycleTest {
private void set(WaveformViewer viewer, String name, Object value) throws Exception {
java.lang.reflect.Field field = WaveformViewer.class.getDeclaredField(name);
field.setAccessible(true); field.set(viewer, value);
}
private IEclipsePreferences preferences(AtomicInteger adds, AtomicInteger removes) {
return (IEclipsePreferences) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IEclipsePreferences.class},
(proxy, method, args) -> {
if (method.getName().equals("addPreferenceChangeListener")) adds.incrementAndGet();
if (method.getName().equals("removePreferenceChangeListener")) removes.incrementAndGet();
return null;
});
}
@Test
public void preferenceReinjectionAndRepeatedDisposalDoNotLeakListeners() throws Exception {
WaveformViewer viewer = new WaveformViewer();
AtomicInteger addsA = new AtomicInteger(), removesA = new AtomicInteger();
AtomicInteger addsB = new AtomicInteger(), removesB = new AtomicInteger();
AtomicInteger removedParts = new AtomicInteger();
IEclipsePreferences a = preferences(addsA, removesA), b = preferences(addsB, removesB);
viewer.ePartService = (EPartService) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{EPartService.class},
(proxy, method, args) -> {
if (method.getName().equals("removePartListener")) removedParts.incrementAndGet();
return null;
});
set(viewer, "partListener", new PartListener());
try {
viewer.reactOnPrefsChange(a); viewer.reactOnPrefsChange(a); viewer.reactOnPrefsChange(b);
assertEquals(1, addsA.get()); assertEquals(1, removesA.get());
assertEquals(1, addsB.get());
viewer.closeDatabase(); viewer.closeDatabase(); viewer.reactOnPrefsChange(a);
assertEquals(1, removesB.get()); assertEquals(1, removedParts.get()); assertEquals(1, addsA.get());
} finally { viewer.closeDatabase(); }
}
@Test
public void toolbarPartListenerIsRemovedEvenWhenDisposedBeforeGuiCreation() {
AtomicInteger added = new AtomicInteger(), removed = new AtomicInteger();
EPartService parts = (EPartService) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{EPartService.class},
(proxy, method, args) -> {
if (method.getName().equals("addPartListener")) added.incrementAndGet();
if (method.getName().equals("removePartListener")) removed.incrementAndGet();
return null;
});
RelationTypeToolControl control = new RelationTypeToolControl(parts);
control.dispose(); control.dispose();
assertEquals(1, added.get()); assertEquals(1, removed.get());
}
@Test
public void decliningReloadResumesMonitoringAndPreferenceChangesTakeEffect() throws Exception {
class Viewer extends WaveformViewer {
boolean closed;
int prompts;
@Override protected boolean isViewerDisposed() { return closed; }
@Override protected boolean confirmReload() { prompts++; return false; }
@Override public void closeDatabase() { closed = true; super.closeDatabase(); }
}
Viewer viewer = new Viewer();
Path file = Files.createTempFile("scviewer-reload", ".tmp");
IWaveformDb database = (IWaveformDb) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveformDb.class},
(proxy, method, args) -> method.getName().equals("isLoaded") ? true : null);
DatabaseLoadSession session = new DatabaseLoadSession(database, List.of(file.toFile()), event -> {}, result -> {});
try {
viewer.sync = new UISynchronize() {
@Override public void syncExec(Runnable task) { task.run(); }
@Override public void asyncExec(Runnable task) { task.run(); }
@Override protected boolean isUIThread(Thread thread) { return true; }
@Override protected void showBusyWhile(Runnable task) { task.run(); }
@Override protected boolean dispatchEvents() { return false; }
};
set(viewer, "database", database); set(viewer, "loadSession", session);
set(viewer, "waveformPane", Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveformView.class},
(proxy, method, args) -> null));
viewer.filesToLoad.add(file.toFile());
viewer.reactOnReloadDatabaseChange(true);
IModificationChecker first = viewer.fileChecker;
assertNotNull(first);
change(file); first.check();
assertEquals(1, viewer.prompts); assertNotNull(viewer.fileChecker); assertNotSame(first, viewer.fileChecker);
viewer.fileChecker.check();
assertEquals("Declined change must be acknowledged", 1, viewer.prompts);
change(file); viewer.fileChecker.check();
assertEquals(2, viewer.prompts);
IModificationChecker old = viewer.fileChecker;
viewer.reactOnReloadDatabaseChange(false);
assertNull(viewer.fileChecker);
change(file); old.check();
assertEquals(2, viewer.prompts);
viewer.reactOnReloadDatabaseChange(true);
assertNotNull(viewer.fileChecker);
viewer.closeDatabase();
viewer.reactOnReloadDatabaseChange(true);
assertNull(viewer.fileChecker);
} finally { viewer.closeDatabase(); Files.deleteIfExists(file); }
}
private void change(Path file) throws Exception {
Files.setLastModifiedTime(file, FileTime.fromMillis(Files.getLastModifiedTime(file).toMillis() + 10000));
}
}
@@ -0,0 +1,91 @@
package com.minres.scviewer.e4.application.parts;
import static org.junit.Assert.*;
import java.lang.reflect.Proxy;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.Map;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import org.junit.Test;
import com.minres.scviewer.database.EmptyWaveform;
import com.minres.scviewer.database.IWaveformDb;
import com.minres.scviewer.database.IHierNode;
import com.minres.scviewer.database.WaveformType;
import com.minres.scviewer.database.ui.IWaveformView;
import com.minres.scviewer.database.ui.TrackEntry.ValueDisplay;
public class ViewerSettingsTest {
private Map<String, String> state() {
return new HashMap<>(Map.of("SHOWN_WAVEFORMS", "1", "SHOWN_WAVEFORM0", "top.stream",
"SHOWN_WAVEFORM0.WAVEFORM_TYPE", "STREAM", "SHOWN_WAVEFORM0.VALUE_DISPLAY", "BINARY",
"SHOWN_WAVEFORM0.WAVEFORM_SELECTED", "TRUE", "SHOWN_CURSORS", "1", "SHOWN_CURSOR0", "123"));
}
@Test
public void readsExistingFormatIncludingOptionalAndUppercaseValues() {
ViewerSettings settings = ViewerSettings.parse(state());
assertEquals("top.stream", settings.tracks().get(0).name());
assertEquals(WaveformType.STREAM, settings.tracks().get(0).type());
assertEquals(ValueDisplay.BINARY, settings.tracks().get(0).valueDisplay());
assertTrue(settings.tracks().get(0).selected());
assertEquals(Long.valueOf(123), settings.cursors().get(0));
assertNull(settings.scale());
}
@Test
public void rejectsMalformedFieldsBeforeApplication() {
for (Map.Entry<String, String> entry : Map.of("SHOWN_WAVEFORMS", "-1", "SHOWN_CURSORS", "9999999999",
"SHOWN_CURSOR0", "time", "SCALING_FACTOR", "0", "BASE_LINE_TIME", "-1",
"SHOWN_WAVEFORM0.VALUE_DISPLAY", "invalid", "TX_DETAILS_SHOWN", "maybe").entrySet()) {
Map<String, String> invalid = state();
invalid.put(entry.getKey(), entry.getValue());
try { ViewerSettings.parse(invalid); fail("Accepted " + entry.getKey()); }
catch (IllegalArgumentException e) { assertTrue(e.getMessage().contains(entry.getKey())); }
}
Map<String, String> missing = state();
missing.remove("SHOWN_WAVEFORM0");
try { ViewerSettings.parse(missing); fail("Accepted missing waveform name"); }
catch (IllegalArgumentException e) { assertTrue(e.getMessage().contains("SHOWN_WAVEFORM0")); }
}
@Test
public void missingUnqualifiedWaveformDoesNotAttemptInvalidSubstring() {
EmptyWaveform child = new EmptyWaveform("child");
EmptyWaveform parent = new EmptyWaveform("top") {
@Override public List<IHierNode> getChildNodes() { return List.of(child); }
};
IWaveformDb db = (IWaveformDb) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveformDb.class},
(proxy, method, args) -> method.getName().equals("getStreamByName") && args[0].equals("top") ? parent : null);
assertNull(ViewerSettings.resolveWaveform(db, "missing"));
assertNull(ViewerSettings.resolveWaveform(db, "top.absent"));
assertSame(child, ViewerSettings.resolveWaveform(db, "top.child"));
}
@Test
public void invalidOrUnreadableFileLeavesViewerUntouchedAndReportsError() throws Exception {
AtomicInteger changes = new AtomicInteger();
IWaveformView pane = (IWaveformView) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveformView.class},
(proxy, method, args) -> { changes.incrementAndGet(); throw new AssertionError("Layout changed before validation"); });
class Viewer extends WaveformViewer {
int errors;
@Override protected void reportSettingsError(String title, String message) { errors++; assertFalse(message.isEmpty()); }
}
Viewer viewer = new Viewer();
Path file = Files.createTempFile("scviewer-settings", ".properties");
try {
java.lang.reflect.Field field = WaveformViewer.class.getDeclaredField("waveformPane");
field.setAccessible(true); field.set(viewer, pane);
Files.writeString(file, "SHOWN_WAVEFORMS=1\nSHOWN_WAVEFORM0=stream\nSHOWN_WAVEFORM0.WAVE_DISPLAY=unknown\n");
viewer.loadState(file.toString());
Files.delete(file);
viewer.loadState(file.toString());
assertEquals(2, viewer.errors);
assertEquals(0, changes.get());
} finally { viewer.closeDatabase(); Files.deleteIfExists(file); }
}
}
@@ -0,0 +1,44 @@
package com.minres.scviewer.e4.application.parts.txTableTree;
import static org.junit.Assert.*;
import java.lang.reflect.Proxy;
import java.util.List;
import org.junit.Test;
import com.minres.scviewer.database.DataType;
import com.minres.scviewer.database.tx.ITx;
import com.minres.scviewer.database.tx.ITxAttribute;
public class TxFilterTest {
private ITx transaction(String name, Object value) {
ITxAttribute attribute = (ITxAttribute) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{ITxAttribute.class},
(proxy, method, args) -> switch (method.getName()) {
case "getName" -> name;
case "getValue" -> value;
default -> null;
});
return (ITx) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{ITx.class},
(proxy, method, args) -> method.getName().equals("getAttributes") ? List.of(attribute) : null);
}
@Test
public void switchingToStringPropertyRecompilesExistingSearchText() {
TxFilter filter = new TxFilter();
filter.setSearchProp("number", DataType.INTEGER);
filter.setSearchValue("match");
filter.setSearchProp("text", DataType.STRING);
assertFalse(filter.select(null, null, transaction("text", "different")));
assertTrue(filter.select(null, null, transaction("text", "prefix match suffix")));
}
@Test
public void booleanValuesCanBeMatchedWithoutAStringCast() {
TxFilter filter = new TxFilter();
filter.setSearchProp("flag", DataType.BOOLEAN);
filter.setSearchValue("TRUE");
assertTrue(filter.select(null, null, transaction("flag", true)));
assertFalse(filter.select(null, null, transaction("flag", false)));
}
}