Refactor site controller tests to inherit from ActionDispatch::IntegrationTest
authorAndy Allan <git@gravitystorm.co.uk>
Wed, 22 Apr 2020 09:02:41 +0000 (11:02 +0200)
committerAndy Allan <git@gravitystorm.co.uk>
Wed, 22 Apr 2020 09:09:13 +0000 (11:09 +0200)
This is the modern way of writing controller tests, since it uses the
rails middleware (among other things) and leads to more realistic tests.

Refs #2563

config/routes.rb
test/controllers/site_controller_test.rb
test/test_helper.rb

index 37ffa2d9a9acde4bb88e64458f1ea4e909d9a7da..40282b37379db08338b7b626c57ef6171e0bfdfe 100644 (file)
@@ -180,7 +180,7 @@ OpenStreetMap::Application.routes.draw do
   match "/auth/:provider" => "users#auth", :via => [:get, :post], :as => :auth
 
   # permalink
-  get "/go/:code" => "site#permalink", :code => /[a-zA-Z0-9_@~]+[=-]*/
+  get "/go/:code" => "site#permalink", :code => /[a-zA-Z0-9_@~]+[=-]*/, :as => :permalink
 
   # rich text preview
   post "/preview/:type" => "site#preview", :as => :preview
index 4dc07f9960a8613b43248d16d541ec28ac4f7aa0..77b07db7d53c9cc281113aa642f8fb01845235f9 100644 (file)
@@ -1,6 +1,6 @@
 require "test_helper"
 
-class SiteControllerTest < ActionController::TestCase
+class SiteControllerTest < ActionDispatch::IntegrationTest
   ##
   # setup oauth keys
   def setup
@@ -96,78 +96,80 @@ class SiteControllerTest < ActionController::TestCase
 
   # Test the index page
   def test_index
-    get :index
+    get root_path
+
     assert_response :success
     assert_template "index"
   end
 
   # Test the index page redirects
   def test_index_redirect
-    get :index, :params => { :node => 123 }
+    get root_path(:node => 123)
     assert_redirected_to :controller => :browse, :action => :node, :id => 123
 
-    get :index, :params => { :way => 123 }
+    get root_path(:way => 123)
     assert_redirected_to :controller => :browse, :action => :way, :id => 123
 
-    get :index, :params => { :relation => 123 }
+    get root_path(:relation => 123)
     assert_redirected_to :controller => :browse, :action => :relation, :id => 123
 
-    get :index, :params => { :note => 123 }
+    get root_path(:note => 123)
     assert_redirected_to :controller => :browse, :action => :note, :id => 123
 
-    get :index, :params => { :query => "test" }
+    get root_path(:query => "test")
     assert_redirected_to :controller => :geocoder, :action => :search, :query => "test"
 
-    get :index, :params => { :lat => 4, :lon => 5 }
+    get root_path(:lat => 4, :lon => 5)
     assert_redirected_to :controller => :site, :action => :index, :anchor => "map=5/4/5"
 
-    get :index, :params => { :lat => 4, :lon => 5, :zoom => 3 }
+    get root_path(:lat => 4, :lon => 5, :zoom => 3)
     assert_redirected_to :controller => :site, :action => :index, :anchor => "map=3/4/5"
 
-    get :index, :params => { :layers => "T" }
+    get root_path(:layers => "T")
     assert_redirected_to :controller => :site, :action => :index, :anchor => "layers=T"
 
-    get :index, :params => { :notes => "yes" }
+    get root_path(:notes => "yes")
     assert_redirected_to :controller => :site, :action => :index, :anchor => "layers=N"
 
-    get :index, :params => { :lat => 4, :lon => 5, :zoom => 3, :layers => "T" }
+    get root_path(:lat => 4, :lon => 5, :zoom => 3, :layers => "T")
     assert_redirected_to :controller => :site, :action => :index, :anchor => "map=3/4/5&layers=T"
   end
 
   # Test the permalink redirect
   def test_permalink
