Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-26T20:24:20Z

Yjiang35: /* Useful Links */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 1.jpg|1200px]]

* '''Issue 2''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 2.jpg|1200px]]

* '''Issue 3''' - After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
[[File:Issue 3.png|1200px]]

* '''Issue 4''' - There is also no indication of this penalty policy for students, and no proof it actually works
[[File:Issue 4.png|1200px]]

* '''Issue 5''' - No Botton navigating to the list of all late policies
[[File:Issue 5.jpg|1200px]]

* '''Issue 6''' - When creating/editing an assignment, you can’t see the detail of each late policy
[[File:Issue 6.png|1200px]]

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:517_Final_flow_chart.drawio.png|600px]]

=== Files to be refactored ===

* '''Issue 1'''
Check how to store assignment information into session and fix it. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 2'''
Store assignment information in session through the creation of late policies. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 3'''
Save late policy information of this assignment into database. 
1. app/views/assignments/edit/_due_dates.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 4'''
Show late policy of current assignment on student view page. 
1. app/views/student_task/view.html.erb 
2. app/controllers/student_task_controller.rb 

* '''Issue 5'''
Create buttons link to all late policies on both main page and assigment view page. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 6'''
A button link to all late policies on assignment/new page to show all policies. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

== Testing ==
=== Testing Goals and Test Objects ===

#When logging in as a student:
##You can see the late policy details of your assignments
##The late policy works correctly if you submit your assignment late
#When logging in as an instructor:
##There is a button to navigate you to the page showing all the late policies
##You can see the details of the late policy when creating or editing an assignment
##The "back" button will lead to a correct webpage when creating or editing an assignment
##The "Apply penalty policy" box is saved after submitting the form when creating or editing an assignment

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Issue1
<pre>
Scenario: The instructor wants to go back as he is creating a new late policy
Given: Logged in as an instructor
When: Clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates” -> “Createlate policy”
And: Clicks “Back”
Then: Redirect to the previous create assignment page.
</pre>
*Issue2
<pre>
Scenario: The instructor have created a new late policy and tries to go back to previous page
Given: Logged in as an instructor
When: An instructor successfully creates a new late policy, being redirected to the “/late_policies” webpage with all information of late policies.
And: The instructor clicks “Back” button
Then: The instructor is redirected to the previous create/edit assignment page.
</pre>
*Issue3: After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
<pre>
Scenario: The instructor create a new assignment with a late policy applied
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment”, enter informations for the new assignment
And: Click “Save” and refresh/redirect to the assignment edit page
Then: The checkbox for the late policy should be in the state of checked.
</pre>
<pre>
Scenario: The instructor apply a late policy to an assignment with no late policy applied yet
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” and goes to an assignment’s edit page
And: The assignment should not has late policy applied before
Then: As the instructor applies late policy to the assignment and refresh/redirect to the assignment edit page, the checkbox for the late policy should be in the state of checked.
</pre>
*Issue4: Show indication and proof about late policies at student’s side
<pre>
Scenario: A student wants to know late policies related to his assignments
Given: Logged in as a student
When: The student clicks “Assignments” from navbar
And: Select an assignment and redirect to the assignment’s detail page (“student_task/view”)
Then: There should be a section parallel with sections like “Signup sheet” and “Your score”, with the name of “Late policy”. As the student clicks on it, the website redirects to the assignment’s late policy detail page.
</pre>
*Issue5: Add “Late policies” inside the “Mange…” section from instructors’ navbar
<pre>
Scenario: An instructor tries to view the list of all the late policies without creating a new assignment
Given: Logged in as an Instructor
When: The instructor hovers his mouse on the “Manage…” section for navbar
And: From the list below, there should be a section called “Late policies”
Then: As the instructor clicks the “Late policies” section, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue6: Add “show all late policies” button inside the “new assignment” -> “Due dates” page
<pre>
Scenario: An instructor tries to create a new assignment and apply a late policy to it
Given: Logged in as an Instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates”
And: Besides the “New late policy” button, there should be a “Show all late policies” button.
Then: As the instructor clicks the “Show all late policies” button, he gets redirected to the /late_policies with all late policies’ details.
</pre>

=== Manual Testing ===
'''Student's View in Assignment'''

[[File:Student View.png|1200px]]

'''Admin's View When Creating new Assignment'''

[[File:Admin View.png|1200px]]

==Project Mentors==
* Nicholas Himes

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2236===
#[https://github.com/517-E2236/expertiza/tree/beta GitHub Repository]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

===Demo Vedio===
#[https://drive.google.com/file/d/1o91z8bYT0cTnydLSqCaHpV0tCIOTFiyD/view?usp=sharing/ Demo Vedio Link]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-26T20:19:12Z

Yjiang35: /* RSpec Unit Tests */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-26T20:18:31Z

Yjiang35: /* Files to be refactored */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 1.jpg|1200px]]

* '''Issue 2''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 2.jpg|1200px]]

* '''Issue 3''' - After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
[[File:Issue 3.png|1200px]]

* '''Issue 4''' - There is also no indication of this penalty policy for students, and no proof it actually works
[[File:Issue 4.png|1200px]]

* '''Issue 5''' - No Botton navigating to the list of all late policies
[[File:Issue 5.jpg|1200px]]

* '''Issue 6''' - When creating/editing an assignment, you can’t see the detail of each late policy
[[File:Issue 6.png|1200px]]

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:517_Final_flow_chart.drawio.png|600px]]

=== Files to be refactored ===

* '''Issue 1'''
Check how to store assignment information into session and fix it. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 2'''
Store assignment information in session through the creation of late policies. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 3'''
Save late policy information of this assignment into database. 
1. app/views/assignments/edit/_due_dates.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 4'''
Show late policy of current assignment on student view page. 
1. app/views/student_task/view.html.erb 
2. app/controllers/student_task_controller.rb 

