如何通过 Rspec 测试 Redis Lock



我们有一个Lockable问题,允许通过 Redis 锁定

module Lockable
extend ActiveSupport::Concern
def redis_lock(key, options = {})
Redis::Lock.new(
key,
expiration: options[:expiration] || 15,
timeout: options[:timeout] || 0.1
).lock { yield if block_given? }
end
end

我们在控制器方法中使用它来确保并发请求得到正确处理。

def create
redis_lock(<generated_key>, timeout: 15) do
# perform_operation
end
render json: <data>, status: :ok
end

在测试此操作时,我想测试是否将正确的generated_key发送到 Redis 以启动锁定。

我为 Redis::Lock 设置了一个期望,但它总是返回 false,大概是因为要创建的请求是在请求中发送的,而不是在请求结束时发送的。

expect(Redis::Lock).to receive(:create).once

测试结构:

context 'return status ok' do
When do
post :create, params: {
<params>
}
end
Then {
expect(Redis::Lock).to receive(:create).once
response.ok?
}
end
end

由于在方法调用结束时清除了锁,因此我无法在 redis 中检查密钥作为测试。

这个答案建议设置一个与 Lockable 结构匹配的假类来模拟相同的行为,但我如何为它编写测试?我们拥有的方法不返回任何要验证的值。

从您提供的代码来看,我相信您只是设置了错误的测试:

expect(Redis::Lock).to receive(:create).once

这期望Redis::Lock类接收create调用,但您正在控制器中调用create

您在redis_lock方法中执行的操作是初始化Redis::Lock的实例并对其调用lock。在我看来,这就是你应该测试的:

expect_any_instance_of(Redis::Lock).to receive(:lock).once

实现将如下所示:

describe 'Lockable' do
describe '#redis_lock' do
subject { lockable.redis_lock(key, options) }
# you gotta set this
let(:lockable) { xyz }
let(:key) { xyz } 
let(:options) { x: 'x', y: 'y' }
it 'calls Redis::Lock.new with correct arguments' do 
expect(Redis::Lock).to receive(:new).with(key: key, options: options)
subject
end
it 'calls #lock on the created Redis::Lock instance' do
expect_any_instance_of(Redis::Lock).to receive(:lock).once
subject
end
end
end

这是使用Rspec间谍的davegson的修改版本,这消除了编码闻起来像any_instances_of

describe 'Lockable' do
describe '#redis_lock' do
it "delegates functionality to Redis::Lock with proper arguments" do
# create an instance spy
redis_lock = instance_spy("Redis::Lock")
expect(Redis::Lock).to receive(:new).with('test', any_args).and_return(redis_lock)
redis_lock('test', timeout: 15) do
sleep 1
end
expect(redis_lock).to have_received(:lock)
end
end
end

最新更新