Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T20:12:58Z

Yhong3: /* Summary of Class Issues */

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

=== 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-25T20:11:11Z

Yhong3: /* E1414: Testing classes related to teams */

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

=== 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-25T20:10:21Z

Yhong3: /* Introduction */

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

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

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

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

=== 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-25T20:10:11Z

Yhong3: /* Running Tests */

=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

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

=== 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-25T20:09:53Z

Yhong3: /* Running Tests */

=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

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

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

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

==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-25T20:08:13Z

Yhong3: /* Test Environment */

=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

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

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

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

You can also run multiple tests
rake test:prepare
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.

==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-25T19:50:33Z

Yhong3: /* unit/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]

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

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

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

You can also run multiple tests
rake test:prepare
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.

==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-25T19:50:15Z

Yhong3: /* 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]

== 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 Class 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 at line 169 in team.rb

=== unit/assignment_team_test.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

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

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

You can also run multiple tests
rake test:prepare
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.

==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-25T19:37:50Z

Yhong3: /* unit/team_test.rb */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:28:17Z

Yhong3: /* Summary of Class Issues */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:23:11Z

Yhong3: /* Summary about issues found for classes */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:21:18Z

Yhong3: /* Summary about change can made and changed already made */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:20:29Z

Yhong3: /* Testing Scenarios */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:19:50Z

Yhong3: /* functional/advertise_for_partner_controller_test.rb */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:19:39Z

Yhong3: /* advertise_for_team_controller.rb */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:15:59Z

Yhong3: /* advertise_for_team_controller.rb */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:15:16Z

Yhong3: /* Summary about change can made and changed already made */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:12:54Z

Yhong3: /* advertise_for_team_controller.rb */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:11:15Z

Yhong3: /* Test Classes */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T19:09:15Z

Yhong3: /* Changes made to original classes */

=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.
== Summary about change can made and changed already made ==
=== Change 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

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

== 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/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
'''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]]

== Testing Scenarios ==

=== 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
* test "test edit advertisement" do
** only assign team

=== 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 at line 169 in team.rb

=== unit/assignment_team_test.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

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

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

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

You can also run multiple tests
rake test:prepare
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.

==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-25T18:58:13Z

Yhong3: /* 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.
== Changes made to original classes ==
=== team.rb ===
* line 10 def get_participants removed
** This is commented out because the same method is defined again at line 26
* line 38 def self.generate_team_name() removed
** This is commented out because the same method is defined again at line 150
* line 100 def self.create_node_object(name, parent_id)
** see the TODO at line 99, the method will not work.

== 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/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
'''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]]

== Testing Scenarios ==

=== 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
* test "test edit advertisement" do
** only assign team

=== 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 at line 169 in team.rb

=== unit/assignment_team_test.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

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

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

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

You can also run multiple tests
rake test:prepare
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.

==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-25T18:56:57Z

Yhong3: /* functional/advertise_for_partner_controller_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]

== 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.
== Changes made to original classes ==
=== team.rb ===
* line 10 def get_participants removed
** This is commented out because the same method is defined again at line 26
* line 38 def self.generate_team_name() removed
** This is commented out because the same method is defined again at line 150
* line 100 def self.create_node_object(name, parent_id)
** see the TODO at line 99, the method will not work.

== 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/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
'''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]]

== Testing Scenarios ==

=== 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
* test "test edit advertisement" do
** only assign team

=== 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 at line 169 in team.rb

=== unit/assignment_team_test.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

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

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

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

You can also run multiple tests
rake test:prepare
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.

==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-25T18:56:12Z

Yhong3: /* app/models/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.
== Changes made to original classes ==
=== team.rb ===
* line 10 def get_participants removed
** This is commented out because the same method is defined again at line 26
* line 38 def self.generate_team_name() removed
** This is commented out because the same method is defined again at line 150
* line 100 def self.create_node_object(name, parent_id)
** see the TODO at line 99, the method will not work.

== 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/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
'''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]]

== Testing Scenarios ==

=== 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 remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

=== 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 at line 169 in team.rb

=== unit/assignment_team_test.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

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

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

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

You can also run multiple tests
rake test:prepare
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.

==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-25T17:59:56Z

Yhong3: /* Possible Refacotring */

=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.
== Changes made to original classes ==
=== team.rb ===
* line 10 def get_participants removed
** This is commented out because the same method is defined again at line 26
* line 38 def self.generate_team_name() removed
** This is commented out because the same method is defined again at line 150
* line 100 def self.create_node_object(name, parent_id)
** see the TODO at line 99, the method will not work.

