warren/jasmine
1
0
Fork 0
Code Issues Pull Requests Actions 9 Packages Projects Releases Wiki Activity

Improve errors with the domaine and how to use the API

Browse Source
This commit is contained in:
dhoko
2016-01-20 15:49:47 +01:00
parent b6798cdb06
commit 14067d0785
16 changed files with 131 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
spec/core/formatErrorMsgSpec.js Normal file
View File

@@ -0,0 +1,69 @@
describe('formatErrorMsg', function () {
it('should return a factory', function() {
expect(typeof jasmineUnderTest.formatErrorMsg).toBe('function');
});
describe('Format an error with a domain', function() {
var formator;
beforeEach(function() {
formator = jasmineUnderTest.formatErrorMsg('api');
});
it('should format the output', function() {
expect(formator('message').trim()).toBe('api : message');
expect(formator('message2').trim()).toBe('api : message2');
});
});
describe('Format an error with a domain and usage', function() {
var formator;
beforeEach(function() {
formator = jasmineUnderTest.formatErrorMsg('api', 'with a param');
});
it('should format the output', function() {
expect(formator('message').trim()).toBe('api : message\nUsage: with a param');
expect(formator('message2').trim()).toBe('api : message2\nUsage: with a param');
});
});
describe('Format an error with a domain, usage, Tips', function() {
var formator;
beforeEach(function() {
formator = jasmineUnderTest.formatErrorMsg('api', 'with a param', 'you can do it');
});
it('should format the output', function() {
expect(formator('message').trim()).toBe('api : message\nUsage: with a param\nTips: you can do it');
expect(formator('message2').trim()).toBe('api : message2\nUsage: with a param\nTips: you can do it');
});
});
describe('Format an error with a domain no usage and Tips', function() {
var formator;
beforeEach(function() {
formator = jasmineUnderTest.formatErrorMsg('api', null, 'you can do it');
});
it('should format the output', function() {
expect(formator('message').trim()).toBe('api : message\nTips: you can do it');
expect(formator('message2').trim()).toBe('api : message2\nTips: you can do it');
});
});
});

4
spec/core/matchers/toHaveBeenCalledSpec.js
View File

