Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2015 E1582 Create integration tests for the instructor interface using capybara and rspec

2015-11-20T15:28:17Z

Hma5: /* View scores for an assignment */

== '''Purpose''' ==
This project is to create integration tests for the instructor interface of Expertiza. The UI procedures need to be tested are:
* Log in
* Create a course
* View scores for an assignment
* View review scores (“review report”)
* View author-feedback scores
* Create an assignment
** 2 rounds of review
** Has no topics / has topics
** Staggered-deadline assignments

== '''Background''' ==

=== RSpec ===
Rspec <ref>[https://en.wikipedia.org/wiki/RSpec RSpec Wiki Page]</ref> is a Behavior Driven Development (BDD) framework for Ruby. It is composed of 4 main parts <ref>[http://rspec.info/ RSpec Official Website]</ref>:
; rspec-core
: The spec runner, providing a rich command line program, flexible and customizable reporting, and an API to organize your code examples.

An example of running rspec file in terminal: <code>rspec spec/model_spec.rb </code>

; rspec-expectations
: Provides a readable API to express expected outcomes of a code example.

; rspec-mocks
: Test double framework, providing multiple types of fake objects to allow you to tightly control the environment in which your specs run.

; rspec-rails
: Supports using RSpec to test Ruby on Rails applications in place of Rails' built-in test framework.

=== Capybara ===
Capybara is a web-based automation test tool that simulates a real user to follow the scenarios of user stories.<ref>[https://github.com/jnicklas/capybara Capybara on GitHub]</ref> It could interact with app to receive pages, parse the HTML and submit forms as a user would.<ref>[https://www.youtube.com/watch?v=p7ZcZNuZ0aw Introducing cucumber & capybara on YouTube]</ref> Used with RSpec and Ruby on Rails (version 1.9 or later), capybara makes it easier to write integration tests. <ref>[http://techiferous.com/2010/04/using-capybara-in-rails-3/ Using Capybara in Rails 3]</ref> It is used on the top of an underlying web-based driver and offers a user-friendly DSL (Domain Specific Language) to describe actions executed by the underlying web driver. Such as <code>rack::test</code>, <code>selenium-webdriver</code> and <code>capybara-webkit</code>.<ref>[http://www.sitepoint.com/basics-capybara-improving-tests/ The Basics of Capybara and Improving Your Tests]</ref>

In this project, we use capybara with rspec by adding the following line:
<code> require 'capybara/rspec' </code>
Then put capybara specs in <code>spec/features</code>.
=== Integration test ===
Integration test is a software testing definition that we combine modules then test them as one group. It is an important application testing way. It is always adapted after unit testing, we need to combine different units to test the functionalities and verify that the aggregated group could deliver its output properly. The purpose of integration test is to verify the functionality of interface between interacted parts, also we can know performance of the subsystems. The integration testing has two types, big bang top down and bottom up.

* '''Big Bang'''

In this type, since all the application is combined with all major usage modules. So we test them under usage model testing, which means we can simulate the users' acts under testing environment. When doing this, we can test if all the expected components is got when we actually do the same way under production environment. It is an effective way to test the functionalities and got better coverage since we are creating the realistic scenarios. It will make sure the application can have proper output when a user does the same input.

* '''Top down and Bottom up'''

Top down and bottom up is another type of integration testing. For top down, we test the top integrated module firstly and test the ranch of it again and again, then we can test all the related modules finally. For Bottom up way, we test the most basic module at first and check the module that containing this basic module. The advantage of it is that we can find the bug easier because we will not miss any branch that we use. However, it is time consuming in this way.<ref>[https://en.wikipedia.org/wiki/Integration_testing/ Integration testing on Wikipedia]</ref>

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

Based on the project requirements, the testing can be divided into the following 6 features:
# Log in: ensure an instructor is able to login to the system
# Create a course:ensure an instuctor is able to create a course.
# View scores for an assignment: ensure that the score of a certain assignment can be viewed.
# View review scores (“review report”): ensure to view the score of a review.
# View author-feedback scores: ensure to view the score of an author feedback.
# Create an assignment: ensure to create an assignment which has two rounds of review, has a topic or does not has a topic, and has a staggered-deadline.

=== Create a course ===
* Scenario 1: create a public course
# sign in
# click "Courses" to browse the course list
# click "New public course" to create a public course
# fill in the text area, and click "Create" button
After returning to the course list, the new course we created is expected to be shown.
* Scenario 2: create a private course
# sign in
# click "Courses" to browse the course list
# click "New private course" to create a private course
# fill in the text area, and click "Create" button
After returning to the course list, the new course we created is expected to be shown.

=== View scores for an assignment ===
# sign in
# click "Assignments" to browse assignment list
# choose a certain assignment, click "View scores" button
In the grades review page, scores are expected to be shown.

=== View review scores (“review report”) ===
* Scenario 1: No review scores available
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Click ‘Show reviews’
# Check that nothing exists
# Check for dashes
*Scenario 2: Review scores available
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Check that review scores exists

=== View author-feedback scores ===
* Scenario 1: No author-feedback scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show author feedbacks’
# Check that nothing exists
*Scenario 2: Author-feedback scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show author feedbacks’
# Check that author-feedback scores exists

=References=
<references></references>

CSC/ECE 517 Fall 2015 E1582 Create integration tests for the instructor interface using capybara and rspec

2015-11-20T15:27:34Z

Hma5: /* Create a course */

CSC/ECE 517 Fall 2015 E1582 Create integration tests for the instructor interface using capybara and rspec

2015-11-20T15:27:01Z

Hma5: /* Test Plan */

== '''Purpose''' ==
This project is to create integration tests for the instructor interface of Expertiza. The UI procedures need to be tested are:
* Log in
* Create a course
* View scores for an assignment
* View review scores (“review report”)
* View author-feedback scores
* Create an assignment
** 2 rounds of review
** Has no topics / has topics
** Staggered-deadline assignments

== '''Background''' ==

=== RSpec ===
Rspec <ref>[https://en.wikipedia.org/wiki/RSpec RSpec Wiki Page]</ref> is a Behavior Driven Development (BDD) framework for Ruby. It is composed of 4 main parts <ref>[http://rspec.info/ RSpec Official Website]</ref>:
; rspec-core
: The spec runner, providing a rich command line program, flexible and customizable reporting, and an API to organize your code examples.

An example of running rspec file in terminal: <code>rspec spec/model_spec.rb </code>

; rspec-expectations
: Provides a readable API to express expected outcomes of a code example.

; rspec-mocks
: Test double framework, providing multiple types of fake objects to allow you to tightly control the environment in which your specs run.

; rspec-rails
: Supports using RSpec to test Ruby on Rails applications in place of Rails' built-in test framework.

=== Capybara ===
Capybara is a web-based automation test tool that simulates a real user to follow the scenarios of user stories.<ref>[https://github.com/jnicklas/capybara Capybara on GitHub]</ref> It could interact with app to receive pages, parse the HTML and submit forms as a user would.<ref>[https://www.youtube.com/watch?v=p7ZcZNuZ0aw Introducing cucumber & capybara on YouTube]</ref> Used with RSpec and Ruby on Rails (version 1.9 or later), capybara makes it easier to write integration tests. <ref>[http://techiferous.com/2010/04/using-capybara-in-rails-3/ Using Capybara in Rails 3]</ref> It is used on the top of an underlying web-based driver and offers a user-friendly DSL (Domain Specific Language) to describe actions executed by the underlying web driver. Such as <code>rack::test</code>, <code>selenium-webdriver</code> and <code>capybara-webkit</code>.<ref>[http://www.sitepoint.com/basics-capybara-improving-tests/ The Basics of Capybara and Improving Your Tests]</ref>

In this project, we use capybara with rspec by adding the following line:
<code> require 'capybara/rspec' </code>
Then put capybara specs in <code>spec/features</code>.
=== Integration test ===
Integration test is a software testing definition that we combine modules then test them as one group. It is an important application testing way. It is always adapted after unit testing, we need to combine different units to test the functionalities and verify that the aggregated group could deliver its output properly. The purpose of integration test is to verify the functionality of interface between interacted parts, also we can know performance of the subsystems. The integration testing has two types, big bang top down and bottom up.

* '''Big Bang'''

In this type, since all the application is combined with all major usage modules. So we test them under usage model testing, which means we can simulate the users' acts under testing environment. When doing this, we can test if all the expected components is got when we actually do the same way under production environment. It is an effective way to test the functionalities and got better coverage since we are creating the realistic scenarios. It will make sure the application can have proper output when a user does the same input.

* '''Top down and Bottom up'''

Top down and bottom up is another type of integration testing. For top down, we test the top integrated module firstly and test the ranch of it again and again, then we can test all the related modules finally. For Bottom up way, we test the most basic module at first and check the module that containing this basic module. The advantage of it is that we can find the bug easier because we will not miss any branch that we use. However, it is time consuming in this way.<ref>[https://en.wikipedia.org/wiki/Integration_testing/ Integration testing on Wikipedia]</ref>

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

Based on the project requirements, the testing can be divided into the following 6 features:
# Log in: ensure an instructor is able to login to the system
# Create a course:ensure an instuctor is able to create a course.
# View scores for an assignment: ensure that the score of a certain assignment can be viewed.
# View review scores (“review report”): ensure to view the score of a review.
# View author-feedback scores: ensure to view the score of an author feedback.
# Create an assignment: ensure to create an assignment which has two rounds of review, has a topic or does not has a topic, and has a staggered-deadline.

=== Create a course ===
* Scenario 1: create a public course
# sign in
# click "Courses" to browse course list
# click "New public course" to create a public course
# fill in the text area, and click "Create" button
After returning to the course list, the new course we created is expected to be shown.
* Scenario 2: create a private course
# sign in
# click "Courses" to browse course list
# click "New private course" to create a private course
# fill in the text area, and click "Create" button
After returning to the course list, the new course we created is expected to be shown.

=== View scores for an assignment ===
# sign in
# click "Assignments" to browse assignment list
# choose a certain assignment, click "View scores" button
In the grades review page, scores are expected to be shown.

=== View review scores (“review report”) ===
* Scenario 1: No review scores available
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Click ‘Show reviews’
# Check that nothing exists
# Check for dashes
*Scenario 2: Review scores available
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Check that review scores exists

=== View author-feedback scores ===
* Scenario 1: No author-feedback scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show author feedbacks’
# Check that nothing exists
*Scenario 2: Author-feedback scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show author feedbacks’
# Check that author-feedback scores exists

=References=
<references></references>

File:9.png

2015-11-09T20:43:04Z

Hma5:

File:8.png

2015-11-09T20:42:57Z

Hma5:

File:7.png

2015-11-09T20:42:50Z

Hma5:

File:6.png

2015-11-09T20:42:42Z

Hma5:

File:5.png

2015-11-09T20:42:33Z

Hma5:

File:4.png

2015-11-09T20:42:21Z

Hma5:

File:3.png

2015-11-09T20:38:13Z

Hma5: uploaded a new version of "File:3.png"

IS-A and HAS-A Rules of Inheritance

File:2.png

2015-11-09T20:37:51Z

Hma5: uploaded a new version of "File:2.png"

Double diamond problem

CSC/ECE 517 Fall 2015/oss E1556 CHM

2015-11-09T20:36:53Z

Hma5: /* UI test */

E1556. Refactoring SuggestionController.rb
== Project description==
This project is about testing and optimizing of SuggestionController of Expertiza system. Suggestion Controller is a module for students to suggest a new topic for their writing assignments, and instructor can approve the suggestion.

Typically, there are three cases when instructor approves the suggestion. First, if the student already has a topic and when suggesting a new topic, he chooses 'Yes' in the signup_preference, he will enroll the new suggested topic automatically after the instructor approves the suggested topic. Second, if the student is in the waitlist of a topic, and when suggesting a new topic, he chooses 'Yes' in the signup_preference, he will enroll the new suggested topic and be removed from the former waitlist. Third, if the student is in the waitlist of a topic, and when suggesting a new topic, he chooses 'No' in the signup_preference, after the instructor approves the new topic, he will remain in the waitlist of former topic, and new topic is left as 'no chooser'.

Besides, Suggestion Controller also needs to be optimized from two aspects. First, the syntax need to be upgraded from rails 3.x to rails 4.x. Second, refactoring the mailer part is necessary.
== Expertiza==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

== Optimization==
=== Syntax ===
For the code to be coordinated with Rails 4 syntax, there is one major difference between Ruby 1.9 and 1.8 need to be change in the suggestion_controller.rb.
The hash operator using the "hash rocket":
<pre>
{ :key => 'value' }
</pre>
Need to be changed into:
<pre>
{ key : 'value' }
</pre>

=== Refator ===
The approve_suggestion() method is quite long in the original code, and the send email function in the method is achieved twice, which doesn’t conform with DRY principle.

The logic of the approve_suggestion() method is described as follows. First, approve the suggestion by create a new record in the SignUpTopic model, set relative parameters, and save the new record. Then send notification to the team. In the notification part, if the student doesn’t have a team, a new team should be created and assigned to the suggested topic.
Based on the logic, the approve_suggestion() method can be clearly divided into two parts: approve suggestion part, and notification part. In the notification part, send email function can be written as a single method in order not to repeat. Besides, creating a new team can also be written as a new method.

After refactor, there are four new methods: approve, notification, create_new_team, and send_email. Approve and notification are called within approve_suggestion, while create_new_team and send_email are called within notification.
<pre>
def create_new_team
new_team = AssignmentTeam.create(name: 'Team' + @user_id.to_s + '_' + rand(1000).to_s, parent_id: @signuptopic.assignment_id, type: 'AssignmentTeam')
t_user = TeamsUser.create(team_id: new_team.id, user_id: @user_id)
SignedUpTeam.create(topic_id: @signuptopic.id, team_id: new_team.id, is_waitlisted: 0)
parent = TeamNode.create(parent_id: @signuptopic.assignment_id, node_object_id: new_team.id)
TeamUserNode.create(parent_id: parent.id, node_object_id: t_user.id)
end

def send_email
proposer = User.find(@user_id)
teams_users = TeamsUser.where(team_id: @team_id)
cc_mail_list = Array.new
teams_users.each do |teams_user|
cc_mail_list << User.find(teams_user.user_id).email if teams_user.user_id != proposer.id
end
Mailer.suggested_topic_approved_message(
{ to: proposer.email,
cc: cc_mail_list,
subject: "Suggested topic '#{@suggestion.title}' has already been approved",
body: {
approved_topic_name: @suggestion.title,
proposer: proposer.name
}
}
).deliver
end

def approve
@suggestion = Suggestion.find(params[:id])
@user_id = User.where(name: @suggestion.unityID).first.id
@team_id = TeamsUser.team_id(@suggestion.assignment_id, @user_id)
@topic_id = SignedUpTeam.topic_id(@suggestion.assignment_id, @user_id)
@signuptopic = SignUpTopic.new
@signuptopic.topic_identifier = 'S' + Suggestion.where("assignment_id = ? and id <= ?", @suggestion.assignment_id, @suggestion.id).size.to_s
@signuptopic.topic_name = @suggestion.title
@signuptopic.assignment_id = @suggestion.assignment_id
@signuptopic.max_choosers = 1;
if @signuptopic.save && @suggestion.update_attribute('status', 'Approved')
flash[:notice] = 'Successfully approved the suggestion.'
else
flash[:error] = 'Error when approving the suggestion.'
end
end

def notification
if @suggestion.signup_preference == 'Y'
#if this user do not have team in this assignment, create one for him/her and assign this topic to this team.
if @team_id.nil?
create_new_team
else #this user has a team in this assignment, check whether this team has topic or not
if @topic_id.nil?
#clean waitlists
SignedUpTeam.where(team_id: @team_id, is_waitlisted: 1).destroy_all
SignedUpTeam.create(topic_id: @signuptopic.id, team_id: @team_id, is_waitlisted: 0)
else
@signuptopic.private_to = @user_id
@signuptopic.save
#if this team has topic, Expertiza will send an email (suggested_topic_approved_message) to this team
send_email
end
end
else
#if this team has topic, Expertiza will send an email (suggested_topic_approved_message) to this team
send_email
end
end

def approve_suggestion
approve
notification
redirect_to action: 'show', id: @suggestion
end
</pre>

== Test ==
=== Rspec===
[[Rspec]] was used to conduct all the tests.
RSpec is a Behaviour-Driven Development tool for Ruby programmers. BDD is an approach to software development that combines Test-Driven Development, Domain Driven Design, and Acceptance Test-Driven Planning. RSpec helps you do the TDD part of that equation, focusing on the documentation and design aspects of TDD.

=== Test1 ===
In the first test, we are going to test the result of approving a student's suggestion topic if the student is in a waitlist. He will be removed from the waitlist and added to the new list, if he selected the signup_preference to be 'Yes'.
We choose 'Writing Assignment 1a' of 'CSC/ECE 517, Spring 2015' as test assignment. I simulate creating a new suggestion with student5717, in team 'Writing Assignment 1a Team14'.

First, log in as Student5717 and suggest a new topic, and choose 'Yes' in signup_preference.
<pre>
# Login with student5717 account
visit 'content_pages/view'
expect(page).to have_content('Welcome')
fill_in "User Name", with: "student5717"
fill_in "Password", with: "password"
click_button "SIGN IN"

# suggest a new suggestion
visit '/suggestion/new?id=711'
fill_in 'suggestion_title', with: 'RSpect'
fill_in 'suggestion_description', with: 'RSpect is a ROR test framework. It focus on function test'
# select 'suggestion_signup_preference', with: 'Y'
expect{click_button "Submit"}.to change(Suggestion, :count).by(1)
</pre>
Then, log out Student5717, and log in with 'instructor6' account, who is the manager of this course. Then approve the suggest.
<pre>
# Logout current account student5717
visit '/suggestion/new?id=711'
click_link "Logout"
expect(current_path).to eq("/")

# Login with account instructor6
visit 'content_pages/view'
expect(page).to have_content('Welcome.')
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

# approve the suggestion
expect(page).to have_content('Manage content')
visit '/suggestion/list?id=711&type=Assignment'
expect(page).to have_content('Suggested topics for Writing assignment 1a')
expect(page).to have_content('RSpect')

num = Suggestion.last.id
visit "/suggestion/"+num.to_s
expect(page).to have_content('Suggestion')
expect(page).to have_content('Title: RSpect')
click_button "Approve suggestion"
visit "/suggestion/"+num.to_s
expect(page).to have_content('status: Approved')
</pre>
Finally, check if suggestion approved successfully. I need to check topic list with 'instructor6' account logged in and check the selected topic in student5717 account.
<pre>
# check if is not in waitlist
visit "/assignments/711/edit#tabs-2"
expect(page).to have_no_content(" Writing assignment 1a_Team14 student5717 (waitlisted)")

# Logout current account instructor6
visit '/suggestion/new?id=711'
click_link "Logout"
current_path.should == "/"

# Login with student5717 account
visit 'content_pages/view'
expect(page).to have_content('Welcome')
fill_in "User Name", with: "student5717"
fill_in "Password", with: "password"
click_button "SIGN IN"

# Check if you select the topic successfully
visit '/sign_up_sheet/list?assignment_id=711'
expect(page).to have_content('Your topic(s): RSpect')
</pre>
=== Test2 ===
For the second test, Writing Assignment 1a team1, whose team id is 23781, was chosen to perform a serial of action. Team no.23781 is holding a topic: Amazon S3 and Rails. And Writing Assignment 1a team5, whose team id is 23800, is in the waiting list of this topic.
First, sign in as Student 5404 from team1, send a suggestion for new topic and indicate they want to choose their suggested topic.
<pre>
@newtopic = 'Violet and Zoe'

#sign in as student5404:
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Assignments')

#suggest a topic:
# signup_preference default to be Y
visit "/student_task/view?id=28634"
expect(page).to have_content('Submit or Review work')
visit "/suggestion/new?id=711"
expect(page).to have_content('New suggestion')
fill_in 'Title',with: @newtopic
expect{click_button "Submit"}.to change(Suggestion, :count).by(1)

#logout
click_link "Logout"
expect(current_path).to eq("/")
visit '/suggestion/new?id=711'
expect(page).to have_content('This is not allowed')
expect(page).to have_content('Welcome')
expect(page).to have_no_content('User: student5404')
</pre>

Then sign in as instructor6 and approve the suggested topic.
<pre>
#sign in as instructor6
visit 'content_pages/view'
expect(page).to have_content('Welcome.')
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Manage content')

#approve the suggestion
visit '/suggestion/list?id=711&type=Assignment'
expect(page).to have_content('Suggested topics for Writing assignment 1a')
num = Suggestion.last.id.to_s
visit "/suggestion/"+num
expect(page).to have_content('Suggestion')
expect(page).to have_content('Title: '+@newtopic)
click_button "Approve suggestion"
visit "/suggestion/"+num.to_s
expect(page).to have_content('status: Approved')

#logout as instructor6
click_link "Logout"
expect(current_path).to eq("/")
visit '/suggestion/new?id=711'
expect(page).to have_content('This is not allowed')
expect(page).to have_content('Welcome')
</pre>
Finally, to check the results. On the one hand, sign in as student5404 again and see if her/his team is holding the new topic. On the other hand sign in as instructor6 and check if team no.23800 is holding the old topic: Amazon S3 and Rails.
<pre>
#sign in as student5404:
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Assignments')

#check the approved suggestion in topics list
visit "/sign_up_sheet/list?assignment_id=711"
expect(page).to have_content("Your approved suggested topic")

# switch to the new topic
num2 = SignUpTopic.last.id.to_s
visit "/sign_up_sheet/switch_original_topic_to_approved_suggested_topic/"+num2+"?assignment_id=711"
expect(page).to have_content("Your topic(s): "+@newtopic)

#logout student5404
click_link "Logout"
expect(current_path).to eq("/")
visit '/suggestion/new?id=711'
expect(page).to have_content('This is not allowed')
expect(page).to have_content('Welcome')
expect(page).to have_no_content('User: student5404')

#sign in as instructor6
visit 'content_pages/view'
expect(page).to have_content('Welcome.')
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Manage content')

# check if team1 is has not enrolled
visit "/assignments/711/edit#tabs-2"
expect(page).to have_no_content(" Writing assignment 1a_Team1 student5404 student5731 ")
expect(page).to have_content("Writing assignment 1a_Team5 student5740 student5704")
expect(page).to have_content("S1 Violet and Zoe Writing assignment 1a_Team1 student5404 student5731")
</pre>
=== Test3 ===
The third test is similar to the second one. Team no.23781 and assignment no.711 are chosen for this test again.
First, student no.5404 login to the system, visit the assignment page, and make a topic suggestion. In the suggestion, instead of choosing “yes” in signup preference, the student chooses “no” in order not to use the suggested topic.

<pre>
visit 'content_pages/view'
fill_in "User Name", with: "student5404"
fill_in "Password", with: "password"
click_button "SIGN IN"

visit '/suggestion/new?id=711'
fill_in 'suggestion_title', with: 'test title'
fill_in 'suggestion_description', with: 'test description'
select 'No', from: "suggestion_signup_preference"
click_button "Submit"

click_link "Logout"
</pre>
After the suggestion is made, login as an instructor, find the assignment, and approve the suggestion.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

num = Suggestion.last.id
path = "/suggestion/" + num.to_s
visit path
click_button "Approve suggestion"

click_link "Logout"
</pre>
In the final step, we check if the new topic is shown in the topic list, then login as student no.5401 again, check if they still hold their old topic.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"

visit '/sign_up_sheet/list?assignment_id=711'
expect(page).to have_content('Your topic(s): Amazon S3 and Rails')
click_link "Logout"

visit 'content_pages/view'
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

visit "/assignments/711/edit#tabs-2"
expect(page).to have_content("Amazon S3 and Rails")
expect(page).to have_content("test title")
</pre>
=== Result ===
Here is the result of our tests. All test cases passed.
<pre>
ChendeMacBook-Pro:expertiza chen$ rspec spec/controllers/suggestion_controller_spec.rb
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.

Randomized with seed 8804
/Users/chen/RubymineProjects/expertiza/app/models/suggestion.rb:5: warning: circular argument reference - assignment_id
......

Deprecation Warnings:

Using `should` from rspec-expectations' old `:should` syntax without explicitly enabling the syntax is deprecated. Use the new `:expect` syntax or explicitly enable `:should` with `config.expect_with(:rspec) { |c| c.syntax = :should }` instead. Called from /Users/chen/RubymineProjects/expertiza/spec/controllers/suggestion_controller_spec.rb:67:in `block (3 levels) in <top (required)>'.

If you need more of the backtrace for any of these deprecations to
identify where to make the necessary changes, you can configure
`config.raise_errors_for_deprecations!`, and it will turn the
deprecation warnings into errors, giving you the full backtrace.

1 deprecation warning total

Finished in 1 minute 6.74 seconds (files took 5.3 seconds to load)
6 examples, 0 failures

Randomized with seed 8804

Coverage report generated for RSpec to /Users/chen/RubymineProjects/expertiza/coverage. 1638 / 5233 LOC (31.3%) covered.
[Coveralls] Outside the CI environment, not sending data.
</pre>
=== UI test ===

For instructor:




For students:


For student users, first you need to login your account, find a certain course, and make suggestion

[[File:1.png]]

Then, based on your need, choose if you want to work on the suggestion you suggested.

[[File:2.png]]

After saving, there will be a flash message on your webpage, and the suggested topic would be shown.

[[File:3.png]]

File:1.png

2015-11-09T20:36:07Z

Hma5: uploaded a new version of "File:1.png"

Distributed Version Control System

CSC/ECE 517 Fall 2015/oss E1556 CHM

2015-11-09T20:32:22Z

Hma5: /* UI test */

E1556. Refactoring SuggestionController.rb
== Project description==
This project is about testing and optimizing of SuggestionController of Expertiza system. Suggestion Controller is a module for students to suggest a new topic for their writing assignments, and instructor can approve the suggestion.

Typically, there are three cases when instructor approves the suggestion. First, if the student already has a topic and when suggesting a new topic, he chooses 'Yes' in the signup_preference, he will enroll the new suggested topic automatically after the instructor approves the suggested topic. Second, if the student is in the waitlist of a topic, and when suggesting a new topic, he chooses 'Yes' in the signup_preference, he will enroll the new suggested topic and be removed from the former waitlist. Third, if the student is in the waitlist of a topic, and when suggesting a new topic, he chooses 'No' in the signup_preference, after the instructor approves the new topic, he will remain in the waitlist of former topic, and new topic is left as 'no chooser'.

Besides, Suggestion Controller also needs to be optimized from two aspects. First, the syntax need to be upgraded from rails 3.x to rails 4.x. Second, refactoring the mailer part is necessary.
== Expertiza==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

== Optimization==
=== Syntax ===
For the code to be coordinated with Rails 4 syntax, there is one major difference between Ruby 1.9 and 1.8 need to be change in the suggestion_controller.rb.
The hash operator using the "hash rocket":
<pre>
{ :key => 'value' }
</pre>
Need to be changed into:
<pre>
{ key : 'value' }
</pre>

=== Refator ===
The approve_suggestion() method is quite long in the original code, and the send email function in the method is achieved twice, which doesn’t conform with DRY principle.

The logic of the approve_suggestion() method is described as follows. First, approve the suggestion by create a new record in the SignUpTopic model, set relative parameters, and save the new record. Then send notification to the team. In the notification part, if the student doesn’t have a team, a new team should be created and assigned to the suggested topic.
Based on the logic, the approve_suggestion() method can be clearly divided into two parts: approve suggestion part, and notification part. In the notification part, send email function can be written as a single method in order not to repeat. Besides, creating a new team can also be written as a new method.

After refactor, there are four new methods: approve, notification, create_new_team, and send_email. Approve and notification are called within approve_suggestion, while create_new_team and send_email are called within notification.
<pre>
def create_new_team
new_team = AssignmentTeam.create(name: 'Team' + @user_id.to_s + '_' + rand(1000).to_s, parent_id: @signuptopic.assignment_id, type: 'AssignmentTeam')
t_user = TeamsUser.create(team_id: new_team.id, user_id: @user_id)
SignedUpTeam.create(topic_id: @signuptopic.id, team_id: new_team.id, is_waitlisted: 0)
parent = TeamNode.create(parent_id: @signuptopic.assignment_id, node_object_id: new_team.id)
TeamUserNode.create(parent_id: parent.id, node_object_id: t_user.id)
end

def send_email
proposer = User.find(@user_id)
teams_users = TeamsUser.where(team_id: @team_id)
cc_mail_list = Array.new
teams_users.each do |teams_user|
cc_mail_list << User.find(teams_user.user_id).email if teams_user.user_id != proposer.id
end
Mailer.suggested_topic_approved_message(
{ to: proposer.email,
cc: cc_mail_list,
subject: "Suggested topic '#{@suggestion.title}' has already been approved",
body: {
approved_topic_name: @suggestion.title,
proposer: proposer.name
}
}
).deliver
end

def approve
@suggestion = Suggestion.find(params[:id])
@user_id = User.where(name: @suggestion.unityID).first.id
@team_id = TeamsUser.team_id(@suggestion.assignment_id, @user_id)
@topic_id = SignedUpTeam.topic_id(@suggestion.assignment_id, @user_id)
@signuptopic = SignUpTopic.new
@signuptopic.topic_identifier = 'S' + Suggestion.where("assignment_id = ? and id <= ?", @suggestion.assignment_id, @suggestion.id).size.to_s
@signuptopic.topic_name = @suggestion.title
@signuptopic.assignment_id = @suggestion.assignment_id
@signuptopic.max_choosers = 1;
if @signuptopic.save && @suggestion.update_attribute('status', 'Approved')
flash[:notice] = 'Successfully approved the suggestion.'
else
flash[:error] = 'Error when approving the suggestion.'
end
end

def notification
if @suggestion.signup_preference == 'Y'
#if this user do not have team in this assignment, create one for him/her and assign this topic to this team.
if @team_id.nil?
create_new_team
else #this user has a team in this assignment, check whether this team has topic or not
if @topic_id.nil?
#clean waitlists
SignedUpTeam.where(team_id: @team_id, is_waitlisted: 1).destroy_all
SignedUpTeam.create(topic_id: @signuptopic.id, team_id: @team_id, is_waitlisted: 0)
else
@signuptopic.private_to = @user_id
@signuptopic.save
#if this team has topic, Expertiza will send an email (suggested_topic_approved_message) to this team
send_email
end
end
else
#if this team has topic, Expertiza will send an email (suggested_topic_approved_message) to this team
send_email
end
end

def approve_suggestion
approve
notification
redirect_to action: 'show', id: @suggestion
end
</pre>

== Test ==
=== Rspec===
[[Rspec]] was used to conduct all the tests.
RSpec is a Behaviour-Driven Development tool for Ruby programmers. BDD is an approach to software development that combines Test-Driven Development, Domain Driven Design, and Acceptance Test-Driven Planning. RSpec helps you do the TDD part of that equation, focusing on the documentation and design aspects of TDD.

=== Test1 ===
In the first test, we are going to test the result of approving a student's suggestion topic if the student is in a waitlist. He will be removed from the waitlist and added to the new list, if he selected the signup_preference to be 'Yes'.
We choose 'Writing Assignment 1a' of 'CSC/ECE 517, Spring 2015' as test assignment. I simulate creating a new suggestion with student5717, in team 'Writing Assignment 1a Team14'.

First, log in as Student5717 and suggest a new topic, and choose 'Yes' in signup_preference.
<pre>
# Login with student5717 account
visit 'content_pages/view'
expect(page).to have_content('Welcome')
fill_in "User Name", with: "student5717"
fill_in "Password", with: "password"
click_button "SIGN IN"

# suggest a new suggestion
visit '/suggestion/new?id=711'
fill_in 'suggestion_title', with: 'RSpect'
fill_in 'suggestion_description', with: 'RSpect is a ROR test framework. It focus on function test'
# select 'suggestion_signup_preference', with: 'Y'
expect{click_button "Submit"}.to change(Suggestion, :count).by(1)
</pre>
Then, log out Student5717, and log in with 'instructor6' account, who is the manager of this course. Then approve the suggest.
<pre>
# Logout current account student5717
visit '/suggestion/new?id=711'
click_link "Logout"
expect(current_path).to eq("/")

# Login with account instructor6
visit 'content_pages/view'
expect(page).to have_content('Welcome.')
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

# approve the suggestion
expect(page).to have_content('Manage content')
visit '/suggestion/list?id=711&type=Assignment'
expect(page).to have_content('Suggested topics for Writing assignment 1a')
expect(page).to have_content('RSpect')

num = Suggestion.last.id
visit "/suggestion/"+num.to_s
expect(page).to have_content('Suggestion')
expect(page).to have_content('Title: RSpect')
click_button "Approve suggestion"
visit "/suggestion/"+num.to_s
expect(page).to have_content('status: Approved')
</pre>
Finally, check if suggestion approved successfully. I need to check topic list with 'instructor6' account logged in and check the selected topic in student5717 account.
<pre>
# check if is not in waitlist
visit "/assignments/711/edit#tabs-2"
expect(page).to have_no_content(" Writing assignment 1a_Team14 student5717 (waitlisted)")

# Logout current account instructor6
visit '/suggestion/new?id=711'
click_link "Logout"
current_path.should == "/"

# Login with student5717 account
visit 'content_pages/view'
expect(page).to have_content('Welcome')
fill_in "User Name", with: "student5717"
fill_in "Password", with: "password"
click_button "SIGN IN"

# Check if you select the topic successfully
visit '/sign_up_sheet/list?assignment_id=711'
expect(page).to have_content('Your topic(s): RSpect')
</pre>
=== Test2 ===
For the second test, Writing Assignment 1a team1, whose team id is 23781, was chosen to perform a serial of action. Team no.23781 is holding a topic: Amazon S3 and Rails. And Writing Assignment 1a team5, whose team id is 23800, is in the waiting list of this topic.
First, sign in as Student 5404 from team1, send a suggestion for new topic and indicate they want to choose their suggested topic.
<pre>
@newtopic = 'Violet and Zoe'

#sign in as student5404:
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Assignments')

#suggest a topic:
# signup_preference default to be Y
visit "/student_task/view?id=28634"
expect(page).to have_content('Submit or Review work')
visit "/suggestion/new?id=711"
expect(page).to have_content('New suggestion')
fill_in 'Title',with: @newtopic
expect{click_button "Submit"}.to change(Suggestion, :count).by(1)

#logout
click_link "Logout"
expect(current_path).to eq("/")
visit '/suggestion/new?id=711'
expect(page).to have_content('This is not allowed')
expect(page).to have_content('Welcome')
expect(page).to have_no_content('User: student5404')
</pre>

Then sign in as instructor6 and approve the suggested topic.
<pre>
#sign in as instructor6
visit 'content_pages/view'
expect(page).to have_content('Welcome.')
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Manage content')

#approve the suggestion
visit '/suggestion/list?id=711&type=Assignment'
expect(page).to have_content('Suggested topics for Writing assignment 1a')
num = Suggestion.last.id.to_s
visit "/suggestion/"+num
expect(page).to have_content('Suggestion')
expect(page).to have_content('Title: '+@newtopic)
click_button "Approve suggestion"
visit "/suggestion/"+num.to_s
expect(page).to have_content('status: Approved')

#logout as instructor6
click_link "Logout"
expect(current_path).to eq("/")
visit '/suggestion/new?id=711'
expect(page).to have_content('This is not allowed')
expect(page).to have_content('Welcome')
</pre>
Finally, to check the results. On the one hand, sign in as student5404 again and see if her/his team is holding the new topic. On the other hand sign in as instructor6 and check if team no.23800 is holding the old topic: Amazon S3 and Rails.
<pre>
#sign in as student5404:
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Assignments')

#check the approved suggestion in topics list
visit "/sign_up_sheet/list?assignment_id=711"
expect(page).to have_content("Your approved suggested topic")

# switch to the new topic
num2 = SignUpTopic.last.id.to_s
visit "/sign_up_sheet/switch_original_topic_to_approved_suggested_topic/"+num2+"?assignment_id=711"
expect(page).to have_content("Your topic(s): "+@newtopic)

#logout student5404
click_link "Logout"
expect(current_path).to eq("/")
visit '/suggestion/new?id=711'
expect(page).to have_content('This is not allowed')
expect(page).to have_content('Welcome')
expect(page).to have_no_content('User: student5404')

#sign in as instructor6
visit 'content_pages/view'
expect(page).to have_content('Welcome.')
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Manage content')

# check if team1 is has not enrolled
visit "/assignments/711/edit#tabs-2"
expect(page).to have_no_content(" Writing assignment 1a_Team1 student5404 student5731 ")
expect(page).to have_content("Writing assignment 1a_Team5 student5740 student5704")
expect(page).to have_content("S1 Violet and Zoe Writing assignment 1a_Team1 student5404 student5731")
</pre>
=== Test3 ===
The third test is similar to the second one. Team no.23781 and assignment no.711 are chosen for this test again.
First, student no.5404 login to the system, visit the assignment page, and make a topic suggestion. In the suggestion, instead of choosing “yes” in signup preference, the student chooses “no” in order not to use the suggested topic.

<pre>
visit 'content_pages/view'
fill_in "User Name", with: "student5404"
fill_in "Password", with: "password"
click_button "SIGN IN"

visit '/suggestion/new?id=711'
fill_in 'suggestion_title', with: 'test title'
fill_in 'suggestion_description', with: 'test description'
select 'No', from: "suggestion_signup_preference"
click_button "Submit"

click_link "Logout"
</pre>
After the suggestion is made, login as an instructor, find the assignment, and approve the suggestion.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

num = Suggestion.last.id
path = "/suggestion/" + num.to_s
visit path
click_button "Approve suggestion"

click_link "Logout"
</pre>
In the final step, we check if the new topic is shown in the topic list, then login as student no.5401 again, check if they still hold their old topic.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"

visit '/sign_up_sheet/list?assignment_id=711'
expect(page).to have_content('Your topic(s): Amazon S3 and Rails')
click_link "Logout"

visit 'content_pages/view'
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

visit "/assignments/711/edit#tabs-2"
expect(page).to have_content("Amazon S3 and Rails")
expect(page).to have_content("test title")
</pre>
=== Result ===
Here is the result of our tests. All test cases passed.
<pre>
ChendeMacBook-Pro:expertiza chen$ rspec spec/controllers/suggestion_controller_spec.rb
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.

Randomized with seed 8804
/Users/chen/RubymineProjects/expertiza/app/models/suggestion.rb:5: warning: circular argument reference - assignment_id
......

Deprecation Warnings:

Using `should` from rspec-expectations' old `:should` syntax without explicitly enabling the syntax is deprecated. Use the new `:expect` syntax or explicitly enable `:should` with `config.expect_with(:rspec) { |c| c.syntax = :should }` instead. Called from /Users/chen/RubymineProjects/expertiza/spec/controllers/suggestion_controller_spec.rb:67:in `block (3 levels) in <top (required)>'.

If you need more of the backtrace for any of these deprecations to
identify where to make the necessary changes, you can configure
`config.raise_errors_for_deprecations!`, and it will turn the
deprecation warnings into errors, giving you the full backtrace.

1 deprecation warning total

Finished in 1 minute 6.74 seconds (files took 5.3 seconds to load)
6 examples, 0 failures

Randomized with seed 8804

Coverage report generated for RSpec to /Users/chen/RubymineProjects/expertiza/coverage. 1638 / 5233 LOC (31.3%) covered.
[Coveralls] Outside the CI environment, not sending data.
</pre>
=== UI test ===

For instructor:




For students:


For student users, first you need to login your account, find a certain course, and make suggestion
[[File:1.png]]
Then, based on your need, choose if you want to work on the suggestion you suggested.
[[File:2.png]]
After saving, there will be a flash message on your webpage, and the suggested topic would be shown.
[[File:3.png]]

File:3.png

2015-11-09T20:31:33Z

Hma5: uploaded a new version of "File:3.png"

IS-A and HAS-A Rules of Inheritance

File:2.png

2015-11-09T20:31:11Z

Hma5: uploaded a new version of "File:2.png"

Double diamond problem

File:1.png

2015-11-09T20:26:50Z

Hma5: uploaded a new version of "File:1.png"

Distributed Version Control System

File:1.png

2015-11-09T20:25:44Z

Hma5: uploaded a new version of "File:1.png"

Distributed Version Control System

CSC/ECE 517 Fall 2015/oss E1556 CHM

2015-11-09T20:25:10Z

Hma5: /* UI test */

E1556. Refactoring SuggestionController.rb
== Project description==
This project is about testing and optimizing of SuggestionController of Expertiza system. Suggestion Controller is a module for students to suggest a new topic for their writing assignments, and instructor can approve the suggestion.

Typically, there are three cases when instructor approves the suggestion. First, if the student already has a topic and when suggesting a new topic, he chooses 'Yes' in the signup_preference, he will enroll the new suggested topic automatically after the instructor approves the suggested topic. Second, if the student is in the waitlist of a topic, and when suggesting a new topic, he chooses 'Yes' in the signup_preference, he will enroll the new suggested topic and be removed from the former waitlist. Third, if the student is in the waitlist of a topic, and when suggesting a new topic, he chooses 'No' in the signup_preference, after the instructor approves the new topic, he will remain in the waitlist of former topic, and new topic is left as 'no chooser'.

Besides, Suggestion Controller also needs to be optimized from two aspects. First, the syntax need to be upgraded from rails 3.x to rails 4.x. Second, refactoring the mailer part is necessary.
== Expertiza==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

== Optimization==
=== Syntax ===
For the code to be coordinated with Rails 4 syntax, there is one major difference between Ruby 1.9 and 1.8 need to be change in the suggestion_controller.rb.
The hash operator using the "hash rocket":
<pre>
{ :key => 'value' }
</pre>
Need to be changed into:
<pre>
{ key : 'value' }
</pre>

=== Refator ===
The approve_suggestion() method is quite long in the original code, and the send email function in the method is achieved twice, which doesn’t conform with DRY principle.

The logic of the approve_suggestion() method is described as follows. First, approve the suggestion by create a new record in the SignUpTopic model, set relative parameters, and save the new record. Then send notification to the team. In the notification part, if the student doesn’t have a team, a new team should be created and assigned to the suggested topic.
Based on the logic, the approve_suggestion() method can be clearly divided into two parts: approve suggestion part, and notification part. In the notification part, send email function can be written as a single method in order not to repeat. Besides, creating a new team can also be written as a new method.

After refactor, there are four new methods: approve, notification, create_new_team, and send_email. Approve and notification are called within approve_suggestion, while create_new_team and send_email are called within notification.
<pre>
def create_new_team
new_team = AssignmentTeam.create(name: 'Team' + @user_id.to_s + '_' + rand(1000).to_s, parent_id: @signuptopic.assignment_id, type: 'AssignmentTeam')
t_user = TeamsUser.create(team_id: new_team.id, user_id: @user_id)
SignedUpTeam.create(topic_id: @signuptopic.id, team_id: new_team.id, is_waitlisted: 0)
parent = TeamNode.create(parent_id: @signuptopic.assignment_id, node_object_id: new_team.id)
TeamUserNode.create(parent_id: parent.id, node_object_id: t_user.id)
end

def send_email
proposer = User.find(@user_id)
teams_users = TeamsUser.where(team_id: @team_id)
cc_mail_list = Array.new
teams_users.each do |teams_user|
cc_mail_list << User.find(teams_user.user_id).email if teams_user.user_id != proposer.id
end
Mailer.suggested_topic_approved_message(
{ to: proposer.email,
cc: cc_mail_list,
subject: "Suggested topic '#{@suggestion.title}' has already been approved",
body: {
approved_topic_name: @suggestion.title,
proposer: proposer.name
}
}
).deliver
end

def approve
@suggestion = Suggestion.find(params[:id])
@user_id = User.where(name: @suggestion.unityID).first.id
@team_id = TeamsUser.team_id(@suggestion.assignment_id, @user_id)
@topic_id = SignedUpTeam.topic_id(@suggestion.assignment_id, @user_id)
@signuptopic = SignUpTopic.new
@signuptopic.topic_identifier = 'S' + Suggestion.where("assignment_id = ? and id <= ?", @suggestion.assignment_id, @suggestion.id).size.to_s
@signuptopic.topic_name = @suggestion.title
@signuptopic.assignment_id = @suggestion.assignment_id
@signuptopic.max_choosers = 1;
if @signuptopic.save && @suggestion.update_attribute('status', 'Approved')
flash[:notice] = 'Successfully approved the suggestion.'
else
flash[:error] = 'Error when approving the suggestion.'
end
end

def notification
if @suggestion.signup_preference == 'Y'
#if this user do not have team in this assignment, create one for him/her and assign this topic to this team.
if @team_id.nil?
create_new_team
else #this user has a team in this assignment, check whether this team has topic or not
if @topic_id.nil?
#clean waitlists
SignedUpTeam.where(team_id: @team_id, is_waitlisted: 1).destroy_all
SignedUpTeam.create(topic_id: @signuptopic.id, team_id: @team_id, is_waitlisted: 0)
else
@signuptopic.private_to = @user_id
@signuptopic.save
#if this team has topic, Expertiza will send an email (suggested_topic_approved_message) to this team
send_email
end
end
else
#if this team has topic, Expertiza will send an email (suggested_topic_approved_message) to this team
send_email
end
end

def approve_suggestion
approve
notification
redirect_to action: 'show', id: @suggestion
end
</pre>

== Test ==
=== Rspec===
[[Rspec]] was used to conduct all the tests.
RSpec is a Behaviour-Driven Development tool for Ruby programmers. BDD is an approach to software development that combines Test-Driven Development, Domain Driven Design, and Acceptance Test-Driven Planning. RSpec helps you do the TDD part of that equation, focusing on the documentation and design aspects of TDD.

=== Test1 ===
In the first test, we are going to test the result of approving a student's suggestion topic if the student is in a waitlist. He will be removed from the waitlist and added to the new list, if he selected the signup_preference to be 'Yes'.
We choose 'Writing Assignment 1a' of 'CSC/ECE 517, Spring 2015' as test assignment. I simulate creating a new suggestion with student5717, in team 'Writing Assignment 1a Team14'.

First, log in as Student5717 and suggest a new topic, and choose 'Yes' in signup_preference.
<pre>
# Login with student5717 account
visit 'content_pages/view'
expect(page).to have_content('Welcome')
fill_in "User Name", with: "student5717"
fill_in "Password", with: "password"
click_button "SIGN IN"

# suggest a new suggestion
visit '/suggestion/new?id=711'
fill_in 'suggestion_title', with: 'RSpect'
fill_in 'suggestion_description', with: 'RSpect is a ROR test framework. It focus on function test'
# select 'suggestion_signup_preference', with: 'Y'
expect{click_button "Submit"}.to change(Suggestion, :count).by(1)
</pre>
Then, log out Student5717, and log in with 'instructor6' account, who is the manager of this course. Then approve the suggest.
<pre>
# Logout current account student5717
visit '/suggestion/new?id=711'
click_link "Logout"
expect(current_path).to eq("/")

# Login with account instructor6
visit 'content_pages/view'
expect(page).to have_content('Welcome.')
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

# approve the suggestion
expect(page).to have_content('Manage content')
visit '/suggestion/list?id=711&type=Assignment'
expect(page).to have_content('Suggested topics for Writing assignment 1a')
expect(page).to have_content('RSpect')

num = Suggestion.last.id
visit "/suggestion/"+num.to_s
expect(page).to have_content('Suggestion')
expect(page).to have_content('Title: RSpect')
click_button "Approve suggestion"
visit "/suggestion/"+num.to_s
expect(page).to have_content('status: Approved')
</pre>
Finally, check if suggestion approved successfully. I need to check topic list with 'instructor6' account logged in and check the selected topic in student5717 account.
<pre>
# check if is not in waitlist
visit "/assignments/711/edit#tabs-2"
expect(page).to have_no_content(" Writing assignment 1a_Team14 student5717 (waitlisted)")

# Logout current account instructor6
visit '/suggestion/new?id=711'
click_link "Logout"
current_path.should == "/"

# Login with student5717 account
visit 'content_pages/view'
expect(page).to have_content('Welcome')
fill_in "User Name", with: "student5717"
fill_in "Password", with: "password"
click_button "SIGN IN"

# Check if you select the topic successfully
visit '/sign_up_sheet/list?assignment_id=711'
expect(page).to have_content('Your topic(s): RSpect')
</pre>
=== Test2 ===
For the second test, Writing Assignment 1a team1, whose team id is 23781, was chosen to perform a serial of action. Team no.23781 is holding a topic: Amazon S3 and Rails. And Writing Assignment 1a team5, whose team id is 23800, is in the waiting list of this topic.
First, sign in as Student 5404 from team1, send a suggestion for new topic and indicate they want to choose their suggested topic.
<pre>
@newtopic = 'Violet and Zoe'

#sign in as student5404:
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Assignments')

#suggest a topic:
# signup_preference default to be Y
visit "/student_task/view?id=28634"
expect(page).to have_content('Submit or Review work')
visit "/suggestion/new?id=711"
expect(page).to have_content('New suggestion')
fill_in 'Title',with: @newtopic
expect{click_button "Submit"}.to change(Suggestion, :count).by(1)

#logout
click_link "Logout"
expect(current_path).to eq("/")
visit '/suggestion/new?id=711'
expect(page).to have_content('This is not allowed')
expect(page).to have_content('Welcome')
expect(page).to have_no_content('User: student5404')
</pre>

Then sign in as instructor6 and approve the suggested topic.
<pre>
#sign in as instructor6
visit 'content_pages/view'
expect(page).to have_content('Welcome.')
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Manage content')

#approve the suggestion
visit '/suggestion/list?id=711&type=Assignment'
expect(page).to have_content('Suggested topics for Writing assignment 1a')
num = Suggestion.last.id.to_s
visit "/suggestion/"+num
expect(page).to have_content('Suggestion')
expect(page).to have_content('Title: '+@newtopic)
click_button "Approve suggestion"
visit "/suggestion/"+num.to_s
expect(page).to have_content('status: Approved')

#logout as instructor6
click_link "Logout"
expect(current_path).to eq("/")
visit '/suggestion/new?id=711'
expect(page).to have_content('This is not allowed')
expect(page).to have_content('Welcome')
</pre>
Finally, to check the results. On the one hand, sign in as student5404 again and see if her/his team is holding the new topic. On the other hand sign in as instructor6 and check if team no.23800 is holding the old topic: Amazon S3 and Rails.
<pre>
#sign in as student5404:
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Assignments')

#check the approved suggestion in topics list
visit "/sign_up_sheet/list?assignment_id=711"
expect(page).to have_content("Your approved suggested topic")

# switch to the new topic
num2 = SignUpTopic.last.id.to_s
visit "/sign_up_sheet/switch_original_topic_to_approved_suggested_topic/"+num2+"?assignment_id=711"
expect(page).to have_content("Your topic(s): "+@newtopic)

#logout student5404
click_link "Logout"
expect(current_path).to eq("/")
visit '/suggestion/new?id=711'
expect(page).to have_content('This is not allowed')
expect(page).to have_content('Welcome')
expect(page).to have_no_content('User: student5404')

#sign in as instructor6
visit 'content_pages/view'
expect(page).to have_content('Welcome.')
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"
expect(page).to have_content('Manage content')

# check if team1 is has not enrolled
visit "/assignments/711/edit#tabs-2"
expect(page).to have_no_content(" Writing assignment 1a_Team1 student5404 student5731 ")
expect(page).to have_content("Writing assignment 1a_Team5 student5740 student5704")
expect(page).to have_content("S1 Violet and Zoe Writing assignment 1a_Team1 student5404 student5731")
</pre>
=== Test3 ===
The third test is similar to the second one. Team no.23781 and assignment no.711 are chosen for this test again.
First, student no.5404 login to the system, visit the assignment page, and make a topic suggestion. In the suggestion, instead of choosing “yes” in signup preference, the student chooses “no” in order not to use the suggested topic.

<pre>
visit 'content_pages/view'
fill_in "User Name", with: "student5404"
fill_in "Password", with: "password"
click_button "SIGN IN"

visit '/suggestion/new?id=711'
fill_in 'suggestion_title', with: 'test title'
fill_in 'suggestion_description', with: 'test description'
select 'No', from: "suggestion_signup_preference"
click_button "Submit"

click_link "Logout"
</pre>
After the suggestion is made, login as an instructor, find the assignment, and approve the suggestion.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

num = Suggestion.last.id
path = "/suggestion/" + num.to_s
visit path
click_button "Approve suggestion"

click_link "Logout"
</pre>
In the final step, we check if the new topic is shown in the topic list, then login as student no.5401 again, check if they still hold their old topic.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"

visit '/sign_up_sheet/list?assignment_id=711'
expect(page).to have_content('Your topic(s): Amazon S3 and Rails')
click_link "Logout"

visit 'content_pages/view'
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

visit "/assignments/711/edit#tabs-2"
expect(page).to have_content("Amazon S3 and Rails")
expect(page).to have_content("test title")
</pre>
=== Result ===
Here is the result of our tests. All test cases passed.
<pre>
ChendeMacBook-Pro:expertiza chen$ rspec spec/controllers/suggestion_controller_spec.rb
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.

Randomized with seed 8804
/Users/chen/RubymineProjects/expertiza/app/models/suggestion.rb:5: warning: circular argument reference - assignment_id
......

Deprecation Warnings:

Using `should` from rspec-expectations' old `:should` syntax without explicitly enabling the syntax is deprecated. Use the new `:expect` syntax or explicitly enable `:should` with `config.expect_with(:rspec) { |c| c.syntax = :should }` instead. Called from /Users/chen/RubymineProjects/expertiza/spec/controllers/suggestion_controller_spec.rb:67:in `block (3 levels) in <top (required)>'.

If you need more of the backtrace for any of these deprecations to
identify where to make the necessary changes, you can configure
`config.raise_errors_for_deprecations!`, and it will turn the
deprecation warnings into errors, giving you the full backtrace.

1 deprecation warning total

Finished in 1 minute 6.74 seconds (files took 5.3 seconds to load)
6 examples, 0 failures

Randomized with seed 8804

Coverage report generated for RSpec to /Users/chen/RubymineProjects/expertiza/coverage. 1638 / 5233 LOC (31.3%) covered.
[Coveralls] Outside the CI environment, not sending data.
</pre>
=== UI test ===

For instructor:




For students:


For student users, first you need to login your account, find a certain course, and make suggestion
[[File:Example.jpg]]
Then, based on your need, choose if you want to work on the suggestion you suggested.
[[File:Example.jpg]]
After saving, there will be a flash message on your webpage, and the suggested topic would be shown.
[[File:Example.jpg]]

CSC/ECE 517 Fall 2015 E1582 Create integration tests for the instructor interface using capybara and rspec

2015-11-05T20:50:21Z

Hma5:

== Intro ==

=== RSpec ===

=== Capybara ===
Capybara is a web-based automation test tool that simulates a real user to follow the scenarios of user stories.<ref>[https://github.com/jnicklas/capybara Capybara on GitHub]</ref> It could interact with app to receive pages, parse the HTML and submit forms as a user would.<ref>[https://www.youtube.com/watch?v=p7ZcZNuZ0aw Introducing cucumber & capybara on YouTube]</ref> Used with RSpec and Ruby on Rails (version 1.9 or later), capybara makes it easier to write integration tests. <ref>[http://techiferous.com/2010/04/using-capybara-in-rails-3/ Using Capybara in Rails 3]</ref> It is used on the top of an underlying web-based driver and offers a user-friendly DSL (Domain Specific Language) to describe actions executed by the underlying web driver. Such as <code>rack::test</code>, <code>selenium-webdriver</code> and <code>capybara-webkit</code>.<ref>[http://www.sitepoint.com/basics-capybara-improving-tests/ The Basics of Capybara and Improving Your Tests]</ref>

In this project, we use capybara with rspec by adding the following line:
require 'capybara/rspec'
Then put capybara specs in <code>spec/features</code>.
=== Integration test ===

== Testing ==

Based on the project requirements, testing can be divided into the following parts:

T1. Ensure an instructor is able to login to the system.

T2. Ensure an instuctor is able to create a course.

T3. Ensure that the score of a certain assignment can be viewed.

T4. Ensure to view the score of a review.

T5. Ensure to view the score of an author feedback.

T6. Ensure to create an assignment which has two rounds of review, has a topic or does not has a topic, and has a staggered-deadline.

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1556 CHM

2015-10-30T17:22:18Z

Hma5: /* Refator */

E1556. Refactoring SuggestionController.rb
== Project description==
== Expertiza==
== Optimization==
=== Syntax ===
=== Refator ===
The approve_suggestion() method is quite long in the original code, and the send email function in the method is achieved twice, which doesn’t conform with DRY principle.

The logic of the approve_suggestion() method is described as follows. First, approve the suggestion by create a new record in the SignUpTopic model, set relative parameters, and save the new record. Then send notification to the team. In the notification part, if the student doesn’t have a team, a new team should be created and assigned to the suggested topic.
Based on the logic, the approve_suggestion() method can be clearly divided into two parts: approve suggestion part, and notification part. In the notification part, send email function can be written as a single method in order not to repeat. Besides, creating a new team can also be written as a new method.

After refactor, there are four new methods: approve, notification, create_new_team, and send_email. Approve and notification are called within approve_suggestion, while create_new_team and send_email are called within notification.
<pre>
def create_new_team
new_team = AssignmentTeam.create(name: 'Team' + @user_id.to_s + '_' + rand(1000).to_s, parent_id: @signuptopic.assignment_id, type: 'AssignmentTeam')
t_user = TeamsUser.create(team_id: new_team.id, user_id: @user_id)
SignedUpTeam.create(topic_id: @signuptopic.id, team_id: new_team.id, is_waitlisted: 0)
parent = TeamNode.create(parent_id: @signuptopic.assignment_id, node_object_id: new_team.id)
TeamUserNode.create(parent_id: parent.id, node_object_id: t_user.id)
end

def send_email
proposer = User.find(@user_id)
teams_users = TeamsUser.where(team_id: @team_id)
cc_mail_list = Array.new
teams_users.each do |teams_user|
cc_mail_list << User.find(teams_user.user_id).email if teams_user.user_id != proposer.id
end
Mailer.suggested_topic_approved_message(
{ to: proposer.email,
cc: cc_mail_list,
subject: "Suggested topic '#{@suggestion.title}' has already been approved",
body: {
approved_topic_name: @suggestion.title,
proposer: proposer.name
}
}
).deliver
end

def approve
@suggestion = Suggestion.find(params[:id])
@user_id = User.where(name: @suggestion.unityID).first.id
@team_id = TeamsUser.team_id(@suggestion.assignment_id, @user_id)
@topic_id = SignedUpTeam.topic_id(@suggestion.assignment_id, @user_id)
@signuptopic = SignUpTopic.new
@signuptopic.topic_identifier = 'S' + Suggestion.where("assignment_id = ? and id <= ?", @suggestion.assignment_id, @suggestion.id).size.to_s
@signuptopic.topic_name = @suggestion.title
@signuptopic.assignment_id = @suggestion.assignment_id
@signuptopic.max_choosers = 1;
if @signuptopic.save && @suggestion.update_attribute('status', 'Approved')
flash[:notice] = 'Successfully approved the suggestion.'
else
flash[:error] = 'Error when approving the suggestion.'
end
end

def notification
if @suggestion.signup_preference == 'Y'
#if this user do not have team in this assignment, create one for him/her and assign this topic to this team.
if @team_id.nil?
create_new_team
else #this user has a team in this assignment, check whether this team has topic or not
if @topic_id.nil?
#clean waitlists
SignedUpTeam.where(team_id: @team_id, is_waitlisted: 1).destroy_all
SignedUpTeam.create(topic_id: @signuptopic.id, team_id: @team_id, is_waitlisted: 0)
else
@signuptopic.private_to = @user_id
@signuptopic.save
#if this team has topic, Expertiza will send an email (suggested_topic_approved_message) to this team
send_email
end
end
else
#if this team has topic, Expertiza will send an email (suggested_topic_approved_message) to this team
send_email
end
end

def approve_suggestion
approve
notification
redirect_to action: 'show', id: @suggestion
end
</pre>

== Test ==
=== Rspec===

=== Test1 ===
=== Test2 ===
=== Test3 ===
The third test is similar to the second one. Team no.23781 and assignment no.711 are chosen for this test again.
First, student no.5404 login to the system, visit the assignment page, and make a topic suggestion. In the suggestion, instead of choosing “yes” in signup preference, the student chooses “no” in order not to use the suggested topic.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: "student5404"
fill_in "Password", with: "password"
click_button "SIGN IN"

visit '/suggestion/new?id=711'
fill_in 'suggestion_title', with: 'test title'
fill_in 'suggestion_description', with: 'test description'
select 'No', from: "suggestion_signup_preference"
click_button "Submit"

click_link "Logout"
</pre>
After the suggestion is made, login as an instructor, find the assignment, and approve the suggestion.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

num = Suggestion.last.id
path = "/suggestion/" + num.to_s
visit path
click_button "Approve suggestion"

click_link "Logout"
</pre>
In the final step, we check if the new topic is shown in the topic list, then login as student no.5401 again, check if they still hold their old topic.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"

visit '/sign_up_sheet/list?assignment_id=711'
expect(page).to have_content('Your topic(s): Amazon S3 and Rails')
click_link "Logout"

visit 'content_pages/view'
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

visit "/assignments/711/edit#tabs-2"
expect(page).to have_content("Amazon S3 and Rails")
expect(page).to have_content("test title")
</pre>
=== Result ===

CSC/ECE 517 Fall 2015/oss E1556 CHM

2015-10-30T16:50:34Z

Hma5:

E1556. Refactoring SuggestionController.rb
== Project description==
== Expertiza==
== Optimization==
=== Syntax ===
=== Refator ===
== Test ==
=== Rspec===

=== Test1 ===
=== Test2 ===
=== Test3 ===
The third test is similar to the second one. Team no.23781 and assignment no.711 are chosen for this test again.
First, student no.5404 login to the system, visit the assignment page, and make a topic suggestion. In the suggestion, instead of choosing “yes” in signup preference, the student chooses “no” in order not to use the suggested topic.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: "student5404"
fill_in "Password", with: "password"
click_button "SIGN IN"

visit '/suggestion/new?id=711'
fill_in 'suggestion_title', with: 'test title'
fill_in 'suggestion_description', with: 'test description'
select 'No', from: "suggestion_signup_preference"
click_button "Submit"

click_link "Logout"
</pre>
After the suggestion is made, login as an instructor, find the assignment, and approve the suggestion.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

num = Suggestion.last.id
path = "/suggestion/" + num.to_s
visit path
click_button "Approve suggestion"

click_link "Logout"
</pre>
In the final step, we check if the new topic is shown in the topic list, then login as student no.5401 again, check if they still hold their old topic.
<pre>
visit 'content_pages/view'
fill_in "User Name", with: 'student5404'
fill_in "Password", with: 'password'
click_button "SIGN IN"

visit '/sign_up_sheet/list?assignment_id=711'
expect(page).to have_content('Your topic(s): Amazon S3 and Rails')
click_link "Logout"

visit 'content_pages/view'
fill_in "User Name", with: 'instructor6'
fill_in "Password", with: 'password'
click_button "SIGN IN"

visit "/assignments/711/edit#tabs-2"
expect(page).to have_content("Amazon S3 and Rails")
expect(page).to have_content("test title")
</pre>
=== Result ===