Good Eggs Test Helpers

Basic setup used for all Good Eggs tests.

Test structure

Good Eggs tests use the BDD testing DSL from mocha, with a few extras.

Assertions

Good Eggs tests use chai, with a bunch of plugins ready for you.

Contributing

Please follow our Code of Conduct when contributing to this project.

yarn install
yarn test

Releasing

To release a new version of this module, use yarn to bump the version in package.json and create a git tag, then push. This will automatically get published to the NPM registry via CI.

yarn version --new-version=<major|minor|patch|premajor|preminor|prepatch>
git push --follow-tags

License

MIT

Changes since last deploy

v8.0.0

BREAKING CHANGES

• Remove chaid which was an unsafe ID assertion library with no types

Other

• Ported to Typescript

v7.0.0

BREAKING CHANGES

Remove exported runtest "binary".

To replace its usage with an equivalent inlined command, add a dependency on nyc:

yarn add --dev nyc

add a _mocha script that runs

NODE_ENV=test yarn run nyc --report-dir=.coverage --temp-directory=.coverage/.nyc_output --reporter=lcov --reporter=text-summary mocha --require=@babel/register --exit

(This assumes you're using Babel 7; otherwise change @babel/register to babel-register.)

and replace uses of runtest with yarn run _mocha.

Finally, to continue conforming to best practices, include a runtest package script that runs:

yarn run _mocha

See here for an example.

v6.5.3

Bug fixes

• Fix deploy from travis

v6.5.2

Bug fixes

• Build for browser as well as node

v6.5.1

Bug fixes

• Load dependencies from public node registry
• Run tests in CI

Other

• Build for Node 8
• Deploy from Travis
• Format with Prettier

v6.5.0

• Fix flow typedefs

v6.4.1

• Add createRollbarStub, createAnalyticsStub, and createLoggerStub; the first two are mocks we commonly copy/paste between repositories; the latter is a factory we usually get from useSinonSandbox, but in a mutative stub pattern. This adapts each stub to use our more common factory pattern.
• Remove first args to before/after/beforeEach/afterEach to fix Jest compatibility
• Bump node to 8.11.4 on Travis
• Update development scripts to be more standard

v6.2.1

• Fix Flow v0.75.0 incompatibility

v6.2.0

• Add .blank() assertion to Chai type definition

v6.1.0

• Add Enzyme className, props type definitions

v6.0.1

• Fix Sinon callsFake type definition

v6.0.0

BREAKING CHANGES

• useSinonSandbox() returns a {sandbox, stubLogger}
• this.stub => sandbox.stub
• this.spy => sandbox.spy
• const clock = sandbox.useFakeTimers() to mock time
• this.stubTime() => clock.setSystemTime()
• this.stubLogger() => stubLogger()
• sinon.match() => sandbox.match()
• sinon no longer exported. Use sandbox from {useSinonSandbox} instead

5.1.3

• Fix flowtype definitions

5.1.2

• Add missing chai, chai-enzyme assertions to flowtype

5.1.1

• Fix path to Sinon in browser environments

5.0.0

BREAKING CHANGES

• this.stubLogger({logger}) => this.stubLogger(logger)

4.0.0

BREAKING CHANGES

• Remove support for babel-nodeing a test file - No more import side-effects. Always run tests via npm script. Simplifies interface and enforces single standard for running tests.
• Export all helpers from index.js - No more reaching into the module (e.g. goodeggs-test-helpers/chai)
• Move ./run_tests.sh from goodeggs-ops-api-test-helpers (previously called api_test.sh) - so we can use it for modules too
• Remove withContext() - prefer mocha's beforeEach instead
• Remove given() - prefer mocha's describe or context instead
• Explicitly define sinon sandboxes via useSinonSandbox() - No more import side effects. See which hooks are configured at the top of each test file. This also means that the clock is no longer stubbed be default.
• Move stubLogger from goodeggs-ops-api-test-helpers - so all sinon sandboxing is centralized and so we can delete goodeggs-ops-api-test-helpers
• Remove chai-json-schema - almost never used!
• Bump to latest version of all dependencies (including chai and mocha)
• Remove this.assert and this.expect - import explicitly from goodeggs-test-helpers instead

3.0.0

• bumps from version 1.14.1 to 4.1.6 of Sinon. We now have access to stub.callsFake to change the implementation of a stub on the fly.

BREAKING CHANGES

Sinon APIs for:

• sinon.stub
• sinon.useFakeTimers
• sinon.sandbox
• stub.reset

have changed subtly (but for the better). Look at the Sinon.js changelog (2.0, 3.0, and 4.0) for details.