Skip to content
🦔 Simple and complete Angular testing utilities that encourage good testing practices
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci build: use yarn Dec 14, 2018
other docs: clean up readme May 5, 2019
projects feat(jest): add createMock (#30) Jul 15, 2019
src fix: providers on a module level (#26) Jun 17, 2019
.all-contributorsrc docs: add szabototo89 as a contributor (#33) Jul 15, 2019
.editorconfig init ngx-testing-library Jun 12, 2018
.gitignore init ngx-testing-library Jun 12, 2018
.npmrc chore: update dependencies to Angular version 8.0.0 (#16) May 29, 2019
CHANGELOG.md chore: add CHANGELOG Jul 29, 2018
CODE_OF_CONDUCT.md docs: fix broken links Jun 17, 2018
CONTRIBUTING.md docs: fix broken links Jun 17, 2018
LICENSE add README, COC, CONTRIBUTING, LICENSE Jun 17, 2018
README.md docs: add szabototo89 as a contributor (#33) Jul 15, 2019
angular.json fix: don't include jest-utils in main package (#15) May 13, 2019
browserslist chore: update dependencies to Angular version 8.0.0 (#16) May 29, 2019
jest.base.config.js chore: update dependencies to Angular version 8.0.0 (#16) May 29, 2019
package.json fix: add providers to configureTestingModule (#22) Jun 3, 2019
prettier.config.js init ngx-testing-library Jun 12, 2018
test.ts init ngx-testing-library Jun 12, 2018
tsconfig.json feat: initial release of scoped package (#20) May 31, 2019
tsconfig.spec.json init ngx-testing-library Jun 12, 2018
tslint.json chore: update dependencies to Angular version 8.0.0 (#16) May 29, 2019
yarn.lock build(deps): bump lodash from 4.17.11 to 4.17.14 (#31) Jul 13, 2019

README.md

@testing-library/angular

hedgehog

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


Read The Docs | Edit the docs



Build Status Code Coverage version downloads MIT License

All Contributors PRs Welcome Code of Conduct Join the community on Spectrum

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 data-testid="count">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 } from '@testing-library/angular';
import CounterComponent from './counter.component.ts';

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

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

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

    click(getByText('+'));

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

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
Tim Deschryver

💻 📖 🚇 ⚠️
Michaël De Boey
Michaël De Boey

📖
Ignacio Le Fluk
Ignacio Le Fluk

💻 ⚠️
Tamás Szabó
Tamás Szabó

💻

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

Docs

Read The Docs | Edit the docs

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

You can’t perform that action at this time.