Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/didi/thrift-mock
A lightweight java test library for mocking thrift server
https://github.com/didi/thrift-mock
java mock server testing-tools thrift unit-test
Last synced: 2 months ago
JSON representation
A lightweight java test library for mocking thrift server
- Host: GitHub
- URL: https://github.com/didi/thrift-mock
- Owner: didi
- License: apache-2.0
- Created: 2019-01-24T04:29:28.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-12T21:58:02.000Z (almost 4 years ago)
- Last Synced: 2024-08-03T17:21:24.230Z (6 months ago)
- Topics: java, mock, server, testing-tools, thrift, unit-test
- Language: Java
- Homepage:
- Size: 97.7 KB
- Stars: 92
- Watchers: 11
- Forks: 30
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# thrift-mock
[](https://app.codacy.com/app/YORYOR/thrift-mock?utm_source=github.com&utm_medium=referral&utm_content=didi/thrift-mock&utm_campaign=Badge_Grade_Dashboard)
A lightweight java unit test library for mocking thrift service
## Features
* Init thrift mock server without any pre-define thrift idl, only a port is needed
* Dynamic binding thrift interface to its response
* Configurable response delays
* Support binding different interfaces from different thrift service to one server
* Embedded with junit4
* Support both blocking and non-blocking call
## Getting Started
### 1. import maven dependency
working with junit
```xml
com.didiglobal.thriftmock
thrift-mock-server4junit
1.0.2
```
working without junit
```xml
com.didiglobal.thriftmock
thrift-mock-server
1.0.2
```
thrift test source
```xml
com.didiglobal.thriftmock
thrift-mock-server
1.0.2
```
### 2. start server
```java
//working without junit, blocking server
ThriftMockServer server = new ThriftMockServer(9999);
Thread t = new Thread(server::start);
t.start();
//working without junit, starting a non-blocking server
AsyncThriftMockServer server = new AsyncThriftMockServer(9999);
Thread t = new Thread(server::start);
t.start();
//working with junit
//blocking server
@Rule
public ThriftMockServer server = new ThriftMockServer(9999);
//non-blocking server
@Rule
public AsyncThriftMockServer server = new AsyncThriftMockServer(9999);
```
### 3. bind interface with expect response
If you have a thrift file like this:
```thrift
namespace java com.xiaoju.ddpay.thriftmock.server
struct Request{
1:optional string msg,
}
struct Response{
1:required i32 code,
2:required string responseMsg,
}
service HelloService {
Response sayHello(1:required Request request);
}
service ByeService {
Response sayBye(1:required Request request);
}
```
#### 3.1 bind interface to fixed response
```java
//define expect response
Response expectHelloResponse = new Response(200, "hello");
//bind response
server.setExpectReturn("sayHello", expectHelloResponse);
//bind response with specific delay(ms)
server.setExpectReturn("sayHello", expectHelloResponse, 100);
```
#### 3.2 bind interface to dynamic response
```java
//bind interface to dynamic response
TBase emptyArgs = new HelloService.sayHello_args();
Function returnLogic = (tBase) -> {
HelloService.sayHello_args sayHello_args = (HelloService.sayHello_args)tBase;
if (sayHello_args.getRequest().getMsg().contains("fail")) {
return new Response(500, "fail");
}
return new Response(200, "success");
};
server.setExpectReturn("sayHello", emptyArgs, returnLogic);
```
#### 3.3 request server
```java
//init a thrift client connect to mock server
TTransport transport = new TSocket("127.0.0.1", 9999);
transport.open();
TProtocol protocol = new TBinaryProtocol(transport);
HelloService.Iface client = new HelloService.Client(protocol);
//request interface sayHello
Response msg = client.sayHello(request);
//get the expect response
Assert.assertEquals(msg.getCode(), 200);
Assert.assertEquals(msg.getMsg(), "hello");
```
## Todo
* make it work like wiremock to test thrift service.
## Contributing
Welcome to contribute by creating issues or sending pull requests. See [Contributing Guide](./CONTRIBUTING.md) for guidelines.
## License
thrift-mock is licensed under the Apache License 2.0. See the [LICENSE](./LICENSE) file.
## Note
This is not an official Didi product (experimental or otherwise), it is just code that happens to be owned by Didi.