From: John Dong <jdong@mit.edu>
Date: Fri, 17 Aug 2007 23:34:05 +0000 (-0400)
Subject: Merge from jdong, XMLRPC changes and testcases
X-Git-Url: https://projects.mako.cc/source/selectricity-live/commitdiff_plain/4ab69ea7afaeff96714961139e7c696e7c7141ab?hp=a16962155a3c3c6616bfe32c7216f3631836d38c

Merge from jdong, XMLRPC changes and testcases
---

diff --git a/app/apis/selectricity_api.rb b/app/apis/selectricity_api.rb
index b1210c6..9c95369 100644
--- a/app/apis/selectricity_api.rb
+++ b/app/apis/selectricity_api.rb
@@ -7,6 +7,7 @@ class ElectionStruct < ActionWebService::Struct
 end
 class VoteInfo < ActionWebService::Struct
   member :voter_id, :int
+  member :voter_session_id, :string
   member :voter_ipaddress, :string
   member :vote_time, :int
   member :vote, [:int]
@@ -18,12 +19,10 @@ class VoteResultStruct < ActionWebService::Struct
   member :condorcet_winners, [:int]
   member :ssd_winners, [:int]
   member :borda_winners, [:int]
-  member :errors, [:string]
 end
 class CandidateMap < ActionWebService::Struct
   member :candidate_ids, [:int]
   member :candidate_names, [:string]
-  member :errors, [:string]
 end
 class SelectricityAPI < ActionWebService::API::Base
   api_method :cast_quickvote, :expects => [:string, :int, [[:int]]], :returns => [:string]
diff --git a/app/models/selectricity_service.rb b/app/models/selectricity_service.rb
index 6d338de..196161a 100644
--- a/app/models/selectricity_service.rb
+++ b/app/models/selectricity_service.rb
@@ -28,7 +28,7 @@ class SelectricityService < ActionWebService::Base
   def quickvote_candidate_ids_to_names(shortname, id_list)
     qv=QuickVote.ident_to_quickvote(shortname)
     candidates={}
-    return [] unless qv
+    raise ArgumentError.new("Quickvote by name #{shortname} doesn't exist") unless qv
     qv.results
     qv.candidates.each {|c| candidates[c.id] = c}
     results=[]
@@ -46,10 +46,8 @@ class SelectricityService < ActionWebService::Base
     #TODO: Validate shortname
     qv=QuickVote.ident_to_quickvote(shortname)
     result=VoteResultStruct.new
-    result.errors=[]
     unless qv
-      result.errors << "No quickvote with name #{shortname} found!"
-      return result
+      raise ArgumentError.new("No quickvote with name #{shortname} found!")
     end
     qv.results
     result.plurality_winners=qv.plurality_result.winners
@@ -62,10 +60,8 @@ class SelectricityService < ActionWebService::Base
   def get_quickvote_candidate_map(shortname)
     qv=QuickVote.ident_to_quickvote(shortname)
     result=CandidateMap.new
-    result.errors=[]
     unless qv
-      result.errors << "No quickvote with name #{shortname} found!"
-      return result
+      raise ArgumentError.new("No quickvote with name #{shortname} found!")
     end
     candidates={}
     qv.candidates.each {|c| candidates[c.id] = c.name}
@@ -77,10 +73,10 @@ class SelectricityService < ActionWebService::Base
     qv=QuickVote.ident_to_quickvote(shortname)
     votes=Array.new
     unless qv
-      return result
+      raise ArgumentError.new("Cannot find QuickVote #{shortname}")
     end
     qv.votes.each  do |vote|
-      votes << VoteInfo.new(:voter_id => vote.voter.id, :voter_ipaddress => vote.voter.ipaddress, :vote_time => vote.time.to_i, :vote => vote.votes)
+      votes << VoteInfo.new(:voter_id => vote.voter.id, :voter_ipaddress => vote.voter.ipaddress, :vote_time => vote.time.to_i, :vote => vote.votes, :voter_session_id => vote.voter.session_id )
     end
     return votes
   end
@@ -92,7 +88,7 @@ class SelectricityService < ActionWebService::Base
     return all
   end
   def get_quickvote(shortname)
