Skip to content

๐Ÿ› ๏ธ Provides high-level utilities and reduces boilerplate for testing Angular applications

License

Notifications You must be signed in to change notification settings

remscodes/ngx-testing-tools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Angular Testing Tools

Makes Angular testing easier

github ci codecov coverage npm version bundle size license

In a nutshell

This library aims to reduce boilerplate ๐Ÿ˜Ž and provides high-level tools๏ธ ๐Ÿ”ฅ for testing Component, Guard, Interceptor and everything else related to the Angular mechanism.

It makes tests easier to read ๐Ÿ˜Œ and faster to write โšก๏ธ!

Quick examples

Testing Component

describe('AppComponent', () => {
  const tb = componentTestBed(AppComponent) // ๐Ÿ› ๏ธ Create the test bed which is re-compiled for each test
    .inject('prefs', Preferences); // ๐Ÿ–‡๏ธ Link a key to an injection for all tests, see below ๐Ÿ‘‡

  it('should render title', tb(({ component, query }) => { // ๐Ÿ”‹ Access enhanced tools for testing components 
    expect(component.title).toEqual('app-v17');
    const span = query.findElement('.content span');
    expect(span.textContent).toContain('app-v17 app is running!');
  }));

  it('should update preferences on click', tb(({ action, injected: { prefs } }) => { // ๐Ÿคฏ Retrieve injections by autocompletion
    expect(prefs.approved).toBeFalse();
    action.click('#my-button');
    expect(prefs.approved).toBeTrue();
  }));
});

๐Ÿซก (The redundant "should create" test is even called up for you!)

Testing Service

describe('AppService', () => {
  const tb = serviceTestBed(AppService, { httpTesting: true }); // ๐Ÿ› ๏ธ Create the test bed and enable http testing

  it('should fetch cat fact', tb(({ service, http, rx }, done) => {
    const mockRes = { fact: 'string', length: 6 };

    rx.remind = service.getCatFact().subscribe({ // ๐Ÿงฏ Use rx.remind to auto unsubscribe after the end of the test
      next: (res) => {
        expect(res).toEqual(mockRes);
        done();
      },
    });

    http.emitSuccessResponse({ url: service.CAT_FACT_URL, body: mockRes }); // ๐ŸŽญ Fake the http response of the request that matches the url
  }));
});

Installation

npm install --save-dev ngx-testing-tools

Documentation

Visit the docs at https://remscodes.github.io/ngx-testing-tools.

Demo

Check demo .spec.ts files.

Version compatibility

Compatible with Angular >= 15.2.x.

What's next ? ๐Ÿคฉ

  • More custom test beds :
    • ResolverTestBed
  • Mocks
  • Angular schematics

License

MIT ยฉ Rรฉmy Abitbol.