Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2169. Testing - Answer Tagging

2021-12-08T19:37:10Z

Snparab: /* Video Link */

__TOC__

== Background ==
Answer tagging (see [https://github.com/expertiza/expertiza/blob/25713567e5e5e1c0b363409715e6d8797b45b01a/app/models/answer_tag.rb answer_tab.rb] and [[Answer_tags|wiki]]) helps determine a few metrics on a student’s responses to a questionnaire. Students can tag these metrics for other students for things such as “Positive Tone” or “Suggest Solutions”.

These specs below all need to be further developed to cover missing methods/lines. Some structures currently exist at the top of spec files (such as assignments, participants, etc) to help make writing tests easier. Please feel free to add to these and write extra tests to cover any edge cases you may think of.

As an instructor on an assignment, going to Etc/View Reports/Answer Tagging Report will show student answer tagging. You will be able to see the percentage of answers tagged, # of answers tagged, # not tagged, and # of taggable answers for each student on a questionnaire.

[[File:Tagging_report.png|thumb|center|Fig. 1]]

== Project Purpose==
The objective of the project is unit testing of functionality in these two ruby files and increasing the coverage.

[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec]

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec]

== Initial Coverage ==
[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec] : 0% Covered

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec] : 18% Covered

=== Missed Methods ===

These methods had no tests before our project was done.

* <code>app/controllers/answer_tags_controller.rb</code>
** <code>action_allowed?</code>
** <code>index</code>
** <code>create_edit</code>
** <code>destroy</code>

* <code>app/models/tag_prompt_deployment.rb</code>
** <code>get_number_of_taggable_answers</code>
** <code>assignment_tagging_progress</code>

== Project Design ==
In this project, we have two controllers to be tested using Rspec Unit testing.

