Provide easy way for QuarkusTestResourceLifecycleManager implementations to inject into test #18714

geoand · 2021-07-15T10:20:52Z

Resolves: #18698

mkouba · 2021-07-15T11:04:05Z

...amework/common/src/main/java/io/quarkus/test/common/QuarkusTestResourceLifecycleManager.java

+         * @param annotations Optional annotations that the field must have. If more than one are specified, the field
+         *        must be annotated with all the provided annotations
+         */
+        void injectIntoFields(Object fieldValue, Class<?> fieldType, Class<? extends Annotation>... annotations);


Maybe you could add a variant with javax.enterprise.util.TypeLiteral<?> fieldType to handle the parameterized types but the problem is that you would have to specify the rules for matching... or rely on existing rules, e.g. from CDI. But these need to be inherently complex and thus it's probably not worth the effort.

Good point!

I would prefer we start with this simple approach for now and keep your suggestion in mind for when / if people need something more complex

quarkus-bot · 2021-07-15T11:31:21Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `eb43068`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Gradle Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
⌛	JVM Tests - JDK 11	`Build`	⚠️ Check →	Logs	Raw logs
⌛	JVM Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
⌛	JVM Tests - JDK 16	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Cache	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - DevTools Integration Tests		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - HTTP	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Messaging1	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Messaging2	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc1	`Download Maven Repo`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc2		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc3		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc4		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Security1	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Security2	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Security3	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Spring		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Windows - hibernate-validator		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - gRPC		⚠️ Check →	Logs	Raw logs

quarkus-bot · 2021-07-15T14:46:20Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `ec38e0a`

Status	Name	Step	Test failures	Logs	Raw logs
✖	Gradle Tests - JDK 11	`Build`	Test failures	Logs	Raw logs

Full information is available in the Build summary check run.

Test Failures

⚙️ Gradle Tests - JDK 11 #

📦 integration-tests/gradle

✖ io.quarkus.gradle.MultiSourceProjectTest.shouldRunTest() line 16 - More details - Source on GitHub

famod · 2021-07-15T22:32:44Z

test-framework/common/src/main/java/io/quarkus/test/common/TestResourceManager.java

