Use stub_any_instance in order to stub find results.
authorAndy Allan <git@gravitystorm.co.uk>
Sun, 30 Oct 2016 09:22:10 +0000 (10:22 +0100)
committerAndy Allan <git@gravitystorm.co.uk>
Sun, 30 Oct 2016 09:22:10 +0000 (10:22 +0100)
This is a much cleaner approach than before.

Gemfile
Gemfile.lock
test/controllers/trace_controller_test.rb

diff --git a/Gemfile b/Gemfile
index 2cbb1cb..039216f 100644 (file)
--- a/Gemfile
+++ b/Gemfile
@@ -101,6 +101,7 @@ group :test do
   gem "rubocop"
   gem "timecop"
   gem "minitest", "~> 5.1", :platforms => [:ruby_19, :ruby_20]
+  gem "minitest-stub_any_instance"
 end
 
 # Needed in development as well so rake can see konacha tasks
index d03cd5a..f457365 100644 (file)
@@ -150,6 +150,7 @@ GEM
     mimemagic (0.3.0)
     mini_portile2 (2.1.0)
     minitest (5.9.1)
+    minitest-stub_any_instance (1.0.1)
     multi_json (1.12.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
@@ -334,6 +335,7 @@ DEPENDENCIES
   libxml-ruby (>= 2.0.5)
   logstasher
   minitest (~> 5.1)
+  minitest-stub_any_instance
   oauth-plugin (>= 0.5.1)
   omniauth
   omniauth-facebook
index 9170d6e..3888b12 100644 (file)
@@ -305,49 +305,43 @@ class TraceControllerTest < ActionController::TestCase
   # Test downloading a trace
   def test_data
     public_trace_file = create(:trace, :visibility => "public", :user => users(:normal_user))
-    # We need to stub both the trace_name, to control which file from test/traces is used,
-    # and also the Trace.find method so that our stubbed object is used by the controller.
-    public_trace_file.stub :trace_name, "#{GPX_TRACE_DIR}/1.gpx" do
-      Trace.stub :find, public_trace_file do
-        # First with no auth, which should work since the trace is public
-        get :data, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
-        check_trace_data public_trace_file
-
-        # Now with some other user, which should work since the trace is public
-        get :data, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:public_user).id }
-        check_trace_data public_trace_file
-
-        # And finally we should be able to do it with the owner of the trace
-        get :data, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:normal_user).id }
-        check_trace_data public_trace_file
-      end
+    Trace.stub_any_instance :trace_name, "#{GPX_TRACE_DIR}/1.gpx" do
+      # First with no auth, which should work since the trace is public
+      get :data, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
+      check_trace_data public_trace_file
+
+      # Now with some other user, which should work since the trace is public
+      get :data, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:public_user).id }
+      check_trace_data public_trace_file
+
+      # And finally we should be able to do it with the owner of the trace
+      get :data, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:normal_user).id }
+      check_trace_data public_trace_file
     end
   end
 
   # Test downloading a compressed trace
   def test_data_compressed
     identifiable_trace_file = create(:trace, :visibility => "identifiable")
-    identifiable_trace_file.stub :trace_name, "#{GPX_TRACE_DIR}/4.gpx" do
-      Trace.stub :find, identifiable_trace_file do
-        # First get the data as is
-        get :data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id
-        check_trace_data identifiable_trace_file, "application/x-gzip", "gpx.gz"
-
-        # Now ask explicitly for XML format
-        get :data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id, :format => "xml"
-        check_trace_data identifiable_trace_file, "application/xml", "xml"
-
-        # Now ask explicitly for GPX format
-        get :data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id, :format => "gpx"
-        check_trace_data identifiable_trace_file
-      end
+    Trace.stub_any_instance :trace_name, "#{GPX_TRACE_DIR}/4.gpx" do
+      # First get the data as is
+      get :data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id
+      check_trace_data identifiable_trace_file, "application/x-gzip", "gpx.gz"
+
+      # Now ask explicitly for XML format
+      get :data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id, :format => "xml"
+      check_trace_data identifiable_trace_file, "application/xml", "xml"
+
+      # Now ask explicitly for GPX format
+      get :data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id, :format => "gpx"
+      check_trace_data identifiable_trace_file
     end
   end
 
   # Check an anonymous trace can't be downloaded by another user
   def test_data_anon
     anon_trace_file = create(:trace, :visibility => "private", :user => users(:public_user))