== 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/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
'''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]]

== Testing Scenarios ==

=== 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 remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

=== 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 at line 169 in team.rb

=== unit/assignment_team_test.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

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

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

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

You can also run multiple tests
rake test:prepare
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.

==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-25T17:58:57Z

Yhong3: /* unit/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]

== 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.
== Changes made to original classes ==
=== team.rb ===
* line 10 def get_participants removed
** This is commented out because the same method is defined again at line 26
* line 38 def self.generate_team_name() removed
** This is commented out because the same method is defined again at line 150
* line 100 def self.create_node_object(name, parent_id)
** see the TODO at line 99, the method will not work.

== 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/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
'''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]]

== Testing Scenarios ==

=== 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 remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

=== 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 at line 169 in team.rb

=== unit/assignment_team_test.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

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

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

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

You can also run multiple tests
rake test:prepare
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.

==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-25T17:58:11Z

Yhong3: /* unit/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]

== 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.
== Changes made to original classes ==
=== team.rb ===
* line 10 def get_participants removed
** This is commented out because the same method is defined again at line 26
* line 38 def self.generate_team_name() removed
** This is commented out because the same method is defined again at line 150
* line 100 def self.create_node_object(name, parent_id)
** see the TODO at line 99, the method will not work.

== 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/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
'''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]]

== Testing Scenarios ==

=== 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 remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

=== unit/team_test.rb ===

* 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 at line 169 in team.rb

=== unit/assignment_team_test.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

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

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

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

You can also run multiple tests
rake test:prepare
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.

==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-24T21:21:15Z

Yhong3: /* Change made to original classes */

=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.
== Changes made to original classes ==
=== team.rb ===
* line 10 def get_participants removed
** This is commented out because the same method is defined again at line 26
* line 38 def self.generate_team_name() removed
** This is commented out because the same method is defined again at line 150
* line 100 def self.create_node_object(name, parent_id)
** see the TODO at line 99, the method will not work.

== 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/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
'''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]]

== Testing Scenarios ==

=== 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 remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

=== unit/team_test.rb ===
* test "add_team" do
* test "delete should destroy the team" do
* test "delete should remove all teams user" do
* test "delete should remove all team node" do
* test "get_participants from assignment team" do
** Please notice that this will actually call the get_participants under AssignmentTeam
* test "get_participants from course team" do
* test "get_node_type" do
* test "get_author_name" do
* test "generate_team_name" do
** Please notice that this method (self.generate_team_name)is modified
* test "generate_team_name for existed prefix" do
* test "get_possible_team_members" do
* test "has_user" do
* test "do not has_user" do
* test "add member already in team" do
* 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 "add member for course should create teams user node" do
* test "add member to assignment team successfully" do
* test "add member to full assignment team should fail" do
* test "copy_members from assignment team" do
* test "copy_members from course team" do
* test "check_for_existing for AssignmentTeam" do
* test "check_for_existing for existed AssignmentTeam should raise error" do
* test "delete all by parent should delete teams" do
* test "delete all by parent will not fail when no teams found" do
* #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 for user not existed should raise error" do
* #test "import team members successfully" do
** problem: add_member are not passing correct assignment id at line 169 in team.rb

=== unit/assignment_team_test.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

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

You can also run multiple tests
rake test:prepare
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.

==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-24T21:21:05Z

Yhong3: /* Change made to original classes */

=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.
== Change made to original classes ==
=== team.rb ===
* line 10 def get_participants removed
** This is commented out because the same method is defined again at line 26
* line 38 def self.generate_team_name() removed
** This is commented out because the same method is defined again at line 150
* line 100 def self.create_node_object(name, parent_id)
** see the TODO at line 99, the method will not work.

== 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/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
'''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]]

== Testing Scenarios ==

=== 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 remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

=== unit/team_test.rb ===
* test "add_team" do
* test "delete should destroy the team" do
* test "delete should remove all teams user" do
* test "delete should remove all team node" do
* test "get_participants from assignment team" do
** Please notice that this will actually call the get_participants under AssignmentTeam
* test "get_participants from course team" do
* test "get_node_type" do
* test "get_author_name" do
* test "generate_team_name" do
** Please notice that this method (self.generate_team_name)is modified
* test "generate_team_name for existed prefix" do
* test "get_possible_team_members" do
* test "has_user" do
* test "do not has_user" do
* test "add member already in team" do
* 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 "add member for course should create teams user node" do
* test "add member to assignment team successfully" do
* test "add member to full assignment team should fail" do
* test "copy_members from assignment team" do
* test "copy_members from course team" do
* test "check_for_existing for AssignmentTeam" do
* test "check_for_existing for existed AssignmentTeam should raise error" do
* test "delete all by parent should delete teams" do
* test "delete all by parent will not fail when no teams found" do
* #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 for user not existed should raise error" do
* #test "import team members successfully" do
** problem: add_member are not passing correct assignment id at line 169 in team.rb

=== unit/assignment_team_test.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

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

You can also run multiple tests
rake test:prepare
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.

==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-24T21:17:58Z

Yhong3: /* Test Classes */