-    get :permalink, :params => { :code => "wBz3--" }
+    get permalink_path(:code => "wBz3--")
     assert_response :redirect
     assert_redirected_to :controller => :site, :action => :index, :anchor => "map=3/4.8779296875/3.955078125"
 
-    get :permalink, :params => { :code => "wBz3--", :m => "" }
+    get permalink_path(:code => "wBz3--", :m => "")
     assert_response :redirect
     assert_redirected_to :controller => :site, :action => :index, :mlat => "4.8779296875", :mlon => "3.955078125", :anchor => "map=3/4.8779296875/3.955078125"
 
-    get :permalink, :params => { :code => "wBz3--", :layers => "T" }
+    get permalink_path(:code => "wBz3--", :layers => "T")
     assert_response :redirect
     assert_redirected_to :controller => :site, :action => :index, :anchor => "map=3/4.8779296875/3.955078125&layers=T"
 
-    get :permalink, :params => { :code => "wBz3--", :node => 1 }
+    get permalink_path(:code => "wBz3--", :node => 1)
     assert_response :redirect
     assert_redirected_to :controller => :browse, :action => :node, :id => 1, :anchor => "map=3/4.8779296875/3.955078125"
 
-    get :permalink, :params => { :code => "wBz3--", :way => 2 }
+    get permalink_path(:code => "wBz3--", :way => 2)
     assert_response :redirect
     assert_redirected_to :controller => :browse, :action => :way, :id => 2, :anchor => "map=3/4.8779296875/3.955078125"
 
-    get :permalink, :params => { :code => "wBz3--", :relation => 3 }
+    get permalink_path(:code => "wBz3--", :relation => 3)
     assert_response :redirect
     assert_redirected_to :controller => :browse, :action => :relation, :id => 3, :anchor => "map=3/4.8779296875/3.955078125"
 
-    get :permalink, :params => { :code => "wBz3--", :changeset => 4 }
+    get permalink_path(:code => "wBz3--", :changeset => 4)
     assert_response :redirect
     assert_redirected_to :controller => :browse, :action => :changeset, :id => 4, :anchor => "map=3/4.8779296875/3.955078125"
   end
 
   # Test the key page
   def test_key
-    get :key, :xhr => true
+    get key_path, :xhr => true
+
     assert_response :success
     assert_template "key"
     assert_template :layout => false
@@ -175,14 +177,18 @@ class SiteControllerTest < ActionController::TestCase
 
   # Test the edit page redirects when you aren't logged in
   def test_edit
-    get :edit
+    get edit_path
+
     assert_response :redirect
     assert_redirected_to :controller => :users, :action => :login, :referer => "/edit"
   end
 
   # Test the error when trying to edit without public edits
   def test_edit_non_public
-    get :edit, :session => { :user => create(:user, :data_public => false) }
+    session_for(create(:user, :data_public => false))
+
+    get edit_path
+
     assert_response :success
     assert_template "edit"
     assert_select "a[href='https://wiki.openstreetmap.org/wiki/Disabling_anonymous_edits']"
@@ -190,7 +196,10 @@ class SiteControllerTest < ActionController::TestCase
 
   # Test the right editor gets used when the user hasn't set a preference
   def test_edit_without_preference
-    get :edit, :session => { :user => create(:user) }
+    session_for(create(:user))
+
+    get edit_path
+
     assert_response :success
     assert_template "edit"
     assert_template :partial => "_#{Settings.default_editor}", :count => 1
@@ -201,57 +210,57 @@ class SiteControllerTest < ActionController::TestCase
     user = create(:user)
     user.preferred_editor = "id"
     user.save!
+    session_for(user)
 
-    get :edit, :session => { :user => user }
+    get edit_path
     assert_response :success
     assert_template "edit"
     assert_template :partial => "_id", :count => 1
 
-    user = create(:user)
     user.preferred_editor = "potlatch2"
     user.save!
 
