Skip to content

Commit 53c9612

Browse files
committed
init project
0 parents  commit 53c9612

File tree

7 files changed

+478
-0
lines changed

7 files changed

+478
-0
lines changed

Diff for: README.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Java Test Code 작성법(JUnit5 기준)
2+
Spring 2.2 이상 버전의 SpringBoot 프로젝트 생성시 기본적으로 JUnit5 의존성이 포함된다.
3+
4+
### 의존성 추가(SpringBoot-starter-test 의존성을 사용하지 않는 경우)
5+
#### Maven
6+
```xml
7+
<!-- https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-api -->
8+
<dependency>
9+
<groupId>org.junit.jupiter</groupId>
10+
<artifactId>junit-jupiter-api</artifactId>
11+
<version>5.5.2</version>
12+
<scope>test</scope>
13+
</dependency>
14+
```
15+
#### Gradle
16+
```groovy
17+
// https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-api
18+
testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.2'
19+
```
20+
21+
### Test Code 생성 방법(macOS Intellij 기준)
22+
default shortcut 기준으로 `command` + `N`으로 constructor, getter/setter 등을 만들 수 있는데, 이 때 test class도 생성할 수 있다.
23+
24+
### Test 실행 방법(macOS Intellij 기준)
25+
`ctrl` + `shift` + `R`
26+
* 특정 메서드에 커서가 있는 채로 누를 경우 해당 테스트 메서드만 실행된다.
27+
* 특정 메서드에 커서가 존재하지 않는 경우 해당 테스트 클래스 전체가 실행된다.
28+
29+
### Basic Annotation
30+
* @Test : 해당 메서드가 테스트 메서드임을 의미(main method가 아니어도 단독 실행이 가능하다.)
31+
* @Disabled : 해당 테스트를 호출되지 않게 한다. (클래스의 테스트 메서드를 모두 실행해도 해당 테스트 메서드는 실행되지 않는다.)
32+
* @BeforeAll : 모든 테스트 메서드가 호출되기 전에 호출된다.
33+
* @AfterAll : 모든 테스트 메서드가 호출된 후에 호출된다.
34+
* @BeforeEach : 모든 테스트 메서드가 호출될 때마다 앞서서 호출된다.
35+
* @AfterEach : 모든 테스트 메서드가 호출될 때마다 따라 호출된다.
36+
37+
### 테스트명 표시하기
38+
#### 1. @DisplayNameGeneration annotation 사용
39+
```java
40+
@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)
41+
class AppTest {
42+
@Test
43+
void create_new_app() {
44+
App app = new App();
45+
assertNotNull(app);
46+
}
47+
}
48+
```
49+
위의 경우에는 해당 테스트명이 `create new app`으로 표시되게 된다.
50+
51+
##### 인자로 제공되는 Name Generate 방식 - 기본 구현체로 제공하는 형태
52+
* ReplaceUnderscores : underscore(`_`)를 공백으로 치환한 이름을 만든다.
53+
* IndicativeSentences : 중첩된 클래스 또는 테스트 메서드로부터 지시문 생성(특정 문자열을 `{0}`과 같은 형태로 표시할 수 있다.)하여 이름을 만든다.
54+
- `@Test` 대신에 `@ParameterizedTest``@ValueSource`을 같이 쓴다.
55+
```java
56+
@DisplayNameGeneration(DisplayNameGenerator.IndicativeSentences)
57+
class AppTest {
58+
@ParameterizedTest(name = "Name is {0}")
59+
@ValueSource(ints = {1, 2, 3})
60+
void testFunc() {
61+
// ...
62+
}
63+
}
64+
```
65+
#### 2. DisplayName
66+
- `@DisplayNameGeneration`보다 우선순위가 높다.
67+
- 띄어쓰기나 한글, 이모지 등을 자유롭게 사용할 수 있다.

