Stub method shared tests #458

nitishr · 2020-01-06T12:59:19Z

Extract StubMethodSharedTests module to check stubbing of public, protected and private methods on Module, Class, Instance, and AnyInstance under various conditions. The only difference in each case is the method_owner and the callee, and sometimes the stubbee or alias_method?. The shared module allows us specify just the varying parts of the fixture and makes the commonality of the checks more apparent and easier to understand, and to reason about scenarios across all types of stubbees more easily.

Rubocop approves, too, since we could get rid of most of Lint/DuplicateMethod disables.

nitishr · 2020-01-06T13:27:18Z

test/acceptance/stub_any_instance_method_defined_on_superclass_test.rb

  end

-  def test_should_stub_method_and_leave_it_unchanged_after_test


Covered by https://github.com/freerange/mocha/pull/458/files#diff-3a2ccaea62f0fe445b2c85036067897aR51-R65

nitishr · 2020-01-06T13:29:34Z

test/acceptance/stub_any_instance_method_test.rb

-      def self.public(*args); end
-    end
-    instance = klass.new
-    run_as_test do
-      klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-    end
-    assert(instance.public_methods(false).any? { |m| m.to_s == 'my_instance_method' })
-    assert_equal :original_return_value, instance.my_instance_method
-  end
-
-  def test_should_leave_stubbed_public_method_unchanged_after_test_when_it_was_originally_private_in_owning_module
-    module_with_private_method = Module.new do
-      def my_included_method
-        :original_return_value
-      end
-      private :my_included_method
-    end
-    klass = Class.new do
-      include module_with_private_method
-      public :my_included_method
-    end
-    instance = klass.new
-    test_result = run_as_test do
-      klass.any_instance.stubs(:my_included_method).returns(:new_return_value)
-      assert_equal :new_return_value, instance.my_included_method
-    end
-    assert_passed(test_result)
-    assert_equal :original_return_value, instance.my_included_method
-  end
-
-  def test_should_leave_stubbed_protected_method_unchanged_after_test
-    klass = Class.new do
-      def my_instance_method
-        :original_return_value
-      end
-      protected :my_instance_method
-      def self.protected(*args); end
-
-      def my_unprotected_instance_method
-        my_instance_method
-      end
-    end
-    instance = klass.new
-    run_as_test do
-      klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-    end
-    assert(instance.protected_methods(false).any? { |m| m.to_s == 'my_instance_method' })
-    assert_equal :original_return_value, instance.my_unprotected_instance_method
-  end
-
-  def test_should_stub_protected_method_within_test
-    klass = Class.new do
-      def my_instance_method
-        :original_return_value
-      end
-      protected :my_instance_method
-      def self.protected(*args); end
-
-      def my_unprotected_instance_method
-        my_instance_method
-      end
-    end
-    instance = klass.new
-    test_result = run_as_test do
-      klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-      assert_method_visibility instance, :my_instance_method, :protected
-    end
-    assert_passed(test_result)
-  end
-
-  def test_should_leave_stubbed_private_method_unchanged_after_test
-    klass = Class.new do
-      def my_instance_method
-        :original_return_value
-      end
-      private :my_instance_method
-      def self.private(*args); end
-    end
-    instance = klass.new
-    run_as_test do
-      klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-    end
-    assert(instance.private_methods(false).any? { |m| m.to_s == 'my_instance_method' })
-    assert_equal :original_return_value, instance.send(:my_instance_method)
-  end
-
-  def test_should_stub_private_method_within_test
-    klass = Class.new do
-      def my_instance_method
-        :original_return_value
-      end
-      private :my_instance_method
-      def self.private(*args); end
-    end
-    instance = klass.new
-    test_result = run_as_test do
-      klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-      assert_method_visibility instance, :my_instance_method, :private
-    end
-    assert_passed(test_result)


All except test_should_leave_stubbed_public_method_unchanged_after_test_when_it_was_originally_private_in_owning_module covered by https://github.com/freerange/mocha/pull/458/files#diff-2d503cd32084bef97bc2b3e3256412c7R3-R15

nitishr · 2020-01-06T13:35:36Z

test/acceptance/stub_any_instance_method_test.rb

