CSC/ECE 517 Spring 2014/final doc updated qyx

E1414: Testing classes related to teams

Please be advised that we do not have deployment link, since our work are all back-end tests

Introduction

This project will be an extension of our previous E1406 project. For the previous project, we did some refactoring and testing for the controllers related to teams. This time, we are going to reuse most of our test environment, but extend the tests to other team-related classes. We also expect to examine and report the code that may require refactoring.

Test Environment

Framework

Rails default test framework

Sample data

Fixtures (under /test/fixtures)

Coverage tool

SimpleCov

Statistics

Please note that the coverage generate by SimpleCov may be lower than expect due to the added fixtures.

Overall (set of 6 tests)

105 tests, 156 assertions, 2 failures, 3060 / 13457 LOC (22.74%) covered.

Unit tests

18 tests, 18 assertions, 0 failures

Functional tests

87 tests, 138 assertions, 2 failures (reasons of failures can be found in "Possible Bugs")

Running Tests

Please note that all of our work will be under the /test folder, which means they will not show any change on the view. Run

rake test:prepare

before each action. To run unit tests

bundle exec ruby -I.:test -e "ARGV.each{|f| require f}" test/unit/team_test.rb test/unit/course_team_test.rb test/unit/assignment_team_test.rb test/unit/team_user_test.rb

To run functional tests

bundle exec ruby -I.:test -e "ARGV.each{|f| require f}" test/functional/advertise_for_partner_controller_test.rb test/functional/teams_users_controller_test.rb

You can also run multiple tests

 bundle exec ruby -I.:test -e "ARGV.each{|f| require f}" test/functional/teams_users_controller_test.rb test/functional/advertise_for_partner_controller_test.rb test/unit/course_team_test.rb test/unit/assignment_team_test.rb test/unit/team_test.rb test/unit/team_user_test.rb

running the whole test suite with rake test is not recommended, as the schema change overtime has broke some of the previous tests.

Background

teams_users.rb & teams_users_controller.rb

• Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
• There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

advertise_for_partner.rb

• This controller takes over the advertisement function from the student_team_controller, and make the class more RESTful.
• It seems like there has been a functional test, but the class name and set up looks like the other class. It may be necessary to re-run, and even re-write the test

team.rb

• This model defines the relationship between team object and other objects. It also has other methods to handle related functions about team operation
• There exists a unit test for team model, but there are only two test cases. Also, some of the methods under team.rb are duplicated, or either marked as not working. Further research may be required before starting to do the test.

assignment_team.rb & course_team.rb

• Both assignment_team class and course_team class are inherited from team class.
• These two classes have similar methods, which could be used to manage teams for assignment and course more effectively.

Summary of Found Issues

Changes made to the class

team.rb

Based on the discussion from the demo, the duplicated method was deleted instead of commented out

• duplicated def get_participants was removed
  • This is removed because the same method is defined again at line 20
• duplicated def self.generate_team_name() was removed
  • This is removed because the same method is defined again at line 131

advertise_for_team_controller.rb

• def new was removed
  • since it's empty, there is no need to keep the code there

Possible Refactoring

team.rb

• line 81 def self.create_node_object(name, parent_id)
  • see the TODO at line 80, the method will not work.

advertise_for_team_controller.rb

• update should be edit (this is mentioned in the comments of code)
• edit should be reexamined since it is only assigning the team object

assignment_team.rb

• in "delete" method, before sign_up.each.destory, we need to make sure sign_up is not nil.
• in "email" method, a method named get_team_users is called but this method has no definition. We should define get_team_users somewhere or delete "email" method.

course_team.rb

• add_participant(course_id, user)method should belong to course rather than course_team. Delete this method.
• self.export_all_assignment_team_related_to_course(csv, parent_id, options)method should be deleted.

teams_user.rb

• delete method should not call team.delete, comment out corresponding statements.
• self.is_team_empty method should not call length, replace corresponding statements with count method

teams_users_controller.rb

• delete_selected method mistake using find and first, this method could not work. No test will be made on the method

Possible Bugs

team.rb

• def add_member(user, assignment_id) allow nil to be passed
  • rails always raise runtime error when nil is passed. Test: "add member for course should create teams user"