+                            if (annotationMatchResult == AnnotationMatchResult.MATCHED) {
+                                // if the annotations match, we throw an exception if the types don't match as it's almost certainly a user error
+                                // if however there were no annotation supplied, then we continue searching for candidate fields
+                                throw new RuntimeException("'" + Arrays.toString(annotations)


IIUC, this prevents some thing like:

@InjectTestObject Foo foo; @InjectTestObject Bar bar;

when injectIntoFields(foo, Foo.class, InjectTestObject.class) is called?

Isn't that too strict when a manager provides multiple objects that can be injected? I mean we would force users to create multiple annotations for that (or none at all).

That is indeed true.

When writing this, I did get the feeling that the type parameter is likely unnecessary.
What do you think about making it an Optional?

The thing is that then the method becomes difficult to use...

I think I'm going to do something different. I'll have two methods: One which only takes an annotation as a param and one which takes a Predicate. That way if more advanced checking is needed, a user can specify it.

Hmm, even though it's more "hidden"/less expressive than using an annotation, injection simply by type is the easiest option after all because the user doesn't have to implement an annotation for that (KISS).

So I think (ideally) there should be four options:

inject by type

inject by annotation

inject by type and annotation

inject by whatever via Predicate

The first tree methods could simply call that Predicate method... 🤔

And then you'll end up with a new CDI ;-).

I think that injectIntoFields(Object value, Predicate<Field> predicate) is flexible enough.

And I thought there is much more to CDI than that. 😉
Anyway, my primary focus was to support lazy devs (aka developer joy) but yeah, you can do everything with the Predicate.

I updated the PR. WDYT?

quarkus-bot · 2021-07-16T09:36:49Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `876caec`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Initial JDK 11 Build	`Build`	⚠️ Check →	Logs	Raw logs

famod

LGTM!
A MatchesType predicate would make it complete or even a dead simple injectIntoFields(Object fieldValue) that infers the type from fieldValue, but both can be added later.

mkouba

Looks good!

quarkus-bot · 2021-07-16T13:32:43Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `341d7e1`

Status	Name	Step	Test failures	Logs	Raw logs
✖	JVM Tests - JDK 11	`Build`	Test failures	Logs	Raw logs
✖	JVM Tests - JDK 11 Windows	`Build`	Test failures	Logs	Raw logs
✖	JVM Tests - JDK 16	`Build`	Test failures	Logs	Raw logs
✖	Native Tests - Misc3	`Build`	Test failures	Logs	Raw logs

Full information is available in the Build summary check run.

Test Failures

⚙️ JVM Tests - JDK 11 #

📦 integration-tests/openshift-client

✖ io.quarkus.it.openshift.client.OpenShiftClientTest.createRoute line 29 - More details - Source on GitHub

✖ io.quarkus.it.openshift.client.OpenShiftClientTest.getRoutes line 49 - More details - Source on GitHub

⚙️ JVM Tests - JDK 11 Windows #

📦 integration-tests/openshift-client

✖ io.quarkus.it.openshift.client.OpenShiftClientTest.createRoute line 29 - More details - Source on GitHub

✖ io.quarkus.it.openshift.client.OpenShiftClientTest.getRoutes line 49 - More details - Source on GitHub

⚙️ JVM Tests - JDK 16 #

📦 integration-tests/hibernate-reactive-panache

✖ io.quarkus.it.panache.reactive.PanacheFunctionalityTest.testPanacheFunctionality line 47 - More details - Source on GitHub

📦 integration-tests/openshift-client

✖ io.quarkus.it.openshift.client.OpenShiftClientTest.createRoute line 29 - More details - Source on GitHub

✖ io.quarkus.it.openshift.client.OpenShiftClientTest.getRoutes line 49 - More details - Source on GitHub

⚙️ Native Tests - Misc3 #

📦 integration-tests/openshift-client

✖ io.quarkus.it.openshift.client.OpenShiftClientTestIT.createRoute - More details - Source on GitHub

✖ io.quarkus.it.openshift.client.OpenShiftClientTestIT.getRoutes - More details - Source on GitHub

…ect into test Resolves: quarkusio#18698

quarkus-bot · 2021-07-16T14:00:38Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `3f640de`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Initial JDK 11 Build	`Build`	⚠️ Check →	Logs	Raw logs

FroMage

LGTM, sorry about the late review :(

docs/src/main/asciidoc/getting-started-testing.adoc

geoand mentioned this pull request Jul 15, 2021

Add basic injection capabilities to QuarkusTestResourceLifecycleManager #18698

Closed

quarkus-bot bot added area/documentation area/hibernate-search Hibernate Search area/testing labels Jul 15, 2021

geoand added triage/backport? and removed area/hibernate-search Hibernate Search labels Jul 15, 2021

mkouba reviewed Jul 15, 2021

View reviewed changes

geoand force-pushed the #18698 branch from eb43068 to ec38e0a Compare July 15, 2021 11:25

quarkus-bot bot added the area/hibernate-search Hibernate Search label Jul 15, 2021

famod reviewed Jul 15, 2021

View reviewed changes

geoand force-pushed the #18698 branch from ec38e0a to 876caec Compare July 16, 2021 09:34

geoand removed area/documentation area/hibernate-search Hibernate Search labels Jul 16, 2021

geoand force-pushed the #18698 branch from 876caec to 341d7e1 Compare July 16, 2021 09:36

quarkus-bot bot added area/documentation area/hibernate-search Hibernate Search labels Jul 16, 2021

famod approved these changes Jul 16, 2021

View reviewed changes

geoand changed the title ~~Provide easy way for QuarkusTestResourceLifecycleManager impls to inject into test~~ Provide easy way for QuarkusTestResourceLifecycleManager implementations to inject into test Jul 16, 2021

geoand added triage/waiting-for-ci Ready to merge when CI successfully finishes and removed area/hibernate-search Hibernate Search labels Jul 16, 2021

mkouba approved these changes Jul 16, 2021

View reviewed changes

geoand force-pushed the #18698 branch from 341d7e1 to 3f640de Compare July 16, 2021 13:46

quarkus-bot bot added the area/hibernate-search Hibernate Search label Jul 16, 2021

Provide easy way for QuarkusTestResourceLifecycleManager impls to inj…

2be876f

…ect into test Resolves: quarkusio#18698

geoand force-pushed the #18698 branch from 3f640de to 2be876f Compare July 16, 2021 13:59

geoand merged commit 328f64b into quarkusio:main Jul 16, 2021

quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jul 16, 2021

quarkus-bot bot added this to the 2.2 - main milestone Jul 16, 2021

geoand deleted the #18698 branch July 17, 2021 07:46

gsmet modified the milestones: 2.2 - main, 2.1.0.Final Jul 19, 2021

gsmet removed the triage/backport? label Jul 19, 2021

manusa mentioned this pull request Jul 22, 2021

Introduce @WithOpenShiftTestServer annotation #18929

Merged

FroMage reviewed Jul 27, 2021

View reviewed changes

docs/src/main/asciidoc/getting-started-testing.adoc Show resolved Hide resolved

Provide easy way for QuarkusTestResourceLifecycleManager implementations to inject into test #18714

Provide easy way for QuarkusTestResourceLifecycleManager implementations to inject into test #18714

Conversation

geoand commented Jul 15, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

quarkus-bot bot commented Jul 15, 2021 • edited Loading

Failing Jobs - Building eb43068

quarkus-bot bot commented Jul 15, 2021 • edited Loading

Failing Jobs - Building ec38e0a

Test Failures

⚙️ Gradle Tests - JDK 11 #

📦 integration-tests/gradle

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

famod Jul 16, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

famod Jul 16, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

quarkus-bot bot commented Jul 16, 2021 • edited Loading

Failing Jobs - Building 876caec

famod left a comment

Choose a reason for hiding this comment

mkouba left a comment

Choose a reason for hiding this comment

quarkus-bot bot commented Jul 16, 2021 • edited Loading

Failing Jobs - Building 341d7e1

Test Failures

⚙️ JVM Tests - JDK 11 #

📦 integration-tests/openshift-client

⚙️ JVM Tests - JDK 11 Windows #

📦 integration-tests/openshift-client

⚙️ JVM Tests - JDK 16 #

📦 integration-tests/hibernate-reactive-panache

📦 integration-tests/openshift-client

⚙️ Native Tests - Misc3 #

📦 integration-tests/openshift-client

quarkus-bot bot commented Jul 16, 2021 • edited Loading

Failing Jobs - Building 3f640de

FroMage left a comment

Choose a reason for hiding this comment

quarkus-bot bot commented Jul 15, 2021 •

edited

Loading

Failing Jobs - Building `eb43068`

quarkus-bot bot commented Jul 15, 2021 •

edited

Loading

Failing Jobs - Building `ec38e0a`

famod Jul 16, 2021 •

edited

Loading

famod Jul 16, 2021 •

edited

Loading

quarkus-bot bot commented Jul 16, 2021 •

edited

Loading

Failing Jobs - Building `876caec`

quarkus-bot bot commented Jul 16, 2021 •

edited

Loading

Failing Jobs - Building `341d7e1`

quarkus-bot bot commented Jul 16, 2021 •

edited

Loading

Failing Jobs - Building `3f640de`