Symfony UX Stimulus testing

Warning

Deprecated: This package is deprecated and will not receive any further updates.

Because this package only provides very small helpers to help write tests for Stimulus controllers, and is tightly coupled with Jest, jsdom and Testing Library dependencies, we can no longer recommend it.

In 2025, we cannot force developers to install Jest (and ~270 sub-dependencies including Babel) and the like, since many test runners exist, and many of them are more modern and much faster, like Vitest.

We want to give you the choice to use the best tools for your needs, and not force you to use what we suggested in the past.

To migrate from @symfony/stimulus-testing, you can follow these steps:

Install the dev dependencies @testing-library/jest-dom @testing-library/dom; you may also want to install mutationobserver-shim regenerator-runtime if you still have legacy code or architecture.
In the file assets/test/setup.js, replace imports:

-import '@symfony/stimulus-testing/setup';
+import '@testing-library/jest-dom';

Create the file assets/test/stimulus-helpers.js with the following content:

export function mountDOM(html = '') {
    const div = document.createElement('div');
    div.innerHTML = html;
    document.body.appendChild(div);

    return div;
}

export function clearDOM() {
    document.body.innerHTML = '';
}

In your tests files, replace imports for mountDOM and clearDOM:

// assets/test/controllers/hello_controller.test.js
-import { clearDOM, mountDOM } from '@symfony/stimulus-testing';
+import { clearDOM, mountDOM } from '../stimulus-helpers';

And finally, remove the @symfony/stimulus-testing dependency from your project.

Symfony UX Stimulus testing is a low-level package to help write tests for Stimulus controllers in applications and reusable packages.

Symfony UX Stimulus testing is currently considered experimental.

Installation

yarn add @symfony/stimulus-testing

Usage

Symfony UX Stimulus testing ships several tools to help write tests for Stimulus controllers:

it uses Jest as test runner ;
it relies internally on jsdom and mutationobserver-shim to emulate a DOM implementation and allow to execute Stimulus controllers in the console ;
it provides an integration of Testing Library ;
it provides helper functions to ease Stimulus tests development in Symfony projects and bundles ;

To start using Symfony UX Testing, you first need to configure a testing environment:

Create a assets/test directory ;
Create a assets/test/setup.js file to initialize Symfony UX Testing:

import '@symfony/stimulus-testing/setup';

Create a assets/jest.config.js file for Jest configuration:

module.exports = {
    'testRegex': 'test/.*\\.test.js',
    'setupFilesAfterEnv': ['./test/setup.js']
};

Create a assets/.babelrc file for Babel configuration (you may need to install Babel, @babel/plugin-proposal-class-properties and @babel/preset-env if you haven't already):

{
    "presets": ["@babel/preset-env"],
    "plugins": ["@babel/plugin-proposal-class-properties"]
}

Finally, create your first test, for instance hello_controller.test.js:

import { Application } from '@hotwired/stimulus';
import { clearDOM, mountDOM } from '@symfony/stimulus-testing';
import HelloController from '../controllers/hello_controller.js';

const startStimulus = () => {
    const application = Application.start();
    application.register('hello', HelloController);
};

describe('HelloController', () => {
    let container;

    beforeEach(() => {
        container = mountDOM('<div data-controller="hello"></div>');
    });

    afterEach(() => {
        clearDOM();
    });

    it('connect', async () => {
        startStimulus();

        // Write a test here ...
    });

    // You can create other tests here
});

symfony/stimulus-testing

ErrorLooks like something went wrong!

About

Topics

Resources

Code of conduct

Security policy

Uh oh!

Stars

Watchers

Forks

Releases 1

Sponsor this project

Packages 0

Contributors 5

Languages

Error
Looks like something went wrong!

Packages