Sn0wyDay opened a new pull request, #873:
URL: https://github.com/apache/commons-io/pull/873
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
Thanks for your contribution to [Apache
Commons](https://commons.apache.org/)! Your help is appreciated!
Before you push a pull request, review this list:
- [x] Read the [contribution guidelines](CONTRIBUTING.md) for this project.
- [x] Read the [ASF Generative Tooling
Guidance](https://www.apache.org/legal/generative-tooling.html) if you use
Artificial Intelligence (AI).
- [x] I used AI to create any part of, or all of, this pull request. Which
AI tool was used to create this pull request, and to what extent did it
contribute?
- [ ] Run a successful build using the default
[Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command
line by itself.
- [x] Write unit tests that match behavioral changes, where the tests fail
if the changes to the runtime are not applied. This may not always be possible,
but it is a best practice.
- [x] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
- [ ] Each commit in the pull request should have a meaningful subject line
and body. Note that a maintainer may squash commits during the merge process.
## Summary
This PR updates `FileUtils.deleteQuietly(File)` so that it does not clean
the target contents when the input is a symbolic link to a directory.
Previously, `deleteQuietly()` checked `file.isDirectory()` and then called
`cleanDirectory(file)` before deleting the file. On platforms where a symbolic
link to a directory is treated as a directory, this could remove the contents
of the symlink target before deleting the symlink itself.
`deleteDirectory()` already avoids this behavior by checking
`!isSymlink(directory)` before cleaning directory contents. This PR applies the
same safety check to `deleteQuietly()` for consistency.
## Change
Before:
```java
if (file.isDirectory()) {
cleanDirectory(file);
}
```
After:
```java
if (file.isDirectory() && !isSymlink(file)) {
cleanDirectory(file);
}
```
## Tests
Added a regression test to verify that calling `deleteQuietly()` on a
symlinked directory deletes only the symlink and preserves the target directory
contents.
The following tests passed locally:
```text
mvn
-Dtest=FileUtilsCleanSymlinksTest#testDeleteQuietlyWithASymlinkDirDeletesOnlyLink
test
mvn -Dtest=FileUtilsCleanSymlinksTest test
```
## AI tooling disclosure
AI-assisted tools were used to help identify the candidate issue and draft
the initial patch explanation. The final code change and test were reviewed and
validated manually before submission.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