-    get :edit, :session => { :user => user }
+    get edit_path
     assert_response :success
     assert_template "edit"
     assert_template :partial => "_potlatch2", :count => 1
 
-    user = create(:user)
     user.preferred_editor = "potlatch"
     user.save!
 
-    get :edit, :session => { :user => user }
+    get edit_path
     assert_response :success
     assert_template "edit"
     assert_template :partial => "_potlatch", :count => 1
 
-    user = create(:user)
     user.preferred_editor = "remote"
     user.save!
 
-    get :edit, :session => { :user => user }
+    get edit_path
     assert_response :success
     assert_template "index"
   end
 
   # Test the right editor gets used when the URL has an override
   def test_edit_with_override
-    get :edit, :params => { :editor => "id" }, :session => { :user => create(:user) }
+    session_for(create(:user))
+
+    get edit_path(:editor => "id")
     assert_response :success
     assert_template "edit"
     assert_template :partial => "_id", :count => 1
 
-    get :edit, :params => { :editor => "potlatch2" }, :session => { :user => create(:user) }
+    get edit_path(:editor => "potlatch2")
     assert_response :success
     assert_template "edit"
     assert_template :partial => "_potlatch2", :count => 1
 
-    get :edit, :params => { :editor => "potlatch" }, :session => { :user => create(:user) }
+    get edit_path(:editor => "potlatch")
     assert_response :success
     assert_template "edit"
     assert_template :partial => "_potlatch", :count => 1
 
-    get :edit, :params => { :editor => "remote" }, :session => { :user => create(:user) }
+    get edit_path(:editor => "remote")
     assert_response :success
     assert_template "index"
   end
@@ -260,8 +269,10 @@ class SiteControllerTest < ActionController::TestCase
   def test_edit_with_node
     user = create(:user)
     node = create(:node, :lat => 1.0, :lon => 1.0)
+    session_for(user)
+
+    get edit_path(:node => node.id)
 
-    get :edit, :params => { :node => node.id }, :session => { :user => user }
     assert_response :success
     assert_template "edit"
     assert_equal 1.0, assigns(:lat)
@@ -273,15 +284,16 @@ class SiteControllerTest < ActionController::TestCase
   def test_edit_with_inaccessible_nodes
     user = create(:user)
     deleted_node = create(:node, :lat => 1.0, :lon => 1.0, :visible => false)
+    session_for(user)
 
-    get :edit, :params => { :node => 99999 }, :session => { :user => user }
+    get edit_path(:node => 99999)
     assert_response :success
     assert_template "edit"
     assert_nil assigns(:lat)
     assert_nil assigns(:lon)
     assert_nil assigns(:zoom)
 
-    get :edit, :params => { :node => deleted_node.id }, :session => { :user => user }
+    get edit_path(:node => deleted_node.id)
     assert_response :success
     assert_template "edit"
     assert_nil assigns(:lat)
@@ -295,8 +307,9 @@ class SiteControllerTest < ActionController::TestCase
     node = create(:node, :lat => 3, :lon => 3)
     way = create(:way)
     create(:way_node, :node => node, :way => way)
+    session_for(user)
 
-    get :edit, :params => { :way => way.id }, :session => { :user => user }
+    get edit_path(:way => way.id)
     assert_response :success
     assert_template "edit"
     assert_equal 3.0, assigns(:lat)
@@ -308,15 +321,16 @@ class SiteControllerTest < ActionController::TestCase
   def test_edit_with_inaccessible_ways
     user = create(:user)
     deleted_way = create(:way, :visible => false)
+    session_for(user)
 
-    get :edit, :params => { :way => 99999 }, :session => { :user => user }
+    get edit_path(:way => 99999)
     assert_response :success
     assert_template "edit"
     assert_nil assigns(:lat)
     assert_nil assigns(:lon)
     assert_nil assigns(:zoom)
 
