co.elastic.support.BaseInputs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of diagnostics Show documentation
Elastic Support Diagnostics Utilities
There is a newer version: 9.2.2
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 *  or more contributor license agreements. Licensed under the Elastic License
 *  2.0; you may not use this file except in compliance with the Elastic License
 *  2.0.
 */
package co.elastic.support;

import co.elastic.support.util.SystemProperties;
import co.elastic.support.util.SystemUtils;
import co.elastic.support.util.TextIOManager;
import com.beust.jcommander.JCommander;
import com.beust.jcommander.Parameter;
import co.elastic.support.diagnostics.ShowHelpException;

import org.apache.commons.lang3.ObjectUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public abstract class BaseInputs {

    private static final Logger logger = LogManager.getLogger(BaseInputs.class);
    public static final String outputDirDescription = "Fully qualified path to an output directory. If it does not exist the diagnostic will attempt to create it. If not specified the diagnostic directory will be used: ";
    public static final String bypassDiagVerifyDescription = "Bypass the diagnostic version check. Use when internet outbound HTTP access is blocked by a firewall.";
    public static final String archiveTypeDescription = "File type that will be used to compress the output directory. Choose between: 'zip', 'tar' or 'any'. 'any' will try to zip first and fallback to tar if the zip fails. Defaults to any.";
    protected List emptyList = new ArrayList<>();
    protected JCommander jCommander;

    // Input Fields

    @Parameter(names = { "-?", "--help" }, description = "Help contents.", help = true)
    public boolean help;

    // If no output directory was specified default to the working directory
    @Parameter(names = { "-o", "--out", "--output", "--outputDir" }, description = outputDirDescription)
    public String outputDir = SystemProperties.userDir;
    public boolean interactive = false;

    // Stop the diag from checking itself for latest version.
    @Parameter(names = { "--bypassDiagVerify" }, description = bypassDiagVerifyDescription)
    public boolean bypassDiagVerify = false;

    // End Input Fields

    public boolean runningInDocker = SystemUtils.isRunningInDocker();

    public BaseInputs() {
        if (runningInDocker) {
            outputDir = "/diagnostic-output";
        }
    }

    public abstract boolean runInteractive(TextIOManager textIOManager);

    public List parseInputs(TextIOManager textIOManager, String[] args) {
        logger.info(Constants.CONSOLE, "Processing diagnosticInputs...");
        jCommander = new JCommander(this);
        jCommander.setCaseSensitiveOptions(true);
        jCommander.parse(args);
        // If we're in help just shut down.
        if (help) {
            jCommander.usage();
            throw new ShowHelpException();
        }

        List errors = new ArrayList<>();

        errors.addAll(ObjectUtils.defaultIfNull(validateDir(outputDir), emptyList));

        return errors;
    }

    public void usage() {
        if (jCommander != null) {
            jCommander.usage();
        } else {
            logger.error(Constants.CONSOLE,
                    "Please rerun with the --help option or with no arguments for interactive mode.");
        }
    }

    protected void runOutputDirInteractive(TextIOManager textIOManager) {
        String output = textIOManager.textIO.newStringInputReader()
                .withMinLength(0)
                .withValueChecker((String val, String propname) -> validateOutputDirectory(val))
                .read(SystemProperties.lineSeparator + outputDirDescription);

        if (StringUtils.isNotEmpty(output)) {
            outputDir = output;
        }
    }

    public List validatePort(int val) {
        if (val < 1 || val > 65535) {
            return Collections.singletonList("Outside the valid range of port values. 1-65535 ");
        }
        return null;
    }

    public List validateOutputDirectory(String val) {
        try {
            if (StringUtils.isEmpty(val.trim())) {
                return null;
            }

            File file = new File(val);
            if (!file.exists()) {
                file.mkdir();
            }
        } catch (Exception e) {
            logger.error(e);
            return Collections
                    .singletonList("Output directory did not exist and could not be created. " + Constants.CHECK_LOG);
        }

        return null;

    }

    public List validateDir(String val) {
        if (StringUtils.isEmpty(val.trim())) {
            return null;
        }

        File file = new File(val);

        if (!file.exists() || !file.isDirectory()) {
            return Collections
                    .singletonList("Specified directory location could not be located or is not a directory.");
        }

        return null;

    }

    public List validateRequiredFile(String val) {
        if (StringUtils.isEmpty(val.trim())) {
            return Collections.singletonList("Input file is required.");
        }

        File file = new File(val);

        if (!file.exists() || file.isDirectory()) {
            return Collections
                    .singletonList("Specified required file location could not be located or is a directory.");
        }

        return null;

    }

    @Override
    public String toString() {
        return "BaseInputs{" +
                "outputDir='" + outputDir + '\'' +
                '}';
    }

}