-  def test_should_be_able_to_stub_a_public_superclass_method
-    superklass = Class.new do
-      def my_superclass_method
-        :original_return_value
-      end
-      public :my_superclass_method
-    end
-    klass = Class.new(superklass)
-    instance = klass.new
-    test_result = run_as_test do
-      klass.any_instance.stubs(:my_superclass_method).returns(:new_return_value)
-      assert_method_visibility instance, :my_superclass_method, :public
-      assert_equal :new_return_value, instance.my_superclass_method
-    end
-    assert_passed(test_result)
-    assert(instance.public_methods(true).any? { |m| m.to_s == 'my_superclass_method' })
-    assert(klass.public_methods(false).none? { |m| m.to_s == 'my_superclass_method' })
-    assert_equal :original_return_value, instance.my_superclass_method
-  end
-
-  def test_should_be_able_to_stub_a_protected_superclass_method
-    superklass = Class.new do
-      def my_superclass_method
-        :original_return_value
-      end
-      protected :my_superclass_method
-    end
-    klass = Class.new(superklass)
-    instance = klass.new
-    test_result = run_as_test do
-      klass.any_instance.stubs(:my_superclass_method).returns(:new_return_value)
-      assert_method_visibility instance, :my_superclass_method, :protected
-      assert_equal :new_return_value, instance.send(:my_superclass_method)
-    end
-    assert_passed(test_result)
-    assert(instance.protected_methods(true).any? { |m| m.to_s == 'my_superclass_method' })
-    assert(klass.protected_methods(false).none? { |m| m.to_s == 'my_superclass_method' })
-    assert_equal :original_return_value, instance.send(:my_superclass_method)
-  end
-
-  def test_should_be_able_to_stub_a_private_superclass_method
-    superklass = Class.new do
-      def my_superclass_method
-        :original_return_value
-      end
-      private :my_superclass_method
-    end
-    klass = Class.new(superklass)
-    instance = klass.new
-    test_result = run_as_test do
-      klass.any_instance.stubs(:my_superclass_method).returns(:new_return_value)
-      assert_method_visibility instance, :my_superclass_method, :private
-      assert_equal :new_return_value, instance.send(:my_superclass_method)
-    end
-    assert_passed(test_result)
-    assert(instance.private_methods(true).any? { |m| m.to_s == 'my_superclass_method' })
-    assert(klass.private_methods(false).none? { |m| m.to_s == 'my_superclass_method' })
-    assert_equal :original_return_value, instance.send(:my_superclass_method)
-  end


Covered by https://github.com/freerange/mocha/pull/458/files#diff-3a2ccaea62f0fe445b2c85036067897aR3-R16

nitishr · 2020-01-06T13:56:26Z

test/acceptance/stub_any_instance_method_test.rb

-  def test_should_leave_stubbed_public_method_unchanged_after_test_when_it_was_originally_private_in_owning_module
-    module_with_private_method = Module.new do
-      def my_included_method
-        :original_return_value
-      end
-      private :my_included_method
-    end
-    klass = Class.new do
-      include module_with_private_method
-      public :my_included_method
-    end
-    instance = klass.new
-    test_result = run_as_test do
-      klass.any_instance.stubs(:my_included_method).returns(:new_return_value)
-      assert_equal :new_return_value, instance.my_included_method
-    end
-    assert_passed(test_result)
-    assert_equal :original_return_value, instance.my_included_method
-  end


Covered by https://github.com/freerange/mocha/pull/458/files#diff-2d503cd32084bef97bc2b3e3256412c7R124-R145

nitishr · 2020-01-06T13:57:18Z

test/acceptance/stub_class_method_defined_on_class_test.rb

@@ -1,78 +1,13 @@
-require File.expand_path('../acceptance_test_helper', __FILE__)
+require File.expand_path('../stub_method_shared_tests', __FILE__)

 class StubClassMethodDefinedOnClassTest < Mocha::TestCase


Covered by https://github.com/freerange/mocha/pull/458/files#diff-7dc8bf9e04a1c602370525dece735736R3

nitishr · 2020-01-06T14:10:31Z

test/acceptance/stub_instance_method_defined_on_singleton_class_test.rb

@@ -1,67 +1,13 @@
-require File.expand_path('../acceptance_test_helper', __FILE__)
+require File.expand_path('../stub_method_shared_tests', __FILE__)

 class StubInstanceMethodDefinedOnSingletonClassTest < Mocha::TestCase


Covered by https://github.com/freerange/mocha/pull/458/files#diff-287d75225bcfb7903618650cb1f1ae8eR3

nitishr · 2020-01-06T14:10:57Z

test/acceptance/stub_instance_method_defined_on_superclass_test.rb

@@ -1,70 +1,13 @@
-require File.expand_path('../acceptance_test_helper', __FILE__)
+require File.expand_path('../stub_method_shared_tests', __FILE__)

 class StubInstanceMethodDefinedOnSuperclassTest < Mocha::TestCase


Covered by https://github.com/freerange/mocha/pull/458/files#diff-1b2eef00c9b1a062585ed887281ffd09R3

nitishr · 2020-01-06T14:11:26Z

test/acceptance/stub_method_defined_on_module_and_aliased_test.rb

