Easy and declarative way to execute sql queries in JUnit tests.
- Provide rich API to code sql queries that are executed in tests written on JUnit 5.
- Simplify sql queries maintaining in code base.
- Provide library independent of various frameworks (Uses only standard Java library and Junit 5 compile dependency)
There are three annotations:
- DbChange
- DbChangeOnce
- SqlExecutorGetter
Provide meta information about RDBMS changes before/after EACH test execution in class.
Provide meta information about RDBMS changes before/after ALL tests execution in class.
Set default sql executor for all tests in class. Value in this annotation should be the name of public method in test class that returns instance of DefaultSqlExecutor.
Annotations position in code:
@ExtendWith(DbChangeExtension.class)
@DbChangeOnce
@SqlExecutorGetter
public class DbChangeUsageTest {
@Test
@DbChange
void test() {
}
}- Open to edit
build.gradle.kts(orbuild.gradlefor groovy) - Add
Dbchangedependency to project
dependencies {
testImplementation("io.github.darrmirr:dbchange:1.0.1")
}- Open to edit your project
pom.xml - Add
Dbchangedependency to dependecies section
<dependency>
<groupId>io.github.darrmirr</groupId>
<artifactId>dbchange</artifactId>
<version>1.0.1</version>
<scope>test</scope>
</dependency>- (mandatory) Put
@ExtendWith(DbChangeExtension.class)on test class. - (mandatory) Create public method in test class that returns instance of
DefaultSqlExecutor. - (optional) Put
@DbChangeOnceon test class - (optional) Put
@SqlExecutorGetteron test class - (optional) Put
@DbChangeon test method
Points to notice:
- If there are no annotations
@DbChangeOnceor@DbChangein test class then Dbchange library does nothing during test execution. - If
@SqlExecutorGetteris not present on test class then it is mandatory to set valuesqlExecutorGetterin each@DbChangeOnceand@DbChangeannotation. - If you use
@DbChangeOncein test then you have to initialize instance of DataSource class at test class constructor or in static context (for example, using JUnit annotation@BeforeAll)
Simple example:
@ExtendWith(DbChangeExtension.class)
@DbChangeOnce(sqlQueryFiles = "sql/database_init.sql")
@DbChangeOnce(sqlQueryFiles = "sql/database_destroy.sql", executionPhase = ExecutionPhase.AFTER_ALL)
@SqlExecutorGetter("defaultSqlExecutor")
public class DbChangeUsageTest {
private DataSource dataSource;
public DbChangeUsageTest() {
dataSource = // code to create instance of dataSource
}
public SqlExecutor defaultSqlExecutor() {
return new DefaultSqlExecutor(dataSource);
}
@Test
@DbChange(changeSet = InsertEmployee6Chained.class )
@DbChange(changeSet = DeleteEmployee6Chained.class , executionPhase = DbChange.ExecutionPhase.AFTER_TEST)
void changeSetChained() {
/* code omitted */
}
}There are following sql queries suppliers:
- statements
@Test
@DbChange(statements = {
"insert into department(id, name) values (14, 'dep14');",
"insert into occupation(id, name) values (8, 'occ8');",
"insert into employee(id, department_id, occupation_id, first_name, last_name) values (10, 14, 8, 'Ivan', 'Ivanov')"
})
@DbChange(statements = {
"delete from employee where id = 10;",
"delete from occupation where id = 8;",
"delete from department where id = 14;"
}, executionPhase = DbChange.ExecutionPhase.AFTER_TEST)
void statements() { /* code omited */ }- sql query files
@Test
@DbChange(sqlQueryFiles = {"sql/sqlqueryfiles/sqlQueryFilesTest1_init.sql", "sql/sqlqueryfiles/sqlQueryFilesTest2_init.sql"})
@DbChange(sqlQueryFiles = "sql/sqlqueryfiles/sqlQueryFilesTest_destroy.sql", executionPhase = DbChange.ExecutionPhase.AFTER_TEST)
void sqlQueryFiles() { /* code omited */ }- sql query getter
@Test
@DbChange(sqlQueryGetter = "testSqlQueryGetterInit")
@DbChange(sqlQueryGetter = "testSqlQueryGetterDestroy", executionPhase = DbChange.ExecutionPhase.AFTER_TEST)
void sqlQueryGetter() { /* code omited */ }
public SqlQueryGetter testSqlQueryGetterInit() { /* code omited */ }
public SqlQueryGetter testSqlQueryGetterDestroy() { /* code omited */ }- changeset
@Test
@DbChange(changeSet = InsertEmployee6Chained.class )
@DbChange(changeSet = DeleteEmployee6Chained.class , executionPhase = DbChange.ExecutionPhase.AFTER_TEST)
void changeSetChained() { /* code omited */ }- @MethodSource (only for JUnit parameterized test)
@ParameterizedTest
@MethodSource("sourceSqlQueryGetterParameterized")
void sqlQueryGetterParameterized(List<DbChangeMeta> dbChangeMetas, List<Department> expectedDepartments) { /* code omited */ }
public static Stream<Arguments> sourceSqlQueryGetterParameterized() { /* code omited */ }Notice:
- all sql queries suppliers (except
@MethodSource) are supported by@DbChangeand@DbChangeOnceannotations.
See usage example in com.github.darrmirr.dbchange.component.DbChangeUsageTest class.
Read article on medium.com for more details
Runtime:
- JRE 8
- JUnit 5.9+ in classpath
Development:
- JDK 8
- Gradle 7
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent