arguments.js

#!/usr/bin/env node
/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 */

const { program, Option } = require('commander');
const { exit } = require('process');
const fs = require('fs');
const ora = require('ora');
const { AUTH, CLI_COMMAND_NAME, DEFAULT_AUTH, DEFAULT_FILENAME, DEFAULT_FORMAT, DEFAULT_MIN_HEIGHT, DEFAULT_TENANT, DEFAULT_WIDTH, ENV_VAR, FORMAT, TRANSPORT_TYPE, DEFAULT_EMAIL_SUBJECT, DEFAULT_EMAIL_NOTE, DEFAULT_MULTI_TENANCY } = require('./constants.js');
const dotenv = require("dotenv");
dotenv.config();
const spinner = ora('');

async function getCommandArguments() {

    program
        .name(CLI_COMMAND_NAME)
        .description('Reporting CLI to download and email reports');

    program
        .addOption(new Option('-u, --url <url>', 'url for the report')
            .env(ENV_VAR.URL))
        .addOption(new Option('-a, --auth <type>', 'authentication type for the report.')
            .default(DEFAULT_AUTH)
            .choices([AUTH.BASIC, AUTH.COGNITO, AUTH.SAML]))
        .addOption(new Option('-c, --credentials <username:password>', 'login credentials')
            .env(ENV_VAR.USERNAME + ' and ' + ENV_VAR.PASSWORD))
        .addOption(new Option('-t, --tenant <tenant>', 'tenants in opensearch dashboards')
            .default(DEFAULT_TENANT))
        .addOption(new Option('--multitenancy <flag>', 'enable or disable multi-tenancy')
                .default(DEFAULT_MULTI_TENANCY)
                .choices(['true', 'false']))
        .addOption(new Option('-f, --format <type>', 'file format for the report')
            .default(DEFAULT_FORMAT)
            .choices([FORMAT.PDF, FORMAT.PNG, FORMAT.CSV]))
        .addOption(new Option('-w, --width <psize>', 'window width in pixels for the report')
            .default(DEFAULT_WIDTH))
        .addOption(new Option('-l, --height <size>', 'minimum window height in pixels for the report')
            .default(DEFAULT_MIN_HEIGHT))
        .addOption(new Option('-n, --filename <name>', 'file name of the report')
            .default(DEFAULT_FILENAME)
            .env(ENV_VAR.FILENAME))
        .addOption(new Option('-e, --transport <method>', 'transport for sending the email')
            .choices([TRANSPORT_TYPE.SES, TRANSPORT_TYPE.SMTP])
            .env(ENV_VAR.TRANSPORT))
        .addOption(new Option('-s, --from <sender>', 'email address of the sender')
            .env(ENV_VAR.FROM))
        .addOption(new Option('-r, --to <recipient>', 'email address of the recipient')
            .env(ENV_VAR.TO))
        .addOption(new Option('--smtphost <host>', 'hostname of the smtp server')
            .env(ENV_VAR.SMTP_HOST))
        .addOption(new Option('--smtpport <port>', 'port for connection')
            .env(ENV_VAR.SMTP_PORT))
        .addOption(new Option('--smtpsecure <flag>', 'use TLS when connecting to server')
            .env(ENV_VAR.SMTP_SECURE))
        .addOption(new Option('--smtpusername <username>', 'smtp username')
            .env(ENV_VAR.SMTP_USERNAME))
        .addOption(new Option('--smtppassword <password>', 'smtp password')
            .env(ENV_VAR.SMTP_PASSWORD))
        .addOption(new Option('--subject <subject>', 'email subject')
            .default(DEFAULT_EMAIL_SUBJECT)
            .env(ENV_VAR.EMAIL_SUBJECT))
        .addOption(new Option('--note <note>', 'email body (string or path to text file)')
            .default(DEFAULT_EMAIL_NOTE)
            .env(ENV_VAR.EMAIL_NOTE))

    program.addHelpText('after', `
Note: The tenant in the url has the higher priority than tenant value provided as command option.`);

    program.parse(process.argv);
    const options = program.opts();
    spinner.start('Fetching the arguments values');
    return getOptions(options);
}

async function getEventArguments(event) {
    if (event.auth === undefined)
        event['auth'] = DEFAULT_AUTH;
    if (event.tenant === undefined)
        event['tenant'] = DEFAULT_TENANT;
    if (event.format === undefined)
        event['format'] = DEFAULT_FORMAT;
    if (event.width === undefined)
        event['width'] = DEFAULT_WIDTH;
    if (event.height === undefined)
        event['height'] = DEFAULT_MIN_HEIGHT;
    if (event.filename === undefined)
        event['filename'] = DEFAULT_FILENAME;
    if (event.subject === undefined)
        event['subject'] = DEFAULT_EMAIL_SUBJECT;
    if (event.note === undefined)
        event['note'] = DEFAULT_EMAIL_NOTE;
    if (event.multitenancy === undefined)
        event['multitenancy'] = DEFAULT_MULTI_TENANCY;

    return getOptions(event);
}

