istanbul-slack-notify/src/coverage-notifier.js

Sends nyc (aka: istanbul) coverage summary and git build details to Slack using a pass/fail threshold for project coverage.

import SlackNotify from "slack-notify";

export default class CoverageNotifier {
  constructor(settings) {
    this.settings = settings || {};
    this.settings.timeout = this.settings.timeout || 5000;
    this.settings.result = {
      pass: {text: "passed", color: "#36a64f", icon: ":thumbsup:"},
      fail: {text: "failed", color: "#dc5547", icon: ":thumbsdown:"},
    };
    if (!this.settings.webhook) {
      throw new Error("Slack webhook url is required (settings.webhook)");
    }
  }

  buildCoveragePayload(data) {
    return new Promise((resolve, reject) => {
      if (!data || !data.coverage || !data.build) {
        reject(new Error("Coverage and/or build data was not provided"));
      }
      let threshold = data.coverage.success ? this.settings.result.pass : this.settings.result.fail;
      let commitRef = data.build.refs.length === 1 ? data.build.refs[0] : data.build.refs[1];
      const payload = {
        username: this.settings.username,
        channel: this.settings.channel,
        icon_emoji: threshold.icon,
        attachments: [
          {
            color: threshold.color,
            fallback: `${data.projectName} - coverage check ${threshold.text} at ${data.coverage.project}%`,
            mrkdwn_in: ["text", "title"],
            title: `${data.projectName} - coverage check ${threshold.text}`,
            title_link: `${data.repositoryUrl}/commits/${data.build.revision}`,
            footer: `${data.build.date} - ${data.build.author} commited ${data.build.shortRevision} ${commitRef}`,
            fields: [
              {
                title: "Total Coverage",
                value: `${data.coverage.project}%`,
                short: true,
              },
              {
                title: "Threshold",
                value: `${data.coverage.threshold}%`,
                short: true,
              },
              {
                title: "Statements",
                value: `${data.coverage.statements}%`,
                short: true,
              },
              {
                title: "Functions / Methods",
                value: `${data.coverage.functions}%`,
                short: true,
              },
              {
                title: "Branches",
                value: `${data.coverage.branches}%`,
                short: true,
              },
              {
                title: "Lines",
                value: `${data.coverage.lines}%`,
                short: true,
              },
            ],
          },
        ],
      };
      resolve(payload);
    });
  }

  sendNotification(payload) {
    return new Promise((resolve, reject) => {
      if (!payload) {
        reject(new Error("No slack payload provided"));
      }
      const timeout = setTimeout(() => {
        reject(new Error("Took too long to send slack request"));
      }, this.settings.timeout);

      // eslint-disable-next-line new-cap
      const slack = SlackNotify(this.settings.webhook);
      slack
        .send(payload)
        .then(resolve)
        .catch(reject)
        .finally(() => clearTimeout(timeout));
    });
  }
}