-    anon_trace_file.stub :trace_name, "#{GPX_TRACE_DIR}/2.gpx" do
+    Trace.stub_any_instance :trace_name, "#{GPX_TRACE_DIR}/2.gpx" do
       # First with no auth
       get :data, :display_name => users(:public_user).display_name, :id => anon_trace_file.id
       assert_response :not_found
@@ -357,10 +351,8 @@ class TraceControllerTest < ActionController::TestCase
       assert_response :not_found
 
       # And finally we should be able to do it with the owner of the trace
-      Trace.stub :find, anon_trace_file do
-        get :data, { :display_name => users(:public_user).display_name, :id => anon_trace_file.id }, { :user => users(:public_user).id }
-        check_trace_data anon_trace_file
-      end
+      get :data, { :display_name => users(:public_user).display_name, :id => anon_trace_file.id }, { :user => users(:public_user).id }
+      check_trace_data anon_trace_file
     end
   end
 
@@ -383,27 +375,25 @@ class TraceControllerTest < ActionController::TestCase
   # Test downloading the picture for a trace
   def test_picture
     public_trace_file = create(:trace, :visibility => "public", :user => users(:normal_user))
-    public_trace_file.stub :large_picture_name, "#{GPX_TRACE_DIR}/1.gif" do
-      Trace.stub :find, public_trace_file do
-        # First with no auth, which should work since the trace is public
-        get :picture, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
-        check_trace_picture public_trace_file
-
-        # Now with some other user, which should work since the trace is public
-        get :picture, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:public_user).id }
-        check_trace_picture public_trace_file
-
-        # And finally we should be able to do it with the owner of the trace
-        get :picture, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:normal_user).id }
-        check_trace_picture public_trace_file
-      end
+    Trace.stub_any_instance :large_picture_name, "#{GPX_TRACE_DIR}/1.gif" do
+      # First with no auth, which should work since the trace is public
+      get :picture, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
+      check_trace_picture public_trace_file
+
+      # Now with some other user, which should work since the trace is public
+      get :picture, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:public_user).id }
+      check_trace_picture public_trace_file
+
+      # And finally we should be able to do it with the owner of the trace
+      get :picture, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:normal_user).id }
+      check_trace_picture public_trace_file
     end
   end
 
   # Check the picture for an anonymous trace can't be downloaded by another user
   def test_picture_anon
     anon_trace_file = create(:trace, :visibility => "private", :user => users(:public_user))
-    anon_trace_file.stub :large_picture_name, "#{GPX_TRACE_DIR}/2.gif" do
+    Trace.stub_any_instance :large_picture_name, "#{GPX_TRACE_DIR}/2.gif" do
       # First with no auth
       get :picture, :display_name => users(:public_user).display_name, :id => anon_trace_file.id
       assert_response :forbidden
@@ -413,10 +403,8 @@ class TraceControllerTest < ActionController::TestCase
       assert_response :forbidden
 
       # And finally we should be able to do it with the owner of the trace
-      Trace.stub :find, anon_trace_file do
-        get :picture, { :display_name => users(:public_user).display_name, :id => anon_trace_file.id }, { :user => users(:public_user).id }
-        check_trace_picture anon_trace_file
-      end
+      get :picture, { :display_name => users(:public_user).display_name, :id => anon_trace_file.id }, { :user => users(:public_user).id }
+      check_trace_picture anon_trace_file
     end
   end
 
@@ -439,27 +427,25 @@ class TraceControllerTest < ActionController::TestCase
   # Test downloading the icon for a trace
   def test_icon
     public_trace_file = create(:trace, :visibility => "public", :user => users(:normal_user))
