Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2018/E1873 Specialized rubics for different topic types

2018-12-18T05:10:49Z

Jli94: /* Procedure & Result */

==''' Introduction '''==

=== Background ===
One of the fantastic features that Expertiza provides is for each assignment, it allows students providing reviews for others' jobs. This is done by offering a pre-defined questionnaire for the whole assignment, which is called the rubric for this assignment. Each rubric has several questions, each question provides a criterion to evaluate the performance from a specific angle. Then students can evaluate the entire job by rating and answering these questions. The team did that job can also get a detailed feedback for different aspects of the project.

=== Motivation ===
One of the problems for the review system is that for each assignment, different topics are included. Students can choose the one topic they like, and those topics fall into different categories. That is, an assignment always include different kind of projects. In Expertiza, the topic can be refactoring projects, testing projects, Mozilla projects, etc. Apparently, for different kinds of projects, we have different criteria to evaluate their performance. However, due to the current design of the system, all projects belong to the same assignment can only have the same rubric, which may lead to unnecessary criteria for some projects and inadequate criteria for other projects.
To make sure all kinds of projects can be evaluated properly. We plan to refactor the system to allow assigning different rubies for different projects in a specified appointment.

==''' Analysis & Plan '''==

To realize such purpose, we have the following tasks need to be done:

===Check Box===
For current design, the rubric used for a specified assignment is set at the following page. To make sure users can choose to set different rubrics for different projects, we need first add a checkbox at this page. Therefore, users can use this box to indicate if they want to use the same rubric for all the projects or set some different rubrics for some projects.

[[File:2018F1873rubric.png]]

===Dropdown List===
To make sure users can choose rubrics for each project, we should add a new dropdown list beside each project in the following page. The number of dropdown list should decide by review round number. Therefore, each time users choose to identify different rubrics for different projects, the list will appear and users can choose proper rubrics. The default rubric set at last page will be overwritten in this case.

[[File:2018F1873project.png]]

===Controller===
Make changes to the controller so that these functions can work. Most of our logic control codes will be written in ''helpers/sign_up_sheet_helper.rb''.

logic flowchart:

[[File:umlj.png]]

===Database===
Add questionnaire_id in sign_up_topics table to make sure the projects can always relate to correct rubrics

[[File:databasejj.png]]

===Test===
Test what we changed to make sure it works as intended and not influence the original system.

==''' Implement Steps '''==

=== Task 1 Add checkbox===
1. edit the file views/assignments/edit/_rubrics.html.erb

2. add a checkbox at the top of the page which says "Vary rubric by topic"

3. set the default state for this checkbox as unchecked

===Task 2 Add dropdown list===
1. edit the file views/assignment/edit/_general.html.erb

2. add a variable to indicate if the checkbox said in Task 1 is checked

3. create a new file under views/sign_up_sheet called "_rubrics_list.html.erb" to store the code for the dropdown list

4. edit the file views/sign_up_sheet/_table_line.html.erb

5. add the code to render the dropdown list

6. making a judgment before rendering the dropdown list, only if the checkbox in Task 1ist checked to render the page

===Task 3 Change controllers===
Change the update method in sign_up_sheet_controller.rb to make sure when new rubric is chosen for a specific topic, it can be stored in the database properly

===Task 4 Create migration===
1. create a new migration to add questionnaire_id in sign_up_topics

2. the questionnaire_id is a foreign key which references to questionnaires

3. change the file models/sign_up_topic.rb, and add the relations with the questionnaire, the relation between them is one-to-one

===Task 5 Test the changes===
1. make a test plan for the features that need to be tested

2. follow the test plan to write automatic test codes

3. evaluate the results and refactor codes

==''' Test plan '''==
We mainly use cucumber and capybara to test UI, and the following are detailed plans

===Test checkbox===
1. go to the rubrics page under the assignment

2. we can see the checkbox says "Vary rubric by topic" shows on this page

3. the initial state of the checkbox is unchecked

===Test dropdown list===
====Scenario 1====
1. the checkbox "Vary rubric by topic" is unchecked

2. go to the topics page under assignment

3.there are no dropdown lists beside topics
====Scenario 2====
1. the checkbox "Vary rubric by topic" is checked

2. go to the topics page under assignment

3. the table to show the topics have a row called "rubrics"

4. under this title, each topic has a dropdown list

==''' Procedure & Result '''==
===Test===
Instead of testing UI, we did some unit tests using Rspec.

For testing update_topic_questionnaires.
*when attributes are nil
<pre>
it 'returns false' do
expect(assignment_form.update_topic_questionnaires(nil)).to be false
end
</pre>
*when attributes are not nil and at least one topic_questionnaire's id is nil or blank
<pre>
let(:attributes) { [topic_questionnaire, topic_questionnaire2] }
before(:each) do
allow(topic_questionnaire).to receive(:[]).with(:id).and_return(nil)
allow(topic_questionnaire2).to receive(:[]).with(:id).and_return(1)
allow(TopicQuestionnaire).to receive(:where).with(sign_up_topic_id: SignUpTopic.where(assignment_id: 1)).and_return([])
allow(TopicQuestionnaire).to receive(:new).with(topic_questionnaire).and_return(topic_questionnaire)
allow(TopicQuestionnaire).to receive(:find).with(1).and_return(topic_questionnaire2)
end
</pre>
*when both save and update_attributes method do not work
<pre>
it 'changes @has_errors value to true and returns attributes (args)' do
allow(topic_questionnaire).to receive(:save).and_return(false)
allow(topic_questionnaire2).to receive(:update_attributes).with(topic_questionnaire2).and_return(false)
expect(assignment_form.update_topic_questionnaires(attributes)).to eq(attributes)
expect(assignment_form.instance_variable_get(:@has_errors)).to be true
end
</pre>
*when both save and update_attributes method work well
<pre>
it 'returns attributes (args) and @has_errors value is nil' do
allow(topic_questionnaire).to receive(:save).and_return(true)
allow(topic_questionnaire2).to receive(:update_attributes).with(topic_questionnaire2).and_return(true)
expect(assignment_form.update_topic_questionnaires(attributes)).to eq(attributes)
expect(assignment_form.instance_variable_get(:@has_errors)).to be nil
end
</pre>

For testing review_by_rounds, check the number of rounds which decides the rounds of the questionnaire that each assignment needs.
*when used in round is nil
<pre>
it 'returns false' do
expect(@review_by_rounds).to be nil
end
</pre>

File:微信图片 20181218000845.png

2018-12-18T05:09:24Z

Jli94:

CSC/ECE 517 Fall 2018/E1873 Specialized rubics for different topic types

2018-12-18T05:06:45Z

Jli94: /* Test */

==''' Introduction '''==

=== Background ===
One of the fantastic features that Expertiza provides is for each assignment, it allows students providing reviews for others' jobs. This is done by offering a pre-defined questionnaire for the whole assignment, which is called the rubric for this assignment. Each rubric has several questions, each question provides a criterion to evaluate the performance from a specific angle. Then students can evaluate the entire job by rating and answering these questions. The team did that job can also get a detailed feedback for different aspects of the project.

=== Motivation ===
One of the problems for the review system is that for each assignment, different topics are included. Students can choose the one topic they like, and those topics fall into different categories. That is, an assignment always include different kind of projects. In Expertiza, the topic can be refactoring projects, testing projects, Mozilla projects, etc. Apparently, for different kinds of projects, we have different criteria to evaluate their performance. However, due to the current design of the system, all projects belong to the same assignment can only have the same rubric, which may lead to unnecessary criteria for some projects and inadequate criteria for other projects.
To make sure all kinds of projects can be evaluated properly. We plan to refactor the system to allow assigning different rubies for different projects in a specified appointment.

==''' Analysis & Plan '''==

To realize such purpose, we have the following tasks need to be done:

===Check Box===
For current design, the rubric used for a specified assignment is set at the following page. To make sure users can choose to set different rubrics for different projects, we need first add a checkbox at this page. Therefore, users can use this box to indicate if they want to use the same rubric for all the projects or set some different rubrics for some projects.

[[File:2018F1873rubric.png]]

===Dropdown List===
To make sure users can choose rubrics for each project, we should add a new dropdown list beside each project in the following page. The number of dropdown list should decide by review round number. Therefore, each time users choose to identify different rubrics for different projects, the list will appear and users can choose proper rubrics. The default rubric set at last page will be overwritten in this case.

[[File:2018F1873project.png]]

===Controller===
Make changes to the controller so that these functions can work. Most of our logic control codes will be written in ''helpers/sign_up_sheet_helper.rb''.

logic flowchart:

[[File:umlj.png]]

===Database===
Add questionnaire_id in sign_up_topics table to make sure the projects can always relate to correct rubrics

[[File:databasejj.png]]

===Test===
Test what we changed to make sure it works as intended and not influence the original system.

==''' Implement Steps '''==

=== Task 1 Add checkbox===
1. edit the file views/assignments/edit/_rubrics.html.erb

2. add a checkbox at the top of the page which says "Vary rubric by topic"

3. set the default state for this checkbox as unchecked

===Task 2 Add dropdown list===
1. edit the file views/assignment/edit/_general.html.erb

2. add a variable to indicate if the checkbox said in Task 1 is checked

3. create a new file under views/sign_up_sheet called "_rubrics_list.html.erb" to store the code for the dropdown list

4. edit the file views/sign_up_sheet/_table_line.html.erb

5. add the code to render the dropdown list

6. making a judgment before rendering the dropdown list, only if the checkbox in Task 1ist checked to render the page

===Task 3 Change controllers===
Change the update method in sign_up_sheet_controller.rb to make sure when new rubric is chosen for a specific topic, it can be stored in the database properly

===Task 4 Create migration===
1. create a new migration to add questionnaire_id in sign_up_topics

2. the questionnaire_id is a foreign key which references to questionnaires

3. change the file models/sign_up_topic.rb, and add the relations with the questionnaire, the relation between them is one-to-one

===Task 5 Test the changes===
1. make a test plan for the features that need to be tested

2. follow the test plan to write automatic test codes

3. evaluate the results and refactor codes

==''' Test plan '''==
We mainly use cucumber and capybara to test UI, and the following are detailed plans

===Test checkbox===
1. go to the rubrics page under the assignment

2. we can see the checkbox says "Vary rubric by topic" shows on this page

3. the initial state of the checkbox is unchecked

===Test dropdown list===
====Scenario 1====
1. the checkbox "Vary rubric by topic" is unchecked

2. go to the topics page under assignment

3.there are no dropdown lists beside topics
====Scenario 2====
1. the checkbox "Vary rubric by topic" is checked

2. go to the topics page under assignment

3. the table to show the topics have a row called "rubrics"

4. under this title, each topic has a dropdown list

==''' Procedure & Result '''==

===Result===
[[File:1873-result.png]]
===Test===
Instead of testing UI, we did some unit tests using Rspec.

For testing update_topic_questionnaires.
*when attributes are nil
<pre>
it 'returns false' do
expect(assignment_form.update_topic_questionnaires(nil)).to be false
end
</pre>
*when attributes are not nil and at least one topic_questionnaire's id is nil or blank
<pre>
let(:attributes) { [topic_questionnaire, topic_questionnaire2] }
before(:each) do
allow(topic_questionnaire).to receive(:[]).with(:id).and_return(nil)
allow(topic_questionnaire2).to receive(:[]).with(:id).and_return(1)
allow(TopicQuestionnaire).to receive(:where).with(sign_up_topic_id: SignUpTopic.where(assignment_id: 1)).and_return([])
allow(TopicQuestionnaire).to receive(:new).with(topic_questionnaire).and_return(topic_questionnaire)
allow(TopicQuestionnaire).to receive(:find).with(1).and_return(topic_questionnaire2)
end
</pre>
*when both save and update_attributes method do not work
<pre>
it 'changes @has_errors value to true and returns attributes (args)' do
allow(topic_questionnaire).to receive(:save).and_return(false)
allow(topic_questionnaire2).to receive(:update_attributes).with(topic_questionnaire2).and_return(false)
expect(assignment_form.update_topic_questionnaires(attributes)).to eq(attributes)
expect(assignment_form.instance_variable_get(:@has_errors)).to be true
end
</pre>
*when both save and update_attributes method work well
<pre>
it 'returns attributes (args) and @has_errors value is nil' do
allow(topic_questionnaire).to receive(:save).and_return(true)
allow(topic_questionnaire2).to receive(:update_attributes).with(topic_questionnaire2).and_return(true)
expect(assignment_form.update_topic_questionnaires(attributes)).to eq(attributes)
expect(assignment_form.instance_variable_get(:@has_errors)).to be nil
end
</pre>

For testing review_by_rounds, check the number of rounds which decides the rounds of the questionnaire that each assignment needs.
*when used in round is nil
<pre>
it 'returns false' do
expect(@review_by_rounds).to be nil
end
</pre>

File:1873-result.png

2018-12-18T05:05:05Z

Jli94:

CSC/ECE 517 Fall 2018/E1873 Specialized rubics for different topic types

2018-11-21T01:25:52Z

Jli94: /* Database */

==''' Introduction '''==

=== Background ===
One of the fantastic features that Expertiza provides is for each assignment, it allows students providing reviews for others' jobs. This is done by offering a pre-defined questionnaire for the whole assignment, which is called the rubric for this assignment. Each rubric has several questions, each question provides a criterion to evaluate the performance from a specific angle. Then students can evaluate the entire job by rating and answering these questions. The team did that job can also get a detailed feedback for different aspects of the project.

=== Motivation ===
One of the problems for the review system is that for each assignment, different topics are included. Students can choose the one topic they like, and those topics fall into different categories. That is, an assignment always include different kind of projects. In Expertiza, the topic can be refactoring projects, testing projects, Mozilla projects, etc. Apparently, for different kinds of projects, we have different criteria to evaluate their performance. However, due to the current design of the system, all projects belong to the same assignment can only have the same rubric, which may lead to unnecessary criteria for some projects and inadequate criteria for other projects.
To make sure all kinds of projects can be evaluated properly. We plan to refactor the system to allow assigning different rubies for different projects in a specified appointment.

==''' Analysis & Plan '''==

To realize such purpose, we have the following tasks need to be done:

===Check Box===
For current design, the rubric used for a specified assignment is set at the following page. To make sure users can choose to set different rubrics for different projects, we need first add a checkbox at this page. Therefore, users can use this box to indicate if they want to use the same rubric for all the projects or set some different rubrics for some projects.

[[File:2018F1873rubric.png]]

===Dropdown List===
To make sure users can choose rubrics for each project, we should add a new dropdown list beside each project in the following page. The number of dropdown list should decide by review round number. Therefore, each time users choose to identify different rubrics for different projects, the list will appear and users can choose proper rubrics. The default rubric set at last page will be overwritten in this case.

[[File:2018F1873project.png]]

===Controller===
Make changes to the controller so that these functions can work. Most of our logic control codes will be written in ''helpers/sign_up_sheet_helper.rb''.

logic flowchart:

[[File:umlj.png]]

===Database===
Add questionnaire_id in sign_up_topics table to make sure the projects can always relate to correct rubrics

[[File:Untitled Diagram.png]]

===Test===
Test what we changed to make sure it works as intended and not influence the original system.

==''' Implement Steps '''==

=== Task 1 Add checkbox===
1. edit the file views/assignments/edit/_rubrics.html.erb

2. add a checkbox at the top of the page which says "Vary rubric by topic"

3. set the default state for this checkbox as unchecked

===Task 2 Add dropdown list===
1. edit the file views/assignment/edit/_general.html.erb

2. add a variable to indicate if the checkbox said in Task 1 is checked

3. create a new file under views/sign_up_sheet called "_rubrics_list.html.erb" to store the code for the dropdown list

4. edit the file views/sign_up_sheet/_table_line.html.erb

5. add the code to render the dropdown list

6. making a judgment before rendering the dropdown list, only if the checkbox in Task 1ist checked to render the page

===Task 3 Change controllers===
Change the update method in sign_up_sheet_controller.rb to make sure when new rubric is chosen for a specific topic, it can be stored in the database properly

