ChatGPT解决这个技术问题 Extra ChatGPT

How do I run a single test using Jest?

I have a test 'works with nested children' within the file fix-order-test.js.

Running the below runs all the tests in the file.

jest fix-order-test

How do I run only a single test? The below does not work as it searches for a file of the regex specified.

jest 'works with nested children'
since your using jest command line, probably through npm then just add the --testNamePattern 'works with nested children' Jest CLI Options #testNamePattern
@BioGenX: link is now broken

R
Rahul Bhobe

From the command line, use the --testNamePattern or -t flag:

jest -t 'fix-order-test'

This will only run tests that match the test name pattern you provide. It's in the Jest documentation.

Another way is to run tests in watch mode, jest --watch, and then press P to filter the tests by typing the test file name or T to run a single test name.

If you have an it inside of a describe block, you have to run

jest -t '<describeString> <itString>'

I am getting unrecognized options for -t. Yes, the documentation does mention it. The flag has been added in 16.0. I am on the latest version. jest -help does not seem to mention the flag. Thanks.
Just a note that this is the test pattern for the specific test name inside it() function and not the file name. Which is what I thought.
If using npm test, you need to do npm test -- -t "fix order test"
This works for me but it also skips every single other test in the project which is slow for large projects. Specifying a specific test file that the test is in really helps: ./node_modules/.bin/jest --config=./.jest.config.json ./src/x/y/sites.js/sitesWorker.test.js -t 'given only incorrect sites'
Not sure if this was the case back then but, now, if you drop the -t it'll run only the tests you care about without skipping all the rest.
p
peterjmag

Jest documentation recommends the following:

If a test is failing, one of the first things to check should be whether the test is failing when it's the only test that runs. In Jest it's simple to run only one test - just temporarily change that test command to a test.only

test.only('this will be the only test that runs', () => {
   expect(true).toBe(false);
});

or

it.only('this will be the only test that runs', () => {
   expect(true).toBe(false);
});

Works for me with jest 20.0.4. Although it only skips the rest of the tests in that file. Tests in other files continue to run, unless you've already restricted the run to the one file.
That's a jest thing though - because it runs the tests asynchronously it probably can't determine which test to run in which file from the beginning. So it will run all files per default and WITHIN the files check for test.only. So if you only want to run one test within a file that has many test cases within a suite of testcases that consists of many files you have to unfortunately run that single file jest myTestFile.test.js
@johnslay: It does, just tested it
@johnslay well, thanks for reading the previous comments before writing your response I guess /s :)
lovely soultion
M
Michael Freidgeim

Full command to run a single Jest test

Command:

node <path-to-jest> -i <you-test-file> -c <jest-config> -t "<test-block-name>"

: Windows: node_modules\jest\bin\jest.js Others: node_modules/.bin/jest

Windows: node_modules\jest\bin\jest.js

Others: node_modules/.bin/jest

-i : path to the file with tests (js or ts)

-c : path to a separate Jest config file (JSON), if you keep your Jest configuration in package.json, you don't have to specify this parameter (Jest will find it without your help)

-t : actually it's a name (the first parameter) of describe(...), it(...), or test(...) block.

Example:

describe("math tests", () => {

  it("1 + 1 = 2", () => {
    expect(1 + 1).toBe(2);
  });

  it("-1 * -1 !== -1", () => {
    expect(-1 * -1).not.toBe(-1);
  });

});

So, the command

node node_modules/jest/bin/jest.js -i test/math-tests.js -c test/tests-config.json -t "1 + 1 = 2"

will test it("1 + 1 = 2", ...), but if you change the -t parameter to "math tests" then it will run both tests from the describe("math tests",...) block.

Remarks:

For Windows, replace node_modules/.bin/jest with node_modules\jest\bin\jest.js. This approach allows you to debug the running script. To enable debugging add '--inspect-brk' parameter to the command.

Running a single Jest test via NPM scripts in 'package.json'

Having Jest installed, you can simplify the syntax of this command (above) by using NPM scripts. In "package.json" add a new script to the "scripts" section:

"scripts": {
  "test:math": "jest -i test/my-tests.js -t \"math tests\"",
}

In this case, we use an alias 'jest' instead of writing the full path to it. Also, we don't specify the configuration file path since we can place it in "package.json" as well and Jest will look into it by default. Now you can run the command:

npm run test:math

And the "math tests" block with two tests will be executed. Or, of course, you can specify one particular test by its name.

