Add regression test for CommandModule cancelation

This validates the bug-fix in 8a65459.

Author: ctrueden

src/test/java/org/scijava/command/CommandModuleTest.java

@@ -0,0 +1,114 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2016 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.command;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.util.concurrent.ExecutionException;
+
+import org.junit.Test;
+import org.scijava.Cancelable;
+import org.scijava.Context;
+import org.scijava.module.Module;
+import org.scijava.module.process.AbstractPreprocessorPlugin;
+import org.scijava.module.process.PreprocessorPlugin;
+import org.scijava.plugin.Plugin;
+
+/** Regression tests for {@link CommandModule}. */
+public class CommandModuleTest {
+
+	@Test
+	public void testCancelable() throws InterruptedException, ExecutionException {
+		final Context context = new Context(CommandService.class);
+		final CommandService commandService = context.service(CommandService.class);
+		final CommandModule ice = commandService.run(IceCommand.class, true).get();
+		final Cancelable c = (Cancelable) ice.getDelegateObject();
+		assertTrue(ice.isCanceled());
+		assertTrue(c.isCanceled());
+		assertEquals("Stop! Collaborate and listen!", ice.getCancelReason());
+		assertEquals("Stop! Collaborate and listen!", c.getCancelReason());
+	}
+	
+	@Test
+	public void testNotCancelable() throws InterruptedException,
+		ExecutionException
+	{
+		final Context context = new Context(CommandService.class);
+		final CommandService commandService = context.service(CommandService.class);
+		final CommandModule fire = commandService.run(FireCommand.class, true).get();
+		assertFalse(fire.getDelegateObject() instanceof Cancelable);
+		assertTrue(fire.isCanceled());
+		assertEquals("NO SINGING!", fire.getCancelReason());
+	}
+
+	// -- Helper classes --
+
+	/** A command which implements {@link Cancelable}. */
+	@Plugin(type = Command.class, initializer = "init")
+	public static class IceCommand extends ContextCommand {
+
+		public void init() {
+			cancel("Stop! Collaborate and listen!");
+		}
+
+		@Override
+		public void run() {
+			throw new IllegalStateException("Unexpected");
+		}
+	}
+
+	/** A command which does not implement {@link Cancelable}. */
+	@Plugin(type = Command.class)
+	public static class FireCommand implements Command {
+
+		@Override
+		public void run() {
+			throw new IllegalStateException("Unexpected");
+		}
+	}
+
+	@Plugin(type = PreprocessorPlugin.class)
+	public static class CommandCanceler extends AbstractPreprocessorPlugin {
+
+		@Override
+		public void process(final Module module) {
+			final Object command = module.getDelegateObject();
+			if (command instanceof IceCommand || command instanceof FireCommand) {
+				// NB: A Monty Python quote which is also a Game of Thrones reference.
+				// That's right -- we did that.
+				cancel("NO SINGING!");
+			}
+		}
+	}
+}