===Task 4 Create migration===
1. create a new migration to add questionnaire_id in sign_up_topics

2. the questionnaire_id is a foreign key which references to questionnaires

3. change the file models/sign_up_topic.rb, and add the relations with the questionnaire, the relation between them is one-to-one

===Task 5 Test the changes===
1. make a test plan for the features that need to be tested

2. follow the test plan to write automatic test codes

3. evaluate the results and refactor codes

==''' Test plan '''==
We mainly use cucumber and capybara to test UI, and the following are detailed plans

===Test checkbox===
1. go to the rubrics page under the assignment

2. we can see the checkbox says "Vary rubric by topic" shows on this page

3. the initial state of the checkbox is unchecked

===Test dropdown list===
====Scenario 1====
1. the checkbox "Vary rubric by topic" is unchecked

2. go to the topics page under assignment

3.there are no dropdown lists beside topics
====Scenario 2====
1. the checkbox "Vary rubric by topic" is checked

2. go to the topics page under assignment

3. the table to show the topics have a row called "rubrics"

4. under this title, each topic has a dropdown list

CSC/ECE 517 Fall 2018/E1873 Specialized rubics for different topic types

2018-11-21T01:25:40Z

Jli94: /* Database */

==''' Introduction '''==

=== Background ===
One of the fantastic features that Expertiza provides is for each assignment, it allows students providing reviews for others' jobs. This is done by offering a pre-defined questionnaire for the whole assignment, which is called the rubric for this assignment. Each rubric has several questions, each question provides a criterion to evaluate the performance from a specific angle. Then students can evaluate the entire job by rating and answering these questions. The team did that job can also get a detailed feedback for different aspects of the project.

=== Motivation ===
One of the problems for the review system is that for each assignment, different topics are included. Students can choose the one topic they like, and those topics fall into different categories. That is, an assignment always include different kind of projects. In Expertiza, the topic can be refactoring projects, testing projects, Mozilla projects, etc. Apparently, for different kinds of projects, we have different criteria to evaluate their performance. However, due to the current design of the system, all projects belong to the same assignment can only have the same rubric, which may lead to unnecessary criteria for some projects and inadequate criteria for other projects.
To make sure all kinds of projects can be evaluated properly. We plan to refactor the system to allow assigning different rubies for different projects in a specified appointment.

==''' Analysis & Plan '''==

To realize such purpose, we have the following tasks need to be done:

===Check Box===
For current design, the rubric used for a specified assignment is set at the following page. To make sure users can choose to set different rubrics for different projects, we need first add a checkbox at this page. Therefore, users can use this box to indicate if they want to use the same rubric for all the projects or set some different rubrics for some projects.

[[File:2018F1873rubric.png]]

===Dropdown List===
To make sure users can choose rubrics for each project, we should add a new dropdown list beside each project in the following page. The number of dropdown list should decide by review round number. Therefore, each time users choose to identify different rubrics for different projects, the list will appear and users can choose proper rubrics. The default rubric set at last page will be overwritten in this case.

[[File:2018F1873project.png]]

===Controller===
Make changes to the controller so that these functions can work. Most of our logic control codes will be written in ''helpers/sign_up_sheet_helper.rb''.

logic flowchart:

[[File:umlj.png]]

===Database===
Add questionnaire_id in sign_up_topics table to make sure the projects can always relate to correct rubrics

[[File:Untitled Diagram.png|500px|aaa]]

===Test===
Test what we changed to make sure it works as intended and not influence the original system.

==''' Implement Steps '''==

=== Task 1 Add checkbox===
1. edit the file views/assignments/edit/_rubrics.html.erb

2. add a checkbox at the top of the page which says "Vary rubric by topic"

3. set the default state for this checkbox as unchecked

===Task 2 Add dropdown list===
1. edit the file views/assignment/edit/_general.html.erb

2. add a variable to indicate if the checkbox said in Task 1 is checked

3. create a new file under views/sign_up_sheet called "_rubrics_list.html.erb" to store the code for the dropdown list

4. edit the file views/sign_up_sheet/_table_line.html.erb

5. add the code to render the dropdown list

6. making a judgment before rendering the dropdown list, only if the checkbox in Task 1ist checked to render the page

===Task 3 Change controllers===
Change the update method in sign_up_sheet_controller.rb to make sure when new rubric is chosen for a specific topic, it can be stored in the database properly

===Task 4 Create migration===
1. create a new migration to add questionnaire_id in sign_up_topics

2. the questionnaire_id is a foreign key which references to questionnaires

3. change the file models/sign_up_topic.rb, and add the relations with the questionnaire, the relation between them is one-to-one

===Task 5 Test the changes===
1. make a test plan for the features that need to be tested

2. follow the test plan to write automatic test codes

3. evaluate the results and refactor codes

==''' Test plan '''==
We mainly use cucumber and capybara to test UI, and the following are detailed plans

===Test checkbox===
1. go to the rubrics page under the assignment

2. we can see the checkbox says "Vary rubric by topic" shows on this page

3. the initial state of the checkbox is unchecked

===Test dropdown list===
====Scenario 1====
1. the checkbox "Vary rubric by topic" is unchecked

2. go to the topics page under assignment

3.there are no dropdown lists beside topics
====Scenario 2====
1. the checkbox "Vary rubric by topic" is checked

2. go to the topics page under assignment

3. the table to show the topics have a row called "rubrics"

4. under this title, each topic has a dropdown list

CSC/ECE 517 Fall 2018/E1873 Specialized rubics for different topic types

2018-11-21T01:23:33Z

Jli94: /* Database */

==''' Introduction '''==

=== Background ===
One of the fantastic features that Expertiza provides is for each assignment, it allows students providing reviews for others' jobs. This is done by offering a pre-defined questionnaire for the whole assignment, which is called the rubric for this assignment. Each rubric has several questions, each question provides a criterion to evaluate the performance from a specific angle. Then students can evaluate the entire job by rating and answering these questions. The team did that job can also get a detailed feedback for different aspects of the project.

=== Motivation ===
One of the problems for the review system is that for each assignment, different topics are included. Students can choose the one topic they like, and those topics fall into different categories. That is, an assignment always include different kind of projects. In Expertiza, the topic can be refactoring projects, testing projects, Mozilla projects, etc. Apparently, for different kinds of projects, we have different criteria to evaluate their performance. However, due to the current design of the system, all projects belong to the same assignment can only have the same rubric, which may lead to unnecessary criteria for some projects and inadequate criteria for other projects.
To make sure all kinds of projects can be evaluated properly. We plan to refactor the system to allow assigning different rubies for different projects in a specified appointment.

==''' Analysis & Plan '''==

To realize such purpose, we have the following tasks need to be done:

===Check Box===
For current design, the rubric used for a specified assignment is set at the following page. To make sure users can choose to set different rubrics for different projects, we need first add a checkbox at this page. Therefore, users can use this box to indicate if they want to use the same rubric for all the projects or set some different rubrics for some projects.

[[File:2018F1873rubric.png]]

===Dropdown List===
To make sure users can choose rubrics for each project, we should add a new dropdown list beside each project in the following page. The number of dropdown list should decide by review round number. Therefore, each time users choose to identify different rubrics for different projects, the list will appear and users can choose proper rubrics. The default rubric set at last page will be overwritten in this case.

[[File:2018F1873project.png]]

===Controller===
Make changes to the controller so that these functions can work. Most of our logic control codes will be written in ''helpers/sign_up_sheet_helper.rb''.

logic flowchart:

[[File:umlj.png]]

===Database===
Add questionnaire_id in sign_up_topics table to make sure the projects can always relate to correct rubrics

[[File:Untitled Diagram.png|500px]]

===Test===
Test what we changed to make sure it works as intended and not influence the original system.

==''' Implement Steps '''==

=== Task 1 Add checkbox===
1. edit the file views/assignments/edit/_rubrics.html.erb

2. add a checkbox at the top of the page which says "Vary rubric by topic"

3. set the default state for this checkbox as unchecked

===Task 2 Add dropdown list===
1. edit the file views/assignment/edit/_general.html.erb

2. add a variable to indicate if the checkbox said in Task 1 is checked

3. create a new file under views/sign_up_sheet called "_rubrics_list.html.erb" to store the code for the dropdown list

4. edit the file views/sign_up_sheet/_table_line.html.erb

5. add the code to render the dropdown list

6. making a judgment before rendering the dropdown list, only if the checkbox in Task 1ist checked to render the page

===Task 3 Change controllers===
Change the update method in sign_up_sheet_controller.rb to make sure when new rubric is chosen for a specific topic, it can be stored in the database properly

===Task 4 Create migration===
1. create a new migration to add questionnaire_id in sign_up_topics

2. the questionnaire_id is a foreign key which references to questionnaires

3. change the file models/sign_up_topic.rb, and add the relations with the questionnaire, the relation between them is one-to-one

===Task 5 Test the changes===
1. make a test plan for the features that need to be tested

2. follow the test plan to write automatic test codes

3. evaluate the results and refactor codes

==''' Test plan '''==
We mainly use cucumber and capybara to test UI, and the following are detailed plans

===Test checkbox===
1. go to the rubrics page under the assignment

2. we can see the checkbox says "Vary rubric by topic" shows on this page

3. the initial state of the checkbox is unchecked

===Test dropdown list===
====Scenario 1====
1. the checkbox "Vary rubric by topic" is unchecked

2. go to the topics page under assignment

3.there are no dropdown lists beside topics
====Scenario 2====
1. the checkbox "Vary rubric by topic" is checked

2. go to the topics page under assignment

3. the table to show the topics have a row called "rubrics"

4. under this title, each topic has a dropdown list

CSC/ECE 517 Fall 2018/E1873 Specialized rubics for different topic types

2018-11-21T01:23:14Z

Jli94: /* Database */

==''' Introduction '''==

=== Background ===
One of the fantastic features that Expertiza provides is for each assignment, it allows students providing reviews for others' jobs. This is done by offering a pre-defined questionnaire for the whole assignment, which is called the rubric for this assignment. Each rubric has several questions, each question provides a criterion to evaluate the performance from a specific angle. Then students can evaluate the entire job by rating and answering these questions. The team did that job can also get a detailed feedback for different aspects of the project.

=== Motivation ===
One of the problems for the review system is that for each assignment, different topics are included. Students can choose the one topic they like, and those topics fall into different categories. That is, an assignment always include different kind of projects. In Expertiza, the topic can be refactoring projects, testing projects, Mozilla projects, etc. Apparently, for different kinds of projects, we have different criteria to evaluate their performance. However, due to the current design of the system, all projects belong to the same assignment can only have the same rubric, which may lead to unnecessary criteria for some projects and inadequate criteria for other projects.
To make sure all kinds of projects can be evaluated properly. We plan to refactor the system to allow assigning different rubies for different projects in a specified appointment.

==''' Analysis & Plan '''==

To realize such purpose, we have the following tasks need to be done:

===Check Box===
For current design, the rubric used for a specified assignment is set at the following page. To make sure users can choose to set different rubrics for different projects, we need first add a checkbox at this page. Therefore, users can use this box to indicate if they want to use the same rubric for all the projects or set some different rubrics for some projects.

[[File:2018F1873rubric.png]]

===Dropdown List===
To make sure users can choose rubrics for each project, we should add a new dropdown list beside each project in the following page. The number of dropdown list should decide by review round number. Therefore, each time users choose to identify different rubrics for different projects, the list will appear and users can choose proper rubrics. The default rubric set at last page will be overwritten in this case.

[[File:2018F1873project.png]]

===Controller===
Make changes to the controller so that these functions can work. Most of our logic control codes will be written in ''helpers/sign_up_sheet_helper.rb''.

logic flowchart:

[[File:umlj.png]]

===Database===
Add questionnaire_id in sign_up_topics table to make sure the projects can always relate to correct rubrics

[[File:Untitled Diagram.png]]|500px

===Test===
Test what we changed to make sure it works as intended and not influence the original system.

==''' Implement Steps '''==

=== Task 1 Add checkbox===
1. edit the file views/assignments/edit/_rubrics.html.erb

2. add a checkbox at the top of the page which says "Vary rubric by topic"

3. set the default state for this checkbox as unchecked

===Task 2 Add dropdown list===
1. edit the file views/assignment/edit/_general.html.erb

2. add a variable to indicate if the checkbox said in Task 1 is checked

3. create a new file under views/sign_up_sheet called "_rubrics_list.html.erb" to store the code for the dropdown list

4. edit the file views/sign_up_sheet/_table_line.html.erb

5. add the code to render the dropdown list

6. making a judgment before rendering the dropdown list, only if the checkbox in Task 1ist checked to render the page

===Task 3 Change controllers===
Change the update method in sign_up_sheet_controller.rb to make sure when new rubric is chosen for a specific topic, it can be stored in the database properly

===Task 4 Create migration===
1. create a new migration to add questionnaire_id in sign_up_topics

2. the questionnaire_id is a foreign key which references to questionnaires

3. change the file models/sign_up_topic.rb, and add the relations with the questionnaire, the relation between them is one-to-one

===Task 5 Test the changes===
1. make a test plan for the features that need to be tested

2. follow the test plan to write automatic test codes

3. evaluate the results and refactor codes

==''' Test plan '''==
We mainly use cucumber and capybara to test UI, and the following are detailed plans

===Test checkbox===
1. go to the rubrics page under the assignment

2. we can see the checkbox says "Vary rubric by topic" shows on this page

3. the initial state of the checkbox is unchecked

===Test dropdown list===
====Scenario 1====
1. the checkbox "Vary rubric by topic" is unchecked

2. go to the topics page under assignment

3.there are no dropdown lists beside topics
====Scenario 2====
1. the checkbox "Vary rubric by topic" is checked

2. go to the topics page under assignment

3. the table to show the topics have a row called "rubrics"

4. under this title, each topic has a dropdown list

CSC/ECE 517 Fall 2018/E1873 Specialized rubics for different topic types

2018-11-20T23:01:18Z

Jli94: /* Controller */

==''' Introduction '''==

=== Background ===
One of the fantastic features that Expertiza provides is for each assignment, it allows students providing reviews for others' jobs. This is done by offering a pre-defined questionnaire for the whole assignment, which is called the rubric for this assignment. Each rubric has several questions, each question provides a criterion to evaluate the performance from a specific angle. Then students can evaluate the entire job by rating and answering these questions. The team did that job can also get a detailed feedback for different aspects of the project.

=== Motivation ===
One of the problems for the review system is that for each assignment, different topics are included. Students can choose the one topic they like, and those topics fall into different categories. That is, an assignment always include different kind of projects. In Expertiza, the topic can be refactoring projects, testing projects, Mozilla projects, etc. Apparently, for different kinds of projects, we have different criteria to evaluate their performance. However, due to the current design of the system, all projects belong to the same assignment can only have the same rubric, which may lead to unnecessary criteria for some projects and inadequate criteria for other projects.
To make sure all kinds of projects can be evaluated properly. We plan to refactor the system to allow assigning different rubies for different projects in a specified appointment.

==''' Analysis & Plan '''==

To realize such purpose, we have the following tasks need to be done:

===Check Box===
For current design, the rubric used for a specified assignment is set at the following page. To make sure users can choose to set different rubrics for different projects, we need first add a checkbox at this page. Therefore, users can use this box to indicate if they want to use the same rubric for all the projects or set some different rubrics for some projects.

[[File:2018F1873rubric.png]]

===Dropdown List===
To make sure users can choose rubrics for each project, we should add a new dropdown list beside each project in the following page. The number of dropdown list should decide by review round number. Therefore, each time users choose to identify different rubrics for different projects, the list will appear and users can choose proper rubrics. The default rubric set at last page will be overwritten in this case.

[[File:2018F1873project.png]]

===Controller===
Make changes to the controller so that these functions can work. Most of our logic control codes will be written in ''helpers/sign_up_sheet_helper.rb''.

logic flowchart:

===Database===
Add questionnaire_id in sign_up_topics table to make sure the projects can always relate to correct rubrics

===Test===
Test what we changed to make sure it works as intended and not influence the original system.

