Repository files navigation

• Table of Contents
• The problem
• This solution
• Example
• Installation
• Version compatibility
• Guiding Principles
• Contributors
• Docs
• FAQ
  • I am using Reactive Forms and thejest-dom matchertoHaveFormValues always returns an empty object or there are missing fields. Why?
• Issues
  • 🐛 Bugs
  • 💡 Feature Requests
  • ❓ Questions
• Getting started with GitHub Codespaces
• LICENSE

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

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

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

counter.component.ts

@Component({selector:'atl-counter',template:`    <span>{{ hello() }}</span>    <button (click)="decrement()">-</button>    <span>Current Count: {{ counter() }}</span>    <button (click)="increment()">+</button>  `,})exportclassCounterComponent{counter=model(0);hello=input('Hi',{alias:'greeting'});increment(){this.counter.set(this.counter()+1);}decrement(){this.counter.set(this.counter()-1);}}

counter.component.spec.ts

import{render,screen,fireEvent,aliasedInput}from'@testing-library/angular';import{CounterComponent}from'./counter.component';describe('Counter',()=>{it('should render counter',async()=>{awaitrender(CounterComponent,{inputs:{counter:5,// aliases need to be specified this way        ...aliasedInput('greeting','Hello Alias!'),},});expect(screen.getByText('Current Count: 5')).toBeVisible();expect(screen.getByText('Hello Alias!')).toBeVisible();});it('should increment the counter on click',async()=>{awaitrender(CounterComponent,{inputs:{counter:5}});constincrementButton=screen.getByRole('button',{name:'+'});fireEvent.click(incrementButton);expect(screen.getByText('Current Count: 6')).toBeVisible();});});

See more examples

This module is distributed vianpm which is bundled withnode andshould be installed as one of your project'sdevDependencies.Starting from ATL version 17, you also need to install@testing-library/dom:

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

Or, you can use theng add command.This sets up your project to use Angular Testing Library, which also includes the installation of@testing-library/dom.

ng add @testing-library/angular

You may also be interested in installingjest-dom so you can usethe custom jest matchers.

Docs

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

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

Utilities are included in this project based on the following guidingprinciples:

1. If it relates to rendering components, it deals with DOM nodes rather thancomponent instances, nor should it encourage dealing with componentinstances.
2. It should be generally useful for testing individual Angular components orfull 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 prettylight-weight, simple, and understandable.

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 💻	Mateus Duraes 💻	Josh Joseph 💻⚠️	Torsten Knauf 🚧	antischematic 🐛🤔
Florian Pabst 💻	Mark Goho 🚧📖	Jan-Willem Baart 💻⚠️	S. Mumenthaler 💻⚠️	Andrei Alecu 💻🤔📖	Daniel Ramírez Barrientos 💻	Mahdi Lazraq 💻⚠️
Arthur Petrie 💻	Fabien Dehopré 💻	Jamie Vereecken 💻	Christian24 💻👀	Michal Štrajt 💻🐛	J. Degand 💻	Maksim Popov 💻

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

Read The Docs |Edit the docs

Only form elements with aname attribute will have their values passed totoHaveFormsValues.

Looking to contribute? Look for theGood First Issuelabel.

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

See Bugs

Please file an issue to suggest new features. Vote on feature requests by addinga 👍. This helps maintainers prioritize what to work on.

See Feature Requests

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

• Discord
• Stack Overflow

To get started, create a codespace for this repository by clicking this 👇

A codespace will open in a web-based version of Visual Studio Code. Thedev container is fully configured with software needed for this project.

Note: Dev containers is an open spec which is supported byGitHub Codespaces andother tools.

MIT