@restqa/cucumber-export/src/reports/slack.js

A simple cucumber-js formatter exporting your result to different endpoints

const got = require("got");
const Errors = require("../errors");

module.exports = function (config, result) {
  return new Promise((resolve, reject) => {
    try {
      if (undefined === config.onlyFailed) {
        config.onlyFailed = true;
      }

      if (!config.url)
        return reject(
          new Error('config.url is required for the "slack" report')
        );

      const url = new URL(config.url);

      if (config.onlyFailed === true && result.success === true)
        return resolve(
          "[SLACK] No Notification is required because eveything is fine :)"
        );

      const getStepsError = function () {
        return result.features
          .filter((_) => !_.result)
          .map((feature) => {
            return feature.elements
              .filter((_) => !_.result)
              .map((scenario) => {
                const step = scenario.steps.find(
                  (_) => _.result.status === "failed"
                );
                if (!step) return null;
                return {
                  type: "section",
                  text: {
                    type: "mrkdwn",
                    text: [
                      `📕 *Feature*: ${feature.feature_name}`,
                      `*Scenario*: ${scenario.name}`,
                      `*Failed step*: ${step.keyword} ${step.name} (Line ${step.line})`,
                      `\`\`\` ${step.result.error_message} \`\`\``,
                      "----"
                    ].join("\n")
                  }
                };
              })
              .filter((_) => _);
          })
          .flat();
      };

      const status = result.success ? "Passed" : "Failed";
      let blocks = [
        {
          type: "section",
          text: {
            type: "mrkdwn",
            text: `The test suite *${status} (${result.passed}/${result.total})*`
          }
        },
        {
          type: "section",
          fields: [
            {
              type: "mrkdwn",
              text: `*Name:* ${result.name}`
            },
            {
              type: "mrkdwn",
              text: `*key:* ${result.key}`
            },
            {
              type: "mrkdwn",
              text: `*Environment:* ${result.env}`
            },
            {
              type: "mrkdwn",
              text: `*Execution Id :* ${result.id}`
            }
          ]
        },
        {
          type: "section",
          text: {
            type: "mrkdwn",
            text: `*Scenarios:* \n *  Passed: ${result.scenarios.passed} \n *  Failed: ${result.scenarios.failed} \n *  Skipped: ${result.scenarios.skipped} \n * Undefined: ${result.scenarios.undefined}`
          },
          accessory: {
            type: "image",
            image_url: `https://restqa.io/assets/img/utils/restqa-logo-${status.toLowerCase()}.png`,
            alt_text: "status"
          }
        },
        {
          type: "context",
          elements: [
            {
              type: "mrkdwn",
              text: "*Powered By:*"
            },
            {
              type: "mrkdwn",
              text: "<https://restqa.io|@restqa>"
            }
          ]
        }
      ];

      if (config.showErrors) {
        blocks = blocks.concat(getStepsError());
      }

      if (config.reportUrl) {
        const section = {
          type: "section",
          text: {
            type: "mrkdwn",
            text: `📊  <${config.reportUrl.replace(
              "{uuid}",
              result.id
            )}|Acccess to the Test report>`
          }
        };
        blocks = blocks.concat(section);
      }

      const data = {
        attachments: [
          {
            color: result.success ? "#007a5a" : "#ff0000",
            blocks: blocks
          }
        ]
      };

      const options = {
        hostname: url.hostname,
        port: url.port,
        protocol: url.protocol,
        pathname: url.pathname,
        method: "POST",
        body: JSON.stringify(data)
      };

      got(options)
        .then((res) => {
          resolve(`[SLACK REPORT][${res.statusCode}] - ${config.url}`);
        })
        .catch((err) => {
          reject(new Errors.HTTP("SLACK REPORT", err));
        });
    } catch (e) {
      reject(new Errors.DEFAULT("SLACK REPORT", e));
    }
  });
};