Another option would be to pull the <the-name-of-test-block> parameter outside the "test:math" script and pass it from the NPM command:

package.json:

"scripts": {
  "test:math": "jest -i test/my-tests.js -t",
}

Command:

npm run test:math "math tests"

Now you can manage the name of the run test(s) with a much shorter command.

Remarks:

The 'jest' command will work with NPM scripts because

npm makes "./node_modules/.bin" the first entry in the PATH environment variable when running any lifecycle scripts, so this will work fine, even if your program is not globally installed (NPM blog) 2. This approach doesn't seem to allow debugging because Jest is run via its binary/CLI, not via node.

Running a selected Jest test in Visual Studio Code

If you are using Visual Studio Code you can take advantage of it and run the currently selected test (in the code editor) by pressing the F5 button. To do this, we will need to create a new launch configuration block in the ".vscode/launch.json" file. In that configuration, we will use predefined variables which are substituted with the appropriate (unfortunately not always) values when running. Of all available we are only interested in these:

${relativeFile} - the current opened file relative to ${workspaceFolder}

${selectedText} - the current selected text in the active file

But before writing out the launch configuration we should add the 'test' script in our 'package.json' (if we haven't done it yet).

File package.json:

"scripts": {
  "test": "jest"
}

Then we can use it in our launch configuration.

Launch configuration:

{
  "type": "node",
  "request": "launch",
  "name": "Run selected Jest test",
  "runtimeExecutable": "npm",
  "runtimeArgs": [
    "run-script",
    "test"
  ],
  "args": [
    "--",
    "-i",
    "${relativeFile}",
    "-t",
    "${selectedText}"
  ],
  "console": "integratedTerminal",
}

It actually does the same as the commands described earlier in this answer. Now that everything is ready, we can run any test we want without having to rewrite the command parameters manually.

Here's all you need to do:

Select currently created launch config in the debug panel: Open the file with tests in the code editor and select the name of the test you want to test (without quotation marks): Press F5 button.

And voilà!

Now to run any test you want. Just open it in the editor, select its name, and press F5.

Unfortunately, it won't be "voilà" on a Windows machines because they substitute (who knows why) the ${relativeFile} variable with the path having reversed slashes and Jest wouldn't understand such a path. (In case if the command needs troubleshooting, see similar approach in https://www.basefactor.com/using-visual-studio-code-to-debug-jest-based-unit-tests)

Remarks:

To run under the debugger, don't forget to add the '--inspect-brk' parameter. In this configuration example, we don't have the Jest configuration parameter assuming that it's included in 'package.json'.


Excellent! This should be the accepted answer. Especially if it adds a mention of npx to greatly simplify calling Jest, regardless of the OS.
Amazingly well explained answer. Probably jest documentation also doesn't have this good explanation :P
To be cross platform, use ${fileBasename} instead of ${relativeFile} in your launch configuration, because jest can't resolve path with backslash '\' (windows)
Can this solution be made to work in Windows now that the Nov 2020 Update to VSCode has added the following new launch.json variables: ${fileWorkspaceFolder} - Resolves to the workspace folder path of the file open in the active VS Code editor. ${fileDirnameBasename} - Resolves to name of the folder that the file open in the active VS Code editor is in. ${pathSeparator} - Resolves to the character used by the operating system to separate components in file paths.
For those using Windows, you can add a "--runTestsByPath" parameter to tell Jest to treat the "${relativeFile}" parameter as a plain path and not a RegEx so that the backslashes are parsed correctly.
S
Salim

As mentioned in other answers, test.only merely filters out other tests in the same file. So tests in other files would still run.

So to run a single test, there are two approaches:

Option 1: If your test name is unique, you can enter t while in watch mode and enter the name of the test you'd like to run.

Option 2: Hit p while in watch mode to enter a regex for the filename you'd like to run. (Relevant commands like this are displayed when you run Jest in watch mode). Change it to it.only on the test you'd like to run.

Hit p while in watch mode to enter a regex for the filename you'd like to run. (Relevant commands like this are displayed when you run Jest in watch mode).

Change it to it.only on the test you'd like to run.

With either of the approaches above, Jest will only run the single test in the file you've specified.


M
Mugur 'Bud' Chirica

If you have jest running as a script command, something like npm test, you need to use the following command to make it work:

npm test -- -t "fix order test"

If you have many test files, you should specify the name of the file too. e.g. npm test -- testFile.js -t "fix order test". Otherwise it will go through all of the test files to find matches, which takes a lot longer.
N
Nima Soroush

You can also use f or x to focus or exclude a test. For example

fit('only this test will run', () => {
   expect(true).toBe(false);
});

it('this test will not run', () => {
   expect(true).toBe(false);
});

xit('this test will be ignored', () => {
   expect(true).toBe(false);
});

xit did work for me, but fit does not. i am using jest@22.4.4.
I think that the main downside of this approach is that - if you're just trying to drill down on one test to fix a bug - it entails unnecessary changes to the underlying test files. If, for whatever reason, you want to maintain the test code (across commits, say) then this might make sense.
Also fit does not work for the same reason that it.only does not work. It only prevents other tests in the same file from running. Other files still run.
it.only And it.skip are more readable and less likely that you accidentally commit your temporary changes to source control
B
Bablu Ahmed

You can try using the following command cause it's working for me

npm run test -- -t 'Your test name'

Or the other way you can do is just add .only with your test like the following and run the command npm run test

it.only('Your test name', () => {})

P
Peter Mortensen

As said a previous answer, you can run the command

jest -t 'fix-order-test'

If you have an it inside of a describe block, you have to run

jest -t '<describeString> <itString>'

P
Peter Mortensen

Use:

npm run test -- test-name

This will only work if your test specification name is unique.

The code above would reference a file with this name: test-name.component.spec.ts


This worked for me! To clarify for anyone else reading this answer: "test specification name" refers to the text inside the describe() block.
Thank you! That was the only solution that worked out of the box without changing code or something else in a JHipster (7.8.1) project.
P
Peter Mortensen

With the latest Jest version, you can use one of the following to only run one test, and the same for a test suite.

it.only('test 1', () => {})

test.only('test 1', () => {})

fit('test 1', () => {})

jest 'test 1' may work too if the test name is unique.


c
codeAline

On jest 26.6.0 this is the only thing that worked for me:

jest -- test/unit/name-of-test-file.test.ts

and to watch

jest --watch -- test/unit/name-of-test-file.test.ts


this plus it.only or describe.only gets the test run narrowed down pretty well
P
Peter Mortensen

In Visual Studio Code, this lets me run/debug only one Jest test, with breakpoints: Debugging tests in Visual Studio Code

My launch.json file has this inside:

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Jest All",
      "program": "${workspaceFolder}/node_modules/.bin/jest",
      "args": ["--runInBand"],
      "console": "integratedTerminal",
      "internalConsoleOptions": "neverOpen",
      "windows": {
        "program": "${workspaceFolder}/node_modules/jest/bin/jest",
      }
    },
    {
      "type": "node",
      "request": "launch",
      "name": "Jest Current File",
      "program": "${workspaceFolder}/node_modules/.bin/jest",
      "args": ["${relativeFile}"],
      "console": "integratedTerminal",
      "internalConsoleOptions": "neverOpen",
      "windows": {
        "program": "${workspaceFolder}/node_modules/jest/bin/jest",
      }
    }
  ]
}