function getOptions(options) {
    var commandOptions = {
        url: null,
        auth: null,
        username: null,
        password: null,
        tenant: null,
        multitenancy: null,
        format: null,
        width: null,
        height: null,
        filename: null,
        transport: null,
        sender: null,
        recipient: null,
        smtphost: null,
        smtpport: null,
        smtpsecure: null,
        smtpusername: null,
        smtppassword: null,
        subject: null,
        time: null,
        note: null,
        emailbody: null
    }

    // Set url.
    commandOptions.url = options.url || process.env[ENV_VAR.URL];
    if (commandOptions.url === undefined || commandOptions.url.length <= 0) {
        spinner.fail('Please specify URL');
        exit(1);
    }

    // Remove double quotes if present.
    if (commandOptions.url.length >= 2 && commandOptions.url.charAt(0) == '"' && commandOptions.url.charAt(commandOptions.url.length - 1) == '"') {
        commandOptions.url = commandOptions.url.substring(1, commandOptions.url.length - 1)
    }

    // Get credentials from command line arguments.
    if (options.credentials !== undefined) {
        commandOptions.username = options.credentials.split(":")[0];
        commandOptions.password = options.credentials.split(":")[1];
    }

    // Get credentials from .env file
    if (commandOptions.username === null || commandOptions.username.length <= 0) {
        commandOptions.username = process.env[ENV_VAR.USERNAME];
    }
    if (commandOptions.password === null || commandOptions.password.length <= 0) {
        commandOptions.password = process.env[ENV_VAR.PASSWORD];
    }

    // If auth type is not none & credentials are missing, exit with error.
    commandOptions.auth = options.auth;
    if ((commandOptions.auth !== undefined && commandOptions.auth !== DEFAULT_AUTH) &&
        ((commandOptions.username == undefined || commandOptions.username.length <= 0) ||
            (commandOptions.password == undefined || commandOptions.password.length <= 0))) {
        spinner.fail('Please specify a valid username or password');
        exit(1);
    }

    // If auth type is none and credentials are present, give warning auth type might be missing.
    if (commandOptions.auth === DEFAULT_AUTH && commandOptions.username !== undefined && commandOptions.password !== undefined) {
        spinner.warn('Credentials are present but auth type is missing. Trying to reach url with no authentication.');
    }

    // Set tenant
    commandOptions.tenant = options.tenant;

    // Set multitenancy
    commandOptions.multitenancy = options.multitenancy;

    // Set report format.
    commandOptions.format = options.format;

    // Set time
    commandOptions.time = new Date();

    // Set default filename is not specified.
    commandOptions.filename = options.filename || process.env[ENV_VAR.FILENAME];
    commandOptions.filename = options.filename === DEFAULT_FILENAME
        ? `${commandOptions.filename}-${commandOptions.time.toISOString().replace(/:/g, '-')}.${commandOptions.format}`
        : `${commandOptions.filename}.${commandOptions.format}`;

    // Set name for email body report image
    commandOptions.emailbody = `email-body-${commandOptions.time.toISOString().replace(/:/g, '-')}.png`

    // Set width and height of the window
    commandOptions.width = Number(options.width);
    commandOptions.height = Number(options.height);

    // Set transport for the email.
    commandOptions.transport = options.transport || process.env[ENV_VAR.TRANSPORT];

    // Set email addresse if specified.
    commandOptions.sender = options.from || process.env[ENV_VAR.FROM];
    commandOptions.recipient = options.to || process.env[ENV_VAR.TO];

    // Set SMTP options.
    commandOptions.smtphost = options.smtphost || process.env[ENV_VAR.SMTP_HOST];
    commandOptions.smtpport = options.smtpport || process.env[ENV_VAR.SMTP_PORT];
    commandOptions.smtpsecure = options.smtpsecure || process.env[ENV_VAR.SMTP_SECURE];
    commandOptions.smtpusername = options.smtpusername || process.env[ENV_VAR.USERNAME];
    commandOptions.smtppassword = options.smtppassword || process.env[ENV_VAR.PASSWORD];

    // Set email subject.
    commandOptions.subject = options.subject || process.env[ENV_VAR.EMAIL_SUBJECT];

    // Set email note.
    commandOptions.note = options.note || process.env[ENV_VAR.EMAIL_NOTE];
    if (commandOptions.note !== DEFAULT_EMAIL_NOTE && fs.existsSync(commandOptions.note)) {
        commandOptions.note = fs.readFileSync(commandOptions.note, "utf8");
    }
    commandOptions.note = getHtml(commandOptions.note);

    spinner.succeed('Fetched argument values');
    return commandOptions;
}

// Convert text to html
function getHtml(text) {
    text = (text || "");
    return text
        .replace(/&/g, "&amp;")
        .replace(/</g, "&lt;")
        .replace(/>/g, "&gt;")
        .replace(/\t/g, "    ")
        .replace(/ /g, "&#8203;&nbsp;&#8203;")
        .replace(/\r\n|\r|\n/g, "<br />");
}

module.exports = {
    getCommandArguments,
    getEventArguments
}