Skip to content

Commit 74cdce1

Browse files
committed
Add a base class for SciJava-based unit tests
This eases creation + disposal of a unique Context for each test method.
1 parent f4c47e0 commit 74cdce1

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
/*
2+
* #%L
3+
* SciJava Common shared library for SciJava software.
4+
* %%
5+
* Copyright (C) 2009 - 2016 Board of Regents of the University of
6+
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
7+
* Institute of Molecular Cell Biology and Genetics.
8+
* %%
9+
* Redistribution and use in source and binary forms, with or without
10+
* modification, are permitted provided that the following conditions are met:
11+
*
12+
* 1. Redistributions of source code must retain the above copyright notice,
13+
* this list of conditions and the following disclaimer.
14+
* 2. Redistributions in binary form must reproduce the above copyright notice,
15+
* this list of conditions and the following disclaimer in the documentation
16+
* and/or other materials provided with the distribution.
17+
*
18+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19+
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20+
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21+
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
22+
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23+
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24+
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25+
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26+
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27+
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28+
* POSSIBILITY OF SUCH DAMAGE.
29+
* #L%
30+
*/
31+
32+
package org.scijava.test;
33+
34+
import java.awt.Cursor;
35+
import java.util.Random;
36+
37+
import org.junit.After;
38+
import org.junit.Before;
39+
import org.scijava.Context;
40+
import org.scijava.plugin.Parameter;
41+
import org.scijava.service.Service;
42+
import org.scijava.util.ByteArray;
43+
import org.scijava.util.FloatArray;
44+
45+
/**
46+
* Base class for unit testing of SciJava components.
47+
* <p>
48+
* Many SciJava-based unit tests need to have a {@link Context} with relevant
49+
* services. Following the
50+
* <a href="https://en.wikipedia.org/wiki/Don%27t_repeat_yourself">DRY
51+
* principle</a>, we should implement it only once. Here.
52+
* </p>
53+
*
54+
* @author Johannes Schindelin
55+
* @author Curtis Rueden
56+
*/
57+
public abstract class AbstractSciJavaTest {
58+
59+
@Parameter
60+
protected Context context;
61+
62+
/** Subclasses can override to create a differently configured context. */
63+
protected Context createContext() {
64+
return new Context(serviceClasses());
65+
}
66+
67+
/** Subclasses must override to define the services the context will have. */
68+
protected abstract Class<? extends Service>[] serviceClasses();
69+
70+
/** Sets up a SciJava context and injects needed services. */
71+
@Before
72+
public void setUp() {
73+
createContext().inject(this);
74+
}
75+
76+
/**
77+
* Disposes of the {@link Context} that was initialized in {@link #setUp()}.
78+
*/
79+
@After
80+
public synchronized void cleanUp() {
81+
if (context != null) {
82+
context.dispose();
83+
context = null;
84+
}
85+
}
86+
87+
}

0 commit comments

Comments
 (0)