在使用的django做测试平台时,,多多少少都会遇到需要定时任务的功能,比如定时执行任务,检查订单之类
的。可能是一段时间,比如每隔 10分钟执行一次,也可能是定点时间,比如 14:00 执行,也可能是长时
间,比如每周几,每个月的哪一天等。查看了一下相关资料, django 定时任务 django-crontab 库比
较多教程和资料,虽然 star 数才五百,但是 API 接口比较简单,接入也很方便,功能也很全面,当然,
也存在一此无法解决的问题,使用时需要注意的
- 使用
pip install django-crontab
- 添加配置文件到settings.py INSTALLED_APPS 中,
INSTALLED_APPS = ( 'django_crontab', ) - 编写定时函数
定时任务分为两类,一种是执行自定义的manage.py,另一种是执行自定义函数
在Django中的app中新建一个myapp/cron.py 文件,把需要定时的代码放进去
def my_schedule_job(): pass
- 在setting.py中增加
CEONJOBS
配置
CRONJOBS = [ ('*/5 * * * *', 'myapp.cron.my_scheduled_job') ]
也可以定义一些关键字参数,有2种格式:
格式1:
要求:cron计时通常格式(有关更多示例,请参阅 Wikipedia 和 crontab.guru)
要求:python模块路径下待执行定时任务
可选:特定于定时任务的后缀(例如,将 out/err 重定向到文件,默认值为'')
CRONJOBS = [ ('*/1 * * * *', 'appname.test_crontab.test','>>/home/python/test_crontab.log') ]
注意: >> 表示追加写入, > 表示覆盖写入。
格式2:
要求:cron计时通常格式
要求:python模块路径下待执行定时任务
可选:方法的位置参数列表(默认值:[])
可选:方法的关键字参数的dict(默认值:{})
可选:特定于定时任务的后缀(例如,将 out/err 重定向到文件,默认值为'')
CRONJOBS = [ ('*/5 * * * *', 'myapp.cron.other_scheduled_job', ['arg1', 'arg2'], {'verbose': 0}), ('0 4 * * *', 'django.core.management.call_command', ['clearsessions']), ]
对于熟悉 Linux 中定时任务 crontab 的同学可能对上面第一个参数的语法很亲切。上面表示每隔1分钟
执行一次代码。
Linux 中的定时任务 crontab 的语法如下:
* * * * * command 分钟(0-59) 小时(0-23) 每个月的哪一天(1-31) 月份(1-12) 周几(0-6) shell脚本或者命令
* 代表所有的取值范围的数字 / 代表每的意思,*/5 就是5个单位 - 代表从某个数字到某个数字 ,分来几个离散的数字 --------------------------- 每两个小时 0 */2 * * * 晚上11点到早上8点之间每两个小时,早上8点 0 23-7,8 * * * 每个月的4号和每个礼拜的礼拜一到礼拜三的早上11点 0 11 4 * 1-3 1月1日早上4点 0 4 1 1 * 0 6 * * * commands >> /tmp/test.log # 每天早上6点执行, 并将信息追加到test.log中 0 */2 * * * commands # 每隔2小时执行一次
- 添加并启动定时任务
# 添加并启动定时任务 python manage.py crontab add
其他命令
#显示当前的定时任务 python manage.py crontab show #删除所有定时任务 python manage.py crontab remove
总结
测试平台执行测试用例时,可以借助jenkins之类的CI/CD工具,也可以使用定时任务crontab
,作为测试开发工程师,我们可能没有权限去操作服务器,那么我们就只能使用django-crontab
,在指定时间(循环执行)测试用例