power-assert-js / empower / 273

pending completion

Build # 273

Build Type

Pull #29

travis-ci

Committed by

web-flow

Commit Message

fix: treat power-assert message as "not generated" to avoid message override

by setting `AssertionError.generatedMessage` to false
now works well with Jest
https://github.com/facebook/jest/blob/ed95b36bb/packages/jest-jasmine2/src/assert_support.js#L97

Pull Request Pull Request #29: fix: treat power-assert message as "not generated" to avoid message override

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

71 of 74 relevant lines covered (95.95%)

98.03 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.48

/index.js

/**
 * empower - Power Assert feature enhancer for assert function/object.
 *
 * https://github.com/power-assert-js/empower
 *
 * Copyright (c) 2013-2018 Takuto Wada
 * Licensed under the MIT license.
 *   https://github.com/power-assert-js/empower/blob/master/MIT-LICENSE.txt
 */
var empowerCore = require('empower-core');
var defaultOptions = require('./lib/default-options');
var capturable = require('./lib/capturable');
var assign = require('core-js/library/fn/object/assign');
var define = require('./lib/define-properties');

/**
 * Enhance Power Assert feature to assert function/object.
 * @param assert target assert function or object to enhance
 * @param formatter power assert format function
 * @param options enhancement options
 * @return enhanced assert function/object
 */
function empower (assert, formatter, options) {
    var config = assign(defaultOptions(), options);
    var eagerEvaluation = !(config.modifyMessageOnRethrow || config.saveContextOnRethrow);
    // see: https://github.com/power-assert-js/empower/pull/26
    var shouldRecreateAssertionError = (function isStackUnchanged () {
        if (typeof assert !== 'function') {
            return false;
        }
        if (typeof assert.AssertionError !== 'function') {
            return false;
        }
        var ae = new assert.AssertionError({
            actual: 123,
            expected: 456,
            operator: '==='
        });
        ae.message = '[REPLACED MESSAGE]';
        return !(/REPLACED MESSAGE/.test(ae.stack)) && /123 === 456/.test(ae.stack);
    })();

    var empowerCoreConfig = assign(config, {
        modifyMessageBeforeAssert: function (beforeAssertEvent) {
            var message = beforeAssertEvent.originalMessage;
            if (!eagerEvaluation) {
                return message;
            }
            return buildPowerAssertText(formatter, message, beforeAssertEvent.powerAssertContext);
        },
        onError: function onError (errorEvent) {
            var e = errorEvent.error;
            if (!/^AssertionError/.test(e.name)) {
                throw e;
            }
            if (!errorEvent.powerAssertContext) {
                throw e;
            }
            var poweredMessage;
            if (config.modifyMessageOnRethrow || config.saveContextOnRethrow) {
                poweredMessage = buildPowerAssertText(formatter, errorEvent.originalMessage, errorEvent.powerAssertContext);
                if (shouldRecreateAssertionError) {
                    e = new assert.AssertionError({
                        message: poweredMessage,
                        actual: e.actual,
                        expected: e.expected,
                        operator: e.operator,
                        stackStartFunction: e.stackStartFunction || onError
                    });
                    e.generatedMessage = false;
                }
            }
            if (config.modifyMessageOnRethrow && !shouldRecreateAssertionError) {
                e.message = poweredMessage;
                e.generatedMessage = false;
            }
            if (config.saveContextOnRethrow) {
                e.powerAssertContext = errorEvent.powerAssertContext;
            }
            throw e;
        }
    });
    var enhancedAssert = empowerCore(assert, empowerCoreConfig);
    define(enhancedAssert, capturable());
    return enhancedAssert;
}

function buildPowerAssertText (formatter, message, context) {
    // console.log(message);
    var powerAssertText = formatter(context);
    return message ? message + ' ' + powerAssertText : powerAssertText;
};

empower.defaultOptions = defaultOptions;
module.exports = empower;