@@ -1,38 +1,19 @@
-require File.expand_path('../acceptance_test_helper', __FILE__)
+require File.expand_path('../stub_method_shared_tests', __FILE__)

 unless Mocha::PRE_RUBY_V19
  class StubMethodDefinedOnModuleAndAliasedTest < Mocha::TestCase


Covered by https://github.com/freerange/mocha/pull/458/files#diff-309245e2d37e36b0941ba90100ab52a0R4

nitishr · 2020-01-06T14:13:13Z

test/acceptance/stub_module_method_test.rb

-  def test_should_stub_method_within_test
-    mod = Module.new do
-      def self.my_module_method
-        :original_return_value
-      end
-    end
-    test_result = run_as_test do
-      mod.stubs(:my_module_method).returns(:new_return_value)
-      assert_equal :new_return_value, mod.my_module_method
-    end
-    assert_passed(test_result)
-  end
-
-  def test_should_leave_stubbed_public_method_unchanged_after_test
-    mod = Module.new do
-      class << self
-        def my_module_method
-          :original_return_value
-        end
-        public :my_module_method
-      end
-    end
-    run_as_test do
-      mod.stubs(:my_module_method).returns(:new_return_value)
-    end
-    assert(mod.public_methods(false).any? { |m| m.to_s == 'my_module_method' })
-    assert_equal :original_return_value, mod.my_module_method
-  end
-
-  def test_should_leave_stubbed_protected_method_unchanged_after_test
-    mod = Module.new do
-      class << self
-        def my_module_method
-          :original_return_value
-        end
-        protected :my_module_method
-        def my_unprotected_module_method
-          my_module_method
-        end
-      end
-    end
-    run_as_test do
-      mod.stubs(:my_module_method).returns(:new_return_value)
-    end
-    assert(mod.protected_methods(false).any? { |m| m.to_s == 'my_module_method' })
-    assert_equal :original_return_value, mod.my_unprotected_module_method
-  end
-
-  def test_should_leave_stubbed_private_method_unchanged_after_test
-    mod = Module.new do
-      class << self
-        def my_module_method
-          :original_return_value
-        end
-        private :my_module_method
-      end
-    end
-    run_as_test do
-      mod.stubs(:my_module_method).returns(:new_return_value)
-    end
-    assert(mod.private_methods(false).any? { |m| m.to_s == 'my_module_method' })
-    assert_equal :original_return_value, mod.send(:my_module_method)
-  end


Covered by https://github.com/freerange/mocha/pull/458/files#diff-32e2463a1ee0834316e464c62bc12448R3-R12

nitishr · 2020-01-06T14:16:07Z

test/acceptance/stub_module_method_test.rb

@@ -88,25 +24,6 @@ def self.my_module_method
    assert_equal 0, mod.mocha.__expectations__.length
  end

-  def test_should_be_able_to_stub_a_superclass_method


Deleted since it's checking nothing more than stubbing of a non-existent method. The module (mod) doesn't 'inherit' the supermod singleton method simply by including supermod.

... making it identical to protected and private method cases

This will allow us to reuse StubInstanceMethodSharedTests in StubInstanceMethodDefinedOnClassTest (and perhaps others)

…ssTest

…uleTest

…erclassTest

This allows us to reuse StubInstanceMethodSharedTests for checking stubbing on a Module and stubbing on an object

This will allow us to reuse StubInstanceMethodSharedTests in StubInstanceMethodDefinedOnSingletonClass as instead of creating an instance from a class there, we obtain the (singleton) class from the instance.

…gletonClass

…ssAndAliasedTest

…iasedTest

...since class methods are just instance methods of the singleton class of class

This will allow us to, for instance, stub a method on a superclass but check the stubbed method on its child

... since it is now used for instance as well as class methods

... and delete test_should_stub_method_within_test as covered by checks in StubMethodSharedTests

delete test_should_stub_*_method_within_test as already covered by checks in StubMethodSharedTests

... while moving them from stub_any_instance_method_test to stub_any_instance_method_defined_on_superclass_test

It wasn't checking stubbing of a supeclass or even a supermodule method. self.my_superclass_method from supermod isn't inherited/included in mod. So, all that it checked was that you could stub a non-existent module method.

... to DRY up assert_snapshot_unchanged + run_as_test + assert_passed combo

nitishr commented Jan 6, 2020

View reviewed changes

nitishr requested a review from floehopper January 16, 2020 13:46

nitishr force-pushed the stub-method-shared-tests branch from 1777b8c to dd3c458 Compare January 17, 2020 02:48

nitishr mentioned this pull request Jan 21, 2020

Simplify mockery and add check to include state in failure message #449

Closed

nitishr mentioned this pull request Feb 16, 2020

