From 983fab8b7af847c67f5c17a9c06048e46a877620 Mon Sep 17 00:00:00 2001 From: Jason Staten Date: Sun, 3 Nov 2019 20:26:38 -0700 Subject: [PATCH] chore: readme cleanup --- README.md | 519 +++++++----------------------------------------------- 1 file changed, 62 insertions(+), 457 deletions(-) diff --git a/README.md b/README.md index f309091..38f3c69 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,16 @@ -
-

React Testing Library

+# AngularJS Testing Library - - goat - +Simple and complete Vue.js testing utilities that encourage good testing +practices. -

Simple and complete React DOM testing utilities that encourage good testing -practices.

- -
- -[**Read The Docs**](https://testing-library.com/react) | -[Edit the docs](https://github.com/testing-library/testing-library-docs) - -
-
- -
+AngularJS Testing Library is a lightweight adapter built on top of +[DOM Testing Library](https://github.com/testing-library/dom-testing-library). -[![Build Status][build-badge]][build] -[![Code Coverage][coverage-badge]][coverage] [![version][version-badge]][package] [![downloads][downloads-badge]][npmtrends] [![MIT License][license-badge]][license] - -[![All Contributors](https://img.shields.io/badge/all_contributors-102-orange.svg?style=flat-square)](#contributors) -[![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc] -[![Join the community on Spectrum][spectrum-badge]][spectrum] - -[![Watch on GitHub][github-watch-badge]][github-watch] -[![Star on GitHub][github-star-badge]][github-star] -[![Tweet][twitter-badge]][twitter] -
- - TestingJavaScript.com Learn the smart, efficient way to test any JavaScript application. - -
- ## Table of Contents @@ -56,26 +19,16 @@ practices.

- [The problem](#the-problem) - [This solution](#this-solution) - [Installation](#installation) - - [Suppressing unnecessary warnings on React DOM 16.8](#suppressing-unnecessary-warnings-on-react-dom-168) - [Examples](#examples) - [Basic Example](#basic-example) - - [Complex Example](#complex-example) - - [More Examples](#more-examples) -- [Hooks](#hooks) - [Guiding Principles](#guiding-principles) -- [Docs](#docs) -- [Issues](#issues) - - [πŸ› Bugs](#-bugs) - - [πŸ’‘ Feature Requests](#-feature-requests) - - [❓ Questions](#-questions) -- [Contributors](#contributors) - [LICENSE](#license) ## The problem -You want to write maintainable tests for your React components. As a part of +You want to write maintainable tests for your AngularJS 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 @@ -85,10 +38,10 @@ your team down. ## This solution -The `React Testing Library` is a very lightweight solution for testing React -components. It provides light utility functions on top of `react-dom` and -`react-dom/test-utils`, in a way that encourages better testing practices. Its -primary guiding principle is: +The `AngularJS Testing Library` is a very lightweight solution for testing +components. It provides light utility functions on top of `angular-mocks` and +`@testing-library/dom-testing-library`, 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] @@ -99,89 +52,71 @@ This module is distributed via [npm][npm] which is bundled with [node][node] and should be installed as one of your project's `devDependencies`: ``` -npm install --save-dev @testing-library/react +npm install --save-dev angularjs-testing-library ``` -This library has `peerDependencies` listings for `react` and `react-dom`. +This library has `peerDependencies` listings for `angular` and `angular-mocks`. You may also be interested in installing `@testing-library/jest-dom` so you can use [the custom jest matchers](https://github.com/testing-library/jest-dom). -> [**Docs**](https://testing-library.com/react) - -### Suppressing unnecessary warnings on React DOM 16.8 - -There is a known compatibility issue with React DOM 16.8 where you will see the -following warning: - -``` -Warning: An update to ComponentName inside a test was not wrapped in act(...). -``` - -If you cannot upgrade to React DOM 16.9, you may suppress the warnings by adding -the following snippet to your test configuration -([learn more](https://github.com/testing-library/react-testing-library/issues/281)): - -```js -// this is just a little hack to silence a warning that we'll get until we -// upgrade to 16.9: https://github.com/facebook/react/pull/14853 -const originalError = console.error -beforeAll(() => { - console.error = (...args) => { - if (/Warning.*not wrapped in act/.test(args[0])) { - return - } - originalError.call(console, ...args) - } -}) - -afterAll(() => { - console.error = originalError -}) -``` - ## Examples ### Basic Example -```jsx +```js // hidden-message.js -import React from 'react' - -// NOTE: React Testing Library works with React Hooks _and_ classes just as well -// and your tests will be the same however you write your components. -function HiddenMessage({children}) { - const [showMessage, setShowMessage] = React.useState(false) - return ( -
- - setShowMessage(e.target.checked)} - checked={showMessage} - /> - {showMessage ? children : null} -
- ) -} +import angular from 'angular' -export default HiddenMessage +class HiddenMessage { + showMessage = false +} +const template = ` +
+ + +
+ {{$ctrl.message}} +
+
+` + +angular.module('atl', []).component('atlHiddenMessage', { + template, + controller: HiddenMessage, + bindings: { + message: '<', + }, +}) // __tests__/hidden-message.js // these imports are something you'd normally configure Jest to import for you -// automatically. Learn more in the setup docs: https://testing-library.com/docs/react-testing-library/setup#cleanup +// automatically. import '@testing-library/jest-dom/extend-expect' // NOTE: jest-dom adds handy assertions to Jest and is recommended, but not required -import React from 'react' -import {render, fireEvent} from '@testing-library/react' -import HiddenMessage from '../hidden-message' +import angular from 'angular' +import 'angular-mocks' +import {render, fireEvent} from 'angularjs-testing-library' +import '../hidden-message' + +beforeEach(() => angular.mock.module('atl')) test('shows the children when the checkbox is checked', () => { const testMessage = 'Test Message' const {queryByText, getByLabelText, getByText} = render( - {testMessage}, + ` + + `, + { + scope: { + testMessage, + }, + }, ) // query* functions will return the element or null if it cannot be found @@ -197,139 +132,13 @@ test('shows the children when the checkbox is checked', () => { }) ``` -### Complex Example - -```jsx -// login.js -import React from 'react' - -function Login() { - const [state, setState] = React.useReducer((s, a) => ({...s, ...a}), { - resolved: false, - loading: false, - error: null, - }) - - function handleSubmit(event) { - event.preventDefault() - const {usernameInput, passwordInput} = event.target.elements - - setState({loading: true, resolved: false, error: null}) - - window - .fetch('/api/login', { - method: 'POST', - headers: {'Content-Type': 'application/json'}, - body: JSON.stringify({ - username: usernameInput.value, - password: passwordInput.value, - }), - }) - .then(r => r.json()) - .then( - user => { - setState({loading: false, resolved: true, error: null}) - window.localStorage.setItem('token', user.token) - }, - error => { - setState({loading: false, resolved: false, error: error.message}) - }, - ) - } - - return ( -
-
-
- - -
-
- - -
- -
- {state.error ?
{state.error.message}
: null} - {state.resolved ? ( -
Congrats! You're signed in!
- ) : null} -
- ) -} - -export default Login - -// __tests__/login.js -// again, these first two imports are something you'd normally handle in -// your testing framework configuration rather than importing them in every file. -import '@testing-library/jest-dom/extend-expect' -import React from 'react' -import {render, fireEvent} from '@testing-library/react' -import Login from '../login' - -test('allows the user to login successfully', async () => { - // mock out window.fetch for the test - const fakeUserResponse = {token: 'fake_user_token'} - jest.spyOn(window, 'fetch').mockImplementationOnce(() => { - return Promise.resolve({ - json: () => Promise.resolve(fakeUserResponse), - }) - }) - - const {getByLabelText, getByText, findByRole} = render() - - // fill out the form - fireEvent.change(getByLabelText(/username/i), {target: {value: 'chuck'}}) - fireEvent.change(getByLabelText(/password/i), {target: {value: 'norris'}}) - - fireEvent.click(getByText(/submit/i)) - - // just like a manual tester, we'll instruct our test to wait for the alert - // to show up before continuing with our assertions. - const alert = await findByRole('alert') - - // .toHaveTextContent() comes from jest-dom's assertions - // otherwise you could use expect(alert.textContent).toMatch(/congrats/i) - // but jest-dom will give you better error messages which is why it's recommended - expect(alert).toHaveTextContent(/congrats/i) - expect(window.localStorage.getItem('token')).toEqual(fakeUserResponse.token) -}) -``` - -### More Examples - -> We're in the process of moving examples to the -> [docs site](https://testing-library.com/docs/example-codesandbox) - -You'll find runnable examples of testing with different libraries in -[the `react-testing-library-examples` codesandbox](https://codesandbox.io/s/github/kentcdodds/react-testing-library-examples). -Some included are: - -- [`react-redux`](https://codesandbox.io/s/github/kentcdodds/react-testing-library-examples/tree/master/?fontsize=14&module=%2Fsrc%2F__tests__%2Freact-redux.js&previewwindow=tests) -- [`react-router`](https://codesandbox.io/s/github/kentcdodds/react-testing-library-examples/tree/master/?fontsize=14&module=%2Fsrc%2F__tests__%2Freact-router.js&previewwindow=tests) -- [`react-context`](https://codesandbox.io/s/github/kentcdodds/react-testing-library-examples/tree/master/?fontsize=14&module=%2Fsrc%2F__tests__%2Freact-context.js&previewwindow=tests) - -You can also find React Testing Library examples at -[react-testing-examples.com](https://react-testing-examples.com/jest-rtl/). - -## Hooks - -If you are interested in testing a custom hook, check out [React Hooks Testing -Library][react-hooks-testing-library]. - -> NOTE it is not recommended to test single-use custom hooks in isolation from -> the components where it's being used. It's better to test the component that's -> using the hook rather than the hook itself. The `React Hooks Testing Library` -> is intended to be used for reusable hooks/libraries. - ## 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 react components are used. +that closely resemble how your components are used. Utilities are included in this project based on the following guiding principles: @@ -337,193 +146,13 @@ 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 React components or - full React applications. While this library is focused on `react-dom`, - utilities could be included even if they don't directly relate to - `react-dom`. +2. It should be generally useful for testing individual AngularJS components or + full AngularJS 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. -## Docs - -[**Read The Docs**](https://testing-library.com/react) | -[Edit the docs](https://github.com/testing-library/testing-library-docs) - -## 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. - -- [Spectrum][spectrum] -- [Reactiflux on Discord][reactiflux] -- [Stack Overflow][stackoverflow] - -## Contributors - -Thanks goes to these people ([emoji key][emojis]): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Kent C. Dodds
Kent C. Dodds
πŸ’» πŸ“– πŸš‡ ⚠️		Ryan Castner
Ryan Castner
πŸ“–		Daniel Sandiego
Daniel Sandiego
πŸ’»		PaweΕ‚ MikoΕ‚ajczyk
PaweΕ‚ MikoΕ‚ajczyk
πŸ’»		Alejandro ÑÑñez Ortiz
Alejandro ÑÑñez Ortiz
πŸ“–		Matt Parrish
Matt Parrish
πŸ› πŸ’» πŸ“– ⚠️		Justin Hall
Justin Hall
πŸ“¦
Anto Aravinth
Anto Aravinth
πŸ’» ⚠️ πŸ“–		Jonah Moses
Jonah Moses
πŸ“–		Łukasz Gandecki
Łukasz Gandecki
πŸ’» ⚠️ πŸ“–		Ivan Babak
Ivan Babak
πŸ› πŸ€”		Jesse Day
Jesse Day
πŸ’»		Ernesto GarcΓ­a
Ernesto GarcΓ­a
πŸ’¬ πŸ’» πŸ“–		Josef Maxx Blake
Josef Maxx Blake
πŸ’» πŸ“– ⚠️
Michal Baranowski
Michal Baranowski
πŸ“ βœ…		Arthur Puthin
Arthur Puthin
πŸ“–		Thomas Chia
Thomas Chia
πŸ’» πŸ“–		Thiago Galvani
Thiago Galvani
πŸ“–		Christian
Christian
⚠️		Alex Krolick
Alex Krolick
πŸ’¬ πŸ“– πŸ’‘ πŸ€”		Johann Hubert Sonntagbauer
Johann Hubert Sonntagbauer
πŸ’» πŸ“– ⚠️
Maddi Joyce
Maddi Joyce
πŸ’»		Ryan Vice
Ryan Vice
πŸ“–		Ian Wilson
Ian Wilson
πŸ“ βœ…		Daniel
Daniel
πŸ› πŸ’»		Giorgio Polvara
Giorgio Polvara
πŸ› πŸ€”		John Gozde
John Gozde
πŸ’»		Sam Horton
Sam Horton
πŸ“– πŸ’‘ πŸ€”
Richard Kotze (mobile)
Richard Kotze (mobile)
πŸ“–		Brahian E. Soto Mercedes
Brahian E. Soto Mercedes
πŸ“–		Benoit de La Forest
Benoit de La Forest
πŸ“–		Salah
Salah
πŸ’» ⚠️		Adam Gordon
Adam Gordon
πŸ› πŸ’»		Matija MarohniΔ‡
Matija Marohnić
πŸ“–		Justice Mba
Justice Mba
πŸ“–
Mark Pollmann
Mark Pollmann
πŸ“–		Ehtesham Kafeel
Ehtesham Kafeel
πŸ’» πŸ“–		Julio PavΓ³n
Julio PavΓ³n
πŸ’»		Duncan L
Duncan L
πŸ“– πŸ’‘		Tiago Almeida
Tiago Almeida
πŸ“–		Robert Smith
Robert Smith
πŸ›		Zach Green
Zach Green
πŸ“–
dadamssg
dadamssg
πŸ“–		Yazan Aabed
Yazan Aabed
πŸ“		Tim
Tim
πŸ› πŸ’» πŸ“– ⚠️		Divyanshu Maithani
Divyanshu Maithani
βœ… πŸ“Ή		Deepak Grover
Deepak Grover
βœ… πŸ“Ή		Eyal Cohen
Eyal Cohen
πŸ“–		Peter Makowski
Peter Makowski
πŸ“–
Michiel Nuyts
Michiel Nuyts
πŸ“–		Joe Ng'ethe
Joe Ng'ethe
πŸ’» πŸ“–		Kate
Kate
πŸ“–		Sean
Sean
πŸ“–		James Long
James Long
πŸ€” πŸ“¦		Herb Hagely
Herb Hagely
πŸ’‘		Alex Wendte
Alex Wendte
πŸ’‘
Monica Powell
Monica Powell
πŸ“–		Vitaly Sivkov
Vitaly Sivkov
πŸ’»		Weyert de Boer
Weyert de Boer
πŸ€” πŸ‘€		EstebanMarin
EstebanMarin
πŸ“–		Victor Martins
Victor Martins
πŸ“–		Royston Shufflebotham
Royston Shufflebotham
πŸ› πŸ“– πŸ’‘		chrbala
chrbala
πŸ’»
Donavon West
Donavon West
πŸ’» πŸ“– πŸ€” ⚠️		Richard Maisano
Richard Maisano
πŸ’»		Marco Biedermann
Marco Biedermann
πŸ’» 🚧 ⚠️		Alex Zherdev
Alex Zherdev
πŸ› πŸ’»		AndrΓ© Matulionis dos Santos
AndrΓ© Matulionis dos Santos
πŸ’» πŸ’‘ ⚠️		Daniel K.
Daniel K.
πŸ› πŸ’» πŸ€” ⚠️ πŸ‘€		mohamedmagdy17593
mohamedmagdy17593
πŸ’»
Loren ☺️
Loren ☺️
πŸ“–		MarkFalconbridge
MarkFalconbridge
πŸ› πŸ’»		Vinicius
Vinicius
πŸ“– πŸ’‘		Peter Schyma
Peter Schyma
πŸ’»		Ian Schmitz
Ian Schmitz
πŸ“–		Joel Marcotte
Joel Marcotte
πŸ› ⚠️ πŸ’»		Alejandro Dustet
Alejandro Dustet
πŸ›
Brandon Carroll
Brandon Carroll
πŸ“–		Lucas Machado
Lucas Machado
πŸ“–		Pascal Duez
Pascal Duez
πŸ“¦		Minh Nguyen
Minh Nguyen
πŸ’»		LiaoJimmy
LiaoJimmy
πŸ“–		Sunil Pai
Sunil Pai
πŸ’» ⚠️		Dan Abramov
Dan Abramov
πŸ‘€
Christian Murphy
Christian Murphy
πŸš‡		Ivakhnenko Dmitry
Ivakhnenko Dmitry
πŸ’»		James George
James George
πŸ“–		JoΓ£o Fernandes
JoΓ£o Fernandes
πŸ“–		Alejandro Perea
Alejandro Perea
πŸ‘€		Nick McCurdy
Nick McCurdy
πŸ‘€ πŸ’¬		Sebastian Silbermann
Sebastian Silbermann
πŸ‘€
AdriΓ  Fontcuberta
AdriΓ  Fontcuberta
πŸ‘€ πŸ“–		John Reilly
John Reilly
πŸ‘€		MichaΓ«l De Boey
MichaΓ«l De Boey
πŸ‘€		Tim Yates
Tim Yates
πŸ‘€		Brian Donovan
Brian Donovan
πŸ’»		Noam Gabriel Jacobson
Noam Gabriel Jacobson
πŸ“–		Ronald van der Kooij
Ronald van der Kooij
⚠️ πŸ’»
Aayush Rajvanshi
Aayush Rajvanshi
πŸ“–		Ely Alamillo
Ely Alamillo
πŸ’» ⚠️		Daniel Afonso
Daniel Afonso
πŸ’» ⚠️		Laurens Bosscher
Laurens Bosscher
πŸ’»
- - - -This project follows the [all-contributors][all-contributors] specification. -Contributions of any kind welcome! - ## LICENSE [MIT](LICENSE) @@ -532,36 +161,12 @@ Contributions of any kind welcome! [npm]: https://www.npmjs.com/ [node]: https://nodejs.org -[build-badge]: https://img.shields.io/travis/testing-library/react-testing-library.svg?style=flat-square -[build]: https://travis-ci.org/testing-library/react-testing-library -[coverage-badge]: https://img.shields.io/codecov/c/github/testing-library/react-testing-library.svg?style=flat-square -[coverage]: https://codecov.io/github/testing-library/react-testing-library -[version-badge]: https://img.shields.io/npm/v/@testing-library/react.svg?style=flat-square -[package]: https://www.npmjs.com/package/@testing-library/react -[downloads-badge]: https://img.shields.io/npm/dm/@testing-library/react.svg?style=flat-square -[npmtrends]: http://www.npmtrends.com/@testing-library/react -[spectrum-badge]: https://withspectrum.github.io/badge/badge.svg -[spectrum]: https://spectrum.chat/testing-library -[license-badge]: https://img.shields.io/npm/l/@testing-library/react.svg?style=flat-square -[license]: https://github.com/testing-library/react-testing-library/blob/master/LICENSE -[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square -[prs]: http://makeapullrequest.com -[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square -[coc]: https://github.com/testing-library/react-testing-library/blob/master/CODE_OF_CONDUCT.md -[github-watch-badge]: https://img.shields.io/github/watchers/testing-library/react-testing-library.svg?style=social -[github-watch]: https://github.com/testing-library/react-testing-library/watchers -[github-star-badge]: https://img.shields.io/github/stars/testing-library/react-testing-library.svg?style=social -[github-star]: https://github.com/testing-library/react-testing-library/stargazers -[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20react-testing-library%20by%20%40@TestingLib%20https%3A%2F%2Fgithub.com%2Ftesting-library%2Freact-testing-library%20%F0%9F%91%8D -[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/testing-library/react-testing-library.svg?style=social -[emojis]: https://github.com/all-contributors/all-contributors#emoji-key -[all-contributors]: https://github.com/all-contributors/all-contributors +[version-badge]: https://img.shields.io/npm/v/angularjs-testing-library.svg?style=flat-square +[package]: https://www.npmjs.com/package/angularjs-testing-library +[downloads-badge]: https://img.shields.io/npm/dm/angularjs-testing-library.svg?style=flat-square +[npmtrends]: http://www.npmtrends.com/angularjs-testing-library +[license-badge]: https://img.shields.io/npm/l/angular-testing-library.svg?style=flat-square +[license]: https://example.com [guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106 -[bugs]: https://github.com/testing-library/react-testing-library/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc -[requests]: https://github.com/testing-library/react-testing-library/issues?q=is%3Aissue+sort%3Areactions-%2B1-desc+label%3Aenhancement+is%3Aopen -[good-first-issue]: https://github.com/testing-library/react-testing-library/issues?utf8=βœ“&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A"good+first+issue"+ -[reactiflux]: https://www.reactiflux.com/ -[stackoverflow]: https://stackoverflow.com/questions/tagged/react-testing-library -[react-hooks-testing-library]: https://github.com/testing-library/react-hooks-testing-library