New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add @JooqTest support #9343
Closed
Closed
Add @JooqTest support #9343
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
f1c4685
Add jOOQ to test dependencies
michael-simons 4bc8b1b
Provide @JooqTest
michael-simons 79ea61a
Add documentation for @JooqTest
michael-simons 675f7de
Implement requested changes
michael-simons b1b9cfa
Add package-info
michael-simons 643239a
Make sure that the dialect fits with the replacement database
michael-simons File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
...ure/src/main/java/org/springframework/boot/test/autoconfigure/jooq/AutoConfigureJooq.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
/* | ||
* Copyright 2012-2017 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.boot.test.autoconfigure.jooq; | ||
|
||
import java.lang.annotation.Documented; | ||
import java.lang.annotation.ElementType; | ||
import java.lang.annotation.Retention; | ||
import java.lang.annotation.RetentionPolicy; | ||
import java.lang.annotation.Target; | ||
|
||
import org.springframework.boot.autoconfigure.ImportAutoConfiguration; | ||
|
||
/** | ||
* {@link ImportAutoConfiguration Auto-configuration imports} for typical jOOQ tests. Most | ||
* tests should consider using {@link JooqTest @JooqTest} rather than using this | ||
* annotation directly. | ||
* | ||
* @author Michael Simons | ||
* @since 2.0.0 | ||
*/ | ||
@Target(ElementType.TYPE) | ||
@Retention(RetentionPolicy.RUNTIME) | ||
@Documented | ||
@ImportAutoConfiguration | ||
public @interface AutoConfigureJooq { | ||
|
||
} |
97 changes: 97 additions & 0 deletions
97
...utoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/jooq/JooqTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
/* | ||
* Copyright 2012-2017 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.boot.test.autoconfigure.jooq; | ||
|
||
import java.lang.annotation.Documented; | ||
import java.lang.annotation.ElementType; | ||
import java.lang.annotation.Inherited; | ||
import java.lang.annotation.Retention; | ||
import java.lang.annotation.RetentionPolicy; | ||
import java.lang.annotation.Target; | ||
|
||
import org.springframework.boot.autoconfigure.ImportAutoConfiguration; | ||
import org.springframework.boot.autoconfigure.SpringBootApplication; | ||
import org.springframework.boot.test.autoconfigure.OverrideAutoConfiguration; | ||
import org.springframework.boot.test.autoconfigure.filter.TypeExcludeFilters; | ||
import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase; | ||
import org.springframework.boot.test.context.SpringBootTestContextBootstrapper; | ||
import org.springframework.context.annotation.ComponentScan.Filter; | ||
import org.springframework.core.annotation.AliasFor; | ||
import org.springframework.test.context.BootstrapWith; | ||
import org.springframework.transaction.annotation.Transactional; | ||
|
||
/** | ||
* Annotation that can be used in combination with {@code @RunWith(SpringRunner.class)} | ||
* for a typical jOOQ test. Can be used when a test focuses <strong>only</strong> on | ||
* jOOQ-based components. | ||
* <p> | ||
* Using this annotation will disable full auto-configuration and instead apply only | ||
* configuration relevant to jOOQ tests. | ||
* <p> | ||
* By default, tests annotated with {@code @JooqTest} will use an embedded in-memory | ||
* database (replacing any explicit or usually auto-configured DataSource). Since | ||
* jOOQ relies heavily on a Java-based schema that corresponds with the database schema, | ||
* that is propably not what you want. The | ||
* {@link AutoConfigureTestDatabase @AutoConfigureTestDatabase} annotation can be used | ||
* to override these settings. | ||
* | ||
* @author Michael Simons | ||
* @since 2.0.0 | ||
*/ | ||
@Target(ElementType.TYPE) | ||
@Retention(RetentionPolicy.RUNTIME) | ||
@Documented | ||
@Inherited | ||
@BootstrapWith(SpringBootTestContextBootstrapper.class) | ||
@OverrideAutoConfiguration(enabled = false) | ||
@TypeExcludeFilters(JooqTypeExcludeFilter.class) | ||
@Transactional | ||
@AutoConfigureJooq | ||
@AutoConfigureTestDatabase | ||
@ImportAutoConfiguration | ||
public @interface JooqTest { | ||
/** | ||
* Determines if default filtering should be used with | ||
* {@link SpringBootApplication @SpringBootApplication}. By default no beans are | ||
* included. | ||
* @see #includeFilters() | ||
* @see #excludeFilters() | ||
* @return if default filters should be used | ||
*/ | ||
boolean useDefaultFilters() default true; | ||
|
||
/** | ||
* A set of include filters which can be used to add otherwise filtered beans to the | ||
* application context. | ||
* @return include filters to apply | ||
*/ | ||
Filter[] includeFilters() default {}; | ||
|
||
/** | ||
* A set of exclude filters which can be used to filter beans that would otherwise be | ||
* added to the application context. | ||
* @return exclude filters to apply | ||
*/ | ||
Filter[] excludeFilters() default {}; | ||
|
||
/** | ||
* Auto-configuration exclusions that should be applied for this test. | ||
* @return auto-configuration exclusions to apply | ||
*/ | ||
@AliasFor(annotation = ImportAutoConfiguration.class, attribute = "exclude") | ||
Class<?>[] excludeAutoConfiguration() default {}; | ||
} |
73 changes: 73 additions & 0 deletions
73
...src/main/java/org/springframework/boot/test/autoconfigure/jooq/JooqTypeExcludeFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
/* | ||
* Copyright 2012-2017 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.boot.test.autoconfigure.jooq; | ||
|
||
import java.util.Collections; | ||
import java.util.Set; | ||
|
||
import org.springframework.boot.context.TypeExcludeFilter; | ||
import org.springframework.boot.test.autoconfigure.filter.AnnotationCustomizableTypeExcludeFilter; | ||
import org.springframework.context.annotation.ComponentScan.Filter; | ||
import org.springframework.core.annotation.AnnotatedElementUtils; | ||
|
||
/** | ||
* {@link TypeExcludeFilter} for {@link JooqTest @JooqTest}. | ||
* | ||
* @author Michael Simons | ||
*/ | ||
class JooqTypeExcludeFilter extends AnnotationCustomizableTypeExcludeFilter { | ||
|
||
private final JooqTest annotation; | ||
|
||
JooqTypeExcludeFilter(Class<?> testClass) { | ||
this.annotation = AnnotatedElementUtils.getMergedAnnotation(testClass, | ||
JooqTest.class); | ||
} | ||
|
||
@Override | ||
protected boolean hasAnnotation() { | ||
return this.annotation != null; | ||
} | ||
|
||
@Override | ||
protected Filter[] getFilters(final FilterType type) { | ||
switch (type) { | ||
case INCLUDE: | ||
return this.annotation.includeFilters(); | ||
case EXCLUDE: | ||
return this.annotation.excludeFilters(); | ||
default: | ||
throw new IllegalStateException("Unsupported type " + type); | ||
} | ||
} | ||
|
||
@Override | ||
protected boolean isUseDefaultFilters() { | ||
return this.annotation.useDefaultFilters(); | ||
} | ||
|
||
@Override | ||
protected Set<Class<?>> getDefaultIncludes() { | ||
return Collections.emptySet(); | ||
} | ||
|
||
@Override | ||
protected Set<Class<?>> getComponentIncludes() { | ||
return Collections.emptySet(); | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
...rc/test/java/org/springframework/boot/test/autoconfigure/jooq/ExampleJooqApplication.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
/* | ||
* Copyright 2012-2017 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.boot.test.autoconfigure.jooq; | ||
|
||
import javax.sql.DataSource; | ||
|
||
import org.springframework.boot.autoconfigure.SpringBootApplication; | ||
import org.springframework.context.annotation.Bean; | ||
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; | ||
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType; | ||
|
||
/** | ||
* Example {@link SpringBootApplication} used with {@link JooqTest} tests. | ||
* | ||
* @author Michael Simons | ||
*/ | ||
@SpringBootApplication | ||
public class ExampleJooqApplication { | ||
|
||
@Bean | ||
public DataSource dataSource() { | ||
EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder() | ||
.generateUniqueName(true).setType(EmbeddedDatabaseType.HSQL); | ||
return builder.build(); | ||
} | ||
|
||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am confused. Why is the default behaviour of the annotation not what the use wants? The purpose of a slice annotation is to do the right thing by default!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
jOOQ depends heavily on the fact that the current database scheme is in sync with the generated Java based scheme. Otherwise queries derived from jOOQ generated classes will break.
I assumed that you would favor this PR more if
@JooqTest
would behave like the other slices related to databases.I am using something like
@JooqTest
without embedded database right now and would turn it off in most cases.If it's ok with the slice doing that thing different than the other databases slices, super fine with me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Of course it is ok. The purpose of a dedicated slice annotation is that it's doing a dedicated job for the task at hand. I've merged your PR with that modification, please review the polish commit. Thanks!