English
资源说明：JUnit testing without dull routine
# JUnit Helper
## What's this?
"JUnit Helper" helps JUnit users to cover all tests for public, protected and package local methods by saving much labor to start writing new test cases.
Currently, command line script, Maven plugin and Eclipse IDE plugin are provided. Eclipse plugin also has an advantage of making it easier to go back and forth between developing class and test class by "Alt + 8 "(test->dev) and "Alt + 9"(dev->test).
## JUnit testing without dull routine
We developers have to do two non-essential dull routine in JUnit testing.
First, it takes no small cost to prepare a new test case. A general procedure to prepare a JUnit test case might be like this - (1) Creating package and test class (2) Defining test methods (3) Finding out how to instantiate (4) Preparing required args, (5) Starting writing logic at last.
JUnit Helper automates (1) - (4) of above. Developers can focus on writing logic.
And second, it is a hard job to ascertain whether the test case aimed to add already exists in a huge test class that might not be maintained for a long time.
JUnit Helper deals with the problem by using a naming convention of test methods that is based on method signature. For example, "public void doSomething(String arg)" -> "@Test public void doSomething_A$String() throws Exception". The naming rule is customizable to meet some needs.
## Overview
If you want to test the following method:
```java
public SearchResult search(SearchCondition condition) {
return null;
}
```
Carry out whichever operation:
* Command Line Script (for Windows, Mac OS X, UNIX)
```sh
./junithelper(.bat) make src/main/java
```
* Maven
```sh
mvn junithelper:make
```
* Eclipse plugin
Select Java file and "Alt + 9"
JUnit Helper outputs the following test method:
```java
@Test
public void search_A$SearchCondition() throws Exception {
// TODO auto-generated by JUnit Helper.
Sample target = new Sample();
SearchCondition condition = null;
SearchResult actual = target.search(condition);
SearchResult expected = null;
assertThat(actual, is(equalTo(expected));
}
```
JUnit 3.x style is also available:
```java
public void test_search_A$SearchCondition() throws Exception {
// TODO auto-generated by JUnit Helper.
...
```
It will be provided without compile errors in most cases. For example, if the args contain primitives or arrays,
```java
public SearchResult search(String[] array, List list, long primitive, Version version) {
return null;
}
```
like this:
```java
@Test
public void search_A$StringArray$List$long$Version() throws Exception {
// TODO auto-generated by JUnit Helper.
Sample target = new Sample();
String[] array = new String[] {};
List list = new ArrayList();
long primitive = 0L;
Version version = null;
SearchResult actual = target.search(array, list, primitive, version);
SearchResult expected = null;
assertThat(actual, is(equalTo(expected));
}
```
"search_A$SearchCondition" or "search_A$StringArray$List$long$Version" is the part to specify which method it tests. Delimiters and some other rules are customizable.
If you want to have several cases for same method, it's a standard way to discriminate them by method name suffix.
```java
@Test
public void search_A$SearchCondition_null() throws Exception {
// TODO auto-generated by JUnit Helper.
...
}
@Test
public void search_A$SearchCondition_empty() throws Exception {
// TODO auto-generated by JUnit Helper.
...
}
@Test
public void search_A$SearchCondition_paging() throws Exception {
// TODO auto-generated by JUnit Helper.
...
}
```
If you add a new method,
```java
public List addedMethod(InputStream is) {
return null;
}
```
JUnit Helper also adds a test method by make command or "Alt + 9" on Eclipse:
```java
@Test
public void addedMethod_A$InputStream() throws Exception {
// TODO auto-generated by JUnit Helper.
...
```
## With mock object frameworks
If you want, JUnit Helper is also able to generate template test code with mock object frameworks:
### Mockito
```java
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import static org.mockito.BDDMockito.*;
@Test
public void search_A$SearchCondition() throws Exception {
// TODO auto-generated by JUnit Helper.
Sample target = new Sample();
// given
SearchCondition condition = mock(SearchCondition.class);
// e.g. : given(mocked.called()).willReturn(1);
// when
SearchResult actual = target.search(condition);
// then
// e.g. : verify(mocked).called();
SearchResult expected = null;
assertThat(actual, is(equalTo(expected));
}
```
### JMock2
```java
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import org.jmock.Mockery;
import org.jmock.Expectations;
import org.jmock.lib.legacy.ClassImposteriser;
@Test
public void search_A$SearchCondition() throws Exception {
// TODO auto-generated by JUnit Helper.
Mockery context = new Mockery(){{
setImposteriser(ClassImposteriser.INSTANCE);
}};
Sample target = new Sample();
final SearchCondition condition = context.mock(SearchCondition.class);
context.checking(new Expectations(){{
// e.g. : allowing(mocked).called(); will(returnValue(1));
}});
SearchResult actual = target.search(condition);
SearchResult expected = null;
assertThat(actual, is(equalTo(expected));
}
```
### EasyMock
```java
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import org.easymock.classextension.EasyMock;
import org.easymock.classextension.IMocksControl;
@Test
public void search_A$SearchCondition() throws Exception {
// TODO auto-generated by JUnit Helper.
IMocksControl mocks = EasyMock.createControl();
Sample target = new Sample();
SearchCondition condition = mocks.createMock(SearchCondition.class);
// e.g. : EasyMock.expect(mocked.called()).andReturn(1);
mocks.replay();
SearchResult actual = target.search(condition);
mocks.verify();
SearchResult expected = null;
assertThat(actual, is(equalTo(expected));
}
```
### JMockit
```java
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import mockit.Mocked;
import mockit.Expectations;
@Mocked
SearchCondition search_A$SearchCondition_condition;
@Test
public void search_A$SearchCondition() throws Exception {
// TODO auto-generated by JUnit Helper.
Sample target = new Sample();
SearchCondition condition = this.search_A$SearchCondition_condition;
new Expectations(){{
// e.g. : mocked.get(anyString); returns(200);
}};
SearchResult actual = target.search(condition);
SearchResult expected = null;
assertThat(actual, is(equalTo(expected));
}
```
# Eclipse Plugin
## How to install
* Update site
http://junithelper.org/eclipse/plugins/site.xml
* Eclipse marketplace
http://marketplace.eclipse.org/content/junit-helper
## How to use
It is very simple, only two shortcut-commands.The following commands are available on Java Editor, Package Explorer and Navigator.
### Commands
* Alt + 8
Open target class from test when selecting test class, open test target class.
* Alt + 9
Open test class or create test class if it does not exist when selecting test target class.
If some methods that have no tests existed, the minimal test methods will be generated automatically.
JUnit 3.x style is also available:
* Alt + 3
Change current test case to JUnit 3.x style.
* Alt + 4
Change current test case to JUnit 4.x style.
### Preference
* Window > Preferences > JUnit Helper
If you need a project-specific configuration, put "junithelper-config.properties" in the project root directory. It will be put above global configuration in Eclipse.
```
# language:en/ja
language:en
outputFileEncoding:UTF-8
directoryPathOfProductSourceCode:src/main/java
directoryPathOfTestSourceCode:src/test/java
# lineBreakPolicy:forceCRLF/forceLF/forceNewFileCRLF/forceNewFileLF
lineBreakPolicy=forceNewFileCRLF
useSoftTabs=false
softTabSize=4
# junitVersion:version3/version4
junitVersion:version4
testCaseClassNameToExtend:junit.framework.TestCase
isTemplateImplementationRequired:true
target.isAccessorExcluded:true
target.isExceptionPatternRequired:true
target.isPackageLocalMethodRequired:true
target.isProtectedMethodRequired:true
target.isPublicMethodRequired:true
# target.regexpCsvForExclusion:com/.example/..+.autogenerated/..+,com/.example/.NoNeedToTest
target.regexpCsvForExclusion:
testMethodName.isArgsRequired:true
testMethodName.isReturnRequired:false
testMethodName.basicDelimiter:_
testMethodName.argsAreaPrefix:A
testMethodName.argsAreaDelimiter:$
testMethodName.returnAreaPrefix:R
testMethodName.returnAreaDelimiter:$
testMethodName.exceptionAreaPrefix:T
testMethodName.exceptionAreaDelimiter:$
# mockObjectFramework:Mockito/JMock2/JMockit/EasyMock
mockObjectFramework:
# testingPatternExplicitComment:ArrangeActAssert/GivenWhenThen
testingPatternExplicitComment:
isExtensionEnabled:true
extensionConfigXML:junithelper-extension.xml
```
# Command Line Script
## How to install
* Zip archive (junithelper-core-X.X.X.zip)
https://github.com/seratch/junithelper/downloads
## How to use
```sh
$ ./tools/junithelper.bat
_
/ _ ._/_/_/_ /_ _ _
(_//_// // / / //_'//_//_'/
/
JUnit Helper version 1.12
Usage:
junithelper [command] [arg1] [arg2]
Commands:
junithelper make [baseDir/targetJavaFile]
junithelper force3 [baseDir/targetJavaFile]
junithelper force4 [baseDir/targetJavaFile]
JVM Options:
-Djunithelper.configProperties=[filepath]
$
```
* make command
This command creates test cases or methods for the classes under specified package recursively.
```sh
$ ./tools/junithelper.bat make ./src/main/java/org/junithelper/core/util/
_
/ _ ._/_/_/_ /_ _ _
(_//_// // / / //_'//_//_'/
/
JUnit Helper version 1.12
Target: C:/workspace/junithelper-core/./src/main/java/org/junithelper/core/util/IOUtil.java
Target: C:/workspace/junithelper-core/./src/main/java/org/junithelper/core/util/ObjectUtil.java
Target: C:/workspace/junithelper-core/./src/main/java/org/junithelper/core/util/PrimitiveTypeUtil.java
Target: C:/workspace/junithelper-core/./src/main/java/org/junithelper/core/util/Stdout.java
Target: C:/workspace/junithelper-core/./src/main/java/org/junithelper/core/util/ThreadUtil.java
Are you sure?(y/n)
y
Modified: C:/workspace/junithelper-core/./src/test/java/org/junithelper/core/util/IOUtilTest.java
Modified: C:/workspace/junithelper-core/./src/test/java/org/junithelper/core/util/ObjectUtilTest.java
Modified: C:/workspace/junithelper-core/./src/test/java/org/junithelper/core/util/PrimitiveTypeUtilTest.java
Created: C:/workspace/junithelper-core/./src/test/java/org/junithelper/core/util/StdoutTest.java
Modified: C:/workspace/junithelper-core/./src/test/java/org/junithelper/core/util/ThreadUtilTest.java
$
```
* force3 command
This command forces test cases JUnit 3.x style for the classes under specified package recursively.
* force4 command
This command forces test cases JUnit 4.x style for the classes under specified package recursively.
## Configuration
You can change the following Configurations by editing "junithelper-config.properties". Maven plugin's Configuration also uses same property names.
```
# language:en/ja
language:en
outputFileEncoding:UTF-8
directoryPathOfProductSourceCode:src/main/java
directoryPathOfTestSourceCode:src/test/java
# lineBreakPolicy:forceCRLF/forceLF/forceNewFileCRLF/forceNewFileLF
lineBreakPolicy=forceNewFileCRLF
useSoftTabs=false
softTabSize=4
# junitVersion:version3/version4
junitVersion:version4
testCaseClassNameToExtend:junit.framework.TestCase
isTemplateImplementationRequired:true
target.isAccessorExcluded:true
target.isExceptionPatternRequired:true
target.isPackageLocalMethodRequired:true
target.isProtectedMethodRequired:true
target.isPublicMethodRequired:true
# target.regexpCsvForExclusion:com/.example/..+.autogenerated/..+,com/.example/.NoNeedToTest
target.regexpCsvForExclusion:
testMethodName.isArgsRequired:true
testMethodName.isReturnRequired:false
testMethodName.basicDelimiter:_
testMethodName.argsAreaPrefix:A
testMethodName.argsAreaDelimiter:$
testMethodName.returnAreaPrefix:R
testMethodName.returnAreaDelimiter:$
testMethodName.exceptionAreaPrefix:T
testMethodName.exceptionAreaDelimiter:$
# mockObjectFramework:Mockito/JMock2/JMockit/EasyMock
mockObjectFramework:
# testingPatternExplicitComment:ArrangeActAssert/GivenWhenThen
testingPatternExplicitComment:
isExtensionEnabled:true
extensionConfigXML:junithelper-extension.xml
```
# Maven Plugin
## How to install
* pom.xml
```xml
...
org.junithelper
maven-junithelper-plugin
...
```
Following is an example of configuration:
```xml
...
org.junithelper
maven-junithelper-plugin
en
UTF-8
forceNewFileCRLF
false
4
src/main/java
src/test/java
version4
junit.framework.TestCase
true
true
true
true
true
true
true
false
_
A
$
R
$
T
$
true
junithelper-extension.xml
...
```
## How to use
### Goals
* `junithelper:make`
This goal is used to execute adding or updating tests. It is possible to specify targets by adding "target" option, for example "mvn junithelper:make -Dtarget=src/main/java/snippet/" or "mvn junithelper:make -Dtarget=src/main/java/snippet/Sample.java".
* `junithepler:force3`
This goal is used to execute converting tests to JUnit 3.x style. "-Dtarget=***" is also availale.
* `junithelper:force4`
This goal is used to execute converting tests to JUnit 4.x style. "-Dtarget=***" is also availale.
```sh
$ mvn junithelper:make
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Building maven-junithelper-plugin Maven Mojo
[INFO] task-segment: [junithelper:make]
[INFO] ------------------------------------------------------------------------
[INFO] [junithelper:make {execution: default-cli}]
_
/ _ ._/_/_/_ /_ _ _
(_//_// // / / //_'//_//_'/
/
JUnit Helper version 1.12
Target: /Users/seratch/IdeaProjects/sample/src/main/java/sample/SampleBean.java
Are you sure?(y/n)
```
# JUnit Helper Extension
## What's this?
You can customize JUnit Helper's template generation.
## How to use
* Eclipse Plugin
Put junithelper-extension.xml in the project root directory. If you also put junithelper-config.properties, it is required to change "isExtensionEnabled" to true.
* Command Line Script
Change "isExtensionEnabled" to true in junithelper-config.properties and edit junithelper-extension.xml.
* Maven plugin
Add configuration in pom.xml and put junithelper-extension.xml in the project root directory.
```xml
org.junithelper
maven-junithelper-plugin
true
junithelper-extension.xml
```
## junithelper-extension.xml
* instantiation
Customize the default way to instantiate.
* arg
Add customized parameter-range testing patterns to each type of argument.
* return
Add customized assertions to each type of return value.
```xml
Calendar.getInstance()
{instance}.add(Calendar.DATE, -1)
java.io.ByteArrayInputStream
new ByteArrayInputStream(new byte[] {})
-1 0 1 2
java.util.Random
new Random().nextInt(10)
-1L 0L 1L 2L
-1.0D 0.0D 0.5D 1.0D
true false
null -1 0 1 2
null -1L 0L 1L 2L
null -1.0D 0.0D 0.5D 1.0D
null true false
null "" "2"
null new Date()
null Calendar.getInstance();
Calendar.getInstance();
{arg}.set(Calendar.YEAR, 2000);
{arg}.set(Calendar.MONTH, 2 - 1);
{arg}.set(Calendar.DATE, 29);
{arg}.set(Calendar.HOUR_OF_DAY, 0);
{arg}.set(Calendar.MINUTE, 0);
{arg}.set(Calendar.SECOND, 0);
{arg}.set(Calendar.MILLISECOND, 0);
Calendar.getInstance();
{arg}.set(Calendar.YEAR, 1999);
{arg}.set(Calendar.MONTH, 12 - 1);
{arg}.set(Calendar.DATE, 31);
{arg}.set(Calendar.HOUR_OF_DAY, 0);
{arg}.set(Calendar.MINUTE, 0);
{arg}.set(Calendar.SECOND, 0);
{arg}.set(Calendar.MILLISECOND, 0);
Calendar.getInstance();
{arg}.set(Calendar.YEAR, 2000);
{arg}.set(Calendar.MONTH, 1 - 1);
{arg}.set(Calendar.DATE, 1);
{arg}.set(Calendar.HOUR_OF_DAY, 0);
{arg}.set(Calendar.MINUTE, 0);
{arg}.set(Calendar.SECOND, 0);
{arg}.set(Calendar.MILLISECOND, 0);
Calendar.getInstance();
{arg}.set(Calendar.YEAR, 1995);
{arg}.set(Calendar.MONTH, 5 - 1);
{arg}.set(Calendar.DATE, 24);
{arg}.set(Calendar.HOUR_OF_DAY, 23);
{arg}.set(Calendar.MINUTE, 59);
{arg}.set(Calendar.SECOND, 59);
{arg}.set(Calendar.MILLISECOND, 0);
Calendar.getInstance();
{arg}.set(Calendar.YEAR, 1995);
{arg}.set(Calendar.MONTH, 5 - 1);
{arg}.set(Calendar.DATE, 25);
{arg}.set(Calendar.HOUR_OF_DAY, 0);
{arg}.set(Calendar.MINUTE, 0);
{arg}.set(Calendar.SECOND, 0);
{arg}.set(Calendar.MILLISECOND, 0);
org.joda.time.format.DateTimeFormat
null
DateTimeFormat.forPattern("yyyyMMddHHmmss").parseDateTime("19950525000000")
static org.hamcrest.Matchers.*
static org.junit.Assert.*
assertThat(actual, is(greaterThanOrEqualTo(0)));
assertThat(actual, is(lessThanOrEqualTo(Integer.MAX_VALUE)));
static org.hamcrest.Matchers.*
static org.junit.Assert.*
assertThat(actual, is(greaterThanOrEqualTo(0)));
assertThat(actual, is(lessThanOrEqualTo(Integer.MAX_VALUE)));
```
## JUnit Helper User Group
https://groups.google.com/group/junit-helper-group
本源码包内暂不包含可直接显示的源代码文件，请下载源码包。
