FilesExpand file tree

 main

/

failed-tests.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

145 lines (129 loc) · 5.02 KB

 main

/

failed-tests.js

Copy path

Top

File metadata and controls

• Code
• Blame

145 lines (129 loc) · 5.02 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

// @ts-check

const Mocha = require("mocha");

const path = require("path");

const fs = require("fs");

const os = require("os");

const failingHookRegExp = /^(.*) "(before|after) (all|each)" hook$/;

/**

* .failed-tests reporter

*

* @typedef {Object} ReporterOptions

* @property {string} [file]

* @property {boolean} [keepFailed]

* @property {string|Mocha.ReporterConstructor} [reporter]

* @property {*} [reporterOptions]

*/

class FailedTestsReporter extends Mocha.reporters.Base {

/**

* @param {Mocha.Runner} runner

* @param {{ reporterOptions?: ReporterOptions }} [options]

*/

constructor(runner, options) {

super(runner, options);

if (!runner) return;

const reporterOptions = this.reporterOptions = options.reporterOptions || {};

if (reporterOptions.file === undefined) reporterOptions.file = ".failed-tests";

if (reporterOptions.keepFailed === undefined) reporterOptions.keepFailed = false;

if (reporterOptions.reporter) {

/** @type {Mocha.ReporterConstructor} */

let reporter;

if (typeof reporterOptions.reporter === "function") {

reporter = reporterOptions.reporter;

}

else if (Mocha.reporters[reporterOptions.reporter]) {

reporter = Mocha.reporters[reporterOptions.reporter];

}

else {

try {

reporter = require(reporterOptions.reporter);

}

catch (_) {

reporter = require(path.resolve(process.cwd(), reporterOptions.reporter));

}

}

const newOptions = Object.assign({}, options, { reporterOptions: reporterOptions.reporterOptions || {} });

if (reporterOptions.reporter === "xunit") {

newOptions.reporterOptions.output = "TEST-results.xml";

}

this.reporter = new reporter(runner, newOptions);

}

/** @type {Mocha.Test[]} */

this.passes = [];

/** @type {(Mocha.Test)[]} */

this.failures = [];

runner.on("pass", test => this.passes.push(test));

runner.on("fail", test => this.failures.push(test));

}

/**

* @param {string} file

* @param {ReadonlyArray<Mocha.Test>} passes

* @param {ReadonlyArray<Mocha.Test | Mocha.Hook>} failures

* @param {boolean} keepFailed

* @param {(err?: NodeJS.ErrnoException) => void} done

*/

static writeFailures(file, passes, failures, keepFailed, done) {

const failingTests = new Set(fs.existsSync(file) ? readTests() : undefined);

const possiblyPassingSuites = /**@type {Set<string>}*/(new Set());

// Remove tests that are now passing and track suites that are now

// possibly passing.

if (failingTests.size > 0 && !keepFailed) {

for (const test of passes) {

failingTests.delete(test.fullTitle().trim());

possiblyPassingSuites.add(test.parent.fullTitle().trim());

}

}

// Add tests that are now failing. If a hook failed, track its

// containing suite as failing. If the suite for a test or hook was

// possibly passing then it is now definitely failing.

for (const test of failures) {

const suiteTitle = test.parent.fullTitle().trim();

if (test.type === "test") {

failingTests.add(test.fullTitle().trim());

}

else {

failingTests.add(suiteTitle);

}

possiblyPassingSuites.delete(suiteTitle);

}

// Remove all definitely passing suites.

for (const suite of possiblyPassingSuites) {

failingTests.delete(suite);

}

if (failingTests.size > 0) {

const failed = Array

.from(failingTests)

.sort()

.join(os.EOL);

fs.writeFile(file, failed, "utf8", done);

}

else if (!keepFailed && fs.existsSync(file)) {

fs.unlink(file, done);

}

else {

done();

}

function readTests() {

return fs.readFileSync(file, "utf8")

.split(/\r?\n/g)

.map(line => line.trim())

.filter(line => line.length > 0);

}

}

/**

* @param {number} failures

* @param {(failures: number) => void} [fn]

*/

done(failures, fn) {

FailedTestsReporter.writeFailures(this.reporterOptions.file, this.passes, this.failures, this.reporterOptions.keepFailed || this.stats.tests === 0, (err) => {

const reporter = this.reporter;

if (reporter && reporter.done) {

reporter.done(failures, fn);

}

else if (fn) {

fn(failures);

}

if (err) console.error(err);

});

}

}

module.exports = FailedTestsReporter;