-    public_trace_file.stub :icon_picture_name, "#{GPX_TRACE_DIR}/1_icon.gif" do
-      Trace.stub :find, public_trace_file do
-        # First with no auth, which should work since the trace is public
-        get :icon, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
-        check_trace_icon public_trace_file
-
-        # Now with some other user, which should work since the trace is public
-        get :icon, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:public_user).id }
-        check_trace_icon public_trace_file
-
-        # And finally we should be able to do it with the owner of the trace
-        get :icon, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:normal_user).id }
-        check_trace_icon public_trace_file
-      end
+    Trace.stub_any_instance :icon_picture_name, "#{GPX_TRACE_DIR}/1_icon.gif" do
+      # First with no auth, which should work since the trace is public
+      get :icon, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
+      check_trace_icon public_trace_file
+
+      # Now with some other user, which should work since the trace is public
+      get :icon, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:public_user).id }
+      check_trace_icon public_trace_file
+
+      # And finally we should be able to do it with the owner of the trace
+      get :icon, { :display_name => users(:normal_user).display_name, :id => public_trace_file.id }, { :user => users(:normal_user).id }
+      check_trace_icon public_trace_file
     end
   end
 
   # Check the icon for an anonymous trace can't be downloaded by another user
   def test_icon_anon
     anon_trace_file = create(:trace, :visibility => "private", :user => users(:public_user))
-    anon_trace_file.stub :icon_picture_name, "#{GPX_TRACE_DIR}/2_icon.gif" do
+    Trace.stub_any_instance :icon_picture_name, "#{GPX_TRACE_DIR}/2_icon.gif" do
       # First with no auth
       get :icon, :display_name => users(:public_user).display_name, :id => anon_trace_file.id
       assert_response :forbidden
@@ -469,10 +455,8 @@ class TraceControllerTest < ActionController::TestCase
       assert_response :forbidden
 
       # And finally we should be able to do it with the owner of the trace
-      Trace.stub :find, anon_trace_file do
-        get :icon, { :display_name => users(:public_user).display_name, :id => anon_trace_file.id }, { :user => users(:public_user).id }
-        check_trace_icon anon_trace_file
-      end
+      get :icon, { :display_name => users(:public_user).display_name, :id => anon_trace_file.id }, { :user => users(:public_user).id }
+      check_trace_icon anon_trace_file
     end
   end
 
@@ -699,77 +683,61 @@ class TraceControllerTest < ActionController::TestCase
   # Test downloading a trace through the api
   def test_api_data
     public_trace_file = create(:trace, :visibility => "public", :user => users(:normal_user))
-    public_trace_file.stub :trace_name, "#{GPX_TRACE_DIR}/1.gpx" do
-      visible = MiniTest::Mock.new
-      visible.expect :find, public_trace_file, [String]
-      visible.expect :find, public_trace_file, [String]
-      Trace.stub :visible, visible do
-        # First with no auth
-        get :api_data, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
-        assert_response :unauthorized
-
-        # Now with some other user, which should work since the trace is public
-        basic_authorization(users(:public_user).display_name, "test")
-        get :api_data, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
-        check_trace_data public_trace_file
-
-        # # And finally we should be able to do it with the owner of the trace
-        basic_authorization(users(:normal_user).display_name, "test")
-        get :api_data, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
-        check_trace_data public_trace_file
-      end
+    Trace.stub_any_instance :trace_name, "#{GPX_TRACE_DIR}/1.gpx" do
+      # First with no auth
+      get :api_data, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
+      assert_response :unauthorized
+
+      # Now with some other user, which should work since the trace is public
+      basic_authorization(users(:public_user).display_name, "test")
+      get :api_data, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
+      check_trace_data public_trace_file
+
+      # # And finally we should be able to do it with the owner of the trace
+      basic_authorization(users(:normal_user).display_name, "test")
+      get :api_data, :display_name => users(:normal_user).display_name, :id => public_trace_file.id
+      check_trace_data public_trace_file
     end
   end
 
   # Test downloading a compressed trace through the api
   def test_api_data_compressed
     identifiable_trace_file = create(:trace, :visibility => "identifiable", :user => users(:public_user))