* '''Issue 5'''
Create buttons link to all late policies on both main page and assigment view page. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 6'''
A button link to all late policies on assignment/new page to show all policies. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

== Testing ==
=== Testing Goals and Test Objects ===

#When logging in as a student:
##You can see the late policy details of your assignments
##The late policy works correctly if you submit your assignment late
#When logging in as an instructor:
##There is a button to navigate you to the page showing all the late policies
##You can see the details of the late policy when creating or editing an assignment
##The "back" button will lead to a correct webpage when creating or editing an assignment
##The "Apply penalty policy" box is saved after submitting the form when creating or editing an assignment

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Issue1
<pre>
Scenario: The instructor wants to go back as he is creating a new late policy
Given: Logged in as an instructor
When: Clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates” -> “Createlate policy”
And: Clicks “Back”
Then: Redirect to the previous create assignment page.
</pre>
*Issue2
<pre>
Scenario: The instructor have created a new late policy and tries to go back to previous page
Given: Logged in as an instructor
When: An instructor successfully creates a new late policy, being redirected to the “/late_policies” webpage with all information of late policies.
And: The instructor clicks “Back” button
Then: The instructor is redirected to the previous create/edit assignment page.
</pre>
*Issue3: After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
<pre>
Scenario: The instructor create a new assignment with a late policy applied
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment”, enter informations for the new assignment
And: Click “Save” and refresh/redirect to the assignment edit page
Then: The checkbox for the late policy should be in the state of checked.
</pre>
<pre>
Scenario: The instructor apply a late policy to an assignment with no late policy applied yet
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” and goes to an assignment’s edit page
And: The assignment should not has late policy applied before
Then: As the instructor applies late policy to the assignment and refresh/redirect to the assignment edit page, the checkbox for the late policy should be in the state of checked.
</pre>
*Issue4: Show indication and proof about late policies at student’s side
<pre>
Scenario: A student wants to know late policies related to his assignments
Given: Logged in as a student
When: The student clicks “Assignments” from navbar
And: Select an assignment and redirect to the assignment’s detail page (“student_task/view”)
Then: There should be a section parallel with sections like “Signup sheet” and “Your score”, with the name of “Late policy”. As the student clicks on it, the website redirects to the assignment’s late policy detail page.
</pre>
*Issue5: Add “Late policies” inside the “Mange…” section from instructors’ navbar
<pre>
Scenario: An instructor tries to view the list of all the late policies without creating a new assignment
Given: Logged in as an Instructor
When: The instructor hovers his mouse on the “Manage…” section for navbar
And: From the list below, there should be a section called “Late policies”
Then: As the instructor clicks the “Late policies” section, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue6: Add “show all late policies” button inside the “new assignment” -> “Due dates” page
<pre>
Scenario: An instructor tries to create a new assignment and apply a late policy to it
Given: Logged in as an Instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates”
And: Besides the “New late policy” button, there should be a “Show all late policies” button.
Then: As the instructor clicks the “Show all late policies” button, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue7: Adding test cases to check the late policy applied actually works to subtract points from the students.
<pre>
Scenario: Subtract points for a student who does trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment
And: It is already late for the deadline
Then: Student should get a deducted point and an information about late policy triggered
</pre>
<pre>
Scenario: Give points for a student who doesn’t trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment and the deadline is not due yet
And: The late policy exists
Then: Student should get points without late policy’s punishment
</pre>
<pre>
Scenario: Give points for a student who submit the assignment after the deadline with no late policy applied for the assignment
Given: Logged in as a Student
When: The student submit the assignment and the deadline is already due
And: The late policy does not exist
Then: Student should get points without any punishment
</pre>

=== Manual Testing ===
'''Student's View in Assignment'''

[[File:Student View.png|1200px]]

'''Admin's View When Creating new Assignment'''

[[File:Admin View.png|1200px]]

==Project Mentors==
* Nicholas Himes

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2236===
#[https://github.com/517-E2236/expertiza/tree/beta GitHub Repository]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-26T20:18:15Z

Yjiang35: /* Issues with the Current Implementation */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 1.jpg|1200px]]

* '''Issue 2''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 2.jpg|1200px]]

* '''Issue 3''' - After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
[[File:Issue 3.png|1200px]]

* '''Issue 4''' - There is also no indication of this penalty policy for students, and no proof it actually works
[[File:Issue 4.png|1200px]]

* '''Issue 5''' - No Botton navigating to the list of all late policies
[[File:Issue 5.jpg|1200px]]

* '''Issue 6''' - When creating/editing an assignment, you can’t see the detail of each late policy
[[File:Issue 6.png|1200px]]

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:517_Final_flow_chart.drawio.png|600px]]

=== Files to be refactored ===

* '''Issue 1'''
Check how to store assignment information into session and fix it. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 2'''
Store assignment information in session through the creation of late policies. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 3'''
Save late policy information of this assignment into database. 
1. app/views/assignments/edit/_due_dates.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 4'''
Show late policy of current assignment on student view page. 
1. app/views/student_task/view.html.erb 
2. app/controllers/student_task_controller.rb 

* '''Issue 5'''
Create buttons link to all late policies on both main page and assigment view page. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 6'''
A button link to all late policies on assignment/new page to show all policies. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 7'''
Fix the late policy function to make it work. 
1. app/controllers/late_policies_controller.rb 
2. app/controllers/assignments_controller.rb 

== Testing ==
=== Testing Goals and Test Objects ===

#When logging in as a student:
##You can see the late policy details of your assignments
##The late policy works correctly if you submit your assignment late
#When logging in as an instructor:
##There is a button to navigate you to the page showing all the late policies
##You can see the details of the late policy when creating or editing an assignment
##The "back" button will lead to a correct webpage when creating or editing an assignment
##The "Apply penalty policy" box is saved after submitting the form when creating or editing an assignment

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Issue1
<pre>
Scenario: The instructor wants to go back as he is creating a new late policy
Given: Logged in as an instructor
When: Clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates” -> “Createlate policy”
And: Clicks “Back”
Then: Redirect to the previous create assignment page.
</pre>
*Issue2
<pre>
Scenario: The instructor have created a new late policy and tries to go back to previous page
Given: Logged in as an instructor
When: An instructor successfully creates a new late policy, being redirected to the “/late_policies” webpage with all information of late policies.
And: The instructor clicks “Back” button
Then: The instructor is redirected to the previous create/edit assignment page.
</pre>
*Issue3: After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
<pre>
Scenario: The instructor create a new assignment with a late policy applied
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment”, enter informations for the new assignment
And: Click “Save” and refresh/redirect to the assignment edit page
Then: The checkbox for the late policy should be in the state of checked.
</pre>
<pre>
Scenario: The instructor apply a late policy to an assignment with no late policy applied yet
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” and goes to an assignment’s edit page
And: The assignment should not has late policy applied before
Then: As the instructor applies late policy to the assignment and refresh/redirect to the assignment edit page, the checkbox for the late policy should be in the state of checked.
</pre>
*Issue4: Show indication and proof about late policies at student’s side
<pre>
Scenario: A student wants to know late policies related to his assignments
Given: Logged in as a student
When: The student clicks “Assignments” from navbar
And: Select an assignment and redirect to the assignment’s detail page (“student_task/view”)
Then: There should be a section parallel with sections like “Signup sheet” and “Your score”, with the name of “Late policy”. As the student clicks on it, the website redirects to the assignment’s late policy detail page.
</pre>
*Issue5: Add “Late policies” inside the “Mange…” section from instructors’ navbar
<pre>
Scenario: An instructor tries to view the list of all the late policies without creating a new assignment
Given: Logged in as an Instructor
When: The instructor hovers his mouse on the “Manage…” section for navbar
And: From the list below, there should be a section called “Late policies”
Then: As the instructor clicks the “Late policies” section, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue6: Add “show all late policies” button inside the “new assignment” -> “Due dates” page
<pre>
Scenario: An instructor tries to create a new assignment and apply a late policy to it
Given: Logged in as an Instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates”
And: Besides the “New late policy” button, there should be a “Show all late policies” button.
Then: As the instructor clicks the “Show all late policies” button, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue7: Adding test cases to check the late policy applied actually works to subtract points from the students.
<pre>
Scenario: Subtract points for a student who does trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment
And: It is already late for the deadline
Then: Student should get a deducted point and an information about late policy triggered
</pre>
<pre>
Scenario: Give points for a student who doesn’t trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment and the deadline is not due yet
And: The late policy exists
Then: Student should get points without late policy’s punishment
</pre>
<pre>
Scenario: Give points for a student who submit the assignment after the deadline with no late policy applied for the assignment
Given: Logged in as a Student
When: The student submit the assignment and the deadline is already due
And: The late policy does not exist
Then: Student should get points without any punishment
</pre>

