Less API using power-assert #46

uiur · 2015-09-09T07:29:16Z

I just want to share my demo, so feel free to close this PR. Just ignore it if you don't like it.

Added t.ok(value, [message]) using power-assert. It shows descriptive assertion message by parsing the JS expression.

example

test((t) => {
  var a = { name: 'foo' }

  t.ok(a.name === 'bar')

  t.end()
})

shows a message like this.

> ava

  ✖ [anonymous]   # test.js:26
  t.ok(a.name === 'bar')
       | |    |         
       | |    false     
       | "foo"          
       Object{name:"foo"}

  --- [string] 'bar'
  +++ [string] a.name
  @@ -1,3 +1,3 @@
  -bar

apis

t.true(true)
t.is('foo', 'foo');
t.not('foo', 'bar');
t.same({a: 'a'}, {a: 'a'});
t.regexTest(/^abc$/, 'abc');

with power-assert:

var deepEqual = require('deep-equal');

t.ok(true);
t.ok('foo' === 'foo');
t.ok('foo' !== 'bar');
t.ok(deepEqual({a: 'a'}, {a: 'a'}));
t.ok(/^abc$/.test('ab'));

more example

  ✖ [anonymous]   # test.js:44

  t.ok(deepEqual(a, b))
       |         |  |  
       |         |  ["a","a"]
       false     ["a","b"]

  ✖ [anonymous]   # test.js:50

  t.ok(/^abc$/.test(`ab${ s }`))
               |    |     |     
               |    "aba" "a"   
               false

I know custom assertion is supported on ava and it worked pretty well.
But I wanted to use t.plan() and that assertion function with ava's minimal interface.

Qix- · 2015-09-09T17:33:59Z

It'd be nice if this translated into some way to hook into Ava to allow it to use any arbitrary assertion library, including support for t.plan().

Side note, power-assert looks badass.

Qix- · 2015-09-09T23:54:04Z

@uiureo why did you close? :o

uiur · 2015-09-10T00:06:40Z

Because I don't intend this PR to be merged. I don't want the opened state to bother you guys.

It'd be nice if this translated into some way to hook into Ava to allow it to use any arbitrary assertion library, including support for t.plan().

That's the very thing I want.
I'm looking into the code and I would try if I come up with some way.

Related: #25

Qix- · 2015-09-10T00:09:32Z

👍 sounds good

sindresorhus · 2015-09-10T07:56:40Z

I'd like to keep this open for a while so people can see it. I think power-assert is really cool and I actually considered including it in AVA early on. The reasons I didn't were the compile step (which is not a problem now that we include Babel by default) and the result, while being very informative, is a bit noisy. foo === bar is a lot clearer and faster to grasp. Is there any way to simplify the output?

uiur · 2015-09-10T09:51:57Z

the result, while being very informative, is a bit noisy. foo === bar is a lot clearer and faster to grasp. Is there any way to simplify the output?

I agree its output is a little bit noisy. It seems you can write custom output formatter in power-assert.

https://github.com/power-assert-js/power-assert#optionsoutput
https://github.com/power-assert-js/power-assert-formatter

FYI @twada

twada · 2015-09-10T10:21:55Z

Hi, I'm creator of power-assert.
Thank you for mentioning me @uiureo.
I'm very interested in AVA now.

power-assert output consists of 4 parts, rendered by 4 renderers (file, assertion, diagram, and binary-expression).
And you can omit each part from output through customization API.

For example, output below

  # test.js:26
  t.ok(a.name === 'bar')
       | |    |         
       | |    false     
       | "foo"          
       Object{name:"foo"}
  --- [string] 'bar'
  +++ [string] a.name
  @@ -1,3 +1,3 @@
  -bar

file renderer produces,

   # test.js:26

assertion renderer produces,

  t.ok(a.name === 'bar')

diagram renderer produces,

       | |    |         
       | |    false     
       | "foo"          
       Object{name:"foo"}

and binary-expression renderer produces

  --- [string] 'bar'
  +++ [string] a.name
  @@ -1,3 +1,3 @@
  -bar

To disable verbose graph, remove diagram renderer from output.renderers by using customize method. For example, this configuration

var assert = require('power-assert').customize({
    output: {
        renderers: [
            './built-in/file',
            './built-in/assertion',
            './built-in/binary-expression'
        ]
    }
});

produces output as below.

  # test.js:26
  t.ok(a.name === 'bar')

  --- [string] 'bar'
  +++ [string] a.name
  @@ -1,3 +1,3 @@
  -bar

