Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reduce scope and surface area of TempDirectory extension #1752

Closed
7 tasks done
marcphilipp opened this issue Jan 27, 2019 · 7 comments
Closed
7 tasks done

Reduce scope and surface area of TempDirectory extension #1752

marcphilipp opened this issue Jan 27, 2019 · 7 comments
Assignees
@sbrannen
Labels
component: Jupiter theme: extensions
Milestone
5.4 RC2

Comments

@marcphilipp
Copy link
Member

marcphilipp commented Jan 27, 2019 •
edited by sbrannen
Loading

Since there are currently multiple issues (e.g. #864 and #1672) that might change how extensions that provide resources are written and registered, we should hide the implementation of @TempDir so we can easily change it in a future release.

Deliverables

  • Remove support for custom file systems, i.e. remove ParentDirProvider and TempDirContext.
  • Make @TempDir a top-level type.
  • Move appropriate Javadoc from TempDirectory to @TempDir.
  • Move TempDirectory to junit-jupiter-engine and make it package-private.
  • Register TempDirectory as a default extension.
  • Update existing documentation in User Guide.
  • Document breaking changes in Release Notes.
@marcphilipp marcphilipp added this to the 5.4 RC2 milestone Jan 27, 2019
@sbrannen
Copy link
Member

sbrannen commented Jan 27, 2019 •
edited
Loading

Let's consider relocating @TempDir to the org.junit.jupiter.api package as well.

@sbrannen sbrannen self-assigned this Jan 27, 2019
@sbrannen
Copy link
Member

in progress

sbrannen added a commit that referenced this issue Jan 27, 2019
@sbrannen
Remove custom file system support in TempDirectory extension
73dfc23 
In order to reduce the scope of the TempDirectory extension in JUnit
Jupiter 5.4, this commit removes the support for custom file systems
and temporary directory names by removing the ParentDirProvider and
TempDirContext APIs and corresponding factory methods.

Issue: #1752
@sbrannen
Copy link
Member

Update: 1st deliverable completed

@sbrannen
Copy link
Member

in progress

sbrannen added a commit that referenced this issue Jan 28, 2019
@sbrannen
Move @tempdir to a top-level type
73a9a73 
In order to simplify use of the TempDirectory extension in JUnit Jupiter
5.4, this commit moves the @tempdir annotation to a top-level type in a
new org.junit.jupiter.api.io package.

Issue: #1752
@sbrannen
Copy link
Member

Let's consider relocating @TempDir to the org.junit.jupiter.api package as well.

For the time being, I have moved the @TempDir annotation to a top-level type in a new org.junit.jupiter.api.io package.

sbrannen added a commit that referenced this issue Jan 28, 2019
@sbrannen
Move TempDirectory to Jupiter engine and register it by default
aacf6b8 
In order to simplify use of @tempdir support in JUnit Jupiter 5.4, this
commit moves the TempDirectory extension to the Jupiter TestEngine
internals and registers it by default.

Consequently, users may now use @tempdir without having to register
an extension for it to work.

Issue: #1752
sbrannen added a commit that referenced this issue Jan 28, 2019
@sbrannen
Add missing @SInCE and @API declarations to @tempdir
f914479 
Issue: #1752
sbrannen added a commit that referenced this issue Jan 28, 2019
@sbrannen
Fix link to TempDirectory in User Guide
ef2a325 
Issue: #1752
sbrannen added a commit that referenced this issue Jan 28, 2019
@sbrannen
Update User Guide regarding @tempdir changes
cbd10c6 
Issue: #1752
sbrannen added a commit that referenced this issue Jan 28, 2019
@sbrannen
Polish Javadoc for @tempdir
e5096d3 
Issue: #1752
sbrannen added a commit that referenced this issue Jan 28, 2019
@sbrannen
Document @tempdir changes in the Release Notes
fc973be 
Issue: #1752
@sbrannen
Copy link
Member

Closing this issue since all deliverables have been completed in master.

@ghost ghost removed the status: in progress label Jan 28, 2019
@snicoll snicoll mentioned this issue Jan 28, 2019
Closed
sbrannen added a commit that referenced this issue Jan 28, 2019
@sbrannen
Move TempDirectoryTests to appropriate package
cda6081 
Issue: #1752
@sbrannen sbrannen mentioned this issue Jan 28, 2019
Closed
2 tasks
@snicoll
Copy link

snicoll commented Jan 28, 2019

Register TempDirectory as a default extension.

That is very nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sbrannen sbrannen

Labels
component: Jupiter theme: extensions
Projects
None yet
Milestone
5.4 RC2
Development

No branches or pull requests
3 participants
@sbrannen @marcphilipp @snicoll