@@ -24,14 +24,14 @@ describe("toHaveBeenCalled", function() {
var matcher = jasmineUnderTest.matchers.toHaveBeenCalled(),
fn = function() {};
expect(function() { matcher.compare(fn) }).toThrow(new Error("Expected a spy, but got Function."));
expect(function() { matcher.compare(fn) }).toThrowError(Error, /Expected a spy, but got Function./);
});
it("throws an exception when invoked with any arguments", function() {
var matcher = jasmineUnderTest.matchers.toHaveBeenCalled(),
spy = jasmineUnderTest.createSpy('sample spy');
expect(function() { matcher.compare(spy, 'foo') }).toThrow(new Error("toHaveBeenCalled does not take arguments, use toHaveBeenCalledWith"));
expect(function() { matcher.compare(spy, 'foo') }).toThrowError(Error, /It does not take arguments, use toHaveBeenCalledWith/);
});
it("has a custom message on failure", function() {

4
spec/core/matchers/toHaveBeenCalledTimesSpec.js
View File

@@ -24,7 +24,7 @@ describe("toHaveBeenCalledTimes", function() {
spy();
expect(function() {
matcher.compare(spy);
}).toThrowError('The expected times failed is a required argument and must be a number.');
}).toThrowError(/The expected times failed is a required argument and must be a number./);
});
it("fails when the actual was called less than the expected", function() {
@@ -54,7 +54,7 @@ describe("toHaveBeenCalledTimes", function() {
expect(function() {
matcher.compare(fn);
}).toThrowError("Expected a spy, but got Function.");
}).toThrowError(/Expected a spy, but got Function./);
});
it("has a custom message on failure that tells it was called only once", function() {

3
spec/core/matchers/toHaveBeenCalledWithSpec.js
View File

@@ -1,4 +1,5 @@
describe("toHaveBeenCalledWith", function() {
it("passes when the actual was called with matching parameters", function() {
var util = {
contains: jasmine.createSpy('delegated-contains').and.returnValue(true)
@@ -61,6 +62,6 @@ describe("toHaveBeenCalledWith", function() {
var matcher = jasmineUnderTest.matchers.toHaveBeenCalledWith(),
fn = function() {};
expect(function() { matcher.compare(fn) }).toThrow(new Error("Expected a spy, but got Function."));
expect(function() { matcher.compare(fn) }).toThrowError(/Expected a spy, but got Function./);
});
});

3
spec/core/matchers/toMatchSpec.js
View File

@@ -1,4 +1,5 @@
describe("toMatch", function() {
it("passes when RegExps are equivalent", function() {
var matcher = jasmineUnderTest.matchers.toMatch(),
result;
@@ -36,7 +37,7 @@ describe("toMatch", function() {
expect(function() {
matcher.compare('foo', { bar: 'baz' });
}).toThrowError('Expected is not a String or a RegExp');
}).toThrowError(/Expected is not a String or a RegExp/);
});
});

8
spec/core/matchers/toThrowErrorSpec.js
View File

@@ -4,7 +4,7 @@ describe("toThrowError", function() {
expect(function() {
matcher.compare({});
}).toThrowError("Actual is not a Function");
}).toThrowError(/Actual is not a Function/);
});
it("throws an error when the expected is not an Error, string, or RegExp", function() {
@@ -15,7 +15,7 @@ describe("toThrowError", function() {
expect(function() {
matcher.compare(fn, 1);
}).toThrowError("Expected is not an Error, string, or RegExp.");
}).toThrowError(/Expected is not an Error, string, or RegExp./);
});
it("throws an error when the expected error type is not an Error", function() {
@@ -26,7 +26,7 @@ describe("toThrowError", function() {
expect(function() {
matcher.compare(fn, void 0, "foo");
}).toThrowError("Expected error type is not an Error.");
}).toThrowError(/Expected error type is not an Error./);
});
it("throws an error when the expected error message is not a string or RegExp", function() {
@@ -37,7 +37,7 @@ describe("toThrowError", function() {
expect(function() {
matcher.compare(fn, Error, 1);
}).toThrowError("Expected error message is not a string or RegExp.");
}).toThrowError(/Expected error message is not a string or RegExp./);
});
it("fails if actual does not throw at all", function() {

3
spec/core/matchers/toThrowSpec.js
View File

@@ -1,11 +1,12 @@
describe("toThrow", function() {
it("throws an error when the actual is not a function", function() {
var matcher = jasmineUnderTest.matchers.toThrow();
expect(function() {
matcher.compare({});
matcherComparator({});
}).toThrowError("Actual is not a Function");
}).toThrowError(/Actual is not a Function/);
});
it("fails if actual does not throw", function() {

13
src/core/SpyRegistry.js
View File

@@ -1,5 +1,7 @@
getJasmineRequireObj().SpyRegistry = function(j$) {
var getErrorMsg = j$.formatErrorMsg('<spyOn>', 'spyOn(<object>, <methodName>)');
function SpyRegistry(options) {
options = options || {};
var currentSpies = options.currentSpies || function() { return []; };
@@ -9,23 +11,24 @@ getJasmineRequireObj().SpyRegistry = function(j$) {
};
this.spyOn = function(obj, methodName) {
if (j$.util.isUndefined(obj)) {
throw new Error('spyOn could not find an object to spy upon for ' + methodName + '()');
throw new Error(getErrorMsg('could not find an object to spy upon for ' + methodName + '()'));
}
if (j$.util.isUndefined(methodName)) {
throw new Error('No method name supplied');
throw new Error(getErrorMsg('No method name supplied the second parameter is required'));
}
if (j$.util.isUndefined(obj[methodName])) {
throw new Error(methodName + '() method does not exist');
throw new Error(getErrorMsg(methodName + '() method does not exist'));
}
if (obj[methodName] && j$.isSpy(obj[methodName]) ) {
if ( !!this.respy ){
return obj[methodName];
}else {
throw new Error(methodName + ' has already been spied upon');
throw new Error(getErrorMsg(methodName + ' has already been spied upon'));
}
}
@@ -37,7 +40,7 @@ getJasmineRequireObj().SpyRegistry = function(j$) {
}
if (descriptor && !(descriptor.writable || descriptor.set)) {
throw new Error(methodName + ' is not declared writable or has no setter');
throw new Error(getErrorMsg(methodName + ' is not declared writable or has no setter'));
}
var originalMethod = obj[methodName],

14
src/core/formatErrorMsg.js Normal file
View File

@@ -0,0 +1,14 @@
getJasmineRequireObj().formatErrorMsg = function() {
function generateErrorMsg(domain, usage, reco) {
var usageDefinition = usage ? 'Usage: ' + usage + '\n' : '';
var recoDefinition = reco ? 'Tips: ' + reco + '\n' : '';
return function errorMsg(msg) {
return domain + ' : ' + msg + '\n' + usageDefinition + recoDefinition;
};
}
return generateErrorMsg;
};

6
src/core/matchers/toHaveBeenCalled.js
View File

@@ -1,16 +1,18 @@
getJasmineRequireObj().toHaveBeenCalled = function(j$) {
var getErrorMsg = j$.formatErrorMsg('<toHaveBeenCalled>', 'expect(<spyObj>).toHaveBeenCalled()', 'To test with arguments, you can use <toHaveBeenCalledWith>');
function toHaveBeenCalled() {
return {
compare: function(actual) {
var result = {};
if (!j$.isSpy(actual)) {
throw new Error('Expected a spy, but got ' + j$.pp(actual) + '.');
throw new Error(getErrorMsg('Expected a spy, but got ' + j$.pp(actual) + '.'));
}
if (arguments.length > 1) {
throw new Error('toHaveBeenCalled does not take arguments, use toHaveBeenCalledWith');
throw new Error(getErrorMsg('It does not take arguments, use toHaveBeenCalledWith'));
}
result.pass = actual.calls.any();

8
src/core/matchers/toHaveBeenCalledTimes.js
View File

@@ -1,17 +1,19 @@
getJasmineRequireObj().toHaveBeenCalledTimes = function(j$) {
var getErrorMsg = j$.formatErrorMsg('<toHaveBeenCalledTimes>', 'expect(<spyObj>).toHaveBeenCalledTimes(<Number>)');
function toHaveBeenCalledTimes() {
return {
compare: function(actual, expected) {
if (!j$.isSpy(actual)) {
throw new Error('Expected a spy, but got ' + j$.pp(actual) + '.');
throw new Error(getErrorMsg('Expected a spy, but got ' + j$.pp(actual) + '.'));
}
var args = Array.prototype.slice.call(arguments, 0),
result = { pass: false };
if (!j$.isNumber_(expected)){
throw new Error('The expected times failed is a required argument and must be a number.');
throw new Error(getErrorMsg('The expected times failed is a required argument and must be a number.'));
}
actual = args[0];
@@ -27,4 +29,4 @@ getJasmineRequireObj().toHaveBeenCalledTimes = function(j$) {
}
return toHaveBeenCalledTimes;
};
};

4
src/core/matchers/toHaveBeenCalledWith.js
View File

@@ -1,5 +1,7 @@
getJasmineRequireObj().toHaveBeenCalledWith = function(j$) {
var getErrorMsg = j$.formatErrorMsg('<toHaveBeenCalledWith>', 'expect(<spyObj>).toHaveBeenCalledWith(...arguments)');
function toHaveBeenCalledWith(util, customEqualityTesters) {
return {
compare: function() {
@@ -9,7 +11,7 @@ getJasmineRequireObj().toHaveBeenCalledWith = function(j$) {
result = { pass: false };
if (!j$.isSpy(actual)) {
throw new Error('Expected a spy, but got ' + j$.pp(actual) + '.');
throw new Error(getErrorMsg('Expected a spy, but got ' + j$.pp(actual) + '.'));
}
if (!actual.calls.any()) {

4
src/core/matchers/toMatch.js
View File

@@ -1,10 +1,12 @@
getJasmineRequireObj().toMatch = function(j$) {
var getErrorMsg = j$.formatErrorMsg('<toMatch>', 'expect(<expectation>).toMatch(<string> || <regexp>)');
function toMatch() {
return {
compare: function(actual, expected) {
if (!j$.isString_(expected) && !j$.isA_('RegExp', expected)) {
throw new Error('Expected is not a String or a RegExp');
throw new Error(getErrorMsg('Expected is not a String or a RegExp'));
}
var regexp = new RegExp(expected);

4
src/core/matchers/toThrow.js
View File

@@ -1,5 +1,7 @@
getJasmineRequireObj().toThrow = function(j$) {
var getErrorMsg = j$.formatErrorMsg('<toThrow>', 'expect(function() {<expectation>}).toThrow()', 'You can match a specific exception with <toThrowError>');
function toThrow(util) {
return {
compare: function(actual, expected) {
@@ -8,7 +10,7 @@ getJasmineRequireObj().toThrow = function(j$) {
thrown;
if (typeof actual != 'function') {
throw new Error('Actual is not a Function');
throw new Error(getErrorMsg('Actual is not a Function'));
}
try {

11
src/core/matchers/toThrowError.js
View File

@@ -1,4 +1,7 @@
getJasmineRequireObj().toThrowError = function(j$) {
var getErrorMsg = j$.formatErrorMsg('<toThrowError>', 'expect(function() {' + '\n' + '\t' + '<expectation>' + '\n' + '}).toThrowError(<constructorErrror>, <message>)');
function toThrowError () {
return {
compare: function(actual) {
@@ -8,7 +11,7 @@ getJasmineRequireObj().toThrowError = function(j$) {
thrown;
if (typeof actual != 'function') {
throw new Error('Actual is not a Function');
throw new Error(getErrorMsg('Actual is not a Function'));
}
var errorMatcher = getMatcher.apply(null, arguments);
@@ -64,15 +67,15 @@ getJasmineRequireObj().toThrowError = function(j$) {
errorType = arguments[1];
expected = arguments[2];
if (!isAnErrorType(errorType)) {
throw new Error('Expected error type is not an Error.');
throw new Error(getErrorMsg('Expected error type is not an Error.'));
}
}
if (expected && !isStringOrRegExp(expected)) {
if (errorType) {
throw new Error('Expected error message is not a string or RegExp.');
throw new Error(getErrorMsg('Expected error message is not a string or RegExp.'));
} else {
throw new Error('Expected is not an Error, string, or RegExp.');
throw new Error(getErrorMsg('Expected is not an Error, string, or RegExp.'));
}
}

1
src/core/requireCore.js
View File

@@ -25,6 +25,7 @@ var getJasmineRequireObj = (function (jasmineGlobal) {
jRequire.base(j$, jasmineGlobal);
j$.util = jRequire.util();
j$.errors = jRequire.errors();
j$.formatErrorMsg = jRequire.formatErrorMsg();
j$.Any = jRequire.Any(j$);
j$.Anything = jRequire.Anything(j$);
j$.CallTracker = jRequire.CallTracker(j$);