Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T14:48:20Z

Xguo6:

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov 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 <code>rake test</code> 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.

=== Possible Bugs ===
==== team.rb ====
* def add_member(user, assignment_id) allow nil to be passed
** rails always raise runtime error when nil is passed. [[#unit/team_test.rb|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. [[#unit/team_test.rb|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.[[#unit/team_test.rb|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.

== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Concerns for Test Cases ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

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

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== 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.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T14:46:30Z

Xguo6:

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov 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 <code>rake test</code> 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.

=== Possible Bugs ===
==== team.rb ====
* def add_member(user, assignment_id) allow nil to be passed
** rails always raise runtime error when nil is passed. [[#unit/team_test.rb|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. [[#unit/team_test.rb|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.[[#unit/team_test.rb|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.

== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Concerns for Test Cases ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

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

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== 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.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T14:39:40Z

Xguo6: /* Statistics */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov 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 <code>rake test</code> 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

=== Possible Bugs ===
==== team.rb ====
* def add_member(user, assignment_id) allow nil to be passed
** rails always raise runtime error when nil is passed. [[#unit/team_test.rb|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. [[#unit/team_test.rb|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.[[#unit/team_test.rb|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.

== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Concerns for Test Cases ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

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

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== 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.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T14:39:10Z

Xguo6: /* Statistics */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov 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 failure 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 <code>rake test</code> 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

=== Possible Bugs ===
==== team.rb ====
* def add_member(user, assignment_id) allow nil to be passed
** rails always raise runtime error when nil is passed. [[#unit/team_test.rb|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. [[#unit/team_test.rb|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.[[#unit/team_test.rb|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.

== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Concerns for Test Cases ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

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

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== 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.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T14:37:45Z

Xguo6: /* Possible Bugs */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov 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

== 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 <code>rake test</code> 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

=== Possible Bugs ===
==== team.rb ====
* def add_member(user, assignment_id) allow nil to be passed
** rails always raise runtime error when nil is passed. [[#unit/team_test.rb|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. [[#unit/team_test.rb|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.[[#unit/team_test.rb|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.

== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Concerns for Test Cases ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

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

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== 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.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T14:26:52Z

Xguo6: /* unit/course_team_test.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov 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

== 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 <code>rake test</code> 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

=== Possible Bugs ===
==== team.rb ====
* def add_member(user, assignment_id) allow nil to be passed
** rails always raise runtime error when nil is passed. [[#unit/team_test.rb|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. [[#unit/team_test.rb|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.[[#unit/team_test.rb|Test: "import team members successfully" ]]

== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Concerns for Test Cases ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

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

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== 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.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T14:22:34Z

Xguo6: /* unit/assignment_team_test.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov 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

== 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 <code>rake test</code> 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

=== Possible Bugs ===
==== team.rb ====
* def add_member(user, assignment_id) allow nil to be passed
** rails always raise runtime error when nil is passed. [[#unit/team_test.rb|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. [[#unit/team_test.rb|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.[[#unit/team_test.rb|Test: "import team members successfully" ]]

== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Concerns for Test Cases ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

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

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== 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 ===
Because most of the methods in course_team.rb are similar with that in assignment_team.rb if they have the same name. So I skip the same name method. Take the test/unit/course_team_test.rb as a reference.
* self.export_all_assignment_team_related_to_course(csv, parent_id, options)
** this method should be deleted here. No test

== Possible Refactoring ==
=== teams_participant.rb & teams_participants_controller.rb ===
* These two files are never used, no tests will cover them.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T14:15:38Z

Xguo6: /* unit/assignment_team_test.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov 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

== 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 <code>rake test</code> 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

=== Possible Bugs ===
==== team.rb ====
* def add_member(user, assignment_id) allow nil to be passed
** rails always raise runtime error when nil is passed. [[#unit/team_test.rb|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. [[#unit/team_test.rb|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.[[#unit/team_test.rb|Test: "import team members successfully" ]]

== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Concerns for Test Cases ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

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

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== 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 ===
* reviewed_by?(reviewer)
** TeamReviewResponseMap is empty, so test this method will return false
* reviewed_contributor?(contributor)
** TeamReviewResponseMap is empty, so test this method will return false
* delete
** this method has bug. No test
* email
** this method has bug because there is no method named get_team_users. No test

=== unit/course_team_test.rb ===
Because most of the methods in course_team.rb are similar with that in assignment_team.rb if they have the same name. So I skip the same name method. Take the test/unit/course_team_test.rb as a reference.
* self.export_all_assignment_team_related_to_course(csv, parent_id, options)
** this method should be deleted here. No test

== Possible Refactoring ==
=== teams_participant.rb & teams_participants_controller.rb ===
* These two files are never used, no tests will cover them.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T14:13:17Z

Xguo6: /* unit/assignment_team_test.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov 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

== 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 <code>rake test</code> 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

=== Possible Bugs ===
==== team.rb ====
* def add_member(user, assignment_id) allow nil to be passed
** rails always raise runtime error when nil is passed. [[#unit/team_test.rb|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. [[#unit/team_test.rb|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.[[#unit/team_test.rb|Test: "import team members successfully" ]]

== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Concerns for Test Cases ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

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

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== 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 ===
* assign_reviewer(reviewer)
** assign a reviewer for this assignment team, and TeamReviewResponseMap.count increases
* reviewed_by?(reviewer)
** TeamReviewResponseMap is empty, so test this method will return false
* reviewed_contributor?(contributor)
** TeamReviewResponseMap is empty, so test this method will return false
* delete
** this method has bug. No test
* get_submitted_files
** submitted_file must be empty, expect nil
* self.handle_duplicate(team, name, assignment_id, handle_duplicates)
** test in different cases(team is nil, option is "ignore", option is "rename")
* self.import(row,session,assignment_id,options)
** test in different cases(argument error, has_column_name is true, has_column_name is false)
* email
** this method has bug because there is no method named get_team_users. No test
* copy(course_id)
** TeamUserNode.count and TeamsUser.count increase
* add_participant(assignment_id, user)
** AssignmentParticipant.count increases
* assignment
** return value should equal what we expect
* get_scores(questions)
** return output's total score is not nil and the assignment team is what we expect
* self.get_team(participant)
** return team is what we expect
* self.export(csv, parent_id, options)
** test in different cases(team_name is true, team_name is false)
* self.get_export_fields(options)
** test if the fields' name is right
* self.create_team_and_node(assignment_id)
** assignent team and team node are not nil
* self.remove_team_by_id(id)
** check the removed team cannot be found in AssignmentTeam

=== unit/course_team_test.rb ===
Because most of the methods in course_team.rb are similar with that in assignment_team.rb if they have the same name. So I skip the same name method. Take the test/unit/course_team_test.rb as a reference.
* self.export_all_assignment_team_related_to_course(csv, parent_id, options)
** this method should be deleted here. No test

== Possible Refactoring ==
=== teams_participant.rb & teams_participants_controller.rb ===
* These two files are never used, no tests will cover them.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T20:26:03Z

Xguo6: /* assignment_team.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
==Classes==
=== 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

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

* get_participants : get participant in the team
* delete : delete a team member in the team
* get_node_type : will return “TeamNode”
* get_author_name : will return team’s name
* generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
* get_possible_team_members(name) : find a team member by name
* has_user(user : find a team member by user object
* add_member(user, assignment_id) : add a user to an assignment team
* copy_members(new_team) : copy current member in the team to the new team
* create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
* check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
* delete_all_by_parent(parent) : delete all teams under the same course/assignment
* randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
* generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
* import_team_members(starting_index, row) : import user from specific index of users and length

=== app/unit/assignment_team.rb ===
* includes?(participant): check if this assignment team include this participant
* assign_reviewer(reviewer): assign a reviewer for this assignment team
* reviewed_by?(reviewer)：check if this assignment team is reviewed by this reviewer
* topic: get the topic picked up by this team
* has_submissions?: check if this team submitted work or not
* reviewed_contributor?(contributor)
* participants: get all the participants
* delete: delete the signed up users
* self.get_first_member(team_id): get the first participant
* get_hyperlinks
* get_path
* get_submitted_files
* get_review_map_type: return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* email： get fist team user's email
* get_participant_type: return AssignmentParticipant
* get_parent_model：return Assignment
* fullname
* get_participants
* copy(course_id): copy a team from course team
* add_participant(assignment_id, user): add participant to AssignmentParticipant
* assignment
* get_scores(questions): return a hash of scores that the team has received for the questions
* self.get_team(participant): get this participant's team
* self.export(csv, parent_id, options): export assignment and team members
* self.get_export_fields(options)
* self.create_team_and_node(assignment_id)
* self.remove_team_by_id(id): Remove a team given the team id

=== app/unit/course_team.rb ===
* get_participant_type: return CourseParticipant
* get_parent_model：return Course
* get_node_type: return TeamNode
* assignment_id: return nil
* copy(assignment_id): copy a team from assignment team
* add_participant(course_id, user): add a user to a course. Note: this is deprecated because the functionality belongs to course
* export_participants: export the participants of a course team
* export(team_name_only): export team name, participants and course
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* self.export(csv, parent_id, options): export course and team members
* self.get_export_fields(options)
* self.export_all_assignment_team_related_to_course(csv, parent_id, options): this method is deprecated
* self.create_team_and_node(assignment_id)

== 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

=== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

=== assignment_team.rb ===
* includes?(participant)
** test one assignment team include a participant return true
* assign_reviewer(reviewer)
** assign a reviewer for this assignment team, and TeamReviewResponseMap.count increases
* reviewed_by?(reviewer)
** TeamReviewResponseMap is empty, so test this method will return false
* has_submissions?
** test one team has a submission return true
* reviewed_contributor?(contributor)
** TeamReviewResponseMap is empty, so test this method will return false
* participants
** participants are not nil
* delete
** this method has bug. No test
* self.get_first_member(team_id)
** test first menber not nil
* get_hyperlinks
** test hyperlinks are not nil
* get_path
** test path is not nil
* get_submitted_files
** submitted_file must be empty, expect nil
* get_review_map_type
** return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates)
** test in different cases(team is nil, option is "ignore", option is "rename")
* self.import(row,session,assignment_id,options)
** test in different cases(argument error, has_column_name is true, has_column_name is false)
* email
** this method has bug because there is no method named get_team_users. No test
* get_participant_type
** return AssignmentParticipant
* get_parent_model
** return Assignment
* fullname
** return value should equal what we expect
* get_participants
** test the participants are not nil
* copy(course_id)
** TeamUserNode.count and TeamsUser.count increase
* add_participant(assignment_id, user)
** AssignmentParticipant.count increases
* assignment
** return value should equal what we expect
* get_scores(questions)
** return output's total score is not nil and the assignment team is what we expect
* self.get_team(participant)
** return team is what we expect
* self.export(csv, parent_id, options)
** test in different cases(team_name is true, team_name is false)
* self.get_export_fields(options)
** test if the fields' name is right
* self.create_team_and_node(assignment_id)
** assignent team and team node are not nil
* self.remove_team_by_id(id)
** check the removed team cannot be found in AssignmentTeam

=== course_team.rb ===
Because most of the methods in course_team.rb are similar with that in assignment_team.rb if they have the same name. So I skip the same name method. Take the test/unit/course_team_test.rb as a reference.
* self.export_all_assignment_team_related_to_course(csv, parent_id, options)
** this method should be deleted here. No test

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T20:20:44Z

Xguo6: /* course_team.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
==Classes==
=== 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

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

* get_participants : get participant in the team
* delete : delete a team member in the team
* get_node_type : will return “TeamNode”
* get_author_name : will return team’s name
* generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
* get_possible_team_members(name) : find a team member by name
* has_user(user : find a team member by user object
* add_member(user, assignment_id) : add a user to an assignment team
* copy_members(new_team) : copy current member in the team to the new team
* create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
* check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
* delete_all_by_parent(parent) : delete all teams under the same course/assignment
* randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
* generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
* import_team_members(starting_index, row) : import user from specific index of users and length

=== app/unit/assignment_team.rb ===
* includes?(participant): check if this assignment team include this participant
* assign_reviewer(reviewer): assign a reviewer for this assignment team
* reviewed_by?(reviewer)：check if this assignment team is reviewed by this reviewer
* topic: get the topic picked up by this team
* has_submissions?: check if this team submitted work or not
* reviewed_contributor?(contributor)
* participants: get all the participants
* delete: delete the signed up users
* self.get_first_member(team_id): get the first participant
* get_hyperlinks
* get_path
* get_submitted_files
* get_review_map_type: return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* email： get fist team user's email
* get_participant_type: return AssignmentParticipant
* get_parent_model：return Assignment
* fullname
* get_participants
* copy(course_id): copy a team from course team
* add_participant(assignment_id, user): add participant to AssignmentParticipant
* assignment
* get_scores(questions): return a hash of scores that the team has received for the questions
* self.get_team(participant): get this participant's team
* self.export(csv, parent_id, options): export assignment and team members
* self.get_export_fields(options)
* self.create_team_and_node(assignment_id)
* self.remove_team_by_id(id): Remove a team given the team id

=== app/unit/course_team.rb ===
* get_participant_type: return CourseParticipant
* get_parent_model：return Course
* get_node_type: return TeamNode
* assignment_id: return nil
* copy(assignment_id): copy a team from assignment team
* add_participant(course_id, user): add a user to a course. Note: this is deprecated because the functionality belongs to course
* export_participants: export the participants of a course team
* export(team_name_only): export team name, participants and course
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* self.export(csv, parent_id, options): export course and team members
* self.get_export_fields(options)
* self.export_all_assignment_team_related_to_course(csv, parent_id, options): this method is deprecated
* self.create_team_and_node(assignment_id)

== 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

=== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

=== assignment_team.rb ===
* includes?(participant)
** test one assignment team include a participant return true
* assign_reviewer(reviewer)
** assign a reviewer for this assignment team, and TeamReviewResponseMap.count increases
* reviewed_by?(reviewer)
** TeamReviewResponseMap is empty, so test this method will return false
* has_submissions?
** test one team has a submission return true
* reviewed_contributor?(contributor)
** TeamReviewResponseMap is empty, so test this method will return false
* participants
** participants are not nil
* delete: delete the signed up users
** this method has bug. No test
* self.get_first_member(team_id): get the first participant
** first menber not nil
* get_hyperlinks
** test hyperlinks are not nil
* get_path
** test path is not nil
* get_submitted_files
** submitted_file must be empty, expect nil
* get_review_map_type
** return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates)
** test in different cases(team is nil, option is "ignore", option is "rename")
* self.import(row,session,assignment_id,options)
** test in different cases(argument error, has_column_name is true, has_column_name is false)
* email： get fist team user's email
** this method is wrong because there is no methond named get_team_users. No test
* get_participant_type
** return AssignmentParticipant
* get_parent_model
** return Assignment
* fullname
** return value should equal what we expect
* get_participants
** test the participants are not nil
* copy(course_id): copy a team from course team
** TeamUserNode.count and TeamsUser.count increase
* add_participant(assignment_id, user)
** AssignmentParticipant.count increases
* assignment
** return value should equal what we expect
* get_scores(questions)
** return output's total score is not nil and the assignment team is what we expect
* self.get_team(participant): get this participant's team
** return team is what we expect
* self.export(csv, parent_id, options)
** test in different cases(team_name is true, team_name is false)
* self.get_export_fields(options)
** test if the fields' name is right
* self.create_team_and_node(assignment_id)
** assignent team and team node are not nil
* self.remove_team_by_id(id)
** check the removed team cannot be found in AssignmentTeam

=== course_team.rb ===
Because most of the methods in course_team.rb are similar with that in assignment_team.rb if they have the same name. So I skip the same name method. Take the test/unit/course_team_test.rb as a reference.
* self.export_all_assignment_team_related_to_course(csv, parent_id, options)
** this method should be deleted here. No test

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T20:16:19Z

Xguo6: /* assignment_team.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
==Classes==
=== 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

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

* get_participants : get participant in the team
* delete : delete a team member in the team
* get_node_type : will return “TeamNode”
* get_author_name : will return team’s name
* generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
* get_possible_team_members(name) : find a team member by name
* has_user(user : find a team member by user object
* add_member(user, assignment_id) : add a user to an assignment team
* copy_members(new_team) : copy current member in the team to the new team
* create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
* check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
* delete_all_by_parent(parent) : delete all teams under the same course/assignment
* randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
* generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
* import_team_members(starting_index, row) : import user from specific index of users and length

=== app/unit/assignment_team.rb ===
* includes?(participant): check if this assignment team include this participant
* assign_reviewer(reviewer): assign a reviewer for this assignment team
* reviewed_by?(reviewer)：check if this assignment team is reviewed by this reviewer
* topic: get the topic picked up by this team
* has_submissions?: check if this team submitted work or not
* reviewed_contributor?(contributor)
* participants: get all the participants
* delete: delete the signed up users
* self.get_first_member(team_id): get the first participant
* get_hyperlinks
* get_path
* get_submitted_files
* get_review_map_type: return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* email： get fist team user's email
* get_participant_type: return AssignmentParticipant
* get_parent_model：return Assignment
* fullname
* get_participants
* copy(course_id): copy a team from course team
* add_participant(assignment_id, user): add participant to AssignmentParticipant
* assignment
* get_scores(questions): return a hash of scores that the team has received for the questions
* self.get_team(participant): get this participant's team
* self.export(csv, parent_id, options): export assignment and team members
* self.get_export_fields(options)
* self.create_team_and_node(assignment_id)
* self.remove_team_by_id(id): Remove a team given the team id

=== app/unit/course_team.rb ===
* get_participant_type: return CourseParticipant
* get_parent_model：return Course
* get_node_type: return TeamNode
* assignment_id: return nil
* copy(assignment_id): copy a team from assignment team
* add_participant(course_id, user): add a user to a course. Note: this is deprecated because the functionality belongs to course
* export_participants: export the participants of a course team
* export(team_name_only): export team name, participants and course
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* self.export(csv, parent_id, options): export course and team members
* self.get_export_fields(options)
* self.export_all_assignment_team_related_to_course(csv, parent_id, options): this method is deprecated
* self.create_team_and_node(assignment_id)

== 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

=== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

=== assignment_team.rb ===
* includes?(participant)
** test one assignment team include a participant return true
* assign_reviewer(reviewer)
** assign a reviewer for this assignment team, and TeamReviewResponseMap.count increases
* reviewed_by?(reviewer)
** TeamReviewResponseMap is empty, so test this method will return false
* has_submissions?
** test one team has a submission return true
* reviewed_contributor?(contributor)
** TeamReviewResponseMap is empty, so test this method will return false
* participants
** participants are not nil
* delete: delete the signed up users
** this method has bug. No test
* self.get_first_member(team_id): get the first participant
** first menber not nil
* get_hyperlinks
** test hyperlinks are not nil
* get_path
** test path is not nil
* get_submitted_files
** submitted_file must be empty, expect nil
* get_review_map_type
** return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates)
** test in different cases(team is nil, option is "ignore", option is "rename")
* self.import(row,session,assignment_id,options)
** test in different cases(argument error, has_column_name is true, has_column_name is false)
* email： get fist team user's email
** this method is wrong because there is no methond named get_team_users. No test
* get_participant_type
** return AssignmentParticipant
* get_parent_model
** return Assignment
* fullname
** return value should equal what we expect
* get_participants
** test the participants are not nil
* copy(course_id): copy a team from course team
** TeamUserNode.count and TeamsUser.count increase
* add_participant(assignment_id, user)
** AssignmentParticipant.count increases
* assignment
** return value should equal what we expect
* get_scores(questions)
** return output's total score is not nil and the assignment team is what we expect
* self.get_team(participant): get this participant's team
** return team is what we expect
* self.export(csv, parent_id, options)
** test in different cases(team_name is true, team_name is false)
* self.get_export_fields(options)
** test if the fields' name is right
* self.create_team_and_node(assignment_id)
** assignent team and team node are not nil
* self.remove_team_by_id(id)
** check the removed team cannot be found in AssignmentTeam

=== course_team.rb ===
== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T20:09:04Z

Xguo6:

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
==Classes==
=== 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

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

* get_participants : get participant in the team
* delete : delete a team member in the team
* get_node_type : will return “TeamNode”
* get_author_name : will return team’s name
* generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
* get_possible_team_members(name) : find a team member by name
* has_user(user : find a team member by user object
* add_member(user, assignment_id) : add a user to an assignment team
* copy_members(new_team) : copy current member in the team to the new team
* create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
* check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
* delete_all_by_parent(parent) : delete all teams under the same course/assignment
* randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
* generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
* import_team_members(starting_index, row) : import user from specific index of users and length

=== app/unit/assignment_team.rb ===
* includes?(participant): check if this assignment team include this participant
* assign_reviewer(reviewer): assign a reviewer for this assignment team
* reviewed_by?(reviewer)：check if this assignment team is reviewed by this reviewer
* topic: get the topic picked up by this team
* has_submissions?: check if this team submitted work or not
* reviewed_contributor?(contributor)
* participants: get all the participants
* delete: delete the signed up users
* self.get_first_member(team_id): get the first participant
* get_hyperlinks
* get_path
* get_submitted_files
* get_review_map_type: return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* email： get fist team user's email
* get_participant_type: return AssignmentParticipant
* get_parent_model：return Assignment
* fullname
* get_participants
* copy(course_id): copy a team from course team
* add_participant(assignment_id, user): add participant to AssignmentParticipant
* assignment
* get_scores(questions): return a hash of scores that the team has received for the questions
* self.get_team(participant): get this participant's team
* self.export(csv, parent_id, options): export assignment and team members
* self.get_export_fields(options)
* self.create_team_and_node(assignment_id)
* self.remove_team_by_id(id): Remove a team given the team id

=== app/unit/course_team.rb ===
* get_participant_type: return CourseParticipant
* get_parent_model：return Course
* get_node_type: return TeamNode
* assignment_id: return nil
* copy(assignment_id): copy a team from assignment team
* add_participant(course_id, user): add a user to a course. Note: this is deprecated because the functionality belongs to course
* export_participants: export the participants of a course team
* export(team_name_only): export team name, participants and course
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* self.export(csv, parent_id, options): export course and team members
* self.get_export_fields(options)
* self.export_all_assignment_team_related_to_course(csv, parent_id, options): this method is deprecated
* self.create_team_and_node(assignment_id)

== 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

=== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

=== assignment_team.rb ===
* includes?(participant)
** test one assignment team include a participant return true
* assign_reviewer(reviewer)
** assign a reviewer for this assignment team, and TeamReviewResponseMap.count increases
* reviewed_by?(reviewer)
** TeamReviewResponseMap is empty, so test this method will return false
* has_submissions?
** test one team has a submission return true
* reviewed_contributor?(contributor)
** TeamReviewResponseMap is empty, so test this method will return false
* participants
** participants are not nil
* delete: delete the signed up users
* self.get_first_member(team_id): get the first participant
** first menber not nil
* get_hyperlinks
** test hyperlinks are not nil
* get_path
** test path is not nil
* get_submitted_files
** submitted_file must be empty, expect nil
* get_review_map_type: return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates)
** test in different cases(team is nil, option is "ignore", option is "rename")
* self.import(row,session,assignment_id,options)
** test in different cases(argument error, has_column_name is true, has_column_name is false)
* email： get fist team user's email
* get_participant_type
** return AssignmentParticipant
* get_parent_model
** return Assignment
* fullname
** return value should equal what we expect
* get_participants
** test the participants are not nil
* copy(course_id): copy a team from course team
** TeamUserNode.count and TeamsUser.count increase
* add_participant(assignment_id, user)
** AssignmentParticipant.count increases
* assignment
** return value should equal what we expect
* get_scores(questions): return a hash of scores that the team has received for the questions
* self.get_team(participant): get this participant's team
* self.export(csv, parent_id, options)
** test in different cases(team_name is true, team_name is false)
* self.get_export_fields(options)
** test if the fields name is right
* self.create_team_and_node(assignment_id)
** assignent team and team node are not nil
* self.remove_team_by_id(id): Remove a team given the team id
=== course_team.rb ===
== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T19:37:12Z

Xguo6:

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
==Classes==
=== 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

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

* get_participants : get participant in the team
* delete : delete a team member in the team
* get_node_type : will return “TeamNode”
* get_author_name : will return team’s name
* generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
* get_possible_team_members(name) : find a team member by name
* has_user(user : find a team member by user object
* add_member(user, assignment_id) : add a user to an assignment team
* copy_members(new_team) : copy current member in the team to the new team
* create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
* check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
* delete_all_by_parent(parent) : delete all teams under the same course/assignment
* randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
* generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
* import_team_members(starting_index, row) : import user from specific index of users and length

=== app/unit/assignment_team.rb ===
* includes?(participant): check if this assignment team include this participant
* assign_reviewer(reviewer): assign a reviewer for this assignment team
* reviewed_by?(reviewer)：check if this assignment team is reviewed by this reviewer
* topic: get the topic picked up by this team
* has_submissions?: check if this team submitted work or not
* reviewed_contributor?(contributor)
* participants: get all the participants
* delete: delete the signed up users
* self.get_first_member(team_id): get the first participant
* get_hyperlinks
* get_path
* get_submitted_files
* get_review_map_type: return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* email： get fist team user's email
* get_participant_type: return AssignmentParticipant
* get_parent_model：return Assignment
* fullname
* get_participants
* copy(course_id): copy a team from course team
* add_participant(assignment_id, user): add participant to AssignmentParticipant
* assignment
* get_scores(questions): return a hash of scores that the team has received for the questions
* self.get_team(participant): get this participant's team
* self.export(csv, parent_id, options): export assignment and team members
* self.get_export_fields(options)
* self.create_team_and_node(assignment_id)
* self.remove_team_by_id(id): Remove a team given the team id

=== app/unit/course_team.rb ===
* get_participant_type: return CourseParticipant
* get_parent_model：return Course
* get_node_type: return TeamNode
* assignment_id: return nil
* copy(assignment_id): copy a team from assignment team
* add_participant(course_id, user): add a user to a course. Note: this is deprecated because the functionality belongs to course
* export_participants: export the participants of a course team
* export(team_name_only): export team name, participants and course
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* self.export(csv, parent_id, options): export course and team members
* self.get_export_fields(options)
* self.export_all_assignment_team_related_to_course(csv, parent_id, options): this method is deprecated
* self.create_team_and_node(assignment_id)

== 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

=== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T19:23:48Z

Xguo6:

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
==Classes==
=== 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

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

* get_participants : get participant in the team
* delete : delete a team member in the team
* get_node_type : will return “TeamNode”
* get_author_name : will return team’s name
* generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
* get_possible_team_members(name) : find a team member by name
* has_user(user : find a team member by user object
* add_member(user, assignment_id) : add a user to an assignment team
* copy_members(new_team) : copy current member in the team to the new team
* create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
* check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
* delete_all_by_parent(parent) : delete all teams under the same course/assignment
* randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
* generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
* import_team_members(starting_index, row) : import user from specific index of users and length

=== app/unit/assignment_team.rb ===
* includes?(participant): check if this assignment team include this participant
* assign_reviewer(reviewer): assign a reviewer for this assignment team
* reviewed_by?(reviewer)：check if this assignment team is reviewed by this reviewer
* topic: get the topic picked up by this team
* has_submissions?: check if this team submitted work or not
* reviewed_contributor?(contributor)
* participants: get all the participants
* delete: delete the signed up users
* self.get_first_member(team_id): get the first participant
* get_hyperlinks
* get_path
* get_submitted_files
* get_review_map_type: return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* email： get fist team user's email
* get_participant_type: return AssignmentParticipant
* get_parent_model：return Assignment
* fullname
* get_participants
* copy(course_id): copy a team from course team
* add_participant(assignment_id, user): add participant to AssignmentParticipant
* assignment
* get_scores(questions): return a hash of scores that the team has received for the questions
* self.get_team(participant): get this participant's team
* self.export(csv, parent_id, options): export assignment and team members
* self.get_export_fields(options)
* self.create_team_and_node(assignment_id)
* self.remove_team_by_id(id): Remove a team given the team id

=== app/unit/course_team.rb ===
== 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

=== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T19:14:50Z

Xguo6: /* app/unit/assignment_team.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
==Classes==
=== 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

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

* get_participants : get participant in the team
* delete : delete a team member in the team
* get_node_type : will return “TeamNode”
* get_author_name : will return team’s name
* generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
* get_possible_team_members(name) : find a team member by name
* has_user(user : find a team member by user object
* add_member(user, assignment_id) : add a user to an assignment team
* copy_members(new_team) : copy current member in the team to the new team
* create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
* check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
* delete_all_by_parent(parent) : delete all teams under the same course/assignment
* randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
* generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
* import_team_members(starting_index, row) : import user from specific index of users and length

=== app/unit/assignment_team.rb ===
* includes?(participant): check if this assignment team include this participant
* assign_reviewer(reviewer): assign a reviewer for this assignment team
* reviewed_by?(reviewer)：check if this assignment team is reviewed by this reviewer
* topic: get the topic picked up by this team
* has_submissions?: check if this team submitted work or not
* reviewed_contributor?(contributor)
* participants: get all the participants
* delete: delete the signed up users
* self.get_first_member(team_id)
* get_hyperlinks
* get_path
* get_submitted_files
* get_review_map_type
* self.handle_duplicate(team, name, assignment_id, handle_duplicates)
* self.import(row,session,assignment_id,options)
* email
* get_participant_type
* get_parent_model
* fullname
* get_participants
* copy(course_id)
* add_participant(assignment_id, user)
* assignment
* get_scores(questions)
* self.get_team(participant)
* self.export(csv, parent_id, options)
* self.get_export_fields(options)
* self.create_team_and_node(assignment_id)
* self.remove_team_by_id(id)

=== app/unit/course_team.rb ===
== 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

=== 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 ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T18:59:50Z

Xguo6:

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T18:55:01Z

Xguo6:

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T18:51:34Z

Xguo6:

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-24T18:40:37Z

Xguo6: Created page with "=E1414: Testing classes related to teams= ''Please be advised that we do not have deployment link, since our work are all back-end tests'' __TOC__ == Introduction == This project..."

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
=== teams_participant.rb & teams_participant_controller.rb===
* teams_participant.rb and teams_participant_controller.rb are used to manage the participants of teams.
* There is no functional test for teams_participant_controller.rb and unit test for teams_participant.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.

==Classes==
=== 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

=== app/models/teams_participant.rb===
The teams_participant.rb is a model belonging to both users and teams. It is used when a team participant is created, listed or deleted.

=== app/controllers/teams_participant_controller.rb===
The teams_participant_controller support team participants management so the team participant:
* get a participant name by inputting part of the name
* list team participants of a team
* add a participant to a team
* remove a selected team participant from a team
* remove all team participants belonging to an item

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

;get_participants : get participant in the team
;delete : delete a team member in the team
;get_node_type : will return “TeamNode”
;get_author_name : will return team’s name
;generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
;get_possible_team_members(name) : find a team member by name
;has_user(user : find a team member by user object
;add_member(user, assignment_id) : add a user to an assignment team
;copy_members(new_team) : copy current member in the team to the new team
;create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
;check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
;Delete_all_by_parent(parent) : delete all teams under the same course/assignment
;Randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
;generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
;import_team_members(starting_index, row) : import user from specific index of users and length

== 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

=== fixtures use in common ===
* teams.yml
* users.yml
* teams_users.yml
* courses.yml
* assignments.yml

=== teams_participant.rb & teams_participant_controller.rb ===
Besides the above fixtures, we also need the following fixrure
* teams_participant.yml

=== teams.rb ===
* teams_participant.yml
* join_team_requests.yml
* participants.yml
* nodes.yml

== Use Case Diagram ==

=== teams_participant_controller.rb ===
[[File:New.jpg]]

=== advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== teams_participant.rb ===

* delete
** Test delete to check if team node and the team user decreases by one

=== teams_participant_controller.rb ===
* auto_complete_for_user_name
** Test auto_complete_for_user_name with invalid user name
* list
** Test list with invalid team id
* new
** Test new with invalid team id
* create
** Test create with invalid team id
** Test create to check if the number of participant increases by one
** 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 not reached
* delete
** Test delete with invalid id
** Test delete to check the number of participant decreases
* delete_select
** Test delete_select with invalid item id
** Test delete_select to check if the number of participant decreases by one

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014

2014-04-24T18:39:09Z

Xguo6:

*[[CSC/ECE_517_Fall_2012/example_page]]
*[[CSC/ECE 517 Spring 2014/ch1a 1a rt]]
*[[CSC/ECE 517 Spring 2014/ch1a 1e rm]]
*[[CSC/ECE 517 Spring 2014/ch1 1w1h jg ]]
*[[CSC/ECE 517 Spring 2014/ch1 1w1b np]]
*[[CSC/ECE 517 Spring 2014/ch1 1w1f mj]]
*[[CSC/ECE 517 Spring 2014/ch1a 1d mm]]
*[[CSC/ECE 517 Spring 2014/ch1a 1c yj]]
*[[CSC/ECE 517 Spring 2014/ch1 1w1l m]]
*[[CSC/ECE 517 Spring 2014/ch1 1w1m bm]]
*[[CSC/ECE 517 Spring 2014/ch1a 1p fy]]
*[[CSC/ECE 517 Spring 2014/oss E1401 lmn]]
*[[CSC/ECE 517 Spring 2014/oss E1402 mmb]]
*[[CSC/ECE 517 Spring 2014/oss E1404 mnp]]
*[[CSC/ECE 517 Spring 2014/oss E1405 irw]]
*[[CSC/ECE 517 Spring 2014/oss E1406 st]]
*[[CSC/ECE 517 Spring 2014/oss S1402 jyy]]
*[[CSC/ECE 517 Spring 2014/oss E1413 mnp]]
*[[CSC/ECE 517 Spring 2014/oss E1414 st]]
*[[CSC/ECE 517 Spring 2014/security_audit]]
*[[CSC/ECE 517 Spring 2014/final_doc_updated qyx]]

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-10T00:41:54Z

Xguo6: /* teams_participant.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
=== teams_participant.rb & teams_participant_controller.rb===
* teams_participant.rb and teams_participant_controller.rb are used to manage the participants of teams.
* There is no functional test for teams_participant_controller.rb and unit test for teams_participant.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.

==Classes==
=== 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

=== app/models/teams_participant.rb===
The teams_participant.rb is a model belonging to both users and teams. It is used when a team participant is created, listed or deleted.

=== app/controllers/teams_participant_controller.rb===
The teams_participant_controller support team participants management so the team participant:
* get a participant name by inputting part of the name
* list team participants of a team
* add a participant to a team
* remove a selected team participant from a team
* remove all team participants belonging to an item

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

;get_participants : get participant in the team
;delete : delete a team member in the team
;get_node_type : will return “TeamNode”
;get_author_name : will return team’s name
;generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
;get_possible_team_members(name) : find a team member by name
;has_user(user : find a team member by user object
;add_member(user, assignment_id) : add a user to an assignment team
;copy_members(new_team) : copy current member in the team to the new team
;create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
;check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
;Delete_all_by_parent(parent) : delete all teams under the same course/assignment
;Randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
;generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
;import_team_members(starting_index, row) : import user from specific index of users and length

== 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

=== fixtures use in common ===
* teams.yml
* users.yml
* teams_users.yml
* courses.yml
* assignments.yml

=== teams_participant.rb & teams_participant_controller.rb ===
Besides the above fixtures, we also need the following fixrure
* teams_participant.yml

=== teams.rb ===
* teams_participant.yml
* join_team_requests.yml
* participants.yml
* nodes.yml

== Use Case Diagram ==

=== teams_participant_controller.rb ===
[[File:New.jpg]]

=== advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== teams_participant.rb ===

* delete
** Test delete to check if team node and the team user decreases by one

=== teams_participant_controller.rb ===
* auto_complete_for_user_name
** Test auto_complete_for_user_name with invalid user name
* list
** Test list with invalid team id
* new
** Test new with invalid team id
* create
** Test create with invalid team id
** Test create to check if the number of participant increases by one
** 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 not reached
* delete
** Test delete with invalid id
** Test delete to check the number of participant decreases
* delete_select
** Test delete_select with invalid item id
** Test delete_select to check if the number of participant decreases by one

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-10T00:41:17Z

Xguo6:

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
=== teams_participant.rb & teams_participant_controller.rb===
* teams_participant.rb and teams_participant_controller.rb are used to manage the participants of teams.
* There is no functional test for teams_participant_controller.rb and unit test for teams_participant.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.

==Classes==
=== 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

=== app/models/teams_participant.rb===
The teams_participant.rb is a model belonging to both users and teams. It is used when a team participant is created, listed or deleted.

=== app/controllers/teams_participant_controller.rb===
The teams_participant_controller support team participants management so the team participant:
* get a participant name by inputting part of the name
* list team participants of a team
* add a participant to a team
* remove a selected team participant from a team
* remove all team participants belonging to an item

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

;get_participants : get participant in the team
;delete : delete a team member in the team
;get_node_type : will return “TeamNode”
;get_author_name : will return team’s name
;generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
;get_possible_team_members(name) : find a team member by name
;has_user(user : find a team member by user object
;add_member(user, assignment_id) : add a user to an assignment team
;copy_members(new_team) : copy current member in the team to the new team
;create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
;check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
;Delete_all_by_parent(parent) : delete all teams under the same course/assignment
;Randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
;generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
;import_team_members(starting_index, row) : import user from specific index of users and length

== 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

=== fixtures use in common ===
* teams.yml
* users.yml
* teams_users.yml
* courses.yml
* assignments.yml

=== teams_participant.rb & teams_participant_controller.rb ===
Besides the above fixtures, we also need the following fixrure
* teams_participant.yml

=== teams.rb ===
* teams_participant.yml
* join_team_requests.yml
* participants.yml
* nodes.yml

== Use Case Diagram ==

=== teams_participant_controller.rb ===
[[File:New.jpg]]

=== advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== teams_participant.rb ===

* Delete
** Test Delete to check if team node and the team user decreases by one

=== teams_participant_controller.rb ===
* auto_complete_for_user_name
** Test auto_complete_for_user_name with invalid user name
* list
** Test list with invalid team id
* new
** Test new with invalid team id
* create
** Test create with invalid team id
** Test create to check if the number of participant increases by one
** 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 not reached
* delete
** Test delete with invalid id
** Test delete to check the number of participant decreases
* delete_select
** Test delete_select with invalid item id
** Test delete_select to check if the number of participant decreases by one

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-10T00:38:17Z

Xguo6: /* teams_participant.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
=== teams_participant.rb & teams_participant_controller.rb===
* teams_participant.rb and teams_participant_controller.rb are used to manage the participants of teams.
* There is no functional test for teams_participant_controller.rb and unit test for teams_participant.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.

==Classes==
=== 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

=== app/models/teams_participant.rb===
The teams_participant.rb is a model belonging to both users and teams. It is used when a team participant is created, listed or deleted.

=== app/controllers/teams_participant_controller.rb===
The teams_participant_controller support team participants management so the team participant:
* get a participant name by inputting part of the name
* list team participants of a team
* add a participant to a team
* remove a selected team participant from a team
* remove all team participants belonging to an item

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

;get_participants : get participant in the team
;delete : delete a team member in the team
;get_node_type : will return “TeamNode”
;get_author_name : will return team’s name
;generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
;get_possible_team_members(name) : find a team member by name
;has_user(user : find a team member by user object
;add_member(user, assignment_id) : add a user to an assignment team
;copy_members(new_team) : copy current member in the team to the new team
;create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
;check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
;Delete_all_by_parent(parent) : delete all teams under the same course/assignment
;Randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
;generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
;import_team_members(starting_index, row) : import user from specific index of users and length

== 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

=== fixtures use in common ===
* teams.yml
* users.yml
* teams_users.yml
* courses.yml
* assignments.yml

=== teams_participant.rb & teams_participant_controller.rb ===
Besides the above fixtures, we also need the following fixrure
* teams_participant.yml

=== teams.rb ===
* teams_participant.yml
* join_team_requests.yml
* participants.yml
* nodes.yml

== Use Case Diagram ==

=== teams_participant_controller.rb ===
[[File:New.jpg]]

=== advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== teams_participant.rb ===

* Test Delete to check if team node and the team user decreases by one

=== teams_participant_controller.rb ===

** Test auto_complete_for_user_name with invalid user name
** Test List with invalid team id
** Test New with invalid team id
** Test Create with invalid team id
** Test Create to check if the number of participant increases by one
** 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 not reached
** Test Delete with invalid user id
** Test Delete_select with invalid item id
** Test Delete_select to check if the number of participant decreases by one

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-10T00:37:01Z

Xguo6:

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
=== teams_participant.rb & teams_participant_controller.rb===
* teams_participant.rb and teams_participant_controller.rb are used to manage the participants of teams.
* There is no functional test for teams_participant_controller.rb and unit test for teams_participant.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.

==Classes==
=== 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

=== app/models/teams_participant.rb===
The teams_participant.rb is a model belonging to both users and teams. It is used when a team participant is created, listed or deleted.

=== app/controllers/teams_participant_controller.rb===
The teams_participant_controller support team participants management so the team participant:
* get a participant name by inputting part of the name
* list team participants of a team
* add a participant to a team
* remove a selected team participant from a team
* remove all team participants belonging to an item

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

;get_participants : get participant in the team
;delete : delete a team member in the team
;get_node_type : will return “TeamNode”
;get_author_name : will return team’s name
;generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
;get_possible_team_members(name) : find a team member by name
;has_user(user : find a team member by user object
;add_member(user, assignment_id) : add a user to an assignment team
;copy_members(new_team) : copy current member in the team to the new team
;create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
;check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
;Delete_all_by_parent(parent) : delete all teams under the same course/assignment
;Randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
;generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
;import_team_members(starting_index, row) : import user from specific index of users and length

== 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

=== fixtures use in common ===
* teams.yml
* users.yml
* teams_users.yml
* courses.yml
* assignments.yml

=== teams_participant.rb & teams_participant_controller.rb ===
Besides the above fixtures, we also need the following fixrure
* teams_participant.yml

=== teams.rb ===
* teams_participant.yml
* join_team_requests.yml
* participants.yml
* nodes.yml

== Use Case Diagram ==

=== teams_participant_controller.rb ===
[[File:New.jpg]]

=== advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

=== teams_users.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== teams_participant.rb ===

** Test Delete to check if team node and the team user decreases by one

=== teams_participant_controller.rb ===

** Test auto_complete_for_user_name with invalid user name
** Test List with invalid team id
** Test New with invalid team id
** Test Create with invalid team id
** Test Create to check if the number of participant increases by one
** 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 not reached
** Test Delete with invalid user id
** Test Delete_select with invalid item id
** Test Delete_select to check if the number of participant decreases by one

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-10T00:29:49Z

Xguo6:

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
=== teams_participant.rb & teams_participant_controller.rb===
* teams_participant.rb and teams_participant_controller.rb are used to manage the participants of teams.
* There is no functional test for teams_participant_controller.rb and unit test for teams_participant.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.

==Classes==
=== 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

=== app/models/teams_participant.rb===
The teams_participant.rb is a model belonging to both users and teams. It is used when a team participant is created, listed or deleted.

=== app/controllers/teams_participant_controller.rb===
The teams_participant_controller support team participants management so the team participant:
* get a participant name by inputting part of the name
* list team participants of a team
* add a participant to a team
* remove a selected team participant from a team
* remove all team participants belonging to an item

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

;get_participants : get participant in the team
;delete : delete a team member in the team
;get_node_type : will return “TeamNode”
;get_author_name : will return team’s name
;generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
;get_possible_team_members(name) : find a team member by name
;has_user(user : find a team member by user object
;add_member(user, assignment_id) : add a user to an assignment team
;copy_members(new_team) : copy current member in the team to the new team
;create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
;check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
;Delete_all_by_parent(parent) : delete all teams under the same course/assignment
;Randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
;generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
;import_team_members(starting_index, row) : import user from specific index of users and length

== 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

=== fixtures use in common ===
* teams.yml
* users.yml
* teams_users.yml
* courses.yml
* assignments.yml

=== teams_participant.rb & teams_participant_controller.rb ===
Besides the above fixtures, we also need the following fixrure
* teams_participant.yml

=== teams.rb ===
* teams_participant.yml
* join_team_requests.yml
* participants.yml
* nodes.yml

== Use Case Diagram ==

=== teams_participant_controller.rb ===
[[File:New.jpg]]

=== advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users.rb & teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

For the methods in teams_user.rb, the scenarios would be like the following:

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== teams_participant_controller.rb ===

** Test auto_complete_for_user_name with invalid user name
** Test List with invalid team id
** Test New with invalid team id
** Test Create with invalid team id
** 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 not reached
** Test Delete with invalid user id
** Test Delete_select with invalid item id

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-10T00:08:38Z

Xguo6:

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st 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 : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== 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.
=== teams_participant.rb & teams_participant_controller.rb===
* teams_participant.rb and teams_participant_controller.rb are used to manage the participants of teams.
* There is no functional test for teams_participant_controller.rb and unit test for teams_participant.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.

==Classes==
=== 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

=== app/models/teams_participant.rb===
The teams_participant.rb is a model belonging to both users and teams. It is used when a team participant is created, listed or deleted.

=== app/controllers/teams_participant_controller.rb===
The teams_participant_controller support team participants management so the team participant:
* get a participant name by inputting part of the name
* list team participants of a team
* add a participant to a team
* remove a selected team participant from a team
* remove all team participants belonging to an item

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

;get_participants : get participant in the team
;delete : delete a team member in the team
;get_node_type : will return “TeamNode”
;get_author_name : will return team’s name
;generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
;get_possible_team_members(name) : find a team member by name
;has_user(user : find a team member by user object
;add_member(user, assignment_id) : add a user to an assignment team
;copy_members(new_team) : copy current member in the team to the new team
;create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
;check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
;Delete_all_by_parent(parent) : delete all teams under the same course/assignment
;Randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
;generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
;import_team_members(starting_index, row) : import user from specific index of users and length

== 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

=== fixtures use in common ===
* teams.yml
* users.yml
* teams_users.yml
* courses.yml
* assignments.yml

=== teams_participant.rb & teams_participant_controller.rb ===
Besides the above fixtures, we also need the following fixrure
* teams_participant.yml

=== teams.rb ===
* teams_participant.yml
* join_team_requests.yml
* participants.yml
* nodes.yml

== Use Case Diagram ==

=== teams_participant_controller.rb ===
[[File:New.jpg]]

=== advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users.rb & teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

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

For the methods in teams_user.rb, the scenarios would be like the following:

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== teams_participant.rb & teams_participant_controller.rb ===

* 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

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== 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 retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== 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.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

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

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

File:New.jpg

2014-04-10T00:07:14Z

Xguo6:

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T20:10:03Z

Xguo6: /* app/models/teams_users.rb & app/controllers/teams_users_controller.rb &app/models/teams_participant.rb & app/controllers/teams_participant_controller.rb */

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T20:08:13Z

Xguo6: /* app/models/teams_users.rb & app/controllers/teams_users_controller.rb */

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T20:05:11Z

Xguo6:

File:Usercase.jpg

2014-04-09T20:02:26Z

Xguo6:

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T19:57:55Z

Xguo6: /* app/models/teams_users.rb & app/controllers/teams_users_controller.rb */

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T19:56:31Z

Xguo6: /* Background */

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T19:55:20Z

Xguo6:

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T03:09:02Z

Xguo6: /* student_team_controller */

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

In this section, we will show the result form SimpleCov. The coverage is 24.08%.

[[File:Result.png]]

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, 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/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T03:08:37Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

In this section, we will show the result form SimpleCov. The coverage is 24.08%.

[[File:Result.png]]

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===student_team_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, 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/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T02:48:52Z

Xguo6: /* References */

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

In this section, we will show the result form SimpleCov. The coverage is 24.08%.

[[File:Result.png]]

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T02:47:51Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

In this section, we will show the result form SimpleCov. The coverage is 24.08%.

[[File:Result.png]]

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>
http://guides.rubyonrails.org/testing.html
https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T02:45:51Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

[[File:Result.png]]

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>
http://guides.rubyonrails.org/testing.html
https://github.com/colszowka/simplecov

File:Result.png

2014-04-01T02:44:30Z

Xguo6: SimpleCov result

SimpleCov result

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T02:00:51Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>
http://guides.rubyonrails.org/testing.html
https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T01:58:20Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>
http://guides.rubyonrails.org/testing.html

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T01:56:39Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T01:20:03Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.
[[File:result.png]]
==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T01:10:53Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T01:09:57Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__

==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T01:07:22Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__

==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

[[File:result.png]]

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T00:50:09Z

Xguo6: /* app/controllers/student_team_controller.rb */

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__

==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-04-01T00:42:29Z

Xguo6:

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__

==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/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team
* <del>review members</del> (removed)

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== 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 <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==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 <code>post</code> or <code>get</code>, 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 <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==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 <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>