=== Manual Testing ===
'''Student's View in Assignment'''

[[File:Student View.png|1200px]]

'''Admin's View When Creating new Assignment'''

[[File:Admin View.png|1200px]]

==Project Mentors==
* Nicholas Himes

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2236===
#[https://github.com/517-E2236/expertiza/tree/beta GitHub Repository]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-26T20:17:40Z

Yjiang35: /* Manual Testing */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 1.jpg|1200px]]

* '''Issue 2''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 2.jpg|1200px]]

* '''Issue 3''' - After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
[[File:Issue 3.png|1200px]]

* '''Issue 4''' - There is also no indication of this penalty policy for students, and no proof it actually works
[[File:Issue 4.png|1200px]]

* '''Issue 5''' - No Botton navigating to the list of all late policies
[[File:Issue 5.jpg|1200px]]

* '''Issue 6''' - When creating/editing an assignment, you can’t see the detail of each late policy
[[File:Issue 6.png|1200px]]

* '''Issue 7''' - Adding test cases to check the late policy applied actually works to subtract points from the students.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:517_Final_flow_chart.drawio.png|600px]]

=== Files to be refactored ===

* '''Issue 1'''
Check how to store assignment information into session and fix it. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 2'''
Store assignment information in session through the creation of late policies. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 3'''
Save late policy information of this assignment into database. 
1. app/views/assignments/edit/_due_dates.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 4'''
Show late policy of current assignment on student view page. 
1. app/views/student_task/view.html.erb 
2. app/controllers/student_task_controller.rb 

* '''Issue 5'''
Create buttons link to all late policies on both main page and assigment view page. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 6'''
A button link to all late policies on assignment/new page to show all policies. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 7'''
Fix the late policy function to make it work. 
1. app/controllers/late_policies_controller.rb 
2. app/controllers/assignments_controller.rb 

== Testing ==
=== Testing Goals and Test Objects ===

#When logging in as a student:
##You can see the late policy details of your assignments
##The late policy works correctly if you submit your assignment late
#When logging in as an instructor:
##There is a button to navigate you to the page showing all the late policies
##You can see the details of the late policy when creating or editing an assignment
##The "back" button will lead to a correct webpage when creating or editing an assignment
##The "Apply penalty policy" box is saved after submitting the form when creating or editing an assignment

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Issue1
<pre>
Scenario: The instructor wants to go back as he is creating a new late policy
Given: Logged in as an instructor
When: Clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates” -> “Createlate policy”
And: Clicks “Back”
Then: Redirect to the previous create assignment page.
</pre>
*Issue2
<pre>
Scenario: The instructor have created a new late policy and tries to go back to previous page
Given: Logged in as an instructor
When: An instructor successfully creates a new late policy, being redirected to the “/late_policies” webpage with all information of late policies.
And: The instructor clicks “Back” button
Then: The instructor is redirected to the previous create/edit assignment page.
</pre>
*Issue3: After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
<pre>
Scenario: The instructor create a new assignment with a late policy applied
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment”, enter informations for the new assignment
And: Click “Save” and refresh/redirect to the assignment edit page
Then: The checkbox for the late policy should be in the state of checked.
</pre>
<pre>
Scenario: The instructor apply a late policy to an assignment with no late policy applied yet
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” and goes to an assignment’s edit page
And: The assignment should not has late policy applied before
Then: As the instructor applies late policy to the assignment and refresh/redirect to the assignment edit page, the checkbox for the late policy should be in the state of checked.
</pre>
*Issue4: Show indication and proof about late policies at student’s side
<pre>
Scenario: A student wants to know late policies related to his assignments
Given: Logged in as a student
When: The student clicks “Assignments” from navbar
And: Select an assignment and redirect to the assignment’s detail page (“student_task/view”)
Then: There should be a section parallel with sections like “Signup sheet” and “Your score”, with the name of “Late policy”. As the student clicks on it, the website redirects to the assignment’s late policy detail page.
</pre>
*Issue5: Add “Late policies” inside the “Mange…” section from instructors’ navbar
<pre>
Scenario: An instructor tries to view the list of all the late policies without creating a new assignment
Given: Logged in as an Instructor
When: The instructor hovers his mouse on the “Manage…” section for navbar
And: From the list below, there should be a section called “Late policies”
Then: As the instructor clicks the “Late policies” section, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue6: Add “show all late policies” button inside the “new assignment” -> “Due dates” page
<pre>
Scenario: An instructor tries to create a new assignment and apply a late policy to it
Given: Logged in as an Instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates”
And: Besides the “New late policy” button, there should be a “Show all late policies” button.
Then: As the instructor clicks the “Show all late policies” button, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue7: Adding test cases to check the late policy applied actually works to subtract points from the students.
<pre>
Scenario: Subtract points for a student who does trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment
And: It is already late for the deadline
Then: Student should get a deducted point and an information about late policy triggered
</pre>
<pre>
Scenario: Give points for a student who doesn’t trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment and the deadline is not due yet
And: The late policy exists
Then: Student should get points without late policy’s punishment
</pre>
<pre>
Scenario: Give points for a student who submit the assignment after the deadline with no late policy applied for the assignment
Given: Logged in as a Student
When: The student submit the assignment and the deadline is already due
And: The late policy does not exist
Then: Student should get points without any punishment
</pre>

=== Manual Testing ===
'''Student's View in Assignment'''

[[File:Student View.png|1200px]]

'''Admin's View When Creating new Assignment'''

[[File:Admin View.png|1200px]]

==Project Mentors==
* Nicholas Himes

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2236===
#[https://github.com/517-E2236/expertiza/tree/beta GitHub Repository]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-26T20:16:45Z

Yjiang35: /* Manual Testing */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 1.jpg|1200px]]

* '''Issue 2''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 2.jpg|1200px]]

* '''Issue 3''' - After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
[[File:Issue 3.png|1200px]]

* '''Issue 4''' - There is also no indication of this penalty policy for students, and no proof it actually works
[[File:Issue 4.png|1200px]]

* '''Issue 5''' - No Botton navigating to the list of all late policies
[[File:Issue 5.jpg|1200px]]

* '''Issue 6''' - When creating/editing an assignment, you can’t see the detail of each late policy
[[File:Issue 6.png|1200px]]

* '''Issue 7''' - Adding test cases to check the late policy applied actually works to subtract points from the students.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:517_Final_flow_chart.drawio.png|600px]]

=== Files to be refactored ===

* '''Issue 1'''
Check how to store assignment information into session and fix it. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 2'''
Store assignment information in session through the creation of late policies. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 3'''
Save late policy information of this assignment into database. 
1. app/views/assignments/edit/_due_dates.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 4'''
Show late policy of current assignment on student view page. 
1. app/views/student_task/view.html.erb 
2. app/controllers/student_task_controller.rb 

* '''Issue 5'''
Create buttons link to all late policies on both main page and assigment view page. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 6'''
A button link to all late policies on assignment/new page to show all policies. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 7'''
Fix the late policy function to make it work. 
1. app/controllers/late_policies_controller.rb 
2. app/controllers/assignments_controller.rb 

