Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2016 E1687 Instructor account creation over the web

2016-12-05T04:57:43Z

Spotta: /* Screencast */

'''E1687. Instructor Account Creation Over the Web'''

This page gives a detail of the final project of creating an instructor account over the web in Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Problem Statement''' ==
In Expertiza, user and instructor accounts are currently created by existing super administrators, instructors or TAs. For new users to access the system and experiment the features offered by Expertiza, a “demo-like” feature needs to implemented. The following are the set of requirements that needs to be catered with this feature:
#Allow people to request instructor accounts over the web. This feature should also have security features such as Captchas to help avoid account creation by bots.
#When a user account is created over the web, the super-admin should get e-mail regarding the same and also the user should be notified upon approval/denial (if denied, then reason should be specified).
#Currently, Expertiza consists of a lot of entities that can be made publicly visible to all other users in the system. But, accounts created this way should not be able to see existing public features, until the super-admin manually gives them permission to view public courses, assignments, and questionnaires.
#A user who creates an account over the web should be pointed to an instruction page and/or video on how to create an assignment and register students for it, etc.

=='''Implementation'''==
The following solutions shall be addressing the problems discussed above.
===Problem 1===
Once a user wants to register and try the features of Expertiza, upon opening the website, one can register by filling up the form and click the register button. There is a captcha that shall be shown below, to make sure that it isn't any bot that is accessing. It provides security to the application.

===Problem 2===
Once the user requests for an account creation, the super admin receives a mail informing about the request with the name of the requested user. The super admin shall then, look for the details of the user in the Requests tab and can either approve/decline the request. Once the super admin approves the user request, the user gets a mail notifying the same. If the request is rejected, then the reason should be mentioned in the reason tab of the form. But there is no mail sent to the user regarding that.

===Problem 3===
There shall be a flash message saying, “Login denied. Needs permission from super admin” that can be seen on the login page if an unregistered user tries to access the features of Expertiza. This helps in removing the access to few publicly visible features as it denies access completely.

===Problem 4===
Once the user account is approved by the super admin and the user tries to login upon notification, he/she shall be redirected to an “Instructions” page on successful login.

This page shall contain the video tutorials explaining various features of Expertiza and also on how to access them.

=='''Files changed'''==
The following are the list of files that were created/edited throughout the project.
* views/auth/_login.html.erb
* views/users/request_new.html.erb
* views/users/review.html
* views/instructions/home.html.erb
* views/users/edit.html.erb
* views/mailer/request_user_message.html.erb
* views/users/new.html.erb
* views/users/_password.html.erb
* views/users/_user.html.erb
* users_controller.rb
* routes.rb
* models
* mailer_helper.rb
* mailer.rb
* models/requested_user.rb
* config/initializers/recaptcha.rb

In '''_login.html.erb''' a new button called Request Sign Up was added for the new users to register. The register page will look as above. On clicking '''Request sign up''', a user will be redirected to a page like below:

[[File:login_screen.png]]

User will have to fill up all the required details and request a signup.
When a super administrator logins to his account he can go to '''Manage/users/review requested users''' menu as shown below
[[File:Approval_new2.png]]

Super Admin can either approve/reject a user. The view for this page would be as shown below.
[[File:req_approval.png]]

In addition to the above files a new file in instructions, named home.html.erb is created which will have all the videos explaining how Expertiza works.

In '''users_controller.rb''' we will be having two new methods. One method (request_user_create) to the new user to request for an account in Expertiza and also mail all the super admins about the new user request. Other method (create_approved_user) is for the super admin to either approve or reject the user request and send a mail to the requested user if his/her account is created. The mail also contains a password for the user to login.

The codes for each method are:

<pre>
def request_user_create
@user = RequestedUser.new(user_params)
@user.institution_id = params[:user][:institution_id]
@user.status = 'Under Review'
#The super admin receives a mail about a new user request with the user name
if verify_recaptcha(model: @user) && @user.save
@super_users = User.joins(:role).where('roles.name' =>'Super-Administrator');
@super_users.each do |super_user|
prepared_mail = MailerHelper.send_mail_to_all_super_users(super_user,@user, "New account Request")
prepared_mail.deliver
end
flash[:success] = "User signup for \"#{@user.name}\" has been successfully requested. "
redirect_to '/instructions/home'
else
flash[:error] = "Error requesting sign up "
redirect_to :controller => 'users', :action => 'request_new', :role=>"Student"
end
end

</pre>

<pre>
def create_approved_user
@user = RequestedUser.find params[:id]
@user.status=params[:status]
@user.reason=params[:reason]
if @user.status.nil?
flash[:error] = "Please Approve or Reject before submitting"
elsif @user.update_attributes(params[:user])
flash[:success] = "The user \"#{@user.name}\" has been successfully updated."
end
if @user.status=="Approved"
check = User.find_by_name(@user.name)
@usernew = User.new()
@usernew.name = @user.name
@usernew.role_id = @user.role_id
@usernew.institution_id = @user.institution_id
@usernew.fullname = @user.fullname
@usernew.email = @user.email
# record the person who created this new user
@usernew.parent_id = session[:user].id
# set the user's timezone to its parent's
@usernew.timezonepref = User.find(@usernew.parent_id).timezonepref

if @usernew.save
password = @usernew.reset_password # the password is reset
# Mail is sent to the user with a new password
prepared_mail = MailerHelper.send_mail_to_user(@usernew, "Your Expertiza account and password
have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
if @usernew.role.name == "Instructor" or @usernew.role.name == "Administrator"
AssignmentQuestionnaire.create(user_id: @user.id)
end
undo_link("The user \"#{@user.name}\" has been successfully created. ")
else
foreign
end
else
if @user.status=="Rejected"
#If the user request has been rejected, a flash message is shown and redirected to review page
if @user.update_columns(reason: params[:reason], status: params[:status])
flash[:success] = "The user \"#{@user.name}\" has been Rejected."
redirect_to action: 'review'
return
else
flash[:error] = "Error processing request."
end
end

end
redirect_to action: 'review'
end
</pre>

=='''Database Changes'''==

We have created a new table called '''requested_users''' with table description that is similar to '''users'''. The status column, which isn't present in the users tables indicates the approval/rejection of the request of the user. The description of the table is as follows:

[[File:Requested_user_db.png‎ ]]

=='''Screencast'''==

Screencast [https://youtu.be/Ro8YVQgdgIg link] to our demonstration

=='''Test Plan'''==

We will be testing each of the functionality separately.

1. Test all views - will be testing if '''_login.html.erb''' and '''Request_new.html.erb''' are rendered properly.

2. Test all controller methods. New test cases will be included for each case:
* Does '''create_approved_user''' actually create a new user
* Does '''request_user_create''' actually not create a new user request

3. Test the model '''requested_user''' so that no invalid entries (blank email ID, blank name etc.) are accepted.

4. Test the mailer to verify if the body, subject, the mail id sent to/from are correctly functioning.

CSC/ECE 517 Fall 2016 E1687 Instructor account creation over the web

2016-12-04T23:54:41Z

Spotta: /* Files changed */

'''E1687. Instructor Account Creation Over the Web'''

This page gives a detail of the final project of creating an instructor account over the web in Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Problem Statement''' ==
In Expertiza, user and instructor accounts are currently created by existing super administrators, instructors or TAs. For new users to access the system and experiment the features offered by Expertiza, a “demo-like” feature needs to implemented. The following are the set of requirements that needs to be catered with this feature:
#Allow people to request instructor accounts over the web. This feature should also have security features such as Captchas to help avoid account creation by bots.
#When a user account is created over the web, the super-admin should get e-mail regarding the same and also the user should be notified upon approval/denial (if denied, then reason should be specified).
#Currently, Expertiza consists of a lot of entities that can be made publicly visible to all other users in the system. But, accounts created this way should not be able to see existing public features, until the super-admin manually gives them permission to view public courses, assignments, and questionnaires.
#A user who creates an account over the web should be pointed to an instruction page and/or video on how to create an assignment and register students for it, etc.

