Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:28:27Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

''' Flowchart:'''

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====

If the email id is not associated with any existing account, then email count will be zero

[[File:Reset negative.PNG|center|border]]

If the email id is associated with an existing account, then email count will be one

[[File:Reset positive.PNG|center|border]]

=== Scenario 3. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

=== Scenario 4. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

This method calls the email function to notify the reviewee
[[File:Reviewee2.PNG|center|border]]
 

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:26:00Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====

If the email id is not associated with any existing account, then email count will be zero

[[File:Reset negative.PNG|center|border]]

If the email id is associated with an existing account, then email count will be one

[[File:Reset positive.PNG|center|border]]

=== Scenario 3. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

=== Scenario 4. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewee2.PNG|center|border]]
 

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:24:27Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====

If the email id is not associated with any existing account, then email count will be zero

[[File:Reset negative.PNG|center|border]]

If the email id is associated with an existing account, then email count will be one

[[File:Reset positive.PNG|center|border]]

=== Scenario 3. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

=== Scenario 4. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewee2.PNG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

File:Reviewee2.PNG

2019-12-07T06:24:16Z

Vpshah:

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:23:16Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====

If the email id is not associated with any existing account, then email count will be zero

[[File:Reset negative.PNG|center|border]]

If the email id is associated with an existing account, then email count will be one

[[File:Reset positive.PNG|center|border]]

=== Scenario 3. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

=== Scenario 4. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewee.PNG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

File:Reviewee.PNG

2019-12-07T06:22:43Z

Vpshah: uploaded a new version of "File:Reviewee.PNG"

Issue2 screenshot

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:14:50Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====

If the email id is not associated with any existing account, then email count will be zero

[[File:Reset negative.PNG|center|border]]

If the email id is associated with an existing account, then email count will be one

[[File:Reset positive.PNG|center|border]]

=== Scenario 3. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

=== Scenario 4. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

File:Reset positive.PNG

2019-12-07T06:07:39Z

Vpshah:

File:Reset negative.PNG

2019-12-07T06:07:29Z

Vpshah:

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:00:10Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:52:45Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

[[File:Instructor create.PNG|center|border]]

*User creation by user request 

[[File:User request1.PNG|center|border]]