== Testing ==
=== Testing Goals and Test Objects ===

#When logging in as a student:
##You can see the late policy details of your assignments
##The late policy works correctly if you submit your assignment late
#When logging in as an instructor:
##There is a button to navigate you to the page showing all the late policies
##You can see the details of the late policy when creating or editing an assignment
##The "back" button will lead to a correct webpage when creating or editing an assignment
##The "Apply penalty policy" box is saved after submitting the form when creating or editing an assignment

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Issue1
<pre>
Scenario: The instructor wants to go back as he is creating a new late policy
Given: Logged in as an instructor
When: Clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates” -> “Createlate policy”
And: Clicks “Back”
Then: Redirect to the previous create assignment page.
</pre>
*Issue2
<pre>
Scenario: The instructor have created a new late policy and tries to go back to previous page
Given: Logged in as an instructor
When: An instructor successfully creates a new late policy, being redirected to the “/late_policies” webpage with all information of late policies.
And: The instructor clicks “Back” button
Then: The instructor is redirected to the previous create/edit assignment page.
</pre>
*Issue3: After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
<pre>
Scenario: The instructor create a new assignment with a late policy applied
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment”, enter informations for the new assignment
And: Click “Save” and refresh/redirect to the assignment edit page
Then: The checkbox for the late policy should be in the state of checked.
</pre>
<pre>
Scenario: The instructor apply a late policy to an assignment with no late policy applied yet
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” and goes to an assignment’s edit page
And: The assignment should not has late policy applied before
Then: As the instructor applies late policy to the assignment and refresh/redirect to the assignment edit page, the checkbox for the late policy should be in the state of checked.
</pre>
*Issue4: Show indication and proof about late policies at student’s side
<pre>
Scenario: A student wants to know late policies related to his assignments
Given: Logged in as a student
When: The student clicks “Assignments” from navbar
And: Select an assignment and redirect to the assignment’s detail page (“student_task/view”)
Then: There should be a section parallel with sections like “Signup sheet” and “Your score”, with the name of “Late policy”. As the student clicks on it, the website redirects to the assignment’s late policy detail page.
</pre>
*Issue5: Add “Late policies” inside the “Mange…” section from instructors’ navbar
<pre>
Scenario: An instructor tries to view the list of all the late policies without creating a new assignment
Given: Logged in as an Instructor
When: The instructor hovers his mouse on the “Manage…” section for navbar
And: From the list below, there should be a section called “Late policies”
Then: As the instructor clicks the “Late policies” section, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue6: Add “show all late policies” button inside the “new assignment” -> “Due dates” page
<pre>
Scenario: An instructor tries to create a new assignment and apply a late policy to it
Given: Logged in as an Instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates”
And: Besides the “New late policy” button, there should be a “Show all late policies” button.
Then: As the instructor clicks the “Show all late policies” button, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue7: Adding test cases to check the late policy applied actually works to subtract points from the students.
<pre>
Scenario: Subtract points for a student who does trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment
And: It is already late for the deadline
Then: Student should get a deducted point and an information about late policy triggered
</pre>
<pre>
Scenario: Give points for a student who doesn’t trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment and the deadline is not due yet
And: The late policy exists
Then: Student should get points without late policy’s punishment
</pre>
<pre>
Scenario: Give points for a student who submit the assignment after the deadline with no late policy applied for the assignment
Given: Logged in as a Student
When: The student submit the assignment and the deadline is already due
And: The late policy does not exist
Then: Student should get points without any punishment
</pre>

=== Manual Testing ===
'''Student's View in Assignment'''
[[File:Student View.png]]

'''Admin's View When Creating new Assignment'''
[[File:Admin View.png]]

==Project Mentors==
* Nicholas Himes

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2236===
#[https://github.com/517-E2236/expertiza/tree/beta GitHub Repository]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

File:Admin View.png

2022-04-26T20:16:24Z

Yjiang35:

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-26T20:14:09Z

Yjiang35: /* Manual Testing */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 1.jpg|1200px]]

* '''Issue 2''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 2.jpg|1200px]]

* '''Issue 3''' - After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
[[File:Issue 3.png|1200px]]

* '''Issue 4''' - There is also no indication of this penalty policy for students, and no proof it actually works
[[File:Issue 4.png|1200px]]

* '''Issue 5''' - No Botton navigating to the list of all late policies
[[File:Issue 5.jpg|1200px]]

* '''Issue 6''' - When creating/editing an assignment, you can’t see the detail of each late policy
[[File:Issue 6.png|1200px]]

* '''Issue 7''' - Adding test cases to check the late policy applied actually works to subtract points from the students.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:517_Final_flow_chart.drawio.png|600px]]

=== Files to be refactored ===

* '''Issue 1'''
Check how to store assignment information into session and fix it. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 2'''
Store assignment information in session through the creation of late policies. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 3'''
Save late policy information of this assignment into database. 
1. app/views/assignments/edit/_due_dates.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 4'''
Show late policy of current assignment on student view page. 
1. app/views/student_task/view.html.erb 
2. app/controllers/student_task_controller.rb 

* '''Issue 5'''
Create buttons link to all late policies on both main page and assigment view page. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 6'''
A button link to all late policies on assignment/new page to show all policies. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 7'''
Fix the late policy function to make it work. 
1. app/controllers/late_policies_controller.rb 
2. app/controllers/assignments_controller.rb 

== Testing ==
=== Testing Goals and Test Objects ===

