在Ruby中对受保护和私有方法进行单元测试的最佳方法是什么？


What's the best way to unit test protected & private methods in Ruby?

使用标准的Ruby Test::Unit框架对Ruby中的受保护和私有方法进行单元测试的最佳方法是什么？

我敢肯定有人会说道，"你应该只测试公共方法;如果它需要单元测试，它不应该是一个受保护的或私有的方法"，但我真的不想讨论这个问题。出于正当和有效的原因，我有几个受保护或私有的方法，这些私有/受保护的方法是中等复杂的，并且类中的公共方法依赖于这些受保护/私有方法正常运行，因此我需要一种方法来测试受保护/私有方法。

还有一件事......我通常将给定类的所有方法放在一个文件中，然后单元在另一个文件中测试该类。理想情况下，我希望将所有"受保护和私有方法的单元测试"功能实现到单元测试文件而不是主要源文件中，以保持主源文件尽可能简单明了。

相关讨论

您可以使用send方法绕过封装：

1
myobject.send(:method_name, args)

这是Ruby的"特性"。 :)

在Ruby 1.9开发过程中存在内部争论，认为send尊重隐私而send!忽略它，但最终在Ruby 1.9中没有任何改变。忽略下面讨论send!和破坏事情的评论。

相关讨论

如果您使用RSpec，这是一种简单的方法：

1
2
3
before(:each) do
  MyClass.send(:public, *MyClass.protected_instance_methods)  
end
相关讨论

只需在测试文件中重新打开该类，然后将这些方法重新定义为公共方法。您无需重新定义方法本身的内容，只需将符号传递给public调用即可。

如果原始类定义如下：

1
2
3
4
5
6
7
8
class MyClass

  private

  def foo
    true
  end
end

在您的测试文件中，只需执行以下操作：

1
2
3
4
class MyClass
  public :foo

end

如果要公开更多私有方法，可以将多个符号传递给public。

1
public :foo, :bar
相关讨论

instance_eval()可能有所帮助：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
--------------------------------------------------- Object#instance_eval
     obj.instance_eval(string [, filename [, lineno]] )   => obj
     obj.instance_eval {| | block }                       => obj
------------------------------------------------------------------------
     Evaluates a string containing Ruby source code, or the given
     block, within the context of the receiver (obj). In order to set
     the context, the variable self is set to obj while the code is
     executing, giving the code access to obj's instance variables. In
     the version of instance_eval that takes a String, the optional
     second and third parameters supply a filename and starting line
     number that are used when reporting compilation errors.

        class Klass
          def initialize
            @secret = 99
          end
        end
        k = Klass.new
        k.instance_eval { @secret }   #=> 99

您可以使用它直接访问私有方法和实例变量。

您还可以考虑使用send()，这也可以让您访问私有和受保护的方法(如James Baker建议的那样)

或者，您可以修改测试对象的元类，以使私有/受保护方法仅为该对象公开。

1
2
3
4
5
6
7
8
9
10
11
    test_obj.a_private_method(...) #=> raises NoMethodError
    test_obj.a_protected_method(...) #=> raises NoMethodError
    class << test_obj
        public :a_private_method, :a_protected_method
    end
    test_obj.a_private_method(...) # executes
    test_obj.a_protected_method(...) # executes

    other_test_obj = test.obj.class.new
    other_test_obj.a_private_method(...) #=> raises NoMethodError
    other_test_obj.a_protected_method(...) #=> raises NoMethodError

这将允许您调用这些方法，而不会影响该类的其他对象。
您可以在测试目录中重新打开该类，并将其公开给所有人
测试代码中的实例，但这可能会影响您对公共接口的测试。

我过去做过的一种方法是：

1
2
3
4
5
6
7
8
9
10
11
class foo
  def public_method
    private_method
  end

private unless 'test' == Rails.env

  def private_method
    'private'
  end
end
相关讨论

I'm sure somebody will pipe up and
dogmatically assert that"you should
only unit test public methods; if it
needs unit testing, it shouldn't be a
protected or private method", but I'm
not really interested in debating
that.

您还可以将这些方法重构为一个新对象，其中这些方法是公共的，并在原始类中私下委托给它们。这将允许您在规范中测试没有魔法元数据的方法，同时保持它们的私密性。

I've got several methods that are
protected or private for good and
valid reasons

这些正当理由是什么？其他OOP语言可以在没有私有方法的情况下逃脱(想到smalltalk，其中私有方法仅作为约定存在)。