Shared tests for potential violations (stubbing non-existent/public methods, etc.) #460

Open

nitishr added 25 commits February 16, 2020 20:43

move define/remove method to setup/teardown

c203058

replace module_eval with send

36888e8

prep to DRY by using send instead of direct invocation

c455732

... making it identical to protected and private method cases

DRY up public, protected and private checks

d2362c5

Prep to DRY - use send & extract visibility to a var

26de50e

DRY up Module public, protected and private checks

6fe3702

prep to DRY by making assert methods near identical

fec664a

DRY up assert_snapshot_unchanged_on_stubbing*

9c47db1

inline delegating methods

90570ec

rename assert_snapshot_unchanged_on_stubbing_method

32562f1

extract & reuse StubInstanceMethodSharedTests

2e425af

allow instantiation to be parameterized by subclassing

0d024d4

This will allow us to reuse StubInstanceMethodSharedTests in StubInstanceMethodDefinedOnClassTest (and perhaps others)

reuse StubInstanceMethodSharedTests in StubInstanceMethodDefinedOnCla…

44037fe

…ssTest

reuse StubInstanceMethodSharedTests in StubInstanceMethodDefinedOnMod…

388c608

…uleTest

reuse StubInstanceMethodSharedTests in StubInstanceMethodDefinedOnSup…

b8505d1

…erclassTest

more expressive name: stubbed_module -> method_owner

60036df

split StubInstanceMethodDefinedOnKernelModuleTest into two

e9cfc66

This allows us to reuse StubInstanceMethodSharedTests for checking stubbing on a Module and stubbing on an object

return stubbed instance instead of stubbed class

eef3880

This will allow us to reuse StubInstanceMethodSharedTests in StubInstanceMethodDefinedOnSingletonClass as instead of creating an instance from a class there, we obtain the (singleton) class from the instance.

reuse StubInstanceMethodSharedTests in StubInstanceMethodDefinedOnSin…

a84b186

…gletonClass

check aliased method stubbing if stub_aliased_method

adc1d2f

reuse StubInstanceMethodSharedTests in StubInstanceMethodDefinedOnCla…

bffb23d

…ssAndAliasedTest

reuse StubInstanceMethodSharedTests in StubMethodDefinedOnModuleAndAl…

1180f77

…iasedTest

reuse StubInstanceMethodSharedTests in StubClassMethod*Test

ba0617b

...since class methods are just instance methods of the singleton class of class

allow stub_owner to be different from stubbed_instance

6d3b047

This will allow us to, for instance, stub a method on a superclass but check the stubbed method on its child

split superclass test into super & child

0ea322e

nitishr added 8 commits February 16, 2020 20:43

remove 'instance' qualifier from shared tests

6a0bbc3

... since it is now used for instance as well as class methods

reuse StubMethodSharedTests in StubModuleMethodTest

060ebb7

... and delete test_should_stub_method_within_test as covered by checks in StubMethodSharedTests

reuse StubMethodSharedTests in StubAnyInstanceMethodTest

1b5af22

delete test_should_stub_*_method_within_test as already covered by checks in StubMethodSharedTests

use shared tests for method private in owning module

fdc2e2b

use shared tests for AnyInstance superclass checks

620ff24

... while moving them from stub_any_instance_method_test to stub_any_instance_method_defined_on_superclass_test

delete test_should_be_able_to_stub_a_superclass_method

99ca183

It wasn't checking stubbing of a supeclass or even a supermodule method. self.my_superclass_method from supermod isn't inherited/included in mod. So, all that it checked was that you could stub a non-existent module method.

extract assert_passed_with_snapshot_unchanged

aad1b3f

... to DRY up assert_snapshot_unchanged + run_as_test + assert_passed combo

stubbed_instance -> callee, stub_owner -> stubbee

18c8c49

nitishr force-pushed the stub-method-shared-tests branch from dd3c458 to 18c8c49 Compare February 16, 2020 20:47

floehopper changed the base branch from master to main July 24, 2020 16:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Stub method shared tests #458

Stub method shared tests #458

nitishr commented Jan 6, 2020 •

edited

nitishr Jan 6, 2020

nitishr Jan 6, 2020

nitishr Jan 6, 2020

nitishr Jan 6, 2020

nitishr Jan 6, 2020

nitishr Jan 6, 2020

nitishr Jan 6, 2020

nitishr Jan 6, 2020

nitishr Jan 6, 2020

nitishr Jan 6, 2020

		end

		def test_should_stub_method_and_leave_it_unchanged_after_test

Stub method shared tests #458

Are you sure you want to change the base?

Stub method shared tests #458

Conversation

nitishr commented Jan 6, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nitishr commented Jan 6, 2020 •

edited