==''' Implement Steps '''==

=== Task 1 Add checkbox===
1. edit the file views/assignments/edit/_rubrics.html.erb

2. add a checkbox at the top of the page which says "Vary rubric by topic"

3. set the default state for this checkbox as unchecked

===Task 2 Add dropdown list===
1. edit the file views/assignment/edit/_general.html.erb

2. add a variable to indicate if the checkbox said in Task 1 is checked

3. create a new file under views/sign_up_sheet called "_rubrics_list.html.erb" to store the code for the dropdown list

4. edit the file views/sign_up_sheet/_table_line.html.erb

5. add the code to render the dropdown list

6. making a judgment before rendering the dropdown list, only if the checkbox in Task 1ist checked to render the page

===Task 3 Change controllers===
Change the update method in sign_up_sheet_controller.rb to make sure when new rubric is chosen for a specific topic, it can be stored in the database properly

===Task 4 Create migration===
1. create a new migration to add questionnaire_id in sign_up_topics

2. the questionnaire_id is a foreign key which references to questionnaires

3. change the file models/sign_up_topic.rb, and add the relations with the questionnaire, the relation between them is one-to-one

===Task 5 Test the changes===
1. make a test plan for the features that need to be tested

2. follow the test plan to write automatic test codes

3. evaluate the results and refactor codes

==''' Test plan '''==
We mainly use cucumber and capybara to test UI, and the following are detailed plans

===Test checkbox===
1. go to the rubrics page under the assignment

2. we can see the checkbox says "Vary rubric by topic" shows on this page

3. the initial state of the checkbox is unchecked

===Test dropdown list===
====Scenario 1====
1. the checkbox "Vary rubric by topic" is unchecked

2. go to the topics page under assignment

3.there are no dropdown lists beside topics
====Scenario 2====
1. the checkbox "Vary rubric by topic" is checked

2. go to the topics page under assignment

3. the table to show the topics have a row called "rubrics"

4. under this title, each topic has a dropdown list

CSC/ECE 517 Fall 2018/E1873 Specialized rubics for different topic types

2018-11-20T22:59:59Z

Jli94: /* Dropdown List */

==''' Introduction '''==

=== Background ===
One of the fantastic features that Expertiza provides is for each assignment, it allows students providing reviews for others' jobs. This is done by offering a pre-defined questionnaire for the whole assignment, which is called the rubric for this assignment. Each rubric has several questions, each question provides a criterion to evaluate the performance from a specific angle. Then students can evaluate the entire job by rating and answering these questions. The team did that job can also get a detailed feedback for different aspects of the project.

=== Motivation ===
One of the problems for the review system is that for each assignment, different topics are included. Students can choose the one topic they like, and those topics fall into different categories. That is, an assignment always include different kind of projects. In Expertiza, the topic can be refactoring projects, testing projects, Mozilla projects, etc. Apparently, for different kinds of projects, we have different criteria to evaluate their performance. However, due to the current design of the system, all projects belong to the same assignment can only have the same rubric, which may lead to unnecessary criteria for some projects and inadequate criteria for other projects.
To make sure all kinds of projects can be evaluated properly. We plan to refactor the system to allow assigning different rubies for different projects in a specified appointment.

==''' Analysis & Plan '''==

To realize such purpose, we have the following tasks need to be done:

===Check Box===
For current design, the rubric used for a specified assignment is set at the following page. To make sure users can choose to set different rubrics for different projects, we need first add a checkbox at this page. Therefore, users can use this box to indicate if they want to use the same rubric for all the projects or set some different rubrics for some projects.

[[File:2018F1873rubric.png]]

===Dropdown List===
To make sure users can choose rubrics for each project, we should add a new dropdown list beside each project in the following page. The number of dropdown list should decide by review round number. Therefore, each time users choose to identify different rubrics for different projects, the list will appear and users can choose proper rubrics. The default rubric set at last page will be overwritten in this case.

[[File:2018F1873project.png]]

===Controller===
Make changes to the controller so that these functions can work. Most of our logic control codes will be written in ''helpers/sign_up_sheet_helper.rb''.

logic flowchart:

[[File:Example.jpg]]

===Database===
Add questionnaire_id in sign_up_topics table to make sure the projects can always relate to correct rubrics

===Test===
Test what we changed to make sure it works as intended and not influence the original system.

==''' Implement Steps '''==

=== Task 1 Add checkbox===
1. edit the file views/assignments/edit/_rubrics.html.erb

2. add a checkbox at the top of the page which says "Vary rubric by topic"

3. set the default state for this checkbox as unchecked

===Task 2 Add dropdown list===
1. edit the file views/assignment/edit/_general.html.erb

2. add a variable to indicate if the checkbox said in Task 1 is checked

3. create a new file under views/sign_up_sheet called "_rubrics_list.html.erb" to store the code for the dropdown list

4. edit the file views/sign_up_sheet/_table_line.html.erb

5. add the code to render the dropdown list

6. making a judgment before rendering the dropdown list, only if the checkbox in Task 1ist checked to render the page

===Task 3 Change controllers===
Change the update method in sign_up_sheet_controller.rb to make sure when new rubric is chosen for a specific topic, it can be stored in the database properly

===Task 4 Create migration===
1. create a new migration to add questionnaire_id in sign_up_topics

2. the questionnaire_id is a foreign key which references to questionnaires

3. change the file models/sign_up_topic.rb, and add the relations with the questionnaire, the relation between them is one-to-one

===Task 5 Test the changes===
1. make a test plan for the features that need to be tested

2. follow the test plan to write automatic test codes

3. evaluate the results and refactor codes

==''' Test plan '''==
We mainly use cucumber and capybara to test UI, and the following are detailed plans

===Test checkbox===
1. go to the rubrics page under the assignment

2. we can see the checkbox says "Vary rubric by topic" shows on this page

3. the initial state of the checkbox is unchecked

===Test dropdown list===
====Scenario 1====
1. the checkbox "Vary rubric by topic" is unchecked

2. go to the topics page under assignment

3.there are no dropdown lists beside topics
====Scenario 2====
1. the checkbox "Vary rubric by topic" is checked

2. go to the topics page under assignment

3. the table to show the topics have a row called "rubrics"

4. under this title, each topic has a dropdown list

CSC/ECE 517 Fall 2018/E1873 Specialized rubics for different topic types

2018-11-20T22:56:17Z

Jli94: /* Controller */

CSC/ECE 517 Fall 2018/E1873 Specialized rubics for different topic types

2018-11-20T22:41:23Z

Jli94: /* Controller */

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T03:24:57Z

Jli94: /* Lets */

For this project, the goal is to write up unit tests for assignment_team.rb

=='''Introduction'''==
Assignment_team.rb in Expertiza provides a method for student to assign a team and finish one assignment. Features come at the cost of complexity; this project is focused on creating the test methods to ensure that user interaction with the assignment interface remains stable and reliable.

=='''Bugs in assignment_team.rb'''==
We found some bugs in assignment_team.rb:
*In assign_reviewer(reviewer)
42: assignment = Assignment.find(self.parent_id) => assignment = Assignment.find_by(id: parent_id)
*In self.import(row, assignment_id, options)
108: id.to_s => assignment_id.to_s
The id doesn't exist in the AssignmentTeam

=='''Let'''==
We Use let to define a memoized helper method. The value will be cached across multiple calls in the same example but not across examples.
<pre>
let(:user) { User.new(id: 1) }
let(:assignment_team) { build(:assignment_team, id: 2, parent_id: 2, name: "team2", users: [user], submitted_hyperlinks: "https://www.1.ncsu.edu") }
let(:assignment_team1) { build(:assignment_team, id: 1, parent_id: 1, name: "team1", submitted_hyperlinks: "") }
let(:assignment_team2) { build(:assignment_team, id: 3, parent_id: 3, directory_num: -1) }
let(:questions) { {QuizQuestionnaire: double(:question)} }
let(:questionnaire) { build(:questionnaire) }
let(:assignment) { build(:assignment, id: 1, questionnaires: [questionnaire], name: 'Test Assgt') }
let(:courseTeam) { build(:course_team, id: 1) }
let(:team) { build(:assignment_team) }
let(:team_user) { build(:team_user) }
let(:team_without_submitted_hyperlinks) { build(:assignment_team, submitted_hyperlinks: "") }
let(:participant1) { build(:participant, id: 1, user: build(:student, id: 1, name: 'no name', fullname: 'no one')) }
let(:participant2) { build(:participant, id: 2) }
let(:review_response_map) { build(:review_response_map, id: 1, assignment: assignment, reviewer: participant1, reviewee: assignment_team1) }
let(:signed_up_team) { build(:signed_up_team, id: 1, team_id: 1, is_waitlisted: 0, topic_id: 1) }

</pre>

=='''Project Description'''==
There are some examples for how this project create test methods for assignment_team.rb

===Create a team===
In assignment_team.rb,there is a method return the team given the participant.
<pre>
def self.team(participant)
return nil if participant.nil?
team = nil
teams_users = TeamsUser.where(user_id: participant.user_id)
return nil unless teams_users
teams_users.each do |teams_user|
team = Team.find(teams_user.team_id)
return team if team.parent_id == participant.parent_id
end
nil
end
</pre>
Based on the above method, the test case can be created, and there are three different possible results could be generated.
*when the participant is nil
<pre>
it "returns nil" do
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when there are not team users records
<pre>
it "returns nil" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return(nil)
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when the participant is not nil and there exist team users records
<pre>
it "returns the team given the participant" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return([team_user])
allow(Team).to receive(:find).with(1).and_return(team)
expect(AssignmentTeam.team(participant1)).to eq(team)
end
</pre>

===Remove team by id===
The assignment_team.rb also provide a method which could remove team by id.
<pre>
def self.remove_team_by_id(id)
old_team = AssignmentTeam.find(id)
old_team.destroy unless old_team.nil?
end
</pre>
Based on the above code, the test case can be created:
<pre>
it "deletes a team given the team id" do
old_team = assignment_team1
allow(AssignmentTeam).to receive(:find).with(1).and_return(old_team)
allow(old_team).to receive(:destroy).and_return(old_team)
expect(AssignmentTeam.remove_team_by_id(1)).to eq(old_team)
end
</pre>

===Return the topic chosen by the team===
The assignment_team.rb offers a method that could return the topic chosen by the team.

<pre>
def topic
SignedUpTeam.find_by(team_id: self.id, is_waitlisted: 0).try(:topic_id)
end
</pre>

Based on the above code, the test case can be created:
<pre>
describe "#topic" do
it "returns the topic id chosen by this team" do
allow(SignedUpTeam).to receive(:find_by).with(team_id:1, is_waitlisted: 0).and_return(signed_up_team1)
expect(assignment_team1.topic).to eq(1)
end
end
</pre>

This test examines the original codes ability to generate the topic that is chosen by the team because it first goes to the mocked instances to look for a team. In this case, to match the mock instance that has created, we look for the team that has team_id as 1, and not being waitlisted. The topic id is set to be 1 in the mock. This function returns 1, because it does return the topic id, for the team that has signed up for a topic.

===Return whether the team has submission===
The assignment_team.rb offers a method that could return either true or false, in terms of whether the team has submitted work or not
<pre>
def has_submissions?
self.submitted_files.any? or self.submitted_hyperlinks.present?
end
</pre>

