Support for @WeldSetup annotated fields in test superclasses

[qmunke]

Currently if a test class inherits from a parent containing a field annotated with @WeldSetup, the WeldJUnit5Extension doesn't pick it up and creates a default instance - due to the call to Class#getDeclaredFields as opposed to Class#getFields. This leads to confusing errors depending on how you're trying to inject into the test (either getting "Container not started" if you reference the super's WeldInitiator from the subclass, or exceptions about unsatisfied dependencies if you try and @Inject a class that isn't picked up by the default instance)

See https://github.com/qmunke/weld-junit/commit/b77d16f10b4d75bd96a686a5c144fc0999c5e684 for a potential fix.

[manovotn]

Hello,

yea, you are right about this bug. Thanks for the effort with debugging/nailing it down.
Since you went this far already, would you mind creating a PR from your potential fix?

[mkouba]

Note that getFields() can only be used for public fields. We don't have this requirement ATM for junit5 extensions (for junit4 test rules must be declared public).

[qmunke]

The documentation doesn't indicate this:

WeldInitiator should be a public field annotated with @org.jboss.weld.junit5.WeldSetup. From there you can use static methods:

[mkouba]

@qmunke Well, you're right the docs say should be. I wonder if we should change this to must be or simply discover the class hierarchy and use getDeclaredFields(). @manovotn WDYT?

[manovotn]

The extension was designed to be able to access even non-public fields.
E.g. it uses setAccessible

I would prefer to retain this ability but the requirement to grab this field from superclass should definitely be supported. Maybe we should inspect the hierarchy but still allow non-public fields? The current class' field would be prioritized, but if there is none, we could inspect the hierarchy and search for any fitting field. Does that sound sane?

[mkouba]

Maybe we should inspect the hierarchy but still allow non-public fields?

+1

@qmunke something like this should work:

for (Class<?> clazz = testInstance.getClass(); clazz != null; clazz = clazz.getSuperclass()) {
  // Find @WeldSetup field using getDeclaredFields()...
}

[rakcheru]

@mkouba @manovotn : waiting for this fix to be available as part of weld-junit release. Any plans to release 1.2.2 soon ?

Note : technically, applying the fix on top of 1.2.1 is not a solution for us.

[mkouba]

@rakcheru Yes, we're going to release 1.2.2 later today or tomorrow morning (CET).