README
¶
post-it
post-it is a HTTP(S) testing tool. It is written in Go programming language.
Inspiration taken from https://www.postman.com/ and https://github.com/codesenberg/bombardier
Installation
You can grab binaries in the releases section.
Alternatively, to get latest and greatest run: go get -u github.com/DustyRat/post-it
Usage
post-it is a HTTP(S) CLI library for calling a variaty of urls from an input file.
All methods use the request_body column for requests.
Usage:
post-it [command] <url>
Available Commands:
DELETE The DELETE method deletes the specified resource.
GET The HTTP GET method requests a representation of the specified resource.
HEAD The HEAD method asks for a response identical to that of a GET request, but without the response body.
PATCH The PATCH method is used to apply partial modifications to a resource.
POST The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server.
PUT The PUT method replaces all current representations of the target resource with the request payload.
help Help about any command
Flags:
-c, --connections int Concurrent connections (default 10)
-e, --errors Record erorrs to output file
-H, --header stringArray HTTP headers to use ("K: V")
-h, --help help for post-it
-g, --histogram Print histogram statistics
-i, --input string Input File (default "input.csv")
--insecure Insecure Skip Verify (default true)
-l, --latencies Print latency statistics
-o, --output string Output File (default "output.csv")
-b, --record-body Record body to output file under the response_body column.
--record-headers Record headers to output file under the headers column.
-s, --response-status string Record response status to output file under the headers status. eg: any, none, 2xx, -2xx (non 2xx statuses), 4xx, 5xx, 200, 301, 404, 503... (default "-2xx")
-t, --timeout duration Connection timeout (default 3s)
Use "post-it [command] --help" for more information about a command.
URL Pattern
THe URL argumant uses {SOME_NAME} to take columns from the input csv file and replce them.
ex:
URL: http://localhost:3000/{column_1}/path/{column_3}/{column_2}
Sample Input File > Parsed URL:
column_1,column_2,column_3
1,6,2 > http://localhost:3000/1/path/2/6
2,48,HELLO > http://localhost:3000/2/path/HELLO/48
3,5,21 > http://localhost:3000/3/path/21/5
Examples
Basic:
Simple STD output. Any non 2xx responses will be saved in output.csv. Uses default input file 'input.csv'
post-it GET "http://localhost:3000/get/{id}"
Sample Input File:
id
1
2
3
4
5
...
STDOUT:
10 / 10 [=====================================] complete 12.5/s Elapsed: 0s
Responses
OK: 200 |
10 |
Statistics
| Average | STDDEV | Max
Req/sec | 12.49 | NA | NA
Latency | 497.95ms | 246.37ms | 799.77ms
File Output (output.csv):
id,status,error
Input:
Uses './test/input.csv' as input file
post-it GET "http://localhost:3000/get/{id}" -i ./test/input.csv
Sample Input File:
id
1
2
3
4
5
...
STDOUT:
10 / 10 [=====================================] complete 10.4/s Elapsed: 0s
Responses
OK: 200 |
10 |
Statistics
| Average | STDDEV | Max
Req/sec | 10.41 | NA | NA
Latency | 599.45ms | 294.34ms | 959.44ms
Sample Input File:
id
1
2
3
4
5
...
File Output (output.csv):
id,status,error
Output:
Outputs request results to './results.csv'
post-it GET "http://localhost:3000/get/{id}" -o ./results.csv
STDOUT:
10 / 10 [=====================================] complete 9.5/s Elapsed: 1s
Responses
OK: 200 |
10 |
Statistics
| Average | STDDEV | Max
Req/sec | 9.51 | NA | NA
Latency | 597.58ms | 341.38ms | 1.05s
Sample Input File:
id
1
2
3
4
5
...
File Output (results.csv):
id,status,error
Status:
Outputs 2xx request results to './output.csv'
post-it GET "http://localhost:3000/get/{id}" -s 2xx
STDOUT:
10 / 10 [=====================================] complete 11.5/s Elapsed: 0s
Responses
OK: 200 | Not Found: 404 |
9 | 1 |
Statistics
| Average | STDDEV | Max
Req/sec | 11.51 | NA | NA
Latency | 531.55ms | 251.08ms | 868.61ms
Sample Input File:
id
1
2
3
4
5
...
File Output (output.csv):
id,status,error
7,200,
6,200,
4,200,
...
Errors Only:
Output only client errors to './output.csv'
post-it GET "http://localhost:3000/get/{id}" -e -s none
Sample Input File:
id
1
2
3
4
5
...
STDOUT:
10 / 10 [=====================================] complete 1810.6/s Elapsed: 0s
Responses
Errors |
10 |
Statistics
| Average | STDDEV | Max
Req/sec | 0.00 | NA | NA
Latency | 0s | 0s | 0s
File Output (output.csv):
id,status,error
1,0,dial tcp [::1]:3000: connect: connection refused
2,0,read tcp 127.0.0.1:54245->127.0.0.1:3000: read: connection reset by peer
3,0,EOF
...
Response Body:
Output record response bodies to './output.csv'
post-it GET "http://localhost:3000/get/{id}" -b -s any
Sample Input File:
id
1
2
3
4
5
...
STDOUT:
10 / 10 [=====================================] complete 12.4/s Elapsed: 0s
Responses
OK: 200 |
10 |
Statistics
| Average | STDDEV | Max
Req/sec | 12.43 | NA | NA
Latency | 500.21ms | 247.6ms | 804.17ms
File Output (output.csv):
id,status,response_body,error
1,200,"{""id"":""1"",""string"":""asdf safasdf asdf""...,
3,200,"{""id"":""3"",""string"":""asdf safasdf asdf""...,
9,200,"{""id"":""9"",""string"":""asdf safasdf asdf""...,
8,200,"{""id"":""8"",""string"":""asdf safasdf asdf""...,
...
Response Headers:
Output record response bodies to './output.csv'
post-it GET "http://localhost:3000/get/{id}" --record-headers -s any
Sample Input File:
id
1
2
3
4
5
...
STDOUT:
10 / 10 [=====================================] complete 10.5/s Elapsed: 0s
Responses
OK: 200 |
10 |
Statistics
| Average | STDDEV | Max
Req/sec | 10.51 | NA | NA
Latency | 599.2ms | 294.25ms | 950.44ms
File Output (output.csv):
id,status,headers,error
4,200,"Content-Length: 371; Content-Type: application/json; Vary: Origin;",
1,200,"Content-Length: 371; Content-Type: application/json; Vary: Origin;",
7,200,"Content-Length: 369; Content-Type: application/json; Vary: Origin;",
2,200,"Content-Length: 371; Content-Type: application/json; Vary: Origin;",
...
Latency & Historgram:
post-it GET "http://localhost:3000/get/{id}" -lg
Sample Input File:
id
1
2
3
4
5
...
STDOUT:
10 / 10 [=====================================] complete 9.8/s Elapsed: 1s
Responses
OK: 200 |
10 |
Statistics
| Average | STDDEV | Max
Req/sec | 9.84 | NA | NA
Latency | 580.18ms | 292.9ms | 1.02s
Latency Distibution
50.00% | 515.75ms
75.00% | 870.99ms
90.00% | 894.22ms
95.00% | 1.02s
99.00% | 1.02s
Histogram
Bucket | Count
1ms | 0
2.5ms | 0
5ms | 0
7.5ms | 0
10ms | 0
25ms | 0
50ms | 0
75ms | 1
100ms | 0
250ms | 3
500ms | 2
750ms | 3
1s | 1
2.5s | 0
5s | 0
7.5s | 0
10s | 0
Inf+ | 0
Licensing
"The code in this project is licensed under MIT license."
Documentation
¶
Overview ¶
MIT License
Copyright (c) 2020 Dustin Ratcliffe ¶
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.
Source Files
Directories