=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.
== Change made to original classes ==
== 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/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
'''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]]

== Testing Scenarios ==

=== 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 remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

=== unit/team_test.rb ===
* test "add_team" do
* test "delete should destroy the team" do
* test "delete should remove all teams user" do
* test "delete should remove all team node" do
* test "get_participants from assignment team" do
** Please notice that this will actually call the get_participants under AssignmentTeam
* test "get_participants from course team" do
* test "get_node_type" do
* test "get_author_name" do
* test "generate_team_name" do
** Please notice that this method (self.generate_team_name)is modified
* test "generate_team_name for existed prefix" do
* test "get_possible_team_members" do
* test "has_user" do
* test "do not has_user" do
* test "add member already in team" do
* 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 "add member for course should create teams user node" do
* test "add member to assignment team successfully" do
* test "add member to full assignment team should fail" do
* test "copy_members from assignment team" do
* test "copy_members from course team" do
* test "check_for_existing for AssignmentTeam" do
* test "check_for_existing for existed AssignmentTeam should raise error" do
* test "delete all by parent should delete teams" do
* test "delete all by parent will not fail when no teams found" do
* #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 for user not existed should raise error" do
* #test "import team members successfully" do
** problem: add_member are not passing correct assignment id at line 169 in team.rb

=== unit/assignment_team_test.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

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

You can also run multiple tests
rake test:prepare
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.

==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-24T21:17:36Z

Yhong3: /* Classes */

=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.
== 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/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
'''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]]

== Testing Scenarios ==

=== 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 remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

=== unit/team_test.rb ===
* test "add_team" do
* test "delete should destroy the team" do
* test "delete should remove all teams user" do
* test "delete should remove all team node" do
* test "get_participants from assignment team" do
** Please notice that this will actually call the get_participants under AssignmentTeam
* test "get_participants from course team" do
* test "get_node_type" do
* test "get_author_name" do
* test "generate_team_name" do
** Please notice that this method (self.generate_team_name)is modified
* test "generate_team_name for existed prefix" do
* test "get_possible_team_members" do
* test "has_user" do
* test "do not has_user" do
* test "add member already in team" do
* 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 "add member for course should create teams user node" do
* test "add member to assignment team successfully" do
* test "add member to full assignment team should fail" do
* test "copy_members from assignment team" do
* test "copy_members from course team" do
* test "check_for_existing for AssignmentTeam" do
* test "check_for_existing for existed AssignmentTeam should raise error" do
* test "delete all by parent should delete teams" do
* test "delete all by parent will not fail when no teams found" do
* #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 for user not existed should raise error" do
* #test "import team members successfully" do
** problem: add_member are not passing correct assignment id at line 169 in team.rb

=== unit/assignment_team_test.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

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

You can also run multiple tests
rake test:prepare
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.

==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-24T21:17:09Z

Yhong3: /* Testing Scenarios */

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

== Testing Scenarios ==

=== 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 remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

=== unit/team_test.rb ===
* test "add_team" do
* test "delete should destroy the team" do
* test "delete should remove all teams user" do
* test "delete should remove all team node" do
* test "get_participants from assignment team" do
** Please notice that this will actually call the get_participants under AssignmentTeam
* test "get_participants from course team" do
* test "get_node_type" do
* test "get_author_name" do
* test "generate_team_name" do
** Please notice that this method (self.generate_team_name)is modified
* test "generate_team_name for existed prefix" do
* test "get_possible_team_members" do
* test "has_user" do
* test "do not has_user" do
* test "add member already in team" do
* 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 "add member for course should create teams user node" do
* test "add member to assignment team successfully" do
* test "add member to full assignment team should fail" do
* test "copy_members from assignment team" do
* test "copy_members from course team" do
* test "check_for_existing for AssignmentTeam" do
* test "check_for_existing for existed AssignmentTeam should raise error" do
* test "delete all by parent should delete teams" do
* test "delete all by parent will not fail when no teams found" do
* #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 for user not existed should raise error" do
* #test "import team members successfully" do
** problem: add_member are not passing correct assignment id at line 169 in team.rb

=== unit/assignment_team_test.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

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

You can also run multiple tests
rake test:prepare
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.

==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-24T21:16:06Z

