fix(allure-cypress): missing tests and fixtures when an error occurs in a hook

[delatrie]

The changes

Reporting of failed hooks

If a hook fails, Mocha won't emit the hook end event. That caused the corresponding fixture to hang in the state until the process finishes instead of being written on disk.

Now, we're detecting those cases, and issuing the cypress_hook_end message in the Mocha's fail event if it corresponds to a hook error.

Note

Spec-level after hooks are handled differently. See below.

Reporting of spec-level failed after hooks

In beta 10 we support spec-level after hooks by patching the after function to introduce two hooks instead of one. The first hook is the original user-defined one, while the second, the Allure-specific one, is responsible for flushing the messages of the original hook to Node.js.

That works just fine until the user-defined hook fails. In that case, Mocha skips its Allure-specific counterpart, which essentially precludes the hook from being reported.

With this PR, the mechanism is changed. Now, instead of inserting extra hooks, we wrap the original hook implementation function. The wrapper calls the original hook implementation, then:

• if the hook fails, it reports all the messages to complete the spec (remember, we're talking about a spec-level after hook; if it fails, other such hooks will be skipped making the failed hook the last piece of user-defined code being executed and the last place capable of calling a Cypress task).
• if the hook succeeds, it completes the spec only if it was the last spec-level after hook in the spec file.

All three types of functions are supported:

• Synchronous: after(() => { /* ... */ });
• Promise-based: after(async () => { /* ... */ });
• Callback-based:after((done) => { /* the code must eventually call done */ });

That technique also works better with cypress open. Previously we tried to complete the spec in Mocha's end event, which, TBH, never worked in the first place.

With cypress run we still rely on Cypress'es after:spec event because it allows us to attach the video.

Reporting of tests skipped because of a failed hook

If a hook fails, Mocha skips the remaining tests from the suite where the hook has been defined. This PR includes them (except those not in the test plan, if any) in the report with the status that depends on the failed hook type:

• broken for before hooks.
• skipped for beforeEach and afterEach hooks.

Note

There are no skipped tests in case of a failed after hook.

Fixes #1072

Open issues

There is a problem with failed after-fixture visibility. See #1122 for more details.

Other minor changes

• Add language specs to examples embedded into JS doc comments
• Some unused code was removed

Checklist

• Sign Allure CLA
• Provide unit tests