github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[kbn-expect] add optional error message (#48895) (#49439)

Browse source 
* [kbn-expect] add optional error message

* review feedback: replace error message with provided one

* add optional message for contain/string
This commit is contained in:
Dmitry Lemeshko 2019-10-26 13:01:43 -04:00 • committed by GitHub
parent bf262840b0
commit b0693a6671
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 48 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

43
packages/kbn-expect/expect.js
View file

@ -98,6 +98,9 @@ Assertion.prototype.assert = function (truth, msg, error, expected) {
if (!ok) {
err = new Error(msg.call(this));
if (this.customMsg) {
err.message = this.customMsg;
}
if (arguments.length > 3) {
err.actual = this.obj;
err.expected = expected;
@ -217,7 +220,10 @@ Assertion.prototype.empty = function () {
*/
Assertion.prototype.be =
Assertion.prototype.equal = function (obj) {
Assertion.prototype.equal = function (obj, msg) {
if (typeof(msg) === 'string') {
this.customMsg = msg;
}
this.assert(
obj === this.obj
, function(){ return 'expected ' + i(this.obj) + ' to equal ' + i(obj) }
@ -231,7 +237,10 @@ Assertion.prototype.equal = function (obj) {
* @api public
*/
Assertion.prototype.eql = function (obj) {
Assertion.prototype.eql = function (obj, msg) {
if (typeof(msg) === 'string') {
this.customMsg = msg;
}
this.assert(
expect.eql(this.obj, obj)
, function(){ return 'expected ' + i(this.obj) + ' to sort of equal ' + i(obj) }
@ -248,7 +257,10 @@ Assertion.prototype.eql = function (obj) {
* @api public
*/
Assertion.prototype.within = function (start, finish) {
Assertion.prototype.within = function (start, finish, msg) {
if (typeof(msg) === 'string') {
this.customMsg = msg;
}
var range = start + '..' + finish;
this.assert(
this.obj >= start && this.obj <= finish
@ -298,7 +310,10 @@ Assertion.prototype.an = function (type) {
*/
Assertion.prototype.greaterThan =
Assertion.prototype.above = function (n) {
Assertion.prototype.above = function (n, msg) {
if (typeof(msg) === 'string') {
this.customMsg = msg;
}
this.assert(
this.obj > n
, function(){ return 'expected ' + i(this.obj) + ' to be above ' + n }
@ -314,7 +329,10 @@ Assertion.prototype.above = function (n) {
*/
Assertion.prototype.lessThan =
Assertion.prototype.below = function (n) {
Assertion.prototype.below = function (n, msg) {
if (typeof(msg) === 'string') {
this.customMsg = msg;
}
this.assert(
this.obj < n
, function(){ return 'expected ' + i(this.obj) + ' to be below ' + n }
@ -329,7 +347,10 @@ Assertion.prototype.below = function (n) {
* @api public
*/
Assertion.prototype.match = function (regexp) {
Assertion.prototype.match = function (regexp, msg) {
if (typeof(msg) === 'string') {
this.customMsg = msg;
}
this.assert(
regexp.exec(this.obj)
, function(){ return 'expected ' + i(this.obj) + ' to match ' + regexp }
@ -344,7 +365,10 @@ Assertion.prototype.match = function (regexp) {
* @api public
*/
Assertion.prototype.length = function (n) {
Assertion.prototype.length = function (n, msg) {
if (typeof(msg) === 'string') {
this.customMsg = msg;
}
expect(this.obj).to.have.property('length');
var len = this.obj.length;
this.assert(
@ -410,7 +434,10 @@ Assertion.prototype.property = function (name, val) {
*/
Assertion.prototype.string =
Assertion.prototype.contain = function (obj) {
Assertion.prototype.contain = function (obj, msg) {
if (typeof(msg) === 'string') {
this.customMsg = msg;
}
if ('string' == typeof this.obj) {
this.assert(
~this.obj.indexOf(obj)

26
packages/kbn-expect/expect.js.d.ts vendored
View file

@ -59,12 +59,12 @@ interface Assertion {
/**
* Checks if the obj exactly equals another.
*/
equal(obj: any): Assertion;
equal(obj: any, msg?: string): Assertion;
/**
* Checks if the obj sortof equals another.
*/
eql(obj: any): Assertion;
eql(obj: any, msg?: string): Assertion;
/**
* Assert within start to finish (inclusive).
@ -72,7 +72,7 @@ interface Assertion {
* @param start
* @param finish
*/
within(start: number, finish: number): Assertion;
within(start: number, finish: number, msg?: string): Assertion;
/**
* Assert typeof.
@ -87,36 +87,36 @@ interface Assertion {
/**
* Assert numeric value above n.
*/
greaterThan(n: number): Assertion;
greaterThan(n: number, msg?: string): Assertion;
/**
* Assert numeric value above n.
*/
above(n: number): Assertion;
above(n: number, msg?: string): Assertion;
/**
* Assert numeric value below n.
*/
lessThan(n: number): Assertion;
lessThan(n: number, msg?: string): Assertion;
/**
* Assert numeric value below n.
*/
below(n: number): Assertion;
below(n: number, msg?: string): Assertion;
/**
* Assert string value matches regexp.
*
* @param regexp
*/
match(regexp: RegExp): Assertion;
match(regexp: RegExp, msg?: string): Assertion;
/**
* Assert property "length" exists and has value of n.
*
* @param n
*/
length(n: number): Assertion;
length(n: number, msg?: string): Assertion;
/**
* Assert property name exists, with optional val.
@ -129,14 +129,14 @@ interface Assertion {
/**
* Assert that string contains str.
*/
contain(str: string): Assertion;
string(str: string): Assertion;
contain(str: string, msg?: string): Assertion;
string(str: string, msg?: string): Assertion;
/**
* Assert that the array contains obj.
*/
contain(obj: any): Assertion;
string(obj: any): Assertion;
contain(obj: any, msg?: string): Assertion;
string(obj: any, msg?: string): Assertion;
/**
* Assert exact keys or inclusion of keys by using the `.own` modifier.