Add unit tests for TorReachabilityMonitorImpl.

This commit is contained in:
akwizgran
2022-06-01 16:25:50 +01:00
parent 63c0210047
commit 2672d82a40

View File

@@ -0,0 +1,246 @@
package org.briarproject.bramble.mailbox;
import org.briarproject.bramble.api.Cancellable;
import org.briarproject.bramble.api.event.EventBus;
import org.briarproject.bramble.api.plugin.Plugin;
import org.briarproject.bramble.api.plugin.PluginManager;
import org.briarproject.bramble.api.plugin.event.TransportActiveEvent;
import org.briarproject.bramble.api.plugin.event.TransportInactiveEvent;
import org.briarproject.bramble.api.system.TaskScheduler;
import org.briarproject.bramble.mailbox.TorReachabilityMonitor.TorReachabilityObserver;
import org.briarproject.bramble.test.BrambleMockTestCase;
import org.briarproject.bramble.test.CaptureArgumentAction;
import org.jmock.Expectations;
import org.jmock.lib.action.DoAllAction;
import org.junit.Before;
import org.junit.Test;
import java.util.concurrent.Executor;
import java.util.concurrent.atomic.AtomicReference;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static org.briarproject.bramble.api.plugin.Plugin.State.ACTIVE;
import static org.briarproject.bramble.api.plugin.Plugin.State.DISABLED;
import static org.briarproject.bramble.api.plugin.Plugin.State.ENABLING;
import static org.briarproject.bramble.api.plugin.TorConstants.ID;
import static org.briarproject.bramble.mailbox.TorReachabilityMonitor.REACHABILITY_PERIOD_MS;
public class TorReachabilityMonitorImplTest extends BrambleMockTestCase {
private final Executor ioExecutor = context.mock(Executor.class);
private final TaskScheduler taskScheduler =
context.mock(TaskScheduler.class);
private final PluginManager pluginManager =
context.mock(PluginManager.class);
private final EventBus eventBus = context.mock(EventBus.class);
private final Plugin plugin = context.mock(Plugin.class);
private final Cancellable scheduledTask = context.mock(Cancellable.class);
private final TorReachabilityObserver observer =
context.mock(TorReachabilityObserver.class);
private TorReachabilityMonitorImpl monitor;
@Before
public void setUp() {
monitor = new TorReachabilityMonitorImpl(ioExecutor, taskScheduler,
pluginManager, eventBus);
}
@Test
public void testSchedulesTaskWhenStartedIfTorIsActive() {
// Starting the monitor should schedule a task
context.checking(new Expectations() {{
oneOf(eventBus).addListener(monitor);
oneOf(pluginManager).getPlugin(ID);
will(returnValue(plugin));
oneOf(plugin).getState();
will(returnValue(ACTIVE));
oneOf(taskScheduler).schedule(with(any(Runnable.class)),
with(ioExecutor), with(REACHABILITY_PERIOD_MS),
with(MILLISECONDS));
will(returnValue(scheduledTask));
}});
monitor.start();
// If Tor has only just become active and the TransportActiveEvent
// arrives after the task has already been scheduled, a second task
// should not be scheduled
monitor.eventOccurred(new TransportActiveEvent(ID));
// Destroying the monitor should cancel the task
context.checking(new Expectations() {{
oneOf(eventBus).removeListener(monitor);
oneOf(scheduledTask).cancel();
}});
monitor.destroy();
}
@Test
public void testSchedulesTaskWhenTorBecomesActive() {
// Starting the monitor should not schedule a task as Tor is inactive
context.checking(new Expectations() {{
oneOf(eventBus).addListener(monitor);
oneOf(pluginManager).getPlugin(ID);
will(returnValue(plugin));
oneOf(plugin).getState();
will(returnValue(ENABLING));
}});
monitor.start();
// When Tor becomes active, a task should be scheduled
context.checking(new Expectations() {{
oneOf(taskScheduler).schedule(with(any(Runnable.class)),
with(ioExecutor), with(REACHABILITY_PERIOD_MS),
with(MILLISECONDS));
will(returnValue(scheduledTask));
}});
monitor.eventOccurred(new TransportActiveEvent(ID));
// Destroying the monitor should cancel the task
context.checking(new Expectations() {{
oneOf(eventBus).removeListener(monitor);
oneOf(scheduledTask).cancel();
}});
monitor.destroy();
}
@Test
public void testCancelsTaskWhenTorBecomesInactive() {
// Starting the monitor should schedule a task
context.checking(new Expectations() {{
oneOf(eventBus).addListener(monitor);
oneOf(pluginManager).getPlugin(ID);
will(returnValue(plugin));
oneOf(plugin).getState();
will(returnValue(ACTIVE));
oneOf(taskScheduler).schedule(with(any(Runnable.class)),
with(ioExecutor), with(REACHABILITY_PERIOD_MS),
with(MILLISECONDS));
will(returnValue(scheduledTask));
}});
monitor.start();
// When Tor becomes inactive, the task should be cancelled
context.checking(new Expectations() {{
oneOf(scheduledTask).cancel();
}});
monitor.eventOccurred(new TransportInactiveEvent(ID));
// Destroying the monitor should not affect the task, which has
// already been cancelled
context.checking(new Expectations() {{
oneOf(eventBus).removeListener(monitor);
}});
monitor.destroy();
}
@Test
public void testObserverRegisteredBeforeTorBecomesActiveIsCalled() {
// Starting the monitor should not schedule a task as Tor is inactive
context.checking(new Expectations() {{
oneOf(eventBus).addListener(monitor);
oneOf(pluginManager).getPlugin(ID);
will(returnValue(plugin));
oneOf(plugin).getState();
will(returnValue(DISABLED));
}});
monitor.start();
// Register an observer
monitor.addObserver(observer);
// When Tor becomes active, a task should be scheduled
AtomicReference<Runnable> runnable = new AtomicReference<>(null);
context.checking(new Expectations() {{
oneOf(taskScheduler).schedule(with(any(Runnable.class)),
with(ioExecutor), with(REACHABILITY_PERIOD_MS),
with(MILLISECONDS));
will(new DoAllAction(
new CaptureArgumentAction<>(runnable, Runnable.class, 0),
returnValue(scheduledTask)
));
}});
monitor.eventOccurred(new TransportActiveEvent(ID));
// When the task runs, the observer should be called
context.checking(new Expectations() {{
oneOf(observer).onTorReachable();
}});
runnable.get().run();
}
@Test
public void testObserverRegisteredBeforeTorBecomesReachableIsCalled() {
// Starting the monitor should schedule a task
AtomicReference<Runnable> runnable = new AtomicReference<>(null);
context.checking(new Expectations() {{
oneOf(eventBus).addListener(monitor);
oneOf(pluginManager).getPlugin(ID);
will(returnValue(plugin));
oneOf(plugin).getState();
will(returnValue(ACTIVE));
oneOf(taskScheduler).schedule(with(any(Runnable.class)),
with(ioExecutor), with(REACHABILITY_PERIOD_MS),
with(MILLISECONDS));
will(new DoAllAction(
new CaptureArgumentAction<>(runnable, Runnable.class, 0),
returnValue(scheduledTask)
));
}});
monitor.start();
// Register an observer
monitor.addObserver(observer);
// When the task runs, the observer should be called
context.checking(new Expectations() {{
oneOf(observer).onTorReachable();
}});
runnable.get().run();
}
@Test
public void testObserverRegisteredAfterTorBecomesReachableIsCalled() {
// Starting the monitor should schedule a task
AtomicReference<Runnable> runnable = new AtomicReference<>(null);
context.checking(new Expectations() {{
oneOf(eventBus).addListener(monitor);
oneOf(pluginManager).getPlugin(ID);
will(returnValue(plugin));
oneOf(plugin).getState();
will(returnValue(ACTIVE));
oneOf(taskScheduler).schedule(with(any(Runnable.class)),
with(ioExecutor), with(REACHABILITY_PERIOD_MS),
with(MILLISECONDS));
will(new DoAllAction(
new CaptureArgumentAction<>(runnable, Runnable.class, 0),
returnValue(scheduledTask)
));
}});
monitor.start();
// When the task runs, no observers have been registered yet
runnable.get().run();
// When an observer is registered, it should be called immediately
context.checking(new Expectations() {{
oneOf(observer).onTorReachable();
}});
monitor.addObserver(observer);
}
}