使用RSpec为Redis和Rails编写测试

Question

我有一个模型类,用于在redis中缓存数据.我第一次在模型上调用方法时,它会计算JSON/Hash值并将其存储在Redis中.在某些情况下,我'刷新'该数据,并在下次调用时重新计算.

这是与我用来在Redis中存储数据的代码片段类似的代码片段:

def cache_data
  self.data_values = data_to_cache
  REDIS.set(redis_key,ActiveSupport::JSON.encode(self.data_values))
  REDIS.get(redis_key) 
end

def data_to_cache
  //  generate a hash of values to return
end

我该如何对这段代码进行单元测试？我使用RSpec和Capybara.如果有帮助,我还会使用Cucumber和Capabara进行集成测试.

Answer 1

我喜欢在测试运行时运行redis.与例如postgres不同,Redis非常快,并且不会显着减慢测试运行时间.

只要确保你REDIS.flush在一个before(:each)街区或相应的黄瓜钩子里打电话.

您可以data_to_cache独立于redis 进行测试,但除非您完全信任您正在使用的redis驱动程序及其提供的合同,否则实际测试cache_data(以及相应的缓存获取方法)更安全.这也允许您切换到不同的redis驱动程序(或不同的快速KV存储),而无需批量重写测试.

Answer 2

首先在spec_helper.rb中添加以下代码,这样即使没有安装redis服务器,您也可以确保测试可以在任何机器上运行:

redis_instance = MockRedis.new
Redis.stub(:new).returns(redis_instance)
Redis::Store.stub(:new).returns(redis_instance)

之后我会测试:

1. 写入REDIS的数据是预期的数据
2. cache_data,flush_data,cache_data的序列调用data_to_cache两次

Answer 3

这两个答案均已于 2022 年 5 月过时。以下是带有示例测试的更新版本。

将其添加到Gemfile

gem 'mock_redis'

mock_redis使用以下命令安装gem

bundle install

在你的spec_helper.rb或rails_helper.rb添加这个

require 'mock_redis'

RSpec.configure do |config|
  '''
  Creating a stub/mock Redis for running the tests without requiring an actual Redis server. This will store the Redis data in memory instead of the Redis server. 
  '''
  config.before(:each) do
    mock_redis = MockRedis.new
    allow(Redis).to receive(:new).and_return(mock_redis)
  end
end

这将确保为您的所有测试模拟 Redis。

假设您有一个module_in_my_app.rb像这样使用 Redis 的模块 ( )

module ModuleInMyApp
    extend self
    @@redis = Redis.new(url: "redis://#{ENV["REDIS_URL"]}")

    def get_or_create_my_key(keys, default_value)
       return @@redis.set(key, value)
    end

    def get_my_key(key)
       return @@redis.get(key)
    end
end

您可以在您的规范中像这样使用它 ( module_in_my_app_spec.rb)

describe "test my redis module" do
    it "should set the key" do
        ModuleInMyApp.set_my_key("US", "United States of America")

        redis_var = class_variable_get(:@@redis)
        expect(redis_var.get("US")).to eq("United States of America")
    end

    it "should get the key" do
        mock_redis = Redis.new
        mock_redis.set("CA", "Canada")
        ModuleInMyApp.class_variable_set(:@@redis, mock_redis)

        actual_result = ModuleInMyApp.get_my_key("CA")
        expect(actual_result).to eq("Canada")
    end
end