CSC/ECE 517 Spring 2014/oss E1414 st

From Expertiza_Wiki
Jump to navigation Jump to search

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.

Classes

app/controllers/teams_controller.rb

teams_controller contains functionalities for team management for instructor/TA accounts. Instructor/TA can:

  • view current teams
  • create new teams
  • import/export teams
  • delete all teams/delete specified team
  • copy existing teams from a course down to an assignment(inherit)
  • update team's information

app/models/teams_users.rb

The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

app/controllers/teams_users_controller.rb

The teams_users_controller support team member management for instructor/TA accounts Instruction/TA can:

  • get a user name by inputting part of the name
  • list team members of a team
  • add a user to a team
  • remove a team member from a team
  • remove all members belonging to an item

app/controllers/advertise_for_partners_controller.rb

The advertise_for_partners_controller work with the student_team_controllers, allowing student manage advertisement for their teams.

A student can:

  • create a new advertisement for the team
  • edit the advertisement content
  • remove advertisement record from the table for the specific team

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.

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

app/models/teams_users.rb & app/controllers/teams_users_controller.rb

  • Teams.yml
  • Usres.yml
  • Teams_Uers.yml
  • Courses.yml
  • Assignments.yml

Testing Scenarios

app/models/teams_users.rb & app/controllers/teams_users_controller.rb

Based on the user story of the teams_users_controller.rb, there are also several sub-scenarios for each method in the user story.

  • Auto_complete_for_user_name:
    • Test auto_complete_for_user_name with valid user name
    • Test auto_complete_for_user_name with invalid user name
  • List
    • Test List with valid team id
    • Test List with invalid team id
  • New
    • Test New with valid team id
    • Test New with invalid team id
  • Create
    • Test Create with valid team id
      • Test Create with valid user id and maximum member number is not reached
      • Test Create with invalid user id and maximum member number is not reached
      • Test Create with valid user id and maximum member number is reached
      • Test Create with invalid user id and maximum member number is reached
    • Test Create with invalid team id
      • Test Create with valid user id and maximum member number is not reached
      • Test Create with invalid user id and maximum member number is not reached
      • Test Create with valid user id and maximum member number is reached
      • Test Create with invalid user id and maximum member number is reached
  • Delete
    • Test Delete with valid user id
    • Test Delete with invalid user id
  • Delete_select
    • Test Delete_select with valid item id
    • Test Delete_select with invalid item id

Deployment

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

rake test TEST=test/functional/student_team_controller.rb

and

rake test TEST=test/functional/teams_controller

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

Testing

Framework
Rails default test framework
Sample data
Fixtures (under /test/fixtures)
Coverage tool
SimpleCov
Total Number of Tests
37
Previous Coverage
22.32%
Current Coverage
24.08%

Sample Test Code

We show two pieces of test code for two controllers 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.

Result

Future Works

student_team_controller

Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late

There are several error raised from leave method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as advertise and remove_advertisement may need to be double checked and see if they are redundant.

teams_controller

The method create_teams_view does not be used at all. So it is safe to delete it.

The method create_teams calls the method randomize_all_by_parent, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

References

<references/>