Diff for: build.gradle

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
plugins {
2+
id 'org.springframework.boot' version '2.7.4'
3+
id 'io.spring.dependency-management' version '1.0.14.RELEASE'
4+
id 'java'
5+
}
6+
7+
group = 'com.yh'
8+
version = '0.0.1-SNAPSHOT'
9+
sourceCompatibility = '11'
10+
11+
repositories {
12+
mavenCentral()
13+
}
14+
15+
dependencies {
16+
implementation 'org.springframework.boot:spring-boot-starter'
17+
testImplementation 'org.springframework.boot:spring-boot-starter-test'
18+
}
19+
20+
tasks.named('test') {
21+
useJUnitPlatform()
22+
}

Diff for: gradlew

+240
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,240 @@
1+
#!/bin/sh
2+
3+
#
4+
# Copyright © 2015-2021 the original authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
19+
##############################################################################
20+
#
21+
# Gradle start up script for POSIX generated by Gradle.
22+
#
23+
# Important for running:
24+
#
25+
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
26+
# noncompliant, but you have some other compliant shell such as ksh or
27+
# bash, then to run this script, type that shell name before the whole
28+
# command line, like:
29+
#
30+
# ksh Gradle
31+
#
32+
# Busybox and similar reduced shells will NOT work, because this script
33+
# requires all of these POSIX shell features:
34+
# * functions;
35+
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
36+
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
37+
# * compound commands having a testable exit status, especially «case»;
38+
# * various built-in commands including «command», «set», and «ulimit».
39+
#
40+
# Important for patching:
41+
#
42+
# (2) This script targets any POSIX shell, so it avoids extensions provided
43+
# by Bash, Ksh, etc; in particular arrays are avoided.
44+
#
45+
# The "traditional" practice of packing multiple parameters into a
46+
# space-separated string is a well documented source of bugs and security
47+
# problems, so this is (mostly) avoided, by progressively accumulating
48+
# options in "$@", and eventually passing that to Java.
49+
#
50+
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
51+
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
52+
# see the in-line comments for details.
53+
#
54+
# There are tweaks for specific operating systems such as AIX, CygWin,
55+
# Darwin, MinGW, and NonStop.
56+
#
57+
# (3) This script is generated from the Groovy template
58+
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
59+
# within the Gradle project.
60+
#
61+
# You can find Gradle at https://github.com/gradle/gradle/.
62+
#
63+
##############################################################################
64+
65+
# Attempt to set APP_HOME
66+
67+
# Resolve links: $0 may be a link
68+
app_path=$0
69+
70+
# Need this for daisy-chained symlinks.
71+
while
72+
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
73+
[ -h "$app_path" ]
74+
do
75+
ls=$( ls -ld "$app_path" )
76+
link=${ls#*' -> '}
77+
case $link in #(
78+
/*) app_path=$link ;; #(
79+
*) app_path=$APP_HOME$link ;;
80+
esac
81+
done
82+
83+
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
84+
85+
APP_NAME="Gradle"
86+
APP_BASE_NAME=${0##*/}
87+
88+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
89+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
90+
91+
# Use the maximum available, or set MAX_FD != -1 to use that value.
92+
MAX_FD=maximum
93+
94+
warn () {
95+
echo "$*"
96+
} >&2
97+
98+
die () {
99+
echo
100+
echo "$*"
101+
echo
102+
exit 1
103+
} >&2
104+
105+
# OS specific support (must be 'true' or 'false').
106+
cygwin=false
107+
msys=false
108+
darwin=false
109+
nonstop=false
110+
case "$( uname )" in #(
111+
CYGWIN* ) cygwin=true ;; #(
112+
Darwin* ) darwin=true ;; #(
113+
MSYS* | MINGW* ) msys=true ;; #(
114+
NONSTOP* ) nonstop=true ;;
115+
esac
116+
117+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
118+
119+
120+
# Determine the Java command to use to start the JVM.
121+
if [ -n "$JAVA_HOME" ] ; then
122+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123+
# IBM's JDK on AIX uses strange locations for the executables
124+
JAVACMD=$JAVA_HOME/jre/sh/java
125+
else
126+
JAVACMD=$JAVA_HOME/bin/java
127+
fi
128+
if [ ! -x "$JAVACMD" ] ; then
129+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130+
131+
Please set the JAVA_HOME variable in your environment to match the
132+
location of your Java installation."
133+
fi
134+
else
135+
JAVACMD=java
136+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137+
138+
Please set the JAVA_HOME variable in your environment to match the
139+
location of your Java installation."
140+
fi
141+
142+
# Increase the maximum file descriptors if we can.
143+
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
144+
case $MAX_FD in #(
145+
max*)
146+
MAX_FD=$( ulimit -H -n ) ||
147+
warn "Could not query maximum file descriptor limit"
148+
esac
149+
case $MAX_FD in #(
150+
'' | soft) :;; #(
151+
*)
152+
ulimit -n "$MAX_FD" ||
153+
warn "Could not set maximum file descriptor limit to $MAX_FD"
154+
esac
155+
fi
156+
157+
# Collect all arguments for the java command, stacking in reverse order:
158+
# * args from the command line
159+
# * the main class name
160+
# * -classpath
161+
# * -D...appname settings
162+
# * --module-path (only if needed)
163+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
164+
165+
# For Cygwin or MSYS, switch paths to Windows format before running java
166+
if "$cygwin" || "$msys" ; then
167+
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
168+
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
169+
170+
JAVACMD=$( cygpath --unix "$JAVACMD" )
171+
172+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
173+
for arg do
174+
if
175+
case $arg in #(
176+
-*) false ;; # don't mess with options #(
177+
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
178+
[ -e "$t" ] ;; #(
179+
*) false ;;
180+
esac
181+
then
182+
arg=$( cygpath --path --ignore --mixed "$arg" )
183+
fi
184+
# Roll the args list around exactly as many times as the number of
185+
# args, so each arg winds up back in the position where it started, but
186+
# possibly modified.
187+
#
188+
# NB: a `for` loop captures its iteration list before it begins, so
189+
# changing the positional parameters here affects neither the number of
190+
# iterations, nor the values presented in `arg`.
191+
shift # remove old arg
192+
set -- "$@" "$arg" # push replacement arg
193+
done
194+
fi
195+
196+
# Collect all arguments for the java command;
197+
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
198+
# shell script including quotes and variable substitutions, so put them in
199+
# double quotes to make sure that they get re-expanded; and
200+
# * put everything else in single quotes, so that it's not re-expanded.
201+
202+
set -- \
203+
"-Dorg.gradle.appname=$APP_BASE_NAME" \
204+
-classpath "$CLASSPATH" \
205+
org.gradle.wrapper.GradleWrapperMain \
206+
"$@"
207+
208+
# Stop when "xargs" is not available.
209+
if ! command -v xargs >/dev/null 2>&1
210+
then
211+
die "xargs is not available"
212+
fi
213+
214+
# Use "xargs" to parse quoted args.
215+
#
216+
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
217+
#
218+
# In Bash we could simply go:
219+
#
220+
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
221+
# set -- "${ARGS[@]}" "$@"
222+
#
223+
# but POSIX shell has neither arrays nor command substitution, so instead we
224+
# post-process each arg (as a line of input to sed) to backslash-escape any
225+
# character that might be a shell metacharacter, then use eval to reverse
226+
# that process (while maintaining the separation between arguments), and wrap
227+
# the whole thing up as a single "set" statement.
228+
#
229+
# This will of course break if any of these variables contains a newline or
230+
# an unmatched quote.
231+
#
232+
233+
eval "set -- $(
234+
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
235+
xargs -n1 |
236+
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
237+
tr '\n' ' '
238+
)" '"$@"'
239+
240+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)