recruit-tech / agreed-core Goto Github PK
View Code? Open in Web Editor NEWagreed is Consumer Driven Contract utilities with JSON mock server.
agreed is Consumer Driven Contract utilities with JSON mock server.
my agreed.js is here.
const { resolve } = require('path')
const { readFileSync } = require('fs')
const content = readFileSync(resolve(__dirname, './data.csv'), { encoding: 'utf-8' })
const boundary = '------------------------cafebabe'
const sep = '\r\n'
module.exports = [
{
request: {
path: '/api/csv/import',
method: 'POST',
headers: {
'Content-Type': `multipart/form-data; boundary=${boundary}`,
},
body: [
`--${boundary}`,
'Content-Disposition: form-data; name="file"; filename="data.csv"',
'Content-Type: text/csv; charset=utf-8',
'',
content,
`--${boundary}--`,
].join(sep),
},
response: {
status: 200,
},
}
]
execute client
$ NODE_DEBUG=http agreed-client --host localhost --port 8080 --path ./agreed.js
and debug message
HTTP 17395: call onSocket 0 0
HTTP 17395: createConnection localhost:8080: { servername: 'localhost',
port: 8080,
host: 'localhost',
headers:
{ 'content-type': 'multipart/form-data; boundary=------------------------cafebabe',
'Content-Length': 1099,
'Content-Type': 'application/json' },
method: 'POST',
path: null,
_agentKey: 'localhost:8080:' }
HTTP 17395: sockets localhost:8080: 1
HTTP 17395: write ret = false
HTTP 17395: outgoing message end.
HTTP 17395: AGENT incoming response!
HTTP 17395: AGENT isHeadResponse false
HTTP 17395: AGENT socket.destroySoon()
'content-type' is duplicated.
API Server received request as a 'Content-Type: application/json'.
because, header-key 'Content-Type' mismatch after completion.
https://github.com/recruit-tech/agreed-core/blob/master/lib/client.js#L65
const completedAgrees = this.completion(agrees); // 1. completion
const requests = completedAgrees.map((agree) => {
const setting = this.setup(agree); // 2. setup
return this.createRequest(setting);
});
https://github.com/recruit-tech/agreed-core/blob/master/lib/check/completion.js#L66
agree.request.headers = toLowerCaseKeys(agree.request.headers); // convert lowerKey
https://github.com/recruit-tech/agreed-core/blob/master/lib/client.js#L43
options.headers['Content-Type'] = (agree.request.headers && agree.request.headers['Content-Type']) || 'application/json';
my agreed.js is here. (just copied example)
// save as agreed.js
module.exports = [
{
request: {
path: '/user/:id',
method: 'GET',
query: {
q: '{:someQueryStrings}',
},
values: {
id: 'yosuke',
someQueryStrings: 'foo'
},
},
response: {
headers: {
'x-csrf-token': 'csrf-token',
},
body: {
message: '{:greeting} {:id} {:someQueryStrings}',
images: '{:images}',
themes: '{:themes}',
},
schema: {
type: 'object',
required: [
'messages',
'images',
'themes'
],
properties: {
message: { type: 'number' }, // should fail here
image: { type: 'string' },
themes: {
type: 'array',
items: {
type: 'object',
properties: {
name: { type: 'string' }
}
}
}
}
},
values: {
greeting: 'hello',
images: [
'http://example.com/foo.jpg',
'http://example.com/bar.jpg',
],
themes: {
name: 'green',
},
}
},
},
]
I activated jsonschema to fail on message
, but it works without jsonschema validation.
$ agreed-server --path ./agreed.js --port 3010
$ curl 'http://localhost:3010/user/yosuke?q=foo'
{"message":"hello yosuke foo","images":["http://example.com/foo.jpg","http://example.com/bar.jpg"],"themes":{"name":"green"}}
my agreed.js is here.
module.exports = [
{
request: {
path: '/foo',
method: 'GET',
body: null,
},
response: {
status: 200,
},
}
]
execute client
$ NODE_DEBUG=http agreed-client --host localhost --port 8080 --path ./agreed.js
and debug message
HTTP 17395: call onSocket 0 0
HTTP 17395: createConnection localhost:8080: { servername: 'localhost',
port: 8082,
host: 'localhost',
headers:
{ 'Content-Length': 4,
'Content-Type': 'application/json' },
method: 'GET',
path: null,
_agentKey: 'localhost:8082:' }
HTTP 17395: sockets localhost:8080: 1
HTTP 17395: write ret = false
HTTP 17395: outgoing message end.
HTTP 17395: AGENT incoming response!
HTTP 17395: AGENT isHeadResponse false
HTTP 17395: AGENT socket.destroySoon()
'Content-Length' is 4 and send body "null" as text.
// agreed.js
module.exports = [
{
request: {
path: '/api/sample/:id',
method: 'PUT',
body: [
{value:'test'}
],
values: {
id: 1,
},
},
response: {
status: 204,
},
}]
クライアントテストの実行
$ agreed-client --host localhost --port 8080 --path ./agreed.js
この時、実際のサーバーステータスが200で戻ってきても、テスト結果がOKとなります。
https://github.com/recruit-tech/agreed-client/blob/master/lib/reporter.js#L15
を見る限りではdiffかschemaErrorsのどちらかにデータがあるとfailするようになってますが、この時のresultの中身は
{ body: '', diff: {}, status: [ 204, 200 ] }
となっており、failと判定されません(※isEmpty(result)は、diffが存在するので常にfalseです)。
よって詰め込む側がdiffに入れるかreporter側がstatusの有無を見るかになりますが、単純にclientのcheckResponseの処理でdiffに入れ損ねているように見えます。
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.