libfaketime的应用场景
周期执行的任务
长周期执行的任务调试和测试,比如每天0点执行,每半个小时执行一次。此类任务的调试和测试一般通过手工修改代码的方式模拟。
超时类程序
比如长连接设置4小时超时,consume kafka消息 60s超时。此类程序一般在运行时不停轮训系统时间或jiffies来判定超时,而且往往用了库,导致手工修改代码的方式基本不可行。那就只能修改系统时间了,但是修改系统时间有时也不可行,程序可能运行在k8s、docker中没有权限修改系统时间。
一些测试场景
某些业务逻辑需要使用到当前时间,典型的场景是计算两个时间的delta,即时长。比如计费程序。
测试数据中包含了精心设计的数据集,例如月底释放的资源,闰月创建的资源,23:59创建的资源等。这些数据要结合当前时间才能有效运行。比如对于计费月结的场景,如果当前系统时间是5月,则数据集必须是4月。
在此场景下,除非每次都自动生成数据集,否则测试数据就无法使用。
libfaketime如何解决这个问题
libfaketime通过LD_PRELOAD hook glbic获取系统时间的相关接口来mock时间,通过环境变量来控制计算系统时间的算法。
这种方式仅不支持静态链接的程序。
libfaketime支持的特性(部分)
- 启动程序时使用mock时间
- 延时使用mock时间
- 运行时mock时间
libfaketime仅依赖glibc,基本在任何系统上都可以构建出来。
# ldd /usr/local/bin/faketime
linux-vdso.so.1 => (0x00007fffffba5000)
libpthread.so.0 => /lib64/libpthread.so.0 (0x00007f03b8c73000)
librt.so.1 => /lib64/librt.so.1 (0x00007f03b8a6b000)
libc.so.6 => /lib64/libc.so.6 (0x00007f03b86db000)
/lib64/ld-linux-x86-64.so.2 (0x00007f03b8e8f000)
install libfaketime
libfaketime不能通过yum安装,只能编译安装。
从github下载:https://github.com/wolfcw/libfaketime
建议下载最新的tag,而不要git clone master分支,master分支一般不是stable版本。
make && make install即可
Tips:因为libfake仅依赖libc,某些环境缺少make,gcc时,也可以编译后拷贝过去。
libfaketime使用方法
让我们先准备一个测试程序
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import time
import datetime
import os
import sys
if __name__ == '__main__':
if len(sys.argv) != 2:
sleep_time = 5
else:
sleep_time = int(sys.argv[1])
print(datetime.datetime.now())
time.sleep(sleep_time)
print(datetime.datetime.now())
启动时mock
# using offsets
LD_PRELOAD=/usr/local/lib/faketime/libfaketime.so.1 \\
FAKETIME="-15d" \\
python3 ./faketime_test.py
2022-05-02 15:11:24.255655
2022-05-02 15:11:34.264570
# absolute date
LD_PRELOAD=/usr/local/lib/faketime/libfaketime.so.1 \\
FAKETIME="2020-12-24 20:30:00" \\
python3 ./faketime_test.py
2020-12-24 20:30:00
2020-12-24 20:30:00
# start at
LD_PRELOAD=/usr/local/lib/faketime/libfaketime.so.1 \\
FAKETIME="@2020-12-24 20:30:00" \\
python3 ./faketime_test.py
2020-12-24 20:30:00.094367
2020-12-24 20:30:05.097899
延时mock
LD_PRELOAD=/usr/local/lib/faketime/libfaketime.so.1 \\
FAKETIME="@2020-12-24 20:30:00" \\
FAKETIME_START_AFTER_SECONDS="2" \\
python3 ./faketime_test.py
2022-05-17 15:20:47.379237
2020-12-24 20:30:05.025025
运行时mock
运行时通过环境变量或者文件来修改时间,我们以bash来演示一下
➜ kafka LD_PRELOAD=/usr/local/lib/faketime/libfaketime.so.1 bash
[root@centos ~/code/kafka]# date
Tue May 17 15:22:44 CST 2022
[root@centos ~/code/kafka]# export FAKETIME="+14d"
[root@centos ~/code/kafka]# date
Tue May 31 15:23:16 CST 2022
bash可以修改自己的环境变量,但是我们的程序不能运行时修改环境变量,所以我们通过~/.faketimerc文件来修改. 请注意,默认情况下基于性能考虑,使用此方式时每10s读取一次文件。
➜ kafka rm ~/.faketimerc
➜ kafka LD_PRELOAD=/usr/local/lib/faketime/libfaketime.so.1 python3 ./faketime_test.py 20 &
[1] 118184
➜ kafka 2022-05-17 15:47:02.999956
➜ kafka echo @2020-12-24 20:30:00 > ~/.faketimerc
➜ kafka 2020-12-24 20:29:59.999929