[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

[[File:User request3.PNG|center|border]]

[[File:User request4.PNG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:47:22Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:Instructor create.PNG|center|border]]
user creation by user request 
email count should be zero when user requests account with an invalid email address
[[File:User request1.PNG|center|border]]
email count should be one when user requests account with a valid email address
[[File:User request2.PNG|center|border]]
user creation by importing csv files 
[[File:User request3.PNG|center|border]]
[[File:User request4.PNG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[Review_r_!.JPG|center|border]]
 
[[File:Review_r_@.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

File:User request4.PNG

2019-12-07T05:46:28Z

Vpshah:

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:41:50Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:Instructor create.PNG|center|border]]
user creation by user request 
email count should be zero when user requests account with an invalid email address
[[File:User request1.PNG|center|border]]
email count should be one when user requests account with a valid email address
[[File:User request2.PNG|center|border]]
user creation by importing csv files 
[[File:User request3.PNG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[Review_r_!.JPG|center|border]]
 
[[File:Review_r_@.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

File:User request3.PNG

2019-12-07T05:41:00Z

Vpshah:

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:37:06Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:Instructor create.PNG|center|border]]
user creation by user request 
email count should be zero when user requests account with an invalid email address
[[File:User request1.PNG|center|border]]
email count should be one when user requests account with a valid email address
[[File:User request2.PNG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[Review_r_!.JPG|center|border]]
 
[[File:Review_r_@.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:36:11Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:Instructor create.PNG|center|border]]
user creation by user request 
[[File:User request1.PNG|center|border]]
[[File:User request2.PNG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[Review_r_!.JPG|center|border]]
 
[[File:Review_r_@.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

File:User request2.PNG

2019-12-07T05:35:24Z

Vpshah:

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:30:56Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:Instructor create.PNG|center|border]]
user creation by user request 
[[File:User request1.PNG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[Review_r_!.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

File:User request1.PNG

2019-12-07T05:29:54Z

Vpshah:

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:21:53Z

Vpshah: /* Code Snippet */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:Instructor create.PNG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

File:Instructor create.PNG

2019-12-07T05:21:06Z

Vpshah:

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:07:53Z

Vpshah: /* Implementation */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:07:40Z

Vpshah: /* Implementation */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

We have implemented tests for the following scenarios:

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:03:19Z

Vpshah: /* Reviewer gets mail when authors resubmit work */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:02:05Z

Vpshah: /* Authors get mail on receiving review */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:01:35Z

Vpshah: /* Resetting Password */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:00:48Z

Vpshah: /* Creating a new user Account */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:00:36Z

Vpshah: /* Creating a new user Account */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:57:31Z

Vpshah: /* Capybara Tests */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:56:41Z

Vpshah: /* Cases Tested */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

I. create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

II. user requests a new account and account is created upon approval from superadmin 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:51:57Z

Vpshah: /* Cases Tested */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of the email functionality when a new user is created
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

I. create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

II. user requests a new account and account is created upon approval from superadmin 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:50:58Z

Vpshah: /* Capybara Tests */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of the email functionality when creating a new user
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

I. create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

II. user requests a new account and account is created upon approval from superadmin 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:50:08Z

Vpshah: /* Capybara Tests */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of the email functionality when creating a new user
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

I. Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

II. create user through instructor filling up the form: 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:49:10Z

Vpshah: /* Capybara Tests */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of the email functionality when creating a new user
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

i. Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

ii) create user through instructor filling up the form: 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:46:52Z

Vpshah: /* Capybara Tests */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of the email functionality when creating a new user
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====
[[File:New_user.JPG|center|border]]
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:46:14Z

Vpshah: /* Capybara Tests */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of the email functionality when creating a new user
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====
[[File:New_user.JPG|center|border]]
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:45:22Z

Vpshah: /* Outcome */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of the email functionality when creating a new user
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====
[[File:New_user.JPG|center|border]]
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:42:58Z

Vpshah: /* Cases Tested */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of the email functionality when creating a new user
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====
[[File:New_user.JPG|center|border]]
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:42:43Z

Vpshah: /* Cases Tested */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of the email functionality when creating a new user
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#Email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====
[[File:New_user.JPG|center|border]]
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:36:26Z

Vpshah: /* Creating a new user Account */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of user creating user in case (i) and case (ii) mentioned above 
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases as it blocks while testing specific to scenario ii: 
#no email should be sent if new account requested with invalid email address 
# super admin should receive email about new account request with a valid email address 
# email notification should be sent to requester when super admin approves account creation request 
# email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:35:33Z

Vpshah: /* Cases Tested */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

The following features were checked as part of user creating user in case (i) and case (ii) mentioned above 
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases as it blocks while testing specific to scenario ii: 
#no email should be sent if new account requested with invalid email address 
# super admin should receive email about new account request with a valid email address 
# email notification should be sent to requester when super admin approves account creation request 
# email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:34:48Z

Vpshah: /* Cases Tested */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
==== Cases Tested ====

Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

The following features were checked as part of user creating user in case (i) and case (ii) mentioned above 
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases as it blocks while testing specific to scenario ii: 
#no email should be sent if new account requested with invalid email address 
# super admin should receive email about new account request with a valid email address 
# email notification should be sent to requester when super admin approves account creation request 
# email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:30:43Z

Vpshah: /* Cases Tested */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
==== Cases Tested ====

Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

The following features were checked as part of user creating user in case (i) and case (ii) mentioned above 
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

We considered the following cases as it blocks while testing specific to scenario ii: 
#no email should be sent if new account requested with invalid email address 
# super admin should receive email about new account request with a valid email address 
# email notification should be sent to requester when super admin approves account creation request 
# email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:30:07Z

Vpshah: /* Cases Tested */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
==== Cases Tested ====

Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

The following features were checked as part of user creating user in case (i) and case (ii) mentioned above 
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

We considered the following cases as it blocks while testing specific to scenario ii: 
#no email should be sent if new account requested with invalid email address 
# super admin should receive email about new account request with a valid email address 
# email notification should be sent to requester when super admin approves account creation request 
# email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:28:51Z

Vpshah:

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
==== Cases Tested ====

Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

The following features were checked as part of user creating user in case (i) and case (ii) mentioned above 
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

We considered the following cases as it blocks while testing specific to scenario ii: 
#no email should be sent if new account requested with invalid email address 
# super admin should receive email about new account request with a valid email address 
# email notification should be sent to requester when super admin approves account creation request 
# email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:26:20Z

Vpshah:

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
==== Cases Tested ====

Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

The following features were checked as part of user creating user in case (i) and case (ii) mentioned above 
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

We considered the following cases as it blocks while testing specific to scenario ii: 
#no email should be sent if new account requested with invalid email address 
# super admin should receive email about new account request with a valid email address 
# email notification should be sent to requester when super admin approves account creation request 
# email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:23:34Z

Vpshah:

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
==== Cases Tested ====

Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

The following features were checked as part of user creating user in case (i) and case (ii) mentioned above 
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

We considered the following cases as it blocks while testing specific to scenario ii: 
#no email should be sent if new account requested with invalid email address 
# super admin should receive email about new account request with a valid email address 
# email notification should be sent to requester when super admin approves account creation request 
# email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.
==== What we fixed====
# Author receiving email
#
==== Outcome ====

==== Code Snippet ====

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:19:49Z

Vpshah: /* Developed By */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
==== Cases Tested ====

Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

The following features were checked as part of user creating user in case (i) and case (ii) mentioned above 
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

We considered the following cases as it blocks while testing specific to scenario ii: 
#no email should be sent if new account requested with invalid email address 
# super admin should receive email about new account request with a valid email address 
# email notification should be sent to requester when super admin approves account creation request 
# email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
==== What we fixed====
==== Outcome ====
==== Code Snippet ====

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T03:31:02Z

Vpshah: /* Approach Chosen and Why? Implementation */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
==== Cases Tested ====

Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

The following features were checked as part of user creating user in case (i) and case (ii) mentioned above 
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

We considered the following cases as it blocks while testing specific to scenario ii: 
#no email should be sent if new account requested with invalid email address 
# super admin should receive email about new account request with a valid email address 
# email notification should be sent to requester when super admin approves account creation request 
# email notification should be sent to requester when super admin rejects account creation request 
 

==== Outcome ====
We used Capybara to model the scenario as follows: 
#Create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

==== Code Snippet ====

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author Review ===
==== What we fixed====
==== Outcome ====
==== Code Snippet ====

== Developed By ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]