shubhendumadhukar/camouflage

Camouflage

镜像概述和主要用途

Camouflage是一款受https://github.com/namshi/mockserver%E5%90%AF%E5%8F%91%E7%9A%84%E6%9C%8D%E5%8A%A1%E8%99%9A%E6%8B%9F%E5%8C%96%E5%B7%A5%E5%85%B7%E3%80%82%E5%AE%83%E9%87%87%E7%94%A8%E6%96%87%E4%BB%B6%E5%BC%8F%E7%AB%AF%E7%82%B9%E9%85%8D%E7%BD%AE%E7%B3%BB%E7%BB%9F%EF%BC%8C%E9%80%9A%E8%BF%87%E5%88%9B%E5%BB%BA%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84%E5%92%8C%E6%A8%A1%E6%8B%9F%E6%96%87%E4%BB%B6%E5%8D%B3%E5%8F%AF%E5%BF%AB%E9%80%9F%E7%94%9F%E6%88%90mock%E7%AB%AF%E7%82%B9%EF%BC%8C%E5%BD%93%E8%B0%83%E7%94%A8%E8%AF%A5%E7%AB%AF%E7%82%B9%E6%97%B6%EF%BC%8C%E7%B3%BB%E7%BB%9F%E4%BC%9A%E5%9F%BA%E4%BA%8E%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E7%94%9F%E6%88%90%E7%9B%B8%E5%BA%94%E5%93%8D%E5%BA%94%E3%80%82%E4%B8%BB%E8%A6%81%E7%94%A8%E4%BA%8E%E5%BC%80%E5%8F%91%E6%B5%8B%E8%AF%95%E9%98%B6%E6%AE%B5%E6%A8%A1%E6%8B%9F%E5%90%8E%E7%AB%AF%E6%9C%8D%E5%8A%A1%EF%BC%8C%E6%94%AF%E6%8C%81HTTP%E3%80%81HTTPS%E3%80%81HTTP2%E3%80%81gRPC%E5%8F%8AWebsockets%E7%AD%89%E5%A4%9A%E7%A7%8D%E5%8D%8F%E8%AE%AE%EF%BC%8C%E5%B8%AE%E5%8A%A9%E5%89%8D%E7%AB%AF%E5%BC%80%E5%8F%91%E3%80%81API%E6%B5%8B%E8%AF%95%E7%8B%AC%E7%AB%8B%E4%BA%8E%E7%9C%9F%E5%AE%9E%E5%90%8E%E7%AB%AF%E6%9C%8D%E5%8A%A1%E8%BF%9B%E8%A1%8C%E3%80%82

核心功能和特性

• 多协议支持：基于文件的HTTP、HTTPS、HTTP2、gRPC和Websockets模拟
• 动态响应：无需编写代码即可生成真实感的动态响应
• 灵活定制：支持部分或完全通过代码定制响应逻辑
• 条件响应：可基于请求参数返回不同响应
• 内置缓存：支持内存缓存和Redis缓存
• 外部数据集成：可从CSV和PostgreSQL等外部数据源获取并处理响应数据
• 延迟模拟：支持模拟网络延迟
• 内置监控：提供服务监控功能
• 备份恢复：内置备份和恢复机制
• 快速启动：通过camouflage init和camouflage restore模块快速搭建环境
• 多环境部署：可部署在独立VM、Docker和Kubernetes
• 文件管理UI：提供文件资源管理器UI，支持远程修改模拟文件

使用场景和适用范围

• 前端开发：在后端服务未就绪时，模拟API响应进行前端开发
• API测试：模拟各种接口场景（成功、失败、异常等）进行测试
• 服务集成测试：隔离依赖服务，验证系统集成逻辑
• 性能测试：模拟高并发场景下的后端响应
• 演示环境：快速搭建演示用的后端服务

使用方法和配置说明

安装与启动

1. 前置条件：安装NodeJS（>v14）
2. 安装Camouflage：

   bash
   npm install -g camouflage-server
   

3. 验证安装：

   bash
   camouflage --version
   