-    return ElectionStruct.new unless election=QuickVote.ident_to_quickvote(shortname)
+    raise ArgumentError.new("Cannot find QuickVote named #{shortname}") unless election=QuickVote.ident_to_quickvote(shortname)
     return ElectionStruct.new(:id => election.id, :name => election.name, :description => election.description, :candidate_ids => election.candidates.collect {|c| c.id }, :candidate_names => election.candidates.collect {|c| c.name } )
   end
   def create_quickvote(election)
@@ -101,7 +97,7 @@ class SelectricityService < ActionWebService::Base
     if qv.save
       return ""
     else
-      return "Saving quickvote FAILED:"+qv.errors.inspect
+      raise ArgumentError.new("Saving quickvote FAILED:"+qv.errors.inspect)
     end
   end
 
diff --git a/test/unit/selectricityservice_test.rb b/test/unit/selectricityservice_test.rb
index 74b26d4..0596dc7 100644
--- a/test/unit/selectricityservice_test.rb
+++ b/test/unit/selectricityservice_test.rb
@@ -21,20 +21,49 @@ class SelectricityServiceTest < Test::Unit::TestCase
     test_create_quickvote
     election = invoke_delegated :vote, :get_quickvote, "TestVote"
     casted_vote = election.candidate_ids.sort_by {rand} #Shuffles
-    invoke_delegated :vote, :cast_quickvote, "TestVote", 42, [casted_vote]
-    quickvote_votes= invoke_delegated :vote, :get_quickvote_votes, "TestVote"
-    assert_equal quickvote_votes.length, 1
-    assert_equal quickvote_votes[0].vote, casted_vote
+    assert_cast_quickvote_succeeds "TestVote", 42, [casted_vote]
+  end
+  def test_cast_nil_quickvote
+    assert_cast_quickvote_fails nil, nil, nil
+    assert_cast_quickvote_fails "foo", nil, nil
+    assert_cast_quickvote_fails "foo",33, []
+    test_create_quickvote
+    assert_cast_quickvote_fails "TestVote",42,nil
+    assert_cast_quickvote_fails "TestVote",nil,[]
+  end
+  def test_cast_malformed_votelist
+    test_create_quickvote
+    election = invoke_delegated :vote, :get_quickvote, "TestVote"
+    assert_cast_quickvote_fails "TestVote", 11, [election.candidate_ids[0]]
+    assert_cast_quickvote_fails "TestVote", 11, [1,2]
+    assert_cast_quickvote_fails "TestVote", 11, [election.candidate_ids[0],election.candidate_ids[0], election.candidate_ids[1], election.candidate_ids[1], election.candidate_ids[2]]
+  end
+  def test_get_nonexistent_quickvote
+    assert_raises ArgumentError do
+      qv = invoke_delegated :vote, :get_quickvote, "asdfasdfasdf"
+    end
+  end
+  def test_get_voters_nonexistent_quickvote
+    assert_raises(ArgumentError) {invoke_delegated :vote, :get_quickvote_votes, "asdfasdf"}
+  end
+  def test_get_candidate_map_nonexistent_quickvote
+    assert_raises(ArgumentError) { invoke_delegated :vote, :get_quickvote_candidate_map, "asdfasdf"}
   end
   def test_cast_mass_quickvote
     test_create_quickvote
     election = invoke_delegated :vote, :get_quickvote, "TestVote"
     20.times do |t|
       casted_vote = election.candidate_ids.sort_by {rand}
-      invoke_delegated :vote, :cast_quickvote, "TestVote", t, [casted_vote]
+      assert_cast_quickvote_succeeds "TestVote", t, [casted_vote]
     end
-    quickvote_votes= invoke_delegated :vote, :get_quickvote_votes, "TestVote"
-    assert_equal quickvote_votes.length, 20
+  end
+  def test_cast_quickvote_nonexistent
+    assert_cast_quickvote_fails "ASDFJOFASF", "me", [1,2,3]
+  end
+  def test_cast_quickvote_nonexistent_candidates
+    test_create_quickvote
+    election = invoke_delegated :vote, :get_quickvote, "TestVote"
+    assert_cast_quickvote_fails "TestVote", 42, [123,342314,5342,1,1,2]
   end
   def test_create_mass_quickvote
     10.times do |t|