#When logging in as a student:
##You can see the late policy details of your assignments
##The late policy works correctly if you submit your assignment late
#When logging in as an instructor:
##There is a button to navigate you to the page showing all the late policies
##You can see the details of the late policy when creating or editing an assignment
##The "back" button will lead to a correct webpage when creating or editing an assignment
##The "Apply penalty policy" box is saved after submitting the form when creating or editing an assignment

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Issue1
<pre>
Scenario: The instructor wants to go back as he is creating a new late policy
Given: Logged in as an instructor
When: Clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates” -> “Createlate policy”
And: Clicks “Back”
Then: Redirect to the previous create assignment page.
</pre>
*Issue2
<pre>
Scenario: The instructor have created a new late policy and tries to go back to previous page
Given: Logged in as an instructor
When: An instructor successfully creates a new late policy, being redirected to the “/late_policies” webpage with all information of late policies.
And: The instructor clicks “Back” button
Then: The instructor is redirected to the previous create/edit assignment page.
</pre>
*Issue3: After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
<pre>
Scenario: The instructor create a new assignment with a late policy applied
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment”, enter informations for the new assignment
And: Click “Save” and refresh/redirect to the assignment edit page
Then: The checkbox for the late policy should be in the state of checked.
</pre>
<pre>
Scenario: The instructor apply a late policy to an assignment with no late policy applied yet
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” and goes to an assignment’s edit page
And: The assignment should not has late policy applied before
Then: As the instructor applies late policy to the assignment and refresh/redirect to the assignment edit page, the checkbox for the late policy should be in the state of checked.
</pre>
*Issue4: Show indication and proof about late policies at student’s side
<pre>
Scenario: A student wants to know late policies related to his assignments
Given: Logged in as a student
When: The student clicks “Assignments” from navbar
And: Select an assignment and redirect to the assignment’s detail page (“student_task/view”)
Then: There should be a section parallel with sections like “Signup sheet” and “Your score”, with the name of “Late policy”. As the student clicks on it, the website redirects to the assignment’s late policy detail page.
</pre>
*Issue5: Add “Late policies” inside the “Mange…” section from instructors’ navbar
<pre>
Scenario: An instructor tries to view the list of all the late policies without creating a new assignment
Given: Logged in as an Instructor
When: The instructor hovers his mouse on the “Manage…” section for navbar
And: From the list below, there should be a section called “Late policies”
Then: As the instructor clicks the “Late policies” section, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue6: Add “show all late policies” button inside the “new assignment” -> “Due dates” page
<pre>
Scenario: An instructor tries to create a new assignment and apply a late policy to it
Given: Logged in as an Instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates”
And: Besides the “New late policy” button, there should be a “Show all late policies” button.
Then: As the instructor clicks the “Show all late policies” button, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue7: Adding test cases to check the late policy applied actually works to subtract points from the students.
<pre>
Scenario: Subtract points for a student who does trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment
And: It is already late for the deadline
Then: Student should get a deducted point and an information about late policy triggered
</pre>
<pre>
Scenario: Give points for a student who doesn’t trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment and the deadline is not due yet
And: The late policy exists
Then: Student should get points without late policy’s punishment
</pre>
<pre>
Scenario: Give points for a student who submit the assignment after the deadline with no late policy applied for the assignment
Given: Logged in as a Student
When: The student submit the assignment and the deadline is already due
And: The late policy does not exist
Then: Student should get points without any punishment
</pre>

=== Manual Testing ===
'''Student's View in Assignment'''
[[File:Student View.png]]

'''Admin's View When Creating new Assignment'''

==Project Mentors==
* Nicholas Himes

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2236===
#[https://github.com/517-E2236/expertiza/tree/beta GitHub Repository]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

File:Student View.png

2022-04-26T20:12:50Z

Yjiang35: Yjiang35 uploaded a new version of File:Student View.png

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-26T20:11:34Z

Yjiang35: /* Regression Testing */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 1.jpg|1200px]]

* '''Issue 2''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 2.jpg|1200px]]

* '''Issue 3''' - After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
[[File:Issue 3.png|1200px]]

* '''Issue 4''' - There is also no indication of this penalty policy for students, and no proof it actually works
[[File:Issue 4.png|1200px]]

* '''Issue 5''' - No Botton navigating to the list of all late policies
[[File:Issue 5.jpg|1200px]]

* '''Issue 6''' - When creating/editing an assignment, you can’t see the detail of each late policy
[[File:Issue 6.png|1200px]]

* '''Issue 7''' - Adding test cases to check the late policy applied actually works to subtract points from the students.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:517_Final_flow_chart.drawio.png|600px]]

=== Files to be refactored ===

* '''Issue 1'''
Check how to store assignment information into session and fix it. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 2'''
Store assignment information in session through the creation of late policies. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 3'''
Save late policy information of this assignment into database. 
1. app/views/assignments/edit/_due_dates.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 4'''
Show late policy of current assignment on student view page. 
1. app/views/student_task/view.html.erb 
2. app/controllers/student_task_controller.rb 

* '''Issue 5'''
Create buttons link to all late policies on both main page and assigment view page. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 6'''
A button link to all late policies on assignment/new page to show all policies. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 7'''
Fix the late policy function to make it work. 
1. app/controllers/late_policies_controller.rb 
2. app/controllers/assignments_controller.rb 

== Testing ==
=== Testing Goals and Test Objects ===

#When logging in as a student:
##You can see the late policy details of your assignments
##The late policy works correctly if you submit your assignment late
#When logging in as an instructor:
##There is a button to navigate you to the page showing all the late policies
##You can see the details of the late policy when creating or editing an assignment
##The "back" button will lead to a correct webpage when creating or editing an assignment
##The "Apply penalty policy" box is saved after submitting the form when creating or editing an assignment

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Issue1
<pre>
Scenario: The instructor wants to go back as he is creating a new late policy
Given: Logged in as an instructor
When: Clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates” -> “Createlate policy”
And: Clicks “Back”
Then: Redirect to the previous create assignment page.
</pre>
*Issue2
<pre>
Scenario: The instructor have created a new late policy and tries to go back to previous page
Given: Logged in as an instructor
When: An instructor successfully creates a new late policy, being redirected to the “/late_policies” webpage with all information of late policies.
And: The instructor clicks “Back” button
Then: The instructor is redirected to the previous create/edit assignment page.
</pre>
*Issue3: After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
<pre>
Scenario: The instructor create a new assignment with a late policy applied
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment”, enter informations for the new assignment
And: Click “Save” and refresh/redirect to the assignment edit page
Then: The checkbox for the late policy should be in the state of checked.
</pre>
<pre>
Scenario: The instructor apply a late policy to an assignment with no late policy applied yet
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” and goes to an assignment’s edit page
And: The assignment should not has late policy applied before
Then: As the instructor applies late policy to the assignment and refresh/redirect to the assignment edit page, the checkbox for the late policy should be in the state of checked.
</pre>
*Issue4: Show indication and proof about late policies at student’s side
<pre>
Scenario: A student wants to know late policies related to his assignments
Given: Logged in as a student
When: The student clicks “Assignments” from navbar
And: Select an assignment and redirect to the assignment’s detail page (“student_task/view”)
Then: There should be a section parallel with sections like “Signup sheet” and “Your score”, with the name of “Late policy”. As the student clicks on it, the website redirects to the assignment’s late policy detail page.
</pre>
*Issue5: Add “Late policies” inside the “Mange…” section from instructors’ navbar
<pre>
Scenario: An instructor tries to view the list of all the late policies without creating a new assignment
Given: Logged in as an Instructor
When: The instructor hovers his mouse on the “Manage…” section for navbar
And: From the list below, there should be a section called “Late policies”
Then: As the instructor clicks the “Late policies” section, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue6: Add “show all late policies” button inside the “new assignment” -> “Due dates” page
<pre>
Scenario: An instructor tries to create a new assignment and apply a late policy to it
Given: Logged in as an Instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates”
And: Besides the “New late policy” button, there should be a “Show all late policies” button.
Then: As the instructor clicks the “Show all late policies” button, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue7: Adding test cases to check the late policy applied actually works to subtract points from the students.
<pre>
Scenario: Subtract points for a student who does trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment
And: It is already late for the deadline
Then: Student should get a deducted point and an information about late policy triggered
</pre>
<pre>
Scenario: Give points for a student who doesn’t trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment and the deadline is not due yet
And: The late policy exists
Then: Student should get points without late policy’s punishment
</pre>
<pre>
Scenario: Give points for a student who submit the assignment after the deadline with no late policy applied for the assignment
Given: Logged in as a Student
When: The student submit the assignment and the deadline is already due
And: The late policy does not exist
Then: Student should get points without any punishment
</pre>

=== Manual Testing ===
'''Student's View in Assignment'''

'''Admin's View When Creating new Assignment'''

