Improve chai support (with detailed output, to match jest exceptions) by rpgeeganage · Pull Request #8454 · jestjs/jest

rpgeeganage · 2019-05-11T19:46:18Z

Summary

This PR is an initial attempt to solve #8152.

Test plan

Before the change Chai output was as follows.

 FAIL  ./chai.spec.js
  a chai test
    ✕ tests something (4ms)

  ● a chai test › tests something

    AssertionError: expected 'hello world' to equal 'hello sunshine'

      3 | describe('a chai test', () => {
      4 |   it('tests something', () => {
    > 5 |     chai.expect('hello world').to.equal('hello sunshine');
        |                                   ^
      6 |   });
      7 | });

      at Object.equal (chai.spec.js:5:35)

Test Suites: 1 failed, 1 total
Tests:       1 failed, 1 total
Snapshots:   0 total
Time:        1.361s
Ran all test suites matching /chai.spec.js/i.

With modification:

  FAIL  ./chai.spec.js
  a chai test
    ✕ tests something (8ms)

  ● a chai test › tests something

    assert.(received, expected)

    Expected value   "hello sunshine"
    Received:
      "hello world"

    Message:
      expected 'hello world' to equal 'hello sunshine'

    Difference:

    - Expected
    + Received

    - hello sunshine
    + hello world

      3 | describe('a chai test', () => {
      4 |   it('tests something', () => {
    > 5 |     chai.expect('hello world').to.equal('hello sunshine');
        |                                   ^
      6 |   });
      7 | });

      at Object.equal (chai.spec.js:5:35)

Test Suites: 1 failed, 1 total
Tests:       1 failed, 1 total
Snapshots:   0 total
Time:        1.534s
Ran all test suites matching /chai.spec.js/i.

rpgeeganage · 2019-05-11T20:18:04Z

@thymikee ,
I have added the tests.
Now still, CI is failing. The failure output is as follows.

$ yarn jest-coverage --color -i --config jest.config.ci.js && yarn test-leak && node scripts/mapCoverage.js && codecov
$ yarn jest --coverage --color -i --config jest.config.ci.js
$ node ./packages/jest-cli/bin/jest.js --coverage --color -i --config jest.config.ci.js
........(node:291) MaxListenersExceededWarning: Possible EventEmitter memory leak detected. 11 exit listeners added. Use emitter.setMaxListeners() to increase limit
.................................................Too long with no output (exceeded 10m0s)

I can't figure out why.
Can you please give me a hint regarding this ?

jeysal · 2019-05-12T17:09:05Z

@rpgeeganage Hmm, I don't see anything suspicious in the diff that might cause tests to stall. Weird that circus passes, must be the change to jasmine2 I guess?
@thymikee seems to be short on time atm, maybe @SimenB has an idea?
Your e2e test passes locally for me as well...

jeysal · 2019-05-12T17:10:33Z

Maybe it broke some other test that waits for a certain output and for some reason doesn't timeout normally? @rpgeeganage have you tried running all tests (yarn jest) locally with your changes? (Will take a looooong time unless you're on Linux)

rpgeeganage · 2019-05-12T20:20:30Z

@jeysal
Thanks a lot. I'll dig deep.

SimenB · 2019-05-12T20:27:18Z

Looks like some sort of hanging test, yes. Not sure why it doesn't time out, probably a bug.

Running yarn jest locally is a good idea :)

rpgeeganage · 2019-05-12T20:30:29Z

@SimenB , @jeysal
I tried and I think I located the error. It's in https://github.com/facebook/jest/blob/master/e2e/failures/__tests__/duringTests.test.js#L18
I think it is because of a bug in my modification. I'm looking into it now.
Thanks a lot.

codecov-io · 2019-05-12T21:17:35Z

Codecov Report

Merging #8454 into master will decrease coverage by 0.06%.
The diff coverage is 0%.

@@            Coverage Diff             @@
##           master    #8454      +/-   ##
==========================================
- Coverage   62.32%   62.26%   -0.07%     
==========================================
  Files         266      266              
  Lines       10735    10746      +11     
  Branches     2614     2624      +10     
==========================================
  Hits         6691     6691              
- Misses       3460     3471      +11     
  Partials      584      584