4. 初始化目录：创建空目录并执行

   bash
   camouflage init
   

   该命令会生成基础目录结构，可根据需求修改
5. 启动服务：

   bash
   camouflage --config config.yml
   

配置选项（示例config.yml文件）

yaml
loglevel: info  # 日志级别：info/warn/error/debug
cpus: 1  # 使用的CPU核心数
monitoring:
  port: 5555  # 监控端口
ssl:
  cert: "./certs/server.cert"  # SSL证书路径
  key: "./certs/server.key"  # SSL密钥路径
protocols:
  http:
    enable: true  # 是否启用HTTP
    mocks_dir: "./mocks"  # HTTP模拟文件目录
    port: 8080  # HTTP端口
  https:
    enable: false  # 是否启用HTTPS
    port: 8443  # HTTPS端口
  http2:
    enable: false  # 是否启用HTTP2
    port: 8081  # HTTP2端口
  ws:
    enable: false  # 是否启用Websockets
    mocks_dir: "./ws_mocks"  # WebSockets模拟文件目录
    port: 8082  # WebSockets端口
  grpc:
    enable: false  # 是否启用gRPC
    host: localhost  # gRPC主机
    port: 4312  # gRPC端口
    mocks_dir: "./grpc/mocks"  # gRPC模拟文件目录
    protos_dir: "./grpc/protos"  # gRPC协议文件目录
backup:
  enable: false  # 是否启用备份
  cron: "0 * * * *"  # 备份定时任务（每小时）
cache:
  enable: false  # 是否启用缓存
  ttl_seconds: 300  # 缓存过期时间（秒）
injection:
  enable: false  # 是否启用注入功能
ext_helpers: "./custom_handlebar.json"  # 外部辅助函数文件路径（无需时可移除）
origins:  # 允许的跨域源
  - http://localhost:3000/
  - http://localhost:3001/
  - http://localhost:5000/

创建第一个模拟端点

以创建/hello-world端点为例：

1. 在${MOCKS_DIR}（配置文件中protocols.http.mocks_dir指定的目录，默认为./mocks）下创建目录：

   bash
   mkdir -p ./mocks/hello-world
   

2. 在该目录下创建GET.mock文件：

   bash
   touch ./mocks/hello-world/GET.mock
   

3. 编辑GET.mock文件，添加以下内容：

   HTTP/1.1 200 OK
   X-Custom-Header: Custom-Value
   Content-Type: application/json
   
   {
       "greeting": "Hey! It works!"
   }
   

4. 访问端点：http://localhost:8080/hello-world

Docker部署示例

Docker Run命令

bash
docker run -d \
  -p 8080:8080 \
  -v $(pwd)/mocks:/app/mocks \
  -v $(pwd)/config.yml:/app/config.yml \
  --name camouflage \
  docker.xuanyuan.run/camouflage-server \
  camouflage --config /app/config.yml

Docker Compose配置

yaml
version: '3'
services:
  camouflage:
    image: docker.xuanyuan.run/camouflage-server
    ports:
      - "8080:8080"
      - "5555:5555"  # 监控端口
    volumes:
      - ./mocks:/app/mocks
      - ./config.yml:/app/config.yml
    command: camouflage --config /app/config.yml
    restart: unless-stopped

贡献指南

欢迎通过以下方式贡献：

• 为项目添加星标（🌟）
• 修正文档中的拼写或语法错误
• 提交issue报告bug或请求新功能
• 通过***参与讨论

详细贡献指南请参考https://github.com/testinggospels/camouflage/blob/main/CONTRIBUTING.md%E3%80%82

从源码构建

1. 克隆仓库：

   bash
   git clone https://github.com/testinggospels/camouflage.git
   

2. 切换到develop分支：

   bash
   git checkout develop
   

3. 安装依赖：

   bash
   npm install
   

4. 构建项目：

   bash
   npm build
   

5. 运行：

   bash
   node bin/camouflage.js --config ./config.yml
   

6. 全局安装（可选）：

   bash
   npm pack
   npm install -g camouflage-server-0.0.0-development.tgz
   

许可证

MIT License

Copyright (c) 2021 testinggospels

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.