Skip to content

Commit

Permalink
docs: update readme, change drive code name to UDF
Browse files Browse the repository at this point in the history
  • Loading branch information
trumpchifan committed Jan 11, 2025
1 parent 635a54f commit d0254ae
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 25 deletions.
41 changes: 21 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,30 @@
[![LICENSE](https://img.shields.io/github/license/HttpRunner/FasterRunner.svg)](https://github.com/HttpRunner/FasterRunner/blob/master/LICENSE)
# FasterRunner
- [X] 支持同步YAPI(Swagger,Postman),无需手动录入接口
- [X] 继承 Requests 的全部特性,轻松实现 HTTP(S) 的各种测试需求
- [X] 借助驱动代码(debugtalk.py),在测试脚本中轻松实现请求参数签名,加密和解密响应等
- [X] 支持完善的 hook 机制,通过请求前置和后置函数,完美解决单接口的token依赖和多个接口的参数传递
- [X] 类crontab的定时任务, 无需额外学习成本
- [X] 测试用例支持参数化和数据驱动机制
- [X] Gitlab-CI, Jenkins 等持续集成工具完美结合
- [X] 测试结果统计报告简洁清晰,附带详尽统计信息和日志记录
- [X] 测试报告推送飞书,钉钉,企业微信等

![](https://cdn.jsdelivr.net/gh/lihuacai168/images/img/project_detail.png)
🚀 让接口测试更简单,让自动化更快速!

- [X] 🚀 **落地实战** - 已在 5+ 个公司中落地实战,效果显著
- [X] 🔄 **无缝同步** - 支持一键同步 YAPI(Swagger,Postman)接口数据,告别手动录入的繁琐
- [X] 💪 **强大引擎** - 基于Pythone3 + Requests 打造,轻松应对各类 HTTP(S) 测试场景,稳定可靠
- [X] 🔐 **灵活扩展** - 通过 debugtalk.py 自定义函数,轻松实现接口签名、加解密等自定义功能
- [X] 🎯 **完美联动** - 强大的 hook 机制,优雅处理接口间的token依赖和参数传递,打通测试全流程
- [X]**智能调度** - 内置 crontab 定时任务,无学习成本,帮你实现自动化监控
- [X] 📊 **数据驱动** - 支持测试用例参数化,释放测试人员生产力
- [X] 🔄 **持续集成** - 完美对接 Gitlab-CI、Jenkins 等CI工具,助力研发效能提升
- [X] 📈 **清晰报告** - 简洁美观的测试报告,包含详尽的统计信息和日志记录,一目了然
- [X] 📱 **即时通知** - 自动推送测试报告至飞书、钉钉、企业微信,随时掌握测试动态

![](https://cdn.jsdelivr.net/gh/lihuacai168/images/img/project_detail.png)

# 注意
# ⚠️ 注意
> python版本需要>=3.9
>
> 3.9, 3.10和3.11都经过测试
# 文档
# 📚 文档
- 使用文档 https://www.yuque.com/lihuacai/fasterunner

# Quick Start
# 🚀 Quick Start

## 拉取代码和启动服务
```shell
Expand All @@ -48,24 +51,22 @@ http://你的ip/fastrunner/login
密码:test2020
```

# Dev
# 💻 Dev
- [Django原生部署](https://www.jianshu.com/p/e26ccc21ddf2)

# uWSGI
# 🔧 uWSGI
- [uWSGI+Nginx+Supervisor+Python虚拟环境部署](https://www.jianshu.com/p/577a966b0998)

# Star History
# Star History

![Star History Chart](https://api.star-history.com/svg?repos=lihuacai168/AnotherFasterRunner&type=Date)



# 贡献者
# 👥 贡献者
<a href="https://github.com/lihuacai168/AnotherFasterRunner/graphs/contributors">
<img src="https://contrib.rocks/image?repo=lihuacai168/AnotherFasterRunner" />
</a>

# 鸣谢
# 🙏 鸣谢

感谢 JetBrains 对开源项目的支持

Expand Down
2 changes: 1 addition & 1 deletion fastrunner/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ class Meta:

class DebugTalkSerializer(serializers.ModelSerializer):
"""
驱动代码序列化
自定义函数序列化
"""

class Meta:
Expand Down
2 changes: 1 addition & 1 deletion fastrunner/utils/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ def parse_tests(testcases, debugtalk, name=None, config=None, project=None):
for variables in config["variables"]:
variables_mapping.update(variables)

# 驱动代码中的所有函数
# 自定义函数中的所有函数
functions_mapping = debugtalk.get("functions", {})

# 替换extract,validate中的变量和函数,只对value有效,key无效
Expand Down
2 changes: 1 addition & 1 deletion fastrunner/utils/runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def run(self):
os.chdir(self.temp)
file_path = os.path.join(self.temp, "debugtalk.py")
loader.FileLoader.dump_python_file(file_path, self.__code)
# 修复驱动代码运行时,找不到内置httprunner包
# 修复自定义函数运行时,找不到内置httprunner包
run_path = [BASE_DIR]
run_path.extend(sys.path)
env = {"PYTHONPATH": ":".join(run_path)}
Expand Down
2 changes: 1 addition & 1 deletion web/src/pages/home/components/Side.vue
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export default {
{name: "测试用例", url: "AutoTest", icon: 'el-icon-s-operation'},
{name: "配置管理", url: "RecordConfig", icon: 'el-icon-s-tools'},
{name: "全局变量", url: "GlobalEnv", icon: 'el-icon-s-custom'},
{name: "驱动代码", url: "DebugTalk", icon: 'el-icon-s-platform'},
{name: "自定义函数", url: "DebugTalk", icon: 'el-icon-s-platform'},
{name: "定时任务", url: "Task", icon: 'el-icon-timer'},
{name: "历史报告", url: "Reports", icon: 'el-icon-s-data'},
{
Expand Down
2 changes: 1 addition & 1 deletion web/src/pages/reports/DebugReport.vue
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
<div class="json-editor">
<!-- 左侧标题 -->
<div class="section-title">
<h3>初始变量,包含:配置变量,全局变量,驱动代码变量</h3>
<h3>初始变量,包含:配置变量,全局变量,自定义函数变量</h3>
</div>
<v-jsoneditor
ref="jsonEditor"
Expand Down

0 comments on commit d0254ae

Please sign in to comment.