1 Star 0 Fork 1

pengyu / httptester

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

近来有需求要对HTTP接口进行压测,于是去了解了一下JMeter,发现虽然功能强大,但本身依赖JAVA,并且依赖图形化界面,不够轻量化,所以想着自己写一个基于命令行的轻量级压测工具,于是就有了httptester。

httptester是采用GO语言来编写的,尽管目前仍是早期版本,但是基本功能已经没有问题了。

快速开始

httptester是一个二进制可执行文件,无需安装。

下载最新版本:https://github.com/rocketk/httptester/releases

找到自己平台对应的版本下载至本地,将其所在目录放入系统环境变量中。

常用命令

获取帮助信息

httptester -h
httptester run -h
httptester serve -h

最简单的压测命令(以压测百度首页为例)

httptester run -u 'https://www.baidu.com/'

设定并发量、循环次数、超时时间

httptester run --loop 10 --concurrency 100 --timeout 500ms -u 'https://www.baidu.com/'
#httptester run --loop 10 --concurrency 100 --timeout 2s -u 'https://www.baidu.com/'

结果

 100% [==============================]
-- Configuration --
Concurrency: 100	Loop: 10	Timeout: 2000 ms	KeepAlive: true	TimeUnit: ms	Method: GET	URL: https://www.baidu.com/
Headers: []
Body:

-- Conclusion --
total count: 1000
success count: 981
failed count: 0
error count: 19
nature duration: 2280 ms
total cost: 195688 ms
max: 1539 ms
min: 0 ms
median: 110 ms
mean: 195 ms
standard deviation: 248.309631
throughput: 430 requests/second
字段 含义
total count 总共的http请求数量,等于loop*concurrency
success count 总共成功的http请求数量
failed count 失败的请求数量,不同于 error count ,只有被【断言】校验不通过的才算失败
error count 错误数量,一般是超时或http接口不可用
nature duration 自然耗时(区别于下面的总体耗时)
total cost 总体耗时,每个请求的耗时加总起来的总耗时,在并发情况下会大于自然耗时
max 最大单次请求耗时
min 最小单次请求耗时
median 单次请求耗时中位数
mean 平均每次请求耗时
standard deviation 每次请求耗时标准差
throughput 吞吐量,数值等于 success_count / nature_duration

启动示例服务

为了更好地测试各种Assertion表达式,你可以通过以下命令启动一个Restful风格的API服务:

httptester serve 
#httptester serve --

此示例服务是一个典型的Restful风格的API服务,包含以下操作(以curl命令为例):

列出全部用户

curl http://localhost:1234/users

增加一个新用户

curl -X POST \
 -d '{"name":"NewUser","age":18,"stature":175,"weight":60,"available":true}' \
 'http://localhost:1234/users'

更新一个已有用户

curl -X PUT \
 -d '{"name":"NewUser","age":18,"stature":175,"weight":60,"available":true}' \
 'http://localhost:1234/users/{id}'

注意将{id}改为实际的用户id

删除一个已有用户

curl -X DELETE 'http://localhost:1234/users/{id}

Assertion

在默认情况下,httptester并不会做断言检测,也就是说只要http请求得到了响应,不论其返回的响应是什么,不论响应码是什么,都会按照成功来计算。但很多情况下,你需要判断其结果是否正确。

当前版本的httptester支持3种断言,即 响应码断言 / JSON断言 / 正则表达式断言

以上一节Restful-API服务接口中的“列出所有用户”为例,curl格式如下:

curl -i http://localhost:1234/users

返回结果:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sat, 13 Mar 2021 13:28:48 GMT
Content-Length: 459

[
  {
    "age" : 18,
    "id" : "732e930c-59ce-4087-b509-6288b5d2d6c5",
    "stature" : 180,
    "weight" : 62.5,
    "name" : "Jack",
    "available" : true
  },
  {
    "age" : 25,
    "id" : "30160f4c-a4ee-420b-ba61-fb0f78a3e312",
    "stature" : 175,
    "weight" : 60.5,
    "name" : "Mary",
    "available" : true
  },
  {
    "age" : 32,
    "id" : "04c7aca2-c27b-4ff1-8756-1bdf57ab7993",
    "stature" : 185,
    "weight" : 65,
    "name" : "Benjamin",
    "available" : true
  },
  {
    "age" : 15,
    "id" : "51784d48-4abd-4f01-83df-4cd43869027c",
    "stature" : 160,
    "weight" : 50.799999999999997,
    "name" : "Lee",
    "available" : false
  }
]

接下来我们来看在httptester中如何来写断言。

响应码断言

使用--assert-status-codes来设定响应码断言,下面的例子表示,只有当http响应码为200201时才算请求成功

httptester run -u 'http://localhost:1234/users' \
  -c 100 -l 100 \
  --assert-status-codes '200 201' 

JSON断言

此次我们使用“新增一个用户”为例,它的返回值如下:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 12 Mar 2021 07:01:50 GMT
Content-Length: 116

{"id":"ddb6b9fe-f0af-40ef-8b44-90e5b150b3ac","name":"NewUser","age":18,"stature":175,"weight":60.5,"available":true}

假设我们认为返回值中的name值要等于NewUser,那么我可以使用--assert-json-expression来达到这一目的。注意双等号两侧的空格是必须的。

httptester run --method POST -u 'http://localhost:1234/users' \
  -b '{"name":"NewUser","age":18,"stature":175,"weight":60,"available":true}' \
  -c 100 -l 100 \
  --assert-json-expression '$.name == NewUser'

更为复杂的例子

添加header 设定method 添加body 添加timeout

httptester run --method 'POST' -u 'http://localhost:1234/users' \
  -H 'Content-Type:application/json' \
  -H 'accept:application/json' \
  -b '{"name":"NewUser","age":18,"stature":175,"weight":60,"available":true}' \
  --timeout 2s \
  --loop 100 \
  --concurrency 100 \
  --assert-status-codes '200 201' \
  --assert-json-expression '$.name == NewUser'
  -e

-e表示如果出现失败或报错,将错误信息打印出来


如果对这个小工具感兴趣,欢迎给我点赞。 如果有任何问题或建议,也欢迎给在此项目中给我提issue或者pull request。

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

用Golang实现的一个轻量级http压测工具,尽管目前处于早期版本,但基本的功能已经具备,包括设置并发、循环次数,https,支持多种断言检测(响应码断言、json断言、正则断言)。能够计算出一个接口在各种并发条件下的吞吐量、正确率、响应时间的平均值、方差、中位数等。 本项目在Github上的地址: https://github.com/rocketk/httptester 展开 收起
Go
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/rocketk/httptester.git
git@gitee.com:rocketk/httptester.git
rocketk
httptester
httptester
main

搜索帮助