Create parameter resolver for class path resources

[nipafx]

An extension that makes it easy to read resources from src/test/resources as discussed in this tweet.

[nipafx]

One possible approach is shown in this reply to the tweet:

@Test
@ResourceRead("sub/anton.txt")
void asContentLines(ResourceContentLines resource) {
	resource.getContent();
}

@Test
@ResourceRead("sub/anton.txt")
void asContentString(ResourceContentString resource) {
	resource.getContent();
}

Another approach would be to always annotate the parameter (I'll keep using ResourceRead for continuity; I'm not proposing it as the annotation's name):

@Test
void asContentString(@ResourceRead("sub/anton.txt") String content) {
	// ...
}

Since we then know which parameter to provide a value for (and thus its type), we can resolve a wide variety of types:

• String by interpreting the entire file content as a single string
• Stream<String> from Files::lines
• any other collection of String by collecting to it
• File or Path for the file itself
• implicit conversion like Jupiter does for parameters
• explicit conversion like Jupiter does with a @ConvertWith annotation
• if we can determine the parametric type of a collection, we could even provide collections of T, where each line in the file is converted (as just described) to an instance of T

As to the annotation itself, it should probably offer the same attributes that the Files API offers when reading files (charset, [is there more?]).

[Michael1993]

JUnit does not register extensions from parameter annotations. Meaning this:

@Test
void asContentString(@ResourceRead("sub/anton.txt") String content) {

does not work.

[nipafx]

Ah right, I seem to forget this quite often... 🤦🏾 See linked issue ☝🏾 - maybe that can change.

[jbduncan]

As a side note, we might want to name the annotation @ResourceRead something like @ClasspathResource (or @ModulePathResource?), because my ongoing work will introduce another concept which so far is also called "resource".

But perhaps that indicates that I need to improve the name of my work's own "resource" thingie instead!

[Bukama]

String by interpreting the entire file content as a single string

Would really like to see this, to easily have the possibility to offer XML-Strings.

[Michael1993]

We are just too slow, it seems.

[Bukama]

Shall we ask him to integrate it into pioneer?

[nipafx]

Hi @khmarbaise, we'd like to have something like this in Pioneer. Would you be interested to integrate your project here (i.e. republish an adapted version of the code in this project)? :)

[khmarbaise]

Hi @nipafx sure sure why not ...