The ER diagram of the parent tables is given below for reference ([https://expertiza.csc.ncsu.edu/index.php/Answer_tags Source: Answer_tags]).

[[File:answer_tags_imported.png]]

The flow diagrams below show how controllers in this project are connected with interrelated classes, methods, and views.

[[File:E2169 answer tags controller.png|900px]]

[[File:E2169 tag prompt deployment.png|900px]]

== Testing Plan ==
=== Controller: answer_tags_controller.rb ===

Existing coverage = 0%

Description:
The purpose of this controller is to track down the total number of tags done by the students. The output of the controller is the list of answer tags in JSON format. The database structure for the answer_tags can be found here [https://expertiza.csc.ncsu.edu/index.php/Answer_tags]

'''Methods'''

1. action_allowed? ( params: action )

Description: To allow the functionality only if the accessing user is having student privileges (current_user_has_student_privileges?)

<code>Use cases:</code>
* <code>When the session is of student type, access should be allowed and index operation should be executed.</code>
* <code>When the session is of student type, access should be allowed and create_edit operation should be executed.</code>

<code>Edge cases:</code>
* <code>When the session is null, Access should be denied for index</code>
* <code>When the session is null, Access should be denied for create_edit</code>

2. index ( params : assignment_id, questionnaire_id, user_id )

Description: Populates the tags by fetching the records from AnswerTag corresponding to each TagPromptDeployment based on the filers provided as params.

<code>Use cases:</code>
* <code> When all valid params are passed, the function should populate the answer tags.</code>
* <code> When user_id is provided, answer tags specific to that user should only be populated.</code>
* <code> When questionnaire_id is provided, answer tags specific to that questionnaire should only be populated.</code>
* <code> When assignment_id is provided, answer tags specific to that assignment should only be populated.</code>
* <code> When only one parameter is passed, the corresponding answer tags should be populated.</code>

<code>Edge test cases:</code>
* <code> When user_id is nil, 0 tags prompts should be returned.</code>
* <code> When questionnaire_id is nil, 0 tags prompts should be returned.</code>
* <code> When assignment_id is nil, 0 tags prompts should be returned.</code>

3. create_edit ( params : answer_id, tag_prompt_deployment_id, value )

Description: Fetches the answer tag with the params provided and then updates the respective tag values by the updated values provided as params.

<code>Use cases:</code>
* <code> When the existing tag is found based on the params passed, the existing tag should be updated with new values.</code>

<code>Edge cases:</code>
* <code> Restricts updating answer tag by the student if no mapping is found related to any answer for that tag (foreign key constraint).</code>
* <code> Restricts updating answer tag by the student if no mapping is found related to any tag_prompt_deployment for that tag (foreign key constraint).</code>
* <code> Restricts updating answer tag by student if no updated value is provided for the answer tag.</code>

=== Controller: tag_prompt_deployment.rb ===

Existing coverage = 18%

Description:
This Controller is when a user (with instructor privilege) wants to see tagging summary of every user that participated in a tagging assignment.

'''Methods'''

1. tag_prompt
Description: tag_prompt has existing test cases scoring 18 percentage coverage. Additional testing is not required.

2. get_number_of_taggable_answers ( params: user_id)

Description: To calculate total taggable answers reviewed by a user that participated in the given tagging assignment. user_id is the parameter passed to this method. An individual and his team will have the same score. Fig 1: The last column values are processed by this method.

<code>Use cases:</code>
* <code>when user_id is nil expect an error</code>
* <code>when a team has given any response then count of taggable answer > 0</code>
* <code>When a question or a response does not exists then count of taggable answer = 0 (extreme case) </code>
* <code>When answer_length_threshold not set, count taggable answer</code>
* <code>When answer_length_threshold is set, count taggable answer</code>

<code>Edge cases:</code>
* user_id (parameter) is nil
* response is empty
* question is empty

3. assignment_tagging_progress

Description: To compute the number of tagged answers, number of untagged answers, and percentage of answers tagged by the users that participated in the tagging Assignment to a particular question.
Fig 1: First three columns after the 2nd column onwards are updated with results obtained from this method.

<code>Use cases:</code>
* <code>When not team participated in the assignment, assert count(user_answer_tagging) =0</code>
* <code>When the question does not exist, assert count(user_answer_tagging) =0 </code>
* <code>When multiple rounds of review, render ReviewResponseMap and assert response object</code>
* <code>When single round of review, render ResponseMap and assert response object</code>
* <code>When answer_length_threshold is SET, number of answers and when answer_length_threshold is NOT SET, number of answers</code>
* <code>When route is success answer_tagging object structure matching</code>

<code>Edge cases:</code>
* There are no teams associated with the assignment.
* There are no questions in the questionnaire that have the question type specified in the TagPromptDeployment object.
* The assignment is set to vary by round.
* The assignment is set not to vary by round.
* There are multiple tags.
* There are no tags.

== Bug Fixing of Additional Issues ==

===Model: tag_prompt_deployment.rb (method: get_number_of_taggable_answers)===

An additional issue in the method get_number_of_taggable_answers. The error message is as shown below which indicates string concatenation fails between integer and string data types.

''TypeError:''
no implicit conversion of Fixnum into String at line 23 https://github.com/expertiza/expertiza/blob/beta/app/models/tag_prompt_deployment.rb.

[[File:Get_number_of_taggable_answers_bug.JPG]]

This issue is fixed by correcting the syntax of the two-strings concatenation. After fixing the code is

<code> answers = answers.where(conditions: "length(comments) < #{self.answer_length_threshold}" ) unless self.answer_length_threshold.nil? </code>

===Model: tag_prompt_deployment.rb (method: assignment_tagging_progress)===

<pre>
Failure/Error: answers = answers.where("length(comments) > ?", self.answer_length_threshold.to_s) unless self.answer_length_threshold.nil?

NoMethodError:
undefined method `where' for #<Array:0x00000003424b60>
</pre>

This issue was resolved by using <code>Arrays.select</code> to achieve the same functionality.

There was another small error in which the TeamsUser <code>user</code> was not found, and the resolution was to find the User model for each <code>TeamsUser.user_id</code>.

== Results ==
Test cases are added to cover all functionality. With the cases added the coverage has reached to 100%.

Test cases demo can be found at [https://youtu.be/Xc7SpMhwUyc OSS Final Project Testing Video]

tag_prompt_deployment.rb: Coverage = 100%

[[File:Tag_prompt_deployment_coverage.jpeg]]

answer_tags_controller.rb: Coverage = 100%

[[File:Answer_tag_controller_coverage.jpeg]]

== Collaborators ==
Nicholas Himes (Mentor)

1. Aditya Khadse

2. Alec Landow

3. Rageeni Sah

4. Sayali Parab

== Relevant Links ==
Main Expertiza repository can be found at [https://github.com/expertiza/expertiza/tree/beta GitHubExp]

Our forked repository can be found at [https://github.com/akk5597/expertiza Github]

== Video Link ==

Test case run and coverage recording [https://youtu.be/Xc7SpMhwUyc OSS Final Project Testing Video]

CSC/ECE 517 Fall 2021 - E2169. Testing - Answer Tagging

2021-12-08T19:36:57Z

Snparab: /* Results */

CSC/ECE 517 Fall 2021 - E2169. Testing - Answer Tagging

2021-12-08T19:36:36Z

Snparab: /* Video Link */

__TOC__

== Background ==
Answer tagging (see [https://github.com/expertiza/expertiza/blob/25713567e5e5e1c0b363409715e6d8797b45b01a/app/models/answer_tag.rb answer_tab.rb] and [[Answer_tags|wiki]]) helps determine a few metrics on a student’s responses to a questionnaire. Students can tag these metrics for other students for things such as “Positive Tone” or “Suggest Solutions”.

These specs below all need to be further developed to cover missing methods/lines. Some structures currently exist at the top of spec files (such as assignments, participants, etc) to help make writing tests easier. Please feel free to add to these and write extra tests to cover any edge cases you may think of.

As an instructor on an assignment, going to Etc/View Reports/Answer Tagging Report will show student answer tagging. You will be able to see the percentage of answers tagged, # of answers tagged, # not tagged, and # of taggable answers for each student on a questionnaire.

[[File:Tagging_report.png|thumb|center|Fig. 1]]

== Project Purpose==
The objective of the project is unit testing of functionality in these two ruby files and increasing the coverage.

[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec]

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec]

== Initial Coverage ==
[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec] : 0% Covered

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec] : 18% Covered

=== Missed Methods ===

These methods had no tests before our project was done.

* <code>app/controllers/answer_tags_controller.rb</code>
** <code>action_allowed?</code>
** <code>index</code>
** <code>create_edit</code>
** <code>destroy</code>

* <code>app/models/tag_prompt_deployment.rb</code>
** <code>get_number_of_taggable_answers</code>
** <code>assignment_tagging_progress</code>

== Project Design ==
In this project, we have two controllers to be tested using Rspec Unit testing.

The ER diagram of the parent tables is given below for reference ([https://expertiza.csc.ncsu.edu/index.php/Answer_tags Source: Answer_tags]).

[[File:answer_tags_imported.png]]

The flow diagrams below show how controllers in this project are connected with interrelated classes, methods, and views.

[[File:E2169 answer tags controller.png|900px]]

[[File:E2169 tag prompt deployment.png|900px]]

== Testing Plan ==
=== Controller: answer_tags_controller.rb ===

Existing coverage = 0%

Description:
The purpose of this controller is to track down the total number of tags done by the students. The output of the controller is the list of answer tags in JSON format. The database structure for the answer_tags can be found here [https://expertiza.csc.ncsu.edu/index.php/Answer_tags]

'''Methods'''

1. action_allowed? ( params: action )

Description: To allow the functionality only if the accessing user is having student privileges (current_user_has_student_privileges?)

<code>Use cases:</code>
* <code>When the session is of student type, access should be allowed and index operation should be executed.</code>
* <code>When the session is of student type, access should be allowed and create_edit operation should be executed.</code>

<code>Edge cases:</code>
* <code>When the session is null, Access should be denied for index</code>
* <code>When the session is null, Access should be denied for create_edit</code>

2. index ( params : assignment_id, questionnaire_id, user_id )

Description: Populates the tags by fetching the records from AnswerTag corresponding to each TagPromptDeployment based on the filers provided as params.

<code>Use cases:</code>
* <code> When all valid params are passed, the function should populate the answer tags.</code>
* <code> When user_id is provided, answer tags specific to that user should only be populated.</code>
* <code> When questionnaire_id is provided, answer tags specific to that questionnaire should only be populated.</code>
* <code> When assignment_id is provided, answer tags specific to that assignment should only be populated.</code>
* <code> When only one parameter is passed, the corresponding answer tags should be populated.</code>

<code>Edge test cases:</code>
* <code> When user_id is nil, 0 tags prompts should be returned.</code>
* <code> When questionnaire_id is nil, 0 tags prompts should be returned.</code>
* <code> When assignment_id is nil, 0 tags prompts should be returned.</code>

3. create_edit ( params : answer_id, tag_prompt_deployment_id, value )

Description: Fetches the answer tag with the params provided and then updates the respective tag values by the updated values provided as params.

<code>Use cases:</code>
* <code> When the existing tag is found based on the params passed, the existing tag should be updated with new values.</code>

<code>Edge cases:</code>
* <code> Restricts updating answer tag by the student if no mapping is found related to any answer for that tag (foreign key constraint).</code>
* <code> Restricts updating answer tag by the student if no mapping is found related to any tag_prompt_deployment for that tag (foreign key constraint).</code>
* <code> Restricts updating answer tag by student if no updated value is provided for the answer tag.</code>

=== Controller: tag_prompt_deployment.rb ===

Existing coverage = 18%

Description:
This Controller is when a user (with instructor privilege) wants to see tagging summary of every user that participated in a tagging assignment.

'''Methods'''

1. tag_prompt
Description: tag_prompt has existing test cases scoring 18 percentage coverage. Additional testing is not required.

2. get_number_of_taggable_answers ( params: user_id)

Description: To calculate total taggable answers reviewed by a user that participated in the given tagging assignment. user_id is the parameter passed to this method. An individual and his team will have the same score. Fig 1: The last column values are processed by this method.

<code>Use cases:</code>
* <code>when user_id is nil expect an error</code>
* <code>when a team has given any response then count of taggable answer > 0</code>
* <code>When a question or a response does not exists then count of taggable answer = 0 (extreme case) </code>
* <code>When answer_length_threshold not set, count taggable answer</code>
* <code>When answer_length_threshold is set, count taggable answer</code>

<code>Edge cases:</code>
* user_id (parameter) is nil
* response is empty
* question is empty

3. assignment_tagging_progress

Description: To compute the number of tagged answers, number of untagged answers, and percentage of answers tagged by the users that participated in the tagging Assignment to a particular question.
Fig 1: First three columns after the 2nd column onwards are updated with results obtained from this method.

<code>Use cases:</code>
* <code>When not team participated in the assignment, assert count(user_answer_tagging) =0</code>
* <code>When the question does not exist, assert count(user_answer_tagging) =0 </code>
* <code>When multiple rounds of review, render ReviewResponseMap and assert response object</code>
* <code>When single round of review, render ResponseMap and assert response object</code>
* <code>When answer_length_threshold is SET, number of answers and when answer_length_threshold is NOT SET, number of answers</code>
* <code>When route is success answer_tagging object structure matching</code>

<code>Edge cases:</code>
* There are no teams associated with the assignment.
* There are no questions in the questionnaire that have the question type specified in the TagPromptDeployment object.
* The assignment is set to vary by round.
* The assignment is set not to vary by round.
* There are multiple tags.
* There are no tags.

== Bug Fixing of Additional Issues ==

===Model: tag_prompt_deployment.rb (method: get_number_of_taggable_answers)===

An additional issue in the method get_number_of_taggable_answers. The error message is as shown below which indicates string concatenation fails between integer and string data types.

''TypeError:''
no implicit conversion of Fixnum into String at line 23 https://github.com/expertiza/expertiza/blob/beta/app/models/tag_prompt_deployment.rb.

[[File:Get_number_of_taggable_answers_bug.JPG]]

This issue is fixed by correcting the syntax of the two-strings concatenation. After fixing the code is

<code> answers = answers.where(conditions: "length(comments) < #{self.answer_length_threshold}" ) unless self.answer_length_threshold.nil? </code>

===Model: tag_prompt_deployment.rb (method: assignment_tagging_progress)===

<pre>
Failure/Error: answers = answers.where("length(comments) > ?", self.answer_length_threshold.to_s) unless self.answer_length_threshold.nil?

NoMethodError:
undefined method `where' for #<Array:0x00000003424b60>
</pre>

This issue was resolved by using <code>Arrays.select</code> to achieve the same functionality.

There was another small error in which the TeamsUser <code>user</code> was not found, and the resolution was to find the User model for each <code>TeamsUser.user_id</code>.

== Results ==
Test cases are added to cover all functionality. With the cases added the coverage has reached to 100%.

Test cases demo can be found at [https://youtu.be/WYSUmL6jcHc OSS Final Project Testing Video]

tag_prompt_deployment.rb: Coverage = 100%

[[File:Tag_prompt_deployment_coverage.jpeg]]

answer_tags_controller.rb: Coverage = 100%

[[File:Answer_tag_controller_coverage.jpeg]]

== Collaborators ==
Nicholas Himes (Mentor)

1. Aditya Khadse

2. Alec Landow

3. Rageeni Sah

4. Sayali Parab

== Relevant Links ==
Main Expertiza repository can be found at [https://github.com/expertiza/expertiza/tree/beta GitHubExp]

Our forked repository can be found at [https://github.com/akk5597/expertiza Github]

== Video Link ==

Test case run and coverage recording [https://youtu.be/Xc7SpMhwUyc]

CSC/ECE 517 Fall 2021 - E2169. Testing - Answer Tagging

2021-11-30T03:54:35Z

Snparab: /* Controller: answer_tags_controller.rb */

__TOC__

== Background ==
Answer tagging (see [https://github.com/expertiza/expertiza/blob/25713567e5e5e1c0b363409715e6d8797b45b01a/app/models/answer_tag.rb answer_tab.rb] and [[Answer_tags|wiki]]) helps determine a few metrics on a student’s responses to a questionnaire. Students can tag these metrics for other students for things such as “Positive Tone” or “Suggest Solutions”.

These specs below all need to be further developed to cover missing methods/lines. Some structures currently exist at the top of spec files (such as assignments, participants, etc) to help make writing tests easier. Please feel free to add to these and write extra tests to cover any edge cases you may think of.

As an instructor on an assignment, going to Etc/View Reports/Answer Tagging Report will show student answer tagging. You will be able to see the percentage of answers tagged, # of answers tagged, # not tagged, and # of taggable answers for each student on a questionnaire.

[[File:Tagging_report.png|thumb|center|Fig. 1]]

== Project Purpose==
The objective of the project is unit testing of functionality in these two ruby files and increasing the coverage.

[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec]

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec]

== Initial Coverage ==
[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec] : 0% Covered

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec] : 18% Covered

=== Missed Methods ===
* <code>app/controllers/answer_tags_controller.rb</code>
** <code>action_allowed?</code>
** <code>index</code>
** <code>create_edit</code>
** <code>destroy</code>

* <code>app/models/tag_prompt_deployment.rb</code>
** <code>get_number_of_taggable_answers</code>
** <code>assignment_tagging_progress</code>

== Project Design ==
In this project, we have two controllers to be tested using Rspec Unit testing.

The ER diagram of the parent tables is given below for reference ([https://expertiza.csc.ncsu.edu/index.php/Answer_tags Source: Answer_tags]).

[[File:answer_tags_imported.png]]

The flow diagrams below show how controllers in this project are connected with interrelated classes, methods, and views.

[[File:E2169 answer tags controller.png|900px]]

[[File:E2169 tag prompt deployment.png|900px]]

== Testing Plan ==
=== Controller: answer_tags_controller.rb ===

Existing coverage = 0%

Description:
The purpose of this controller is to track down the total number of tags done by the students. The database structure for the answer_tags can be found here [https://expertiza.csc.ncsu.edu/index.php/Answer_tags]

'''Methods'''

1. action_allowed? ( params: action )

Description: To allow the functionality only if the accessing user is having student privileges (current_user_has_student_privileges?)

<code>Use cases:</code>
* <code>When the session is of student type, access should be allowed and index operation should be executed.</code>
* <code>When the session is of student type, access should be allowed and create_edit operation should be executed.</code>

<code>Edge cases:</code>
* <code>When the session is null, Access should be denied for index</code>
* <code>When the session is null, Access should be denied for create_edit</code>

2. index ( params : assignment_id, questionnaire_id, user_id )

Description: Populates the tags by fetching the records from AnswerTag corresponding to each TagPromptDeployment based on the filers provided as params.

<code>Use cases:</code>
* <code> When all valid params are passed, the function should populate the answer tags.</code>
* <code> When user_id is provided, answer tags specific to that user should only be populated.</code>
* <code> When questionnaire_id is provided, answer tags specific to that questionnaire should only be populated.</code>
* <code> When assignment_id is provided, answer tags specific to that assignment should only be populated.</code>
* <code> When only one parameter is passed, the corresponding answer tags should be populated.</code>

<code>Edge test cases:</code>
* <code> When user_id is nil, 0 tags prompts should be returned.</code>
* <code> When questionnaire_id is nil, 0 tags prompts should be returned.</code>
* <code> When assignment_id is nil, 0 tags prompts should be returned.</code>

3. create_edit ( params : answer_id, tag_prompt_deployment_id, value )

Description: Fetches the answer tag with the params provided and then updates the respective tag values by the updated values provided as params.

<code>Use cases:</code>
* <code> When the existing tag is found based on the params passed, the existing tag should be updated with new values.</code>

<code>Edge cases:</code>
* <code> Restricts updating answer tag by the student if no mapping is found related to any answer for that tag (foreign key constraint).</code>
* <code> Restricts updating answer tag by the student if no mapping is found related to any tag_prompt_deployment for that tag (foreign key constraint).</code>
* <code> Restricts updating answer tag by student if no updated value is provided for the answer tag.</code>

=== Controller: tag_prompt_deployment.rb ===

Existing coverage = 18%

Description:
This Controller is when a user (with instructor privilege) wants to see tagging summary of every user that participated in a tagging assignment.

'''Methods'''

1. tag_prompt
Description: tag_prompt has existing test cases scoring 18 percentage coverage. Additional testing is not required.

2. get_number_of_taggable_answers ( params: user_id)

Description: To calculate total taggable answers reviewed by a user that participated in the given tagging assignment. user_id is the parameter passed to this method. An individual and his team will have the same score. Fig 1: The last column values are processed by this method.

<code>Use cases:</code>
* <code>when user_id is nil expect an error</code>
* <code>when a team has given any response then count of taggable answer > 0</code>
* <code>When a question or a response does not exists then count of taggable answer = 0 (extreme case) </code>
* <code>When answer_length_threshold not set, count taggable answer</code>
* <code>When answer_length_threshold is set, count taggable answer</code>

<code>Edge cases:</code>
* user_id (parameter) is nil
* response is empty
* question is empty

3. assignment_tagging_progress

Description: To compute the number of tagged answers, number of untagged answers, and percentage of answers tagged by the users that participated in the tagging Assignment to a particular question.
Fig 1: First three columns after the 2nd column onwards are updated with results obtained from this method.

<code>Use cases:</code>
* <code>When not team participated in the assignment, assert count(user_answer_tagging) =0</code>
* <code>When the question does not exist, assert count(user_answer_tagging) =0 </code>
* <code>When multiple rounds of review, render ReviewResponseMap and assert response object</code>
* <code>When single round of review, render ResponseMap and assert response object</code>
* <code>When answer_length_threshold is SET, number of answers and when answer_length_threshold is NOT SET, number of answers</code>
* <code>When route is success answer_tagging object structure matching</code>

<code>Edge cases:</code>
* There are no teams associated with the assignment.
* There are no questions in the questionnaire that have the question type specified in the TagPromptDeployment object.
* The assignment is set to vary by round.
* The assignment is set not to vary by round.
* There are multiple tags.
* There are no tags.

== Bug Fixing of Additional Issues ==

===Model: tag_prompt_deployment.rb (method: get_number_of_taggable_answers)===

An additional issue in the method get_number_of_taggable_answers. The error message is as shown below which indicates string concatenation fails between integer and string data types.

''TypeError:''
no implicit conversion of Fixnum into String at line 23 https://github.com/expertiza/expertiza/blob/beta/app/models/tag_prompt_deployment.rb.

[[File:Get_number_of_taggable_answers_bug.JPG]]

This issue is fixed by correcting the syntax of the two-strings concatenation. After fixing the code is

<code> answers = answers.where(conditions: "length(comments) < #{self.answer_length_threshold}" ) unless self.answer_length_threshold.nil? </code>

===Model: tag_prompt_deployment.rb (method: assignment_tagging_progress)===

<pre>
Failure/Error: answers = answers.where("length(comments) > ?", self.answer_length_threshold.to_s) unless self.answer_length_threshold.nil?

NoMethodError:
undefined method `where' for #<Array:0x00000003424b60>
</pre>

This issue was resolved by using <code>Arrays.select</code> to achieve the same functionality.

There was another small error in which the TeamsUser <code>user</code> was not found, and the resolution was to find the User model for each <code>TeamsUser.user_id</code>.

== Results ==
Test cases are added to cover all functionality. With the cases added the coverage has reached to 100%.

Test cases demo can be found at [https://youtu.be/WYSUmL6jcHc OSS Final Project Testing Video]

tag_prompt_deployment.rb: Coverage = 100%

[[File:Tag_prompt_deployment_coverage.jpeg]]

answer_tags_controller.rb: Coverage = 100%

[[File:Answer_tag_controller_coverage.jpeg]]

== Collaborators ==
Nicholas Himes (Mentor)

1. Aditya Khadse

2. Alec Landow

3. Rageeni Sah

4. Sayali Parab

== Relevant Links ==
Main Expertiza repository can be found at [https://github.com/expertiza/expertiza/tree/beta GitHubExp]

Our forked repository can be found at [https://github.com/akk5597/expertiza Github]

== Video Link ==

Test case run and coverage recording [https://www.youtube.com/watch?v=WYSUmL6jcHc]

CSC/ECE 517 Fall 2021 - E2169. Testing - Answer Tagging

2021-11-30T03:53:49Z

Snparab: /* Controller: answer_tags_controller.rb */

__TOC__

== Background ==
Answer tagging (see [https://github.com/expertiza/expertiza/blob/25713567e5e5e1c0b363409715e6d8797b45b01a/app/models/answer_tag.rb answer_tab.rb] and [[Answer_tags|wiki]]) helps determine a few metrics on a student’s responses to a questionnaire. Students can tag these metrics for other students for things such as “Positive Tone” or “Suggest Solutions”.

These specs below all need to be further developed to cover missing methods/lines. Some structures currently exist at the top of spec files (such as assignments, participants, etc) to help make writing tests easier. Please feel free to add to these and write extra tests to cover any edge cases you may think of.

As an instructor on an assignment, going to Etc/View Reports/Answer Tagging Report will show student answer tagging. You will be able to see the percentage of answers tagged, # of answers tagged, # not tagged, and # of taggable answers for each student on a questionnaire.

[[File:Tagging_report.png|thumb|center|Fig. 1]]

== Project Purpose==
The objective of the project is unit testing of functionality in these two ruby files and increasing the coverage.

[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec]

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec]

== Initial Coverage ==
[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec] : 0% Covered

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec] : 18% Covered

=== Missed Methods ===
* <code>app/controllers/answer_tags_controller.rb</code>
** <code>action_allowed?</code>
** <code>index</code>
** <code>create_edit</code>
** <code>destroy</code>

* <code>app/models/tag_prompt_deployment.rb</code>
** <code>get_number_of_taggable_answers</code>
** <code>assignment_tagging_progress</code>

== Project Design ==
In this project, we have two controllers to be tested using Rspec Unit testing.

The ER diagram of the parent tables is given below for reference ([https://expertiza.csc.ncsu.edu/index.php/Answer_tags Source: Answer_tags]).

[[File:answer_tags_imported.png]]

The flow diagrams below show how controllers in this project are connected with interrelated classes, methods, and views.

[[File:E2169 answer tags controller.png|900px]]

[[File:E2169 tag prompt deployment.png|900px]]

== Testing Plan ==
=== Controller: answer_tags_controller.rb ===

Existing coverage = 0%

Description:
The purpose of this controller is to track down the total number of tags done by the students. The database structure for the answer_tags can be found here [https://expertiza.csc.ncsu.edu/index.php/Answer_tags]

'''Methods'''

1. action_allowed? ( params: action )

Description: To allow the functionality only if the accessing user is having student privileges (current_user_has_student_privileges?)

<code>Use cases:</code>
* <code>When the session is of student type, access should be allowed and index operation should be executed.</code>
* <code>When the session is of student type, access should be allowed and create_edit operation should be executed.</code>

<code>Edge cases:</code>
* <code>When the session is null, Access should be denied for index</code>
* <code>When the session is null, Access should be denied for create_edit</code>

2. index ( params : assignment_id, questionnaire_id, user_id )

Description: Populates the tags by fetching the records from AnswerTag corresponding to each TagPromptDeployment based on the filers provided as params.

<code>Use cases:</code>
* <code> When all valid params are passed, the function should populate the answer tags.</code>
* <code> When user_id is provided, answer tags specific to that user should only be populated.</code>
* <code> When questionnaire_id is provided, answer tags specific to that questionnaire should only be populated.</code>
* <code> When assignment_id is provided, answer tags specific to that assignment should only be populated.</code>
* <code> When only one parameter is passed, the corresponding answer tags should be populated.</code>

<code>Edge test cases:</code>
* <code> When user_id is nil, 0 tags prompts should be returned.</code>
* <code> When questionnaire_id is nil, 0 tags prompts should be returned.</code>
* <code> When assignment_id is nil, 0 tags prompts should be returned.</code>

3. create_edit ( params : answer_id, tag_prompt_deployment_id, value )

Description: Fetches the answer tag with the params provided and then updates the respective tag values by the updated values provided as params.

<code>Use cases:</code>
* <code> When the existing tag is found based on the params passed, the existing tag should be updated with new values.</code>

<code>Edge cases:</code>
* <code> Restricts updating answer tag by the student if no mapping is found related to any answer for that tag (foreign key constraint).</code>
* <code> Restricts updating answer tag by the student if no mapping is found related to any tag_prompt_deployment for that tag (foreign key constraint).</code>
* <code> Restricts updating answer tag by student if no updated value is provided for the answer tag.</code>

=== Controller: tag_prompt_deployment.rb ===

Existing coverage = 18%

Description:
This Controller is when a user (with instructor privilege) wants to see tagging summary of every user that participated in a tagging assignment.

'''Methods'''

1. tag_prompt
Description: tag_prompt has existing test cases scoring 18 percentage coverage. Additional testing is not required.

2. get_number_of_taggable_answers ( params: user_id)

Description: To calculate total taggable answers reviewed by a user that participated in the given tagging assignment. user_id is the parameter passed to this method. An individual and his team will have the same score. Fig 1: The last column values are processed by this method.

<code>Use cases:</code>
* <code>when user_id is nil expect an error</code>
* <code>when a team has given any response then count of taggable answer > 0</code>
* <code>When a question or a response does not exists then count of taggable answer = 0 (extreme case) </code>
* <code>When answer_length_threshold not set, count taggable answer</code>
* <code>When answer_length_threshold is set, count taggable answer</code>

<code>Edge cases:</code>
* user_id (parameter) is nil
* response is empty
* question is empty

3. assignment_tagging_progress

Description: To compute the number of tagged answers, number of untagged answers, and percentage of answers tagged by the users that participated in the tagging Assignment to a particular question.
Fig 1: First three columns after the 2nd column onwards are updated with results obtained from this method.

<code>Use cases:</code>
* <code>When not team participated in the assignment, assert count(user_answer_tagging) =0</code>
* <code>When the question does not exist, assert count(user_answer_tagging) =0 </code>
* <code>When multiple rounds of review, render ReviewResponseMap and assert response object</code>
* <code>When single round of review, render ResponseMap and assert response object</code>
* <code>When answer_length_threshold is SET, number of answers and when answer_length_threshold is NOT SET, number of answers</code>
* <code>When route is success answer_tagging object structure matching</code>

<code>Edge cases:</code>
* There are no teams associated with the assignment.
* There are no questions in the questionnaire that have the question type specified in the TagPromptDeployment object.
* The assignment is set to vary by round.
* The assignment is set not to vary by round.
* There are multiple tags.
* There are no tags.

== Bug Fixing of Additional Issues ==

===Model: tag_prompt_deployment.rb (method: get_number_of_taggable_answers)===

An additional issue in the method get_number_of_taggable_answers. The error message is as shown below which indicates string concatenation fails between integer and string data types.

''TypeError:''
no implicit conversion of Fixnum into String at line 23 https://github.com/expertiza/expertiza/blob/beta/app/models/tag_prompt_deployment.rb.

[[File:Get_number_of_taggable_answers_bug.JPG]]

This issue is fixed by correcting the syntax of the two-strings concatenation. After fixing the code is

<code> answers = answers.where(conditions: "length(comments) < #{self.answer_length_threshold}" ) unless self.answer_length_threshold.nil? </code>

===Model: tag_prompt_deployment.rb (method: assignment_tagging_progress)===

<pre>
Failure/Error: answers = answers.where("length(comments) > ?", self.answer_length_threshold.to_s) unless self.answer_length_threshold.nil?

NoMethodError:
undefined method `where' for #<Array:0x00000003424b60>
</pre>

This issue was resolved by using <code>Arrays.select</code> to achieve the same functionality.

There was another small error in which the TeamsUser <code>user</code> was not found, and the resolution was to find the User model for each <code>TeamsUser.user_id</code>.

== Results ==
Test cases are added to cover all functionality. With the cases added the coverage has reached to 100%.

Test cases demo can be found at [https://youtu.be/WYSUmL6jcHc OSS Final Project Testing Video]

tag_prompt_deployment.rb: Coverage = 100%

[[File:Tag_prompt_deployment_coverage.jpeg]]

answer_tags_controller.rb: Coverage = 100%

[[File:Answer_tag_controller_coverage.jpeg]]

== Collaborators ==
Nicholas Himes (Mentor)

1. Aditya Khadse

2. Alec Landow

3. Rageeni Sah

4. Sayali Parab

== Relevant Links ==
Main Expertiza repository can be found at [https://github.com/expertiza/expertiza/tree/beta GitHubExp]

Our forked repository can be found at [https://github.com/akk5597/expertiza Github]

== Video Link ==

Test case run and coverage recording [https://www.youtube.com/watch?v=WYSUmL6jcHc]

CSC/ECE 517 Fall 2021 - E2169. Testing - Answer Tagging

2021-11-30T03:47:30Z

Snparab:

__TOC__

== Background ==
Answer tagging (see [https://github.com/expertiza/expertiza/blob/25713567e5e5e1c0b363409715e6d8797b45b01a/app/models/answer_tag.rb answer_tab.rb] and [[Answer_tags|wiki]]) helps determine a few metrics on a student’s responses to a questionnaire. Students can tag these metrics for other students for things such as “Positive Tone” or “Suggest Solutions”.

These specs below all need to be further developed to cover missing methods/lines. Some structures currently exist at the top of spec files (such as assignments, participants, etc) to help make writing tests easier. Please feel free to add to these and write extra tests to cover any edge cases you may think of.

As an instructor on an assignment, going to Etc/View Reports/Answer Tagging Report will show student answer tagging. You will be able to see the percentage of answers tagged, # of answers tagged, # not tagged, and # of taggable answers for each student on a questionnaire.

[[File:Tagging_report.png|thumb|center|Fig. 1]]

== Project Purpose==
The objective of the project is unit testing of functionality in these two ruby files and increasing the coverage.

[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec]

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec]

== Initial Coverage ==
[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec] : 0% Covered

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec] : 18% Covered

=== Missed Methods ===
* <code>app/controllers/answer_tags_controller.rb</code>
** <code>action_allowed?</code>
** <code>index</code>
** <code>create_edit</code>
** <code>destroy</code>

* <code>app/models/tag_prompt_deployment.rb</code>
** <code>get_number_of_taggable_answers</code>
** <code>assignment_tagging_progress</code>

== Project Design ==
In this project, we have two controllers to be tested using Rspec Unit testing.

The ER diagram of the parent tables is given below for reference ([https://expertiza.csc.ncsu.edu/index.php/Answer_tags Source: Answer_tags]).

[[File:answer_tags_imported.png]]

The flow diagrams below show how controllers in this project are connected with interrelated classes, methods, and views.

[[File:E2169 answer tags controller.png|900px]]

[[File:E2169 tag prompt deployment.png|900px]]

== Testing Plan ==
=== Controller: answer_tags_controller.rb ===

Existing coverage = 0%

Description:
The purpose of this controller is to track down the total number of tags done by the students. The database structure for the answer_tags can be found here [https://expertiza.csc.ncsu.edu/index.php/Answer_tags]

'''Methods'''

1. action_allowed? ( params: action )

Description: To allow the functionality only if the accessing user is having student privileges (current_user_has_student_privileges?)

<code>Use cases:</code>
* <code>When the session is null, Access should be denied</code>
* <code>When the session is of student type, access should be allowed and operation should be executed.</code>

2. index ( params : assignment_id, questionnaire_id, user_id )

Description: Populates the tags by fetching the records from AnswerTag corresponding to each TagPromptDeployment based on the filers provided as params.

<code>Use cases:</code>
* <code> When all valid params are passed, the function should populate the answer tags.</code>
* <code> When user_id is provided, answer tags specific to that user should only be populated.</code>
* <code> When questionnaire_id is provided, answer tags specific to that questionnaire should only be populated.</code>
* <code> When assignment_id is provided, answer tags specific to that assignment should only be populated.</code>
* <code> When only one parameter is passed, the corresponding answer tags should be populated.</code>

<code>Edge test cases:</code>
* <code> When user_id is nil, 0 tags prompts should be returned.</code>
* <code> When questionnaire_id is nil, 0 tags prompts should be returned.</code>
* <code> When assignment_id is nil, 0 tags prompts should be returned.</code>

3. create_edit ( params : answer_id, tag_prompt_deployment_id, value )

Description: Fetches the answer tag with the params provided and then updates the respective tag values by the updated values provided as params.

<code>Use cases:</code>
* <code> When the existing tag is found based on the params passed, the existing tag should be updated with new values.</code>

=== Controller: tag_prompt_deployment.rb ===

Existing coverage = 18%

Description:
This Controller is when a user (with instructor privilege) wants to see tagging summary of every user that participated in a tagging assignment.

'''Methods'''

1. tag_prompt
Description: tag_prompt has existing test cases scoring 18 percentage coverage. Additional testing is not required.

2. get_number_of_taggable_answers ( params: user_id)

Description: To calculate total taggable answers reviewed by a user that participated in the given tagging assignment. user_id is the parameter passed to this method. An individual and his team will have the same score. Fig 1: The last column values are processed by this method.

<code>Use cases:</code>
* <code>when user_id is nil expect an error</code>
* <code>when a team has given any response then count of taggable answer > 0</code>
* <code>When a question or a response does not exists then count of taggable answer = 0 (extreme case) </code>
* <code>When answer_length_threshold not set, count taggable answer</code>
* <code>When answer_length_threshold is set, count taggable answer</code>

<code>Edge cases:</code>
* user_id (parameter) is nil
* response is empty
* question is empty

3. assignment_tagging_progress

Description: To compute the number of tagged answers, number of untagged answers, and percentage of answers tagged by the users that participated in the tagging Assignment to a particular question.
Fig 1: First three columns after the 2nd column onwards are updated with results obtained from this method.

<code>Use cases:</code>
* <code>When not team participated in the assignment, assert count(user_answer_tagging) =0</code>
* <code>When the question does not exist, assert count(user_answer_tagging) =0 </code>
* <code>When multiple rounds of review, render ReviewResponseMap and assert response object</code>
* <code>When single round of review, render ResponseMap and assert response object</code>
* <code>When answer_length_threshold is SET, number of answers and when answer_length_threshold is NOT SET, number of answers</code>
* <code>When route is success answer_tagging object structure matching</code>

<code>Edge cases:</code>
* There are no teams associated with the assignment.
* There are no questions in the questionnaire that have the question type specified in the TagPromptDeployment object.
* The assignment is set to vary by round.
* The assignment is set not to vary by round.
* There are multiple tags.
* There are no tags.

== Bug Fixing of Additional Issues ==

===Model: tag_prompt_deployment.rb (method: get_number_of_taggable_answers)===

An additional issue in the method get_number_of_taggable_answers. The error message is as shown below which indicates string concatenation fails between integer and string data types.

''TypeError:''
no implicit conversion of Fixnum into String at line 23 https://github.com/expertiza/expertiza/blob/beta/app/models/tag_prompt_deployment.rb.

[[File:Get_number_of_taggable_answers_bug.JPG]]

This issue is fixed by correcting the syntax of the two-strings concatenation. After fixing the code is

<code> answers = answers.where(conditions: "length(comments) < #{self.answer_length_threshold}" ) unless self.answer_length_threshold.nil? </code>

===Model: tag_prompt_deployment.rb (method: assignment_tagging_progress)===

<pre>
Failure/Error: answers = answers.where("length(comments) > ?", self.answer_length_threshold.to_s) unless self.answer_length_threshold.nil?

NoMethodError:
undefined method `where' for #<Array:0x00000003424b60>
</pre>

This issue was resolved by using <code>Arrays.select</code> to achieve the same functionality.

There was another small error in which the TeamsUser <code>user</code> was not found, and the resolution was to find the User model for each <code>TeamsUser.user_id</code>.

== Results ==
Test cases are added to cover all functionality. With the cases added the coverage has reached to 100%.

Test cases demo can be found at [https://youtu.be/WYSUmL6jcHc OSS Final Project Testing Video]

tag_prompt_deployment.rb: Coverage = 100%

[[File:Tag_prompt_deployment_coverage.jpeg]]

answer_tags_controller.rb: Coverage = 100%

[[File:Answer_tag_controller_coverage.jpeg]]

== Collaborators ==
Nicholas Himes (Mentor)

1. Aditya Khadse

2. Alec Landow

3. Rageeni Sah

4. Sayali Parab

== Relevant Links ==
Main Expertiza repository can be found at [https://github.com/expertiza/expertiza/tree/beta GitHubExp]

Our forked repository can be found at [https://github.com/akk5597/expertiza Github]

CSC/ECE 517 Fall 2021 - E2169. Testing - Answer Tagging

2021-11-30T03:45:15Z

Snparab: /* Collaborators */

__TOC__

== Background ==
Answer tagging (see [https://github.com/expertiza/expertiza/blob/25713567e5e5e1c0b363409715e6d8797b45b01a/app/models/answer_tag.rb answer_tab.rb] and [[Answer_tags|wiki]]) helps determine a few metrics on a student’s responses to a questionnaire. Students can tag these metrics for other students for things such as “Positive Tone” or “Suggest Solutions”.

These specs below all need to be further developed to cover missing methods/lines. Some structures currently exist at the top of spec files (such as assignments, participants, etc) to help make writing tests easier. Please feel free to add to these and write extra tests to cover any edge cases you may think of.

As an instructor on an assignment, going to Etc/View Reports/Answer Tagging Report will show student answer tagging. You will be able to see the percentage of answers tagged, # of answers tagged, # not tagged, and # of taggable answers for each student on a questionnaire.

[[File:Tagging_report.png|thumb|center|Fig. 1]]

== Project Purpose==
The objective of the project is unit testing of functionality in these two ruby files and increasing the coverage.

[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec]

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec]

== Initial Coverage ==
[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fanswer_tags_controller.rb Answer_tags_controller_spec] : 0% Covered

[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Ftag_prompt_deployment.rb Tag_prompt_deployment_spec] : 18% Covered

=== Missed Methods ===
* <code>app/controllers/answer_tags_controller.rb</code>
** <code>action_allowed?</code>
** <code>index</code>
** <code>create_edit</code>
** <code>destroy</code>

* <code>app/models/tag_prompt_deployment.rb</code>
** <code>get_number_of_taggable_answers</code>
** <code>assignment_tagging_progress</code>

== Project Design ==
In this project, we have two controllers to be tested using Rspec Unit testing.

The ER diagram of the parent tables is given below for reference ([https://expertiza.csc.ncsu.edu/index.php/Answer_tags Source: Answer_tags]).

[[File:answer_tags_imported.png]]

The flow diagrams below show how controllers in this project are connected with interrelated classes, methods, and views.

[[File:E2169 answer tags controller.png|900px]]

[[File:E2169 tag prompt deployment.png|900px]]

== Testing Plan ==
=== Controller: answer_tags_controller.rb ===

Existing coverage = 0%

Description:
The purpose of this controller is to track down the total number of tags done by the students. The database structure for the answer_tags can be found here [https://expertiza.csc.ncsu.edu/index.php/Answer_tags]

'''Methods'''

1. action_allowed? ( params: action )

Description: To allow the functionality only if the accessing user is having student privileges (current_user_has_student_privileges?)

<code>Use cases:</code>
* <code>When the session is null, Access should be denied</code>
* <code>When the session is of student type, access should be allowed and operation should be executed.</code>

2. index ( params : assignment_id, questionnaire_id, user_id )

Description: Populates the tags by fetching the records from AnswerTag corresponding to each TagPromptDeployment based on the filers provided as params.

<code>Use cases:</code>
* <code> When all valid params are passed, the function should populate the answer tags.</code>
* <code> When user_id is provided, answer tags specific to that user should only be populated.</code>
* <code> When questionnaire_id is provided, answer tags specific to that questionnaire should only be populated.</code>
* <code> When assignment_id is provided, answer tags specific to that assignment should only be populated.</code>
* <code> When only one parameter is passed, the corresponding answer tags should be populated.</code>

<code>Edge test cases:</code>
* <code> When user_id is nil, 0 tags prompts should be returned.</code>
* <code> When questionnaire_id is nil, 0 tags prompts should be returned.</code>
* <code> When assignment_id is nil, 0 tags prompts should be returned.</code>

3. create_edit ( params : answer_id, tag_prompt_deployment_id, value )

Description: Fetches the answer tag with the params provided and then updates the respective tag values by the updated values provided as params.

<code>Use cases:</code>
* <code> When the existing tag is found based on the params passed, the existing tag should be updated with new values.</code>

=== Controller: tag_prompt_deployment.rb ===

Existing coverage = 18%

Description:
This Controller is when a user (with instructor privilege) wants to see tagging summary of every user that participated in a tagging assignment.

'''Methods'''

1. tag_prompt
Description: tag_prompt has existing test cases scoring 18 percentage coverage. Additional testing is not required.

2. get_number_of_taggable_answers ( params: user_id)

Description: To calculate total taggable answers reviewed by a user that participated in the given tagging assignment. user_id is the parameter passed to this method. An individual and his team will have the same score. Fig 1: The last column values are processed by this method.

<code>Use cases:</code>
* <code>when user_id is nil expect an error</code>
* <code>when a team has given any response then count of taggable answer > 0</code>
* <code>When a question or a response does not exists then count of taggable answer = 0 (extreme case) </code>
* <code>When answer_length_threshold not set, count taggable answer</code>
* <code>When answer_length_threshold is set, count taggable answer</code>

<code>Edge cases:</code>
* user_id (parameter) is nil
* response is empty
* question is empty

3. assignment_tagging_progress

Description: To compute the number of tagged answers, number of untagged answers, and percentage of answers tagged by the users that participated in the tagging Assignment to a particular question.
Fig 1: First three columns after the 2nd column onwards are updated with results obtained from this method.

<code>Use cases:</code>
* <code>When not team participated in the assignment, assert count(user_answer_tagging) =0</code>
* <code>When the question does not exist, assert count(user_answer_tagging) =0 </code>
* <code>When multiple rounds of review, render ReviewResponseMap and assert response object</code>
* <code>When single round of review, render ResponseMap and assert response object</code>
* <code>When answer_length_threshold is SET, number of answers and when answer_length_threshold is NOT SET, number of answers</code>
* <code>When route is success answer_tagging object structure matching</code>

<code>Edge cases:</code>
* There are no teams associated with the assignment.
* There are no questions in the questionnaire that have the question type specified in the TagPromptDeployment object.
* The assignment is set to vary by round.
* The assignment is set not to vary by round.
* There are multiple tags.
* There are no tags.

== Bug Fixing of Additional Issues ==

===Model: tag_prompt_deployment.rb (method: get_number_of_taggable_answers)===

An additional issue in the method get_number_of_taggable_answers. The error message is as shown below which indicates string concatenation fails between integer and string data types.

''TypeError:''
no implicit conversion of Fixnum into String at line 23 https://github.com/expertiza/expertiza/blob/beta/app/models/tag_prompt_deployment.rb.

[[File:Get_number_of_taggable_answers_bug.JPG]]

This issue is fixed by correcting the syntax of the two-strings concatenation. After fixing the code is

<code> answers = answers.where(conditions: "length(comments) < #{self.answer_length_threshold}" ) unless self.answer_length_threshold.nil? </code>

===Model: tag_prompt_deployment.rb (method: assignment_tagging_progress)===

<pre>
Failure/Error: answers = answers.where("length(comments) > ?", self.answer_length_threshold.to_s) unless self.answer_length_threshold.nil?

NoMethodError:
undefined method `where' for #<Array:0x00000003424b60>
</pre>

This issue was resolved by using <code>Arrays.select</code> to achieve the same functionality.

There was another small error in which the TeamsUser <code>user</code> was not found, and the resolution was to find the User model for each <code>TeamsUser.user_id</code>.

== Results ==
Test cases are added to cover all functionality. With the cases added the coverage has reached to 100%.

tag_prompt_deployment.rb: Coverage = 100%

[[File:Tag_prompt_deployment_coverage.jpeg]]

answer_tags_controller.rb: Coverage = 100%

[[File:Answer_tag_controller_coverage.jpeg]]

== Collaborators ==
Nicholas Himes (Mentor)

1. Aditya Khadse

2. Alec Landow

3. Rageeni Sah

4. Sayali Parab

== Relevant Links ==
Main Expertiza repository can be found at [https://github.com/expertiza/expertiza/tree/beta GitHubExp]

Our forked repository can be found at [https://github.com/akk5597/expertiza Github]

CSC/ECE 517 Fall 2021 - E2169. Testing - Answer Tagging

2021-11-01T21:20:17Z

Snparab:

CSC/ECE 517 Fall 2021 - E2133. Write tests for popup controller.rb

2021-10-21T03:41:14Z

Snparab: /* Results */

The goal of this project is to add unit testing for the PopupController to raise statement coverage above 60%. See the Test Outline section for specifics of our work.

== Project Introduction ==
The PopupController is responsible for preparing data that will be displayed in popup views. To render the data, which mostly concerns assignments, the controller makes many accesses to database tables such as Response, ResponseMap, Question, Questionnaire, Answer, and Participant. The previous team implemented some of the test cases to improve the coverage. The previous work test coverage was 96%. However, their test cases followed integration testing methodologies which were not consistent with Unit testing.
We will be implementing Unit testing while retaining the current coverage.

=== Team ===
Yi Qiu (mentor)

*Sayali Parab, snparab1704

*Rageeni Sah, ragesah

*Priya Jakhar, priyajakhar

=== Files Involved ===

popup_controller.rb

popup_controller_spec.rb

=== Running Tests ===
What we need to do is to set up the environment and complete the 'popup_controller_spec.rb' to finish the unit tests for popup controller. This rspec test file can be run by calling the following code:
<pre>
rspec spec/controllers/popup_controller_spec.rb
</pre>

===What needs to be done===
1. Write RSpec unit test cases to make the statement coverage above 90%.

2. Cover as many boundary cases and the core functionality for all popup controller actions.

== Test Plan ==
In total, we wrote tests to cover all 6 methods in the popup controller. We created unit test cases with the help of mocked objects (factory objects and stub objects).

====Popup Controller Methods====

The code of the controller can be found [https://github.com/expertiza/expertiza/blob/beta/app/controllers/popup_controller.rb here]. The methods are:

*action_allowed?
*author_feedback_popup
*team_users_popup
*view_review_scores_popup
*reviewer_details_popup
*self_review_popup

====Mock Models====

====Test Frame====
Since it's unit testing, we need to test functional logic.

1. action_allowed? - This is the first action that takes place when user tries to access the popup. This checks whether the current user is authorized to view the pop up. The action is allowed for all users except the student.

Code snippet:
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do; expect(controller.send(:action_allowed?)).to be false; end
it 'for student' do
stub_current_user(student, student.role.name, student.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when role has right privilege, it allows action' do
it 'for Super Admin' do
stub_current_user(superadmin, superadmin.role.name, superadmin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for Admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for Instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for TA' do
stub_current_user(ta, ta.role.name, ta.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. author_feedback_popup - This action can be called from response_report by clicking on Student names from Instructor's end.

Code snippet:
<pre>
describe '#author_feedback_popup' do
context 'when response_id does not exist' do
it 'fail to get any info' do; expect(controller.send(:author_feedback_popup)).to be nil; end
end
context 'when response_id exists' do
it 'passes tests in first block' do
allow(Question).to receive_message_chain(:find, :questionnaire_id).with(answer.question_id).with(no_args).and_return(questionnaire.id)
allow(Questionnaire).to receive(:find).with(questionnaire.id).and_return(questionnaire)
allow(questionnaire).to receive(:max_question_score).and_return(20)
allow(Answer).to receive(:where).with(any_args).and_return([answer])
allow(Response).to receive(:find).with(any_args).and_return(response)
allow(response).to receive(:average_score).and_return(16)
allow(response).to receive(:aggregate_questionnaire_score).and_return(20)
allow(response).to receive(:maximum_score).and_return(19)
allow(Participant).to receive(:find).with("1").and_return(participant)
allow(User).to receive(:find).with(participant.user_id).and_return(participant)

params = {response_id: 1, reviewee_id: 1}
session = {user: ta}
result = get :author_feedback_popup, params, session
expect(result.status).to eq 200
expect(controller.instance_variable_get(:@sum)).to eq 20
expect(controller.instance_variable_get(:@total_possible)).to eq 19
expect(controller.instance_variable_get(:@total_percentage)).to eq 16
end
end
end
</pre>

3. team_users_popup - This action can be called from _review_report by clicking the team reviewed link from the instructor's end. This action is responsible to fetch team details that have reviewed the assignment. details: team name, team users, max score round, total possible rounds, comments, etc.

Findings:
team_users_popup.html

Params:
id,
id2

Responses:
sum
team
assignment
team_users
reviewer_id
similar_assignments

Used variables in HTML view:
team,
team_users,
ip,
assignment,
reviewer_id,
response_round_ ,
response_id_round_ ,
scores_round_ ,
Max_score_round_ ,
Total_percentage_round_ ,
sum_round_ ,
total_possible_round_

Code snippet:
<pre>
describe '#team_users_popup' do
## INSERT CONTEXT/DESCRIPTION/CODE HERE
it "renders the page successfuly as Instructor" do
allow(Team).to receive(:find).and_return(team)
allow(Assignment).to receive(:find).and_return(assignment)

reviewer = double(:reviewer1, reviewer_id: 1)
user_id = double(:user_id, user_id: 1)
response = double('response1', response_id: 1, responses: "this is test response")
answer = double('answer', question_id: 1)

allow(ResponseMap).to receive(:find).with(1).and_return(reviewer)
allow(Participant).to receive(:find).with(1).and_return(user_id)
allow(Response).to receive_message_chain(:where, :last).with(map_id: 1, round: 1).with(no_args).and_return(response)
allow(Answer).to receive(:where).with(response_id: 1).and_return(answer)
allow(Response).to receive_message_chain(:average_score).with(no_args).and_return(response)
allow(Response).to receive_message_chain(:aggregate_questionnaire_score).with(no_args).and_return(response)
allow(Response).to receive_message_chain(:maximum_score).with(no_args).and_return(response)

params = {id: team.id}
session = {user: instructor}
result = get :team_users_popup, params, session
expect(result.status).to eq 200
end
end
</pre>

4. view_review_scores_popup- This action can be called from _review_report by clicking the summary link from the instructor's end. This action is responsible to fetch the details of the scores that have been received for the assignment which includes further details such as the course, assignment, questions, responses, the team responsible for the review, review summary, etc.

Findings:

View_review_scores_popup.html

Params:
reviewer_id,
Assignment_id

Response:
review_final_versions,

Used variables in HTML view:
review_final_versions,
review_final_versions.questionnaire_id,
review_final_versions.response_ids

Test cases:
If Reviewer_id is null,
If Assignment_id is null,
Assignment.vary_by_topic true - Provide Flash error,
Assignment.vary_by_topic false - Does not provide Flash error,
review_final_versions - Has the structure as expected by the rendering view page

Code snippet:
<pre>
describe '#view_review_scores_popup'do
context 'review tone analysis operation is performed' do
it 'Prepares scores and review analysis report for rendering purpose' do
allow(Assignment).to receive(:find).and_return(assignment)
allow(Participant).to receive(:find).and_return(participant)
params = {reviewer_id: participant.id, assignment_id: assignment.id}
session = {user: instructor}
result = get :view_review_scores_popup, params, session
expect(controller.instance_variable_get(:@review_final_versions)).to eq final_versions
end
end
end
</pre>

5. reviewer_details_popup - This action can be called from response_report by clicking reviewer names from the instructor's end. This action is responsible to fetch reviewer details: full name, user id, email, and handle.

Code snippet:
<pre>
describe '#reviewer_details_popup' do
render_views
it "render reviewer_details_popup page successfully" do
participant = double(:participant, user_id: 1)
user = double(:user, fullname: "Test User", name: "Test", email: "test@gmail.com", handle: 1)
allow(Participant).to receive(:find).with("1").and_return(participant)
allow(User).to receive(:find).with(participant.user_id).and_return(user)
params = {id: 1, assignment_id: 1}
session = {user: instructor}
get :reviewer_details_popup, params, session
expect(@response).to have_http_status(200)
expect(user.fullname).to eq("Test User")
expect(user.name).to eq("Test")
expect(user.email).to eq("test@gmail.com")
expect(user.handle).to eq(1)
end
end
</pre>

6. self_review_popup - This action can be called from "response_report" by clicking reviewer names from the instructor's end. In this action for the given response id maximum score is displayed. If the response id is nil maximum score is set to 5, i.e., if a question response is not reviewed then the system automatically assigns five as the maximum score for the response.

Code snippet:
<pre>
describe '#self_review_popup' do
context "when current user is the participant" do
it "render page successfully as Instructor to get maximum_score " do
question1 = double(:question1, questionnaire_id: 1)
questionnaire1 = double(:questionnaire1, min_question_score: 1, max_question_score: 3, name: 'Test questionnaire')
answer1 = double('Answer', question_id: 1)
response1 = double('response1', response_id: 1, responses: "this is test response")
allow(Answer).to receive_message_chain(:where, :first).with(response_id: 1).with(no_args).and_return(answer1)
allow(Question).to receive(:find).with(1).and_return(question1)
allow(Questionnaire).to receive(:find).and_return(questionnaire1)
allow(Answer).to receive(:where).with("1").and_return(answer1)
allow(Response).to receive_message_chain(:find, :average_score).with("1").with(no_args).and_return(response1)
allow(Response).to receive_message_chain(:find, :aggregate_questionnaire_score).with("1").with(no_args).and_return(response1)
allow(Response).to receive_message_chain(:find, :maximum_score).with("1").with(no_args).and_return(response1)
params = {response_id: 1, user_fullname: questionnaire1.name}
session = {user: instructor}
get :self_review_popup, params, session
expect(@response).to have_http_status(200)
end
end
end

</pre>

== Results ==
The total coverage of the test is 75.59%, meeting our minimum coverage requirement.

=== Related Links===

A video of all tests running can be seen [https://youtu.be/hUpoXL2gfcI here]

The main repository can be found [https://github.com/expertiza/expertiza/tree/beta here]

The forked git repository for this project can be found [https://github.com/priyajakhar/expertiza/tree/beta here]

===Conclusion===

There were 6 modules in the controller for which we wrote unit tests following behavior driven approach. We did not consider any edge cases for now therefore there is scope to further improve the testing coverage to reach 100%.

CSC/ECE 517 Fall 2021 - E2133. Write tests for popup controller.rb

2021-10-21T00:55:07Z

CSC/ECE 517 Fall 2021

2021-10-18T16:10:38Z

Snparab:

== OSS Projects ==
* [[CSC/ECE 517 Fall 2021 - {$num}. {$desc.title}]]
* [[CSC/ECE 517 Fall 2021 - E2128. Refactor student_quizzes_controller.rb & late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2132. Add tests cases for review mapping helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2134. Write unit tests for admin_controller.rb and institution_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2138. Auto-generate submission directory names based on assignment]]
* [[CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications]]
* [[CSC/ECE 517 Fall 2021 - E2133. Write tests for popup_controller.rb]]

CSC/ECE 517 Fall 2021 - E2133. Write tests for popup controller.rb

2021-10-18T16:10:04Z

Snparab: Created page with "== Project Introduction == The PopupController is responsible for preparing data that will be displayed in popup views. To render the data, which mostly concerns assignments,..."

== Project Introduction ==
The PopupController is responsible for preparing data that will be displayed in popup views. To render the data, which mostly concerns assignments, the controller makes many accesses to database tables such as Response, ResponseMap, Question, Questionnaire, Answer, and Participant.

=== Team ===

*Sayali Parab, snparab1704

*Rageeni

*Priya

=== Files Involved ===

popup_controller.rb

popup_controller_spec.rb

=== Running Tests ===
What we need to do is to set up the environment and complete the 'popup_controller_spec.rb' to finish the integration tests for popup controller. This rspec test file can be run by calling the following code:
<pre>
rspec spec/controllers/popup_controller_spec.rb
</pre>

===What needs to be done===
1.Write RSpec integration tests to make the statement coverage above 90%.

2.Cover as many edge cases as you can.

3.Achieve as high branch coverage as you can. Teaching staff will use the mutant-rspec gem to measure test thoroughness and fault-finding capability of tests.

== Test Plan ==

====Popup Controller Methods====

The code of the controller can be found [https://github.com/YChen239/expertiza/blob/master/app/controllers/popup_controller.rb here]. The methods are:

*action_allowed?
*author_feedback_popup
*team_users_popup
*view_review_scores_popup
*reviewer_details_popup
*self_review_popup

=== Related Links===

The main repository can be found [https://github.com/expertiza/expertiza here]

The forked git repository for this project can be found [https://github.com/priyajakhar/expertiza here]

===Conclusion===