@@ -110,42 +139,57 @@ class SelectricityServiceTest < Test::Unit::TestCase
     end
     25.times do |t|
       vote = [candidates["jdong"], candidates["mako"], candidates["justin"]]
-      invoke_delegated :vote, :cast_quickvote, "favdev", "1:#{t}", [vote]
+      assert_cast_quickvote_succeeds "favdev", "1:#{t}", [vote]
     end
     5.times do |t|
       vote = [candidates["mako"], candidates["justin"], candidates["jdong"]]
-      invoke_delegated :vote, :cast_quickvote, "favdev", "2:#{t}", [vote]
+      assert_cast_quickvote_succeeds "favdev", "2:#{t}", [vote]
     end
     10.times do |t|
       vote = [candidates["justin"], candidates["mako"], candidates["jdong"]]
-      invoke_delegated :vote, :cast_quickvote, "favdev", "3:#{t}", [vote]
+      assert_cast_quickvote_succeeds "favdev", "3:#{t}", [vote]
     end
-    results=invoke_delegated(:vote, :get_quickvote_results, "favdev")
+    results=nil
+    assert_nothing_raised {results=invoke_delegated(:vote, :get_quickvote_results, "favdev")}
     assert_equal results.approval_winners, [candidates["mako"]]
     assert_equal results.borda_winners, [candidates["jdong"]]
     assert_equal results.plurality_winners, [candidates["jdong"]]
     assert_equal results.condorcet_winners, [candidates["jdong"]]
     assert_equal results.ssd_winners, [candidates["jdong"]]
-    assert_equal results.errors.length, 0
   end
   private
+  def assert_cast_quickvote_succeeds(shortname, id, vote)
+    assert_nothing_raised do
+      old_votes = invoke_delegated :vote, :get_quickvote_votes, shortname
+      invoke_delegated :vote, :cast_quickvote, shortname, id, vote
+      new_votes = invoke_delegated :vote, :get_quickvote_votes, shortname
+      assert_equal old_votes.length, new_votes.length-1
+      assert_not_nil(reflection = new_votes.find_all { |v| v.voter_session_id == "XMLRPC:#{id}" })
+      assert_equal reflection.length, 1
+      assert_equal reflection[0].vote, vote[0]
+    end
+  end
+  def assert_cast_quickvote_fails(shortname, id, vote)
+    assert_raise Test::Unit::AssertionFailedError do 
+      assert_cast_quickvote_succeeds(shortname, id, vote)
+    end
+  end
   def assert_create_quickvote_succeeds(election)
     # Checks if a created quickvote is identical when retrieved
-    old_len=invoke_delegated(:vote,:list_quickvotes).length
-    result = invoke_delegated :vote, :create_quickvote, election
-    assert_equal result, ""
-    reflection = invoke_delegated :vote, :get_quickvote, election.name
-    assert_equal election.description, reflection.description
-    assert_equal 0, election.name.casecmp(reflection.name)
-    assert_equal election.candidate_names, reflection.candidate_names
-    assert_equal(invoke_delegated(:vote,:list_quickvotes).length, old_len+1)
+    assert_nothing_raised do
+      old_len=invoke_delegated(:vote,:list_quickvotes).length
+      result = invoke_delegated :vote, :create_quickvote, election
+      assert_equal result, ""
+      reflection = invoke_delegated :vote, :get_quickvote, election.name
+      assert_equal election.description, reflection.description
+      assert_equal 0, election.name.casecmp(reflection.name)
+      assert_equal election.candidate_names, reflection.candidate_names
+      assert_equal(invoke_delegated(:vote,:list_quickvotes).length, old_len+1)
+    end
   end
   def assert_create_quickvote_fails(election)
-    # Helper function to check that creating this quickvote fails
-    old_len=invoke_delegated(:vote,:list_quickvotes).length
-    result = invoke_delegated :vote, :create_quickvote, election
-    assert_instance_of String, result
-    assert_not_equal result.length, 0
-    assert_equal(invoke_delegated(:vote,:list_quickvotes).length, old_len)
+    assert_raise Test::Unit::AssertionFailedError do
+      assert_create_quickvote_succeeds election
+    end
   end
 end