==Project Mentors==
* Nicholas Himes

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2236===
#[https://github.com/517-E2236/expertiza/tree/beta GitHub Repository]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-11T22:57:21Z

Yjiang35: /* RSpec Unit Tests */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 1.jpg|1200px]]

* '''Issue 2''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 2.jpg|1200px]]

* '''Issue 3''' - After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
[[File:Issue 3.png|1200px]]

* '''Issue 4''' - There is also no indication of this penalty policy for students, and no proof it actually works
[[File:Issue 4.png|1200px]]

* '''Issue 5''' - No Botton navigating to the list of all late policies
[[File:Issue 5.jpg|1200px]]

* '''Issue 6''' - When creating/editing an assignment, you can’t see the detail of each late policy
[[File:Issue 6.png|1200px]]

* '''Issue 7''' - Adding test cases to check the late policy applied actually works to subtract points from the students.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:517_Final_flow_chart.drawio.png|600px]]

=== Files to be refactored ===

* '''Issue 1'''
Check how to store assignment information into session and fix it. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 2'''
Store assignment information in session through the creation of late policies. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 3'''
Save late policy information of this assignment into database. 
1. app/views/assignments/edit/_due_dates.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 4'''
Show late policy of current assignment on student view page. 
1. app/views/student_task/view.html.erb 
2. app/controllers/student_task_controller.rb 

* '''Issue 5'''
Create buttons link to all late policies on both main page and assigment view page. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 6'''
A button link to all late policies on assignment/new page to show all policies. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 7'''
Fix the late policy function to make it work. 
1. app/controllers/late_policies_controller.rb 
2. app/controllers/assignments_controller.rb 

== Testing ==
=== Testing Goals and Test Objects ===

#When logging in as a student:
##You can see the late policy details of your assignments
##The late policy works correctly if you submit your assignment late
#When logging in as an instructor:
##There is a button to navigate you to the page showing all the late policies
##You can see the details of the late policy when creating or editing an assignment
##The "back" button will lead to a correct webpage when creating or editing an assignment
##The "Apply penalty policy" box is saved after submitting the form when creating or editing an assignment

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Issue1
<pre>
Scenario: The instructor wants to go back as he is creating a new late policy
Given: Logged in as an instructor
When: Clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates” -> “Createlate policy”
And: Clicks “Back”
Then: Redirect to the previous create assignment page.
</pre>
*Issue2
<pre>
Scenario: The instructor have created a new late policy and tries to go back to previous page
Given: Logged in as an instructor
When: An instructor successfully creates a new late policy, being redirected to the “/late_policies” webpage with all information of late policies.
And: The instructor clicks “Back” button
Then: The instructor is redirected to the previous create/edit assignment page.
</pre>
*Issue3: After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
<pre>
Scenario: The instructor create a new assignment with a late policy applied
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment”, enter informations for the new assignment
And: Click “Save” and refresh/redirect to the assignment edit page
Then: The checkbox for the late policy should be in the state of checked.
</pre>
<pre>
Scenario: The instructor apply a late policy to an assignment with no late policy applied yet
Given: Logged in as an instructor
When: The instructor clicks “Manage…” -> “Assignments” and goes to an assignment’s edit page
And: The assignment should not has late policy applied before
Then: As the instructor applies late policy to the assignment and refresh/redirect to the assignment edit page, the checkbox for the late policy should be in the state of checked.
</pre>
*Issue4: Show indication and proof about late policies at student’s side
<pre>
Scenario: A student wants to know late policies related to his assignments
Given: Logged in as a student
When: The student clicks “Assignments” from navbar
And: Select an assignment and redirect to the assignment’s detail page (“student_task/view”)
Then: There should be a section parallel with sections like “Signup sheet” and “Your score”, with the name of “Late policy”. As the student clicks on it, the website redirects to the assignment’s late policy detail page.
</pre>
*Issue5: Add “Late policies” inside the “Mange…” section from instructors’ navbar
<pre>
Scenario: An instructor tries to view the list of all the late policies without creating a new assignment
Given: Logged in as an Instructor
When: The instructor hovers his mouse on the “Manage…” section for navbar
And: From the list below, there should be a section called “Late policies”
Then: As the instructor clicks the “Late policies” section, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue6: Add “show all late policies” button inside the “new assignment” -> “Due dates” page
<pre>
Scenario: An instructor tries to create a new assignment and apply a late policy to it
Given: Logged in as an Instructor
When: The instructor clicks “Manage…” -> “Assignments” -> “Create new assignment” -> “Due dates”
And: Besides the “New late policy” button, there should be a “Show all late policies” button.
Then: As the instructor clicks the “Show all late policies” button, he gets redirected to the /late_policies with all late policies’ details.
</pre>
*Issue7: Adding test cases to check the late policy applied actually works to subtract points from the students.
<pre>
Scenario: Subtract points for a student who does trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment
And: It is already late for the deadline
Then: Student should get a deducted point and an information about late policy triggered
</pre>
<pre>
Scenario: Give points for a student who doesn’t trigger the late policy (which does exist)
Given: Logged in as a Student
When: The student submit the assignment and the deadline is not due yet
And: The late policy exists
Then: Student should get points without late policy’s punishment
</pre>
<pre>
Scenario: Give points for a student who submit the assignment after the deadline with no late policy applied for the assignment
Given: Logged in as a Student
When: The student submit the assignment and the deadline is already due
And: The late policy does not exist
Then: Student should get points without any punishment
</pre>

=== Regression Testing ===
''In order to ensure complete coverage, testing of the changes done between the end of last semester and this project will be done to ensure that ''
''old test cases still pass.''

# Make sure all existing waitlist functionality still passes

==Project Mentors==
* Nicholas Himes

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2236===
#[https://github.com/517-E2236/expertiza/tree/beta GitHub Repository]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-11T21:11:53Z

Yjiang35: /* Issues with the Current Implementation */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-11T21:11:27Z

Yjiang35: /* Manual Testing */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-11T21:09:51Z

Yjiang35: /* Testing Goals and Test Objects */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-11T20:54:21Z

Yjiang35: /* Testing Goals and Test Objects */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-11T20:53:31Z

Yjiang35: /* Milestones */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-11T20:43:24Z

Yjiang35: /* Problem Description */

File:Issue 3.png

2022-04-11T20:43:05Z

Yjiang35:

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-07T17:49:47Z

Yjiang35: /* Problem Description */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T01:54:53Z

Yjiang35: /* Project Scope */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T01:52:20Z

Yjiang35: /* Project Scope */

File:517 Final flow chart.drawio.png

2022-04-05T01:51:55Z

Yjiang35:

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T00:57:48Z

Yjiang35: /* E2236 */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T00:52:34Z

Yjiang35: /* Issues with the Current Implementation */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T00:52:06Z

Yjiang35: /* Problem Description */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T00:49:56Z

Yjiang35: /* Issues with the Current Implementation */

File:Issue 6.png

2022-04-05T00:47:36Z

Yjiang35:

File:Issue 5.jpg

2022-04-05T00:46:41Z

Yjiang35:

File:Issue 4.png

2022-04-05T00:45:41Z

Yjiang35:

File:Issue 3.jpg

2022-04-05T00:43:27Z

