Commercetools Mocking library for Node

This library mocks the Commercetools rest api to ease testing of your typescript codebases interacting with the commercetools api. It uses the same proven approach as our testing module in the commercetools Python SDK.

Installation

yarn add --dev @labdigital/commercetools-mock

Docker image

This codebase is also available as a docker image where it provides a runnable http server exposing the mocked endpoints. See https://github.com/labd/commercetools-mock-server

Example

import { CommercetoolsMock, getBaseResourceProperties } from '@labdigital/commercetools-mock'

const ctMock = new CommercetoolsMock({
  apiHost: 'https://localhost',
  authHost: 'https://localhost',
  enableAuthentication: false,
  validateCredentials: false,
  defaultProjectKey: 'my-project',
  silent: true,
})

describe('A module', () => {
  beforeAll(() => {
    ctMock.start()

    ctMock.project().add('type', {
      ...getBaseResourceProperties()
      key: 'my-customt-type',
      fieldDefinitions: [],
    })
  })

  afterAll(() => {
    ctMock.stop()
  })

  afterEach(() => {
    ctMock.clear()
  })

  test('my function', async () => {
    ctMock.project().add('customer', customerFixture)

    const res = await myFunction()

    expect(res).toEqual(true)
  })
})

Adding a resource

Implement the following:

• New repository in src/repositories
• New service in src/services
• Add new service to src/ctMock.ts ctMock._services
• Add new service to src/storage.ts InMemoryStorage
• Adjust src/types.ts RepositoryMap and possibly serviceTypes

Releasing

This codebases use @changesets for release and version management

• Create a new changeset using pnpm changeset
• Push the changes to the main branch.
• GitHub actions will create a release PR. When the release is ready merge the release branch