exceptionfactory opened a new pull request #5744:
URL: https://github.com/apache/nifi/pull/5744
#### Description of PR
NIFI-6699 Corrects handling of symbolic links for `GetSFTP` and `ListSFTP`
processors, which both use the `SFTPTransfer.getListing()` method to retrieve a
listing of remote file information.
The current behavior evaluates the `FileMode.Type` property of each remote
file and handles all symbolic links as directories when the the calling
processor has the `Follow symlink` property is enabled. With this approach,
`SFTPTransfer` adds all remote symbolic links to a list of directories selected
for recursion, including symbolic links to files. The results in a
`FileNotFoundException` when `SFTPTransfer` attempts to read a symbolic link
file as a directory.
To resolve this problem, the remote resource filter now performs a remote
`stat()` request when evaluating a symbolic link for potential inclusion as a
directory to read. The `stat()` request traverses the symbolic link on the
remote system and returns the associated file attributes, including directory
status. This approach allows the `SFTPTransfer` remote resource filter to
determine whether or not to process the symbolic link as a directory. The
additional `stat()` request is necessary because symbolic link attributes do
not indicate whether the link points to a regular file or directory.
The additional `stat()` request has a potential performance impact when
listing directories with large numbers of symbolic links. The `Follow symlink`
property is disabled by default, so this change does not impact default
processor behavior.
Additional changes include refactoring the `SFTPServer` test class now named
`TestServerSFTPTransfer` to run as a unit test. Updates to the test include
migrating to JUnit 5, allowing the test to run on all operating systems, and
leveraging the standard JUnit 5 `TempDir` annotation for the test SFTP server.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [X] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [X] Does your PR title start with **NIFI-XXXX** where XXXX is the JIRA
number you are trying to resolve? Pay particular attention to the hyphen "-"
character.
- [X] Has your PR been rebased against the latest commit within the target
branch (typically `main`)?
- [X] Is your initial contribution a single, squashed commit? _Additional
commits in response to PR reviewer feedback should be made on this branch and
pushed to allow change tracking. Do not `squash` or use `--force` when pushing
to allow for clean monitoring of changes._
### For code changes:
- [X] Have you ensured that the full suite of tests is executed via `mvn
-Pcontrib-check clean install` at the root `nifi` folder?
- [X] Have you written or updated unit tests to verify your changes?
- [X] Have you verified that the full build is successful on JDK 8?
- [X] Have you verified that the full build is successful on JDK 11?
- [ ] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the `LICENSE` file, including the main
`LICENSE` file under `nifi-assembly`?
- [ ] If applicable, have you updated the `NOTICE` file, including the main
`NOTICE` file found under `nifi-assembly`?
- [ ] If adding new Properties, have you added `.displayName` in addition to
.name (programmatic access) for each of the new properties?
### For documentation related changes:
- [ ] Have you ensured that format looks appropriate for the output in which
it is rendered?
### Note:
Please ensure that once the PR is submitted, you check GitHub Actions CI for
build issues and submit an update to your PR as soon as possible.
--
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]
