Skip to content

Client-only workaround for handling mocha hook errors #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bmomberger-bitovi merged 3 commits into from
Jun 7, 2018
Merged

Client-only workaround for handling mocha hook errors #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f41d29f
Catch mocha errors in before/after hooks, and report them back as par…
bmomberger-bitovi Jun 6, 2018
047299b
Add notes about reverting client-only change when server can be fixed
bmomberger-bitovi Jun 6, 2018
090f363
Uncomment test for mocha errors
bmomberger-bitovi Jun 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion src/adapters/mocha.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,33 @@ function TesteeReporter(runner) {
});

pipe('fail', function(data, err) {
var diff = self.diff(data);
var diff;
// Note: this is a workaround until https://github.com/bitovi/testee-client/pull/43
// can be merged. The associated server PR https://github.com/bitovi/testee/pull/163
// currently is failing to pass the tests, so #43 cannot be merged. Once that is working
// working, this change should be reverted. --BM 2018-06-06
var title = data.title;
if(data && data.type === "hook") {
if(data.ctx.currentTest) {
data = data.ctx.currentTest;
} else if(data.title === '"before all" hook') {
// tests in this suite will never run if before() fails,
// so create the first test in order to fail it.
data = data.parent.tests[0];
diff = self.diff(data);
self.api['test'](diff);
} else {
// after all hook. apply to last test, which has already ran
data = data.parent.tests[data.parent.tests.length - 1];
}
}

diff = self.diff(data);
diff.err = {
message: err.message,
stack: err.stack || ''
};
diff.title = title;
return diff;
});

Expand Down
29 changes: 29 additions & 0 deletions test/mocha/mocha-errors.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!DOCTYPE html>
<html>
<head>
<title>Mocha</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../node_modules/mocha/mocha.css" />
</head>
<body>
<div id="mocha"></div>

<script src="../../node_modules/chai/chai.js" type="text/javascript"></script>
<script src="../../node_modules/mocha/mocha.js" type="text/javascript"></script>
<script type="text/javascript">
mocha.setup('bdd');

onload = function () {
mocha.run();
};

window.expect = chai.expect;

window.__coverage__ = { test: 'Mocha coverage' };
window.Testee = window.top.TesteeMock;
</script>

<script type="text/javascript" src="../../dist/testee.js"></script>
<script type="text/javascript" src="test-errors.js"></script>
</body>
</html>
36 changes: 36 additions & 0 deletions test/mocha/test-errors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
describe('mocha', function() {
describe('Errors in setup/teardown', function() {
describe('before', function() {
before(function() {
throw new Error('Test error');
})
it('passes', function() {
expect(true).to.equal(true);
})
})
describe('beforeEach', function() {
beforeEach(function() {
throw new Error('Test error');
})
it('passes', function() {
expect(true).to.equal(true);
})
})
describe('afterEach', function() {
afterEach(function() {
throw new Error('Test error');
})
it('passes', function() {
expect(true).to.equal(true);
})
})
describe('after', function() {
after(function() {
throw new Error('Test error');
})
it('passes', function() {
expect(true).to.equal(true);
})
})
})
});
1 change: 0 additions & 1 deletion test/mocha/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,4 @@ describe('Test module', function() {
});
});
});

});
218 changes: 218 additions & 0 deletions test/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,6 +567,224 @@ unit.test(
testTester('mocha/mocha.html', mochaSnapshot)
);

var mochaErrorsSnapshot = [{
"name": "api/runs::create",
"data": {
"status": "running",
"environment": navigator.userAgent,
"runner": "Mocha",
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/suites::create",
"data": {
"status": "running",
"title": "",
"pending": false,
"root": true,
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/suites::create",
"data": {
"status": "running",
"title": "mocha",
"pending": false,
"root": false,
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/suites::create",
"data": {
"status": "running",
"title": "Errors in setup/teardown",
"pending": false,
"root": false,
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/suites::create",
"data": {
"status": "running",
"title": "before",
"pending": false,
"root": false,
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/tests::create",
"data": {
"title": "passes",
"sync": true,
"timedOut": false,
//"pending": true,
"type": "test",
//"status": "pending",
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/tests::patch",
"data": {
"status": "failed",
"state": "failed",
"title": "\"before all\" hook",
"err": {
"message": "Test error"
}
}
}, {
"name": "api/suites::patch",
"data": {
"status": "finished"
}
}, {
"name": "api/suites::create",
"data": {
"status": "running",
"title": "beforeEach",
"pending": false,
"root": false,
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/tests::create",
"data": {
"title": "passes",
"sync": true,
"timedOut": false,
"type": "test",
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/tests::patch",
"data": {
"status": "failed",
"state": "failed",
"title": "\"before each\" hook for \"passes\"",
"err": {
"message": "Test error"
}
}
}, {
"name": "api/suites::patch",
"data": {
"status": "finished"
}
}, {
"name": "api/suites::create",
"data": {
"status": "running",
"title": "afterEach",
"pending": false,
"root": false,
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/tests::create",
"data": {
"title": "passes",
"sync": true,
"timedOut": false,
"type": "test",
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/tests::patch",
"data": {
"status": "passed",
"state": "passed"
}
}, {
"name": "api/tests::patch",
"data": {
"status": "failed",
"state": "failed",
"title": "\"after each\" hook for \"passes\"",
"err": {
"message": "Test error"
}
}
}, {
"name": "api/suites::patch",
"data": {
"status": "finished"
}
}, {
"name": "api/suites::create",
"data": {
"status": "running",
"title": "after",
"pending": false,
"root": false,
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/tests::create",
"data": {
"title": "passes",
"sync": true,
"timedOut": false,
"type": "test",
"file": /mocha\/mocha-errors\.html/
}
}, {
"name": "api/tests::patch",
"data": {
"status": "passed",
"state": "passed"
}
}, {
"name": "api/tests::patch",
"data": {
"status": "failed",
"state": "failed",
"title": "\"after all\" hook",
"err": {
"message": "Test error"
}
}
}, {
"name": "api/suites::patch",
"data": {
"status": "finished"
}
}, {
"name": "api/suites::patch",
"data": {
"status": "finished"
}
}, {
"name": "api/suites::patch",
"data": {
"status": "finished"
}
}, {
"name": "api/suites::patch",
"data": {
"status": "finished"
}
}, {
"name": "api/coverages::create",
"data": {
coverage: {
"test": "Mocha coverage"
}
}
}, {
"name": "api/runs::patch",
"data": {
"status": "finished",
"total": 6,
"failed": 4,
"pending": 0,
"passed": 2
}
}];
unit.test(
'runs the Mocha test and errors as appropriate',
testTester('mocha/mocha-errors.html', mochaErrorsSnapshot)
);

var jasmineSnapshot = [{
"name": "api/runs::create",
"data": {
Expand Down