RSPEC-设置ENV变量的最佳方法

Question

我在模块上有类方法，然后放置一个常数，并将其称为

module Cryption
 module Crypt
  class << self
    OFF_ENCRYPT = ENV['IS_OFF']
    
    def encrypt
       OFF_ENCRYPT
    end

    def decrypt
       OFF_ENCRYPT
    end
  end
 end
end

模块创建为gem

迫使我在要求之前设置环境变量

ENV["IS_OFF"] = "YES"
require "bundler/setup"
require "cryption"

Cryption::Crypt.encrypt
# result => "YES"

的每个类级别的方法“>

spec_helper.rb

require "bundler/setup"
require "cryption"

crypt_off_spec.rb

RSpec.describe "YES" do
  before(:context) do
    ENV['IS_OFF'] = "YES"
  end
  it "encryption off" do
     expect(Cryption::Crypt.encrypt).to eq("YES")
  end
end

crypt_on_spec.rb

RSpec.describe "NO" do
  before(:context) do
    ENV['IS_OFF'] = "NO"
  end
  it "encryption off" do
     expect(Cryption::Crypt.encrypt).to eq("NO")
  end
end

Answer 1

Env Vars并不应该在运行时更改。因此，在测试中调用env ['is_off'] =“ no”并不是一个好主意。问题是，env var是一种全局配置，因此，如果您从一个测试中更改它，则在运行另一个测试时仍将更改该值。

最简单的方法可能是 stub_const 常数的值，例如stub_const“ cryption :: crypt”，“ off_encrypt”，“ false”。这是最好的选择，IMO。

但是，为了完整，我可以向您展示一种实际更改特定测试的环境变量的方法。首先，您需要将常数更改为方法，例如def off_encrypt; env [“ off_encrypt”];结束。要么更改加密/解密仅直接读取env var，例如不是从常数读取。

然后，在您的测试中，您可以做这样的事情：

around(:each) do |example|
  orig_value = ENV["OFF_ENCRYPT"]
  ENV["OFF_ENCRYPT"] = "true" # set the new value
  example.run
ensure
  ENV["OFF_ENCRYPT"] = orig_value
end

再次，我真的不建议这样做，但这是可能的。

Answer 2

来避免使用反模式

突变env：通常可以轻松避免使用一些最小的TDD重构ENV变量 。 ENV变量通过将ENV变量视为类或实例变量的目的。

从测试的角度来看，如果您想验证方法或类在ENV持有特定值时做正确的事情，则应设计您的应用程序以创建您关心的ENV值的副本，并根据需要突变。另外，如果您要测试是否正确拾取特定值，则可以分叉一个过程，然后更改叉子内的值，这不会影响该父过程。

我建议以下内容：

1. 重构您的班级将ENV变量用作默认值。
2. 重构您的类以启用测试或运行时行为以覆盖默认值。
3. 构建测试可确保ENV [“ Encryption_Enabled”]（或您想命名的任何内容）是有效的，并且可以在测试或运行时轻松修改。

示例重构和一些测试骨架，

class Foo

  attr_accessor :encryption_enabled

  # set a default of true (or false if you prefer), or take an
  # optional keyword argument like +encryption_enabled: true+
  # when you initialize an instance of your class
  def initialize
    @encryption_enabled = ENV.fetch "ENCRYPTION_ENABLED", true
  end
end

这将拾取您现有的环境价值，但是您现在拥有一个访问者，可以在其中根据需要更改特定测试。例如：

Rspec.describe Foo
  describe "#encryption_enabled" do
    it "sets an instance variable based on ENV['ENCRYPTION_ENABLED']" do
      pending
    end

    it "defaults to 'true' if ENV['ENCRYPTION_ENABLED'] is unset" do
      pending
    end

    it "can be set to 'false' via its accessor" do
      subject.encryption_enabled = false
      expect(subject).to be_false
    end
  end
end

您还可以更新#New以获取关键字参数以覆盖默认值或执行其他操作。关键是Env应该提供不经常更改的默认值，您的类和方法应在必要时覆盖它们。这为测试提供了更大的灵活性。

您真正需要的唯一与ENV相关的测试是确保读取和解析正确的env值的测试，例如当它们不设置，无效或其他内容时。基于ENV变量的更改运行时行为只是一个反模式，因此这是重构的成熟。