=='''Implementation'''==
The following solutions shall be addressing the problems discussed above.
===Problem 1===
Once a user wants to register and try the features of Expertiza, upon opening the website, one can register by filling up the form and click the register button. There is a captcha that shall be shown below, to make sure that it isn't any bot that is accessing. It provides security to the application.

===Problem 2===
Once the user requests for an account creation, the super admin receives a mail informing about the request with the name of the requested user. The super admin shall then, look for the details of the user in the Requests tab and can either approve/decline the request. Once the super admin approves the user request, the user gets a mail notifying the same. If the request is rejected, then the reason should be mentioned in the reason tab of the form. But there is no mail sent to the user regarding that.

===Problem 3===
There shall be a flash message saying, “Login denied. Needs permission from super admin” that can be seen on the login page if an unregistered user tries to access the features of Expertiza. This helps in removing the access to few publicly visible features as it denies access completely.

===Problem 4===
Once the user account is approved by the super admin and the user tries to login upon notification, he/she shall be redirected to an “Instructions” page on successful login.

This page shall contain the video tutorials explaining various features of Expertiza and also on how to access them.

=='''Files changed'''==
The following are the list of files that were created/edited throughout the project.
* views/auth/_login.html.erb
* views/users/request_new.html.erb
* views/users/review.html
* views/instructions/home.html.erb
* views/users/edit.html.erb
* views/mailer/request_user_message.html.erb
* views/users/new.html.erb
* views/users/_password.html.erb
* views/users/_user.html.erb
* users_controller.rb
* routes.rb
* models
* mailer_helper.rb
* mailer.rb
* models/requested_user.rb
* config/initializers/recaptcha.rb

In '''_login.html.erb''' a new button called Request Sign Up was added for the new users to register. The register page will look as above. On clicking '''Request sign up''', a user will be redirected to a page like below:

[[File:login_screen.png]]

User will have to fill up all the required details and request a signup.
When a super administrator logins to his account he can go to '''Manage/users/review requested users''' menu as shown below
[[File:Approval_new2.png]]

Super Admin can either approve/reject a user. The view for this page would be as shown below.
[[File:req_approval.png]]

In addition to the above files a new file in instructions, named home.html.erb is created which will have all the videos explaining how Expertiza works.

In '''users_controller.rb''' we will be having two new methods. One method (request_user_create) to the new user to request for an account in Expertiza and also mail all the super admins about the new user request. Other method (create_approved_user) is for the super admin to either approve or reject the user request and send a mail to the requested user if his/her account is created. The mail also contains a password for the user to login.

The codes for each method are:

<pre>
def request_user_create
@user = RequestedUser.new(user_params)
@user.institution_id = params[:user][:institution_id]
@user.status = 'Under Review'
#The super admin receives a mail about a new user request with the user name
if verify_recaptcha(model: @user) && @user.save
@super_users = User.joins(:role).where('roles.name' =>'Super-Administrator');
@super_users.each do |super_user|
prepared_mail = MailerHelper.send_mail_to_all_super_users(super_user,@user, "New account Request")
prepared_mail.deliver
end
flash[:success] = "User signup for \"#{@user.name}\" has been successfully requested. "
redirect_to '/instructions/home'
else
flash[:error] = "Error requesting sign up "
redirect_to :controller => 'users', :action => 'request_new', :role=>"Student"
end
end

</pre>

<pre>
def create_approved_user
@user = RequestedUser.find params[:id]
@user.status=params[:status]
@user.reason=params[:reason]
if @user.status.nil?
flash[:error] = "Please Approve or Reject before submitting"
elsif @user.update_attributes(params[:user])
flash[:success] = "The user \"#{@user.name}\" has been successfully updated."
end
if @user.status=="Approved"
check = User.find_by_name(@user.name)
@usernew = User.new()
@usernew.name = @user.name
@usernew.role_id = @user.role_id
@usernew.institution_id = @user.institution_id
@usernew.fullname = @user.fullname
@usernew.email = @user.email
# record the person who created this new user
@usernew.parent_id = session[:user].id
# set the user's timezone to its parent's
@usernew.timezonepref = User.find(@usernew.parent_id).timezonepref

