@testing-library/angular

Test your Angular components with the dom-testing-library

Stats

StarsIssuesVersionUpdatedCreatedSize
@testing-library/angular
531312.0.212 days ago3 years agoMinified + gzip package size for @testing-library/angular in KB

Readme

@testing-library/angular

hedgehog

Simple and complete Angular testing utilities that encourage good testing practices.


Read The Docs | Edit the docs



Build Status version downloads MIT License

All Contributors PRs Welcome Code of Conduct Discord

Watch on GitHub Star on GitHub Tweet

Table of Contents

The problem

You want to write maintainable tests for your Angular components. As a part of this goal, you want your tests to avoid including implementation details of your components and rather focus on making your tests give you the confidence for which they are intended. As part of this, you want your testbase to be maintainable in the long run so refactors of your components (changes to implementation but not functionality) don't break your tests and slow you and your team down.

This solution

The @testing-library/angular is a very lightweight solution for testing Angular components. It provides light utility functions on top of Angular and @testing-library/dom, in a way that encourages better testing practices. Its primary guiding principle is:

The more your tests resemble the way your software is used, the more confidence they can give you.

Example

counter.component.ts

@Component({
  selector: 'counter',
  template: `
    <button (click)="decrement()">-</button>
    <span>Current Count: {{ counter }}</span>
    <button (click)="increment()">+</button>
  `,
})
export class CounterComponent {
  @Input() counter = 0;

  increment() {
    this.counter += 1;
  }

  decrement() {
    this.counter -= 1;
  }
}

counter.component.spec.ts

import { render, screen, fireEvent } from '@testing-library/angular';
import { CounterComponent } from './counter.component.ts';

describe('Counter', () => {
  test('should render counter', async () => {
    await render(CounterComponent, { componentProperties: { counter: 5 } });

    expect(screen.getByText('Current Count: 5'));
  });

  test('should increment the counter on click', async () => {
    await render(CounterComponent, { componentProperties: { counter: 5 } });

    const incrementButton = screen.getByRole('button', { name: /increment/i });
    fireEvent.click(incrementButton);

    expect(screen.getByText('Current Count: 6'));
  });
});

See more examples

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

npm install @testing-library/angular --save-dev

You may also be interested in installing jest-dom so you can use the custom jest matchers.

Docs

Guiding Principles

The more your tests resemble the way your software is used, the more confidence they can give you.

We try to only expose methods and utilities that encourage you to write tests that closely resemble how your Angular components are used.

Utilities are included in this project based on the following guiding principles:

  1. If it relates to rendering components, it deals with DOM nodes rather than component instances, nor should it encourage dealing with component instances.
  2. It should be generally useful for testing individual Angular components or full Angular applications.
  3. Utility implementations and APIs should be simple and flexible.

At the end of the day, what we want is for this library to be pretty light-weight, simple, and understandable.

Contributors

Thanks goes to these people (emoji key):


Tim Deschryver

๐Ÿ’ป ๐Ÿ“– ๐Ÿš‡ โš ๏ธ

Michaรซl De Boey

๐Ÿ“–

Ignacio Le Fluk

๐Ÿ’ป โš ๏ธ

Tamรกs Szabรณ

๐Ÿ’ป

Gregor Woiwode

๐Ÿ’ป

Toni Villena

๐Ÿ› ๐Ÿ’ป ๐Ÿ“– โš ๏ธ

ShPelles

๐Ÿ“–

Miluoshi

๐Ÿ’ป โš ๏ธ

Nick McCurdy

๐Ÿ“–

Srinivasan Sekar

๐Ÿ“–

Bitcollage

๐Ÿ“–

Emil Sundin

๐Ÿ’ป

Ombrax

๐Ÿ’ป

Rafael Santana

๐Ÿ’ป โš ๏ธ ๐Ÿ›

Benjamin Blackwood

๐Ÿ“– โš ๏ธ

Gustavo Porto

๐Ÿ“–

Bo Vandersteene

๐Ÿ’ป

Janek

๐Ÿ’ป โš ๏ธ

Gleb Irovich

๐Ÿ’ป โš ๏ธ

Arjen

๐Ÿ’ป ๐Ÿšง

Suguru Inatomi

๐Ÿ’ป ๐Ÿค”

Amit Miran

๐Ÿš‡

Jan-Willem Willebrands

๐Ÿ’ป

Sandro

๐Ÿ’ป ๐Ÿ›

Michael Westphal

๐Ÿ’ป โš ๏ธ

Lukas

๐Ÿ’ป

Matan Borenkraout

๐Ÿšง

mleimer

๐Ÿ“– โš ๏ธ

MeIr

๐Ÿ› โš ๏ธ

John Dengis

๐Ÿ’ป โš ๏ธ

Rokas Brazdลพionis

๐Ÿ’ป

This project follows the all-contributors specification. Contributions of any kind welcome!

Docs

Read The Docs | Edit the docs

FAQ

I am using Reactive Forms and the jest-dom matcher toHaveFormValues always returns an empty object or there are missing fields. Why?

Only form elements with a name attribute will have their values passed to toHaveFormsValues.

Issues

Looking to contribute? Look for the Good First Issue label.

๐Ÿ› Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

๐Ÿ’ก Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a ๐Ÿ‘. This helps maintainers prioritize what to work on.

See Feature Requests

โ“ Questions

For questions related to using the library, please visit a support community instead of filing an issue on GitHub.

LICENSE

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.