npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

angularjs-testing-library

v5.0.0

Published

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

Downloads

1,246

Readme

AngularJS Testing Library

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

AngularJS Testing Library is a lightweight adapter built on top of DOM Testing Library.

version downloads MIT License issues todo.sr.ht

Table of Contents

The problem

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 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 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.

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 --save-dev angularjs-testing-library

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.

Examples

Basic Example

// hidden-message.js
import angular from 'angular'

class HiddenMessage {
  showMessage = false
}
const template = `
  <div>
    <label for="toggle">Show Message</label>
    <input
      id="toggle"
      type="checkbox"
      ng-model="$ctrl.showMessage"
    />
    <div ng-if="$ctrl.showMessage">
      {{$ctrl.message}}
    </div>
  </div>
`

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.
import '@testing-library/jest-dom/extend-expect'
// NOTE: jest-dom adds handy assertions to Jest and is recommended, but not required

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(
    `
    <atl-hidden-message message="testMessage"></atl-hidden-message>
  `,
    {
      scope: {
        testMessage,
      },
    },
  )

  // query* functions will return the element or null if it cannot be found
  // get* functions will return the element or throw an error if it cannot be found
  expect(queryByText(testMessage)).toBeNull()

  // the queries can accept a regex to make your selectors more resilient to content tweaks and changes.
  fireEvent.click(getByLabelText(/show/i))

  // .toBeInTheDocument() is an assertion that comes from jest-dom
  // otherwise you could use .toBeDefined()
  expect(getByText(testMessage)).toBeInTheDocument()
})

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 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 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.

LICENSE

MIT