And this in file package.json:

  "scripts": {
    "test": "jest"
  }

To run one test, in that test, change test (or it) to test.only (or it.only). To run one test suite (several tests), change describe to describe.only.

Set breakpoint(s) if you want.

In Visual Studio Code, go to Debug View (Shift + Cmd + D or Shift + Ctrl + D).

From the dropdown menu at top, pick Jest Current File.

Click the green arrow to run that test.


In my case, your config runs only one test (with it.only(...)), but it doesn't stop at breakpoints :(
Getting JavaScript to hit breakpoints in a debugger can be tricky, because of its asynchronous nature. In VS Code, play around with where you place your breakpoints, plus the commands in the Debug menu, till it hits them. If it keeps skipping breakpoints, place them EARLIER in your code. If 1 file calls a function in another file, place breakpoint at that function call, then "Step Into" the call to jump files. Play with these Debug commands: "Step Over, Step Into, Step Out, Continue"
Actually, you don't need "scripts": { "test": "jest" } in package.json because you have specified the full path in the "program" parameter in launch.json .
Thx, those "${relativeFile}" helped me to run single file in VSCode.
@TudorLeustean , probably worth mentioning, add debugger; on the line you want to stop, in my case setting breakpoints via UI didn't work for tests too.
M
Michael Freidgeim

https://i.stack.imgur.com/riUgi.png


P
Peter Mortensen

