Provide access to source element annotations for TempDirFactory

[scordio]

Overview

Closes #3390.

---

I hereby agree to the terms of the JUnit Contributor License Agreement.

---

Definition of Done

• There are no TODOs left in the code
• Method preconditions are checked and documented in the method's Javadoc
• Coding conventions (e.g. for logging) have been followed
• Change is covered by automated tests including corner cases, errors, and exception handling
• Public API has Javadoc and @API annotations
• Change is documented in the User Guide and Release Notes

[scordio]

@marschall could you please point me to some real-life usage so that I can put together the corresponding tests?

memoryfilesystem is already in the test scope so we should be able to stay as close as possible to what you have in mind.

[sbrannen]

could you please point me to some real-life usage so that I can put together the corresponding tests?

How about a custom @TempDirPrefix(<String value()>) annotation that your custom TempDirFactory uses to look up the prefix?

[marcphilipp]

Looking good! Please add tests accessing getAnnotatedElement for a field and parameter as discussed above.

[scordio]

I assume this change doesn't require an entry in the release notes, right?

[marschall]

@marschall could you please point me to some real-life usage so that I can put together the corresponding tests?

memoryfilesystem is already in the test scope so we should be able to stay as close as possible to what you have in mind.

Sure, here's the implementation of the factory, built against this PR

https://github.com/marschall/memoryfilesystem-junit-provider/blob/master/src/main/java/com/github/marschall/memoryfilesystem/junit/MemoryFileSystemTempDirFactory.java

Here's the meta-annotation

https://github.com/marschall/memoryfilesystem-junit-provider/blob/master/src/main/java/com/github/marschall/memoryfilesystem/junit/WindowsMemoryTempDir.java

Here's the integration test

https://github.com/marschall/memoryfilesystem-junit-provider/blob/master/src/test/java/com/github/marschall/memoryfilesystem/junit/WindowsMemoryTempDirTests.java

A test may look something like this.

marschall@eb58e90

This code is quite rushed and can obviously be improved. First would probably be the names. A extension of the existing test rather than copy and pasting would probably be next. Feel free to cherry pick and improve upon it.

[marcphilipp]

I assume this change doesn't require an entry in the release notes, right?

If we're going directly to GA, we don't need an extra entry. I'm considering doing an RC2 release. If I decide to go for that, I'll add a release note entry myself.

[scordio]

A test may look something like this.

marschall@eb58e90

Thanks, I've improved the existing test along these lines in ea6d11d.

[scordio]

All feedback applied, @marcphilipp and @sbrannen. I don't expect further changes unless you see something.

Some jobs are failing but it seems to be a remote issue:

* What went wrong:
A problem occurred configuring root project 'junit5'.
> Could not resolve all files for configuration ':classpath'.
   > Could not download nohttp-0.0.11.jar (io.spring.nohttp:nohttp:0.0.11)
      > Could not get resource 'https://plugins.gradle.org/m2/io/spring/nohttp/nohttp/0.0.11/nohttp-0.0.11.jar'.
         > Could not GET 'https://jcenter.bintray.com/io/spring/nohttp/nohttp/0.0.11/nohttp-0.0.11.jar'. Received status code 502 from server: Bad Gateway

Lastly, I left unchecked the release notes task based on #3394 (comment).

[marcphilipp]

@scordio Thanks tons for the quick turnaround on this! 👍