Based on the above code, the test case can be created, and there are three possible results:
*when current assignment team submitted files
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_files).and_return([double(:File)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit files but submitted hyperlinks
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_hyperlinks).and_return([double(:Hyperlink)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit either files or hyperlinks
<pre>
it "returns false" do
expect(assignment_team1.has_submissions? ).to be false
end
</pre>
===Return participants of a team===
The assignment_team.rb offers a method that could return the participants of a team.
<pre>
def participants
users = self.users
participants = []
users.each do |user|
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: self.parent_id)
participants << participant unless participant.nil?
end
participants
end
alias get_participants participants
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#participants" do
it "returns participants of the current assignment team" do
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: 2).and_return(participant2)
expect(assignment_team.participants).to eq([participant2])
end
end
</pre>
===Return the first member of the team===
The assignment_team.rb offers a method that could return the first member of the team.
<pre>
def self.get_first_member(team_id)
find_by(id: team_id).try(:participants).try(:first)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe ".get_first_member" do
it "returns the first participant of current assignment team" do
allow(AssignmentTeam).to receive_message_chain(:find_by, :try, :try).with(id: 1).with(:participants).with(:first).and_return(participant1)
expect(AssignmentTeam.get_first_member(1)).to eq(participant1)
end
end
</pre>
===Import csv file to form teams directly===
The assignment_team.rb offers a method that could import csv file to form teams directly.
<pre>
def self.import(row, assignment_id, options)
unless Assignment.find_by(id: assignment_id)
raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
end
@assignment_team = prototype
Team.import(row, assignment_id, options, @assignment_team)
end
</pre>
Based on the above code, the test case can be created:
*when there is no assignment with this assignment id
<pre>
context "when there is no assignment with this assignment id" do
it "raises an ImportError" do
allow(Assignment).to receive(:find_by).with(id: 1).and_return(nil)
expect { AssignmentTeam.import([], 1, has_column_names: 'false') }
.to raise_error(ImportError, "The assignment with the id \"1\" was not found. <a href='/assignment/new'>Create</a> this assignment?")
end
end
</pre>
*when there exists an assignment with this assignment id
<pre>
context "when there exists an assignment with this assignment id" do
it "imports a csv file to form assignment teams" do
allow(Assignment).to receive(:find_by).with(id: 2).and_return(double("Assignment", id: 2))
allow(AssignmentTeam).to receive(:prototype).and_return(assignment_team)
allow(Team).to receive(:import).with([], 2, {}, assignment_team).and_return(true)
expect(AssignmentTeam.import([], 2, {})).to eq(true)
end
end
</pre>
===Copy the current Assignment team to the CourseTeam===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def copy(course_id)
new_team = CourseTeam.create_team_and_node(course_id)
new_team.name = name
new_team.save
copy_members(new_team)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#copy" do
it "copies the current assignment team and team members to a new course team" do
allow(CourseTeam).to receive(:create_team_and_node).with(1).and_return(courseTeam)
allow(Team).to receive(:copy_members).with(courseTeam).and_return([])
expect(assignment_team.copy(1)).to eq([])
end
end
</pre>
===return a hash of scores that the team has received for the questions===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def scores(questions)
scores = {}
scores[:team] = self # This doesn't appear to be used anywhere
assignment.questionnaires.each do |questionnaire|
scores[questionnaire.symbol] = {}
scores[questionnaire.symbol][:assessments] = ReviewResponseMap.where(reviewee_id: self.id)
scores[questionnaire.symbol][:scores] = Answer.compute_scores(scores[questionnaire.symbol][:assessments], questions[questionnaire.symbol])
end
scores[:total_score] = assignment.compute_total_score(scores)
scores
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#scores" do
it "returns a hash of scores that current assignment team has received for the questions" do
allow(assignment_team).to receive(:assignment).and_return(assignment)
allow(ReviewResponseMap).to receive(:where).with(reviewee_id: 2).and_return(review_response_map)
allow(Answer).to receive(:compute_scores).with(review_response_map, questions[QuizQuestionnaire]).and_return(10)
allow(assignment).to receive(:compute_total_score).and_return(10)
# expect(assignment_team.scores(questions)[:QuizQuestionnaire]).equal?({assessments: review_response_map, scores: 10}).to be true
expect(assignment_team.scores(questions)[:team]).to eq(assignment_team)
expect(assignment_team.scores(questions)[:total_score]).to eq(10)
end
end
</pre>
===Return whether assignment team exist corresponding response maps===
The assignment_team.rb offers a method that could judge whether there exist corresponding response maps.
<pre>
def received_any_peer_review?
ResponseMap.where(reviewee_id: self.id, reviewed_object_id: self.parent_id).any?
end
</pre>
Based on the above code, the test case can be created:
*when there exist corresponding response map
<pre>
it "returns true" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([double(:ResponseMap)])
expect(assignment_team1.received_any_peer_review?).to be true
end
</pre>
*when there does not exist corresponding response maps
<pre>
it "returns false" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([])
expect(assignment_team1.received_any_peer_review?).to be false
end
</pre>
===Set the directory num for this team===
The assignment_team.rb offers a method that could Set the directory num for this team.
<pre>
def set_student_directory_num
return if self.directory_num and self.directory_num >= 0
max_num = AssignmentTeam.where(parent_id: self.parent_id).order('directory_num desc').first.directory_num
dir_num = max_num ? max_num + 1 : 0
self.update_attributes(directory_num: dir_num)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#set_student_directory_num" do
context "when there is no directory number for the assignment team" do
it "sets a directory number for the assignment team" do
# allow(assignment_team1).to receive(:try).with(:directory).and_return(-1)
allow(AssignmentTeam).to receive_message_chain(:where, :order, :first, :directory_num).and_return(4)
expect(assignment_team2.set_student_directory_num).to eq(true)
end
end
end
</pre>

This test can successfully test whether the team has submitted files/hyperlinks or not, because it creates a mock function, for the submitted_files function to receive a parameter - so that the team has hypothetically passed in a submitted file. The returning value being true shows that the has_submissions? test succeeded when the team receives a submitted file.

Similarly, we created a mock function for the team to receive a hyperlink using submitted_hyperlink. This second test case returning true shows the hyperlink being submitted is also detected by the function.

When there's no mock happening inside the function, no file or hyperlink will be passed into the team. So has_submissions? returns false is what's being expected.

=='''Result'''==
Our test cases has coverage: 100%

There are in total 127 relevant lines, and all of them get passed.

=='''Conclusion'''==
The testing framework in the assignment_team_spec.rb used unit tests to test the functionality of each action in the class. The mock instances are created at the beginning of the file, so that during each test they don't need to be constructed again. In order to test each unit case without depending on other functionalities, the mocked actions, as well as the desired returns are built inside different test cases, depending on the need of the case.

In building the test framework, the key is to understand the input, output and the desired action of each function that we want to test. The Rspec test format also has a steep learning curve, but the test shows stable and robust result on the assignment_team.rb.

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T03:24:32Z

Jli94:

For this project, the goal is to write up unit tests for assignment_team.rb

=='''Introduction'''==
Assignment_team.rb in Expertiza provides a method for student to assign a team and finish one assignment. Features come at the cost of complexity; this project is focused on creating the test methods to ensure that user interaction with the assignment interface remains stable and reliable.

=='''Bugs in assignment_team.rb'''==
We found some bugs in assignment_team.rb:
*In assign_reviewer(reviewer)
42: assignment = Assignment.find(self.parent_id) => assignment = Assignment.find_by(id: parent_id)
*In self.import(row, assignment_id, options)
108: id.to_s => assignment_id.to_s
The id doesn't exist in the AssignmentTeam

=='''Lets'''==
We Use let to define a memoized helper method. The value will be cached across multiple calls in the same example but not across examples.
<pre>
let(:user) { User.new(id: 1) }
let(:assignment_team) { build(:assignment_team, id: 2, parent_id: 2, name: "team2", users: [user], submitted_hyperlinks: "https://www.1.ncsu.edu") }
let(:assignment_team1) { build(:assignment_team, id: 1, parent_id: 1, name: "team1", submitted_hyperlinks: "") }
let(:assignment_team2) { build(:assignment_team, id: 3, parent_id: 3, directory_num: -1) }
let(:questions) { {QuizQuestionnaire: double(:question)} }
let(:questionnaire) { build(:questionnaire) }
let(:assignment) { build(:assignment, id: 1, questionnaires: [questionnaire], name: 'Test Assgt') }
let(:courseTeam) { build(:course_team, id: 1) }
let(:team) { build(:assignment_team) }
let(:team_user) { build(:team_user) }
let(:team_without_submitted_hyperlinks) { build(:assignment_team, submitted_hyperlinks: "") }
let(:participant1) { build(:participant, id: 1, user: build(:student, id: 1, name: 'no name', fullname: 'no one')) }
let(:participant2) { build(:participant, id: 2) }
let(:review_response_map) { build(:review_response_map, id: 1, assignment: assignment, reviewer: participant1, reviewee: assignment_team1) }
let(:signed_up_team) { build(:signed_up_team, id: 1, team_id: 1, is_waitlisted: 0, topic_id: 1) }

</pre>

=='''Project Description'''==
There are some examples for how this project create test methods for assignment_team.rb

===Create a team===
In assignment_team.rb,there is a method return the team given the participant.
<pre>
def self.team(participant)
return nil if participant.nil?
team = nil
teams_users = TeamsUser.where(user_id: participant.user_id)
return nil unless teams_users
teams_users.each do |teams_user|
team = Team.find(teams_user.team_id)
return team if team.parent_id == participant.parent_id
end
nil
end
</pre>
Based on the above method, the test case can be created, and there are three different possible results could be generated.
*when the participant is nil
<pre>
it "returns nil" do
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when there are not team users records
<pre>
it "returns nil" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return(nil)
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when the participant is not nil and there exist team users records
<pre>
it "returns the team given the participant" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return([team_user])
allow(Team).to receive(:find).with(1).and_return(team)
expect(AssignmentTeam.team(participant1)).to eq(team)
end
</pre>

===Remove team by id===
The assignment_team.rb also provide a method which could remove team by id.
<pre>
def self.remove_team_by_id(id)
old_team = AssignmentTeam.find(id)
old_team.destroy unless old_team.nil?
end
</pre>
Based on the above code, the test case can be created:
<pre>
it "deletes a team given the team id" do
old_team = assignment_team1
allow(AssignmentTeam).to receive(:find).with(1).and_return(old_team)
allow(old_team).to receive(:destroy).and_return(old_team)
expect(AssignmentTeam.remove_team_by_id(1)).to eq(old_team)
end
</pre>

===Return the topic chosen by the team===
The assignment_team.rb offers a method that could return the topic chosen by the team.

<pre>
def topic
SignedUpTeam.find_by(team_id: self.id, is_waitlisted: 0).try(:topic_id)
end
</pre>

Based on the above code, the test case can be created:
<pre>
describe "#topic" do
it "returns the topic id chosen by this team" do
allow(SignedUpTeam).to receive(:find_by).with(team_id:1, is_waitlisted: 0).and_return(signed_up_team1)
expect(assignment_team1.topic).to eq(1)
end
end
</pre>

This test examines the original codes ability to generate the topic that is chosen by the team because it first goes to the mocked instances to look for a team. In this case, to match the mock instance that has created, we look for the team that has team_id as 1, and not being waitlisted. The topic id is set to be 1 in the mock. This function returns 1, because it does return the topic id, for the team that has signed up for a topic.

===Return whether the team has submission===
The assignment_team.rb offers a method that could return either true or false, in terms of whether the team has submitted work or not
<pre>
def has_submissions?
self.submitted_files.any? or self.submitted_hyperlinks.present?
end
</pre>

Based on the above code, the test case can be created, and there are three possible results:
*when current assignment team submitted files
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_files).and_return([double(:File)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit files but submitted hyperlinks
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_hyperlinks).and_return([double(:Hyperlink)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit either files or hyperlinks
<pre>
it "returns false" do
expect(assignment_team1.has_submissions? ).to be false
end
</pre>
===Return participants of a team===
The assignment_team.rb offers a method that could return the participants of a team.
<pre>
def participants
users = self.users
participants = []
users.each do |user|
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: self.parent_id)
participants << participant unless participant.nil?
end
participants
end
alias get_participants participants
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#participants" do
it "returns participants of the current assignment team" do
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: 2).and_return(participant2)
expect(assignment_team.participants).to eq([participant2])
end
end
</pre>
===Return the first member of the team===
The assignment_team.rb offers a method that could return the first member of the team.
<pre>
def self.get_first_member(team_id)
find_by(id: team_id).try(:participants).try(:first)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe ".get_first_member" do
it "returns the first participant of current assignment team" do
allow(AssignmentTeam).to receive_message_chain(:find_by, :try, :try).with(id: 1).with(:participants).with(:first).and_return(participant1)
expect(AssignmentTeam.get_first_member(1)).to eq(participant1)
end
end
</pre>
===Import csv file to form teams directly===
The assignment_team.rb offers a method that could import csv file to form teams directly.
<pre>
def self.import(row, assignment_id, options)
unless Assignment.find_by(id: assignment_id)
raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
end
@assignment_team = prototype
Team.import(row, assignment_id, options, @assignment_team)
end
</pre>
Based on the above code, the test case can be created:
*when there is no assignment with this assignment id
<pre>
context "when there is no assignment with this assignment id" do
it "raises an ImportError" do
allow(Assignment).to receive(:find_by).with(id: 1).and_return(nil)
expect { AssignmentTeam.import([], 1, has_column_names: 'false') }
.to raise_error(ImportError, "The assignment with the id \"1\" was not found. <a href='/assignment/new'>Create</a> this assignment?")
end
end
</pre>
*when there exists an assignment with this assignment id
<pre>
context "when there exists an assignment with this assignment id" do
it "imports a csv file to form assignment teams" do
allow(Assignment).to receive(:find_by).with(id: 2).and_return(double("Assignment", id: 2))
allow(AssignmentTeam).to receive(:prototype).and_return(assignment_team)
allow(Team).to receive(:import).with([], 2, {}, assignment_team).and_return(true)
expect(AssignmentTeam.import([], 2, {})).to eq(true)
end
end
</pre>
===Copy the current Assignment team to the CourseTeam===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def copy(course_id)
new_team = CourseTeam.create_team_and_node(course_id)
new_team.name = name
new_team.save
copy_members(new_team)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#copy" do
it "copies the current assignment team and team members to a new course team" do
allow(CourseTeam).to receive(:create_team_and_node).with(1).and_return(courseTeam)
allow(Team).to receive(:copy_members).with(courseTeam).and_return([])
expect(assignment_team.copy(1)).to eq([])
end
end
</pre>
===return a hash of scores that the team has received for the questions===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def scores(questions)
scores = {}
scores[:team] = self # This doesn't appear to be used anywhere
assignment.questionnaires.each do |questionnaire|
scores[questionnaire.symbol] = {}
scores[questionnaire.symbol][:assessments] = ReviewResponseMap.where(reviewee_id: self.id)
scores[questionnaire.symbol][:scores] = Answer.compute_scores(scores[questionnaire.symbol][:assessments], questions[questionnaire.symbol])
end
scores[:total_score] = assignment.compute_total_score(scores)
scores
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#scores" do
it "returns a hash of scores that current assignment team has received for the questions" do
allow(assignment_team).to receive(:assignment).and_return(assignment)
allow(ReviewResponseMap).to receive(:where).with(reviewee_id: 2).and_return(review_response_map)
allow(Answer).to receive(:compute_scores).with(review_response_map, questions[QuizQuestionnaire]).and_return(10)
allow(assignment).to receive(:compute_total_score).and_return(10)
# expect(assignment_team.scores(questions)[:QuizQuestionnaire]).equal?({assessments: review_response_map, scores: 10}).to be true
expect(assignment_team.scores(questions)[:team]).to eq(assignment_team)
expect(assignment_team.scores(questions)[:total_score]).to eq(10)
end
end
</pre>
===Return whether assignment team exist corresponding response maps===
The assignment_team.rb offers a method that could judge whether there exist corresponding response maps.
<pre>
def received_any_peer_review?
ResponseMap.where(reviewee_id: self.id, reviewed_object_id: self.parent_id).any?
end
</pre>
Based on the above code, the test case can be created:
*when there exist corresponding response map
<pre>
it "returns true" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([double(:ResponseMap)])
expect(assignment_team1.received_any_peer_review?).to be true
end
</pre>
*when there does not exist corresponding response maps
<pre>
it "returns false" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([])
expect(assignment_team1.received_any_peer_review?).to be false
end
</pre>
===Set the directory num for this team===
The assignment_team.rb offers a method that could Set the directory num for this team.
<pre>
def set_student_directory_num
return if self.directory_num and self.directory_num >= 0
max_num = AssignmentTeam.where(parent_id: self.parent_id).order('directory_num desc').first.directory_num
dir_num = max_num ? max_num + 1 : 0
self.update_attributes(directory_num: dir_num)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#set_student_directory_num" do
context "when there is no directory number for the assignment team" do
it "sets a directory number for the assignment team" do
# allow(assignment_team1).to receive(:try).with(:directory).and_return(-1)
allow(AssignmentTeam).to receive_message_chain(:where, :order, :first, :directory_num).and_return(4)
expect(assignment_team2.set_student_directory_num).to eq(true)
end
end
end
</pre>

This test can successfully test whether the team has submitted files/hyperlinks or not, because it creates a mock function, for the submitted_files function to receive a parameter - so that the team has hypothetically passed in a submitted file. The returning value being true shows that the has_submissions? test succeeded when the team receives a submitted file.

Similarly, we created a mock function for the team to receive a hyperlink using submitted_hyperlink. This second test case returning true shows the hyperlink being submitted is also detected by the function.

When there's no mock happening inside the function, no file or hyperlink will be passed into the team. So has_submissions? returns false is what's being expected.

=='''Result'''==
Our test cases has coverage: 100%

There are in total 127 relevant lines, and all of them get passed.

=='''Conclusion'''==
The testing framework in the assignment_team_spec.rb used unit tests to test the functionality of each action in the class. The mock instances are created at the beginning of the file, so that during each test they don't need to be constructed again. In order to test each unit case without depending on other functionalities, the mocked actions, as well as the desired returns are built inside different test cases, depending on the need of the case.

In building the test framework, the key is to understand the input, output and the desired action of each function that we want to test. The Rspec test format also has a steep learning curve, but the test shows stable and robust result on the assignment_team.rb.

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T03:20:33Z

Jli94: /* Bugs in assignment_team.rb */

For this project, the goal is to write up unit tests for assignment_team.rb

=='''Introduction'''==
Assignment_team.rb in Expertiza provides a method for student to assign a team and finish one assignment. Features come at the cost of complexity; this project is focused on creating the test methods to ensure that user interaction with the assignment interface remains stable and reliable.

=='''Bugs in assignment_team.rb'''==
We found some bugs in assignment_team.rb:
*In assign_reviewer(reviewer)
42: assignment = Assignment.find(self.parent_id) => assignment = Assignment.find_by(id: parent_id)
*In self.import(row, assignment_id, options)
108: id.to_s => assignment_id.to_s
The id doesn't exist in the AssignmentTeam

=='''Project Description'''==
There are some examples for how this project create test methods for assignment_team.rb

===Create a team===
In assignment_team.rb,there is a method return the team given the participant.
<pre>
def self.team(participant)
return nil if participant.nil?
team = nil
teams_users = TeamsUser.where(user_id: participant.user_id)
return nil unless teams_users
teams_users.each do |teams_user|
team = Team.find(teams_user.team_id)
return team if team.parent_id == participant.parent_id
end
nil
end
</pre>
Based on the above method, the test case can be created, and there are three different possible results could be generated.
*when the participant is nil
<pre>
it "returns nil" do
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when there are not team users records
<pre>
it "returns nil" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return(nil)
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when the participant is not nil and there exist team users records
<pre>
it "returns the team given the participant" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return([team_user])
allow(Team).to receive(:find).with(1).and_return(team)
expect(AssignmentTeam.team(participant1)).to eq(team)
end
</pre>

===Remove team by id===
The assignment_team.rb also provide a method which could remove team by id.
<pre>
def self.remove_team_by_id(id)
old_team = AssignmentTeam.find(id)
old_team.destroy unless old_team.nil?
end
</pre>
Based on the above code, the test case can be created:
<pre>
it "deletes a team given the team id" do
old_team = assignment_team1
allow(AssignmentTeam).to receive(:find).with(1).and_return(old_team)
allow(old_team).to receive(:destroy).and_return(old_team)
expect(AssignmentTeam.remove_team_by_id(1)).to eq(old_team)
end
</pre>

===Return the topic chosen by the team===
The assignment_team.rb offers a method that could return the topic chosen by the team.

<pre>
def topic
SignedUpTeam.find_by(team_id: self.id, is_waitlisted: 0).try(:topic_id)
end
</pre>

Based on the above code, the test case can be created:
<pre>
describe "#topic" do
it "returns the topic id chosen by this team" do
allow(SignedUpTeam).to receive(:find_by).with(team_id:1, is_waitlisted: 0).and_return(signed_up_team1)
expect(assignment_team1.topic).to eq(1)
end
end
</pre>

This test examines the original codes ability to generate the topic that is chosen by the team because it first goes to the mocked instances to look for a team. In this case, to match the mock instance that has created, we look for the team that has team_id as 1, and not being waitlisted. The topic id is set to be 1 in the mock. This function returns 1, because it does return the topic id, for the team that has signed up for a topic.

===Return whether the team has submission===
The assignment_team.rb offers a method that could return either true or false, in terms of whether the team has submitted work or not
<pre>
def has_submissions?
self.submitted_files.any? or self.submitted_hyperlinks.present?
end
</pre>

Based on the above code, the test case can be created, and there are three possible results:
*when current assignment team submitted files
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_files).and_return([double(:File)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit files but submitted hyperlinks
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_hyperlinks).and_return([double(:Hyperlink)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit either files or hyperlinks
<pre>
it "returns false" do
expect(assignment_team1.has_submissions? ).to be false
end
</pre>
===Return participants of a team===
The assignment_team.rb offers a method that could return the participants of a team.
<pre>
def participants
users = self.users
participants = []
users.each do |user|
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: self.parent_id)
participants << participant unless participant.nil?
end
participants
end
alias get_participants participants
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#participants" do
it "returns participants of the current assignment team" do
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: 2).and_return(participant2)
expect(assignment_team.participants).to eq([participant2])
end
end
</pre>
===Return the first member of the team===
The assignment_team.rb offers a method that could return the first member of the team.
<pre>
def self.get_first_member(team_id)
find_by(id: team_id).try(:participants).try(:first)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe ".get_first_member" do
it "returns the first participant of current assignment team" do
allow(AssignmentTeam).to receive_message_chain(:find_by, :try, :try).with(id: 1).with(:participants).with(:first).and_return(participant1)
expect(AssignmentTeam.get_first_member(1)).to eq(participant1)
end
end
</pre>
===Import csv file to form teams directly===
The assignment_team.rb offers a method that could import csv file to form teams directly.
<pre>
def self.import(row, assignment_id, options)
unless Assignment.find_by(id: assignment_id)
raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
end
@assignment_team = prototype
Team.import(row, assignment_id, options, @assignment_team)
end
</pre>
Based on the above code, the test case can be created:
*when there is no assignment with this assignment id
<pre>
context "when there is no assignment with this assignment id" do
it "raises an ImportError" do
allow(Assignment).to receive(:find_by).with(id: 1).and_return(nil)
expect { AssignmentTeam.import([], 1, has_column_names: 'false') }
.to raise_error(ImportError, "The assignment with the id \"1\" was not found. <a href='/assignment/new'>Create</a> this assignment?")
end
end
</pre>
*when there exists an assignment with this assignment id
<pre>
context "when there exists an assignment with this assignment id" do
it "imports a csv file to form assignment teams" do
allow(Assignment).to receive(:find_by).with(id: 2).and_return(double("Assignment", id: 2))
allow(AssignmentTeam).to receive(:prototype).and_return(assignment_team)
allow(Team).to receive(:import).with([], 2, {}, assignment_team).and_return(true)
expect(AssignmentTeam.import([], 2, {})).to eq(true)
end
end
</pre>
===Copy the current Assignment team to the CourseTeam===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def copy(course_id)
new_team = CourseTeam.create_team_and_node(course_id)
new_team.name = name
new_team.save
copy_members(new_team)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#copy" do
it "copies the current assignment team and team members to a new course team" do
allow(CourseTeam).to receive(:create_team_and_node).with(1).and_return(courseTeam)
allow(Team).to receive(:copy_members).with(courseTeam).and_return([])
expect(assignment_team.copy(1)).to eq([])
end
end
</pre>
===return a hash of scores that the team has received for the questions===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def scores(questions)
scores = {}
scores[:team] = self # This doesn't appear to be used anywhere
assignment.questionnaires.each do |questionnaire|
scores[questionnaire.symbol] = {}
scores[questionnaire.symbol][:assessments] = ReviewResponseMap.where(reviewee_id: self.id)
scores[questionnaire.symbol][:scores] = Answer.compute_scores(scores[questionnaire.symbol][:assessments], questions[questionnaire.symbol])
end
scores[:total_score] = assignment.compute_total_score(scores)
scores
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#scores" do
it "returns a hash of scores that current assignment team has received for the questions" do
allow(assignment_team).to receive(:assignment).and_return(assignment)
allow(ReviewResponseMap).to receive(:where).with(reviewee_id: 2).and_return(review_response_map)
allow(Answer).to receive(:compute_scores).with(review_response_map, questions[QuizQuestionnaire]).and_return(10)
allow(assignment).to receive(:compute_total_score).and_return(10)
# expect(assignment_team.scores(questions)[:QuizQuestionnaire]).equal?({assessments: review_response_map, scores: 10}).to be true
expect(assignment_team.scores(questions)[:team]).to eq(assignment_team)
expect(assignment_team.scores(questions)[:total_score]).to eq(10)
end
end
</pre>
===Return whether assignment team exist corresponding response maps===
The assignment_team.rb offers a method that could judge whether there exist corresponding response maps.
<pre>
def received_any_peer_review?
ResponseMap.where(reviewee_id: self.id, reviewed_object_id: self.parent_id).any?
end
</pre>
Based on the above code, the test case can be created:
*when there exist corresponding response map
<pre>
it "returns true" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([double(:ResponseMap)])
expect(assignment_team1.received_any_peer_review?).to be true
end
</pre>
*when there does not exist corresponding response maps
<pre>
it "returns false" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([])
expect(assignment_team1.received_any_peer_review?).to be false
end
</pre>
===Set the directory num for this team===
The assignment_team.rb offers a method that could Set the directory num for this team.
<pre>
def set_student_directory_num
return if self.directory_num and self.directory_num >= 0
max_num = AssignmentTeam.where(parent_id: self.parent_id).order('directory_num desc').first.directory_num
dir_num = max_num ? max_num + 1 : 0
self.update_attributes(directory_num: dir_num)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#set_student_directory_num" do
context "when there is no directory number for the assignment team" do
it "sets a directory number for the assignment team" do
# allow(assignment_team1).to receive(:try).with(:directory).and_return(-1)
allow(AssignmentTeam).to receive_message_chain(:where, :order, :first, :directory_num).and_return(4)
expect(assignment_team2.set_student_directory_num).to eq(true)
end
end
end
</pre>

This test can successfully test whether the team has submitted files/hyperlinks or not, because it creates a mock function, for the submitted_files function to receive a parameter - so that the team has hypothetically passed in a submitted file. The returning value being true shows that the has_submissions? test succeeded when the team receives a submitted file.

Similarly, we created a mock function for the team to receive a hyperlink using submitted_hyperlink. This second test case returning true shows the hyperlink being submitted is also detected by the function.

When there's no mock happening inside the function, no file or hyperlink will be passed into the team. So has_submissions? returns false is what's being expected.

=='''Result'''==
Our test cases has coverage: 100%

There are in total 127 relevant lines, and all of them get passed.

=='''Conclusion'''==
The testing framework in the assignment_team_spec.rb used unit tests to test the functionality of each action in the class. The mock instances are created at the beginning of the file, so that during each test they don't need to be constructed again. In order to test each unit case without depending on other functionalities, the mocked actions, as well as the desired returns are built inside different test cases, depending on the need of the case.

In building the test framework, the key is to understand the input, output and the desired action of each function that we want to test. The Rspec test format also has a steep learning curve, but the test shows stable and robust result on the assignment_team.rb.

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T03:18:05Z

Jli94: /* Bugs in assignment_team.rb */

For this project, the goal is to write up unit tests for assignment_team.rb

=='''Introduction'''==
Assignment_team.rb in Expertiza provides a method for student to assign a team and finish one assignment. Features come at the cost of complexity; this project is focused on creating the test methods to ensure that user interaction with the assignment interface remains stable and reliable.

=='''Bugs in assignment_team.rb'''==
We found some bugs in assignment_team.rb:
*In assign_reviewer(reviewer)
assignment = Assignment.find(self.parent_id) => assignment = Assignment.find_by(id: parent_id)
*In self.import(row, assignment_id, options)
108: raise ImportError, "The assignment with the id \"" + id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
=>raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
The id dose't exist in the AssignmentTeam

=='''Project Description'''==
There are some examples for how this project create test methods for assignment_team.rb

===Create a team===
In assignment_team.rb,there is a method return the team given the participant.
<pre>
def self.team(participant)
return nil if participant.nil?
team = nil
teams_users = TeamsUser.where(user_id: participant.user_id)
return nil unless teams_users
teams_users.each do |teams_user|
team = Team.find(teams_user.team_id)
return team if team.parent_id == participant.parent_id
end
nil
end
</pre>
Based on the above method, the test case can be created, and there are three different possible results could be generated.
*when the participant is nil
<pre>
it "returns nil" do
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when there are not team users records
<pre>
it "returns nil" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return(nil)
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when the participant is not nil and there exist team users records
<pre>
it "returns the team given the participant" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return([team_user])
allow(Team).to receive(:find).with(1).and_return(team)
expect(AssignmentTeam.team(participant1)).to eq(team)
end
</pre>

===Remove team by id===
The assignment_team.rb also provide a method which could remove team by id.
<pre>
def self.remove_team_by_id(id)
old_team = AssignmentTeam.find(id)
old_team.destroy unless old_team.nil?
end
</pre>
Based on the above code, the test case can be created:
<pre>
it "deletes a team given the team id" do
old_team = assignment_team1
allow(AssignmentTeam).to receive(:find).with(1).and_return(old_team)
allow(old_team).to receive(:destroy).and_return(old_team)
expect(AssignmentTeam.remove_team_by_id(1)).to eq(old_team)
end
</pre>

===Return the topic chosen by the team===
The assignment_team.rb offers a method that could return the topic chosen by the team.

<pre>
def topic
SignedUpTeam.find_by(team_id: self.id, is_waitlisted: 0).try(:topic_id)
end
</pre>

Based on the above code, the test case can be created:
<pre>
describe "#topic" do
it "returns the topic id chosen by this team" do
allow(SignedUpTeam).to receive(:find_by).with(team_id:1, is_waitlisted: 0).and_return(signed_up_team1)
expect(assignment_team1.topic).to eq(1)
end
end
</pre>

This test examines the original codes ability to generate the topic that is chosen by the team because it first goes to the mocked instances to look for a team. In this case, to match the mock instance that has created, we look for the team that has team_id as 1, and not being waitlisted. The topic id is set to be 1 in the mock. This function returns 1, because it does return the topic id, for the team that has signed up for a topic.

===Return whether the team has submission===
The assignment_team.rb offers a method that could return either true or false, in terms of whether the team has submitted work or not
<pre>
def has_submissions?
self.submitted_files.any? or self.submitted_hyperlinks.present?
end
</pre>

Based on the above code, the test case can be created, and there are three possible results:
*when current assignment team submitted files
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_files).and_return([double(:File)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit files but submitted hyperlinks
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_hyperlinks).and_return([double(:Hyperlink)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit either files or hyperlinks
<pre>
it "returns false" do
expect(assignment_team1.has_submissions? ).to be false
end
</pre>
===Return participants of a team===
The assignment_team.rb offers a method that could return the participants of a team.
<pre>
def participants
users = self.users
participants = []
users.each do |user|
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: self.parent_id)
participants << participant unless participant.nil?
end
participants
end
alias get_participants participants
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#participants" do
it "returns participants of the current assignment team" do
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: 2).and_return(participant2)
expect(assignment_team.participants).to eq([participant2])
end
end
</pre>
===Return the first member of the team===
The assignment_team.rb offers a method that could return the first member of the team.
<pre>
def self.get_first_member(team_id)
find_by(id: team_id).try(:participants).try(:first)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe ".get_first_member" do
it "returns the first participant of current assignment team" do
allow(AssignmentTeam).to receive_message_chain(:find_by, :try, :try).with(id: 1).with(:participants).with(:first).and_return(participant1)
expect(AssignmentTeam.get_first_member(1)).to eq(participant1)
end
end
</pre>
===Import csv file to form teams directly===
The assignment_team.rb offers a method that could import csv file to form teams directly.
<pre>
def self.import(row, assignment_id, options)
unless Assignment.find_by(id: assignment_id)
raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
end
@assignment_team = prototype
Team.import(row, assignment_id, options, @assignment_team)
end
</pre>
Based on the above code, the test case can be created:
*when there is no assignment with this assignment id
<pre>
context "when there is no assignment with this assignment id" do
it "raises an ImportError" do
allow(Assignment).to receive(:find_by).with(id: 1).and_return(nil)
expect { AssignmentTeam.import([], 1, has_column_names: 'false') }
.to raise_error(ImportError, "The assignment with the id \"1\" was not found. <a href='/assignment/new'>Create</a> this assignment?")
end
end
</pre>
*when there exists an assignment with this assignment id
<pre>
context "when there exists an assignment with this assignment id" do
it "imports a csv file to form assignment teams" do
allow(Assignment).to receive(:find_by).with(id: 2).and_return(double("Assignment", id: 2))
allow(AssignmentTeam).to receive(:prototype).and_return(assignment_team)
allow(Team).to receive(:import).with([], 2, {}, assignment_team).and_return(true)
expect(AssignmentTeam.import([], 2, {})).to eq(true)
end
end
</pre>
===Copy the current Assignment team to the CourseTeam===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def copy(course_id)
new_team = CourseTeam.create_team_and_node(course_id)
new_team.name = name
new_team.save
copy_members(new_team)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#copy" do
it "copies the current assignment team and team members to a new course team" do
allow(CourseTeam).to receive(:create_team_and_node).with(1).and_return(courseTeam)
allow(Team).to receive(:copy_members).with(courseTeam).and_return([])
expect(assignment_team.copy(1)).to eq([])
end
end
</pre>
===return a hash of scores that the team has received for the questions===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def scores(questions)
scores = {}
scores[:team] = self # This doesn't appear to be used anywhere
assignment.questionnaires.each do |questionnaire|
scores[questionnaire.symbol] = {}
scores[questionnaire.symbol][:assessments] = ReviewResponseMap.where(reviewee_id: self.id)
scores[questionnaire.symbol][:scores] = Answer.compute_scores(scores[questionnaire.symbol][:assessments], questions[questionnaire.symbol])
end
scores[:total_score] = assignment.compute_total_score(scores)
scores
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#scores" do
it "returns a hash of scores that current assignment team has received for the questions" do
allow(assignment_team).to receive(:assignment).and_return(assignment)
allow(ReviewResponseMap).to receive(:where).with(reviewee_id: 2).and_return(review_response_map)
allow(Answer).to receive(:compute_scores).with(review_response_map, questions[QuizQuestionnaire]).and_return(10)
allow(assignment).to receive(:compute_total_score).and_return(10)
# expect(assignment_team.scores(questions)[:QuizQuestionnaire]).equal?({assessments: review_response_map, scores: 10}).to be true
expect(assignment_team.scores(questions)[:team]).to eq(assignment_team)
expect(assignment_team.scores(questions)[:total_score]).to eq(10)
end
end
</pre>
===Return whether assignment team exist corresponding response maps===
The assignment_team.rb offers a method that could judge whether there exist corresponding response maps.
<pre>
def received_any_peer_review?
ResponseMap.where(reviewee_id: self.id, reviewed_object_id: self.parent_id).any?
end
</pre>
Based on the above code, the test case can be created:
*when there exist corresponding response map
<pre>
it "returns true" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([double(:ResponseMap)])
expect(assignment_team1.received_any_peer_review?).to be true
end
</pre>
*when there does not exist corresponding response maps
<pre>
it "returns false" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([])
expect(assignment_team1.received_any_peer_review?).to be false
end
</pre>
===Set the directory num for this team===
The assignment_team.rb offers a method that could Set the directory num for this team.
<pre>
def set_student_directory_num
return if self.directory_num and self.directory_num >= 0
max_num = AssignmentTeam.where(parent_id: self.parent_id).order('directory_num desc').first.directory_num
dir_num = max_num ? max_num + 1 : 0
self.update_attributes(directory_num: dir_num)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#set_student_directory_num" do
context "when there is no directory number for the assignment team" do
it "sets a directory number for the assignment team" do
# allow(assignment_team1).to receive(:try).with(:directory).and_return(-1)
allow(AssignmentTeam).to receive_message_chain(:where, :order, :first, :directory_num).and_return(4)
expect(assignment_team2.set_student_directory_num).to eq(true)
end
end
end
</pre>

This test can successfully test whether the team has submitted files/hyperlinks or not, because it creates a mock function, for the submitted_files function to receive a parameter - so that the team has hypothetically passed in a submitted file. The returning value being true shows that the has_submissions? test succeeded when the team receives a submitted file.

Similarly, we created a mock function for the team to receive a hyperlink using submitted_hyperlink. This second test case returning true shows the hyperlink being submitted is also detected by the function.

When there's no mock happening inside the function, no file or hyperlink will be passed into the team. So has_submissions? returns false is what's being expected.

=='''Result'''==
Our test cases has coverage: 100%

There are in total 127 relevant lines, and all of them get passed.

=='''Conclusion'''==
The testing framework in the assignment_team_spec.rb used unit tests to test the functionality of each action in the class. The mock instances are created at the beginning of the file, so that during each test they don't need to be constructed again. In order to test each unit case without depending on other functionalities, the mocked actions, as well as the desired returns are built inside different test cases, depending on the need of the case.

In building the test framework, the key is to understand the input, output and the desired action of each function that we want to test. The Rspec test format also has a steep learning curve, but the test shows stable and robust result on the assignment_team.rb.

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T03:17:42Z

Jli94:

For this project, the goal is to write up unit tests for assignment_team.rb

=='''Introduction'''==
Assignment_team.rb in Expertiza provides a method for student to assign a team and finish one assignment. Features come at the cost of complexity; this project is focused on creating the test methods to ensure that user interaction with the assignment interface remains stable and reliable.

=='''Bugs in assignment_team.rb'''==
We found some bugs in assignment_team.rb:
===In assign_reviewer(reviewer)===
assignment = Assignment.find(self.parent_id) => assignment = Assignment.find_by(id: parent_id)
===In self.import(row, assignment_id, options)===
108: raise ImportError, "The assignment with the id \"" + id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
=>raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
The id dose't exist in the AssignmentTeam

=='''Project Description'''==
There are some examples for how this project create test methods for assignment_team.rb

===Create a team===
In assignment_team.rb,there is a method return the team given the participant.
<pre>
def self.team(participant)
return nil if participant.nil?
team = nil
teams_users = TeamsUser.where(user_id: participant.user_id)
return nil unless teams_users
teams_users.each do |teams_user|
team = Team.find(teams_user.team_id)
return team if team.parent_id == participant.parent_id
end
nil
end
</pre>
Based on the above method, the test case can be created, and there are three different possible results could be generated.
*when the participant is nil
<pre>
it "returns nil" do
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when there are not team users records
<pre>
it "returns nil" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return(nil)
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when the participant is not nil and there exist team users records
<pre>
it "returns the team given the participant" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return([team_user])
allow(Team).to receive(:find).with(1).and_return(team)
expect(AssignmentTeam.team(participant1)).to eq(team)
end
</pre>

===Remove team by id===
The assignment_team.rb also provide a method which could remove team by id.
<pre>
def self.remove_team_by_id(id)
old_team = AssignmentTeam.find(id)
old_team.destroy unless old_team.nil?
end
</pre>
Based on the above code, the test case can be created:
<pre>
it "deletes a team given the team id" do
old_team = assignment_team1
allow(AssignmentTeam).to receive(:find).with(1).and_return(old_team)
allow(old_team).to receive(:destroy).and_return(old_team)
expect(AssignmentTeam.remove_team_by_id(1)).to eq(old_team)
end
</pre>

===Return the topic chosen by the team===
The assignment_team.rb offers a method that could return the topic chosen by the team.

<pre>
def topic
SignedUpTeam.find_by(team_id: self.id, is_waitlisted: 0).try(:topic_id)
end
</pre>

Based on the above code, the test case can be created:
<pre>
describe "#topic" do
it "returns the topic id chosen by this team" do
allow(SignedUpTeam).to receive(:find_by).with(team_id:1, is_waitlisted: 0).and_return(signed_up_team1)
expect(assignment_team1.topic).to eq(1)
end
end
</pre>

This test examines the original codes ability to generate the topic that is chosen by the team because it first goes to the mocked instances to look for a team. In this case, to match the mock instance that has created, we look for the team that has team_id as 1, and not being waitlisted. The topic id is set to be 1 in the mock. This function returns 1, because it does return the topic id, for the team that has signed up for a topic.

===Return whether the team has submission===
The assignment_team.rb offers a method that could return either true or false, in terms of whether the team has submitted work or not
<pre>
def has_submissions?
self.submitted_files.any? or self.submitted_hyperlinks.present?
end
</pre>

Based on the above code, the test case can be created, and there are three possible results:
*when current assignment team submitted files
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_files).and_return([double(:File)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit files but submitted hyperlinks
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_hyperlinks).and_return([double(:Hyperlink)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit either files or hyperlinks
<pre>
it "returns false" do
expect(assignment_team1.has_submissions? ).to be false
end
</pre>
===Return participants of a team===
The assignment_team.rb offers a method that could return the participants of a team.
<pre>
def participants
users = self.users
participants = []
users.each do |user|
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: self.parent_id)
participants << participant unless participant.nil?
end
participants
end
alias get_participants participants
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#participants" do
it "returns participants of the current assignment team" do
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: 2).and_return(participant2)
expect(assignment_team.participants).to eq([participant2])
end
end
</pre>
===Return the first member of the team===
The assignment_team.rb offers a method that could return the first member of the team.
<pre>
def self.get_first_member(team_id)
find_by(id: team_id).try(:participants).try(:first)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe ".get_first_member" do
it "returns the first participant of current assignment team" do
allow(AssignmentTeam).to receive_message_chain(:find_by, :try, :try).with(id: 1).with(:participants).with(:first).and_return(participant1)
expect(AssignmentTeam.get_first_member(1)).to eq(participant1)
end
end
</pre>
===Import csv file to form teams directly===
The assignment_team.rb offers a method that could import csv file to form teams directly.
<pre>
def self.import(row, assignment_id, options)
unless Assignment.find_by(id: assignment_id)
raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
end
@assignment_team = prototype
Team.import(row, assignment_id, options, @assignment_team)
end
</pre>
Based on the above code, the test case can be created:
*when there is no assignment with this assignment id
<pre>
context "when there is no assignment with this assignment id" do
it "raises an ImportError" do
allow(Assignment).to receive(:find_by).with(id: 1).and_return(nil)
expect { AssignmentTeam.import([], 1, has_column_names: 'false') }
.to raise_error(ImportError, "The assignment with the id \"1\" was not found. <a href='/assignment/new'>Create</a> this assignment?")
end
end
</pre>
*when there exists an assignment with this assignment id
<pre>
context "when there exists an assignment with this assignment id" do
it "imports a csv file to form assignment teams" do
allow(Assignment).to receive(:find_by).with(id: 2).and_return(double("Assignment", id: 2))
allow(AssignmentTeam).to receive(:prototype).and_return(assignment_team)
allow(Team).to receive(:import).with([], 2, {}, assignment_team).and_return(true)
expect(AssignmentTeam.import([], 2, {})).to eq(true)
end
end
</pre>
===Copy the current Assignment team to the CourseTeam===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def copy(course_id)
new_team = CourseTeam.create_team_and_node(course_id)
new_team.name = name
new_team.save
copy_members(new_team)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#copy" do
it "copies the current assignment team and team members to a new course team" do
allow(CourseTeam).to receive(:create_team_and_node).with(1).and_return(courseTeam)
allow(Team).to receive(:copy_members).with(courseTeam).and_return([])
expect(assignment_team.copy(1)).to eq([])
end
end
</pre>
===return a hash of scores that the team has received for the questions===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def scores(questions)
scores = {}
scores[:team] = self # This doesn't appear to be used anywhere
assignment.questionnaires.each do |questionnaire|
scores[questionnaire.symbol] = {}
scores[questionnaire.symbol][:assessments] = ReviewResponseMap.where(reviewee_id: self.id)
scores[questionnaire.symbol][:scores] = Answer.compute_scores(scores[questionnaire.symbol][:assessments], questions[questionnaire.symbol])
end
scores[:total_score] = assignment.compute_total_score(scores)
scores
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#scores" do
it "returns a hash of scores that current assignment team has received for the questions" do
allow(assignment_team).to receive(:assignment).and_return(assignment)
allow(ReviewResponseMap).to receive(:where).with(reviewee_id: 2).and_return(review_response_map)
allow(Answer).to receive(:compute_scores).with(review_response_map, questions[QuizQuestionnaire]).and_return(10)
allow(assignment).to receive(:compute_total_score).and_return(10)
# expect(assignment_team.scores(questions)[:QuizQuestionnaire]).equal?({assessments: review_response_map, scores: 10}).to be true
expect(assignment_team.scores(questions)[:team]).to eq(assignment_team)
expect(assignment_team.scores(questions)[:total_score]).to eq(10)
end
end
</pre>
===Return whether assignment team exist corresponding response maps===
The assignment_team.rb offers a method that could judge whether there exist corresponding response maps.
<pre>
def received_any_peer_review?
ResponseMap.where(reviewee_id: self.id, reviewed_object_id: self.parent_id).any?
end
</pre>
Based on the above code, the test case can be created:
*when there exist corresponding response map
<pre>
it "returns true" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([double(:ResponseMap)])
expect(assignment_team1.received_any_peer_review?).to be true
end
</pre>
*when there does not exist corresponding response maps
<pre>
it "returns false" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([])
expect(assignment_team1.received_any_peer_review?).to be false
end
</pre>
===Set the directory num for this team===
The assignment_team.rb offers a method that could Set the directory num for this team.
<pre>
def set_student_directory_num
return if self.directory_num and self.directory_num >= 0
max_num = AssignmentTeam.where(parent_id: self.parent_id).order('directory_num desc').first.directory_num
dir_num = max_num ? max_num + 1 : 0
self.update_attributes(directory_num: dir_num)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#set_student_directory_num" do
context "when there is no directory number for the assignment team" do
it "sets a directory number for the assignment team" do
# allow(assignment_team1).to receive(:try).with(:directory).and_return(-1)
allow(AssignmentTeam).to receive_message_chain(:where, :order, :first, :directory_num).and_return(4)
expect(assignment_team2.set_student_directory_num).to eq(true)
end
end
end
</pre>

This test can successfully test whether the team has submitted files/hyperlinks or not, because it creates a mock function, for the submitted_files function to receive a parameter - so that the team has hypothetically passed in a submitted file. The returning value being true shows that the has_submissions? test succeeded when the team receives a submitted file.

Similarly, we created a mock function for the team to receive a hyperlink using submitted_hyperlink. This second test case returning true shows the hyperlink being submitted is also detected by the function.

When there's no mock happening inside the function, no file or hyperlink will be passed into the team. So has_submissions? returns false is what's being expected.

=='''Result'''==
Our test cases has coverage: 100%

There are in total 127 relevant lines, and all of them get passed.

=='''Conclusion'''==
The testing framework in the assignment_team_spec.rb used unit tests to test the functionality of each action in the class. The mock instances are created at the beginning of the file, so that during each test they don't need to be constructed again. In order to test each unit case without depending on other functionalities, the mocked actions, as well as the desired returns are built inside different test cases, depending on the need of the case.

In building the test framework, the key is to understand the input, output and the desired action of each function that we want to test. The Rspec test format also has a steep learning curve, but the test shows stable and robust result on the assignment_team.rb.

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T03:02:59Z

Jli94: /* Project Description */

For this progect, the goal is to wirte up unit tests for assignment_team.rb

=='''Introduction'''==
Assignment_team.rb in Expertiza provides a method for student to assign a team and finish one assignment. Features come at the cost of complexity; this project is focused on creating the test methods to ensure that user interaction with the assignment interface remains stable and reliable.

=='''Project Description'''==
There are some examples for how this project create test methods for assignment_team.rb

===Create a team===
In assignment_team.rb,there is a method return the team given the participant.
<pre>
def self.team(participant)
return nil if participant.nil?
team = nil
teams_users = TeamsUser.where(user_id: participant.user_id)
return nil unless teams_users
teams_users.each do |teams_user|
team = Team.find(teams_user.team_id)
return team if team.parent_id == participant.parent_id
end
nil
end
</pre>
Based on the above method, the test case can be created, and there are three different possible results could be generated.
*when the participant is nil
<pre>
it "returns nil" do
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when there are not team users records
<pre>
it "returns nil" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return(nil)
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when the participant is not nil and there exist team users records
<pre>
it "returns the team given the participant" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return([team_user])
allow(Team).to receive(:find).with(1).and_return(team)
expect(AssignmentTeam.team(participant1)).to eq(team)
end
</pre>

===Remove team by id===
The assignment_team.rb also provide a method which could remove team by id.
<pre>
def self.remove_team_by_id(id)
old_team = AssignmentTeam.find(id)
old_team.destroy unless old_team.nil?
end
</pre>
Based on the above code, the test case can be created:
<pre>
it "deletes a team given the team id" do
old_team = assignment_team1
allow(AssignmentTeam).to receive(:find).with(1).and_return(old_team)
allow(old_team).to receive(:destroy).and_return(old_team)
expect(AssignmentTeam.remove_team_by_id(1)).to eq(old_team)
end
</pre>

===Return the topic chosen by the team===
The assignment_team.rb offers a method that could return the topic chosen by the team.

<pre>
def topic
SignedUpTeam.find_by(team_id: self.id, is_waitlisted: 0).try(:topic_id)
end
</pre>

Based on the above code, the test case can be created:
<pre>
describe "#topic" do
it "returns the topic id chosen by this team" do
allow(SignedUpTeam).to receive(:find_by).with(team_id:1, is_waitlisted: 0).and_return(signed_up_team1)
expect(assignment_team1.topic).to eq(1)
end
end
</pre>

This test examines the original codes ability to generate the topic that is chosen by the team because it first goes to the mocked instances to look for a team. In this case, to match the mock instance that has created, we look for the team that has team_id as 1, and not being waitlisted. The topic id is set to be 1 in the mock. This function returns 1, because it does return the topic id, for the team that has signed up for a topic.

===Return whether the team has submission===
The assignment_team.rb offers a method that could return either true or false, in terms of whether the team has submitted work or not
<pre>
def has_submissions?
self.submitted_files.any? or self.submitted_hyperlinks.present?
end
</pre>

Based on the above code, the test case can be created, and there are three possible results:
*when current assignment team submitted files
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_files).and_return([double(:File)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit files but submitted hyperlinks
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_hyperlinks).and_return([double(:Hyperlink)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit either files or hyperlinks
<pre>
it "returns false" do
expect(assignment_team1.has_submissions? ).to be false
end
</pre>
===Return participants of a team===
The assignment_team.rb offers a method that could return the participants of a team.
<pre>
def participants
users = self.users
participants = []
users.each do |user|
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: self.parent_id)
participants << participant unless participant.nil?
end
participants
end
alias get_participants participants
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#participants" do
it "returns participants of the current assignment team" do
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: 2).and_return(participant2)
expect(assignment_team.participants).to eq([participant2])
end
end
</pre>
===Return the first member of the team===
The assignment_team.rb offers a method that could return the first member of the team.
<pre>
def self.get_first_member(team_id)
find_by(id: team_id).try(:participants).try(:first)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe ".get_first_member" do
it "returns the first participant of current assignment team" do
allow(AssignmentTeam).to receive_message_chain(:find_by, :try, :try).with(id: 1).with(:participants).with(:first).and_return(participant1)
expect(AssignmentTeam.get_first_member(1)).to eq(participant1)
end
end
</pre>
===Import csv file to form teams directly===
The assignment_team.rb offers a method that could import csv file to form teams directly.
<pre>
def self.import(row, assignment_id, options)
unless Assignment.find_by(id: assignment_id)
raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
end
@assignment_team = prototype
Team.import(row, assignment_id, options, @assignment_team)
end
</pre>
Based on the above code, the test case can be created:
*when there is no assignment with this assignment id
<pre>
context "when there is no assignment with this assignment id" do
it "raises an ImportError" do
allow(Assignment).to receive(:find_by).with(id: 1).and_return(nil)
expect { AssignmentTeam.import([], 1, has_column_names: 'false') }
.to raise_error(ImportError, "The assignment with the id \"1\" was not found. <a href='/assignment/new'>Create</a> this assignment?")
end
end
</pre>
*when there exists an assignment with this assignment id
<pre>
context "when there exists an assignment with this assignment id" do
it "imports a csv file to form assignment teams" do
allow(Assignment).to receive(:find_by).with(id: 2).and_return(double("Assignment", id: 2))
allow(AssignmentTeam).to receive(:prototype).and_return(assignment_team)
allow(Team).to receive(:import).with([], 2, {}, assignment_team).and_return(true)
expect(AssignmentTeam.import([], 2, {})).to eq(true)
end
end
</pre>
===Copy the current Assignment team to the CourseTeam===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def copy(course_id)
new_team = CourseTeam.create_team_and_node(course_id)
new_team.name = name
new_team.save
copy_members(new_team)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#copy" do
it "copies the current assignment team and team members to a new course team" do
allow(CourseTeam).to receive(:create_team_and_node).with(1).and_return(courseTeam)
allow(Team).to receive(:copy_members).with(courseTeam).and_return([])
expect(assignment_team.copy(1)).to eq([])
end
end
</pre>
===return a hash of scores that the team has received for the questions===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def scores(questions)
scores = {}
scores[:team] = self # This doesn't appear to be used anywhere
assignment.questionnaires.each do |questionnaire|
scores[questionnaire.symbol] = {}
scores[questionnaire.symbol][:assessments] = ReviewResponseMap.where(reviewee_id: self.id)
scores[questionnaire.symbol][:scores] = Answer.compute_scores(scores[questionnaire.symbol][:assessments], questions[questionnaire.symbol])
end
scores[:total_score] = assignment.compute_total_score(scores)
scores
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#scores" do
it "returns a hash of scores that current assignment team has received for the questions" do
allow(assignment_team).to receive(:assignment).and_return(assignment)
allow(ReviewResponseMap).to receive(:where).with(reviewee_id: 2).and_return(review_response_map)
allow(Answer).to receive(:compute_scores).with(review_response_map, questions[QuizQuestionnaire]).and_return(10)
allow(assignment).to receive(:compute_total_score).and_return(10)
# expect(assignment_team.scores(questions)[:QuizQuestionnaire]).equal?({assessments: review_response_map, scores: 10}).to be true
expect(assignment_team.scores(questions)[:team]).to eq(assignment_team)
expect(assignment_team.scores(questions)[:total_score]).to eq(10)
end
end
</pre>
===Return whether assignment team exist corresponding response maps===
The assignment_team.rb offers a method that could judge whether there exist corresponding response maps.
<pre>
def received_any_peer_review?
ResponseMap.where(reviewee_id: self.id, reviewed_object_id: self.parent_id).any?
end
</pre>
Based on the above code, the test case can be created:
*when there exist corresponding response map
<pre>
it "returns true" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([double(:ResponseMap)])
expect(assignment_team1.received_any_peer_review?).to be true
end
</pre>
*when there does not exist corresponding response maps
<pre>
it "returns false" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([])
expect(assignment_team1.received_any_peer_review?).to be false
end
</pre>
===Set the directory num for this team===
The assignment_team.rb offers a method that could Set the directory num for this team.
<pre>
def set_student_directory_num
return if self.directory_num and self.directory_num >= 0
max_num = AssignmentTeam.where(parent_id: self.parent_id).order('directory_num desc').first.directory_num
dir_num = max_num ? max_num + 1 : 0
self.update_attributes(directory_num: dir_num)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#set_student_directory_num" do
context "when there is no directory number for the assignment team" do
it "sets a directory number for the assignment team" do
# allow(assignment_team1).to receive(:try).with(:directory).and_return(-1)
allow(AssignmentTeam).to receive_message_chain(:where, :order, :first, :directory_num).and_return(4)
expect(assignment_team2.set_student_directory_num).to eq(true)
end
end
end
</pre>

This test can successfully test whether the team has submitted files/hyperlinks or not, because it creates a mock function, for the submitted_files function to receive a parameter - so that the team has hypothetically passed in a submitted file. The returning value being true shows that the has_submissions? test succeeded when the team receives a submitted file.

Similarly, we created a mock function for the team to receive a hyperlink using submitted_hyperlink. This second test case returning true shows the hyperlink being submitted is also detected by the function.

When there's no mock happening inside the function, no file or hyperlink will be passed into the team. So has_submissions? returns false is what's being expected.

=='''Result'''==
Our test cases has coverage: 100%

There are in total 127 relevant lines, and all of them get passed.

=='''Conclusion'''==
The testing framework in the assignment_team_spec.rb used unit tests to test the functionality of each action in the class. The mock instances are created at the beginning of the file, so that during each test they don't need to be constructed again. In order to test each unit case without depending on other functionalities, the mocked actions, as well as the desired returns are built inside different test cases, depending on the need of the case.

In building the test framework, the key is to understand the input, output and the desired action of each functionality that we want to test. The Rspec test format also has a steep learning curve, but the test shows stable and robust result on the assignment_team.rb.

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T03:02:02Z

Jli94: /* Project Description */

For this progect, the goal is to wirte up unit tests for assignment_team.rb

=='''Introduction'''==
Assignment_team.rb in Expertiza provides a method for student to assign a team and finish one assignment. Features come at the cost of complexity; this project is focused on creating the test methods to ensure that user interaction with the assignment interface remains stable and reliable.

=='''Project Description'''==
There are some examples for how this project create test methods for assignment_team.rb

===Create team===
In assignment_team.rb,there is a method return the team given the participant.
<pre>
def self.team(participant)
return nil if participant.nil?
team = nil
teams_users = TeamsUser.where(user_id: participant.user_id)
return nil unless teams_users
teams_users.each do |teams_user|
team = Team.find(teams_user.team_id)
return team if team.parent_id == participant.parent_id
end
nil
end
</pre>
Based on the above method, the test case can be created, and there are three different possible results could be generated.
*when the participant is nil
<pre>
it "returns nil" do
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when there are not team users records
<pre>
it "returns nil" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return(nil)
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when the participant is not nil and there exist team users records
<pre>
it "returns the team given the participant" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return([team_user])
allow(Team).to receive(:find).with(1).and_return(team)
expect(AssignmentTeam.team(participant1)).to eq(team)
end
</pre>

===Remove team by id===
The assignment_team.rb also provide a method which could remove team by id.
<pre>
def self.remove_team_by_id(id)
old_team = AssignmentTeam.find(id)
old_team.destroy unless old_team.nil?
end
</pre>
Based on the above code, the test case can be created:
<pre>
it "deletes a team given the team id" do
old_team = assignment_team1
allow(AssignmentTeam).to receive(:find).with(1).and_return(old_team)
allow(old_team).to receive(:destroy).and_return(old_team)
expect(AssignmentTeam.remove_team_by_id(1)).to eq(old_team)
end
</pre>

===Return the topic chosen by the team===
The assignment_team.rb offers a method that could return the topic chosen by the team.

<pre>
def topic
SignedUpTeam.find_by(team_id: self.id, is_waitlisted: 0).try(:topic_id)
end
</pre>

Based on the above code, the test case can be created:
<pre>
describe "#topic" do
it "returns the topic id chosen by this team" do
allow(SignedUpTeam).to receive(:find_by).with(team_id:1, is_waitlisted: 0).and_return(signed_up_team1)
expect(assignment_team1.topic).to eq(1)
end
end
</pre>

This test examines the original codes ability to generate the topic that is chosen by the team because it first goes to the mocked instances to look for a team. In this case, to match the mock instance that has created, we look for the team that has team_id as 1, and not being waitlisted. The topic id is set to be 1 in the mock. This function returns 1, because it does return the topic id, for the team that has signed up for a topic.

===Return whether the team has submission===
The assignment_team.rb offers a method that could return either true or false, in terms of whether the team has submitted work or not
<pre>
def has_submissions?
self.submitted_files.any? or self.submitted_hyperlinks.present?
end
</pre>

Based on the above code, the test case can be created, and there are three possible results:
*when current assignment team submitted files
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_files).and_return([double(:File)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit files but submitted hyperlinks
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_hyperlinks).and_return([double(:Hyperlink)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit either files or hyperlinks
<pre>
it "returns false" do
expect(assignment_team1.has_submissions? ).to be false
end
</pre>
===Return participants of a team===
The assignment_team.rb offers a method that could return the participants of a team.
<pre>
def participants
users = self.users
participants = []
users.each do |user|
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: self.parent_id)
participants << participant unless participant.nil?
end
participants
end
alias get_participants participants
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#participants" do
it "returns participants of the current assignment team" do
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: 2).and_return(participant2)
expect(assignment_team.participants).to eq([participant2])
end
end
</pre>
===Return the first member of the team===
The assignment_team.rb offers a method that could return the first member of the team.
<pre>
def self.get_first_member(team_id)
find_by(id: team_id).try(:participants).try(:first)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe ".get_first_member" do
it "returns the first participant of current assignment team" do
allow(AssignmentTeam).to receive_message_chain(:find_by, :try, :try).with(id: 1).with(:participants).with(:first).and_return(participant1)
expect(AssignmentTeam.get_first_member(1)).to eq(participant1)
end
end
</pre>
===Import csv file to form teams directly===
The assignment_team.rb offers a method that could import csv file to form teams directly.
<pre>
def self.import(row, assignment_id, options)
unless Assignment.find_by(id: assignment_id)
raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
end
@assignment_team = prototype
Team.import(row, assignment_id, options, @assignment_team)
end
</pre>
*when there is no assignment with this assignment id
<pre>
context "when there is no assignment with this assignment id" do
it "raises an ImportError" do
allow(Assignment).to receive(:find_by).with(id: 1).and_return(nil)
expect { AssignmentTeam.import([], 1, has_column_names: 'false') }
.to raise_error(ImportError, "The assignment with the id \"1\" was not found. <a href='/assignment/new'>Create</a> this assignment?")
end
end
</pre>
*when there exists an assignment with this assignment id
<pre>
context "when there exists an assignment with this assignment id" do
it "imports a csv file to form assignment teams" do
allow(Assignment).to receive(:find_by).with(id: 2).and_return(double("Assignment", id: 2))
allow(AssignmentTeam).to receive(:prototype).and_return(assignment_team)
allow(Team).to receive(:import).with([], 2, {}, assignment_team).and_return(true)
expect(AssignmentTeam.import([], 2, {})).to eq(true)
end
end
</pre>
===Copy the current Assignment team to the CourseTeam===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def copy(course_id)
new_team = CourseTeam.create_team_and_node(course_id)
new_team.name = name
new_team.save
copy_members(new_team)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#copy" do
it "copies the current assignment team and team members to a new course team" do
allow(CourseTeam).to receive(:create_team_and_node).with(1).and_return(courseTeam)
allow(Team).to receive(:copy_members).with(courseTeam).and_return([])
expect(assignment_team.copy(1)).to eq([])
end
end
</pre>
===return a hash of scores that the team has received for the questions===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def scores(questions)
scores = {}
scores[:team] = self # This doesn't appear to be used anywhere
assignment.questionnaires.each do |questionnaire|
scores[questionnaire.symbol] = {}
scores[questionnaire.symbol][:assessments] = ReviewResponseMap.where(reviewee_id: self.id)
scores[questionnaire.symbol][:scores] = Answer.compute_scores(scores[questionnaire.symbol][:assessments], questions[questionnaire.symbol])
end
scores[:total_score] = assignment.compute_total_score(scores)
scores
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#scores" do
it "returns a hash of scores that current assignment team has received for the questions" do
allow(assignment_team).to receive(:assignment).and_return(assignment)
allow(ReviewResponseMap).to receive(:where).with(reviewee_id: 2).and_return(review_response_map)
allow(Answer).to receive(:compute_scores).with(review_response_map, questions[QuizQuestionnaire]).and_return(10)
allow(assignment).to receive(:compute_total_score).and_return(10)
# expect(assignment_team.scores(questions)[:QuizQuestionnaire]).equal?({assessments: review_response_map, scores: 10}).to be true
expect(assignment_team.scores(questions)[:team]).to eq(assignment_team)
expect(assignment_team.scores(questions)[:total_score]).to eq(10)
end
end
</pre>
===Return whether assignment team exist corresponding response maps===
The assignment_team.rb offers a method that could judge whether there exist corresponding response maps.
<pre>
def received_any_peer_review?
ResponseMap.where(reviewee_id: self.id, reviewed_object_id: self.parent_id).any?
end
</pre>
*when there exist corresponding response map
<pre>
it "returns true" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([double(:ResponseMap)])
expect(assignment_team1.received_any_peer_review?).to be true
end
</pre>
*when there does not exist corresponding response maps
<pre>
it "returns false" do
allow(ResponseMap).to receive(:where).with(reviewee_id: 1, reviewed_object_id: 1).and_return([])
expect(assignment_team1.received_any_peer_review?).to be false
end
</pre>
===Set the directory num for this team===
The assignment_team.rb offers a method that could Set the directory num for this team.
<pre>
def set_student_directory_num
return if self.directory_num and self.directory_num >= 0
max_num = AssignmentTeam.where(parent_id: self.parent_id).order('directory_num desc').first.directory_num
dir_num = max_num ? max_num + 1 : 0
self.update_attributes(directory_num: dir_num)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#set_student_directory_num" do
context "when there is no directory number for the assignment team" do
it "sets a directory number for the assignment team" do
# allow(assignment_team1).to receive(:try).with(:directory).and_return(-1)
allow(AssignmentTeam).to receive_message_chain(:where, :order, :first, :directory_num).and_return(4)
expect(assignment_team2.set_student_directory_num).to eq(true)
end
end
end
</pre>

This test can successfully test whether the team has submitted files/hyperlinks or not, because it creates a mock function, for the submitted_files function to receive a parameter - so that the team has hypothetically passed in a submitted file. The returning value being true shows that the has_submissions? test succeeded when the team receives a submitted file.

Similarly, we created a mock function for the team to receive a hyperlink using submitted_hyperlink. This second test case returning true shows the hyperlink being submitted is also detected by the function.

When there's no mock happening inside the function, no file or hyperlink will be passed into the team. So has_submissions? returns false is what's being expected.

=='''Result'''==
Our test cases has coverage: 100%

There are in total 127 relevant lines, and all of them get passed.

=='''Conclusion'''==
The testing framework in the assignment_team_spec.rb used unit tests to test the functionality of each action in the class. The mock instances are created at the beginning of the file, so that during each test they don't need to be constructed again. In order to test each unit case without depending on other functionalities, the mocked actions, as well as the desired returns are built inside different test cases, depending on the need of the case.

In building the test framework, the key is to understand the input, output and the desired action of each functionality that we want to test. The Rspec test format also has a steep learning curve, but the test shows stable and robust result on the assignment_team.rb.

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T02:54:25Z

Jli94: /* Project Description */

For this progect, the goal is to wirte up unit tests for assignment_team.rb

=='''Introduction'''==
Assignment_team.rb in Expertiza provides a method for student to assign a team and finish one assignment. Features come at the cost of complexity; this project is focused on creating the test methods to ensure that user interaction with the assignment interface remains stable and reliable.

=='''Project Description'''==
There are some examples for how this project create test methods for assignment_team.rb

===Create team===
In assignment_team.rb,there is a method return the team given the participant.
<pre>
def self.team(participant)
return nil if participant.nil?
team = nil
teams_users = TeamsUser.where(user_id: participant.user_id)
return nil unless teams_users
teams_users.each do |teams_user|
team = Team.find(teams_user.team_id)
return team if team.parent_id == participant.parent_id
end
nil
end
</pre>
Based on the above method, the test case can be created, and there are three different possible results could be generated.
*when the participant is nil
<pre>
it "returns nil" do
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when there are not team users records
<pre>
it "returns nil" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return(nil)
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when the participant is not nil and there exist team users records
<pre>
it "returns the team given the participant" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return([team_user])
allow(Team).to receive(:find).with(1).and_return(team)
expect(AssignmentTeam.team(participant1)).to eq(team)
end
</pre>

===Remove team by id===
The assignment_team.rb also provide a method which could remove team by id.
<pre>
def self.remove_team_by_id(id)
old_team = AssignmentTeam.find(id)
old_team.destroy unless old_team.nil?
end
</pre>
Based on the above code, the test case can be created:
<pre>
it "deletes a team given the team id" do
old_team = assignment_team1
allow(AssignmentTeam).to receive(:find).with(1).and_return(old_team)
allow(old_team).to receive(:destroy).and_return(old_team)
expect(AssignmentTeam.remove_team_by_id(1)).to eq(old_team)
end
</pre>

===Return the topic chosen by the team===
The assignment_team.rb offers a method that could return the topic chosen by the team.

<pre>
def topic
SignedUpTeam.find_by(team_id: self.id, is_waitlisted: 0).try(:topic_id)
end
</pre>

Based on the above code, the test case can be created:
<pre>
describe "#topic" do
it "returns the topic id chosen by this team" do
allow(SignedUpTeam).to receive(:find_by).with(team_id:1, is_waitlisted: 0).and_return(signed_up_team1)
expect(assignment_team1.topic).to eq(1)
end
end
</pre>

This test examines the original codes ability to generate the topic that is chosen by the team because it first goes to the mocked instances to look for a team. In this case, to match the mock instance that has created, we look for the team that has team_id as 1, and not being waitlisted. The topic id is set to be 1 in the mock. This function returns 1, because it does return the topic id, for the team that has signed up for a topic.

===Return whether the team has submission===
The assignment_team.rb offers a method that could return either true or false, in terms of whether the team has submitted work or not
<pre>
def has_submissions?
self.submitted_files.any? or self.submitted_hyperlinks.present?
end
</pre>

Based on the above code, the test case can be created, and there are three possible results:
*when current assignment team submitted files
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_files).and_return([double(:File)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit files but submitted hyperlinks
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_hyperlinks).and_return([double(:Hyperlink)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit either files or hyperlinks
<pre>
it "returns false" do
expect(assignment_team1.has_submissions? ).to be false
end
</pre>
===Return participants of a team===
The assignment_team.rb offers a method that could return the participants of a team.
<pre>
def participants
users = self.users
participants = []
users.each do |user|
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: self.parent_id)
participants << participant unless participant.nil?
end
participants
end
alias get_participants participants
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#participants" do
it "returns participants of the current assignment team" do
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: 2).and_return(participant2)
expect(assignment_team.participants).to eq([participant2])
end
end
</pre>
===Return the first member of the team===
The assignment_team.rb offers a method that could return the first member of the team.
<pre>
def self.get_first_member(team_id)
find_by(id: team_id).try(:participants).try(:first)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe ".get_first_member" do
it "returns the first participant of current assignment team" do
allow(AssignmentTeam).to receive_message_chain(:find_by, :try, :try).with(id: 1).with(:participants).with(:first).and_return(participant1)
expect(AssignmentTeam.get_first_member(1)).to eq(participant1)
end
end
</pre>
===Import csv file to form teams directly===
The assignment_team.rb offers a method that could import csv file to form teams directly.
<pre>
def self.import(row, assignment_id, options)
unless Assignment.find_by(id: assignment_id)
raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
end
@assignment_team = prototype
Team.import(row, assignment_id, options, @assignment_team)
end
</pre>
*when there is no assignment with this assignment id
<pre>
context "when there is no assignment with this assignment id" do
it "raises an ImportError" do
allow(Assignment).to receive(:find_by).with(id: 1).and_return(nil)
expect { AssignmentTeam.import([], 1, has_column_names: 'false') }
.to raise_error(ImportError, "The assignment with the id \"1\" was not found. <a href='/assignment/new'>Create</a> this assignment?")
end
end
</pre>
*when there exists an assignment with this assignment id
<pre>
context "when there exists an assignment with this assignment id" do
it "imports a csv file to form assignment teams" do
allow(Assignment).to receive(:find_by).with(id: 2).and_return(double("Assignment", id: 2))
allow(AssignmentTeam).to receive(:prototype).and_return(assignment_team)
allow(Team).to receive(:import).with([], 2, {}, assignment_team).and_return(true)
expect(AssignmentTeam.import([], 2, {})).to eq(true)
end
end
</pre>
===Copy the current Assignment team to the CourseTeam===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def copy(course_id)
new_team = CourseTeam.create_team_and_node(course_id)
new_team.name = name
new_team.save
copy_members(new_team)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#copy" do
it "copies the current assignment team and team members to a new course team" do
allow(CourseTeam).to receive(:create_team_and_node).with(1).and_return(courseTeam)
allow(Team).to receive(:copy_members).with(courseTeam).and_return([])
expect(assignment_team.copy(1)).to eq([])
end
end
</pre>
===return a hash of scores that the team has received for the questions====
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def scores(questions)
scores = {}
scores[:team] = self # This doesn't appear to be used anywhere
assignment.questionnaires.each do |questionnaire|
scores[questionnaire.symbol] = {}
scores[questionnaire.symbol][:assessments] = ReviewResponseMap.where(reviewee_id: self.id)
scores[questionnaire.symbol][:scores] = Answer.compute_scores(scores[questionnaire.symbol][:assessments], questions[questionnaire.symbol])
end
scores[:total_score] = assignment.compute_total_score(scores)
scores
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#scores" do
it "returns a hash of scores that current assignment team has received for the questions" do
allow(assignment_team).to receive(:assignment).and_return(assignment)
allow(ReviewResponseMap).to receive(:where).with(reviewee_id: 2).and_return(review_response_map)
allow(Answer).to receive(:compute_scores).with(review_response_map, questions[QuizQuestionnaire]).and_return(10)
allow(assignment).to receive(:compute_total_score).and_return(10)
# expect(assignment_team.scores(questions)[:QuizQuestionnaire]).equal?({assessments: review_response_map, scores: 10}).to be true
expect(assignment_team.scores(questions)[:team]).to eq(assignment_team)
expect(assignment_team.scores(questions)[:total_score]).to eq(10)
end
end
</pre>

This test can successfully test whether the team has submitted files/hyperlinks or not, because it creates a mock function, for the submitted_files function to receive a parameter - so that the team has hypothetically passed in a submitted file. The returning value being true shows that the has_submissions? test succeeded when the team receives a submitted file.

Similarly, we created a mock function for the team to receive a hyperlink using submitted_hyperlink. This second test case returning true shows the hyperlink being submitted is also detected by the function.

When there's no mock happening inside the function, no file or hyperlink will be passed into the team. So has_submissions? returns false is what's being expected.

=='''Result'''==
Our test cases has coverage: 100%

There are in total 127 relevant lines, and all of them get passed.

=='''Conclusion'''==
The testing framework in the assignment_team_spec.rb used unit tests to test the functionality of each action in the class. The mock instances are created at the beginning of the file, so that during each test they don't need to be constructed again. In order to test each unit case without depending on other functionalities, the mocked actions, as well as the desired returns are built inside different test cases, depending on the need of the case.

In building the test framework, the key is to understand the input, output and the desired action of each functionality that we want to test. The Rspec test format also has a steep learning curve, but the test shows stable and robust result on the assignment_team.rb.

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T02:53:03Z

Jli94: /* Project Description */

For this progect, the goal is to wirte up unit tests for assignment_team.rb

=='''Introduction'''==
Assignment_team.rb in Expertiza provides a method for student to assign a team and finish one assignment. Features come at the cost of complexity; this project is focused on creating the test methods to ensure that user interaction with the assignment interface remains stable and reliable.

=='''Project Description'''==
There are some examples for how this project create test methods for assignment_team.rb

===Create team===
In assignment_team.rb,there is a method return the team given the participant.
<pre>
def self.team(participant)
return nil if participant.nil?
team = nil
teams_users = TeamsUser.where(user_id: participant.user_id)
return nil unless teams_users
teams_users.each do |teams_user|
team = Team.find(teams_user.team_id)
return team if team.parent_id == participant.parent_id
end
nil
end
</pre>
Based on the above method, the test case can be created, and there are three different possible results could be generated.
*when the participant is nil
<pre>
it "returns nil" do
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when there are not team users records
<pre>
it "returns nil" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return(nil)
expect(AssignmentTeam.team(participant1)).to eq(nil)
end
</pre>
*when the participant is not nil and there exist team users records
<pre>
it "returns the team given the participant" do
allow(TeamsUser).to receive(:where).with(user_id: 1).and_return([team_user])
allow(Team).to receive(:find).with(1).and_return(team)
expect(AssignmentTeam.team(participant1)).to eq(team)
end
</pre>

===Remove team by id===
The assignment_team.rb also provide a method which could remove team by id.
<pre>
def self.remove_team_by_id(id)
old_team = AssignmentTeam.find(id)
old_team.destroy unless old_team.nil?
end
</pre>
Based on the above code, the test case can be created:
<pre>
it "deletes a team given the team id" do
old_team = assignment_team1
allow(AssignmentTeam).to receive(:find).with(1).and_return(old_team)
allow(old_team).to receive(:destroy).and_return(old_team)
expect(AssignmentTeam.remove_team_by_id(1)).to eq(old_team)
end
</pre>

===Return the topic chosen by the team===
The assignment_team.rb offers a method that could return the topic chosen by the team.

<pre>
def topic
SignedUpTeam.find_by(team_id: self.id, is_waitlisted: 0).try(:topic_id)
end
</pre>

Based on the above code, the test case can be created:
<pre>
describe "#topic" do
it "returns the topic id chosen by this team" do
allow(SignedUpTeam).to receive(:find_by).with(team_id:1, is_waitlisted: 0).and_return(signed_up_team1)
expect(assignment_team1.topic).to eq(1)
end
end
</pre>

This test examines the original codes ability to generate the topic that is chosen by the team because it first goes to the mocked instances to look for a team. In this case, to match the mock instance that has created, we look for the team that has team_id as 1, and not being waitlisted. The topic id is set to be 1 in the mock. This function returns 1, because it does return the topic id, for the team that has signed up for a topic.

===Return whether the team has submission===
The assignment_team.rb offers a method that could return either true or false, in terms of whether the team has submitted work or not
<pre>
def has_submissions?
self.submitted_files.any? or self.submitted_hyperlinks.present?
end
</pre>

Based on the above code, the test case can be created, and there are three possible results:
*when current assignment team submitted files
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_files).and_return([double(:File)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit files but submitted hyperlinks
<pre>
it "returns true" do
allow(assignment_team1).to receive(:submitted_hyperlinks).and_return([double(:Hyperlink)])
expect(assignment_team1.has_submissions? ).to be true
end
</pre>
*when current assignment team did not submit either files or hyperlinks
<pre>
it "returns false" do
expect(assignment_team1.has_submissions? ).to be false
end
</pre>
===Return participants of a team===
The assignment_team.rb offers a method that could return the participants of a team.
<pre>
def participants
users = self.users
participants = []
users.each do |user|
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: self.parent_id)
participants << participant unless participant.nil?
end
participants
end
alias get_participants participants
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#participants" do
it "returns participants of the current assignment team" do
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: 2).and_return(participant2)
expect(assignment_team.participants).to eq([participant2])
end
end
</pre>
===Return the first member of the team===
The assignment_team.rb offers a method that could return the first member of the team.
<pre>
def self.get_first_member(team_id)
find_by(id: team_id).try(:participants).try(:first)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe ".get_first_member" do
it "returns the first participant of current assignment team" do
allow(AssignmentTeam).to receive_message_chain(:find_by, :try, :try).with(id: 1).with(:participants).with(:first).and_return(participant1)
expect(AssignmentTeam.get_first_member(1)).to eq(participant1)
end
end
</pre>
===Import csv file to form teams directly===
The assignment_team.rb offers a method that could import csv file to form teams directly.
<pre>
def self.import(row, assignment_id, options)
unless Assignment.find_by(id: assignment_id)
raise ImportError, "The assignment with the id \"" + assignment_id.to_s + "\" was not found. <a href='/assignment/new'>Create</a> this assignment?"
end
@assignment_team = prototype
Team.import(row, assignment_id, options, @assignment_team)
end
</pre>
*when there is no assignment with this assignment id
<pre>
context "when there is no assignment with this assignment id" do
it "raises an ImportError" do
allow(Assignment).to receive(:find_by).with(id: 1).and_return(nil)
expect { AssignmentTeam.import([], 1, has_column_names: 'false') }
.to raise_error(ImportError, "The assignment with the id \"1\" was not found. <a href='/assignment/new'>Create</a> this assignment?")
end
end
</pre>
*when there exists an assignment with this assignment id
<pre>
context "when there exists an assignment with this assignment id" do
it "imports a csv file to form assignment teams" do
allow(Assignment).to receive(:find_by).with(id: 2).and_return(double("Assignment", id: 2))
allow(AssignmentTeam).to receive(:prototype).and_return(assignment_team)
allow(Team).to receive(:import).with([], 2, {}, assignment_team).and_return(true)
expect(AssignmentTeam.import([], 2, {})).to eq(true)
end
end
</pre>
===Copy the current Assignment team to the CourseTeam===
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.
<pre>
def copy(course_id)
new_team = CourseTeam.create_team_and_node(course_id)
new_team.name = name
new_team.save
copy_members(new_team)
end
</pre>
Based on the above code, the test case can be created:
<pre>
describe "#copy" do
it "copies the current assignment team and team members to a new course team" do
allow(CourseTeam).to receive(:create_team_and_node).with(1).and_return(courseTeam)
allow(Team).to receive(:copy_members).with(courseTeam).and_return([])
expect(assignment_team.copy(1)).to eq([])
end
end
</pre>
===return a hash of scores that the team has received for the questions====
The assignment_team.rb offers a method that could copy the current Assignment team to the CourseTeam.