And of course, I want to hear your request, and create custom formatter for AVA!

FYI:
You can also create and add custom Renderer Class to configuration options.

Qix- · 2015-09-10T18:03:30Z

To be honest, the binary renderer is the part that seems noisy to me. The diagram is what makes it super useful.

Thanks for the information @twada :D Very tempting to switch from should. I'll play with it a bit more.

sindresorhus · 2015-09-10T18:28:57Z

Instead of:

  # test.js:26
  t.ok(a.name === 'bar')
       | |    |         
       | |    false     
       | "foo"          
       Object{name:"foo"}
  --- [string] 'bar'
  +++ [string] a.name
  @@ -1,3 +1,3 @@
  -bar

I think I would want something like:

  # test.js:26
  a.name === 'bar'
     |
     |
   "foo"

twada · 2015-09-11T05:57:46Z

Hi @Qix-

To be honest, the binary renderer is the part that seems noisy to me. The diagram is what makes it super useful.

Understood. You can disable binary-expression renderer by removing './built-in/binary-expression' from output.renderers

var assert = require('power-assert').customize({
    output: {
        renderers: [
            './built-in/file',
            './built-in/assertion',
            './built-in/diagram'
        ]
    }
});

You'll see output like

  # test.js:26
  t.ok(a.name === 'bar')
       | |    |         
       | |    false     
       | "foo"          
       Object{name:"foo"}

Very tempting to switch from should. I'll play with it a bit more.

I'm glad to hear that! 😄

twada · 2015-09-11T05:59:37Z

Hi @sindresorhus, thank you for your request.
I'll create succinct output renderer for AVA!

sindresorhus · 2015-10-11T16:47:53Z

@twada Any updates? Would really like to use power-assert to improve AVAs assert output.

twada · 2015-10-11T17:16:18Z

@sindresorhus I've extracted power-assert-renderers module out and now creating less-noisy succinct-diagram renderer for AVA.

I would like you to see succinct-diagram-test.js.
(You'll see assert or t.ok calls are still remaining in output, but it's a bit difficult to remove for now)

If you like it, I'm going to integrate it into this pull-req and also power-assert master.

sindresorhus · 2015-10-20T08:04:09Z

@twada Yes, looks very good :) I'm fine with this for now. Would be awesome if you would integrate it into this PR and fix the merge conflict.

kevva · 2015-10-20T09:11:24Z

Really exciting stuff.

uiur · 2015-10-20T10:54:58Z

I did quick hack to use the succinct renderer and fixed the merge conflict.

Now the output looks like this:

❯ npm test    

> ava

  ✖ [anonymous]   
  t.ok(a.name === 'bar')
         |              
         "foo"          


  1 test failed

  1. [anonymous]
  AssertionError:   
  t.ok(a.name === 'bar')
         |              
         "foo"          
    at decoratedAssert (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/power-assert/node_modules/empower/lib/decorate.js:42:30)
    at Function.powerAssert (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/power-assert/node_modules/empower/index.js:58:32)
    at Test.ok (/Users/zat/.ghq/github.com/sindresorhus/ava/lib/test.js:85:15)
    at Test.fn (/Users/zat/.ghq/github.com/uiureo/ava-power-assert-example/test.js:26:5)
    at Test.<anonymous> (/Users/zat/.ghq/github.com/sindresorhus/ava/lib/test.js:124:19)
    at tryCatcher (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/bluebird/js/main/util.js:26:23)
    at Promise._resolveFromResolver (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/bluebird/js/main/promise.js:480:31)
    at new Promise (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/bluebird/js/main/promise.js:70:37)
    at Test.run (/Users/zat/.ghq/github.com/sindresorhus/ava/lib/test.js:110:9)
    at tryCatcher (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/bluebird/js/main/util.js:26:23)
    at ReductionPromiseArray._promiseFulfilled (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/bluebird/js/main/reduce.js:105:38)
    at ReductionPromiseArray.init [as _init$] (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/bluebird/js/main/promise_array.js:92:18)
    at ReductionPromiseArray.init (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/bluebird/js/main/reduce.js:42:10)
    at Async._drainQueue (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/bluebird/js/main/async.js:128:12)
    at Async._drainQueues (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/bluebird/js/main/async.js:133:10)
    at Async.drainQueues (/Users/zat/.ghq/github.com/sindresorhus/ava/node_modules/bluebird/js/main/async.js:15:14)

