index.js

'use strict';

const NotificationBase = require('screwdriver-notifications-base');
const schema = require('screwdriver-data-schema');
const Hoek = require('@hapi/hoek');
const Joi = require('joi');
const tinytim = require('tinytim');
const path = require('path');
const emailer = require('./email');

// See also COLOR_MAP in Slack Notification.
// https://github.com/screwdriver-cd/notifications-slack/blob/master/index.js#L10
const COLOR_MAP = {
    ABORTED: '767676',
    CREATED: '0B548C',
    FAILURE: 'FF4000',
    QUEUED: '669999',
    RUNNING: '0F69FF',
    SUCCESS: '00CC00',
    BLOCKED: 'CCC',
    UNSTABLE: 'FFD333',
    COLLAPSED: 'F2F2F2',
    FIXED: '00CC00',
    FROZEN: 'ACD9FF'
};
const DEFAULT_STATUSES = ['FAILURE'];
// Joi Schema Validation
const SCHEMA_ADDRESS = Joi.string().email();
const SCHEMA_ADDRESSES = Joi.array().items(SCHEMA_ADDRESS).min(1);
const SCHEMA_STATUSES = Joi.array().items(schema.plugins.notifications.schemaStatus).min(0);
const SCHEMA_EMAIL = Joi.alternatives().try(
    Joi.object().keys({ addresses: SCHEMA_ADDRESSES, statuses: SCHEMA_STATUSES }),
    SCHEMA_ADDRESS,
    SCHEMA_ADDRESSES
);
const SCHEMA_EMAIL_SETTINGS = Joi.object()
    .keys({
        email: SCHEMA_EMAIL.required()
    })
    .unknown(true);
const SCHEMA_BUILD_DATA = Joi.object().keys({
    ...schema.plugins.notifications.schemaBuildData,
    settings: SCHEMA_EMAIL_SETTINGS.required()
});
const SCHEMA_JOB_DATA = Joi.object().keys({
    ...schema.plugins.notifications.schemaJobData,
    settings: SCHEMA_EMAIL_SETTINGS.required()
});
const SCHEMA_SMTP_CONFIG = Joi.object().keys({
    host: Joi.string().required(),
    port: Joi.number().integer().required(),
    from: SCHEMA_ADDRESS.required(),
    username: Joi.string(),
    password: Joi.string()
});

/**
 * Handle email messaging for build status
 * @method buildStatus
 * @param  {Object}         buildData
 * @param  {String}         buildData.status             Build status
 * @param  {Object}         buildData.pipeline           Pipeline
 * @param  {String}         buildData.jobName            Job name
 * @param  {Object}         buildData.build              Build
 * @param  {Object}         buildData.event              Event
 * @param  {String}         buildData.buildLink          Build link
 * @param  {Object}         buildData.settings           Notification setting
 * @param  {Object}         config                       Email notifications config
 */
function buildStatus(buildData, config) {
    // Check buildData format against SCHEMA_BUILD_DATA
    try {
        Joi.attempt(buildData, SCHEMA_BUILD_DATA, 'Invalid build data format');
    } catch (e) {
        return;
    }

    const emailSettings = Hoek.reach(buildData, 'settings.email');

    // Convert shorthand config to object
    // ie: 'email: [test@email.com, test2@email.com]' or 'email: test@email.com'
    if (typeof emailSettings === 'string' || Array.isArray(emailSettings)) {
        buildData.settings.email = {
            addresses: emailSettings
        };
    }

    // Make sure statuses are set
    const defaultSettings = {
        statuses: DEFAULT_STATUSES
    };

    buildData.settings.email = Object.assign(defaultSettings, buildData.settings.email);

    const statuses = Hoek.reach(buildData, 'settings.email.statuses');

    // Add for fixed notification
    if (buildData.isFixed) {
        statuses.push('FIXED');
    }

    // Do not change the `buildData.status` directly
    // It affects the behavior of other notification plugins
    let notificationStatus = buildData.status;

    if (statuses.includes('FAILURE')) {
        if (notificationStatus === 'SUCCESS' && buildData.isFixed) {
            notificationStatus = 'FIXED';
        }
    }
    // Short circuit if status does not match
    if (!statuses.includes(notificationStatus)) {
        return;
    }

    const changedFiles = Hoek.reach(buildData, 'build.meta.commit.changedFiles', { default: '' }).split(',');

    let changedFilesStr = '';

    if (changedFiles.length > 0 && changedFiles[0] !== '') {
        changedFiles.forEach(file => {
            const li = '<li>{{contents}}</li>';

            changedFilesStr += tinytim.tim(li, { contents: file });
        });
    } else {
        changedFilesStr = 'There are no changed files.';
    }

    const ul = '<ul>{{list}}</ul>';

    changedFilesStr = tinytim.tim(ul, { list: changedFilesStr });

    const rootDir = Hoek.reach(buildData, 'pipeline.scmRepo.rootDir', { default: '' });
    const subject =
        `${notificationStatus} - Screwdriver ` +
        `${Hoek.reach(buildData, 'pipeline.scmRepo.name')} ` +
        `${buildData.jobName} ${rootDir} #${Hoek.reach(buildData, 'build.id')}`;
    const message = `Build status: ${notificationStatus}\nBuild link:${buildData.buildLink}`;
    const commitSha = Hoek.reach(buildData, 'build.meta.build.sha').slice(0, 7);
    const commitMessage = Hoek.reach(buildData, 'build.meta.commit.message');
    const commitLink = Hoek.reach(buildData, 'build.meta.commit.url');
    const html = tinytim.renderFile(path.resolve(__dirname, './template/email.html'), {
        buildStatus: notificationStatus,
        buildLink: buildData.buildLink,
        buildId: buildData.build.id,
        changedFiles: changedFilesStr,
        commitSha,
        commitMessage,
        commitLink,
        statusColor: COLOR_MAP[buildData.status]
    });

    const mailOpts = {
        from: config.from,
        to: Hoek.reach(buildData, 'settings.email.addresses'),
        subject,
        text: message,
        html
    };

    const smtpConfig = {
        host: config.host,
        port: config.port
    };

    if (config.username && config.password) {
        smtpConfig.auth = {
            user: config.username,
            pass: config.password
        };
    }

    emailer(mailOpts, smtpConfig);
}

/**
 * Handle email messaging for job status
 * @method jobStatus
 * @param  {Object}         jobData
 * @param  {String}         jobData.status             Status
 * @param  {Object}         jobData.pipeline           Pipeline
 * @param  {String}         jobData.jobName            Job name
 * @param  {String}         jobData.pipelineLink       Pipeline link
 * @param  {String}         jobData.message            Message
 * @param  {Object}         jobData.settings           Notification setting
 * @param  {Object}         config                     Email notifications config
 */
function jobStatus(jobData, config) {
    try {
        Joi.attempt(jobData, SCHEMA_JOB_DATA, 'Invalid job data format');
    } catch (e) {
        return;
    }

    const emailSettings = Hoek.reach(jobData, 'settings.email');

    // Convert shorthand config to object
    // ie: 'email: [test@email.com, test2@email.com]' or 'email: test@email.com'
    if (typeof emailSettings === 'string' || Array.isArray(emailSettings)) {
        jobData.settings.email = {
            addresses: emailSettings
        };
    }

    // Make sure statuses are set
    const defaultSettings = {
        statuses: DEFAULT_STATUSES
    };

    jobData.settings.email = Object.assign(defaultSettings, jobData.settings.email);

    const rootDir = Hoek.reach(jobData, 'pipeline.scmRepo.rootDir', { default: '' });
    const subject =
        `${jobData.status} - Screwdriver ` +
        `${Hoek.reach(jobData, 'pipeline.scmRepo.name')} ` +
        `${jobData.jobName} ${rootDir}`;
    const message = `${jobData.message}\nPipeline link:${jobData.pipelineLink}`;
    const mailOpts = {
        from: config.from,
        to: Hoek.reach(jobData, 'settings.email.addresses'),
        subject,
        text: message
    };

    const smtpConfig = {
        host: config.host,
        port: config.port
    };

    if (config.username && config.password) {
        smtpConfig.auth = {
            user: config.username,
            pass: config.password
        };
    }

    emailer(mailOpts, smtpConfig);
}

class EmailNotifier extends NotificationBase {
    /**
     * Constructs an EmailNotifier
     * @constructor
     * @param {object} config - Screwdriver config object initialized in API
     */
    constructor(config) {
        super(...arguments);
        this.config = Joi.attempt(config, SCHEMA_SMTP_CONFIG, 'Invalid config for email notifications');
    }

    /**
     * Sets listener on server event of name 'eventName' in Screwdriver
     * @method _notify
     * @param {String} event - Event emitted from Screwdriver
     * @param {Object} payload - Build data emitted with some event from Screwdriver
     */
    _notify(event, payload) {
        if (!payload || !payload.settings || Object.keys(payload.settings).length === 0) {
            return;
        }

        switch (event) {
            case 'build_status':
                buildStatus(payload, this.config);
                break;
            case 'job_status':
                jobStatus(payload, this.config);
                break;
            default:
        }
    }

    // Validate the settings email object
    static validateConfig(config) {
        return SCHEMA_EMAIL_SETTINGS.validate(config);
    }
}

module.exports = EmailNotifier;