Yjiang35:

File:Issue 2.jpg

2022-04-05T00:43:04Z

Yjiang35:

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T00:41:40Z

Yjiang35: /* Issues with the Current Implementation */

File:Issue 1.jpg

2022-04-05T00:40:08Z

Yjiang35:

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-02T17:37:46Z

Yjiang35: /* Project Scope */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-02T17:36:18Z

Yjiang35: /* Project Scope */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-02T17:35:42Z

Yjiang35: /* Project Scope */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-02T17:33:52Z

Yjiang35: /* Issues with the Current Implementation */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-02T00:19:09Z

Yjiang35:

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-01T21:58:25Z

Yjiang35:

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:Rsz late policy.png|600px]]
 
All the issues raised mainly exist in the "Due Dates" tab on the "Edit Assignment" page.
* '''Issue 1''' - Change "penalty policy" to "late policy" on all the relevant UI screens (app/views/late_policies).
* '''Issue 2''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 3''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 4''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 5''' - Write new test cases for late_policies_controller.rb and late_policy.rb.

==Problem description, Approach & Fix==

<h4> Issue 1: Renaming penalty policy to late policy</h4>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

'''Code Snippet : '''

[[File:Issue1A.png]]

<h4> Issue 2: Issue 2: Late policies cannot be created without raising an error </h4>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
'''Code Snippet : '''

[[File:Issue2A.png]]

<h4> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page. To achieve this, we have added the assignment reference in the current session.

'''Code Snippet : '''

[[File:issue3A.png]]

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.We found out that this functionality is already working, however we added an information icon so that it is well understood by the user how to use this.

'''Code Snippet : '''

[[File:issue4A.png]]

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Added test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file for late_policies_spec.rb with appropriate test cases
</ul>

===Test Plan===
----
'''''Before fix'''''
 
 
'''Manual Testing ()'''

#[https://drive.google.com/file/d/1gpW2Y6mw-ctg5EZE4JZoSLS5mjJuIg1S/view?usp=sharing Working Demo Video]

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''''After fix'''''

The new code changes does not break existing functionality. Please check out below video which shows how all the five issues are being addressed :

#[https://drive.google.com/file/d/1gpW2Y6mw-ctg5EZE4JZoSLS5mjJuIg1S/view?usp=sharing Working Demo]

'''Automated Testing Using RSpec'''

We created two new test files, late_policy_spec.rb and late_policies_controller_spec.rb which cover test scenarios for late_policy.rb and late_policies_controller.rb repesctively.

'''late_policy_spec.rb'''

This test suite covers the two functions available in the model. Our test ensures that the model functions as expected. Most of the corner cases are being covered by controller test and thus the key to this test suite is ensuring all functionalities function as expected.

[[File:Test_1.png|600px]]

The first function in the model is for checking if for a particular instructor, the policy name already exists. For this scenario, there are two possible outcomes :
* Policy name already exists under an instructor.
* Policy name does not exists under an instructor.

Our test cases cover both of these scenarios.

[[File:Test_2.png|600px]]
[[File:Test_3.png|600px]]

The second method in this controller checks if penalty points are being updated correctly or not. One key aspect to testing this function was the mocking of the helper method. Our model depends on a helper file to update penalty points based on certain factors. Since the functionality of the model should be independent of helper behavior, we have mocked that call. The calculation of penalty is based on the type of the deadline which can have 4 possible values :
* nil
* 1
* 2
* 5

Based on each none or one of the penalty points from submission, review or meta_review gets updated. Our test suite goes through each and ensures the correct one is being updated.

'''late_policies_controller_spec.rb'''
Our controller test ensures that the controller works as expected. We have covered the test cases for each method present in the controller, Moreover, we tried to cover most of the corner cases. We have total of 14 controller test case and detailed test cases can be checked out in our pull request (#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]).

Following are few test cases :

1.) This test case covers the scenario where the penalty per unit exceeds the max penalty for an assignment.

[[File:MaxPenaltyLess.png]]

2.) Trying to create/update policy which already exists.

[[File:SamePolicy.png]]

[[File:createSamePolicy.png]]

3.) Delete the policy.

[[File:DestroyPolicy.png]]

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

Test coverage has been increased by 0.6 percentage :

[[File:Coverage.png]]

==Milestones==

==Project Mentors==
*

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-01T21:56:42Z

Yjiang35: Created page with "__TOC__ ==Problem Description== Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented..."

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:Rsz late policy.png|600px]]
 
All the issues raised mainly exist in the "Due Dates" tab on the "Edit Assignment" page.
* '''Issue 1''' - Change "penalty policy" to "late policy" on all the relevant UI screens (app/views/late_policies).
* '''Issue 2''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 3''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 4''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 5''' - Write new test cases for late_policies_controller.rb and late_policy.rb.

==Problem description, Approach & Fix==

<h4> Issue 1: Renaming penalty policy to late policy</h4>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

'''Code Snippet : '''

[[File:Issue1A.png]]

<h4> Issue 2: Issue 2: Late policies cannot be created without raising an error </h4>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
'''Code Snippet : '''

[[File:Issue2A.png]]

<h4> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page. To achieve this, we have added the assignment reference in the current session.

'''Code Snippet : '''

[[File:issue3A.png]]

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.We found out that this functionality is already working, however we added an information icon so that it is well understood by the user how to use this.

'''Code Snippet : '''

[[File:issue4A.png]]

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Added test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file for late_policies_spec.rb with appropriate test cases
</ul>

===Test Plan===
----
'''''Before fix'''''
 
 
'''Manual Testing ()'''

#[https://drive.google.com/file/d/1gpW2Y6mw-ctg5EZE4JZoSLS5mjJuIg1S/view?usp=sharing Working Demo Video]

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''''After fix'''''

The new code changes does not break existing functionality. Please check out below video which shows how all the five issues are being addressed :

#[https://drive.google.com/file/d/1gpW2Y6mw-ctg5EZE4JZoSLS5mjJuIg1S/view?usp=sharing Working Demo]

'''Automated Testing Using RSpec'''

We created two new test files, late_policy_spec.rb and late_policies_controller_spec.rb which cover test scenarios for late_policy.rb and late_policies_controller.rb repesctively.

'''late_policy_spec.rb'''

This test suite covers the two functions available in the model. Our test ensures that the model functions as expected. Most of the corner cases are being covered by controller test and thus the key to this test suite is ensuring all functionalities function as expected.

[[File:Test_1.png|600px]]

The first function in the model is for checking if for a particular instructor, the policy name already exists. For this scenario, there are two possible outcomes :
* Policy name already exists under an instructor.
* Policy name does not exists under an instructor.

Our test cases cover both of these scenarios.

[[File:Test_2.png|600px]]
[[File:Test_3.png|600px]]

The second method in this controller checks if penalty points are being updated correctly or not. One key aspect to testing this function was the mocking of the helper method. Our model depends on a helper file to update penalty points based on certain factors. Since the functionality of the model should be independent of helper behavior, we have mocked that call. The calculation of penalty is based on the type of the deadline which can have 4 possible values :
* nil
* 1
* 2
* 5

Based on each none or one of the penalty points from submission, review or meta_review gets updated. Our test suite goes through each and ensures the correct one is being updated.

