https://github.com/asyrjasalo/dockoon

HTTP API virtualisation on Azure Container Instances & API Management
https://github.com/asyrjasalo/dockoon

azure bicep docker mockoon service-virtualization

Last synced: 19 days ago
JSON representation

HTTP API virtualisation on Azure Container Instances & API Management

• Host: GitHub
• URL: https://github.com/asyrjasalo/dockoon
• Owner: asyrjasalo
• Created: 2020-12-24T18:49:02.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-08-06T02:38:09.000Z (over 3 years ago)
• Last Synced: 2024-10-19T10:44:40.269Z (2 months ago)
• Topics: azure, bicep, docker, mockoon, service-virtualization
• Language: Bicep
• Homepage: https://hub.docker.com/r/asyrjasalo/mockoon
• Size: 1.36 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# dockoon

[![Docker pulls](https://img.shields.io/docker/pulls/asyrjasalo/mockoon)](https://hub.docker.com/r/asyrjasalo/mockoon)

[The Docker images](https://hub.docker.com/r/asyrjasalo/mockoon) include:

- Alpine Linux (`mockoon:alpine`) or Debian Buster (`mockoon:slimbuster`) base

- Node.js 14 running as non-root user

- Latest [@mockoon/cli](https://www.npmjs.com/package/@mockoon/cli)

## Prerequisites

Install development dependencies:

    brew bundle

If casks are not available for your OS, you can download and install Mockoon

[from the official page](https://mockoon.com/#download).

## Usage

Build and run proxy to [jsonplaceholder](https://jsonplaceholder.typicode.com/)

at [:8080](https://localhost:8080) from `Dockerfile`:

    ./dockoon

Use Mockoon GUI to edit `apis.json` copied to the image and re-run the script.

Or fetch `apis.json` over the wire as any `mockoon-cli` arguments are accepted:

    ./dockoon start --data https://file-server/apis.json --index 0 --port 8080

### Customizing Docker environment

Pass variable `BUILD_ARGS` to include additional `docker build` arguments:

    BUILD_ARGS="--build-arg FROM_IMAGE=asyrjasalo/mockoon:slimbuster" \

      ./dockoon

Pass variable `RUN_ARGS` to include additional `docker run` arguments:

    RUN_ARGS="-d -p 4000:4000" \

      ./dockoon start --data apis.json --name jsonplaceholder --port 4000

## Cloud deployment

See [bicep/README.md](bicep/README.md) for deploying to Azure Container

Instances hosted behind an API Management service.

## Contributing

On Git commit, hooks in `.pre-commit-config.yaml` will be installed and run.

### CI/CD

The [Azure DevOps pipeline](https://dev.azure.com/asyrjasalo/dockoon/_build) 

implements the steps documented below (building and pushing the base images)

as well as cloud deployment to Azure documented in

[bicep/README.md](bicep/README.md).

### Building a base image

Alpine Linux:

    docker/build_and_test_image

If succeeded the container will run and output `mockoon-cli` version.

Pass variable `BUILD_ARGS` to override the default `docker build` arguments.

Pass `IMAGE_KIND` to build on non-Alpine Dockerfile. For Debian Buster (slim):

    IMAGE_KIND=slimbuster \

      docker/build_and_test_image

Pass `BUILD_DIR` to override the dir path where `Dockerfile.IMAGE_KIND` is in.

### Pushing the base image

Run `docker login` before running the scripts.

Push the image to your private Docker registry:

    REGISTRY_URL=https://your.azurecr.io \

      docker/tag_and_push_image

Tag and push the image `mockoon:alpine` to [Docker Hub](https://hub.docker.com):

    REGISTRY_URL="$USER" \

      docker/tag_and_push_image

If Debian image was built instead, tag and push the image `mockoon:slimbuster`:

    REGISTRY_URL="$USER" \

    IMAGE_KIND=slimbuster \

      docker/tag_and_push_image