Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/testing-library/angular-testing-library

🐙 Simple and complete Angular testing utilities that encourage good testing practices
https://github.com/testing-library/angular-testing-library
angular dom-testing-library testing testing-library
Last synced: 1 day ago
JSON representation
🐙 Simple and complete Angular testing utilities that encourage good testing practices
Host: GitHub
URL: https://github.com/testing-library/angular-testing-library
Owner: testing-library
License: mit
Created: 2018-06-12T10:08:51.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-12-14T16:37:46.000Z (12 days ago)
Last Synced: 2024-12-19T22:21:00.247Z (7 days ago)
Topics: angular, dom-testing-library, testing, testing-library
Language: TypeScript
Homepage: https://testing-library.com/angular
Size: 3.75 MB
Stars: 721
Watchers: 14
Forks: 92
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        


@testing-library/angular




Simple and complete Angular testing utilities that encourage good testing

practices.





[**Read The Docs**](https://testing-library.com/angular) |

[Edit the docs](https://github.com/testing-library/testing-library-docs)








[![Build Status][build-badge]][build]

[![version][version-badge]][package] [![downloads][downloads-badge]][npmtrends]

[![MIT License][license-badge]][license]

[![All Contributors](https://img.shields.io/github/all-contributors/testing-library/angular-testing-library?color=ee8449&style=flat-square)](#contributors)

[![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc]

[![Discord][discord-badge]][discord]

[![Watch on GitHub][github-watch-badge]][github-watch]

[![Star on GitHub][github-star-badge]][github-star]

[![Tweet][twitter-badge]][twitter]



  

    

  



[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=137053739)

## Table of Contents

- [Table of Contents](#table-of-contents)

- [The problem](#the-problem)

- [This solution](#this-solution)

- [Example](#example)

- [Installation](#installation)

- [Version compatibility](#version-compatibility)

- [Guiding Principles](#guiding-principles)

- [Contributors](#contributors)

- [Docs](#docs)

- [FAQ](#faq)

  - [I am using Reactive Forms and the `jest-dom` matcher `toHaveFormValues` always returns an empty object or there are missing fields. Why?](#i-am-using-reactive-forms-and-the-jest-dom-matcher-tohaveformvalues-always-returns-an-empty-object-or-there-are-missing-fields-why)

- [Issues](#issues)

  - [🐛 Bugs](#-bugs)

  - [💡 Feature Requests](#-feature-requests)

  - [❓ Questions](#-questions)

- [Getting started with GitHub Codespaces](#getting-started-with-github-codespaces)

- [LICENSE](#license)

## 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.][guiding-principle]

## Example

counter.component.ts

```ts

@Component({

  selector: 'app-counter',

  template: `

    {{ hello() }}

    -

    Current Count: {{ counter() }}

    +

  `,

})

export class CounterComponent {

  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

```typescript

import { render, screen, fireEvent, aliasedInput } from '@testing-library/angular';

import { CounterComponent } from './counter.component';

describe('Counter', () => {

  it('should render counter', async () => {

    await render(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 () => {

    await render(CounterComponent, { inputs: { counter: 5 } });

    const incrementButton = screen.getByRole('button', { name: '+' });

    fireEvent.click(incrementButton);

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

  });

});

```

[See more examples](https://github.com/testing-library/angular-testing-library/tree/main/apps/example-app/src/app/examples)

## Installation

This module is distributed via [npm][npm] which is bundled with [node][node] and

should be installed as one of your project's `devDependencies`.

Starting from ATL version 17, you also need to install `@testing-library/dom`:

```bash

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

```

Or, you can use the `ng add` command.

This sets up your project to use Angular Testing Library, which also includes the installation of `@testing-library/dom`.

```bash

ng add @testing-library/angular

```

You may also be interested in installing `jest-dom` so you can use

[the custom jest matchers](https://github.com/testing-library/jest-dom#readme).

> [**Docs**](https://testing-library.com/angular)

## Version compatibility

| Angular | Angular Testing Library      |

| ------- | ---------------------------- |

| 19.x    | 17.x, 16.x, 15.x, 14.x, 13.x |

| 18.x    | 17.x, 16.x, 15.x, 14.x, 13.x |

| 17.x    | 17.x, 16.x, 15.x, 14.x, 13.x |

| 16.x    | 14.x, 13.x                   |

| >= 15.1 | 14.x, 13.x                   |

| < 15.1  | 12.x, 11.x                   |

| 14.x    | 12.x, 11.x                   |

## Guiding Principles

> [The more your tests resemble the way your software is used, the more

> confidence they can give you.][guiding-principle]

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][emojis]):

  

    

      
_{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}
💻

    

  

This project follows the [all-contributors][all-contributors] specification.

Contributions of any kind welcome!

## Docs

[**Read The Docs**](https://testing-library.com/angular) |

[Edit the docs](https://github.com/testing-library/testing-library-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][good-first-issue]

label._

### 🐛 Bugs

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

[**See Bugs**][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**][requests]

### ❓ Questions

For questions related to using the library, please visit a support community

instead of filing an issue on GitHub.

- [Discord][discord]

- [Stack Overflow][stackoverflow]

## Getting started with GitHub Codespaces

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

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=137053739)

A codespace will open in a web-based version of Visual Studio Code. The [dev container](.devcontainer/devcontainer.json) is fully configured with software needed for this project.

**Note**: Dev containers is an open spec which is supported by [GitHub Codespaces](https://github.com/codespaces) and [other tools](https://containers.dev/supporting).

## LICENSE

MIT

[npm]: https://www.npmjs.com/

[node]: https://nodejs.org

[build-badge]: https://github.com/testing-library/angular-testing-library/actions/workflows/ci.yml/badge.svg

[build]: https://github.com/testing-library/angular-testing-library/actions/workflows/ci.yml

[version-badge]: https://img.shields.io/npm/v/@testing-library/angular.svg?style=flat-square

[package]: https://www.npmjs.com/package/@testing-library/angular

[downloads-badge]: https://img.shields.io/npm/dm/@testing-library/angular.svg?style=flat-square

[npmtrends]: http://www.npmtrends.com/@testing-library/angular

[discord-badge]: https://img.shields.io/discord/723559267868737556.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square

[discord]: https://discord.gg/testing-library

[license-badge]: https://img.shields.io/npm/l/@testing-library/angular.svg?style=flat-square

[license]: https://github.com/testing-library/angular-testing-library/blob/main/LICENSE

[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square

[prs]: http://makeapullrequest.com

[donate-badge]: https://img.shields.io/badge/$-support-green.svg?style=flat-square

[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square

[coc]: https://github.com/testing-library/angular-testing-library/blob/main/CODE_OF_CONDUCT.md

[github-watch-badge]: https://img.shields.io/github/watchers/testing-library/angular-testing-library.svg?style=social

[github-watch]: https://github.com/testing-library/angular-testing-library/watchers

[github-star-badge]: https://img.shields.io/github/stars/testing-library/angular-testing-library.svg?style=social

[github-star]: https://github.com/testing-library/angular-testing-library/stargazers

[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20🦔%20@testing-library/angular%20by%20%40tim_deschryver%20https%3A%2F%2Fgithub.com%2F@testing-library/angular

[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/testing-library/angular-testing-library.svg?style=social

[emojis]: https://github.com/all-contributors/all-contributors#emoji-key

[all-contributors]: https://github.com/all-contributors/all-contributors

[set-immediate]: https://developer.mozilla.org/en-US/docs/Web/API/Window/setImmediate

[guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106

[bugs]: https://github.com/testing-library/angular-testing-library/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc

[requests]: https://github.com/testing-library/angular-testing-library/issues?q=is%3Aissue+sort%3Areactions-%2B1-desc+label%3Aenhancement+is%3Aopen

[good-first-issue]: https://github.com/testing-library/angular-testing-library/issues?utf8=✓&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A"good+first+issue"+

[stackoverflow]: https://stackoverflow.com/questions/tagged/angular-testing-library

[contributors-badge]: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square