Yhong3: /* 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
'''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]]

== 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 ===
* test "test remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

=== unit/team_test.rb ===
* test "add_team" do
* test "delete should destroy the team" do
* test "delete should remove all teams user" do
* test "delete should remove all team node" do
* test "get_participants from assignment team" do
** Please notice that this will actually call the get_participants under AssignmentTeam
* test "get_participants from course team" do
* test "get_node_type" do
* test "get_author_name" do
* test "generate_team_name" do
** Please notice that this method (self.generate_team_name)is modified
* test "generate_team_name for existed prefix" do
* test "get_possible_team_members" do
* test "has_user" do
* test "do not has_user" do
* test "add member already in team" do
* 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 "add member for course should create teams user node" do
* test "add member to assignment team successfully" do
* test "add member to full assignment team should fail" do
* test "copy_members from assignment team" do
* test "copy_members from course team" do
* test "check_for_existing for AssignmentTeam" do
* test "check_for_existing for existed AssignmentTeam should raise error" do
* test "delete all by parent should delete teams" do
* test "delete all by parent will not fail when no teams found" do
* #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 for user not existed should raise error" do
* #test "import team members successfully" do
** problem: add_member are not passing correct assignment id at line 169 in team.rb

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

You can also run multiple tests
rake test:prepare
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.

==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-24T21:03:29Z

Yhong3: /* advertise_for_partner_controller.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
'''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]]

== 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 ===
* test "test remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # 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
* test "test edit advertisement" do
** only assign team

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

You can also run multiple tests
rake test:prepare
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.

==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:56:33Z

Yhong3: /* Running Tests */

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

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

You can also run multiple tests
rake test:prepare
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.

==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:49:16Z

Yhong3: /* Setup */

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

== 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/oss E1414 st

2014-04-09T23:15:12Z

Yhong3: /* app/controllers/advertise_for_partner_controller.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:Usercase.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

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

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T23:15:01Z

Yhong3: /* app/controllers/teams_participant_controller.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:Usercase.jpg]]

=== app/controllers/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

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

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T23:11:41Z

Yhong3: /* app/controllers/teams_participant_controller.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 ==

=== app/controllers/teams_participant_controller.rb ===
[[File:Usercase.jpg]]

=== app/controllers/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

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

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T23:10:00Z

Yhong3: /* Sample Test Code */

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

=== app/controllers/teams_participant_controller.rb ===
[[File:Usercase.jpg]]

hey, just to let you know, usually the squares should be ovals.

=== app/controllers/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

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

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T23:09:07Z

Yhong3: /* team */

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

=== app/controllers/teams_participant_controller.rb ===
[[File:Usercase.jpg]]

hey, just to let you know, usually the squares should be ovals.

=== app/controllers/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

=== 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 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-09T23:08:50Z

Yhong3: /* advertise_for_team_controller */

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

=== app/controllers/teams_participant_controller.rb ===
[[File:Usercase.jpg]]

hey, just to let you know, usually the squares should be ovals.

=== app/controllers/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

=== 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 ===
* 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 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-09T23:08:19Z

Yhong3: /* app/models/teams_participant.rb & app/controllers/teams_participant_controller.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 ==

=== app/controllers/teams_participant_controller.rb ===
[[File:Usercase.jpg]]

hey, just to let you know, usually the squares should be ovals.

=== app/controllers/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

=== 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 ===
* ''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 ===
* 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 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-09T23:08:01Z

Yhong3: /* app/models/teams_users.rb & app/controllers/teams_users_controller.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 ==

=== app/controllers/teams_participant_controller.rb ===
[[File:Usercase.jpg]]

hey, just to let you know, usually the squares should be ovals.

=== app/controllers/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

=== app/models/teams_participant.rb & app/controllers/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 ===
* ''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 ===
* 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 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-09T23:06:46Z

Yhong3: /* app/models/teams_participant.rb & app/controllers/teams_participant_controller.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 ==

=== app/controllers/teams_participant_controller.rb ===
[[File:Usercase.jpg]]

hey, just to let you know, usually the squares should be ovals.

=== app/controllers/advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== app/models/teams_users.rb & app/controllers/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

=== app/models/teams_participant.rb & app/controllers/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 ===
* ''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 ===
* 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 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-09T23:02:10Z

Yhong3: /* Test Environment */

=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

=== app/models/teams_participant.rb & app/controllers/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 ==

=== app/controllers/teams_participant_controller.rb ===
[[File:Usercase.jpg]]

hey, just to let you know, usually the squares should be ovals.

=== app/controllers/advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== app/models/teams_users.rb & app/controllers/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

=== app/models/teams_participant.rb & app/controllers/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 ===
* ''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 ===
* 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 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-09T23:02:01Z

Yhong3: /* Background */

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T22:00:26Z

Yhong3: /* Background */

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

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

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

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

=== app/models/teams_participant.rb & app/controllers/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 ==

=== app/controllers/teams_participant_controller.rb ===
[[File:Usercase.jpg]]

hey, just to let you know, usually the squares should be ovals.

=== app/controllers/advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== app/models/teams_users.rb & app/controllers/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

=== app/models/teams_participant.rb & app/controllers/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 ===
* ''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 ===
* 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 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-09T21:46:55Z

Yhong3: /* team.rb */

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T21:46:41Z

Yhong3: /* team.rb */

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T21:30:56Z

Yhong3: /* advertise_for_partner_controller.rb */