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

@aegis-techno/ngx-testing-tools

v17.0.0

Published

Given When Then concepts for jest.

Downloads

102

Readme

NgxTestingTools

This library is a helper that encourages leaner, meaner specs.

It provide Given When Then Concepts and mock tool for Jest and Angular

Running unit tests

Run ng test ngx-testing-tools to execute the unit tests via jest.

Given When Then Concepts

This library is a helper that encourages leaner, meaner specs using Given, When, and Then.

The basic idea behind this is a humble acknowledgement of given-when-then as the best English language analogue we have to arrange-act-assert

Prior Art + Credit

The concept (and implementation) is based on the work of HiRez.io, who've done an amazing implementation of the original jasmine-given library by Justin Searls, which is in turn based on rspec-given by Jim Weirich.

Example

describe('A context', () => {
    let fakeNumber: number;
    let actualResult: any;

    function addTwo(num: number) {
        return num + 2;
    }

    Given(() => {
        fakeNumber = undefined;
        actualResult = undefined;
    });

    describe('should run "Given" before "When" and "When" before "Then"', () => {
        Given(() => {
            fakeNumber = 2;
        });

        When(() => {
            actualResult = addTwo(fakeNumber);
        });

        Then(() => {
            expect(actualResult).toBe(4);
        });
    });

    describe("redundant test execution example", () => {
        context("a traditional spec with numerous Then statements", () => {
            var timesGivenWasInvoked = 0,
                timesWhenWasInvoked = 0;
            Given(() => {
                timesGivenWasInvoked++;
            });
            When(() => {
                timesWhenWasInvoked++;
            });
            Then(() => expect(timesGivenWasInvoked).toBe(1));
            Then(() => expect(timesWhenWasInvoked).toBe(2));
            Then(() => expect(timesGivenWasInvoked).toBe(3));
            Then(() => expect(timesWhenWasInvoked).toBe(4));
        });


        context("a spec with one Then and multiple And statements", () => {
            var timesGivenWasInvoked = 0,
                timesWhenWasInvoked = 0;
            Given(() => {
                timesGivenWasInvoked++;
            });
            When(() => {
                timesWhenWasInvoked++;
            });
            Then(() => expect(timesGivenWasInvoked).toBe(1));
            And(() => expect(timesWhenWasInvoked).toBe(1));
            And(() => expect(timesGivenWasInvoked).toBe(1));
            And(() => expect(timesWhenWasInvoked).toBe(1));
            Then(() => expect(timesWhenWasInvoked).toBe(2));
        });
    });

Given

The Given section specifies a starting point, a set of preconditions that must be true before the code under test is allowed to be run. In standard test frameworks the preconditions are established with a combination of setup methods

When

The When clause specifies the code to be tested ... oops, excuse me ... specified. After the preconditions in the given section are met, the when code block is run.

Then / ThenExpect

The Then clauses are the postconditions of the specification. These then conditions must be true after the code under test (the When clause) is run.

And

The And clauses are play after the Then clause find before. The And clauses don't support "random order running test".

Mock

Utils method :

  • configureTestBed(moduleDef?: TestModuleMetadata), for the configuration of the TestBed in a Given.
  • createTestContext(component: Type<T>), for create un wrapper of a fixture for the component class given.
  • provideSpyObjForClass, create a SpyObj.
  • injectMock(classType: Type<T> | AbstractType<T>), for retreive a mock.

Usage

describe('MyComponent', () => {
    let testContext: TestContext<MyComponent>;

    configureTestBed({
            providers: [
                provideSpyObjForClass(MyService)
            ]
        },
    );

    Given(() => {
        injectMock(MyService).foo.and.returnValue(["TEST"]);
    })

    When(async () => {
        testContext = createTestContext(MyComponent);
        await testContext.whenStable();
    });

    Then('should be created', () => {
        expect(testContext.component).toBeTruthy();
    });

    Then('should have retrieve data from service', () => {
        expect(testContext.component.bar).toBe("TEST");
    });
});