if @usernew.save
password = @usernew.reset_password # the password is reset
# Mail is sent to the user with a new password
prepared_mail = MailerHelper.send_mail_to_user(@usernew, "Your Expertiza account and password
have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
if @usernew.role.name == "Instructor" or @usernew.role.name == "Administrator"
AssignmentQuestionnaire.create(user_id: @user.id)
end
undo_link("The user \"#{@user.name}\" has been successfully created. ")
else
foreign
end
else
if @user.status=="Rejected"
#If the user request has been rejected, a flash message is shown and redirected to review page
if @user.update_columns(reason: params[:reason], status: params[:status])
flash[:success] = "The user \"#{@user.name}\" has been Rejected."
redirect_to action: 'review'
return
else
flash[:error] = "Error processing request."
end
end

end
redirect_to action: 'review'
end
</pre>

=='''Database Changes'''==

We have created a new table called '''requested_users''' with table description that is similar to '''users'''. The status column, which isn't present in the users tables indicates the approval/rejection of the request of the user. The description of the table is as follows:

[[File:Requested_user_db.png‎ ]]

=='''Screencast'''==

Screencast [https://youtu.be/4HAs8jhbkw4 link] to our demonstration

=='''Test Plan'''==

We will be testing each of the functionality separately.

1. Test all views - will be testing if '''_login.html.erb''' and '''Request_new.html.erb''' are rendered properly.

2. Test all controller methods. New test cases will be included for each case:
* Does '''create_approved_user''' actually create a new user
* Does '''request_user_create''' actually not create a new user request

3. Test the model '''requested_user''' so that no invalid entries (blank email ID, blank name etc.) are accepted.

4. Test the mailer to verify if the body, subject, the mail id sent to/from are correctly functioning.

File:Req approval.png

2016-12-04T23:54:13Z

Spotta:

CSC/ECE 517 Fall 2016 E1687 Instructor account creation over the web

2016-12-04T23:12:03Z

Spotta: /* Files changed */

'''E1687. Instructor Account Creation Over the Web'''

This page gives a detail of the final project of creating an instructor account over the web in Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Problem Statement''' ==
In Expertiza, user and instructor accounts are currently created by existing super administrators, instructors or TAs. For new users to access the system and experiment the features offered by Expertiza, a “demo-like” feature needs to implemented. The following are the set of requirements that needs to be catered with this feature:
#Allow people to request instructor accounts over the web. This feature should also have security features such as Captchas to help avoid account creation by bots.
#When a user account is created over the web, the super-admin should get e-mail regarding the same and also the user should be notified upon approval/denial (if denied, then reason should be specified).
#Currently, Expertiza consists of a lot of entities that can be made publicly visible to all other users in the system. But, accounts created this way should not be able to see existing public features, until the super-admin manually gives them permission to view public courses, assignments, and questionnaires.
#A user who creates an account over the web should be pointed to an instruction page and/or video on how to create an assignment and register students for it, etc.

=='''Implementation'''==
The following solutions shall be addressing the problems discussed above.
===Problem 1===
Once a user wants to register and try the features of Expertiza, upon opening the website, one can register by filling up the form and click the register button. There is a captcha that shall be shown below, to make sure that it isn't any bot that is accessing. It provides security to the application.

===Problem 2===
Once the user requests for an account creation, the super admin receives a mail informing about the request with the name of the requested user. The super admin shall then, look for the details of the user in the Requests tab and can either approve/decline the request. Once the super admin approves the user request, the user gets a mail notifying the same. If the request is rejected, then the reason should be mentioned in the reason tab of the form. But there is no mail sent to the user regarding that.

===Problem 3===
There shall be a flash message saying, “Login denied. Needs permission from super admin” that can be seen on the login page if an unregistered user tries to access the features of Expertiza. This helps in removing the access to few publicly visible features as it denies access completely.

===Problem 4===
Once the user account is approved by the super admin and the user tries to login upon notification, he/she shall be redirected to an “Instructions” page on successful login.

This page shall contain the video tutorials explaining various features of Expertiza and also on how to access them.

=='''Files changed'''==
The following are the list of files that were created/edited throughout the project.
* views/auth/_login.html.erb
* views/users/request_new.html.erb
* views/users/review.html
* views/instructions/home.html.erb
* views/users/edit.html.erb
* views/mailer/request_user_message.html.erb
* views/users/new.html.erb
* views/users/_password.html.erb
* views/users/_user.html.erb
* users_controller.rb
* routes.rb
* models
* mailer_helper.rb
* mailer.rb
* models/requested_user.rb
* config/initializers/recaptcha.rb

In '''_login.html.erb''' a new button called Request Sign Up was added for the new users to register. The register page will look as above. On clicking '''Request sign up''', a user will be redirected to a page like below:

[[File:login_screen.png]]

User will have to fill up all the required details and request a signup.
When a super administrator logins to his account he can go to '''Manage/users/review requested users''' menu as shown below
[[File:Approval_new2.png]]

Super Admin can either approve/reject a user. The view for this page would be as shown below.
[[File:req_approval_table.png]]

In addition to the above files a new file in instructions, named home.html.erb is created which will have all the videos explaining how Expertiza works.

In '''users_controller.rb''' we will be having two new methods. One method (request_user_create) to the new user to request for an account in Expertiza and also mail all the super admins about the new user request. Other method (create_approved_user) is for the super admin to either approve or reject the user request and send a mail to the requested user if his/her account is created. The mail also contains a password for the user to login.

The codes for each method are:

<pre>
def request_user_create
@user = RequestedUser.new(user_params)
@user.institution_id = params[:user][:institution_id]
@user.status = 'Under Review'
#The super admin receives a mail about a new user request with the user name
if verify_recaptcha(model: @user) && @user.save
@super_users = User.joins(:role).where('roles.name' =>'Super-Administrator');
@super_users.each do |super_user|
prepared_mail = MailerHelper.send_mail_to_all_super_users(super_user,@user, "New account Request")
prepared_mail.deliver
end
flash[:success] = "User signup for \"#{@user.name}\" has been successfully requested. "
redirect_to '/instructions/home'
else
flash[:error] = "Error requesting sign up "
redirect_to :controller => 'users', :action => 'request_new', :role=>"Student"
end
end

</pre>

<pre>
def create_approved_user
@user = RequestedUser.find params[:id]
@user.status=params[:status]
@user.reason=params[:reason]
if @user.status.nil?
flash[:error] = "Please Approve or Reject before submitting"
elsif @user.update_attributes(params[:user])
flash[:success] = "The user \"#{@user.name}\" has been successfully updated."
end
if @user.status=="Approved"
check = User.find_by_name(@user.name)
@usernew = User.new()
@usernew.name = @user.name
@usernew.role_id = @user.role_id
@usernew.institution_id = @user.institution_id
@usernew.fullname = @user.fullname
@usernew.email = @user.email
# record the person who created this new user
@usernew.parent_id = session[:user].id
# set the user's timezone to its parent's
@usernew.timezonepref = User.find(@usernew.parent_id).timezonepref

if @usernew.save
password = @usernew.reset_password # the password is reset
# Mail is sent to the user with a new password
prepared_mail = MailerHelper.send_mail_to_user(@usernew, "Your Expertiza account and password
have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
if @usernew.role.name == "Instructor" or @usernew.role.name == "Administrator"
AssignmentQuestionnaire.create(user_id: @user.id)
end
undo_link("The user \"#{@user.name}\" has been successfully created. ")
else
foreign
end
else
if @user.status=="Rejected"
#If the user request has been rejected, a flash message is shown and redirected to review page
if @user.update_columns(reason: params[:reason], status: params[:status])
flash[:success] = "The user \"#{@user.name}\" has been Rejected."
redirect_to action: 'review'
return
else
flash[:error] = "Error processing request."
end
end

end
redirect_to action: 'review'
end
</pre>

=='''Database Changes'''==

We have created a new table called '''requested_users''' with table description that is similar to '''users'''. The status column, which isn't present in the users tables indicates the approval/rejection of the request of the user. The description of the table is as follows:

[[File:Requested_user_db.png‎ ]]

=='''Screencast'''==

Screencast [https://youtu.be/4HAs8jhbkw4 link] to our demonstration

=='''Test Plan'''==

We will be testing each of the functionality separately.

1. Test all views - will be testing if '''_login.html.erb''' and '''Request_new.html.erb''' are rendered properly.

2. Test all controller methods. New test cases will be included for each case:
* Does '''create_approved_user''' actually create a new user
* Does '''request_user_create''' actually not create a new user request

3. Test the model '''requested_user''' so that no invalid entries (blank email ID, blank name etc.) are accepted.

4. Test the mailer to verify if the body, subject, the mail id sent to/from are correctly functioning.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-05T01:54:48Z

Spotta: UI

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic. The key point here is there should be a signup preference that should be set for the notification.

We have used the following accounts for testing:
<pre>
* Login ID - instructor6 Password - password
* Student1 ID - student5432 Password - password
* Student2 Id - student5404 Password - password
</pre>

The implementation can be seen in the video, where we covered few cases mentioned above.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfill the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

'''''' We have submitted two links to show the working of email functionality and the other one to show the tests. As suggested by the professor, this is done as an alternative to deployment. ''''''

=== Working in UI ===
The steps are given as follows:
# Sign in Expertiza using the instructor account (login credentials mentioned above)
# Go to Manage tab, then click Assignments, and click New Public Assignment
# Give all the necessary details (Name of assignment, rubrics, due dates etc..) '''Do not forget to click on Allow students to suggest topic'''
# Go to Manage assignments tab, and in the assignment you just created, click on add participants and select copy from course
# Login from student credentials (mentioned earlier) and go to the assignment that was created
# Either sign up for the topic or suggest a new one directly
# Now to instructor account and view suggestions against the assignment created
# The instructor can approve or decline
# Open the gmail account (id: expertiza.development@gmail.com, password: qwer@1234) and look for mail if approved

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-05T01:13:42Z

Spotta: /* Why these scenarios? */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic. The key point here is there should be a signup preference that should be set for the notification.

We have used the following accounts for testing:
<pre>
* Login ID - instructor6 Password - password
* Student1 ID - student5432 Password - password
* Student2 Id - student5404 Password - password
</pre>

The implementation can be seen in the video, where we covered few cases mentioned above.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

'''''' We have submitted two links to show the working of email functionality and the other one to show the tests. As suggested by the professor, this is done as an alternative to deployment. ''''''

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-05T01:13:03Z

Spotta: Videos

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic. The key point here is there should be a signup preference that should be set for the notification.

We have used the following accounts for testing:
<pre>
* Login ID - instructor6 Password - password
* Student1 ID - student5432 Password - password
* Student2 Id - student5404 Password - password
</pre>

The implementation can be seen in the video, where we covered few cases mentioned above.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

''' We have submitted two links to show the working of email functionality and the other one to show the tests. As suggested by the professor, this is done as an alternative to deployment. '''

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-05T01:12:41Z

Spotta: /* Why these scenarios? */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic. The key point here is there should be a signup preference that should be set for the notification.

We have used the following accounts for testing:
<pre>
* Login ID - instructor6 Password - password
* Student1 ID - student5432 Password - password
* Student2 Id - student5404 Password - password
</pre>

The implementation can be seen in the video, where we covered few cases mentioned above.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== ''' We have submitted two links to show the working of email functionality and the other one to show the tests. As suggested by the professor, this is done as an alternative to deployment. '''
==

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-05T01:12:15Z

Spotta: Videos

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic. The key point here is there should be a signup preference that should be set for the notification.

We have used the following accounts for testing:
<pre>
* Login ID - instructor6 Password - password
* Student1 ID - student5432 Password - password
* Student2 Id - student5404 Password - password
</pre>

The implementation can be seen in the video, where we covered few cases mentioned above.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

''' We have submitted two links to show the working of email functionality and the other one to show the tests. As suggested by the professor, this is done as an alternative to deployment. '''

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-04T16:57:30Z

Spotta: /* Email functionality */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic. The key point here is there should be a signup preference that should be set for the notification.

We have used the following accounts for testing:
<pre>
* Login ID - instructor6 Password - password
* Student1 ID - student5432 Password - password
* Student2 Id - student5404 Password - password
</pre>

The implementation can be seen in the video, where we covered few cases mentioned above.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-04T16:56:25Z

Spotta: /* Email functionality */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic. The key point here is there should be a signup preference that should be set for the notification.

We have used the following accounts for testing:
* Login ID - instructor6 Password - password
* Student1 ID - student5432 Password - password
* Student2 Id - student5404 Password - password

The implementation can be seen in the video, where we covered few cases mentioned above.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-04T16:56:03Z

Spotta: /* Email functionality */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic. The key point here is there should be a signup preference that should be set for the notification.

We have used the following accounts for testing:
* Login ID - instructor6 Password - password
* Student1 ID - student5432 Password - password
* Student2 Id - student5404 Password - password

The implementation can be seen in the video, where we covered few cases mentioned above.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-04T16:55:29Z

Spotta: /* Email functionality */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic. The key point here is there should be a signup preference that should be set for the notification.

We have used the following accounts for testing:
* Login ID - instructor6
Password - password
* Student1 ID - student5432
Password - password
* Student2 Id - student5404
Password - password

The implementation can be seen in the video, where we covered few cases mentioned above.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-04T16:53:34Z

Spotta: /* Email functionality */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic. The key point here is there should be a signup preference that should be set for the notification.

We have used the following accounts for testing:

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-04T16:42:28Z

Spotta: /* Email functionality */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
Instructor starts a new assignment with some topics
* Student signs up for one topic, suggests a new one but doesn't want to work on it. Then the student receives a mail once the instructor approves.
* Student doesn't sign up for a topic and suggests a new one. If the student opts to work on it, then on approval, a mail is sent. If the student doesn't want to work on it, then no mail is sent even on approval.
* It is a team project - if there is already a team and they come up with a new topic and want to work on it, then a mail is sent on approval. If there isn't a team and a student suggests a new topic, a topic is assigned on approval and also a team of students who choose that topic. In this case, there is no email notification.
* A team project - there is a team and they suggest a topic but choose not to work on it and also they haven't signed up for a topic. In this case, upon the acceptance of topic by the instructor, there is no email sent and they are supposed to sign up for a topic from the given set.

Irrespective of teams and topic, if someone suggests a topic anonymously, there won't be any email notification on approval of the topic.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-11-04T16:35:32Z

Spotta: email

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are:
* app/views/mailer/suggested_topic_approved_message.html.erb
* spec/features/topic_suggestion2_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There is a partial coverage of suggstion_controller using feature test and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

==='''Refactoring''' ===
There were lot of trailing spaces in the code, which are removed. Few lines were too long and one had to scroll right to go through that line. This was taken care of. We have also edited the messages, making them more readable and logical. Also, the unused methods in the code were removed.

The comments were added for future readability.

=== '''Email functionality''' ===
The email functionality which wasn't working before has been fixed. These are the cases considered:
* Instructor starts a new assignment with some topics -> Student signs up for one topic, suggests a new one but doesn't want to work on it.
Then the student receives a mail once the instructor approves.
*

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
*Test the integration of core functionalities of suggestion controller
*Have maximum code coverage
*Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“'''Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.'''” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:25:36Z

Spotta: /* On a Local Machine */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are: app/views/mailer/suggested_topic_approved_message.html.erb, suggestion_controller_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above

#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]

#Install RBENV
brew update
brew install rbenv
brew install ruby-build

#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz

#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install

#Change yml files

#Go to expertiza/config and rename secrets.yml.example to secrets.yml

#Go to expertiza/config and rename database.yml.example to database.yml

#Edit database.yml to include the root password for your local MySQL in the “password” field

#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)

#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p

#Create expertiza user
create user expertiza@localhost;

#Create the databases
create database pg_development;
create database pg_test;

#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;

#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install

#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)

#Load this sql file into pg_development database created using the method mentioned here.

#Run bundle exec rake db:migrate

#Run bundle exec rake db:test:prepare

#Run rails s

#Open browser and test localhost:3000

#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There weren't any test cases before and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
Test the integration of core functionalities of suggestion controller
Have maximum code coverage
Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:24:34Z

Spotta: /* On a Local Machine */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are: app/views/mailer/suggested_topic_approved_message.html.erb, suggestion_controller_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>
#Fork the git repository mentioned above
#Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]
#Install RBENV
brew update
brew install rbenv
brew install ruby-build
#Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz
#Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install
#Change yml files
#Go to expertiza/config and rename secrets.yml.example to secrets.yml
#Go to expertiza/config and rename database.yml.example to database.yml
#Edit database.yml to include the root password for your local MySQL in the “password” field
#Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)
#Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p
#Create expertiza user
create user expertiza@localhost;
#Create the databases
create database pg_development;
create database pg_test;
#Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;
#Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install
#Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)
#Load this sql file into pg_development database created using the method mentioned here.
#Run bundle exec rake db:migrate
#Run bundle exec rake db:test:prepare
#Run rails s
#Open browser and test localhost:3000
#Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There weren't any test cases before and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
Test the integration of core functionalities of suggestion controller
Have maximum code coverage
Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:21:44Z

Spotta: /* On a Local Machine */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are: app/views/mailer/suggested_topic_approved_message.html.erb, suggestion_controller_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

<pre>

Fork the git repository mentioned above
Clone the repository to your local machine
Install [http://brew.sh/ Homebrew]
Install RBENV
brew update
brew install rbenv
brew install ruby-build
Install dependencies
brew install aspell gcc47 libxml2 libxslt graphviz
Install gems
export JAVA_HOME=/etc/alternatives/java_sdk
bundle install
Change yml files
Go to expertiza/config and rename secrets.yml.example to secrets.yml
Go to expertiza/config and rename database.yml.example to database.yml
Edit database.yml to include the root password for your local MySQL in the “password” field
Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)
Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
mysql -uroot -p
Create expertiza user
create user expertiza@localhost;
Create the databases
create database pg_development;
create database pg_test;
Set privileges for expertiza user
grant all on pg_development.to expertiza@localhost;
grant all on pg_test.to expertiza@localhost;
Install javascript libraries
sudo apt-get install npm
sudo npm install bower
bower install
Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)
Load this sql file into pg_development database created using the method mentioned here.
Run bundle exec rake db:migrate
Run bundle exec rake db:test:prepare
Run rails s
Open browser and test localhost:3000
Login credentials
Username - instructor6
Password - password

</pre>

== '''Our Implementation''' ==
There weren't any test cases before and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
Test the integration of core functionalities of suggestion controller
Have maximum code coverage
Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:20:23Z

Spotta: /* Docker */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are: app/views/mailer/suggested_topic_approved_message.html.erb, suggestion_controller_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

The Docker has been setup on a Windows PC and steps are given below
<pre>

Start Docker on Windows

docker run --expose 3000 -p 3000:3000 -v //c//Users//Srikar//Expertiza://c//Users//Srikar//Expertiza -it winbobob/expertiza-fall2016

/etc/init.d/mysql start
mysql -uroot -p
show databases;
quit

git clone https://github.com/srikarpotta/expertiza.git
cd expertiza
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml

bundle install
rake db:migrate
sudo apt-get install npm
npm install -g bower

sudo rm /usr/bin/node
sudo ln –s /usr/bin/nodejs /usr/bin/node
bower install --allow-root
thin start

</pre>

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

* Fork the git repository mentioned above
* Clone the repository to your local machine
* Install [http://brew.sh/ Homebrew]
* Install RBENV
** brew update
** brew install rbenv
** brew install ruby-build
* Install dependencies
** brew install aspell gcc47 libxml2 libxslt graphviz
* Install gems
** export JAVA_HOME=/etc/alternatives/java_sdk
** bundle install
* Change yml files
** Go to expertiza/config and rename secrets.yml.example to secrets.yml
** Go to expertiza/config and rename database.yml.example to database.yml
** Edit database.yml to include the root password for your local MySQL in the “password” field
* Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)
* Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
** mysql -uroot -p
* Create expertiza user
** create user expertiza@localhost;
* Create the databases
** create database pg_development;
** create database pg_test;
* Set privileges for expertiza user
** grant all on pg_development.* to expertiza@localhost;
** grant all on pg_test.* to expertiza@localhost;
* Install javascript libraries
** sudo apt-get install npm
** sudo npm install bower
** bower install
* Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)
* Load this sql file into pg_development database created using the method mentioned here.
* Run bundle exec rake db:migrate
* Run bundle exec rake db:test:prepare
* Run rails s
* Open browser and test localhost:3000
* Login credentials
** Username - instructor6
** Password - password

== '''Our Implementation''' ==
There weren't any test cases before and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
Test the integration of core functionalities of suggestion controller
Have maximum code coverage
Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:19:08Z

Spotta: /* What’s next? */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are: app/views/mailer/suggested_topic_approved_message.html.erb, suggestion_controller_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

* Fork the git repository mentioned above
* Clone the repository to your local machine
* Install [http://brew.sh/ Homebrew]
* Install RBENV
** brew update
** brew install rbenv
** brew install ruby-build
* Install dependencies
** brew install aspell gcc47 libxml2 libxslt graphviz
* Install gems
** export JAVA_HOME=/etc/alternatives/java_sdk
** bundle install
* Change yml files
** Go to expertiza/config and rename secrets.yml.example to secrets.yml
** Go to expertiza/config and rename database.yml.example to database.yml
** Edit database.yml to include the root password for your local MySQL in the “password” field
* Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)
* Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
** mysql -uroot -p
* Create expertiza user
** create user expertiza@localhost;
* Create the databases
** create database pg_development;
** create database pg_test;
* Set privileges for expertiza user
** grant all on pg_development.* to expertiza@localhost;
** grant all on pg_test.* to expertiza@localhost;
* Install javascript libraries
** sudo apt-get install npm
** sudo npm install bower
** bower install
* Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)
* Load this sql file into pg_development database created using the method mentioned here.
* Run bundle exec rake db:migrate
* Run bundle exec rake db:test:prepare
* Run rails s
* Open browser and test localhost:3000
* Login credentials
** Username - instructor6
** Password - password

== '''Our Implementation''' ==
There weren't any test cases before and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
Test the integration of core functionalities of suggestion controller
Have maximum code coverage
Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.” - Edsger Dijkstra

Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:18:43Z

Spotta: /* Scenario 6 */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are: app/views/mailer/suggested_topic_approved_message.html.erb, suggestion_controller_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

* Fork the git repository mentioned above
* Clone the repository to your local machine
* Install [http://brew.sh/ Homebrew]
* Install RBENV
** brew update
** brew install rbenv
** brew install ruby-build
* Install dependencies
** brew install aspell gcc47 libxml2 libxslt graphviz
* Install gems
** export JAVA_HOME=/etc/alternatives/java_sdk
** bundle install
* Change yml files
** Go to expertiza/config and rename secrets.yml.example to secrets.yml
** Go to expertiza/config and rename database.yml.example to database.yml
** Edit database.yml to include the root password for your local MySQL in the “password” field
* Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)
* Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
** mysql -uroot -p
* Create expertiza user
** create user expertiza@localhost;
* Create the databases
** create database pg_development;
** create database pg_test;
* Set privileges for expertiza user
** grant all on pg_development.* to expertiza@localhost;
** grant all on pg_test.* to expertiza@localhost;
* Install javascript libraries
** sudo apt-get install npm
** sudo npm install bower
** bower install
* Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)
* Load this sql file into pg_development database created using the method mentioned here.
* Run bundle exec rake db:migrate
* Run bundle exec rake db:test:prepare
* Run rails s
* Open browser and test localhost:3000
* Login credentials
** Username - instructor6
** Password - password

== '''Our Implementation''' ==
There weren't any test cases before and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

==== Scenario 6 ====

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
Test the integration of core functionalities of suggestion controller
Have maximum code coverage
Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.” - Edsger Dijkstra
Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:18:29Z

Spotta: /* Scenario 5 */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are: app/views/mailer/suggested_topic_approved_message.html.erb, suggestion_controller_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

* Fork the git repository mentioned above
* Clone the repository to your local machine
* Install [http://brew.sh/ Homebrew]
* Install RBENV
** brew update
** brew install rbenv
** brew install ruby-build
* Install dependencies
** brew install aspell gcc47 libxml2 libxslt graphviz
* Install gems
** export JAVA_HOME=/etc/alternatives/java_sdk
** bundle install
* Change yml files
** Go to expertiza/config and rename secrets.yml.example to secrets.yml
** Go to expertiza/config and rename database.yml.example to database.yml
** Edit database.yml to include the root password for your local MySQL in the “password” field
* Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)
* Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
** mysql -uroot -p
* Create expertiza user
** create user expertiza@localhost;
* Create the databases
** create database pg_development;
** create database pg_test;
* Set privileges for expertiza user
** grant all on pg_development.* to expertiza@localhost;
** grant all on pg_test.* to expertiza@localhost;
* Install javascript libraries
** sudo apt-get install npm
** sudo npm install bower
** bower install
* Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)
* Load this sql file into pg_development database created using the method mentioned here.
* Run bundle exec rake db:migrate
* Run bundle exec rake db:test:prepare
* Run rails s
* Open browser and test localhost:3000
* Login credentials
** Username - instructor6
** Password - password

== '''Our Implementation''' ==
There weren't any test cases before and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

==== Scenario 5 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

=== Scenario 6 ===

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
Test the integration of core functionalities of suggestion controller
Have maximum code coverage
Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.” - Edsger Dijkstra
Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:18:15Z

Spotta: /* Scenario 4 */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are: app/views/mailer/suggested_topic_approved_message.html.erb, suggestion_controller_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

* Fork the git repository mentioned above
* Clone the repository to your local machine
* Install [http://brew.sh/ Homebrew]
* Install RBENV
** brew update
** brew install rbenv
** brew install ruby-build
* Install dependencies
** brew install aspell gcc47 libxml2 libxslt graphviz
* Install gems
** export JAVA_HOME=/etc/alternatives/java_sdk
** bundle install
* Change yml files
** Go to expertiza/config and rename secrets.yml.example to secrets.yml
** Go to expertiza/config and rename database.yml.example to database.yml
** Edit database.yml to include the root password for your local MySQL in the “password” field
* Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)
* Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
** mysql -uroot -p
* Create expertiza user
** create user expertiza@localhost;
* Create the databases
** create database pg_development;
** create database pg_test;
* Set privileges for expertiza user
** grant all on pg_development.* to expertiza@localhost;
** grant all on pg_test.* to expertiza@localhost;
* Install javascript libraries
** sudo apt-get install npm
** sudo npm install bower
** bower install
* Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)
* Load this sql file into pg_development database created using the method mentioned here.
* Run bundle exec rake db:migrate
* Run bundle exec rake db:test:prepare
* Run rails s
* Open browser and test localhost:3000
* Login credentials
** Username - instructor6
** Password - password

== '''Our Implementation''' ==
There weren't any test cases before and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

==== Scenario 4 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

=== Scenario 5 ===
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

=== Scenario 6 ===

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
Test the integration of core functionalities of suggestion controller
Have maximum code coverage
Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.” - Edsger Dijkstra
Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:17:40Z

Spotta: /* Scenario 3 */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are: app/views/mailer/suggested_topic_approved_message.html.erb, suggestion_controller_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

* Fork the git repository mentioned above
* Clone the repository to your local machine
* Install [http://brew.sh/ Homebrew]
* Install RBENV
** brew update
** brew install rbenv
** brew install ruby-build
* Install dependencies
** brew install aspell gcc47 libxml2 libxslt graphviz
* Install gems
** export JAVA_HOME=/etc/alternatives/java_sdk
** bundle install
* Change yml files
** Go to expertiza/config and rename secrets.yml.example to secrets.yml
** Go to expertiza/config and rename database.yml.example to database.yml
** Edit database.yml to include the root password for your local MySQL in the “password” field
* Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)
* Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
** mysql -uroot -p
* Create expertiza user
** create user expertiza@localhost;
* Create the databases
** create database pg_development;
** create database pg_test;
* Set privileges for expertiza user
** grant all on pg_development.* to expertiza@localhost;
** grant all on pg_test.* to expertiza@localhost;
* Install javascript libraries
** sudo apt-get install npm
** sudo npm install bower
** bower install
* Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)
* Load this sql file into pg_development database created using the method mentioned here.
* Run bundle exec rake db:migrate
* Run bundle exec rake db:test:prepare
* Run rails s
* Open browser and test localhost:3000
* Login credentials
** Username - instructor6
** Password - password

== '''Our Implementation''' ==
There weren't any test cases before and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

==== Scenario 3 ====
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

=== Scenario 4 ===
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

=== Scenario 5 ===
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

=== Scenario 6 ===

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
Test the integration of core functionalities of suggestion controller
Have maximum code coverage
Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.” - Edsger Dijkstra
Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:17:08Z

Spotta: /* Scenario 6 */

'''E1643. Refactor and Test Suggestion Controller'''

This page gives a detail of the OSS project of refactoring and testing the suggestion controller of Expertiza.

== '''Introduction''' ==
Expertiza is a Ruby on Rails based open source project. The main motive of this project is to make learning more effective through peer review. This website is a result of combined effort of both students and faculty at NC State, and is used not just by this university but also in many other universities. The website allows students to form teams and work on various projects listed by the instructor and also suggest new topics that seem interesting, though they can opt not to work on them. It also makes it easy for the instructor to add a new topic to an assignment/project, create a new project and add students to it. The time spent by TAs and instructor is greatly reduced. The key feature is peer review, where the students can review the work of others and provide feedback. This helps in improving the existing work and also provides a new way to learn. There isn’t any restriction on the format of submission as it accepts any form of submission varying from URL to wiki pages, which isn’t a common feature in other websites.

== '''Motivation''' ==
This provides a great opportunity for the students to learn through collaboration. It provides a chance to contribute to an open source project. One would take back experience of working on Rails, and testing environments like RSpec. Being one of the primary user of Expertiza, students would enhance the functionalities according to their experiences using it and can view their changes implemented real-time.

== '''Problem Statement''' ==
Our files to be modified are: app/views/mailer/suggested_topic_approved_message.html.erb, suggestion_controller_spec.rb

The current folder of suggestion_controller.rb provides a chance to suggest a new topic to work on for a project. There is also an option for the student to not work on it. One can also submit the suggestion anonymously. Once a student submits the topic, the instructor can check that in the view suggestions tab, and can either approve or reject. Once the instructor approves, the student gets a mail regarding the approval. This mail is sent only if the student doesn’t submit the topic anonymously. In the process of assigning the given suggestion as a project topic to the student, it automatically gets assigned to the whole team if the student is part of a team.

Our problem statement includes:

1. Modifying the code in accordance to rails 4 syntax

2. Send email code which was duplicated needs to be replaced by a single method

3. Fix and test the working of email functionality (an email is sent to the student who suggested the topic once the instructor approves, unless he/she sends it anonymously)

4. Write integration tests for each method in suggestion_controller.rb (including some edge cases)

== '''Setup''' ==
Before starting off with working on the Expertiza project, we need to fork the existing code from [https://github.com/expertiza/expertiza expertiza/master branch]. We are provided with 3 methods of setting up Expertiza: Docker, setting it up locally and using Expertiza image. We are describing the first two methods (the ones we used) below.

=== Docker ===

=== On a Local Machine ===
We have used MacOS, so the following steps are in regard to MacOS.
The following steps will help you setup Expertiza project in your local machine. The steps are comprehensive amalgamation of steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX Development Setup], the [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit?pli=1 document]provided and also few steps that were missed in both. The order we followed:

* Fork the git repository mentioned above
* Clone the repository to your local machine
* Install [http://brew.sh/ Homebrew]
* Install RBENV
** brew update
** brew install rbenv
** brew install ruby-build
* Install dependencies
** brew install aspell gcc47 libxml2 libxslt graphviz
* Install gems
** export JAVA_HOME=/etc/alternatives/java_sdk
** bundle install
* Change yml files
** Go to expertiza/config and rename secrets.yml.example to secrets.yml
** Go to expertiza/config and rename database.yml.example to database.yml
** Edit database.yml to include the root password for your local MySQL in the “password” field
* Install mysql (https://gist.github.com/nrollr/a8d156206fa1e53c6cd6)
* Log into MySql as root (mysql is generally present in /usr/local/mysql/bin/)
** mysql -uroot -p
* Create expertiza user
** create user expertiza@localhost;
* Create the databases
** create database pg_development;
** create database pg_test;
* Set privileges for expertiza user
** grant all on pg_development.* to expertiza@localhost;
** grant all on pg_test.* to expertiza@localhost;
* Install javascript libraries
** sudo apt-get install npm
** sudo npm install bower
** bower install
* Download the expertiza scrubbed library (https://drive.google.com/file/d/0B2vDvVjH76uEMDJhNjZVOUFTWmM/view)
* Load this sql file into pg_development database created using the method mentioned here.
* Run bundle exec rake db:migrate
* Run bundle exec rake db:test:prepare
* Run rails s
* Open browser and test localhost:3000
* Login credentials
** Username - instructor6
** Password - password

== '''Our Implementation''' ==
There weren't any test cases before and also the email functionality wasn't working. We have fixed the email functionality and also refactored parts of the code. As per our knowledge we couldn't find any code in accordance to Ruby 2 syntax.

=== '''Testing''' ===
We were tasked with writing integration test cases for suggestion_controller. We came up with 6 end-to-end test cases to test “integration” of suggestion controller with other models, controllers and views. The test script can be found [https://github.com/anubhabMajumdar/expertiza/blob/amajumd/spec/features/topic_suggestion2_spec.rb here].

==== Prerequisite ====
All the scenarios uses the following:
* Instructor6
* Student2064
* Assignment 1

==== Scenario 1 ====
Instructor6 logs in and visits assignment 1 to check suggested topics (currently empty)

<pre>

scenario "allow instructor to log in and view suggestions (suggestions should be empty) for Assignment 1" do
user = User.find_by_name('instructor6')
stub_current_user(user, user.role.name, user.role)
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_no_content "Computer Vision"
end

</pre>

==== Scenario 2 ====

Student2064 logs in -> Visits on Assignment 1 -> Clicks on new suggestion -> Submits new topic called “Computer Vision” -> Checks submission is successful -> Adds comment -> Submits comment -> Checks successful submission of comment -> Tries submitting blank comment -> Checks unsuccessful submission of blank comment -> Tries editing suggestion title and suggestion description -> Checks edit is successful -> Logs out successfully
<pre>
# Create new suggestion (Computer Vision)
fill_in 'suggestion_title', with: 'Computer Vision'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion'
select "N", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Thank you for your suggestion!"
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision"
expect(page).to have_content "Initiated"

# View the suggestion
find_link('View').click
expect(page).to have_content "View Suggested topic Computer Vision"

# Add comment
fill_in 'suggestion_comment_comments', with: 'Student2064 commenting on Computer Vision'
click_button 'Submit comment'
expect(page).to have_content "Your comment has been successfully added."
expect(page).to have_content "Student2064 commenting on Computer Vision"

# Try adding blank comment
click_button 'Submit comment'
expect(page).to have_content "There was an error adding your comment."

# Edit title and description
find_link('Edit').click
expect(page).to have_content "Edit Suggested topic Computer Vision"
fill_in 'suggestion_title', with: 'Computer Vision 2'
fill_in 'suggestion_description', with: 'This is a Computer Vision suggestion 2'
select "Y", :from => "suggestion_signup_preference"
click_button 'Submit'
expect(page).to have_content "Suggested topics for Assignment 1"
expect(page).to have_content "Computer Vision 2"
</pre>

Other scenarios that were tested are given below

=== Scenario 3 ===
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 approves the suggestion -> Student2064 logs in -> Visits Assignment 1 ->
Checks suggestion “Computer Vision” is accepted

=== Scenario 4 ===
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 -> Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor6 rejects the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks suggestion “Computer Vision” is rejected

=== Scenario 5 ===
Student2064 logs in and suggests a topic (Computer Vision) under Assignment 1 ->Instructor6 logs in and checks on Assignment 1 -> Checks that “Computer Vision” is submitted by student2064 -> Checks comment by student2064 -> Instructor votes for the suggestion -> Student2064 logs in -> Visits Assignment 1 -> Checks Instructor6 has voted for the suggestion

=== Scenario 6 ===

Student2064 logs in and visits Assignment 1 -> Suggests “Computer Vision” -> Select “No” for suggestion signup preference -> Submits suggestion -> Instructor6 logs in and visits Assignment 1 suggestions -> Approves suggestion “Computer Vision” -> Checks suggestion approved successfully

=== Why these scenarios? ===

The scenarios are carefully designed to fulfil the following criteria:
Test the integration of core functionalities of suggestion controller
Have maximum code coverage
Not to repeat scenarios developed by another contributor in topic_suggestion_spec.rb

== Conclusions ==

=== What we learnt ===
* How to read existing codebases
* Understand other people’s code before contributing
* Refactor existing code without breaking existing functionalities
* Write integration test cases

=== What’s next? ===

“Program testing can be a very effective way to show the presence of bugs, but is hopelessly inadequate for showing their absence.” - Edsger Dijkstra
Thus, the best way to uncover bugs lurking in our code is to come up with more scenarios and implement them. We have tested the most business critical scenarios and few edge cases were covered by creators of topic_suggestion_spec.rb. They only show the absence of bugs in the routes we are following to reach from point A to point B. However, many such scenarios exists which are not yet covered. We hope to extend our work further in future to cover many such scenarios.

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:13:06Z

Spotta: /* Scenario 3 */

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:08:25Z

Spotta: /* Scenario 2 */

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:07:45Z

Spotta: /* Scenario 2 */

CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller

2016-10-29T01:04:17Z

Spotta: /* Scenario 2 */