Different ways to show Results

[renycorreia]

Is there a way of showing the results in a more descriptive way, insted of (or in adition to) the percentage? If there isn't, is there any predictions of launching something like this?

e.g.

[ASaiAnudeep]

We want to support these kind of customisations through extensions.

[renycorreia]

Thanks for the replay @ASaiAnudeep!

I was able to create the custom result. But, is there a way to show only the custom result without the default result?

[renycorreia]

After copying to our custom.js some of the functions in references to the payload, we were able to return only the custom result.

[kartal-huseyin]

Can you share the custom.js file pls?

[renycorreia]

@kartal-huseyin

This is my custom.js file

const request = require('phin-retry');

const STATUS = Object.freeze({
  PASS: 'pass',
  FAIL: 'fail',
  PASS_OR_FAIL: 'passOrfail'
});

async function run({ target, result }) {


  setTargetInputs(target);
  const root_payload = getRootPayload();
  const payload = getMainPayload(target);
  await setFunctionalPayload({ result, target, payload });
  setRootPayload(root_payload, payload);
  return request.post({
    url: target.inputs.url,
    body: root_payload
  });


  async function setFunctionalPayload({ result, target, payload, root_payload }) {
    await extension_manager.run({ result, target, payload, root_payload, hook: HOOK.START });
    setTitleBlock({ result, target, payload });
    setMainBlock({ result, target, payload });
    await extension_manager.run({ result, target, payload, root_payload, hook: HOOK.POST_MAIN });
    setSuiteBlock({ result, target, payload });
    await extension_manager.run({ result, target, payload, root_payload, hook: HOOK.END });
  }

  function setTargetInputs(target) {
    target.inputs = Object.assign({}, default_inputs, target.inputs);
    if (target.inputs.publish === 'test-summary-slim') {
      target.inputs.include_suites = false;
    }
    if (target.inputs.publish === 'failure-details') {
      target.inputs.include_failure_details = true;
    }
  }

  function getMainPayload(target) {
    const main = {
      "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
      "type": "AdaptiveCard",
      "version": "1.0",
      "body": [],
      "actions": []
    };
    if (target.inputs.width) {
      if (!main.msteams) {
        main.msteams = {};
      }
      main.msteams.width = target.inputs.width;
    }
    return main;
  }

  function getTitleText(result, target) {
    const title = target.inputs.title ? target.inputs.title : result.name;
    if (target.inputs.title_suffix) {
      return `${title} ${target.inputs.title_suffix}`;
    }
    return `${title}`;
  }

  async function setFunctionalPayload({ result, target, payload }) {
    setTitleBlock({ result, target, payload });
    setMainBlock({ result, target, payload });
    setSuiteBlock({ result, target, payload });
  }

  function setTitleBlock({ result, target, payload }) {
    const title = getTitleText(result, target).split("\\").pop().replace('.dll', '');
    let text = `${result.failed > 0 ? '❌' : '✅'} ${title}`;

    if (target.inputs.title_link) {
      text = `[${text}](${target.inputs.title_link})`
    }
    payload.body.push({
      "type": "TextBlock",
      "text": text,
      "size": "medium",
      "weight": "bolder",
      "wrap": true
    });
  }

  function setMainBlock({ result, payload }) {
    const facts = [];
    facts.push({
      "value": `${blankSpaces(5)} Total: ${result.total} | Passed:  ${result.passed} | Failed: ${result.failed} | Skipped: ${result.skipped}`
    });
    facts.push({
      "value": `${blankSpaces(5)} Duration: ${Math.ceil(result.duration / 60000)}m`
    });
    payload.body.push({
      "type": "FactSet",
      "facts": facts
    });
  }

  function setSuiteBlock({ result, target, payload }) {
    if (target.inputs.include_suites) {
      for (let i = 0; i < result.suites.length; i++) {
        const suite = result.suites[i];
        if (target.inputs.only_failures && suite.status !== 'FAIL') {
          continue;
        }
        payload.body.push(...getSuiteSummary({ suite }));
        if (target.inputs.include_failure_details) {
          payload.body.push(...getFailureDetailsFactSets(suite));
        }
      }
    }
  }

  function getSuiteSummary({ suite }) {
    return [
      {
        "type": "TextBlock",
        "text": `${blankSpaces(5)} ${suite.failed > 0 ? '❌' : '✅'} ${suite.name.split(".Features.")[1]}`,
        "isSubtle": true,
        "weight": "bolder",
        "wrap": true
      },
      {
        "type": "FactSet",
        "facts": [
          {
            "value": `${blankSpaces(20)} Total: ${suite.total} | Passed:  ${suite.passed} | Failed: ${suite.failed} | Skipped: ${suite.skipped}`
          },
          {
            "value": `${blankSpaces(20)} Duration: ${Math.ceil(suite.duration / 60000)}m`
          }
        ]
      }
    ]
  }
  function getFailureDetailsFactSets(suite) {
    const fact_sets = [];
    const cases = suite.cases;
    for (let i = 0; i < cases.length; i++) {
      const test_case = cases[i];
      if (test_case.status === 'FAIL') {
        fact_sets.push({
          "type": "FactSet",
          "facts": [
            {
              "title": "Test:",
              "value": test_case.name
            },
            {
              "title": "Error:",
              "value": truncate(test_case.failure, 150)
            }
          ]
        });
      }
    }
    return fact_sets;
  }

  function blankSpaces(n) {
    var txt = `\u0020`;

    for (let i = 0; i < n; i++) {
      txt += `\u0020`;
    }
    return txt;
  }
}

function getRootPayload() {
  return {
    "type": "message",
    "attachments": [
      {
        "contentType": "application/vnd.microsoft.card.adaptive",
        "content": ''
      }
    ]
  };
}

function setRootPayload(root_payload, payload) {
  root_payload.attachments[0].content = payload;
}

const default_options = {
  condition: STATUS.PASS_OR_FAIL
}

const default_inputs = {
  publish: 'test-summary',
  include_suites: true,
  only_failures: false,
  include_failure_details: false,
  width: '',
  duration: '',
  metrics: [
    {
      "name": "Samples",
    },
    {
      "name": "Duration",
      "condition": "always",
      "fields": ["avg", "p95"]
    }
  ]
}


module.exports = {
  run
}

This is my config.json file

{
  "reports": [
    {
      "targets": [
        {
          "name": "custom",
          "inputs": {
            "url": "{TeamsWebhook}",
            "title": "{PROJECT_NAME}",
            "title_link": "{BUILD_URL}",
            "load": "resources/custom.js"
          }
        }
      ],
      "results": [
        {
          "type": "xunit",
          "files": [
            "resources/TestResult.xml"
          ]
        }
      ]
    }
  ]
}

And this is the final card

[asmarazaq]

I am not able to integrate it with circle ci build