Create new temporary directory/resource extension #491

jbduncan · 2021-05-29T19:48:54Z

Proposed commit message:

${action} (${issues} / ${pull-request}) [max 70 characters]

${body} [max 70 characters per line]

${references}: ${issues}
PR: ${pull-request}

PR checklist

The following checklist shall help the PR's author, the reviewers and maintainers to ensure the quality of this project.
It is based on our contributors guidelines, especially the "writing code" section.
It shall help to check for completion of the listed points.
If a point does not apply to the given PR's changes, the corresponding entry can be simply marked as done.

Documentation (general)

There is documentation (Javadoc and site documentation; added or updated)
There is implementation information to describe why a non-obvious source code / solution got implemented
Site documentation has its own .adoc file in the docs folder, e.g. docs/report-entries.adoc
Only one sentence per line (especially in .adoc files)
Javadoc uses formal style, while sites documentation may use informal style

Documentation (new extension)

The docs/docs-nav.yml navigation has an entry for the new extension
The package-info.java contains information about the new extension

Code

Code adheres to code style, naming conventions etc.
Successful tests cover all changes
There are checks which validate correct / false usage / configuration of a functionality and there are tests to verify those checks
Tests use AssertJ or our own PioneerAssert (which are based on AssertJ)

Contributing

A prepared commit message exists
The list of contributions inside README.md mentions the new contribution (real name optional)

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

nipafx

This looks good and is definitely going into the right direction. Keep at it. 😉 (And don't hesitate to let us know if you don't have the time or interest for it any more. We don't want to put pressure on you completing this.)

nipafx · 2021-07-27T17:22:55Z

buildSrc/build.gradle

-							IssueNavigationLink {
-								option(name: "issueRegexp", value: '#(\\d+)')
-								option(name: "linkRegexp", value: 'https://github.com/junit-pioneer/junit-pioneer/issues/$1')
+			if (xmlFile.exists() && xmlFile.isFile()) {


You added this check, right? Can you let us know why it was necessary? If we need to change this file, we should so it in a separate change.

I did indeed. It was necessary because when I imported this project into my IntelliJ IDEA, the file .idea/vcs.xml was absent for some bizarre reason. So whenever I tried to run any of the Gradle tasks, it threw an exception upon trying to parse the file.

That's a good shout, putting this in a separate change. Given I'm busy IRL, is this something that someone from the core team would be able to handle? If not, then that's fine, as I've just put it in my TODO list.

nipafx · 2021-07-27T17:28:37Z

src/main/java/org/junitpioneer/jupiter/TemporaryDirectory.java

+
+			@Override
+			public Path get() throws Exception {
+				return (tempDir = Files.createTempDirectory(prefix));


Doesn't this reassign a new tempDir every time get() is called? Generally speaking, I'd prefer to have a final field, whose value gets assigned on creation.

It does. I assumed that Resource::get will be called at most once by the extension and will never be called by user code.

I drove out this code in a "minimalist" TDD fashion, without thinking much, so thanks for pointing out the flaw! It's now in the TODO list.

nipafx · 2021-07-27T17:29:31Z