Add comments to the user block functional tests

diff --git a/test/functional/user_blocks_controller_test.rb b/test/functional/user_blocks_controller_test.rb
index a93e079348bb9027690c34da3aacc4ce3a4a85f1..4029fca265f727b6a375d96424a7403c15eee2cc 100644 (file)
--- a/test/functional/user_blocks_controller_test.rb
+++ b/test/functional/user_blocks_controller_test.rb
@@ -61,6 +61,7 @@ class UserBlocksControllerTest < ActionController::TestCase
   ##
   # test the index action
   def test_index
+    # The list of blocks should load
     get :index
     assert_response :success
     assert_select "table#block_list", :count => 1 do
@@ -74,22 +75,27 @@ class UserBlocksControllerTest < ActionController::TestCase
   ##
   # test the show action
   def test_show
+    # Viewing a block should fail when no ID is given
     get :show
     assert_response :not_found
     assert_template "not_found"
     assert_select "p", "Sorry, the user block with ID  could not be found."
 
+    # Viewing a block should fail when a bogus ID is given
     get :show, :id => 99999
     assert_response :not_found
     assert_template "not_found"
     assert_select "p", "Sorry, the user block with ID 99999 could not be found."
 
+    # Viewing an active block should work
     get :show, :id => user_blocks(:active_block)
     assert_response :success
 
+    # Viewing an expired block should work
     get :show, :id => user_blocks(:expired_block)
     assert_response :success
 
+    # Viewing a revoked block should work
     get :show, :id => user_blocks(:revoked_block)
     assert_response :success
   end
@@ -97,19 +103,24 @@ class UserBlocksControllerTest < ActionController::TestCase
   ##
   # test the new action
   def test_new
+    # Check that the block creation page requires us to login
     get :new, :display_name => users(:normal_user).display_name
     assert_redirected_to login_path(:referer => new_user_block_path(:display_name => users(:normal_user).display_name))
 
+    # Login as a normal user
     session[:user] = users(:public_user).id
     cookies["_osm_username"] = users(:public_user).display_name
 
+    # Check that normal users can't load the block creation page
     get :new, :display_name => users(:normal_user).display_name
     assert_redirected_to user_blocks_path
     assert_equal "You need to be a moderator to perform that action.", flash[:error]
 
+    # Login as a moderator
     session[:user] = users(:moderator_user).id
     cookies["_osm_username"] = users(:moderator_user).display_name
 
+    # Check that the block creation page loads for moderators
     get :new, :display_name => users(:normal_user).display_name
     assert_response :success
     assert_select "form#new_user_block", :count => 1 do
@@ -120,11 +131,13 @@ class UserBlocksControllerTest < ActionController::TestCase
       assert_select "input[type='submit'][value='Create block']", :count => 1
     end
 
+    # We should get an error if no user is specified
     get :new
     assert_response :not_found
     assert_template "user/no_such_user"
     assert_select "h2", "The user  does not exist"
 
+    # We should get an error if the user doesn't exist
     get :new, :display_name => "non_existent_user"
     assert_response :not_found
     assert_template "user/no_such_user"
@@ -134,19 +147,24 @@ class UserBlocksControllerTest < ActionController::TestCase
   ##
   # test the edit action
   def test_edit
+    # Check that the block edit page requires us to login
     get :edit, :id => user_blocks(:active_block).id
     assert_redirected_to login_path(:referer => edit_user_block_path(:id => user_blocks(:active_block).id))
 
+    # Login as a normal user
     session[:user] = users(:public_user).id
     cookies["_osm_username"] = users(:public_user).display_name
 
+    # Check that normal users can't load the block edit page
     get :edit, :id => user_blocks(:active_block).id
     assert_redirected_to user_blocks_path
     assert_equal "You need to be a moderator to perform that action.", flash[:error]
 
+    # Login as a moderator
     session[:user] = users(:moderator_user).id
     cookies["_osm_username"] = users(:moderator_user).display_name
 
+    # Check that the block edit page loads for moderators
     get :edit, :id => user_blocks(:active_block).id
     assert_response :success
     assert_select "form#edit_user_block_#{user_blocks(:active_block).id}", :count => 1 do
@@ -156,11 +174,13 @@ class UserBlocksControllerTest < ActionController::TestCase
       assert_select "input[type='submit'][value='Update block']", :count => 1
     end
 
+    # We should get an error if no user is specified
     get :edit
     assert_response :not_found
     assert_template "not_found"
     assert_select "p", "Sorry, the user block with ID  could not be found."
 
