Include `AnnotatedElement` description in `@TempDir` log messages

[xenoterracide]

Given:

  @TempDir(cleanup = CleanupMode.ON_SUCCESS)
  File bareRepo;

  @TempDir(cleanup = CleanupMode.ON_SUCCESS)
  File projectDir;

When an error occurs

Then include variable name in messaging

Jan 27, 2025 11:56:57 AM org.junit.jupiter.engine.extension.TempDirectory$CloseablePath close
INFO: Skipping cleanup of temp dir /tmp/junit-3303696269557854236 for projectDir due to cleanup mode configuration.
Jan 27, 2025 11:56:57 AM org.junit.jupiter.engine.extension.TempDirectory$CloseablePath close
INFO: Skipping cleanup of temp dir bareRepo /tmp/junit-9223851550808936974 for bareRepo due to cleanup mode configuration.

existing behavior it's hard to tell which is which

Jan 27, 2025 11:56:57 AM org.junit.jupiter.engine.extension.TempDirectory$CloseablePath close
INFO: Skipping cleanup of temp dir /tmp/junit-3303696269557854236 due to cleanup mode configuration.
Jan 27, 2025 11:56:57 AM org.junit.jupiter.engine.extension.TempDirectory$CloseablePath close
INFO: Skipping cleanup of temp dir /tmp/junit-9223851550808936974 due to cleanup mode configuration.

I'm not fussy on how the field name is output, I'd just like to see it in this messaging. P.S. Thanks for CleanupMode, love it.

[sbrannen]

Indeed, that would improve the diagnostics.

I'm not fussy on how the field name is output, I'd just like to see it in this messaging.

It's not just about fields but rather fields and parameters (i.e., the AnnotatedElement on which @TempDir is declared). We should be able to access that via the AnnotatedElementContext, and I've updated the title of this issue to reflect that.

Speaking of which, we may want to include more than just the name -- for example, "... for field XYZ" or "... for parameter XYZ".

P.S. Thanks for CleanupMode, love it.

Glad to hear it.

[marcphilipp]

I'm not fussy on how the field name is output, I'd just like to see it in this messaging.

It's not just about fields but rather fields and parameters (i.e., the AnnotatedElement on which @TempDir is declared). We should be able to access that via the AnnotatedElementContext, and I've updated the title of this issue to reflect that.

Speaking of which, we may want to include more than just the name -- for example, "... for field XYZ" or "... for parameter XYZ".

I did a quick experiment and included AnnotatedElement.toString() in the logged message. I'm afraid the result is not very readable:

Skipping cleanup of temp directory /tmp/junit-17443529230999080485 (declared in java.nio.file.Path org.junit.jupiter.engine.extension.TempDirectoryCleanupTests$TempDirFieldTests$DefaultFieldCase.defaultFieldDir) due to NEVER cleanup mode.

I think we can omit the type of the field or parameter (java.nio.file.Path in this case) but we should include the FQCN in addition to the field/parameter name because it's not necessarily declared directly in the test class but may be inherited. Thoughts?

[sbrannen]

I think we can omit the type of the field or parameter (java.nio.file.Path in this case) but we should include the FQCN in addition to the field/parameter name because it's not necessarily declared directly in the test class but may be inherited. Thoughts?

Sorry: I didn't realize you had commented on this issue in the interim.

I had already started looking into this and forgot to assign myself.

Yes, I was thinking along the lines of the fully-qualified name of the annotated element or perhaps a shortened variant of that (the XYZ), excluding the type and including the word "field" or "parameter", hence my previous statement about "... for field XYZ" or "... for parameter XYZ".

[sbrannen]

@marcphilipp, this is what I currently have in my prototype.

Parameter:

INFO: Skipping cleanup of temp dir /tmp/junit-14650606712517209045 for parameter tempDirParameter in CleanupModeDemo.fileTest() due to cleanup mode configuration.

Field:

INFO: Skipping cleanup of temp dir /tmp/junit-8961957783960616710 for field CleanupModeDemo.tempDirField due to cleanup mode configuration.

WDYT?