Impacted Files	Coverage Δ
...ackages/jest-jasmine2/src/assertionErrorMessage.ts	`0% <0%> (ø)`	⬆️
packages/jest-jasmine2/src/jasmine/Spec.ts	`0% <0%> (ø)`	⬆️
packages/jest-circus/src/formatNodeAssertErrors.ts	`12.96% <0%> (-1.33%)`	⬇️
packages/jest-jasmine2/src/jasmine/Env.ts	`0% <0%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 15e2cc6...de3815f. Read the comment docs.

rpgeeganage · 2019-05-16T22:58:03Z

@jeysal ,
I have fixed the comments. Please review the new change.
Thanks a lot.

jeysal

Really nice work @rpgeeganage ❤️
Hope the change to chai also goes through for an even better integration 😎

rpgeeganage · 2019-05-17T16:44:06Z

@jeysal ,
Thanks a lot and I'm honored to contribute to this project.
I'm planning to dive into possible chai modification during the weekend.

lucasfcosta · 2019-06-23T14:24:31Z

Hello everyone, I've just seen the related issue in Chai's repo, I'll do my best to get it merged there this week. I think the code is pretty much g2g.

lucasfcosta · 2019-06-25T20:19:35Z

Just FYI, we've just merged @rpgeeganage's amazing work in chaijs/chai#1257 and we'll try to separate some time for a release with that change this weekend.

github-actions · 2021-05-11T18:12:54Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

rpgeeganage added 3 commits May 11, 2019 21:41

added fix to improve chai output

3c3a721

fix linting issue

c4ba682

update the change log

bfd6e62

rpgeeganage mentioned this pull request May 11, 2019

Improve chai support (with detailed output, to match jest exceptions) #8444

Closed

fix changelog lint

f9ddff7

facebook-github-bot added the cla signed label May 11, 2019

added extra check to see error is not undefined

5772bd3

SimenB requested changes May 12, 2019

View reviewed changes

Comment thread packages/jest-circus/src/formatNodeAssertErrors.ts Outdated

Comment thread packages/jest-circus/src/formatNodeAssertErrors.ts

fixed the comments

db0eead

fix tsc issue

243ba85

SimenB approved these changes May 12, 2019

View reviewed changes

jeysal reviewed May 15, 2019

View reviewed changes

Comment thread e2e/__tests__/__snapshots__/chaiAssertionLibrary.ts.snap Outdated

Comment thread e2e/chai-assertion-library-errors/__tests__/chai_assertion.js Outdated

fix the incorrect test case

e568d07

rpgeeganage mentioned this pull request May 15, 2019

Chai Assertion error doesn't have 'operator' attribute chaijs/chai#1252

Closed

rpgeeganage added 5 commits May 16, 2019 23:24

remove assert.(a,b) message if operator not set

0764ed4

remove assert.(a,b) message if operator not set

821a795

fix assert message

69d3778

fix linting

173e9c6

removed unwanted empty string in final message

de3815f

jeysal approved these changes May 17, 2019

View reviewed changes

jeysal merged commit 6d31fb1 into jestjs:master May 17, 2019

rpgeeganage deleted the improve_chai_assertion_messages_display branch May 17, 2019 16:45

SimenB mentioned this pull request Jun 24, 2019

Improve chai support (with detailed output, to match jest exceptions) #8152

Closed

snyk-bot mentioned this pull request Sep 2, 2019

[Snyk] Upgrade jest from 24.8.0 to 24.9.0 iliutastoica/30-seconds-of-angular#3

Open

snyk-bot mentioned this pull request Dec 15, 2019

[Snyk] Upgrade babel-jest from 24.0.0 to 24.9.0 jakeherp/burger-builder#14

Open

This was referenced Dec 31, 2019

Update jest to the latest version Leko/hothouse#515

Open

Update babel-jest to the latest version Leko/hothouse#529

Open

This was referenced Jan 7, 2020

Update jest to the latest version Leko/hothouse#542

Open

Update babel-jest to the latest version Leko/hothouse#552

Open

Update jest to the latest version Leko/hothouse#560

Open

Update babel-jest to the latest version Leko/hothouse#579

Open

This was referenced Jan 21, 2020

Update jest to the latest version Leko/hothouse#596

Open

Update babel-jest to the latest version Leko/hothouse#606

Open

snyk-bot mentioned this pull request Mar 21, 2020

[Snyk] Upgrade: jest, jest-cli lwojcik/sc2pte-panel-frontend#88

Closed

snyk-bot mentioned this pull request Apr 30, 2020

[Snyk] Upgrade: jest, jest-cli lwojcik/sc2pte-panel-frontend#118

Closed

github-actions Bot locked as resolved and limited conversation to collaborators May 11, 2021

Uh oh!

Conversation

rpgeeganage commented May 11, 2019

Summary

Test plan

Uh oh!

rpgeeganage commented May 11, 2019

Uh oh!

jeysal commented May 12, 2019

Uh oh!

jeysal commented May 12, 2019

Uh oh!

rpgeeganage commented May 12, 2019

Uh oh!

SimenB commented May 12, 2019

Uh oh!

rpgeeganage commented May 12, 2019

Uh oh!

Uh oh!

Uh oh!

codecov-io commented May 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

rpgeeganage commented May 16, 2019

Uh oh!

jeysal left a comment

Choose a reason for hiding this comment

Uh oh!

rpgeeganage commented May 17, 2019

Uh oh!

lucasfcosta commented Jun 23, 2019

Uh oh!

lucasfcosta commented Jun 25, 2019

Uh oh!

github-actions Bot commented May 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov-io commented May 12, 2019 •

edited

Loading