com.blackducksoftware.integration.hub.detect.workflow.report.DetectConfigurationReporter.java Source code

Introduction

Here is the source code for com.blackducksoftware.integration.hub.detect.workflow.report.DetectConfigurationReporter.java

Source

/**
 * hub-detect
 *
 * Copyright (C) 2019 Black Duck Software, Inc.
 * http://www.blackducksoftware.com/
 *
 * 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 com.blackducksoftware.integration.hub.detect.workflow.report;

import java.util.List;
import java.util.stream.Collectors;

import org.apache.commons.lang3.StringUtils;

import com.blackducksoftware.integration.hub.detect.help.DetectOption;
import com.blackducksoftware.integration.hub.detect.workflow.report.writer.ReportWriter;

public class DetectConfigurationReporter {

    private List<DetectOption> sortOptions(final List<DetectOption> detectOptions) {
        return detectOptions.stream().sorted((o1, o2) -> o1.getDetectProperty().getPropertyKey()
                .compareTo(o2.getDetectProperty().getPropertyKey())).collect(Collectors.toList());
    }

    public void print(ReportWriter writer, final List<DetectOption> detectOptions)
            throws IllegalArgumentException, SecurityException {
        writer.writeLine("");
        writer.writeLine("Current property values:");
        writer.writeLine("--property = value [notes]");
        writer.writeLine(StringUtils.repeat("-", 60));

        final List<DetectOption> sortedOptions = sortOptions(detectOptions);

        for (final DetectOption option : sortedOptions) {
            final String key = option.getDetectProperty().getPropertyKey();
            String fieldValue = option.getFinalValue();
            final DetectOption.FinalValueType fieldType = option.getFinalValueType();
            if (!StringUtils.isEmpty(key) && !StringUtils.isEmpty(fieldValue) && "metaClass" != key) {
                final boolean containsPassword = key.toLowerCase().contains("password")
                        || key.toLowerCase().contains("api.token");
                if (containsPassword) {
                    fieldValue = StringUtils.repeat("*", fieldValue.length());
                }

                String text = "";
                final String displayName = option.getDetectProperty().getPropertyKey();
                if (fieldType == DetectOption.FinalValueType.SUPPLIED
                        || fieldType == DetectOption.FinalValueType.DEFAULT || containsPassword) {
                    if (fieldValue.trim().length() > 0) {
                        text = displayName + " = " + fieldValue;
                    }
                } else if (fieldType == DetectOption.FinalValueType.INTERACTIVE) {
                    text = displayName + " = " + fieldValue + " [interactive]";
                } else if (fieldType == DetectOption.FinalValueType.LATEST) {
                    text = displayName + " = " + fieldValue + " [latest]";
                } else if (fieldType == DetectOption.FinalValueType.CALCULATED) {
                    text = displayName + " = " + fieldValue + " [calculated]";
                } else if (fieldType == DetectOption.FinalValueType.OVERRIDE) {
                    text = displayName + " = " + fieldValue + " [" + option.getResolvedValue() + "]";
                } else if (fieldType == DetectOption.FinalValueType.COPIED) {
                    text = displayName + " = " + fieldValue + " [copied]";
                }

                if (option.getValidValues().size() > 0) {
                    final DetectOption.OptionValidationResult validationResult = option.validateValue(fieldValue);
                    if (!validationResult.isValid()) {
                        text += String.format(" [%s]", validationResult.getValidationMessage());
                    }
                }

                if (option.getWarnings().size() > 0) {
                    text += "\t *** WARNING ***";
                }
                writer.writeLine(text);
            }
        }
        writer.writeLine(StringUtils.repeat("-", 60));
        writer.writeLine("");

    }

    public void printWarnings(ReportWriter writer, final List<DetectOption> detectOptions) {
        final List<DetectOption> sortedOptions = sortOptions(detectOptions);

        final List<DetectOption> allWarnings = sortedOptions.stream().filter(it -> it.getWarnings().size() > 0)
                .collect(Collectors.toList());
        if (allWarnings.size() > 0) {
            writer.writeLine("");
            writer.writeLine(StringUtils.repeat("*", 60));
            if (allWarnings.size() == 1) {
                writer.writeLine("WARNING (" + allWarnings.size() + ")");
            } else {
                writer.writeLine("WARNINGS (" + allWarnings.size() + ")");
            }
            for (final DetectOption option : allWarnings) {
                for (final String warning : option.getWarnings()) {
                    writer.writeLine(option.getDetectProperty().getPropertyKey() + ": " + warning);
                }
            }
            writer.writeLine(StringUtils.repeat("*", 60));
            writer.writeLine("");
        }
    }
}