How to make my tests pending in Jest?

Question

I want to make some of my jest tests pending. How can I do it? API reference doesn't have any method how can I make my test pending.

score 28 · Answer 1 · answered Feb 25 '19 at 15:55

28

You can also just say test.todo('Some test I still need to do')

The test runner will then have show a count of tests in a todo state:

Tests: 1 todo, 2 passed, 3 total

answered Feb 25 '19 at 15:55

Herald Smit

1

Note this is only available in Jest 24+ – Matt Sanders May 10 '19 at 20:32
1

Now with jest v24 this should be the accepted answer. Marking a test as skipped is not quite the same as stating it is pending. – Ernesto Aug 19 '19 at 16:03

josemigallas · Answer 2 · 2021-04-21T11:07:04.007

15

UPDATED

Since jest@24.0.0 it's now possible to use:

it.todo(...)
test.todo(...)

Which will look like:

Tests:       1 todo, 23 passed, 24 total

OLD ANSWER

Setting tests as Pending per se is not featured in Jest.

However it allows to skip tests by using

it.skip(...)
test.skip(...)

And then they are marked not as passed but skipped:

Tests:       1 skipped, 23 passed, 24 total

Which for me is a very good equivalent to "pending".

edited Apr 21 '21 at 11:07

answered Jul 07 '18 at 14:37

josemigallas

NOTE: `it.todo` and `test.todo` will still run `beforeAll` callbacks, even if the test file doesn't contain any active tests. https://github.com/facebook/jest/issues/11006 – Joshua Pinter May 25 '21 at 17:44

score 10 · Answer 3 · answered Aug 24 '15 at 13:50

10

You're looking for xit and xdescribe

answered Aug 24 '15 at 13:50

Rodrigo Siqueira

`xit` and `xdescribe` just make tests passing. Can I show them as pending? – asiniy Aug 24 '15 at 17:58
1

@asiniy I believe not as [pending](http://jasmine.github.io/2.0/introduction.html#section-Pending_Specs) is only available after jasmine 2.0, and jest uses 1.3 – Rodrigo Siqueira Aug 24 '15 at 18:29

score 5 · Answer 4 · answered Feb 09 '17 at 22:42

5

Instead of saying test(...), just say xtest(...) and the test will be skipped.

answered Feb 09 '17 at 22:42

nbkhope

Is there a way to add reason which will show up in report? Like in Jasmine: xit().pend('Reason') – Gennadiii Dec 29 '17 at 13:53
This won't make the test pending but it simply will make it pass. – josemigallas Nov 20 '18 at 08:35
1

Actually, it won't make the test pass, it will skip the test entirely. It will be not pending, not failed and not even passed. – kekko12 May 07 '20 at 15:51
I thought that was specific to mocha...? – Hyfy Mar 25 '21 at 17:42

Zenchi · Answer 5 · 2018-03-28T10:51:09.887

1

Looks like in the latest version of jest xit and xdescribe will show up as skipped for the default reporter.

If you really need to display pending specs you will need to create a custom reporter.

Here is the link to the jest documentation for setting a custom handler.

edited Mar 28 '18 at 10:51

answered Mar 27 '18 at 04:15

Zenchi

Links to external resources are encouraged, but please add context around the link so your fellow users will have some idea what it is and why it’s there. Always quote the most relevant part of an important link, in case the target site is unreachable or goes permanently offline. – baduker Mar 27 '18 at 04:36

5 Answers5