This is an automated email from the ASF dual-hosted git repository.
pvillard pushed a commit to branch support/nifi-1.x
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/support/nifi-1.x by this push:
new 10ff385eeb NIFI-13727 Add DeleteSFTP processor
10ff385eeb is described below
commit 10ff385eebe46ff46d7e053dee58848ad7bf3d44
Author: EndzeitBegins <[email protected]>
AuthorDate: Sat Sep 7 18:25:20 2024 +0200
NIFI-13727 Add DeleteSFTP processor
Signed-off-by: Pierre Villard <[email protected]>
This closes #9245.
---
.../nifi/processors/standard/DeleteSFTP.java | 226 +++++++++++++++++++++
.../services/org.apache.nifi.processor.Processor | 1 +
.../nifi/processors/standard/TestDeleteSFTP.java | 185 +++++++++++++++++
3 files changed, 412 insertions(+)
diff --git
a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/DeleteSFTP.java
b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/DeleteSFTP.java
new file mode 100644
index 0000000000..cf5d2860b0
--- /dev/null
+++
b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/DeleteSFTP.java
@@ -0,0 +1,226 @@
+/*
+ * 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
+ *
+ * http://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.
+ */
+package org.apache.nifi.processors.standard;
+
+import org.apache.nifi.annotation.behavior.DefaultRunDuration;
+import org.apache.nifi.annotation.behavior.InputRequirement;
+import org.apache.nifi.annotation.behavior.SupportsBatching;
+import org.apache.nifi.annotation.documentation.CapabilityDescription;
+import org.apache.nifi.annotation.documentation.Tags;
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.components.ValidationContext;
+import org.apache.nifi.components.ValidationResult;
+import org.apache.nifi.expression.ExpressionLanguageScope;
+import org.apache.nifi.flowfile.FlowFile;
+import org.apache.nifi.flowfile.attributes.CoreAttributes;
+import org.apache.nifi.logging.ComponentLog;
+import org.apache.nifi.processor.AbstractProcessor;
+import org.apache.nifi.processor.ProcessContext;
+import org.apache.nifi.processor.ProcessSession;
+import org.apache.nifi.processor.Relationship;
+import org.apache.nifi.processor.exception.FlowFileAccessException;
+import org.apache.nifi.processor.exception.ProcessException;
+import org.apache.nifi.processor.util.StandardValidators;
+import org.apache.nifi.processors.standard.util.FileTransfer;
+import org.apache.nifi.processors.standard.util.FTPTransfer;
+import org.apache.nifi.processors.standard.util.SFTPTransfer;
+
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.concurrent.TimeUnit;
+
+@SupportsBatching(defaultDuration = DefaultRunDuration.TWENTY_FIVE_MILLIS)
+@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED)
+@Tags({"remote", "remove", "delete", "sftp"})
+@CapabilityDescription("Deletes a file residing on an SFTP server.")
+public class DeleteSFTP extends AbstractProcessor {
+
+ public static final Relationship REL_SUCCESS = new Relationship.Builder()
+ .name("success")
+ .description("All FlowFiles, for which an existing file has been
deleted, are routed to this relationship")
+ .build();
+ public static final Relationship REL_NOT_FOUND = new Relationship.Builder()
+ .name("not found")
+ .description("All FlowFiles, for which the file to delete did not
exist, are routed to this relationship")
+ .build();
+ public static final Relationship REL_FAILURE = new Relationship.Builder()
+ .name("failure")
+ .description("All FlowFiles, for which an existing file could not
be deleted, are routed to this relationship")
+ .build();
+
+ private static Set<Relationship> RELATIONSHIPS = new HashSet<>();
+
+ public static final PropertyDescriptor DIRECTORY_PATH = new
PropertyDescriptor.Builder()
+ .name("Directory Path")
+ .displayName("Directory Path")
+ .description("The path to the directory the file to delete is
located in.")
+ .required(true)
+ .defaultValue("${" + CoreAttributes.PATH.key() + "}")
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+
.expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES)
+ .build();
+ public static final PropertyDescriptor FILENAME = new
PropertyDescriptor.Builder()
+ .name("Filename")
+ .displayName("Filename")
+ .description("The name of the file to delete.")
+ .required(true)
+ .defaultValue("${" + CoreAttributes.FILENAME.key() + "}")
+ .addValidator(StandardValidators.NON_EMPTY_EL_VALIDATOR)
+
.expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES)
+ .build();
+
+ private static List<PropertyDescriptor> PROPERTIES = new ArrayList<>();
+
+ static {
+ RELATIONSHIPS.add(REL_SUCCESS);
+ RELATIONSHIPS.add(REL_NOT_FOUND);
+ RELATIONSHIPS.add(REL_FAILURE);
+ RELATIONSHIPS = Collections.unmodifiableSet(RELATIONSHIPS);
+
+ PROPERTIES.add(DIRECTORY_PATH);
+ PROPERTIES.add(FILENAME);
+ PROPERTIES.add(SFTPTransfer.HOSTNAME);
+ PROPERTIES.add(SFTPTransfer.PORT);
+ PROPERTIES.add(SFTPTransfer.USERNAME);
+ PROPERTIES.add(SFTPTransfer.PASSWORD);
+ PROPERTIES.add(SFTPTransfer.PRIVATE_KEY_PATH);
+ PROPERTIES.add(SFTPTransfer.PRIVATE_KEY_PASSPHRASE);
+ PROPERTIES.add(SFTPTransfer.STRICT_HOST_KEY_CHECKING);
+ PROPERTIES.add(SFTPTransfer.HOST_KEY_FILE);
+ PROPERTIES.add(SFTPTransfer.BATCH_SIZE);
+ PROPERTIES.add(SFTPTransfer.CONNECTION_TIMEOUT);
+ PROPERTIES.add(SFTPTransfer.DATA_TIMEOUT);
+ PROPERTIES.add(SFTPTransfer.USE_KEEPALIVE_ON_TIMEOUT);
+ PROPERTIES.add(SFTPTransfer.USE_COMPRESSION);
+ PROPERTIES.add(SFTPTransfer.PROXY_CONFIGURATION_SERVICE);
+ PROPERTIES.add(FTPTransfer.PROXY_TYPE);
+ PROPERTIES.add(FTPTransfer.PROXY_HOST);
+ PROPERTIES.add(FTPTransfer.PROXY_PORT);
+ PROPERTIES.add(FTPTransfer.HTTP_PROXY_USERNAME);
+ PROPERTIES.add(FTPTransfer.HTTP_PROXY_PASSWORD);
+ PROPERTIES.add(SFTPTransfer.CIPHERS_ALLOWED);
+ PROPERTIES.add(SFTPTransfer.KEY_ALGORITHMS_ALLOWED);
+ PROPERTIES.add(SFTPTransfer.KEY_EXCHANGE_ALGORITHMS_ALLOWED);
+ PROPERTIES.add(SFTPTransfer.MESSAGE_AUTHENTICATION_CODES_ALLOWED);
+ PROPERTIES = Collections.unmodifiableList(PROPERTIES);
+ }
+
+ @Override
+ public Set<Relationship> getRelationships() {
+ return RELATIONSHIPS;
+ }
+
+ @Override
+ protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
+ return PROPERTIES;
+ }
+
+ @Override
+ public void onTrigger(ProcessContext context, ProcessSession session)
throws ProcessException {
+ FlowFile flowFile = session.get();
+ if (flowFile == null) {
+ return;
+ }
+
+ final ComponentLog logger = getLogger();
+ String hostname =
context.getProperty(FileTransfer.HOSTNAME).evaluateAttributeExpressions(flowFile).getValue();
+
+ final int maxNumberOfFiles =
context.getProperty(SFTPTransfer.BATCH_SIZE).asInteger();
+ int fileCount = 0;
+
+ try (final SFTPTransfer transfer = new SFTPTransfer(context, logger)) {
+ do {
+ //evaluate again inside the loop as each flowfile can have a
different hostname
+ hostname =
context.getProperty(FileTransfer.HOSTNAME).evaluateAttributeExpressions(flowFile).getValue();
+
+ final long startNanos = System.nanoTime();
+
+ final String directoryPathProperty =
context.getProperty(DIRECTORY_PATH).evaluateAttributeExpressions(flowFile).getValue();
+ final String filename =
context.getProperty(FILENAME).evaluateAttributeExpressions(flowFile).getValue();
+
+ try {
+ final Path directoryPath =
Paths.get(directoryPathProperty).normalize();
+ final Path filePath =
directoryPath.resolve(filename).normalize();
+
+ if (!directoryPath.equals(filePath.getParent())) {
+ final String errorMessage = String.format(
+ "Attempting to delete file at path '%s' which
is not a direct child of the directory '%s'",
+ filePath, directoryPath
+ );
+
+ handleFailure(session, flowFile, errorMessage, null);
+ continue;
+ }
+
+ transfer.deleteFile(flowFile, directoryPath.toString(),
filename);
+
+ session.transfer(flowFile, REL_SUCCESS);
+ final String transitUri = String.format("sftp://%s";,
filePath);
+ final long transferMillis =
TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNanos);
+ logger.debug("Successfully deleted file at path {} in {}
millis; routing to success", flowFile, transferMillis);
+
session.getProvenanceReporter().invokeRemoteProcess(flowFile, transitUri,
"Object deleted");
+ } catch (FileNotFoundException fileNotFoundException) {
+ session.transfer(flowFile, REL_NOT_FOUND);
+ } catch (IOException ioException) {
+ final String errorMessage = String.format(
+ "Failed to delete file '%s' in directory '%s'",
+ filename, directoryPathProperty
+ );
+
+ handleFailure(session, flowFile, errorMessage,
ioException);
+ }
+ } while (isScheduled()
+ && (getRelationships().size() ==
context.getAvailableRelationships().size())
+ && (++fileCount < maxNumberOfFiles)
+ && ((flowFile = session.get()) != null));
+ } catch (final IOException | FlowFileAccessException |
ProcessException e) {
+ context.yield();
+
+ final Throwable cause;
+ if (e instanceof FlowFileAccessException || e instanceof
ProcessException) {
+ cause = e.getCause();
+ } else {
+ cause = e;
+ }
+
+ String errorMessage = String.format("Routing to failure since
unable to delete %s from remote host %s", flowFile, hostname);
+ handleFailure(session, flowFile, errorMessage, cause);
+ }
+ }
+
+ @Override
+ protected Collection<ValidationResult> customValidate(ValidationContext
validationContext) {
+ final Collection<ValidationResult> results = new ArrayList<>();
+ SFTPTransfer.validateProxySpec(validationContext, results);
+ return results;
+ }
+
+ private void handleFailure(ProcessSession session, FlowFile flowFile,
String errorMessage, Throwable throwable) {
+ getLogger().error(errorMessage, throwable);
+
+ session.penalize(flowFile);
+ session.transfer(flowFile, REL_FAILURE);
+ }
+}
\ No newline at end of file
diff --git
a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor
b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor
index abf8fe7748..8c968bb44f 100644
---
a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor
+++
b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor
@@ -25,6 +25,7 @@ org.apache.nifi.processors.standard.CountText
org.apache.nifi.processors.standard.CryptographicHashAttribute
org.apache.nifi.processors.standard.CryptographicHashContent
org.apache.nifi.processors.standard.DebugFlow
+org.apache.nifi.processors.standard.DeleteSFTP
org.apache.nifi.processors.standard.DetectDuplicate
org.apache.nifi.processors.standard.DeduplicateRecord
org.apache.nifi.processors.standard.DeleteFile
diff --git
a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestDeleteSFTP.java
b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestDeleteSFTP.java
new file mode 100644
index 0000000000..a12140424e
--- /dev/null
+++
b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestDeleteSFTP.java
@@ -0,0 +1,185 @@
+/*
+ * 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
+ *
+ * http://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.
+ */
+package org.apache.nifi.processors.standard;
+
+import org.apache.commons.io.FileUtils;
+import org.apache.nifi.flowfile.attributes.CoreAttributes;
+import org.apache.nifi.processors.standard.util.SFTPTransfer;
+import org.apache.nifi.processors.standard.util.SSHTestServer;
+import org.apache.nifi.provenance.ProvenanceEventType;
+import org.apache.nifi.util.MockFlowFile;
+import org.apache.nifi.util.TestRunner;
+import org.apache.nifi.util.TestRunners;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+class TestDeleteSFTP {
+
+ private static final int BATCH_SIZE = 2;
+
+ private final TestRunner runner =
TestRunners.newTestRunner(DeleteSFTP.class);
+ private final SSHTestServer sshTestServer = new SSHTestServer();
+ private Path sshServerRootPath;
+
+ @BeforeEach
+ void setRunner() throws IOException {
+ sshTestServer.startServer();
+ sshServerRootPath =
Paths.get(sshTestServer.getVirtualFileSystemPath()).toAbsolutePath();
+
+ runner.setProperty(SFTPTransfer.HOSTNAME, sshTestServer.getHost());
+ runner.setProperty(SFTPTransfer.PORT,
Integer.toString(sshTestServer.getSSHPort()));
+ runner.setProperty(SFTPTransfer.USERNAME, sshTestServer.getUsername());
+ runner.setProperty(SFTPTransfer.PASSWORD, sshTestServer.getPassword());
+ runner.setProperty(SFTPTransfer.BATCH_SIZE,
Integer.toString(BATCH_SIZE));
+ }
+
+ @AfterEach
+ void clearDirectory() throws IOException {
+ sshTestServer.stopServer();
+ FileUtils.deleteQuietly(sshServerRootPath.toFile());
+ }
+
+ @Test
+ void deletesExistingFile() throws IOException {
+ final Path fileToDelete = createFile("rel/path", "test.txt");
+ final MockFlowFile enqueuedFlowFile = enqueue(fileToDelete);
+ assertExists(fileToDelete);
+
+ runner.run();
+
+ assertNotExists(fileToDelete);
+ runner.assertAllFlowFilesTransferred(DeleteSFTP.REL_SUCCESS, 1);
+ runner.assertAllFlowFiles(
+ DeleteSFTP.REL_SUCCESS,
+ flowFileInRelationship -> assertEquals(enqueuedFlowFile,
flowFileInRelationship)
+ );
+ runner.assertProvenanceEvent(ProvenanceEventType.REMOTE_INVOCATION);
+ }
+
+ @Test
+ void sendsFlowFileToNotFoundWhenFileDoesNotExist() throws IOException {
+ final Path directoryPath =
Files.createDirectories(sshServerRootPath.resolve("rel/path"));
+ final String filename = "not-exist.txt";
+ final Path fileToDelete = directoryPath.resolve(filename);
+ enqueue(fileToDelete);
+ assertNotExists(fileToDelete);
+
+ runner.run();
+
+ assertNotExists(fileToDelete);
+ runner.assertAllFlowFilesTransferred(DeleteSFTP.REL_NOT_FOUND);
+ }
+
+ @Test
+ void sendsFlowFileToNotFoundWhenDirectoryDoesNotExist() {
+ final Path directoryPath = sshServerRootPath.resolve("rel/path");
+ final String filename = "not-exist.txt";
+ final Path fileToDelete = directoryPath.resolve(filename);
+ enqueue(fileToDelete);
+ assertNotExists(fileToDelete);
+
+ runner.run();
+
+ assertNotExists(fileToDelete);
+ runner.assertAllFlowFilesTransferred(DeleteSFTP.REL_NOT_FOUND);
+ }
+
+ @Test
+ void sendsFlowFileToFailureWhenTargetIsADirectory() throws IOException {
+ Path fileToDelete =
Files.createDirectories(sshServerRootPath.resolve("a/directory"));
+ enqueue(fileToDelete);
+ assertExists(fileToDelete);
+
+ runner.run();
+
+ assertExists(fileToDelete);
+ runner.assertAllFlowFilesTransferred(DeleteSFTP.REL_FAILURE);
+ runner.assertPenalizeCount(1);
+ }
+
+ @Test
+ void sendsFlowFileToFailureWhenFileIsNotADirectChildOfTheDirectory()
throws IOException {
+ final Path directoryPath =
Files.createDirectories(sshServerRootPath.resolve("rel/path"));
+ final String filename = "../sibling.txt";
+ enqueue(directoryPath.toString(), filename);
+ final Path fileToDelete = Files.write(directoryPath.resolve(filename),
"sibling content".getBytes(StandardCharsets.UTF_8));
+ assertExists(fileToDelete);
+
+ runner.run();
+
+ assertExists(fileToDelete);
+ runner.assertAllFlowFilesTransferred(DeleteSFTP.REL_FAILURE, 1);
+ runner.assertPenalizeCount(1);
+ }
+
+ @Test
+ void deletesUpToBatchSizeFilesWithASingleConnection() throws IOException {
+ for (int fileNumber = 1; fileNumber <= 2 * BATCH_SIZE; fileNumber++) {
+ final Path fileToDelete = createFile("a/directory",
String.format("file-%d", fileNumber));
+ enqueue(fileToDelete);
+ assertExists(fileToDelete);
+ }
+
+ runner.run();
+ runner.assertTransferCount(DeleteSFTP.REL_SUCCESS, BATCH_SIZE);
+ runner.clearTransferState();
+
+ runner.run();
+ runner.assertTransferCount(DeleteSFTP.REL_SUCCESS, BATCH_SIZE);
+ runner.assertQueueEmpty();
+ }
+
+ private Path createFile(String directoryPath, String filename) throws
IOException {
+ Path directory =
Files.createDirectories(sshServerRootPath.resolve(directoryPath));
+
+ return Files.write(directory.resolve(filename), "some
text".getBytes(StandardCharsets.UTF_8));
+ }
+
+ private MockFlowFile enqueue(Path path) {
+ final Path relativePath = sshServerRootPath.relativize(path);
+
+ return enqueue(String.format("/%s", relativePath.getParent()),
relativePath.getFileName().toString());
+ }
+
+ private MockFlowFile enqueue(String directoryPath, String filename) {
+ final Map<String, String> attributes = new HashMap<>();
+ attributes.put(CoreAttributes.PATH.key(), directoryPath);
+ attributes.put(CoreAttributes.FILENAME.key(), filename);
+
+ return runner.enqueue("data", attributes);
+ }
+
+ private static void assertNotExists(Path filePath) {
+ assertTrue(Files.notExists(filePath), () -> "File " + filePath +
"still exists");
+ }
+
+ private static void assertExists(Path filePath) {
+ assertTrue(Files.exists(filePath), () -> "File " + filePath + "does
not exist");
+ }
+}
