fossabot/grpc-man

A client to call gRPC server methods on the fly. 一个 gRPC 客户端，可以灵活地调用 gRPC 服务。

grpc-man

A client to call gRPC server methods on the fly. 一个 gRPC 客户端，可以灵活地调用 gRPC 服务。

名字灵感来源于 post-man。

有什么用？

本包提供了一个轻量级的 gRPC 客户端实现，可以用来快速验证你的 gRPC 服务是否正确工作。

当然，它只提供了连接 gRPC 服务的方法，具体运行结果需要自行写代码验证。

作者在实际项目中使用 Mocha 测试框架，也非常推荐你使用它。后面会有在 Mocha 框架中使用此包的示例代码。

当然，你也可以在别的测试框架中使用本包，比如本项目自身使用了 jest（jest 很优秀，但实际使用下来，我感觉不如 Mocha 快）。

安装:

# 如果你想全局运行:
npm install -g grpc-man

# 如果你想在项目的测试代码里使用它:
npm install --save-dev grpc-man

用在 javascript 项目里：

import GrpcClient from 'grpc-man/lib/Client';

async function main() {
  const client = new GrpcClient('<yourhost>:<your port>', __dirname + 'your.proto');

  await client.grpc.youpackage.YourService.yourMethod(arg);
}

用在测试里:

如果你的项目使用 gRPC 为客户提供服务，那么在你的项目的自动化测试中，你可以用它来帮助调用你的 gRPC 服务:

mocha 示例

示例用到的 proto 文件在这里。

import assert = require('assert');
import GrpcClient from 'grpc-man/lib/Client';

describe('grpc', () => {
  it('可以打招呼', async () => {
    const client = new Client('0.0.0.0:8899', __dirname + '/./proto/helloworld.proto');

    const res = await client.grpc.helloworld.Greeter.sayHello({ name: 'name' });
    assert.deepEqual(res, { message: 'Hello name' });
  });
});

如果你采用 jest 测试框架，那么可以参考本包的测试代码。

命令行使用

grpc-man <endpoint> <protoFilePath>

# for example:
grpc-man localhost:8080 /path/to/proto_file

本地运行

npm start <endpoint> <protoFilePath>

# for example:
npm start localhost:8080 /path/to/proto_file

License