+    # We should get an error if the user doesn't exist
     get :edit, :id => 99999
     assert_response :not_found
     assert_template "not_found"
@@ -170,18 +190,23 @@ class UserBlocksControllerTest < ActionController::TestCase
   ##
   # test the create action
   def test_create
+    # Not logged in yet, so creating a block should fail
     post :create
     assert_response :forbidden
 
+    # Login as a normal user
     session[:user] = users(:public_user).id
     cookies["_osm_username"] = users(:public_user).display_name
 
+    # Check that normal users can't create blocks
     post :create
     assert_response :forbidden
 
+    # Login as a moderator
     session[:user] = users(:moderator_user).id
     cookies["_osm_username"] = users(:moderator_user).display_name
 
+    # A bogus block period should result in an error
     assert_no_difference "UserBlock.count" do
       post :create,
         :display_name => users(:unblocked_user).display_name,
@@ -190,6 +215,7 @@ class UserBlocksControllerTest < ActionController::TestCase
     assert_redirected_to new_user_block_path(:display_name => users(:unblocked_user).display_name)
     assert_equal "The blocking period must be one of the values selectable in the drop-down list.", flash[:error]
 
+    # Check that creating a block works
     assert_difference "UserBlock.count", 1 do
       post :create,
         :display_name => users(:unblocked_user).display_name,
@@ -207,11 +233,13 @@ class UserBlocksControllerTest < ActionController::TestCase
     assert_equal "markdown", b.reason_format
     assert_equal users(:moderator_user).id, b.creator_id
 
+    # We should get an error if no user is specified
     post :create
     assert_response :not_found
     assert_template "user/no_such_user"
     assert_select "h2", "The user  does not exist"
 
+    # We should get an error if the user doesn't exist
     post :create, :display_name => "non_existent_user"
     assert_response :not_found
     assert_template "user/no_such_user"
@@ -221,18 +249,23 @@ class UserBlocksControllerTest < ActionController::TestCase
   ##
   # test the update action
   def test_update
+    # Not logged in yet, so updating a block should fail
     put :update
     assert_response :forbidden
 
+    # Login as a normal user
     session[:user] = users(:public_user).id
     cookies["_osm_username"] = users(:public_user).display_name
 
+    # Check that normal users can't update blocks
     put :update
     assert_response :forbidden
 
+    # Login as the wrong moderator
     session[:user] = users(:second_moderator_user).id
     cookies["_osm_username"] = users(:second_moderator_user).display_name
 
+    # Check that only the person who created a block can update it
     assert_no_difference "UserBlock.count" do
       put :update,
         :id => user_blocks(:active_block).id,
@@ -242,9 +275,11 @@ class UserBlocksControllerTest < ActionController::TestCase
     assert_redirected_to edit_user_block_path(:id => user_blocks(:active_block).id)
     assert_equal "Only the moderator who created this block can edit it.", flash[:error]
 
+    # Login as the correct moderator
     session[:user] = users(:moderator_user).id
     cookies["_osm_username"] = users(:moderator_user).display_name
 
+    # A bogus block period should result in an error
     assert_no_difference "UserBlock.count" do
       put :update,
         :id => user_blocks(:active_block).id,
@@ -253,6 +288,7 @@ class UserBlocksControllerTest < ActionController::TestCase
     assert_redirected_to edit_user_block_path(:id => user_blocks(:active_block).id)
     assert_equal "The blocking period must be one of the values selectable in the drop-down list.", flash[:error]
 
+    # Check that updating a block works
     assert_no_difference "UserBlock.count" do
       put :update,
         :id => user_blocks(:active_block).id,
@@ -266,11 +302,13 @@ class UserBlocksControllerTest < ActionController::TestCase
     assert_equal true, b.needs_view
     assert_equal "Vandalism", b.reason
 
+    # We should get an error if no block ID is specified
     put :update
     assert_response :not_found
     assert_template "not_found"
     assert_select "p", "Sorry, the user block with ID  could not be found."
 
+    # We should get an error if the block doesn't exist
     put :update, :id => 99999
     assert_response :not_found
     assert_template "not_found"
@@ -280,19 +318,24 @@ class UserBlocksControllerTest < ActionController::TestCase
   ##
   # test the revoke action
   def test_revoke
+    # Check that the block revoke page requires us to login
     get :revoke, :id => user_blocks(:active_block).id
     assert_redirected_to login_path(:referer => revoke_user_block_path(:id => user_blocks(:active_block).id))
 
