briansolo1985 commented on code in PR #6434: URL: https://github.com/apache/nifi/pull/6434#discussion_r984825912
########## c2/c2-client-bundle/c2-client-service/src/main/java/org/apache/nifi/c2/client/service/operation/DebugOperationHandler.java: ########## @@ -0,0 +1,196 @@ +/* + * 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.c2.client.service.operation; + +import static java.nio.file.Files.copy; +import static java.nio.file.Files.createTempDirectory; +import static java.nio.file.Files.deleteIfExists; +import static java.nio.file.Files.lines; +import static java.nio.file.Files.write; +import static java.util.Optional.empty; +import static java.util.Optional.ofNullable; +import static org.apache.commons.compress.utils.IOUtils.closeQuietly; +import static org.apache.commons.lang3.StringUtils.EMPTY; +import static org.apache.nifi.c2.protocol.api.C2OperationState.OperationState.FULLY_APPLIED; +import static org.apache.nifi.c2.protocol.api.C2OperationState.OperationState.NOT_APPLIED; +import static org.apache.nifi.c2.protocol.api.OperandType.DEBUG; +import static org.apache.nifi.c2.protocol.api.OperationType.TRANSFER; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.function.Predicate; +import java.util.stream.Stream; +import org.apache.commons.compress.archivers.tar.TarArchiveEntry; +import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream; +import org.apache.commons.compress.compressors.gzip.GzipCompressorOutputStream; +import org.apache.nifi.c2.client.api.C2Client; +import org.apache.nifi.c2.protocol.api.C2Operation; +import org.apache.nifi.c2.protocol.api.C2OperationAck; +import org.apache.nifi.c2.protocol.api.C2OperationState; +import org.apache.nifi.c2.protocol.api.C2OperationState.OperationState; +import org.apache.nifi.c2.protocol.api.OperandType; +import org.apache.nifi.c2.protocol.api.OperationType; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class DebugOperationHandler implements C2OperationHandler { + + private static final Logger LOG = LoggerFactory.getLogger(DebugOperationHandler.class); + + private static final String C2_CALLBACK_URL_NOT_FOUND = "C2 Server callback URL was not found in request"; + private static final String SUCCESSFUL_UPLOAD = "Debug bundle was uploaded successfully"; + private static final String UNABLE_TO_CREATE_BUNDLE = "Unable to create debug bundle"; + + static final String TARGET_ARG = "target"; + static final String NEW_LINE = "\n"; + + private final C2Client c2Client; + private final List<Path> bundleFilePaths; + private final Predicate<String> contentFilter; + + private DebugOperationHandler(C2Client c2Client, List<Path> bundleFilePaths, Predicate<String> contentFilter) { + this.c2Client = c2Client; + this.bundleFilePaths = bundleFilePaths; + this.contentFilter = contentFilter; + } + + public static DebugOperationHandler create(C2Client c2Client, List<Path> bundleFilePaths, Predicate<String> contentFilter) { + if (c2Client == null) { + throw new IllegalArgumentException("C2Client should not be null"); + } + if (bundleFilePaths == null || bundleFilePaths.isEmpty()) { + throw new IllegalArgumentException("bundleFilePaths should not be not null or empty"); + } + if (contentFilter == null) { + throw new IllegalArgumentException("Exclude sensitive filter should not be null"); Review Comment: I made the variable name more generic, if you don't mind ########## c2/c2-client-bundle/c2-client-service/src/main/java/org/apache/nifi/c2/client/service/operation/DebugOperationHandler.java: ########## @@ -0,0 +1,196 @@ +/* + * 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.c2.client.service.operation; + +import static java.nio.file.Files.copy; +import static java.nio.file.Files.createTempDirectory; +import static java.nio.file.Files.deleteIfExists; +import static java.nio.file.Files.lines; +import static java.nio.file.Files.write; +import static java.util.Optional.empty; +import static java.util.Optional.ofNullable; +import static org.apache.commons.compress.utils.IOUtils.closeQuietly; +import static org.apache.commons.lang3.StringUtils.EMPTY; +import static org.apache.nifi.c2.protocol.api.C2OperationState.OperationState.FULLY_APPLIED; +import static org.apache.nifi.c2.protocol.api.C2OperationState.OperationState.NOT_APPLIED; +import static org.apache.nifi.c2.protocol.api.OperandType.DEBUG; +import static org.apache.nifi.c2.protocol.api.OperationType.TRANSFER; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.function.Predicate; +import java.util.stream.Stream; +import org.apache.commons.compress.archivers.tar.TarArchiveEntry; +import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream; +import org.apache.commons.compress.compressors.gzip.GzipCompressorOutputStream; +import org.apache.nifi.c2.client.api.C2Client; +import org.apache.nifi.c2.protocol.api.C2Operation; +import org.apache.nifi.c2.protocol.api.C2OperationAck; +import org.apache.nifi.c2.protocol.api.C2OperationState; +import org.apache.nifi.c2.protocol.api.C2OperationState.OperationState; +import org.apache.nifi.c2.protocol.api.OperandType; +import org.apache.nifi.c2.protocol.api.OperationType; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class DebugOperationHandler implements C2OperationHandler { + + private static final Logger LOG = LoggerFactory.getLogger(DebugOperationHandler.class); + + private static final String C2_CALLBACK_URL_NOT_FOUND = "C2 Server callback URL was not found in request"; + private static final String SUCCESSFUL_UPLOAD = "Debug bundle was uploaded successfully"; + private static final String UNABLE_TO_CREATE_BUNDLE = "Unable to create debug bundle"; + + static final String TARGET_ARG = "target"; + static final String NEW_LINE = "\n"; + + private final C2Client c2Client; + private final List<Path> bundleFilePaths; + private final Predicate<String> contentFilter; + + private DebugOperationHandler(C2Client c2Client, List<Path> bundleFilePaths, Predicate<String> contentFilter) { + this.c2Client = c2Client; + this.bundleFilePaths = bundleFilePaths; + this.contentFilter = contentFilter; + } + + public static DebugOperationHandler create(C2Client c2Client, List<Path> bundleFilePaths, Predicate<String> contentFilter) { + if (c2Client == null) { + throw new IllegalArgumentException("C2Client should not be null"); + } + if (bundleFilePaths == null || bundleFilePaths.isEmpty()) { + throw new IllegalArgumentException("bundleFilePaths should not be not null or empty"); + } + if (contentFilter == null) { + throw new IllegalArgumentException("Exclude sensitive filter should not be null"); + } + + return new DebugOperationHandler(c2Client, bundleFilePaths, contentFilter); + } + + @Override + public OperationType getOperationType() { + return TRANSFER; + } + + @Override + public OperandType getOperandType() { + return DEBUG; + } + + @Override + public C2OperationAck handle(C2Operation operation) { + String debugCallbackUrl = operation.getArgs().get(TARGET_ARG); + if (debugCallbackUrl == null) { + LOG.error("Callback URL was not found in C2 request."); + return operationAck(operation, operationState(NOT_APPLIED, C2_CALLBACK_URL_NOT_FOUND)); + } + + List<Path> contentFilteredFilePaths = null; + C2OperationState operationState; + try { + contentFilteredFilePaths = filterContent(bundleFilePaths); + operationState = createDebugBundle(contentFilteredFilePaths) + .map(bundle -> c2Client.uploadDebugBundle(debugCallbackUrl, bundle) + .map(errorMessage -> operationState(NOT_APPLIED, errorMessage)) + .orElseGet(() -> operationState(FULLY_APPLIED, SUCCESSFUL_UPLOAD))) + .orElseGet(() -> operationState(NOT_APPLIED, UNABLE_TO_CREATE_BUNDLE)); + } catch (Exception e) { + LOG.error("Unexpected error happened", e); + operationState = operationState(NOT_APPLIED, UNABLE_TO_CREATE_BUNDLE); + } finally { + ofNullable(contentFilteredFilePaths).ifPresent(this::cleanup); + } + + LOG.debug("Returning operation ack with state {} and details {}", operationState.getState(), operationState.getDetails()); Review Comment: Added -- 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]