npm ERR! Test failed.  See above for more details.

sindresorhus · 2015-10-20T11:00:38Z

lib/babel.js

@@ -15,7 +17,15 @@ try {

 	require(localBabel)(options);
 } catch (err) {
-	require('babel-core/register')(options);
+	require('babel-core/register')(assign({}, options, {


The options here need to be put in a variable and used in line 18 too.

twada · 2015-10-20T11:01:05Z

@uiureo Thanks for responding so quickly, nice to see this being merged!

sindresorhus · 2015-10-20T11:02:06Z

lib/test.js

@@ -70,6 +78,19 @@ Object.keys(assert).forEach(function (el) {
 	};
 });

+Test.prototype.ok = function () {


This should probably be in the assert.js file.

sindresorhus · 2015-10-20T11:04:31Z

@twada Can you review?

twada · 2015-10-20T17:03:43Z

@sindresorhus modifyMessageOnRethrow option indicates whether to modify AssertionError message on (re)throwing AssersionError or not.

Should we enable it?

You are right. Should be true in this case.

(power-assert overwrites empower's default for ease of use)

uiur · 2015-10-21T01:41:10Z

I've tried to add patterns like this:

    plugins: [
        createEspowerPlugin(require('babel-core'), {
            patterns: [
                't.ok(value, [message])',
                't.notOk(value, [message])',
                't.true(value, [message])',
                't.false(value, [message])',
                't.is(value, expected, [message])',
                't.not(value, expected, [message])',
                't.same(value, expected, [message])',
                't.notSame(value, expected, [message])',
                't.regexTest(regex, contents, [message])'
            ]
        })
    ]

test((t) => {
  var a = 'foo'
  t.is(a, 'bar')
  t.end()
})

But I got weird output like this.

  ✖ [anonymous] { powerAssertContext: { value: 'foo', events: [ [Object] ] },
  source: { content: 't.is(a, \'bar\')', filepath: 'test.js', line === 'bar'

t.ok() works correctly.

twada · 2015-10-21T03:29:10Z

@uiureo Thank you for reporting.
In this case, intrumentation patterns in lib/babel.js should be the same.
So please configure lib/babel.js and try again.

function enhanceAssert(assert) {
    empower(assert,
        powerAssertFormatter({
            renderers: [
                powerAssertRenderers.AssertionRenderer,
                powerAssertRenderers.SuccinctRenderer
            ]
        }),
        {
            destructive: true,
            modifyMessageOnRethrow: true,
            saveContextOnRethrow: false,
            patterns: [
                't.ok(value, [message])',
                't.notOk(value, [message])',
                't.true(value, [message])',
                't.false(value, [message])',
                't.is(value, expected, [message])',
                't.not(value, expected, [message])',
                't.same(value, expected, [message])',
                't.notSame(value, expected, [message])',
                't.regexTest(regex, contents, [message])'
            ]
        }
    );
}

uiur · 2015-10-21T03:46:49Z

@twada
Ah, I missed the point.
It works right. Thanks for help.

sindresorhus · 2015-10-23T18:03:59Z

test/test.js

+
+	execCli('fixture/power-assert.js', function (err, stdout, stderr) {
+		t.ok(err);
+		t.true(stderr.indexOf('t.ok(a === \'bar\')\n') !== -1);


How is this testing that it's working? It's only the normals output.

And should be:

t.not(stderr.indexOf('t.ok(a === \'bar\')'), -1);

Without power-assert, the output should be false == true because this assert is t.ok().
I thought probably it renders t.ok(a === 'bar') only when power-assert works.

test(t => { const a = 'foo'; t.ok(a === 'bar'); t.end(); });

Should I test this renders the diagram output somehow?

t.ok(a === 'bar') | "foo"

I've added a test that it renders diagram output by regexp.
Let me know if you want some changes.

uiur · 2015-10-24T02:24:33Z

@sindresorhus I've done some tweaks. Can you review again?

sindresorhus · 2015-10-24T08:22:41Z

Landed. Woop woop. Great work @uiureo. And thanks for reviewing @twada :)

uiur · 2015-10-24T08:32:25Z

Thanks a lot @sindresorhus @twada. I couldn't do this without your great help :)

twada · 2015-10-24T12:14:51Z

@sindresorhus Wow I'm very glad to see this pull-req is getting merged!! 🎉
Thank you so much @uiureo for your great work!

uiur closed this Sep 9, 2015

sindresorhus reopened this Sep 10, 2015

This was referenced Sep 18, 2015

And/or checking? kevva/claim#9

Closed

instanceOf() kevva/claim#8

Closed

azu mentioned this pull request Sep 24, 2015

POC: tape + power-assert = ??? azu/tape-power-assert#1

Open

sindresorhus reviewed Oct 20, 2015
View reviewed changes

twada mentioned this pull request Oct 21, 2015

_expr and _capt should not be enumerable power-assert-js/empower#15

Closed

sindresorhus reviewed Oct 23, 2015
View reviewed changes

uiur added 9 commits October 24, 2015 09:54

Add power-assert to enhance test output

27f08ed

Add enhanced output for t.assert()

0780d2d

Update power-assert-renderers

96beedc

Remove unneccessary expressions

96e81be

Add comment for workaround

603ef01

Add patterns for power-assert

dfb0c45

Add test for power-assert output

8087faa

Update empower

d7cf4bd

Fix wrong indent

8673535

uiur force-pushed the power-assert branch from 8f37839 to 8673535 Compare October 24, 2015 00:55

uiur added 4 commits October 24, 2015 10:27

Move enhanceAssert() into ./lib/enhance-assert.js

8f8f1fb

Remove a unnecessary line

5a637c2

Use t.not()

bd3a06e

Test that it renders a diagram output

b8fc55d

sindresorhus closed this in c96622d Oct 24, 2015

This was referenced Oct 24, 2015

Objects are difficult to differentiate. power-assert-js/power-assert-formatter#18

Closed

Objects are difficult to differentiate. twada/power-assert-renderers#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Less API using power-assert #46

Less API using power-assert #46

uiur commented Sep 9, 2015

Qix- commented Sep 9, 2015

Qix- commented Sep 9, 2015

uiur commented Sep 10, 2015

Qix- commented Sep 10, 2015

sindresorhus commented Sep 10, 2015

uiur commented Sep 10, 2015

twada commented Sep 10, 2015

Qix- commented Sep 10, 2015

sindresorhus commented Sep 10, 2015

twada commented Sep 11, 2015

twada commented Sep 11, 2015

sindresorhus commented Oct 11, 2015

twada commented Oct 11, 2015

sindresorhus commented Oct 20, 2015

kevva commented Oct 20, 2015

uiur commented Oct 20, 2015

sindresorhus Oct 20, 2015

twada commented Oct 20, 2015

sindresorhus Oct 20, 2015

sindresorhus commented Oct 20, 2015

twada commented Oct 20, 2015

uiur commented Oct 21, 2015

twada commented Oct 21, 2015

uiur commented Oct 21, 2015

sindresorhus Oct 23, 2015

uiur Oct 24, 2015

uiur Oct 24, 2015

uiur commented Oct 24, 2015

sindresorhus commented Oct 24, 2015

uiur commented Oct 24, 2015

twada commented Oct 24, 2015

Less API using power-assert #46

Less API using power-assert #46

Conversation

uiur commented Sep 9, 2015

example

apis

more example

Qix- commented Sep 9, 2015

Qix- commented Sep 9, 2015

uiur commented Sep 10, 2015

Qix- commented Sep 10, 2015

sindresorhus commented Sep 10, 2015

uiur commented Sep 10, 2015

twada commented Sep 10, 2015

Qix- commented Sep 10, 2015

sindresorhus commented Sep 10, 2015

twada commented Sep 11, 2015

twada commented Sep 11, 2015

sindresorhus commented Oct 11, 2015

twada commented Oct 11, 2015

sindresorhus commented Oct 20, 2015

kevva commented Oct 20, 2015

uiur commented Oct 20, 2015

sindresorhus Oct 20, 2015

Choose a reason for hiding this comment

twada commented Oct 20, 2015

sindresorhus Oct 20, 2015

Choose a reason for hiding this comment

sindresorhus commented Oct 20, 2015

twada commented Oct 20, 2015

uiur commented Oct 21, 2015

twada commented Oct 21, 2015

uiur commented Oct 21, 2015

sindresorhus Oct 23, 2015

Choose a reason for hiding this comment

uiur Oct 24, 2015

Choose a reason for hiding this comment

uiur Oct 24, 2015

Choose a reason for hiding this comment

uiur commented Oct 24, 2015

sindresorhus commented Oct 24, 2015

uiur commented Oct 24, 2015

twada commented Oct 24, 2015