-    get :edit, :params => { :way => deleted_way.id }, :session => { :user => user }
+    get edit_path(:way => deleted_way.id)
     assert_response :success
     assert_template "edit"
     assert_nil assigns(:lat)
@@ -330,8 +344,9 @@ class SiteControllerTest < ActionController::TestCase
     note = create(:note) do |n|
       n.comments.create(:author_id => user.id)
     end
+    session_for(user)
 
-    get :edit, :params => { :note => note.id }, :session => { :user => user }
+    get edit_path(:note => note.id)
     assert_response :success
     assert_template "edit"
     assert_equal 1.0, assigns(:lat)
@@ -345,15 +360,16 @@ class SiteControllerTest < ActionController::TestCase
     deleted_note = create(:note, :status => "hidden") do |n|
       n.comments.create(:author_id => user.id)
     end
+    session_for(user)
 
-    get :edit, :params => { :note => 99999 }, :session => { :user => user }
+    get edit_path(:note => 99999)
     assert_response :success
     assert_template "edit"
     assert_nil assigns(:lat)
     assert_nil assigns(:lon)
     assert_nil assigns(:zoom)
 
-    get :edit, :params => { :note => deleted_note.id }, :session => { :user => user }
+    get edit_path(:note => deleted_note.id)
     assert_response :success
     assert_template "edit"
     assert_nil assigns(:lat)
@@ -365,8 +381,9 @@ class SiteControllerTest < ActionController::TestCase
   def test_edit_with_gpx
     user = create(:user)
     gpx = create(:trace, :latitude => 1, :longitude => 1)
+    session_for(user)
 
-    get :edit, :params => { :gpx => gpx.id }, :session => { :user => user }
+    get edit_path(:gpx => gpx.id)
     assert_response :success
     assert_template "edit"
     assert_equal 1.0, assigns(:lat)
@@ -379,22 +396,23 @@ class SiteControllerTest < ActionController::TestCase
     user = create(:user)
     deleted_gpx = create(:trace, :deleted, :latitude => 1, :longitude => 1)
     private_gpx = create(:trace, :latitude => 1, :longitude => 1, :visibility => "private")
+    session_for(user)
 
-    get :edit, :params => { :gpx => 99999 }, :session => { :user => user }
+    get edit_path(:gpx => 99999)
     assert_response :success
     assert_template "edit"
     assert_nil assigns(:lat)
     assert_nil assigns(:lon)
     assert_nil assigns(:zoom)
 
-    get :edit, :params => { :gpx => deleted_gpx.id }, :session => { :user => user }
+    get edit_path(:gpx => deleted_gpx.id)
     assert_response :success
     assert_template "edit"
     assert_nil assigns(:lat)
     assert_nil assigns(:lon)
     assert_nil assigns(:zoom)
 
-    get :edit, :params => { :gpx => private_gpx.id }, :session => { :user => user }
+    get edit_path(:gpx => private_gpx.id)
     assert_response :success
     assert_template "edit"
     assert_nil assigns(:lat)
@@ -404,29 +422,29 @@ class SiteControllerTest < ActionController::TestCase
 
   # Test the edit page redirects
   def test_edit_redirect
-    get :edit, :params => { :lat => 4, :lon => 5 }
+    get edit_path(:lat => 4, :lon => 5)
     assert_redirected_to :controller => :site, :action => :edit, :anchor => "map=5/4/5"
 
-    get :edit, :params => { :lat => 4, :lon => 5, :zoom => 3 }
+    get edit_path(:lat => 4, :lon => 5, :zoom => 3)
     assert_redirected_to :controller => :site, :action => :edit, :anchor => "map=3/4/5"
 
-    get :edit, :params => { :lat => 4, :lon => 5, :zoom => 3, :editor => "id" }
+    get edit_path(:lat => 4, :lon => 5, :zoom => 3, :editor => "id")
     assert_redirected_to :controller => :site, :action => :edit, :editor => "id", :anchor => "map=3/4/5"
   end
 
   # Test the copyright page
   def test_copyright