相关讨论

与@ WillSargent的响应类似，这是我在describe块中用于测试一些受保护验证器的特殊情况，而无需通过FactoryGirl创建/更新它们的重量级过程(并且您可以使用private_instance_methods类似的)：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
  describe"protected custom `validates` methods" do
    # Test these methods directly to avoid needing FactoryGirl.create
    # to trigger before_create, etc.
    before(:all) do
      @protected_methods = MyClass.protected_instance_methods
      MyClass.send(:public, *@protected_methods)
    end
    after(:all) do
      MyClass.send(:protected, *@protected_methods)
      @protected_methods = nil
    end

    # ...do some tests...
  end

要公开所描述的类的所有受保护和私有方法，您可以将以下内容添加到spec_helper.rb，而不必触摸任何spec文件。

1
2
3
4
5
6
RSpec.configure do |config|
  config.before(:each) do
    described_class.send(:public, *described_class.protected_instance_methods)
    described_class.send(:public, *described_class.private_instance_methods)
  end
end

我知道我迟到了，但不要测试私人方法......我想不出这样做的理由。一种可公开访问的方法是在某处使用该私有方法，测试公共方法以及可能导致使用该私有方法的各种方案。有些东西进来了，有些东西出来了。测试私有方法是一个很大的禁忌，它使得以后重构代码变得更加困难。他们是私人的有一个原因。

相关讨论

您可以"重新打开"该类并提供一个委托给私有类的新方法：

1
2
3
4
5
6
7
8
9
10
class Foo
  private
  def bar; puts"Oi! how did you reach me??"; end
end
# and then
class Foo
  def ah_hah; bar; end
end
# then
Foo.new.ah_hah

我可能倾向于使用instance_eval()。然而，在我了解instance_eval()之前，我会在单元测试文件中创建一个派生类。然后我会将私有方法设置为公开。

在下面的示例中，build_year_range方法在PublicationSearch :: ISIQuery类中是私有的。为了测试目的而派生一个新类允许我将方法设置为公共的，因此可以直接测试。同样，派生类公开了一个先前未公开的名为"result"的实例变量。

1
2
3
4
5
# A derived class useful for testing.
class MockISIQuery < PublicationSearch::ISIQuery
    attr_accessor :result
    public :build_year_range
end

在我的单元测试中，我有一个测试用例，它实例化MockISIQuery类并直接测试build_year_range()方法。

在Test :: Unit框架中可以写，

1
MyClass.send(:public, :method_name)

这里"method_name"是私有方法。

＆虽然调用这个方法可以写，

1
assert_equal expected, MyClass.instance.method_name(params)

您可以使用单例方法代替obj.send。你的代码中还有3行代码
测试类，不需要更改要测试的实际代码。

1
2
3
def obj.my_private_method_publicly (*args)
  my_private_method(*args)
end

在测试用例中，只要您想测试my_private_method，就可以使用my_private_method_publicly。

http://mathandprogramming.blogspot.com/2010/01/ruby-testing-private-methods.html

私有方法的obj.send在1.9中被send!替换，但后来再次删除send!。所以obj.send运作得非常好。

要纠正上面的最佳答案：在Ruby 1.9.1中，它是发送所有消息的Object＃send，以及尊重隐私的Object＃public_send。

相关讨论

这是我使用的Class的一般补充。它比仅仅公开您正在测试的方法更多的霰弹枪，但在大多数情况下它并不重要，而且它更具可读性。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
class Class
  def publicize_methods
    saved_private_instance_methods = self.private_instance_methods
    self.class_eval { public *saved_private_instance_methods }
    begin
      yield
    ensure
      self.class_eval { private *saved_private_instance_methods }
    end
  end
end

MyClass.publicize_methods do
  assert_equal 10, MyClass.new.secret_private_method
end

在1.9中使用send来访问protected / private方法，因此不推荐使用。

为此：

1
2
3
disrespect_privacy @object do |p|
  assert p.private_method
end

您可以在test_helper文件中实现此功能：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
class ActiveSupport::TestCase
  def disrespect_privacy(object_or_class, &block)   # access private methods in a block
    raise ArgumentError, 'Block must be specified' unless block_given?
    yield Disrespect.new(object_or_class)
  end

  class Disrespect
    def initialize(object_or_class)
      @object = object_or_class
    end
    def method_missing(method, *args)
      @object.send(method, *args)
    end
  end
end