LWC Test Case Generation

Use the LWC test case generation feature to generate Jest unit tests for your LWC components.

LWC Test Case Generation

Use Agentforce for Developers to quickly generate an LWC jest test.

  1. From within the JavaScript file in a Lighning web component folder, right-click and select the Agentforce: Generate an LWC Test command, or click the beaker icon on the top right, to open the Test Case Generation panel.
  2. Select LWC. Then select the component that you want to test. Currently, you cannot select specific methods or files.
  3. Click Generate Tests to generate your first test.
  4. Click ✔️ to Accept if the generated test looks good in the diff view, or generate again.

When generating Jest tests, consider these guidelines.

  • The generated Jest tests are added to a test file in the component's tests folder with the naming convention <componentName>.test.js. If one already exists, review the proposed changes in the diff view before accepting them. Accepting the changes automatically overwrites the file. If your test file already includes at least a test case, new ones may be generated after the last test case.
  • If your test case contains a "TODO" description, a test case based on the description you provide is generated. For example, if your test file contains 'TODO: verify that the component renders account name and details when provided', you may see separate test cases for "renders account name when provided" and "renders account details when provided".
  • Test case generation may occasionally return a message that no improvements are needed in the tests or it may not return any changes at all. If this happens, try including TODO descriptions in your test file and running the test case generation again.

This is a list of known issues with LWC test case generation. The team is working on them internally. For issues related to Agentforce for Developers, check our github repo.

  • The generated Jest test may contain placeholder code for you to update. For example, you can update placeholder record IDs with a valid record ID.
  • Mock data may be generated for test cases that retrieve record data, such as from the getRecord wire adapter. Mock data generation isn't guaranteed. To use your own mock data, see Mock the Data in the LWC Dev Guide.
  • Check the generated test cases for accuracy. Test cases may fail and require developer input. For example, a test case may fail because it doesn't wait for asynchronous DOM updates before querying an element.