E2157. Fix issues related to deadlines and late policies

2021-11-02T21:59:47Z

Vsharma7: Updating test plan

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

This Project will be continuation on the previous work done at #[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1978._Fix_issues_related_to_deadlines_and_late_policies E1978]

* '''Issue 1''' - Code is missing comments.

* '''Issue 2''' - Two flash messages were removed which were conveying what went wrong.

* '''Issue 3''' - late_policy.rb and late_policies_controller.rb doesn't have any tests.

* '''Issue 4''' - have a test to check the min penalty as well rather than just the cap.

==Approach & Fix==

<h4> Issue 1: Code is missing comments.</h4>
Adding comments to the late policy code flow for better readability.

<h4> Issue 2: Two flash messages were removed which were conveying what went wrong. </h4>
Ensure that all correct error messages are flashed to the user.

<h4> Issue 3: 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>
Add test file for late_policies_controller_spec.rb with appropriate test cases
Add test file for late_policies_spec.rb with appropriate test cases

<h4> Issue 4: have a test to check the min penalty as well rather than just the cap and make sure all checks pass </h4>
Add new test cases wherever required in the code and increase the test coverage and also ensure all existing test cases are passing and functionality
is working as expected.

<br>

==Expected Results==
We expect the new code changes should not break existing functionality and the following results upon completion:
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

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>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Automated Testing Using Capybara'''

We plan to create UI test framework using Capybara with Cucumber that automates the manual testing path and saves time and repetitive effort. These tests will be written prior to code and define the expected behavior of policy controller.

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

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

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

'''10/26''' – Develop Project Design Document

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]

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

E2145. OSS Project Beige

2021-10-16T20:47:46Z

Vsharma7: second draft. updated wip feilds.

This wiki page provides description of changes made under E2145 OSS assignment for Fall 2021, CSC/ECE 517.

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==
When a participant updates the submission after the reading the review comments, the reviewer will have to review it again when the second review cycle starts. However, since the reviewer may have multiple submissions to review, some of which are updated, and some that are not, it becomes difficult for the reviewer to identify the updated submissions that need attention. Currently there is no way of identifying the difference between updated and stale submissions.

==Proposed Solution==
For identifying the submission status of the project in next review cycle, the reviewer should be able to quickly identify the submissions that need attention. This can be done in the UI of the reviewer’s page. The submissions can be color-coded using a scheme like the one used in the “Review Report” page.
* <span style="color:red">Red</span> – If the review has not been started
* <span style="color:orange">Orange</span> – If the review was started, but not completed
* <span style="color:brown">Brown</span> – Submission has been reviewed

This solution will allows reviewers to identify and prioritize their work without having to dig deep into individual submissions.

==Tasks==
The following would be the key tasks:
* Add a new model to track the status of a review
* Upon change of review stage, update the data in the database.
* Change color in the UI based on the status of the review.

==Implementation==
===List of Changes===
WIP

==Testing==
===Rspec===
WIP

===UI Testing===
WIP

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

Expertiza_Wiki - User contributions [en]

E2157. Fix issues related to deadlines and late policies

E2145. OSS Project Beige