'''late_policies_controller_spec.rb'''
Our controller test ensures that the controller works as expected. We have covered the test cases for each method present in the controller, Moreover, we tried to cover most of the corner cases. We have total of 14 controller test case and detailed test cases can be checked out in our pull request (#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]).

Following are few test cases :

1.) This test case covers the scenario where the penalty per unit exceeds the max penalty for an assignment.

[[File:MaxPenaltyLess.png]]

2.) Trying to create/update policy which already exists.

[[File:SamePolicy.png]]

[[File:createSamePolicy.png]]

3.) Delete the policy.

[[File:DestroyPolicy.png]]

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

Test coverage has been increased by 0.6 percentage :

[[File:Coverage.png]]

==Milestones==
'''10/25''' – Project Selection

'''11/03''' – Develop Project Design Document

'''11/06''' – Update Project Design Document based on feedback from Round 1

'''11/10''' – Divided tasks and started implementation

'''11/14''' – First review of implementation and discussion on future work

'''11/22''' – Follow up review and start with documentation update

'''11/28''' – Work completion followed by video creation

'''11/29''' – Final submission

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

CSC/ECE 517 Spring 2022

2022-04-01T21:56:26Z

Yjiang35: /* Final Projects */

== OSS Projects ==

* [[CSC/ECE 517 Spring 2022 - E2200: Testing advice_controller]]
* [[CSC/ECE 517 Spring 2022 - E2203: Adding tests for courses_controller, eula_controller]]
* [[CSC/ECE 517 Spring 2022 - E2204: Adding tests for markup_styles_controller, lock_controller]]
* [[CSC/ECE 517 Spring 2022 - E2208: Testing for submission_records_controller, profile_controller]]
* [[CSC/ECE 517 Spring 2022 - E2218: Refactor response_controller]]
* [[CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires_controller]]
* [[CSC/ECE 517 Spring 2022 - E2216: Refactor late_policies_controller]]
* [[CSC/ECE 517 Spring 2022 - E2215: Refactor student_quizzes_controller]]
* [[CSC/ECE 517 Spring 2022 - E2214: Refactor teams_controller]]
* [[CSC/ECE 517 Spring 2022 - E2219: Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2211: Testing for summary_helper]]
* [[CSC/ECE 517 Spring 2022 - E2225: Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Spring 2022 - E2221: Refactor submitted content controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2206: Testing for users_controller]]
* [[CSC/ECE 517 Spring 2022 - E2207: Testing for submitted_content_controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2205: Testing for participants_controller, versions_controller]]
* [[CSC/ECE 517 Spring 2022 - E2212: Testing for hamer.rb]]
* [[CSC/ECE 517 Spring 2022 - S2200: Refactoring evaluation of SQL queries (Java/JUnit)]]
* [[CSC/ECE 517 Spring 2022 - S2222: Refactor impersonate_controller]]
* [[CSC/ECE 517 Spring 2022 - E2202- Testing for badges_controller, publishing_controller]]
*[[CSC/ECE 517 Spring 2022 - E2220: Refactor reputation_web_service_controller]]
* [[CSC/ECE 517 Spring 2022 - E2224: Refactor review_mapping_controller]]
* [[CSC/ECE 517 Spring 2022 - E2209: Testing for analytic helper.rb, join team requests helper.rb]]
* [[CSC/ECE 517 Spring 2022 - E2227: SQL Injection Fix]]
* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2201: Testing for assignment_questionnaire_controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2243. Refactor student_teams functionality]]

== Final Projects ==
* [[CSC/ECE 517 Spring 2022 - E2245: View for results of bidding]]
* [[CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements]]
* [[CSC/ECE 517 Spring 2022 - E2237: Grading audit trail]]
* [[CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE]]
* [[CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies]]

CSC/ECE 517 Spring 2022

2022-04-01T21:56:12Z

Yjiang35: /* Final Projects */

== OSS Projects ==

* [[CSC/ECE 517 Spring 2022 - E2200: Testing advice_controller]]
* [[CSC/ECE 517 Spring 2022 - E2203: Adding tests for courses_controller, eula_controller]]
* [[CSC/ECE 517 Spring 2022 - E2204: Adding tests for markup_styles_controller, lock_controller]]
* [[CSC/ECE 517 Spring 2022 - E2208: Testing for submission_records_controller, profile_controller]]
* [[CSC/ECE 517 Spring 2022 - E2218: Refactor response_controller]]
* [[CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires_controller]]
* [[CSC/ECE 517 Spring 2022 - E2216: Refactor late_policies_controller]]
* [[CSC/ECE 517 Spring 2022 - E2215: Refactor student_quizzes_controller]]
* [[CSC/ECE 517 Spring 2022 - E2214: Refactor teams_controller]]
* [[CSC/ECE 517 Spring 2022 - E2219: Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2211: Testing for summary_helper]]
* [[CSC/ECE 517 Spring 2022 - E2225: Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Spring 2022 - E2221: Refactor submitted content controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2206: Testing for users_controller]]
* [[CSC/ECE 517 Spring 2022 - E2207: Testing for submitted_content_controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2205: Testing for participants_controller, versions_controller]]
* [[CSC/ECE 517 Spring 2022 - E2212: Testing for hamer.rb]]
* [[CSC/ECE 517 Spring 2022 - S2200: Refactoring evaluation of SQL queries (Java/JUnit)]]
* [[CSC/ECE 517 Spring 2022 - S2222: Refactor impersonate_controller]]
* [[CSC/ECE 517 Spring 2022 - E2202- Testing for badges_controller, publishing_controller]]
*[[CSC/ECE 517 Spring 2022 - E2220: Refactor reputation_web_service_controller]]
* [[CSC/ECE 517 Spring 2022 - E2224: Refactor review_mapping_controller]]
* [[CSC/ECE 517 Spring 2022 - E2209: Testing for analytic helper.rb, join team requests helper.rb]]
* [[CSC/ECE 517 Spring 2022 - E2227: SQL Injection Fix]]
* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2201: Testing for assignment_questionnaire_controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2243. Refactor student_teams functionality]]

== Final Projects ==
* [[CSC/ECE 517 Spring 2022 - E2245: View for results of bidding]]
* [[CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements]]
* [[CSC/ECE 517 Spring 2022 - E2237: Grading audit trail]]
* [[CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE]]
* [[CSC/ECE 517 Spring 2022 - E2236. Fix issues related to deadlines and late policies]]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:24:28Z

Yjiang35: /* Conclusion */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<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
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
Here is the link for the screenshots of the coverage:
[https://i.imgur.com/IYDSPU3.png Versions Controller Test Coverage]

[https://i.imgur.com/IwDWIcy.png Participants Controller Test Coverage]

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:11:20Z

Yjiang35: /* Test for Participants Controller */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<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
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:06:52Z

Yjiang35: /* Test for Participants Controller */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<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
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T00:51:32Z

Yjiang35: /* Test for Participants Controller */

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T00:49:57Z

Yjiang35: /* Test for Participants Controller */

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T00:27:29Z

Yjiang35: /* Test for Versions Controller */

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T00:25:49Z

Yjiang35: /* Test for Versions Controller */

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T00:23:27Z

Yjiang35: /* Test for Versions Controller */