https://github.com/knightliao/pfrock

pfrock

A plugin-based server for running fake HTTP and socket services (especially SOA service) using Python.

   _ (`-.            _  .-')                          .-. .-')
  ( (OO  )          ( ( -O )                           ( OO )
 _.`        ,------.,------.  .-'),-----.    .-----. ,--. ,--.
(__...--''('-| _.---'|   /`. '( OO'  .-.  '  '  .--./ |  .'   /
 |  /  | |(OO|(_    |  /  | |/   |  | |  |  |  |('-. |      /,
 |  |_.' |/  |  '--. |  |_.' |_) |  ||  | /_) |OO  )|     ' _)
 |  .___.'_)|  .--' |  .  '.'   |  | |  | ||  |`-'| |  .   
 |  |       |  |_)  |  |      `'  '-'  '(_'  '--' |  |   
 `--'        `--'    `--' '--'     `-----'    `-----' `--' '--'

requirements

python >=2.7

开发进度

• dev(develop branch): 0.2.5
• master(stable branch)： 0.2.5

English readme

https://github.com/knightliao/pfrock/blob/master/README-en.md

主要目标

• 为微服务架构（ SOA ）而生。
  • 可以 mock 微服务架构（ SOA ）中各式各样的服务接口请求
  • 统一的代理服务入口。通过提供统一的 router 入口, 用户不必一个一个接口的去对接 mock. 统一接入代理服务即可.
• 强大的功能
  • 配置文件式设计，零开发成本
  • 更改配置文件，无须重启，自动生效
  • 输入自定义匹配 url, method(GET/POST/PUT/DELETE/HEAD); 输出自定义 静态文件 /静态目录 /动态 handler/header
• 开放式设计
  • 插件式开发，即插即用, 为可扩展性提供良好支持。目前系统核心已经支持 静态 /动态 /自定义 的 Mock 服务能力
  • 开放性，利用 python 动态能力，可以与各种中间件交互，登录 redis/Q/db/hadoop

也就是说,

• 我们可以随心所欲的对任何 URL, 任何 method 进行 mock.
• 并且可以对不想 mock 的 URL, 还是让他请求原来要请求的服务.

通过此种方式, 我们可以以最低的侵入性, 实现为系统的部分或者全部接口进行 mock.

可用的插件

• pfrock-static-plugin :提供文件式或目录结构的静态数据 mock 服务插件
• pfrock-http-plugin : 提供动态 http 服务请求的 mock 服务插件
• pfrock-proxy-plugin: 提供远程服务的代理服务插件

快速安装

pip install pfrock==0.2.5

(pypi: https://pypi.python.org/pypi/pfrock)

Quick-Start

demo 目录结构

- demo
    - mocks
        - handler
            - hello_world.py
            - __init__.py
        - static
            - a.json
            - b.json
        - __init__.py
    - __init__.py
    - pfrockfile.json        

配置文件

{
    "servers": [
        {
            "port": 8888,
            "routes": [
                {
                    "path": "/api1/(.*)",
                    "handler": "pfrock_static_plugin",
                    "options": {
                        "routes": [
                            {
                                "path": "json",
                                "file": "mocks/static/a.json"
                            },
                            {
                                "dir": "mocks/static"
                            }
                        ]
                    }
                },
                {
                    "path": "/api",
                    "methods": [
                        "GET"
                    ],
                    "handler": "pfrock_http_plugin",
                    "options": {
                        "handler": "mocks.handler.hello_world.HelloWorldHandler",
                        "query": "1!",
                        "pageno": 1
                    }
                },
                {
                    "path": ".*",
                    "methods": "any",
                    "handler": "pfrock_proxy_plugin",
                    "options": {
                        "url": "http://www.sov5.com"
                    }
                }
            ]
        }
    ]
}

启动

➜  pfrock git:(master) ✗
➜  pfrock git:(master) ✗ cd demo
➜  demo git:(master) ✗ pfrockpy
   _ (`-.            _  .-')                          .-. .-')
  ( (OO  )          ( ( -O )                           ( OO )
 _.`        ,------.,------.  .-'),-----.    .-----. ,--. ,--.
(__...--''('-| _.---'|   /`. '( OO'  .-.  '  '  .--./ |  .'   /
 |  /  | |(OO|(_    |  /  | |/   |  | |  |  |  |('-. |      /,
 |  |_.' |/  |  '--. |  |_.' |_) |  ||  | /_) |OO  )|     ' _)
 |  .___.'_)|  .--' |  .  '.'   |  | |  | ||  |`-'| |  .   
 |  |       |  |_)  |  |      `'  '-'  '(_'  '--' |  |   
 `--'        `--'    `--' '--'     `-----'    `-----' `--' '--'
pfrock version 0.2.2
[I 2016-03-04 14:07:05,231 pfrock.core MainThread __init__:19] started server 8888 with autoreload mod

静态文件 json get 请求

➜  ~  curl http://localhost:8888/api1/json
{
  "a": "bddd33e34"
}%

静态文件 json post 请求

➜  ~  curl -X POST -d {} http://localhost:8888/api1/json
{
  "a": "bddd33e34"
}%

静态目录 json get 请求

➜  ~  curl http://localhost:8888/api1/b.json
{
    "b": "bbb"
}%

动态能力 get

➜  ~  curl 'http://localhost:8888/api'
Hello, world 1! 1%                                                                                                                                            ➜  ~

代理能力

那么, 除了上面这些 URL 之外, 没有被匹配的 URL 怎么办? 就用代理到默认的服务器上吧! 这在项目中经常会被用到.

➜  ~  curl 'http://localhost:8888/'

没有匹配到的 URL 自动被 路由到 设定的 域名和端口上.

这里是被路由到 http://www.sov5.com

Tutorial

• Tutorial-0: 目录结构推荐
• Tutorial-1: 静态配置服务能力
• Tutorial-2: 动态 mock 服务能力
• Tutorial-3: 代理服务能力
• Tutorial-4: 统一的 pfrock 服务
• pfrock 命令介绍

more demos

https://github.com/knightliao/pfrock-demos

敏捷开发建议

建议按以下方式进行敏捷开发

• 服务间定好接口
• 使用 pfrock 来提供统一 mock 服务
• 通过 mock 接口，修改配置文件，无须重启 pfrock ，快速进行接口式开发
• 联调过程和测试过程，亦可通过 pfrock 来进行部分接口 mock, 避免部分服务不稳定影响整体服务能力

群·联系·讨论

• pfrock 技术 QQ 群: 545511264
• 搜索引擎推荐：sov5 搜索引擎, 支持谷歌网页搜索和电影搜索
• disconf Distributed Configuration Management Platform(分布式配置管理平台)
• python 论坛推荐：Django 中国社区
• 我的微信： knightliao