Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/labd/commercetools-node-mock
Mock for the commercetools rest api
https://github.com/labd/commercetools-node-mock
commercetools testing
Last synced: about 11 hours ago
JSON representation
Mock for the commercetools rest api
- Host: GitHub
- URL: https://github.com/labd/commercetools-node-mock
- Owner: labd
- License: mit
- Created: 2021-04-05T07:54:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T15:54:45.000Z (2 days ago)
- Last Synced: 2024-11-06T16:46:41.399Z (2 days ago)
- Topics: commercetools, testing
- Language: TypeScript
- Homepage:
- Size: 3.35 MB
- Stars: 20
- Watchers: 8
- Forks: 17
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Commercetools Mocking library for Node
[
](https://www.npmjs.com/package/@labdigital/commercetools-mock)
[](https://codecov.io/gh/labd/commercetools-node-mock)
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](https://github.com/labd/commercetools-python-sdk/tree/main/src/commercetools/testing).
Since version 2 of this library it is based on [msw](https://mswjs.io/) instead
of nock. It is now therefore als recommended to manage the msw server yourself
and use the `registerHandlers` method to register the handlers on this server.
This allows you to use the same server for mocking other API's as well.
## Installation
```bash
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://hub.docker.com/r/labdigital/commercetools-mock-server
## Example
```typescript
import { CommercetoolsMock, getBaseResourceProperties } from '@labdigital/commercetools-mock'
import { setupServer } from 'msw/node'
const ctMock = new CommercetoolsMock({
apiHost: 'https://localhost',
authHost: 'https://localhost',
enableAuthentication: false,
validateCredentials: false,
defaultProjectKey: 'my-project',
silent: true,
})
describe('A module', () => {
const mswServer = setupServer()
beforeAll(() => {
mswServer.listen({ onUnhandledRequest: "error" })
})
beforeEach(() => {
ctMock.registerHandlers(mswServer)
ctMock.project().add('type', {
...getBaseResourceProperties()
key: 'my-customt-type',
fieldDefinitions: [],
})
})
afterAll(() => {
mswServer.close()
})
afterEach(() => {
server.clearHandlers()
ctMock.clear()
})
test('my function', async () => {
ctMock.project().add('customer', customerFixture)
const res = await myFunction()
expect(res).toEqual(true)
})
})
```
## Contributing
This codebases use [@changesets](https://github.com/changesets/changesets) for release and version management
- Create a feature branch with new features / fixes (see [Adding a new service](#adding-a-service))
- When your code changes are complete, add a changeset file to your feature branch using `pnpm changeset`
- Create a PR to request your changes to be merged to main
- After your PR is merged, GitHub actions will create a release PR or add your changeset to an existing release PR
- When the release is ready merge the release branch. A new version will be released
### Adding a new service {#adding-a-service}
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