This test can successfully test whether the team has submitted files/hyperlinks or not, because it creates a mock function, for the submitted_files function to receive a parameter - so that the team has hypothetically passed in a submitted file. The returning value being true shows that the has_submissions? test succeeded when the team receives a submitted file.

Similarly, we created a mock function for the team to receive a hyperlink using submitted_hyperlink. This second test case returning true shows the hyperlink being submitted is also detected by the function.

When there's no mock happening inside the function, no file or hyperlink will be passed into the team. So has_submissions? returns false is what's being expected.

=='''Result'''==
Our test cases has coverage: 100%

There are in total 127 relevant lines, and all of them get passed.

=='''Conclusion'''==
The testing framework in the assignment_team_spec.rb used unit tests to test the functionality of each action in the class. The mock instances are created at the beginning of the file, so that during each test they don't need to be constructed again. In order to test each unit case without depending on other functionalities, the mocked actions, as well as the desired returns are built inside different test cases, depending on the need of the case.

In building the test framework, the key is to understand the input, output and the desired action of each functionality that we want to test. The Rspec test format also has a steep learning curve, but the test shows stable and robust result on the assignment_team.rb.

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T02:31:55Z

Jli94: /* Return participants of a team */

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-03T02:31:16Z

Jli94: /* Return participants of a team */

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-02T20:02:33Z

Jli94: /* Project Description */

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-02T20:01:36Z

Jli94: /* Return participants of a team */

CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb

2018-11-02T20:01:10Z

Jli94: /* Project Description */