+    # Login as a normal user
     session[:user] = users(:public_user).id
     cookies["_osm_username"] = users(:public_user).display_name
 
+    # Check that normal users can't load the block revoke page
     get :revoke, :id => user_blocks(:active_block).id
     assert_redirected_to user_blocks_path
     assert_equal "You need to be a moderator to perform that action.", flash[:error]
 
+    # Login as a moderator
     session[:user] = users(:moderator_user).id
     cookies["_osm_username"] = users(:moderator_user).display_name
 
+    # Check that the block revoke page loads for moderators
     get :revoke, :id => user_blocks(:active_block).id
     assert_response :success
     assert_template "revoke"
@@ -301,16 +344,19 @@ class UserBlocksControllerTest < ActionController::TestCase
       assert_select "input[type='submit'][value='Revoke!']", :count => 1
     end
 
+    # Check that revoking a block works
     post :revoke, :id => user_blocks(:active_block).id, :confirm => true
     assert_redirected_to user_block_path(:id => user_blocks(:active_block).id)
     b = UserBlock.find(user_blocks(:active_block).id)
     assert_in_delta Time.now, b.ends_at, 1
 
+    # We should get an error if no block ID is specified
     get :revoke
     assert_response :not_found
     assert_template "not_found"
     assert_select "p", "Sorry, the user block with ID  could not be found."
 
+    # We should get an error if the block doesn't exist
     get :revoke, :id => 99999
     assert_response :not_found
     assert_template "not_found"
@@ -320,21 +366,25 @@ class UserBlocksControllerTest < ActionController::TestCase
   ##
   # test the blocks_on action
   def test_blocks_on
+    # Asking for a list of blocks with no user name should fail
     get :blocks_on
     assert_response :not_found
     assert_template "user/no_such_user"
     assert_select "h2", "The user  does not exist"
 
+    # Asking for a list of blocks with a bogus user name should fail
     get :blocks_on, :display_name => "non_existent_user"
     assert_response :not_found
     assert_template "user/no_such_user"
     assert_select "h2", "The user non_existent_user does not exist"
 
+    # Check the list of blocks for a user that has never been blocked
     get :blocks_on, :display_name => users(:normal_user).display_name
     assert_response :success
     assert_select "table#block_list", false
     assert_select "p", "#{users(:normal_user).display_name} has not been blocked yet."
 
+    # Check the list of blocks for a user that is currently blocked
     get :blocks_on, :display_name => users(:blocked_user).display_name
     assert_response :success
     assert_select "table#block_list", :count => 1 do
@@ -343,6 +393,7 @@ class UserBlocksControllerTest < ActionController::TestCase
       assert_select "a[href='#{user_block_path(user_blocks(:revoked_block))}']", 1
     end
 
+    # Check the list of blocks for a user that has previously been blocked
     get :blocks_on, :display_name => users(:unblocked_user).display_name
     assert_response :success
     assert_select "table#block_list", :count => 1 do
@@ -354,16 +405,19 @@ class UserBlocksControllerTest < ActionController::TestCase
   ##
   # test the blocks_by action
   def test_blocks_by
+    # Asking for a list of blocks with no user name should fail
     get :blocks_by
     assert_response :not_found
     assert_template "user/no_such_user"
     assert_select "h2", "The user  does not exist"
 
+    # Asking for a list of blocks with a bogus user name should fail
     get :blocks_by, :display_name => "non_existent_user"
     assert_response :not_found
     assert_template "user/no_such_user"
     assert_select "h2", "The user non_existent_user does not exist"
 
+    # Check the list of blocks given by one moderator
     get :blocks_by, :display_name => users(:moderator_user).display_name
     assert_response :success
     assert_select "table#block_list", :count => 1 do
@@ -371,6 +425,7 @@ class UserBlocksControllerTest < ActionController::TestCase
       assert_select "a[href='#{user_block_path(user_blocks(:active_block))}']", 1
     end
 
+    # Check the list of blocks given by a different moderator
     get :blocks_by, :display_name => users(:second_moderator_user).display_name
     assert_response :success
     assert_select "table#block_list", :count => 1 do
@@ -379,6 +434,7 @@ class UserBlocksControllerTest < ActionController::TestCase
       assert_select "a[href='#{user_block_path(user_blocks(:revoked_block))}']", 1
     end
 
+    # Check the list of blocks (not) given by a normal user
     get :blocks_by, :display_name => users(:normal_user).display_name
     assert_response :success
     assert_select "table#block_list", false