• def randomize_all_by_parent passing wrong arguments
  • The code is passing wrong arguments in line 124 for add_member, there should be 2 arguments. Test: "randomize_all_by_parent"
• def import_team_members passing wrong arguments
  • it is calling add_member and passing nil for assignment_id, which will make rails raise error.Test: "import team members successfully"

assignment_team.rb

• def self.get_export_fields(options)
  • when the option team_name => false, the second element of the output array should be "Team members". But from the test, it is "Assignment Name". This is one failure from assignment_team_test.rb
• def add_participant(assignment_id, user)
  • the AssignmentParticipant.count does not increase. This is another failure from assignment_team_test.rb.

teams_user.rb

• def delete(option)
  • should not call team.delete, it will cause recursion error
• def self.is_team_empty(team_id)
  • rewrite this method without using length method, the length method will generate errors here

teams_users_controller.rb

• def delete_selected(options)
  • the statement TeamsUser.find(item_id).first cannot work, since the method find will return an exact object, which cannot be applied first method

Setup

To set up our testing for the models and controllers, we need some fixtures to support. Fixtures needed for corresponding classes are listed below However, all of the fixtures are required to be in the fixutre folder, otherwise it will raise error.

fixtures use in common

• teams.yml
• users.yml
• teams_users.yml
• courses.yml
• assignments.yml
• teams_participant.yml
• join_team_requests.yml
• participants.yml
• nodes.yml
• questions.yml
• signed_up_users.yml

Use Case Diagram

advertise_for_partner_controller.rb

Concerns for Test Cases

functional/teams_users_controller_test.rb

functional/teams_users_controller_test.rb

Because most of the tests are straightforward, only tests with concerns are listed.

• Delete_select
  • Please notice that this method will receive an item_id and delete the first team user belonging to that item

unit/teams_users_test.rb

Only tests with concerns are listed.

• Delete
  • Notice here we would not test if the method will delete team, only test if it could delete the team user

functional/advertise_for_partner_controller_test.rb

• # test "test update advertisement fail" do
  • should show flash for fail message when team.save fail, but there is no really a good way to fail team.save, so this is not implemented

unit/team_test.rb

Most of test should be straightforward, so only the test with concerns will be listed below

• test "get_participants from assignment team" do
  • Please notice that this will actually call the get_participants under AssignmentTeam

• test "generate_team_name" do
  • Please notice that this method (self.generate_team_name)is modified

• test "add member for course should create teams user" do
  • In the original code, it allow nil to be passed as parameter, and checks for assignment_id = nil, but rails will actually raise runtime error when nil is passed.

• #test "randomize_all_by_parent" do
  • Commented out because the bug in the code make it raise error because assignment id not passed. (wrong argument)

• #test "import team members successfully" do
  • problem: add_member are not passing correct assignment id in team.rb

unit/assignment_team_test.rb

Because most of the tests are straightforward, only tests with concerns are listed.

• delete
  • this method has bug. In the method, before sign_up.each.destory, we need to make sure sign_up is not nil. No test
• email
  • this method has bug because there is no method named get_team_users. No test

unit/course_team_test.rb

Only tests with concerns are listed.

• add_participant(course_id, user)
  • this method should belong to course rather than course_team. This test may be not useful.
• self.export_all_assignment_team_related_to_course(csv, parent_id, options)
  • this method should be deleted from course_team class. No test

Possible Refactoring

teams_participant.rb & teams_participants_controller.rb

• These two files are never used, no tests will cover them.

Sample Test Code

We show two pieces of test code for two controllers from our previous work to explain how our test works

   test "create_student team with name in use" do
       sessionVars = session_for(users(:student8))
       post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
       assert_equal 'Team name is already in use.', flash[:notice]
       assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
   end

   test "create_should_increase_number_of_teams_course" do
       sessionVars = session_for(users(:instructor1))
       sessionVars[:team_type] = "Course"
       assert_difference 'Team.count' do
         get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
       end
   end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use post or get, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command rake test TEST=test/functional/your_test_file.rb, you will see if the test is passed or not.

References

<references/>

• http://guides.rubyonrails.org/testing.html
• https://github.com/colszowka/simplecov