1	/**
2	* empower - Power Assert feature enhancer for assert function/object.
3	*
4	* https://github.com/power-assert-js/empower
5	*
6	* Copyright (c) 2013-2018 Takuto Wada
7	* Licensed under the MIT license.
8	* https://github.com/power-assert-js/empower/blob/master/MIT-LICENSE.txt
9	*/
10	var empowerCore = require('empower-core');	3✔
11	var defaultOptions = require('./lib/default-options');	3✔
12	var capturable = require('./lib/capturable');	3✔
13	var assign = require('core-js/library/fn/object/assign');	3✔
14	var define = require('./lib/define-properties');	3✔
15
16	/**
17	* Enhance Power Assert feature to assert function/object.
18	* @param assert target assert function or object to enhance
19	* @param formatter power assert format function
20	* @param options enhancement options
21	* @return enhanced assert function/object
22	*/
23	function empower (assert, formatter, options) {	3✔
24	var config = assign(defaultOptions(), options);	201✔
25	var eagerEvaluation = !(config.modifyMessageOnRethrow \|\| config.saveContextOnRethrow);	201✔
26	// see: https://github.com/power-assert-js/empower/pull/26
27	var shouldRecreateAssertionError = (function isStackUnchanged () {	201✔
28	if (typeof assert !== 'function') {	201✔
29	return false;	108✔
30	}
31	if (typeof assert.AssertionError !== 'function') {	93✔
32	return false;	63✔
33	}
34	var ae = new assert.AssertionError({	30✔
35	actual: 123,
36	expected: 456,
37	operator: '==='
38	});
39	ae.message = '[REPLACED MESSAGE]';	30✔
40	return !(/REPLACED MESSAGE/.test(ae.stack)) && /123 === 456/.test(ae.stack);	30✔
41	})();
42
43	var empowerCoreConfig = assign(config, {	201✔
44	modifyMessageBeforeAssert: function (beforeAssertEvent) {
45	var message = beforeAssertEvent.originalMessage;	132✔
46	if (!eagerEvaluation) {	132✔
47	return message;	81✔
48	}
49	return buildPowerAssertText(formatter, message, beforeAssertEvent.powerAssertContext);	51✔
50	},
51	onError: function onError (errorEvent) {
52	var e = errorEvent.error;	234✔
53	if (!/^AssertionError/.test(e.name)) {	234✔
54	throw e;	×
55	}
56	if (!errorEvent.powerAssertContext) {	234✔
57	throw e;	102✔
58	}
59	var poweredMessage;	132✔
60	if (config.modifyMessageOnRethrow \|\| config.saveContextOnRethrow) {	132✔
61	poweredMessage = buildPowerAssertText(formatter, errorEvent.originalMessage, errorEvent.powerAssertContext);	81✔
62	if (shouldRecreateAssertionError) {	81✔
63	e = new assert.AssertionError({	×
64	message: poweredMessage,
65	actual: e.actual,
66	expected: e.expected,
67	operator: e.operator,
68	stackStartFunction: e.stackStartFunction \|\| onError
69	});
70	e.generatedMessage = false;	×
71	}
72	}
73	if (config.modifyMessageOnRethrow && !shouldRecreateAssertionError) {	132✔
74	e.message = poweredMessage;	54✔
75	e.generatedMessage = false;	54✔
76	}
77	if (config.saveContextOnRethrow) {	132✔
78	e.powerAssertContext = errorEvent.powerAssertContext;	54✔
79	}
80	throw e;	132✔
81	}
82	});
83	var enhancedAssert = empowerCore(assert, empowerCoreConfig);	201✔
84	define(enhancedAssert, capturable());	186✔
85	return enhancedAssert;	186✔
86	}
87
88	function buildPowerAssertText (formatter, message, context) {	3✔
89	// console.log(message);
90	var powerAssertText = formatter(context);	132✔
91	return message ? message + ' ' + powerAssertText : powerAssertText;	132✔
92	};
93
94	empower.defaultOptions = defaultOptions;	3✔
95	module.exports = empower;	3✔

power-assert-js / empower / 273

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous