simple-mock

A boiler plate repo for all of your mocking needs during test automation.

• Based on express and written in TypeScript.
• Example 'user' enpoints are defined in index.ts and use functions imported from users.ts.
• State is held in a json file and can be obtained/deleted via /mock/state.

Initial Setup

• Create .env file by copying and renaming .env.eample.
• Run yarn build.

Local development

NOTE evelated previlages (sudo for mac) required to access state file. State will not save if not used.

• Start live reload session (recommended): sudo yarn start
  • ...OR Start static instance: sudo yarn static
• Confirm by navigation to http://localhost:2000 in a browser.
  • ...OR import and run the Mock.postman_collection.json postman collection.

State

• State is stored in a json file specifed via the STATE_FILE environment variable.
• State can be accessed via the browser at http://localhost:2000/state.

Run via Docker

• Build: docker build . -t [NameOfMock]:[Version] --build-arg _HTTPS_MODE=[Boolean] --build-arg _MOCK_REFERENCE=[NameOfMock] --platform linux/amd64
• Run: docker run -i --rm -p 8080:8080 -p 2000:2000 -v $PWD/state.json:/state.json [NameOfMock]:[Version]

Full example

yarn build
docker build . -t some-mock:1.0 --build-arg _HTTPS_MODE=false --build-arg _MOCK_REFERENCE=SOME_MOCK --platform linux/amd64
docker run -i --rm -p 8080:8080 -p 2000:2000 -v $PWD/state.json:/state.json some-mock:1.0

Run via Docker-Compose

• Run Locally: MOCK_REFERENCE=[NameOfMock] MOCK_VERSION=[Version] docker-compose up --build --force-recreate mock
  • Access API via curl http://localhost:8080/health
  • Logs will be shown in console (unless --detach specified)
  • ctl+c
• ...OR Expose to the internet via Ngrok: MOCK_REFERENCE=[NameOfMock] MOCK_VERSION=[Version] docker-compose up --build --force-recreate ngrok_mock
  • Access API via curl $(docker logs ngrok_mock | xargs)/health
  • Logs access via docker logs -f [NameOfMock]
  • Stop: docker-compose down

Full examples

• Local

MOCK_REFERENCE=some-mock MOCK_VERSION=1.0 docker-compose up --build --force-recreate mock
curl http://localhost:8080/health

• Ngrok (externally accessible)

MOCK_REFERENCE=some-mock MOCK_VERSION=1.0 docker-compose up --build --force-recreate ngrok_mock
curl $(docker logs some-mock | xargs)/health
docker logs -f some-mock

HTTPS

For those situations where your mock needs to be https;

• Obtain your tls.crt and tls.key files (these are often mounted secrets in kubernetes).
• Mount or copy them to /dist/certs within your container.
  • More details
• Set HTTPS_MODE env var to "true".