-    identifiable_trace_file.stub :trace_name, "#{GPX_TRACE_DIR}/4.gpx" do
-      visible = MiniTest::Mock.new
-      visible.expect :find, identifiable_trace_file, [String]
-      visible.expect :find, identifiable_trace_file, [String]
-      visible.expect :find, identifiable_trace_file, [String]
-      Trace.stub :visible, visible do
-        # Authenticate as the owner of the trace we will be using
-        basic_authorization(users(:public_user).display_name, "test")
-
-        # First get the data as is
-        get :api_data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id
-        check_trace_data identifiable_trace_file, "application/x-gzip", "gpx.gz"
-
-        # Now ask explicitly for XML format
-        get :api_data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id, :format => "xml"
-        check_trace_data identifiable_trace_file, "application/xml", "xml"
-
-        # # Now ask explicitly for GPX format
-        get :api_data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id, :format => "gpx"
-        check_trace_data identifiable_trace_file
-      end
+    Trace.stub_any_instance :trace_name, "#{GPX_TRACE_DIR}/4.gpx" do
+      # Authenticate as the owner of the trace we will be using
+      basic_authorization(users(:public_user).display_name, "test")
+
+      # First get the data as is
+      get :api_data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id
+      check_trace_data identifiable_trace_file, "application/x-gzip", "gpx.gz"
+
+      # Now ask explicitly for XML format
+      get :api_data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id, :format => "xml"
+      check_trace_data identifiable_trace_file, "application/xml", "xml"
+
+      # # Now ask explicitly for GPX format
+      get :api_data, :display_name => users(:public_user).display_name, :id => identifiable_trace_file.id, :format => "gpx"
+      check_trace_data identifiable_trace_file
     end
   end
 
   # Check an anonymous trace can't be downloaded by another user through the api
   def test_api_data_anon
     anon_trace_file = create(:trace, :visibility => "private", :user => users(:public_user))
-    anon_trace_file.stub :trace_name, "#{GPX_TRACE_DIR}/2.gpx" do
-      visible = MiniTest::Mock.new
-      visible.expect :find, anon_trace_file, [String]
-      visible.expect :find, anon_trace_file, [String]
-      Trace.stub :visible, visible do
-        # First with no auth
-        get :api_data, :display_name => users(:public_user).display_name, :id => anon_trace_file.id
-        assert_response :unauthorized
-
-        # Now with some other user, which shouldn't work since the trace is anon
-        basic_authorization(users(:normal_user).display_name, "test")
-        get :api_data, :display_name => users(:public_user).display_name, :id => anon_trace_file.id
-        assert_response :forbidden
-
-        # And finally we should be able to do it with the owner of the trace
-        basic_authorization(users(:public_user).display_name, "test")
-        get :api_data, :display_name => users(:public_user).display_name, :id => anon_trace_file.id
-        check_trace_data anon_trace_file
-      end
+    Trace.stub_any_instance :trace_name, "#{GPX_TRACE_DIR}/2.gpx" do
+      # First with no auth
+      get :api_data, :display_name => users(:public_user).display_name, :id => anon_trace_file.id
+      assert_response :unauthorized
+
+      # Now with some other user, which shouldn't work since the trace is anon
+      basic_authorization(users(:normal_user).display_name, "test")
+      get :api_data, :display_name => users(:public_user).display_name, :id => anon_trace_file.id
+      assert_response :forbidden
+
+      # And finally we should be able to do it with the owner of the trace
+      basic_authorization(users(:public_user).display_name, "test")
+      get :api_data, :display_name => users(:public_user).display_name, :id => anon_trace_file.id
+      check_trace_data anon_trace_file
     end
   end