-    get :copyright
+    get copyright_path
     assert_response :success
     assert_template "copyright"
     assert_select "div[lang='en'][dir='ltr']"
 
-    get :copyright, :params => { :copyright_locale => "fr" }
+    get copyright_path(:copyright_locale => "fr")
     assert_response :success
     assert_template "copyright"
     assert_select "div[lang='fr'][dir='ltr']"
 
-    get :copyright, :params => { :copyright_locale => "ar" }
+    get copyright_path(:copyright_locale => "ar")
     assert_response :success
     assert_template "copyright"
     assert_select "div[lang='ar'][dir='rtl']"
@@ -434,42 +452,43 @@ class SiteControllerTest < ActionController::TestCase
 
   # Test the welcome page
   def test_welcome
-    get :welcome
+    get welcome_path
     assert_response :redirect
     assert_redirected_to :controller => :users, :action => :login, :referer => "/welcome"
 
-    get :welcome, :session => { :user => create(:user) }
+    session_for(create(:user))
+    get welcome_path
     assert_response :success
     assert_template "welcome"
   end
 
   # Test the fixthemap page
   def test_fixthemap
-    get :fixthemap
+    get fixthemap_path
     assert_response :success
     assert_template "fixthemap"
   end
 
   # Test the help page
   def test_help
-    get :help
+    get help_path
     assert_response :success
     assert_template "help"
   end
 
   # Test the about page
   def test_about
-    get :about
+    get about_path
     assert_response :success
     assert_template "about"
     assert_select "div[lang='en'][dir='ltr']"
 
-    get :about, :params => { :about_locale => "fr" }
+    get about_path(:about_locale => "fr")
     assert_response :success
     assert_template "about"
     assert_select "div[lang='fr'][dir='ltr']"
 
-    get :about, :params => { :about_locale => "ar" }
+    get about_path(:about_locale => "ar")
     assert_response :success
     assert_template "about"
     assert_select "div[lang='ar'][dir='rtl']"
@@ -477,12 +496,12 @@ class SiteControllerTest < ActionController::TestCase
 
   # Test the export page
   def test_export
-    get :export
+    get export_path
     assert_response :success
     assert_template "export"
     assert_template :layout => "map"
 
-    get :export, :xhr => true
+    get export_path, :xhr => true
     assert_response :success
     assert_template "export"
     assert_template :layout => "xhr"
@@ -490,26 +509,29 @@ class SiteControllerTest < ActionController::TestCase
 
   # Test the offline page
   def test_offline
-    get :offline
+    get offline_path
     assert_response :success
     assert_template "offline"
   end
 
   # Test the rich text preview
   def test_preview
-    post :preview, :xhr => true, :params => { :type => "html" }
+    post preview_path(:type => "html"), :xhr => true
     assert_response :success
 
-    post :preview, :xhr => true, :params => { :type => "markdown" }
+    post preview_path(:type => "markdown"), :xhr => true
     assert_response :success
 
-    post :preview, :xhr => true, :params => { :type => "text" }
+    post preview_path(:type => "text"), :xhr => true
     assert_response :success
   end
 
   # Test the id frame
   def test_id
-    get :id, :session => { :user => create(:user) }
+    session_for(create(:user))
+
+    get id_path
+
     assert_response :success
     assert_template "id"
     assert_template :layout => false
index c19b809ecbcd102e4f606afa29a395ecfd2d681a..a5ea127f6b44785dac44cb67e4530431addaa51c 100644 (file)
@@ -185,6 +185,11 @@ module ActiveSupport
       click_on "Login", :match => :first
     end
 
+    def session_for(user)
+      post login_path, :params => { :username => user.display_name, :password => "test" }
+      follow_redirect!
+    end
+
     def xml_for_node(node)
       doc = OSM::API.new.get_xml_doc
       doc.root << xml_node_for_node(node)