npm test __tests__/filename.test.ts - to run a single file.

test.only('check single test', () => { expect(true).toBe(true)}); - to run a single test case

test.skip('to skip testcase, () => {expect(false).toBe(false_}); - to skip a test case


A
Anton Swanevelder

https://jestjs.io/docs/cli#--testnamepatternregex

Where your test is something like this file called my.test.js

test("My Sum", () => {
  const sum = 3;
  expect(sum).toBe(3);
});

Run on CLI with the test name

jest -t Sum

Use npm test with regex match part of file name example: my.test.js

npm test -t my

P
Peter Mortensen

Here is my take:

./node_modules/.bin/jest --config test/jest-unit-config.json --runInBand src/components/OpenForm/OpenForm.spec.js -t 'show expanded'

Notes:

./node_modules/.bin/... is a wonderful way, to access the locally installed Jest (or Mocha or...) binary that came with the locally installed package. (Yes, in your npm scripts you can jest with nothing before, but this is handy on command line... (that's also a good start for your debugging config, whichever IDE you are using...)

Your project might not have a set of configuration options. But if it does (peek into the scripts in package.json), this is, what you need.

--runInBand – as said, don't know about your configuration, but if you concentrate on developing/fixing a single test, you rather do not want to deal with web workers...

Yes, you can give the whole, explicit path to your file

Optionally, you can use -t to not run all tests in that file, but only a single one (here: the one, that has something with ‘show expanded’ in its name). Same effect can be achieved by glueing .only() into that file.


Rather than finding the jest binary in node_mpdules bin, you can now use npx jest blah
P
Peter Mortensen

Just a little add-on, because it seems there was kind of a fight if to use ./node_modules/.bin/jest -i ... or just jest -i ... or npm test -- -i ...

Just calling jest works if you have it installed globally (as with npm install -g jest), a not-so-clean way of handling dependencies If you have Jest installed only locally in the package and want to call the Jest script without the npm script detour, you can use npx jest -i ... => this is exactly what npx is for. It saves you from writing ./node_modules/.bin/....


T
Tingolfin

I took me a while to find this so I'd like to add it here for people like me who use yarn:

yarn test -i "src/components/folderX/folderY/.../Filename.ts" -t "name of test"

So filename after -i and testname after -t.


P
Peter Mortensen

There is now a nice Jest plugin for this called jest-watch-typeahead it makes this process much simpler.


Can you edit your answer to explain how this plugin solves the problem?
M
MartinDuo

For VSCode in Windows, I use these in my launch.json file. Note the use of ${pathSeparator} to handle the difference in Win and Mac. Select one in the debug dropdown and press F5 to run.

 {
  "name": "Debug Selected Jest Test",
  "type": "node",
  "request": "launch",
  "runtimeArgs": ["--inspect-brk", "${workspaceRoot}/node_modules/jest/bin/jest.js", "--runInBand"],
  "args": ["--", "-i", "${fileDirnameBasename}${pathSeparator}${fileBasename} ", "-t", "${selectedText}"],
  "console": "integratedTerminal",
  "internalConsoleOptions": "neverOpen",
  "port": 9229
},
{
  "name": "Debug Named Jest Test",
  "type": "node",
  "request": "launch",
  "runtimeArgs": ["--inspect-brk", "${workspaceRoot}/node_modules/jest/bin/jest.js", "--runInBand"],
  "args": ["--", "-i", "${fileDirnameBasename}${pathSeparator}${fileBasename} ", "-t", "filename.test.js"],
  "console": "integratedTerminal",
  "internalConsoleOptions": "neverOpen",
  "port": 9229
},

M
Md. Raju Ahmed

In the latest version of jest, you can run any single test in multiple ways.

fit('only this test will run', () => {});

it.only('only this test will run',() => {});

m
mubasshir00

run this command line :

   npm run test-jest unit_test/file_name -- -t test_name

My Package.json

"test-jest": "jest --verbose=true --force-exit",
"test-jest:watch": "jest --watchAll",

Y
Yehya

After checking the Jest CLI doc, I found this is how we run a specific test in a specific file.

jest --findRelatedTests path/to/fileA.js path/to/fileB.js -t "test name"

With yarn,

yarn test --findRelatedTests path/to/fileA.js path/to/fileB.js -t "test name"

With npm,

npm test -- --findRelatedTests path/to/fileA.js path/to/fileB.js -t "test name"

For reference please check Jest Cli Options