Feature: skipped_tests_passed flag for mocha parser

[jmuleiro]

Context

I have a few tests that are skipped via feature flags that are evaluated in Cypress' code. Because of what the resulting JSON looks like, the parser interprets the results as if passed tests < total tests. Though this is technically correct, because the tests themselves didn't run, you can't exactly say they failed (or passed, for that matter). But with my use case, I need those skipped tests to be ignored and not considered for the pass rate.

Because this feels like such a niche scenario, I decided to implement flag into the parser's configuration, that would look like this in testbeats' configuration:

{
  "results": [
    {
      "type": "mocha",
      "files": ["cypress-output.json"],
      "skipped_tests_passed": true
    }
  ]
}

The flag, set to false by default, lets the mocha parser completely ignore skipped and pending tests, subtracting them from the total metric, which leads to testbeats showing an appropriate pass rate (of 100% in my case).

Changes

• Added skipped_tests_passed flag to ParseOptions interface
• Added skipped_tests_passed logic to mocha parser
  • The default behavior remains the same, but if skipped_tests_passed=true, result.skipped will be subtracted from result.total to not consider skipped tests for the total pass rate
• Added mocha JSON test case for when skipped_tests_passed=true
• Added mochawesome test case for when skipped_tests_passed=true
• Miscellaneous
  • getTestSuite: Now checks if rawSuite has a property of skipped, and sums its length to suite.skipped if it does. This is to prevent nested tests from being set to FAIL even when they were actually skipped (related to PR #64).

[jmuleiro]

Note: Feel free to suggest a better name for the flag, skipped_tests_passed was the best I could come up with. Note 2: I'm using a custom-built version of the packages in the meantime, so there's no rush to get this feature in from my end.

[ASaiAnudeep]

I believe this is something mocha reporter should support natively.

[jmuleiro]

I believe this is something mocha reporter should support natively.

@ASaiAnudeep I agree, though for the time being, it doesn't.

[ASaiAnudeep]

Closing this as for now. Will come up with a better way to handle extensions.