Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2016 E1621 Refactor and Test the Quizzing Feature

2016-04-18T12:03:00Z

Ewhorton: /* Post Completion */

= Introduction to Expertiza =
Expertiza<ref>https://github.com/expertiza/expertiza</ref> is a project developed using Ruby on Rails<ref>http://guides.rubyonrails.org/getting_started.html</ref>. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an [https://en.wikipedia.org/wiki/Open_source open source] application and the code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

= Problem Statement =
The Expertiza quiz feature is in need of refactoring. Currently, quizzes are checked by <code>questionnaires_controller.valid_quiz</code>. This method is rather long, involved, and does not take advantage of object-oriented practices. It combs through the parameters hash received from a request and manually checks all quiz fields, all question fields, all question choice fields, and verifies that each question has a correct choice.

We will refactor the method to construct a quiz questionniare and then call <code>valid?</code> to recursively validate the object tree using ActiveRecord validations. This is an improvement over the current code which checks all questions manually. The purpose of refactoring in this manner is to enhance readability, DRYness, and maintainability of Expertiza code.

In addition to this refactoring we will implement integration testing on the quiz feature to verify that the expected behavior is present for all use cases.

A full description of the assignment may be found [https://docs.google.com/document/d/13oRmKemlwRzXG1ItcI2zTx4r3gAAfvmuobZjxiy0oVo/edit#heading=h.su78b3gdq1a7 here]

=Classes involved=
* questionnaires_controller.rb
* quiz_quesetionnaire.rb
* quiz_question.rb
* quiz_question_choice.rb
* spec/features/quiz_spec.rb

=Use Case and Scenarios=
The Quiz Use Case allows for instructors to create and manage assignments where students may write quizzes for reviewers on materials they have submitted. See the following scenarios for a complete description of how the feature is expected to work.

==Instructors are able to create and manage an assignment's quiz feature==
An instructor chooses to create an assignment that has a quiz [S1]. While editing the assignment they may choose the number of quiz questions [S2] and set which phases students are allowed to take the quizzes [S3].

* [S1] - When creating the assignment there is a checkbox labeled "has quiz." Checking this box creates an assignment that includes a quiz.
* [S2] - When an assignment has a quiz there is an input field that accepts the number of questions that will be on each quiz. Setting this number appropriately changes the number of quiz questions.
* [S3] - Students may not take quizzes on a phase that does not allow them to do so. When on a stage that does allow for quizzes, they may take quizzes on work that they have reviewed.

==Instructors can view quiz questions and scores from the tree view==
After an assignment has been created the instructor may choose to view student quizzes from the tree view [S1]. While on the quiz view page they see student quizzes [S2] and student responses [S3].

* [S1] - The instructor may navigate to the list of assignments. Assignments with quizzes enabled will provide a link for the instructor to follow and view student quizzes.
* [S2] - The instructor shall be presented with the quiz title, questions, and answer choices. The correct answer choices will be in bold.
* [S3] - The score for each student who has taken the quiz shall be listed along with the average quiz score.

==Students can create and edit quizzes==
A student navigates to the assignment work page and chooses to create a new quiz [S1] or edit an existing one [S2]. By doing so they are able to choose a quiz title and quiz questions [S3]. Invalid input results in an error message prompting the student to fix the issue [E1].

* [S1] - A student may only create a quiz if they have not yet done so.
* [S2] - A student may only edit a quiz if they have previously created one.
* [S3] - The quiz has the number of quiz questions defined by the instructor in the assignment.

* [E1] - Possible errors include:
** The quiz has no name.
** One or more questions is missing text.
** One or more choices is missing text.
** A question is missing a correct answer choice.

==Students can take quizzes on assignments they have reviewed==
A student decides to take a quiz [S1] on another team's assignment that they have previously reviewed. They select an artifact for review [S2] and fill in their answers. After submitting the quiz they can view their score on the take quizzes page [S3] and see question-by-question scores by clicking view [S4].

* [S1] - The student may only take a quiz during a stage in which the assignment is configured to allow them to do so.
* [S2] - Only quizzes from submissions they have reviewed are available.
* [S3] - The take quizzes page lists the final score for each quiz.
* [S4] - Choosing to view a quiz will show a student each question along with their answers and the correct answers.

=Design and Implementation=
Design for the refactoring has been driven by object oriented principles and test-driven-development, and makes use of the existing object hierarchy described in the following UML diagram.

[[File:Expertiza_quiz_hierarchy.png|Expertiza Quiz Hierarchy]]

See the below sections for a part-by-part breakdown of the planned implementation for this project.

==Tests==
Quiz tests will be added to the file spec/features/quiz_spec.rb and will make use of
* rspec
* capybara
* selenium

Tests will be made which fully cover the expected behavior of each listed scenario in the Use Case.

==Refactoring==
Each of the following files will be refactored as described.

===QuestionnaireController===
Refactor the <code>valid_quiz</code> method. It will be renamed to <code>validate_quiz</code> to more properly describe the action that occurs as a result of it being called. The behavior will be changed to construct a new quiz questionnaire with submitted questions wich will be validated using <code>quiz.valid?</code>.

===QuizQuestionnaire===
The following fields will be validated using ActiveRecord validations.
* Presence of name

===QuizQuestion===
The following fields will be validated using ActiveRecord validations
* Presence of text
* Presence of type
* Has a correct answer

===QuizQuestionChoice===
The following fields will be validated using ActiveRecord validations
* Presence of text

===Test Cases===
In order to verify that refactoring has been done correctly and maintains the same external behavior, we will write test cases to the existing implementation. These test cases will be the ground truth of the validation feature. Refactored code will not be considered complete until all of these test cases once again pass.

=Post Completion=
Testing and refactoring have been completed and a [https://github.com/expertiza/expertiza/pull/671 pull request] created to merge features back into master.

==Refactoring==
Refactoring went according to plan. The following model files were edited to use ActiveRecord validations on specific fields
* question.rb
* questionnaire.rb
* quiz_quesetion.rb
* quiz_question_choice.rb

In addition, tests were added to <code>spec/controllers/questionnaires_controller_spec.rb</code> to test quiz validation. With passing tests, the <code>validate_quiz</code> method in <code>questionnaires_controller</code> was refactored. It now constructs a quiz from params and returns it if it is valid. If the quiz is invalid an error message is returned.

===Before Refactoring===
<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
def valid_quiz
:num_quiz_questions = Assignment.find(params[:aid]).num_quiz_questions
:valid = "valid"

:(1..num_quiz_questions).each do |i|
:: if params[:new_question][i.to_s] == ''
:::// One of the questions text is not filled out
:::valid = "Please make sure all questions have text"
:::break
::elsif !params.has_key?(:question_type) || !params[:question_type].has_key?(i.to_s) || params[:question_type][i.to_s][:type] == nil
:::// A type isnt selected for a question
:::valid = "Please select a type for each question"
:::break
::elsif params[:questionnaire][:name]==""
:::// questionnaire name is not specified
:::valid = "Please specify quiz name (please do not use your name or id)."
:::break
::else
:::type = params[:question_type][i.to_s][:type]
:::if type == 'MultipleChoiceCheckbox' or type == 'MultipleChoiceRadio'
::::correct_selected = false
::::(1..4).each do |x|
:::::if params[:new_choices][i.to_s][type][x.to_s][:txt] == ''
::::::// Text isnt provided for an option
::::::valid = "Please make sure every question has text for all options"
::::::break
:::::elsif type == 'MultipleChoiceRadio' and not params[:new_choices][i.to_s][type][x.to_s][:iscorrect] == nil
::::::correct_selected = true
:::::elsif type == 'MultipleChoiceCheckbox' and not params[:new_choices][i.to_s][type][x.to_s][:iscorrect] == 0.to_s
::::::correct_selected = true
:::::end
::::end
::::if valid == "valid" && !correct_selected
:::::// A correct option isnt selected for a check box or radio question
:::::valid = "Please select a correct answer for all questions"
::::::break
::::end
:::elsif type == 'TF' # TF is not disabled. We need to test TF later.
::::if params[:new_choices][i.to_s]["TF"] == nil
:::::// A correct option isnt selected for a true/false question
:::::valid = "Please select a correct answer for all questions"
:::::break
::::end
:::end
::end
:end

:return valid
end
</div>

===After Refactoring===
<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
def validate_quiz
:num_quiz_questions = Assignment.find(params[:aid]).num_quiz_questions

:questionnaire = quiz_questionnaire num_quiz_questions

:if questionnaire.valid?
::return questionnaire
: end

:questionnaire_errors questionnaire
end
</div>

==Testing==
All tests were implemented as part of <code>spec/features/quiz_spec.rb</code> and thoroughly cover the Use Case, scenarios, and sub flows listed above. A factory file, <code>spec/factories/quiz_factory.rb</code> was added to aid testing.

= References =
<references/>

CSC/ECE 517 Spring 2016 E1621 Refactor and Test the Quizzing Feature

2016-04-18T11:27:54Z

Ewhorton:

User:Mxu

2016-04-11T21:29:32Z

Ewhorton: /* Instructors can view quiz questions and scores from the tree view */

===CSC/ECE 517 Spring 2016 E1621: Refactor and test the quizzing feature===

= Introduction to Expertiza =
Expertiza<ref>https://github.com/expertiza/expertiza</ref> is a project developed using Ruby on Rails<ref>http://guides.rubyonrails.org/getting_started.html</ref>. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an [https://en.wikipedia.org/wiki/Open_source open source] application and the code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

= Problem Statement =
The Expertiza quiz feature is in need of refactoring. Currently, quizzes are checked by <code>questionnaires_controller.valid_quiz</code>. This method is rather long, involved, and does not take advantage of object-oriented practices. It combs through the parameters hash received from a request and manually checks all quiz fields, all question fields, all question choice fields, and verifies that each question has a correct choice.

We will refactor the method to construct a quiz questionniare and then call <code>valid?</code> to recursively validate the object tree using ActiveRecord validations. This is an improvement over the current code which checks all questions manually. The purpose of refactoring in this manner is to enhance readability, DRYness, and maintainability of Expertiza code.

In addition to this refactoring we will implement integration testing on the quiz feature to verify that the expected behavior is present for all use cases.

A full description of the assignment may be found [https://docs.google.com/document/d/13oRmKemlwRzXG1ItcI2zTx4r3gAAfvmuobZjxiy0oVo/edit#heading=h.su78b3gdq1a7 here]

=Classes involved=
* questionnaires_controller.rb
* quiz_quesetionnaire.rb
* quiz_question.rb
* quiz_question_choice.rb
* spec/features/quiz_spec.rb

=Use Case and Scenarios=
The Quiz Use Case allows for instructors to create and manage assignments where students may write quizzes for reviewers on materials they have submitted. See the following scenarios for a complete description of how the feature is expected to work.

==Instructors are able to create and manage an assignment's quiz feature==
An instructor chooses to create an assignment that has a quiz [S1]. While editing the assignment they may choose the number of quiz questions [S2] and set which phases students are allowed to take the quizzes [S3].

* [S1] - When creating the quiz there is a checkbox labeled "has quiz." Checking this box creates an assignment that includes a quiz.
* [S2] - When an assignment has a quiz there is an input field that accepts the number of questions that will be on each quiz. Setting this number appropriately changes the number of quiz questions.
* [S3] - Students may not take quizzes on a phase that does not allow them to do so. When on a stage that does allow for quizzes, they may take quizzes on work that they have reviewed.

==Instructors can view quiz questions and scores from the tree view==
After an assignment has been created the instructor may choose to view student quizzes from the tree view [S1]. While on the quiz view page they see student quizzes [S2] and student responses [S3].

* [S1] - The instructor may navigate to the list of assignments. Assignments with quizzes enabled will provide a link for the instructor to follow and view student quizzes.
* [S2] - The instructor shall be presented with the quiz title, questions, and answer choices. The correct answer choices will be in bold.
* [S3] - The score for each student who has taken the quiz shall be listed along with the average quiz score.

==Students can create and edit quizzes==
A student navigates to the assignment work page and chooses to create a new quiz [S1] or edit an existing one [S2]. By doing so they are able to choose a quiz title and quiz questions [S3]. Invalid input results in an error message prompting the student to fix the issue [E1].

* [S1] - A student may only create a quiz if they have not yet done so.
* [S2] - A student may only edit a quiz if they have previously created one.
* [S3] - The quiz has the number of quiz questions defined by the instructor in the assignment.

* [E1] - Possible errors include:
** The quiz has no name.
** One or more questions is missing text.
** One or more choices is missing text.
** A question is missing a correct answer choice.

==Students can take quizzes on assignments they have reviewed==
A student decides to take a quiz [S1] on another team's assignment that they have previously reviewed. They select an artifact for review [S2] and fill in their answers. After submitting the quiz they can view their score on the take quizzes page [S3] and see question-by-question scores by clicking view [S4].

* [S1] - The student may only take a quiz during a stage in which the assignment is configured to allow them to do so.
* [S2] - Only quizzes from submissions they have reviewed are available.
* [S3] - The take quizzes page lists the final score for each quiz.
* [S4] - Choosing to view a quiz will show a student each question along with their answers and the correct answers.

=Design and Implementation=
Design for the refactoring has been driven by object oriented principles and test-driven-development, and makes use of the existing object hierarchy described in the following UML diagram.

[[File:Expertiza_quiz_hierarchy.png|Expertiza Quiz Hierarchy]]

See the below sections for a part-by-part breakdown of the planned implementation for this project.

==Tests==
Quiz tests will be added to the file spec/features/quiz_spec.rb and will make use of
* rspec
* capybara
* selenium

Tests will be made which fully cover the expected behavior of each listed scenario in the Use Case.

==Refactoring==
Each of the following files will be refactored as described.

===QuestionnaireController===
Refactor the <code>valid_quiz</code> method. It will be renamed to <code>validate_quiz</code> to more properly describe the action that occurs as a result of it being called. The behavior will be changed to construct a new quiz questionnaire with submitted questions wich will be validated using <code>quiz.valid?</code>.

===QuizQuestionnaire===
The following fields will be validated using ActiveRecord validations.
* Presence of name

===QuizQuestion===
The following fields will be validated using ActiveRecord validations
* Presence of text
* Presence of type
* Has a correct answer

===QuizQuestionChoice===
The following fields will be validated using ActiveRecord validations
* Presence of text

===Test Cases===
In order to verify that refactoring has been done correctly and maintains the same external behavior, we will write test cases to the existing implementation. These test cases will be the ground truth of the validation feature. Refactored code will not be considered complete until all of these test cases once again pass.

= References =
<references/>

User:Mxu

2016-04-09T00:38:58Z

Ewhorton: /* Instructors are able to create and manage an assignment's quiz feature */

===CSC/ECE 517 Spring 2016 E1621: Refactor and test the quizzing feature===

= Introduction to Expertiza =
Expertiza<ref>https://github.com/expertiza/expertiza</ref> is a project developed using Ruby on Rails<ref>http://guides.rubyonrails.org/getting_started.html</ref>. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an [https://en.wikipedia.org/wiki/Open_source open source] application and the code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

= Problem Statement =
The Expertiza quiz feature is in need of refactoring. Currently, quizzes are checked by <code>questionnaires_controller.valid_quiz</code>. This method is rather long, involved, and does not take advantage of object-oriented practices. It combs through the parameters hash received from a request and manually checks all quiz fields, all question fields, all question choice fields, and verifies that each question has a correct choice.

We will refactor the method to construct a quiz questionniare and then call <code>valid?</code> to recursively validate the object tree using ActiveRecord validations. This is an improvement over the current code which checks all questions manually. The purpose of refactoring in this manner is to enhance readability, DRYness, and maintainability of Expertiza code.

In addition to this refactoring we will implement integration testing on the quiz feature to verify that the expected behavior is present for all use cases.

A full description of the assignment may be found [https://docs.google.com/document/d/13oRmKemlwRzXG1ItcI2zTx4r3gAAfvmuobZjxiy0oVo/edit#heading=h.su78b3gdq1a7 here]

=Classes involved=
* questionnaires_controller.rb
* quiz_quesetionnaire.rb
* quiz_question.rb
* quiz_question_choice.rb
* spec/features/quiz_spec.rb

=Use Case and Scenarios=
The Quiz Use Case allows for instructors to create and manage assignments where students may write quizzes for reviewers on materials they have submitted. See the following scenarios for a complete description of how the feature is expected to work.

==Instructors are able to create and manage an assignment's quiz feature==
An instructor chooses to create an assignment that has a quiz [S1]. While editing the assignment they may choose the number of quiz questions [S2] and set which phases students are allowed to take the quizzes [S3].

* [S1] - When creating the quiz there is a checkbox labeled "has quiz." Checking this box creates an assignment that includes a quiz.
* [S2] - When an assignment has a quiz there is an input field that accepts the number of questions that will be on each quiz. Setting this number appropriately changes the number of quiz questions.
* [S3] - Students may not take quizzes on a phase that does not allow them to do so. When on a stage that does allow for quizzes, they may take quizzes on work that they have reviewed.

==Instructors can view quiz questions and scores from the tree view==
After an assignment has been created the instructor may choose to view student quizzes from the tree view [S1]. While on the quiz view page they see student quizzes [S2] and student responses [S3].

* [S1] - The instructor may navigate to the list of assignments. Assignments with quizzes enabled will provide a link for the instructor to follow and view student quizzes.
* [S2] - The quiz title and questions are to be presented in a clear manner. The correct answer choices should be easily determined.
* [S3] - The score for each student who has taken the quiz shall be listed along with the average quiz score.

==Students can create and edit quizzes==
A student navigates to the assignment work page and chooses to create a new quiz [S1] or edit an existing one [S2]. By doing so they are able to choose a quiz title and quiz questions [S3]. Invalid input results in an error message prompting the student to fix the issue [E1].

* [S1] - A student may only create a quiz if they have not yet done so.
* [S2] - A student may only edit a quiz if they have previously created one.
* [S3] - The quiz has the number of quiz questions defined by the instructor in the assignment.

* [E1] - Possible errors include:
** The quiz has no name.
** One or more questions is missing text.
** One or more choices is missing text.
** A question is missing a correct answer choice.

==Students can take quizzes on assignments they have reviewed==
A student decides to take a quiz [S1] on another team's assignment that they have previously reviewed. They select an artifact for review [S2] and fill in their answers. After submitting the quiz they can view their score on the take quizzes page [S3] and see question-by-question scores by clicking view [S4].

* [S1] - The student may only take a quiz during a stage in which the assignment is configured to allow them to do so.
* [S2] - Only quizzes from submissions they have reviewed are available.
* [S3] - The take quizzes page lists the final score for each quiz.
* [S4] - Choosing to view a quiz will show a student each question along with their answers and the correct answers.

=Design and Implementation=
Design for the refactoring has been driven by object oriented principles and test-driven-development, and makes use of the existing object hierarchy described in the following UML diagram.

[[File:Expertiza_quiz_hierarchy.png|Expertiza Quiz Hierarchy]]

See the below sections for a part-by-part breakdown of the planned implementation for this project.

==Tests==
Quiz tests will be added to the file spec/features/quiz_spec.rb and will make use of
* rspec
* capybara
* selenium

Tests will be made which fully cover the expected behavior of each listed scenario in the Use Case.

==Refactoring==
Each of the following files will be refactored as described.

===QuestionnaireController===
Refactor the <code>valid_quiz</code> method. It will be renamed to <code>validate_quiz</code> to more properly describe the action that occurs as a result of it being called. The behavior will be changed to construct a new quiz questionnaire with submitted questions wich will be validated using <code>quiz.valid?</code>.

===QuizQuestionnaire===
The following fields will be validated using ActiveRecord validations.
* Presence of name

===QuizQuestion===
The following fields will be validated using ActiveRecord validations
* Presence of text
* Presence of type
* Has a correct answer

===QuizQuestionChoice===
The following fields will be validated using ActiveRecord validations
* Presence of text

===Test Cases===
In order to verify that refactoring has been done correctly and maintains the same external behavior, we will write test cases to the existing implementation. These test cases will be the ground truth of the validation feature. Refactored code will not be considered complete until all of these test cases once again pass.

= References =
<references/>

User:Mxu

2016-04-09T00:37:57Z

Ewhorton: /* Classes involved */

===CSC/ECE 517 Spring 2016 E1621: Refactor and test the quizzing feature===

= Introduction to Expertiza =
Expertiza<ref>https://github.com/expertiza/expertiza</ref> is a project developed using Ruby on Rails<ref>http://guides.rubyonrails.org/getting_started.html</ref>. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an [https://en.wikipedia.org/wiki/Open_source open source] application and the code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

= Problem Statement =
The Expertiza quiz feature is in need of refactoring. Currently, quizzes are checked by <code>questionnaires_controller.valid_quiz</code>. This method is rather long, involved, and does not take advantage of object-oriented practices. It combs through the parameters hash received from a request and manually checks all quiz fields, all question fields, all question choice fields, and verifies that each question has a correct choice.

We will refactor the method to construct a quiz questionniare and then call <code>valid?</code> to recursively validate the object tree using ActiveRecord validations. This is an improvement over the current code which checks all questions manually. The purpose of refactoring in this manner is to enhance readability, DRYness, and maintainability of Expertiza code.

In addition to this refactoring we will implement integration testing on the quiz feature to verify that the expected behavior is present for all use cases.

A full description of the assignment may be found [https://docs.google.com/document/d/13oRmKemlwRzXG1ItcI2zTx4r3gAAfvmuobZjxiy0oVo/edit#heading=h.su78b3gdq1a7 here]

=Classes involved=
* questionnaires_controller.rb
* quiz_quesetionnaire.rb
* quiz_question.rb
* quiz_question_choice.rb
* spec/features/quiz_spec.rb

=Use Case and Scenarios=
The Quiz Use Case allows for instructors to create and manage assignments where students may write quizzes for reviewers on materials they have submitted. See the following scenarios for a complete description of how the feature is expected to work.

==Instructors are able to create and manage an assignment's quiz feature==
An instructor chooses to create an assignment that has quiz [S1]. While editing the assignment they may choose the number of quiz questions [S2] and set which phases students are allowed to take the quizzes [S3].

* [S1] - When creating the quiz there is a checkbox labeled "has quiz." Checking this box creates an assignment that includes a quiz.
* [S2] - When an assignment has a quiz there is an input field that accepts the number of questions that will be on each quiz. Setting this number appropriately changes the number of quiz questions.
* [S3] - Students may not take quizzes on a phase that does not allow them to do so. When on a stage that does allow for quizzes, they may take quizzes on work that they have reviewed.

==Instructors can view quiz questions and scores from the tree view==
After an assignment has been created the instructor may choose to view student quizzes from the tree view [S1]. While on the quiz view page they see student quizzes [S2] and student responses [S3].

* [S1] - The instructor may navigate to the list of assignments. Assignments with quizzes enabled will provide a link for the instructor to follow and view student quizzes.
* [S2] - The quiz title and questions are to be presented in a clear manner. The correct answer choices should be easily determined.
* [S3] - The score for each student who has taken the quiz shall be listed along with the average quiz score.

==Students can create and edit quizzes==
A student navigates to the assignment work page and chooses to create a new quiz [S1] or edit an existing one [S2]. By doing so they are able to choose a quiz title and quiz questions [S3]. Invalid input results in an error message prompting the student to fix the issue [E1].

* [S1] - A student may only create a quiz if they have not yet done so.
* [S2] - A student may only edit a quiz if they have previously created one.
* [S3] - The quiz has the number of quiz questions defined by the instructor in the assignment.

* [E1] - Possible errors include:
** The quiz has no name.
** One or more questions is missing text.
** One or more choices is missing text.
** A question is missing a correct answer choice.

==Students can take quizzes on assignments they have reviewed==
A student decides to take a quiz [S1] on another team's assignment that they have previously reviewed. They select an artifact for review [S2] and fill in their answers. After submitting the quiz they can view their score on the take quizzes page [S3] and see question-by-question scores by clicking view [S4].

* [S1] - The student may only take a quiz during a stage in which the assignment is configured to allow them to do so.
* [S2] - Only quizzes from submissions they have reviewed are available.
* [S3] - The take quizzes page lists the final score for each quiz.
* [S4] - Choosing to view a quiz will show a student each question along with their answers and the correct answers.

=Design and Implementation=
Design for the refactoring has been driven by object oriented principles and test-driven-development, and makes use of the existing object hierarchy described in the following UML diagram.

[[File:Expertiza_quiz_hierarchy.png|Expertiza Quiz Hierarchy]]

See the below sections for a part-by-part breakdown of the planned implementation for this project.

==Tests==
Quiz tests will be added to the file spec/features/quiz_spec.rb and will make use of
* rspec
* capybara
* selenium

Tests will be made which fully cover the expected behavior of each listed scenario in the Use Case.

==Refactoring==
Each of the following files will be refactored as described.

===QuestionnaireController===
Refactor the <code>valid_quiz</code> method. It will be renamed to <code>validate_quiz</code> to more properly describe the action that occurs as a result of it being called. The behavior will be changed to construct a new quiz questionnaire with submitted questions wich will be validated using <code>quiz.valid?</code>.

===QuizQuestionnaire===
The following fields will be validated using ActiveRecord validations.
* Presence of name

===QuizQuestion===
The following fields will be validated using ActiveRecord validations
* Presence of text
* Presence of type
* Has a correct answer

===QuizQuestionChoice===
The following fields will be validated using ActiveRecord validations
* Presence of text

===Test Cases===
In order to verify that refactoring has been done correctly and maintains the same external behavior, we will write test cases to the existing implementation. These test cases will be the ground truth of the validation feature. Refactored code will not be considered complete until all of these test cases once again pass.

= References =
<references/>

User:Mxu

2016-04-09T00:21:54Z

Ewhorton: /* Tests */

===CSC/ECE 517 Spring 2016 E1621: Refactor and test the quizzing feature===

= Introduction to Expertiza =
Expertiza<ref>https://github.com/expertiza/expertiza</ref> is a project developed using Ruby on Rails<ref>http://guides.rubyonrails.org/getting_started.html</ref>. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an [https://en.wikipedia.org/wiki/Open_source open source] application and the code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

= Problem Statement =
The Expertiza quiz feature is in need of refactoring. Currently, quizzes are checked by <code>questionnaires_controller.valid_quiz</code>. This method is rather long, involved, and does not take advantage of object-oriented practices. It combs through the parameters hash received from a request and manually checks all quiz fields, all question fields, all question choice fields, and verifies that each question has a correct choice.

We will refactor the method to construct a quiz questionniare and then call <code>valid?</code> to recursively validate the object tree using ActiveRecord validations. This is an improvement over the current code which checks all questions manually. The purpose of refactoring in this manner is to enhance readability, DRYness, and maintainability of Expertiza code.

In addition to this refactoring we will implement integration testing on the quiz feature to verify that the expected behavior is present for all use cases.

A full description of the assignment may be found [https://docs.google.com/document/d/13oRmKemlwRzXG1ItcI2zTx4r3gAAfvmuobZjxiy0oVo/edit#heading=h.su78b3gdq1a7 here]

== Classes involved ==
* questionnaires_controller.rb
* quiz_quesetionnaire.rb
* quiz_question.rb
* quiz_question_choice.rb
* spec/features/quiz_spec.rb

=Use Case and Scenarios=
The Quiz Use Case allows for instructors to create and manage assignments where students may write quizzes for reviewers on materials they have submitted. See the following scenarios for a complete description of how the feature is expected to work.

==Instructors are able to create and manage an assignment's quiz feature==
An instructor chooses to create an assignment that has quiz [S1]. While editing the assignment they may choose the number of quiz questions [S2] and set which phases students are allowed to take the quizzes [S3].

* [S1] - When creating the quiz there is a checkbox labeled "has quiz." Checking this box creates an assignment that includes a quiz.
* [S2] - When an assignment has a quiz there is an input field that accepts the number of questions that will be on each quiz. Setting this number appropriately changes the number of quiz questions.
* [S3] - Students may not take quizzes on a phase that does not allow them to do so. When on a stage that does allow for quizzes, they may take quizzes on work that they have reviewed.

==Instructors can view quiz questions and scores from the tree view==
After an assignment has been created the instructor may choose to view student quizzes from the tree view [S1]. While on the quiz view page they see student quizzes [S2] and student responses [S3].

* [S1] - The instructor may navigate to the list of assignments. Assignments with quizzes enabled will provide a link for the instructor to follow and view student quizzes.
* [S2] - The quiz title and questions are to be presented in a clear manner. The correct answer choices should be easily determined.
* [S3] - The score for each student who has taken the quiz shall be listed along with the average quiz score.

==Students can create and edit quizzes==
A student navigates to the assignment work page and chooses to create a new quiz [S1] or edit an existing one [S2]. By doing so they are able to choose a quiz title and quiz questions [S3]. Invalid input results in an error message prompting the student to fix the issue [E1].

* [S1] - A student may only create a quiz if they have not yet done so.
* [S2] - A student may only edit a quiz if they have previously created one.
* [S3] - The quiz has the number of quiz questions defined by the instructor in the assignment.

* [E1] - Possible errors include:
** The quiz has no name.
** One or more questions is missing text.
** One or more choices is missing text.
** A question is missing a correct answer choice.

==Students can take quizzes on assignments they have reviewed==
A student decides to take a quiz [S1] on another team's assignment that they have previously reviewed. They select an artifact for review [S2] and fill in their answers. After submitting the quiz they can view their score on the take quizzes page [S3] and see question-by-question scores by clicking view [S4].

* [S1] - The student may only take a quiz during a stage in which the assignment is configured to allow them to do so.
* [S2] - Only quizzes from submissions they have reviewed are available.
* [S3] - The take quizzes page lists the final score for each quiz.
* [S4] - Choosing to view a quiz will show a student each question along with their answers and the correct answers.

=Design and Implementation=
Design for the refactoring has been driven by object oriented principles and test-driven-development, and makes use of the existing object hierarchy described in the following UML diagram.

[[File:Expertiza_quiz_hierarchy.png|Expertiza Quiz Hierarchy]]

See the below sections for a part-by-part breakdown of the planned implementation for this project.

==Tests==
Quiz tests will be added to the file spec/features/quiz_spec.rb and will make use of
* rspec
* capybara
* selenium

Tests will be made which fully cover the expected behavior of each listed scenario in the Use Case.

==Refactoring==
Each of the following files will be refactored as described.

===QuestionnaireController===
Refactor the <code>valid_quiz</code> method. It will be renamed to <code>validate_quiz</code> to more properly describe the action that occurs as a result of it being called. The behavior will be changed to construct a new quiz questionnaire with submitted questions wich will be validated using <code>quiz.valid?</code>.

===QuizQuestionnaire===
The following fields will be validated using ActiveRecord validations.
* Presence of name

===QuizQuestion===
The following fields will be validated using ActiveRecord validations
* Presence of text
* Presence of type
* Has a correct answer

===QuizQuestionChoice===
The following fields will be validated using ActiveRecord validations
* Presence of text

===Test Cases===
In order to verify that refactoring has been done correctly and maintains the same external behavior, we will write test cases to the existing implementation. These test cases will be the ground truth of the validation feature. Refactored code will not be considered complete until all of these test cases once again pass.

= References =
<references/>

User:Mxu

2016-04-09T00:17:26Z

Ewhorton: Obligatory photo.

===CSC/ECE 517 Spring 2016 E1621: Refactor and test the quizzing feature===

= Introduction to Expertiza =
Expertiza<ref>https://github.com/expertiza/expertiza</ref> is a project developed using Ruby on Rails<ref>http://guides.rubyonrails.org/getting_started.html</ref>. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an [https://en.wikipedia.org/wiki/Open_source open source] application and the code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

= Problem Statement =
The Expertiza quiz feature is in need of refactoring. Currently, quizzes are checked by <code>questionnaires_controller.valid_quiz</code>. This method is rather long, involved, and does not take advantage of object-oriented practices. It combs through the parameters hash received from a request and manually checks all quiz fields, all question fields, all question choice fields, and verifies that each question has a correct choice.

We will refactor the method to construct a quiz questionniare and then call <code>valid?</code> to recursively validate the object tree using ActiveRecord validations. This is an improvement over the current code which checks all questions manually. The purpose of refactoring in this manner is to enhance readability, DRYness, and maintainability of Expertiza code.

In addition to this refactoring we will implement integration testing on the quiz feature to verify that the expected behavior is present for all use cases.

A full description of the assignment may be found [https://docs.google.com/document/d/13oRmKemlwRzXG1ItcI2zTx4r3gAAfvmuobZjxiy0oVo/edit#heading=h.su78b3gdq1a7 here]

== Classes involved ==
* questionnaires_controller.rb
* quiz_quesetionnaire.rb
* quiz_question.rb
* quiz_question_choice.rb
* spec/features/quiz_spec.rb

=Use Case and Scenarios=
The Quiz Use Case allows for instructors to create and manage assignments where students may write quizzes for reviewers on materials they have submitted. See the following scenarios for a complete description of how the feature is expected to work.

==Instructors are able to create and manage an assignment's quiz feature==
An instructor chooses to create an assignment that has quiz [S1]. While editing the assignment they may choose the number of quiz questions [S2] and set which phases students are allowed to take the quizzes [S3].

* [S1] - When creating the quiz there is a checkbox labeled "has quiz." Checking this box creates an assignment that includes a quiz.
* [S2] - When an assignment has a quiz there is an input field that accepts the number of questions that will be on each quiz. Setting this number appropriately changes the number of quiz questions.
* [S3] - Students may not take quizzes on a phase that does not allow them to do so. When on a stage that does allow for quizzes, they may take quizzes on work that they have reviewed.

==Instructors can view quiz questions and scores from the tree view==
After an assignment has been created the instructor may choose to view student quizzes from the tree view [S1]. While on the quiz view page they see student quizzes [S2] and student responses [S3].

* [S1] - The instructor may navigate to the list of assignments. Assignments with quizzes enabled will provide a link for the instructor to follow and view student quizzes.
* [S2] - The quiz title and questions are to be presented in a clear manner. The correct answer choices should be easily determined.
* [S3] - The score for each student who has taken the quiz shall be listed along with the average quiz score.

==Students can create and edit quizzes==
A student navigates to the assignment work page and chooses to create a new quiz [S1] or edit an existing one [S2]. By doing so they are able to choose a quiz title and quiz questions [S3]. Invalid input results in an error message prompting the student to fix the issue [E1].

* [S1] - A student may only create a quiz if they have not yet done so.
* [S2] - A student may only edit a quiz if they have previously created one.
* [S3] - The quiz has the number of quiz questions defined by the instructor in the assignment.

* [E1] - Possible errors include:
** The quiz has no name.
** One or more questions is missing text.
** One or more choices is missing text.
** A question is missing a correct answer choice.

==Students can take quizzes on assignments they have reviewed==
A student decides to take a quiz [S1] on another team's assignment that they have previously reviewed. They select an artifact for review [S2] and fill in their answers. After submitting the quiz they can view their score on the take quizzes page [S3] and see question-by-question scores by clicking view [S4].

* [S1] - The student may only take a quiz during a stage in which the assignment is configured to allow them to do so.
* [S2] - Only quizzes from submissions they have reviewed are available.
* [S3] - The take quizzes page lists the final score for each quiz.
* [S4] - Choosing to view a quiz will show a student each question along with their answers and the correct answers.

=Design and Implementation=
Design for the refactoring has been driven by object oriented principles and test-driven-development, and makes use of the existing object hierarchy described in the following UML diagram.

[[File:Expertiza_quiz_hierarchy.png|Expertiza Quiz Hierarchy]]

See the below sections for a part-by-part breakdown of the planned implementation for this project.

==Tests==
Quiz tests will be added to the file spec/features/quiz_spec.rb and will make use of
* rspec
* capybara
* selenium

Test will be made to fully cover the expected behavior of each listed scenario in the quizzes use case.

==Refactoring==
Each of the following files will be refactored as described.

===QuestionnaireController===
Refactor the <code>valid_quiz</code> method. It will be renamed to <code>validate_quiz</code> to more properly describe the action that occurs as a result of it being called. The behavior will be changed to construct a new quiz questionnaire with submitted questions wich will be validated using <code>quiz.valid?</code>.

===QuizQuestionnaire===
The following fields will be validated using ActiveRecord validations.
* Presence of name

===QuizQuestion===
The following fields will be validated using ActiveRecord validations
* Presence of text
* Presence of type
* Has a correct answer

===QuizQuestionChoice===
The following fields will be validated using ActiveRecord validations
* Presence of text

===Test Cases===
In order to verify that refactoring has been done correctly and maintains the same external behavior, we will write test cases to the existing implementation. These test cases will be the ground truth of the validation feature. Refactored code will not be considered complete until all of these test cases once again pass.

= References =
<references/>

File:Expertiza quiz hierarchy.png

2016-04-09T00:11:36Z

Ewhorton: UML describing the hierarchy involved in creating quizzes from the questionnaire controller.

UML describing the hierarchy involved in creating quizzes from the questionnaire controller.

User:Mxu

2016-04-01T23:17:59Z

Ewhorton: /* QuizQuestionnaire */

===CSC/ECE 517 Spring 2016 E1621: Refactor and test the quizzing feature===

= Introduction to Expertiza =
Expertiza<ref>https://github.com/expertiza/expertiza</ref> is a project developed using Ruby on Rails<ref>http://guides.rubyonrails.org/getting_started.html</ref>. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an [https://en.wikipedia.org/wiki/Open_source open source] application and the code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

= Problem Statement =
The Expertiza quiz feature is in need of refactoring. Currently, quizzes are checked by questionnaires_controller#valid_quiz. This method is rather long, involved, and does not take advantage of object-oriented practices. We will refactor the method to construct a quiz question object and then call valid? to check if the question is valid. This is an improvement over the current code which checks all questions manually.

In addition to this refactoring we will implement integration testing on the quiz feature to verify that the correct behavior is present.

A full description of the assignment may be found [https://docs.google.com/document/d/13oRmKemlwRzXG1ItcI2zTx4r3gAAfvmuobZjxiy0oVo/edit#heading=h.su78b3gdq1a7 here]

== Classes involved ==
* questionnaires_controller.rb
* spec/features/quiz_spec.rb

== What it does ==
The purpose of this assignment is to enhance readability, DRYness, and maintainability of Expertiza code through refactoring and functional testing.

== What is wrong with it ==
The valid_quiz method in questionnaires_controller needs to be refactored. This method should not check the questions one by one, instead, it should create the quiz_question objects and quiz_choice objects, then call “quiz_question.valid?” to check whether the question is valid.

== What needs to be done ==
Student-generated quizzes is the feature that students use for writing quizzes for the Wikipedia contribution assignment. In this project, you need to do refactoring and create functional tests for this feature:
* Refactoring:
** Refactor the valid_quiz method in questionnaires_controller. This method should not check the questions one by one, instead, it should create the quiz_question objects and quiz_choice objects, then call “quiz_question.valid?” to check whether the question is valid.
* Testing:
** The instructor can set up an assignment which supports quizzing feature by
*** Checking the “has quiz” box
*** Setting the # of question for each set of quiz
*** Setting in which deadline can student reviewers take the quizzes
** Student authors can create quizzes and edit them:
*** They can create quizzes on the “Your work” page
*** They can edit the quiz questions.
*** They can view the quiz questions.
*** If the quiz question has something missing, the system will flash an error message, either:
**** The name of quiz is missing.
**** The question text is missing for one or more questions.
**** The choices are missing for one or more questions.
**** The correct answer(s) have not been provided.
** Student reviewers can take the quizzes on the work they have reviewed/they need to review
*** They need to request the artifact to review first. If this artifact has a quiz associated, they can take the quiz in the round which quiz-taking is allowed.
*** They can click “take quiz” then request quizzes to take.
*** They can fill in their choices on the quizzes.
*** After taking the quizzes, and submitting, they will see their grade on the “Take quizzes” page
*** On the “take quizzes” page, they can see their question-by-question scores for finished quizzes by clicking “view”
** Instructor can view the quiz questions and quiz scores on the tree display by clicking “view quiz questions” icon.

= Scope =
This project can be divided into major work items:

# Instructors is able to create and manage an assignment's quiz feature.
# Instructors can view quiz questions and scores from the tree view.
# Students can create quizzes and edit them.
# Students can take quizzes on assignments they have reviewed.
# Refactor questionnaires_controller#valid_quiz

= Implementation =
Quiz test will be added to spec/features/quiz_spec.rb and will make use of
* rspec
* capybara
* selenium

Additionally, refactoring on questionnaires_controller may include the creation of the valid? method in app/models/quiz_question.rb.

=Design=
Design for the refactoring will be driven by object oriented principles and test-driven-development.

==QuizQuestion==
Implement a <code>validate</code> method that validates a quiz question for correctness including
* Has text
* Has type
* Has all options
* Has a correct answer
** If radio only one correct answer
** If checkbox at least one correct anser

==QuizQuestionnaire==
Implement a <code>validate</code> method that validates a quiz and all of its questions for correctness including
* Has name

==QuestionnaireController==
Refactor the <code>valid_quiz</code> method to construct a new quiz object with submitted questions. This quiz object will be validated using <code>quiz.validate</code>.

==Test Cases==
Implement unit test cases for each of the methods listed above.

= References =
<references/>

User:Mxu

2016-04-01T20:05:01Z

Ewhorton: /* Design */

===CSC/ECE 517 Spring 2016 E1621: Refactor and test the quizzing feature===

= Introduction to Expertiza =
Expertiza<ref>https://github.com/expertiza/expertiza</ref> is a project developed using Ruby on Rails<ref>http://guides.rubyonrails.org/getting_started.html</ref>. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an [https://en.wikipedia.org/wiki/Open_source open source] application and the code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

= Problem Statement =
The Expertiza quiz feature is in need of refactoring. Currently, quizzes are checked by questionnaires_controller#valid_quiz. This method is rather long, involved, and does not take advantage of object-oriented practices. We will refactor the method to construct a quiz question object and then call valid? to check if the question is valid. This is an improvement over the current code which checks all questions manually.

In addition to this refactoring we will implement integration testing on the quiz feature to verify that the correct behavior is present.

A full description of the assignment may be found [https://docs.google.com/document/d/13oRmKemlwRzXG1ItcI2zTx4r3gAAfvmuobZjxiy0oVo/edit#heading=h.su78b3gdq1a7 here]

== Classes involved ==
* questionnaires_controller.rb
* spec/features/quiz_spec.rb

== What it does ==
The purpose of this assignment is to enhance readability, DRYness, and maintainability of Expertiza code through refactoring and functional testing.

== What is wrong with it ==
The valid_quiz method in questionnaires_controller needs to be refactored. This method should not check the questions one by one, instead, it should create the quiz_question objects and quiz_choice objects, then call “quiz_question.valid?” to check whether the question is valid.

== What needs to be done ==
Student-generated quizzes is the feature that students use for writing quizzes for the Wikipedia contribution assignment. In this project, you need to do refactoring and create functional tests for this feature:
* Refactoring:
** Refactor the valid_quiz method in questionnaires_controller. This method should not check the questions one by one, instead, it should create the quiz_question objects and quiz_choice objects, then call “quiz_question.valid?” to check whether the question is valid.
* Testing:
** The instructor can set up an assignment which supports quizzing feature by
*** Checking the “has quiz” box
*** Setting the # of question for each set of quiz
*** Setting in which deadline can student reviewers take the quizzes
** Student authors can create quizzes and edit them:
*** They can create quizzes on the “Your work” page
*** They can edit the quiz questions.
*** They can view the quiz questions.
*** If the quiz question has something missing, the system will flash an error message, either:
**** The name of quiz is missing.
**** The question text is missing for one or more questions.
**** The choices are missing for one or more questions.
**** The correct answer(s) have not been provided.
** Student reviewers can take the quizzes on the work they have reviewed/they need to review
*** They need to request the artifact to review first. If this artifact has a quiz associated, they can take the quiz in the round which quiz-taking is allowed.
*** They can click “take quiz” then request quizzes to take.
*** They can fill in their choices on the quizzes.
*** After taking the quizzes, and submitting, they will see their grade on the “Take quizzes” page
*** On the “take quizzes” page, they can see their question-by-question scores for finished quizzes by clicking “view”
** Instructor can view the quiz questions and quiz scores on the tree display by clicking “view quiz questions” icon.

= Scope =
This project can be divided into major work items:

# Instructors is able to create and manage an assignment's quiz feature.
# Instructors can view quiz questions and scores from the tree view.
# Students can create quizzes and edit them.
# Students can take quizzes on assignments they have reviewed.
# Refactor questionnaires_controller#valid_quiz

= Implementation =
Quiz test will be added to spec/features/quiz_spec.rb and will make use of
* rspec
* capybara
* selenium

Additionally, refactoring on questionnaires_controller may include the creation of the valid? method in app/models/quiz_question.rb.

=Design=
Design for the refactoring will be driven by object oriented principles and test-driven-development.

==QuizQuestion==
Implement a <code>validate</code> method that validates a quiz question for correctness including
* Has text
* Has type
* Has all options
* Has a correct answer
** If radio only one correct answer
** If checkbox at least one correct anser

==QuizQuestionnaire==
Implement a <code>validate></code> method that validate a quiz and all of its questions for correctness including
* Has name

==QuestionnaireController==
Refactor the <code>valid_quiz</code> method to construct a new quiz object with submitted questions. This quiz object will be validated using <code>quiz.validate</code>.

==Test Cases==
Implement unit test cases for each of the methods listed above.

= References =
<references/>

User:Mxu

2016-03-28T22:31:35Z

Ewhorton: /* Problem Statement */

User:Mxu

2016-03-28T22:18:25Z

Ewhorton: /* Design */

User:Mxu

2016-03-28T22:13:44Z

Ewhorton: /* Implementation */

User:Mxu

2016-03-28T22:10:29Z

Ewhorton: /* Scope */

User:Mxu

2016-03-28T22:07:29Z

Ewhorton:

User:Mxu

2016-03-28T22:06:43Z

Ewhorton: /* Problem Statement */

User:Mxu

2016-03-28T21:57:52Z

Ewhorton: /* Introduction to Expertiza */

User:Ewhorton

2016-03-21T12:20:44Z

Ewhorton: /* Test Results */

File:Calibration-tests.png

2016-03-21T12:20:34Z

Ewhorton: uploaded a new version of "File:Calibration-tests.png"

File:Calibration-tests.png

2016-03-21T12:17:44Z

Ewhorton:

User:Ewhorton

2016-03-21T11:38:50Z

Ewhorton: /* Flow of the calibration function */

User:Ewhorton

2016-03-21T11:38:16Z

Ewhorton: /* Motivation */

User:Ewhorton

2016-03-19T02:22:26Z

Ewhorton: Pointing project resources to github fork.

'''Expertiza''' is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. <ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref>

==Introduction==
Our contribution to this project is a suite of functional tests for the assignment calibration function. These tests are designed to provide integration, regression, and acceptance testing by using automation technologies.

===Problem Statement===
Expertiza has a feature called Calibration that can be turned on for an assignment. When this feature is enabled an expert, typically the instructor, can provide an expert review for the assignment artifacts. After students finish their own reviews they may compare their responses to the expert review. The instructor may also view calibration results to view the scores for the entire class.

While this is a preexisting feature within Expertiza, there currently exist no tests for it. The goal of this project is to fully test the entire flow of the calibration feature using the '''RSpec''' and '''Capybara''' frameworks.

===Motivation===
The moment a line of code is written it becomes legacy code in need of support. Test cases are used not only to ensure that code is operating properly, but also to ensure that it continues to do so after having been modified. An important aspect of this is acceptance testing to verify that the project meets customer requirements. Rather than performing these tests by hand, it is easier to combine an automated testing system like RSpec with a driver like Capybara which allows testing of an application's functionality from the outside either by running in a headless browser.

===Flow of the calibration function===
A more detailed description of the calibration may be found [https://docs.google.com/document/d/1LcicJCUY0GHN1qzwRQPL9A1Nv89sVtNtxlADOzVQeBk/edit#heading=h.g4vilf87e3f0 here]

Before analyzing code, one must familiarize themselves with the steps involved in assignment submission by student on Expertiza. The steps involved are:
# Login with valid instructor username and password
# Click on "Assignment"
# Click on "New public assignment"
# Input all the information needed, check the “Calibrated peer-review for training?” box, click on Create
# Select the review rubric in “Rubrics” tab
# Go to “Due dates” tab, make sure that this assignment is currently in Review phase, also, make the submission allowed in review phase.
# Add a submitter to the assignment. This submitter will add documents to be reviewed.
# Go to the list of assignments, click “edit” icon of the assignment
# Go to the “Calibration” tab, click on the "Begin" link next to the student artifact for the expert review, and click “Submit Review”
# Go to “Review strategy” tab, select Instructor-Selected as review strategy, then select the radio button “Set number of reviews done by each student” and input the number of reviews
# Login with valid student username and password who is a reviewer for the assignment
# Click on the assignment
# Click on “Other’s work”
# After clicking “Begin”, Expertiza will display peer-review page
# Click “Submit Review”
# Click “Show calibration results” to see expert review
# Login with valid instructor username and password
# Click on "Assignment"
# Click on the “view review report” to see the calibration report

== Creating the Tests==

===Gems involved===
* rspec-rails
* capybara
* selenium-webdriver
* factory_girl_rails

====rspec-rails====
Rspec-rails is a testing framework for Rails 3.x and 4.x. It supports testing of models, controllers, requests, features, views and routes. It does this by accepting test scenarios called specs.<ref>[https://github.com/rspec/rspec-rails rpsce-rails on GitHub]</ref>

====capybara====
Capybara helps you test web applications by simulating how a real user would interact with your application. It comes with built in Rack::Test and Selenium support. WebKit is supported through an external gem.<ref>[https://github.com/jnicklas/capybara capybara on GitHub]</ref> To control the environments in which the scenarios are run, it provides before and after hooks.<ref>[https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/hooks/before-and-after-hooks Before and after hooks]</ref>
*before(:each) blocks are run before each scenario in the group
*before(:all) blocks are run once before all of the scenarios in the group
*after(:each) blocks are run after each scenario in the group
*after(:all) blocks are run once after all of the scenarios in the group

====selenium====
Selenium is a portable software testing framework for web applications. Selenium provides a record/playback tool for authoring tests without learning a test scripting language (Selenium IDE). It is the default javascript webdriver for Capybara.

====factory girl====
Factory Girl is a factory gem meant for use in testing. It allows for easy and highly configurable on-the-fly model creation that allows tests to request a new instance of a model template and optionally override any of the defaults.

===Test Scenarios===
The following scenarios were considered when writing tests for the calibration use case:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An instructor creates a calibrated assignment
:An instructor authenticates to expertiza
:They select to add a new assignment
:While creating the assignment, the instructor selects to turn calibration on
:After creating the assignment the instructor sees a calibration tab on the assignment page
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An instructor edits the calibration configuration
:An instructor authenticates to expertiza
:They select to edit an existing assignment
:The instructor clicks on the calibration tab and sees it is populated with submitted artifacts
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An expert submits a review for calibration
:An expert has been added to an assignment to provide the expert review
:The expert authenticates to Expertiza and begins the expert review
:The expert finishes and submits the review
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Student Calibration
:A student has submitted a response for the assignment and it is currently in the review phase
:The student authenticates to Expertiza and chooses to view calibration for the assignment
:The student sees their own answers compared to the expert review.
:Answers that match are marked green, and answers that differ are marked red.
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Instructor Calibration
:It is currently the review phase for an assignment
:An instructor authenticates to Expertiza and chooses to view calibration
:The instructor can see the percentages relating to student responses for the assignment
</div>

===Code===
Code for the tests exists in two locations
* [https://github.com/EricHorton/expertiza/blob/master/spec/factories/factories.rb Factory]
* [https://github.com/EricHorton/expertiza/blob/master/spec/features/calibration_spec.rb CalibrationSpec]

====Structure====
Our specs follow the standard RSpec describe/it syntax. For example:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">

describe 'Some Feature' do
:before :each do

:end

:it 'should do x' do
::expect(true).to be(true)
:end

:it 'should not do y' do
::expect(true).to be(false)
:end
end
</div>

==Running the tests==

The following are steps required to run the test

* Clone the repository in a new directory
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ git clone https://github.com/EricHorton/expertiza
</pre>

Create and then prepare the test database
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ cd expertiza
$ rake db:test:prepare
</pre>

* Type the command to run tests for assignment submission
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
rspec spec/features/calibration_spec.rb
</pre>

==Test Results==

The following screenshot shows the result of the rspec command.

[[File:test_result_temp2_expertiza.jpg|Feature Test Result]]

=== Test Analysis ===

* All test cases are green, which means there are no currently failing tests.
* Test cases are run through the Selenium driver on Firefox for javascript support. Because they are full acceptance tests they are slower than regular unit tests, but still beat evaluating the feature by hand.
* Tests are independent and repeatable. Database changes are made within a transaction that is rolled back after tests complete.

==Project Resources==
# [https://github.com/EricHorton/expertiza GitHub Fork]

=References=
<references></references>

=External links=
* [http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Documentation]

User:Ewhorton

2016-03-19T02:19:41Z

Ewhorton: Filling in test analysis for our tests.

'''Expertiza''' is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. <ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref>

==Introduction==
Our contribution to this project is a suite of functional tests for the assignment calibration function. These tests are designed to provide integration, regression, and acceptance testing by using automation technologies.

===Problem Statement===
Expertiza has a feature called Calibration that can be turned on for an assignment. When this feature is enabled an expert, typically the instructor, can provide an expert review for the assignment artifacts. After students finish their own reviews they may compare their responses to the expert review. The instructor may also view calibration results to view the scores for the entire class.

While this is a preexisting feature within Expertiza, there currently exist no tests for it. The goal of this project is to fully test the entire flow of the calibration feature using the '''RSpec''' and '''Capybara''' frameworks.

===Motivation===
The moment a line of code is written it becomes legacy code in need of support. Test cases are used not only to ensure that code is operating properly, but also to ensure that it continues to do so after having been modified. An important aspect of this is acceptance testing to verify that the project meets customer requirements. Rather than performing these tests by hand, it is easier to combine an automated testing system like RSpec with a driver like Capybara which allows testing of an application's functionality from the outside either by running in a headless browser.

===Flow of the calibration function===
A more detailed description of the calibration may be found [https://docs.google.com/document/d/1LcicJCUY0GHN1qzwRQPL9A1Nv89sVtNtxlADOzVQeBk/edit#heading=h.g4vilf87e3f0 here]

Before analyzing code, one must familiarize themselves with the steps involved in assignment submission by student on Expertiza. The steps involved are:
# Login with valid instructor username and password
# Click on "Assignment"
# Click on "New public assignment"
# Input all the information needed, check the “Calibrated peer-review for training?” box, click on Create
# Select the review rubric in “Rubrics” tab
# Go to “Due dates” tab, make sure that this assignment is currently in Review phase, also, make the submission allowed in review phase.
# Add a submitter to the assignment. This submitter will add documents to be reviewed.
# Go to the list of assignments, click “edit” icon of the assignment
# Go to the “Calibration” tab, click on the "Begin" link next to the student artifact for the expert review, and click “Submit Review”
# Go to “Review strategy” tab, select Instructor-Selected as review strategy, then select the radio button “Set number of reviews done by each student” and input the number of reviews
# Login with valid student username and password who is a reviewer for the assignment
# Click on the assignment
# Click on “Other’s work”
# After clicking “Begin”, Expertiza will display peer-review page
# Click “Submit Review”
# Click “Show calibration results” to see expert review
# Login with valid instructor username and password
# Click on "Assignment"
# Click on the “view review report” to see the calibration report

== Creating the Tests==

===Gems involved===
* rspec-rails
* capybara
* selenium-webdriver
* factory_girl_rails

====rspec-rails====
Rspec-rails is a testing framework for Rails 3.x and 4.x. It supports testing of models, controllers, requests, features, views and routes. It does this by accepting test scenarios called specs.<ref>[https://github.com/rspec/rspec-rails rpsce-rails on GitHub]</ref>

====capybara====
Capybara helps you test web applications by simulating how a real user would interact with your application. It comes with built in Rack::Test and Selenium support. WebKit is supported through an external gem.<ref>[https://github.com/jnicklas/capybara capybara on GitHub]</ref> To control the environments in which the scenarios are run, it provides before and after hooks.<ref>[https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/hooks/before-and-after-hooks Before and after hooks]</ref>
*before(:each) blocks are run before each scenario in the group
*before(:all) blocks are run once before all of the scenarios in the group
*after(:each) blocks are run after each scenario in the group
*after(:all) blocks are run once after all of the scenarios in the group

====selenium====
Selenium is a portable software testing framework for web applications. Selenium provides a record/playback tool for authoring tests without learning a test scripting language (Selenium IDE). It is the default javascript webdriver for Capybara.

====factory girl====
Factory Girl is a factory gem meant for use in testing. It allows for easy and highly configurable on-the-fly model creation that allows tests to request a new instance of a model template and optionally override any of the defaults.

===Test Scenarios===
The following scenarios were considered when writing tests for the calibration use case:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An instructor creates a calibrated assignment
:An instructor authenticates to expertiza
:They select to add a new assignment
:While creating the assignment, the instructor selects to turn calibration on
:After creating the assignment the instructor sees a calibration tab on the assignment page
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An instructor edits the calibration configuration
:An instructor authenticates to expertiza
:They select to edit an existing assignment
:The instructor clicks on the calibration tab and sees it is populated with submitted artifacts
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An expert submits a review for calibration
:An expert has been added to an assignment to provide the expert review
:The expert authenticates to Expertiza and begins the expert review
:The expert finishes and submits the review
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Student Calibration
:A student has submitted a response for the assignment and it is currently in the review phase
:The student authenticates to Expertiza and chooses to view calibration for the assignment
:The student sees their own answers compared to the expert review.
:Answers that match are marked green, and answers that differ are marked red.
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Instructor Calibration
:It is currently the review phase for an assignment
:An instructor authenticates to Expertiza and chooses to view calibration
:The instructor can see the percentages relating to student responses for the assignment
</div>

===Code===
Code for the tests exists in two locations
* [https://github.com/EricHorton/expertiza/blob/master/spec/factories/factories.rb Factory]
* [https://github.com/EricHorton/expertiza/blob/master/spec/features/calibration_spec.rb CalibrationSpec]

====Structure====
Our specs follow the standard RSpec describe/it syntax. For example:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">

describe 'Some Feature' do
:before :each do

:end

:it 'should do x' do
::expect(true).to be(true)
:end

:it 'should not do y' do
::expect(true).to be(false)
:end
end
</div>

==Running the tests==

The following are steps required to run the test

* Clone the repository in a new directory
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ git clone https://github.com/EricHorton/expertiza
</pre>

Create and then prepare the test database
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ cd expertiza
$ rake db:test:prepare
</pre>

* Type the command to run tests for assignment submission
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
rspec spec/features/calibration_spec.rb
</pre>

==Test Results==

The following screenshot shows the result of the rspec command.

[[File:test_result_temp2_expertiza.jpg|Feature Test Result]]

=== Test Analysis ===

* All test cases are green, which means there are no currently failing tests.
* Test cases are run through the Selenium driver on Firefox for javascript support. Because they are full acceptance tests they are slower than regular unit tests, but still beat evaluating the feature by hand.
* Tests are independent and repeatable. Database changes are made within a transaction that is rolled back after tests complete.

==Project Resources==
# [https://github.com/shrenujgandhi/expertiza GitHub Link]
# [https://youtu.be/_58l0VPy04M YouTube Demo]

=References=
<references></references>

=External links=
* [http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Documentation]

User:Ewhorton

2016-03-19T02:09:33Z

Ewhorton: Editing for calibration tests.

'''Expertiza''' is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. <ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref>

==Introduction==
Our contribution to this project is a suite of functional tests for the assignment calibration function. These tests are designed to provide integration, regression, and acceptance testing by using automation technologies.

===Problem Statement===
Expertiza has a feature called Calibration that can be turned on for an assignment. When this feature is enabled an expert, typically the instructor, can provide an expert review for the assignment artifacts. After students finish their own reviews they may compare their responses to the expert review. The instructor may also view calibration results to view the scores for the entire class.

While this is a preexisting feature within Expertiza, there currently exist no tests for it. The goal of this project is to fully test the entire flow of the calibration feature using the '''RSpec''' and '''Capybara''' frameworks.

===Motivation===
The moment a line of code is written it becomes legacy code in need of support. Test cases are used not only to ensure that code is operating properly, but also to ensure that it continues to do so after having been modified. An important aspect of this is acceptance testing to verify that the project meets customer requirements. Rather than performing these tests by hand, it is easier to combine an automated testing system like RSpec with a driver like Capybara which allows testing of an application's functionality from the outside either by running in a headless browser.

===Flow of the calibration function===
A more detailed description of the calibration may be found [https://docs.google.com/document/d/1LcicJCUY0GHN1qzwRQPL9A1Nv89sVtNtxlADOzVQeBk/edit#heading=h.g4vilf87e3f0 here]

Before analyzing code, one must familiarize themselves with the steps involved in assignment submission by student on Expertiza. The steps involved are:
# Login with valid instructor username and password
# Click on "Assignment"
# Click on "New public assignment"
# Input all the information needed, check the “Calibrated peer-review for training?” box, click on Create
# Select the review rubric in “Rubrics” tab
# Go to “Due dates” tab, make sure that this assignment is currently in Review phase, also, make the submission allowed in review phase.
# Add a submitter to the assignment. This submitter will add documents to be reviewed.
# Go to the list of assignments, click “edit” icon of the assignment
# Go to the “Calibration” tab, click on the "Begin" link next to the student artifact for the expert review, and click “Submit Review”
# Go to “Review strategy” tab, select Instructor-Selected as review strategy, then select the radio button “Set number of reviews done by each student” and input the number of reviews
# Login with valid student username and password who is a reviewer for the assignment
# Click on the assignment
# Click on “Other’s work”
# After clicking “Begin”, Expertiza will display peer-review page
# Click “Submit Review”
# Click “Show calibration results” to see expert review
# Login with valid instructor username and password
# Click on "Assignment"
# Click on the “view review report” to see the calibration report

== Creating the Tests==

===Gems involved===
* rspec-rails
* capybara
* selenium-webdriver
* factory_girl_rails

====rspec-rails====
Rspec-rails is a testing framework for Rails 3.x and 4.x. It supports testing of models, controllers, requests, features, views and routes. It does this by accepting test scenarios called specs.<ref>[https://github.com/rspec/rspec-rails rpsce-rails on GitHub]</ref>

====capybara====
Capybara helps you test web applications by simulating how a real user would interact with your application. It comes with built in Rack::Test and Selenium support. WebKit is supported through an external gem.<ref>[https://github.com/jnicklas/capybara capybara on GitHub]</ref> To control the environments in which the scenarios are run, it provides before and after hooks.<ref>[https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/hooks/before-and-after-hooks Before and after hooks]</ref>
*before(:each) blocks are run before each scenario in the group
*before(:all) blocks are run once before all of the scenarios in the group
*after(:each) blocks are run after each scenario in the group
*after(:all) blocks are run once after all of the scenarios in the group

====selenium====
Selenium is a portable software testing framework for web applications. Selenium provides a record/playback tool for authoring tests without learning a test scripting language (Selenium IDE). It is the default javascript webdriver for Capybara.

====factory girl====
Factory Girl is a factory gem meant for use in testing. It allows for easy and highly configurable on-the-fly model creation that allows tests to request a new instance of a model template and optionally override any of the defaults.

===Test Scenarios===
The following scenarios were considered when writing tests for the calibration use case:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An instructor creates a calibrated assignment
:An instructor authenticates to expertiza
:They select to add a new assignment
:While creating the assignment, the instructor selects to turn calibration on
:After creating the assignment the instructor sees a calibration tab on the assignment page
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An instructor edits the calibration configuration
:An instructor authenticates to expertiza
:They select to edit an existing assignment
:The instructor clicks on the calibration tab and sees it is populated with submitted artifacts
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An expert submits a review for calibration
:An expert has been added to an assignment to provide the expert review
:The expert authenticates to Expertiza and begins the expert review
:The expert finishes and submits the review
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Student Calibration
:A student has submitted a response for the assignment and it is currently in the review phase
:The student authenticates to Expertiza and chooses to view calibration for the assignment
:The student sees their own answers compared to the expert review.
:Answers that match are marked green, and answers that differ are marked red.
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Instructor Calibration
:It is currently the review phase for an assignment
:An instructor authenticates to Expertiza and chooses to view calibration
:The instructor can see the percentages relating to student responses for the assignment
</div>

===Code===
Code for the tests exists in two locations
* [https://github.com/EricHorton/expertiza/blob/master/spec/factories/factories.rb Factory]
* [https://github.com/EricHorton/expertiza/blob/master/spec/features/calibration_spec.rb CalibrationSpec]

====Structure====
Our specs follow the standard RSpec describe/it syntax. For example:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">

describe 'Some Feature' do
:before :each do

:end

:it 'should do x' do
::expect(true).to be(true)
:end

:it 'should not do y' do
::expect(true).to be(false)
:end
end
</div>

==Running the tests==

The following are steps required to run the test

* Clone the repository in a new directory
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ git clone https://github.com/EricHorton/expertiza
</pre>

Create and then prepare the test database
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ cd expertiza
$ rake db:test:prepare
</pre>

* Type the command to run tests for assignment submission
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
rspec spec/features/calibration_spec.rb
</pre>

==Test Results==

The following screenshot shows the result of the rspec command.

[[File:test_result_temp2_expertiza.jpg|Feature Test Result]]

=== Test Analysis ===

* ''7 examples, 0 failures'' imply that there are 7 test scenarios and none of them failed.
* The tests take around 35 seconds to run, which implies that they are fast.
* They are also repeatable as the assignments that are created in the ''before all'' block are also deleted in the ''after all'' block.
* They are also self-verifying as all the results are in green, which mean that all the cases passed.

==Project Resources==
# [https://github.com/shrenujgandhi/expertiza GitHub Link]
# [https://youtu.be/_58l0VPy04M YouTube Demo]

=References=
<references></references>

=External links=
* [http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Documentation]

User:Ewhorton

2016-03-19T02:06:33Z

Ewhorton: Simplifying code structure description. Linking to project files.

'''Expertiza''' is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. <ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref>

==Introduction==
Our contribution to this project is a suite of functional tests for the assignment calibration function. These tests are designed to provide integration, regression, and acceptance testing by using automation technologies.

===Problem Statement===
Expertiza has a feature called Calibration that can be turned on for an assignment. When this feature is enabled an expert, typically the instructor, can provide an expert review for the assignment artifacts. After students finish their own reviews they may compare their responses to the expert review. The instructor may also view calibration results to view the scores for the entire class.

While this is a preexisting feature within Expertiza, there currently exist no tests for it. The goal of this project is to fully test the entire flow of the calibration feature using the '''RSpec''' and '''Capybara''' frameworks.

===Motivation===
The moment a line of code is written it becomes legacy code in need of support. Test cases are used not only to ensure that code is operating properly, but also to ensure that it continues to do so after having been modified. An important aspect of this is acceptance testing to verify that the project meets customer requirements. Rather than performing these tests by hand, it is easier to combine an automated testing system like RSpec with a driver like Capybara which allows testing of an application's functionality from the outside either by running in a headless browser.

===Flow of the calibration function===
A more detailed description of the calibration may be found [https://docs.google.com/document/d/1LcicJCUY0GHN1qzwRQPL9A1Nv89sVtNtxlADOzVQeBk/edit#heading=h.g4vilf87e3f0 here]

Before analyzing code, one must familiarize themselves with the steps involved in assignment submission by student on Expertiza. The steps involved are:
# Login with valid instructor username and password
# Click on "Assignment"
# Click on "New public assignment"
# Input all the information needed, check the “Calibrated peer-review for training?” box, click on Create
# Select the review rubric in “Rubrics” tab
# Go to “Due dates” tab, make sure that this assignment is currently in Review phase, also, make the submission allowed in review phase.
# Add a submitter to the assignment. This submitter will add documents to be reviewed.
# Go to the list of assignments, click “edit” icon of the assignment
# Go to the “Calibration” tab, click on the "Begin" link next to the student artifact for the expert review, and click “Submit Review”
# Go to “Review strategy” tab, select Instructor-Selected as review strategy, then select the radio button “Set number of reviews done by each student” and input the number of reviews
# Login with valid student username and password who is a reviewer for the assignment
# Click on the assignment
# Click on “Other’s work”
# After clicking “Begin”, Expertiza will display peer-review page
# Click “Submit Review”
# Click “Show calibration results” to see expert review
# Login with valid instructor username and password
# Click on "Assignment"
# Click on the “view review report” to see the calibration report

== Creating the Tests==

===Gems involved===
* rspec-rails
* capybara
* selenium-webdriver
* factory_girl_rails

====rspec-rails====
Rspec-rails is a testing framework for Rails 3.x and 4.x. It supports testing of models, controllers, requests, features, views and routes. It does this by accepting test scenarios called specs.<ref>[https://github.com/rspec/rspec-rails rpsce-rails on GitHub]</ref>

====capybara====
Capybara helps you test web applications by simulating how a real user would interact with your application. It comes with built in Rack::Test and Selenium support. WebKit is supported through an external gem.<ref>[https://github.com/jnicklas/capybara capybara on GitHub]</ref> To control the environments in which the scenarios are run, it provides before and after hooks.<ref>[https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/hooks/before-and-after-hooks Before and after hooks]</ref>
*before(:each) blocks are run before each scenario in the group
*before(:all) blocks are run once before all of the scenarios in the group
*after(:each) blocks are run after each scenario in the group
*after(:all) blocks are run once after all of the scenarios in the group

====selenium====
Selenium is a portable software testing framework for web applications. Selenium provides a record/playback tool for authoring tests without learning a test scripting language (Selenium IDE). It is the default javascript webdriver for Capybara.

====factory girl====
Factory Girl is a factory gem meant for use in testing. It allows for easy and highly configurable on-the-fly model creation that allows tests to request a new instance of a model template and optionally override any of the defaults.

===Test Scenarios===
The following scenarios were considered when writing tests for the calibration use case:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An instructor creates a calibrated assignment
:An instructor authenticates to expertiza
:They select to add a new assignment
:While creating the assignment, the instructor selects to turn calibration on
:After creating the assignment the instructor sees a calibration tab on the assignment page
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An instructor edits the calibration configuration
:An instructor authenticates to expertiza
:They select to edit an existing assignment
:The instructor clicks on the calibration tab and sees it is populated with submitted artifacts
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An expert submits a review for calibration
:An expert has been added to an assignment to provide the expert review
:The expert authenticates to Expertiza and begins the expert review
:The expert finishes and submits the review
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Student Calibration
:A student has submitted a response for the assignment and it is currently in the review phase
:The student authenticates to Expertiza and chooses to view calibration for the assignment
:The student sees their own answers compared to the expert review.
:Answers that match are marked green, and answers that differ are marked red.
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Instructor Calibration
:It is currently the review phase for an assignment
:An instructor authenticates to Expertiza and chooses to view calibration
:The instructor can see the percentages relating to student responses for the assignment
</div>

===Code===
Code for the tests exists in two locations
* [https://github.com/EricHorton/expertiza/blob/master/spec/factories/factories.rb Factory]
* [https://github.com/EricHorton/expertiza/blob/master/spec/features/calibration_spec.rb CalibrationSpec]

====Structure====
Our specs follow the standard RSpec describe/it syntax. For example:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">

describe 'Some Feature' do
:before :each do

:end

:it 'should do x' do
::expect(true).to be(true)
:end

:it 'should not do y' do
::expect(true).to be(false)
:end
end
</div>

==Running the tests==

The following are steps required to run the test

* Clone the repository in a new directory
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ mkdir review
$ cd review
$ git clone https://github.com/shrenujgandhi/expertiza.git
</pre>

In case you don't have a database with student and instructor entries then download the dump from https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uESEkzSWpJRnhGbmc/view. Extract its contents.
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ cd expertiza
$ rake db:create:all
$ cd Downloads/
$ mysql -u root -p expertiza_development < expertiza_scrubbed_2015_08_14.sql
password:

$ cd expertiza
$ rake db:migrate
</pre>

* Type the command to run tests for assignment submission
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
rspec spec/features/student_submission_spec.rb
</pre>

==Test Results==

The following screenshot shows the result of the rspec command.

[[File:test_result_temp2_expertiza.jpg|Feature Test Result]]

=== Test Analysis ===

* ''7 examples, 0 failures'' imply that there are 7 test scenarios and none of them failed.
* The tests take around 35 seconds to run, which implies that they are fast.
* They are also repeatable as the assignments that are created in the ''before all'' block are also deleted in the ''after all'' block.
* They are also self-verifying as all the results are in green, which mean that all the cases passed.

==Project Resources==
# [https://github.com/shrenujgandhi/expertiza GitHub Link]
# [https://youtu.be/_58l0VPy04M YouTube Demo]

=References=
<references></references>

=External links=
* [http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Documentation]

User:Ewhorton

2016-03-19T01:55:58Z

Ewhorton: /* Test Scenarios */

'''Expertiza''' is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. <ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref>

==Introduction==
Our contribution to this project is a suite of functional tests for the assignment calibration function. These tests are designed to provide integration, regression, and acceptance testing by using automation technologies.

===Problem Statement===
Expertiza has a feature called Calibration that can be turned on for an assignment. When this feature is enabled an expert, typically the instructor, can provide an expert review for the assignment artifacts. After students finish their own reviews they may compare their responses to the expert review. The instructor may also view calibration results to view the scores for the entire class.

While this is a preexisting feature within Expertiza, there currently exist no tests for it. The goal of this project is to fully test the entire flow of the calibration feature using the '''RSpec''' and '''Capybara''' frameworks.

===Motivation===
The moment a line of code is written it becomes legacy code in need of support. Test cases are used not only to ensure that code is operating properly, but also to ensure that it continues to do so after having been modified. An important aspect of this is acceptance testing to verify that the project meets customer requirements. Rather than performing these tests by hand, it is easier to combine an automated testing system like RSpec with a driver like Capybara which allows testing of an application's functionality from the outside either by running in a headless browser.

===Flow of the calibration function===
A more detailed description of the calibration may be found [https://docs.google.com/document/d/1LcicJCUY0GHN1qzwRQPL9A1Nv89sVtNtxlADOzVQeBk/edit#heading=h.g4vilf87e3f0 here]

Before analyzing code, one must familiarize themselves with the steps involved in assignment submission by student on Expertiza. The steps involved are:
# Login with valid instructor username and password
# Click on "Assignment"
# Click on "New public assignment"
# Input all the information needed, check the “Calibrated peer-review for training?” box, click on Create
# Select the review rubric in “Rubrics” tab
# Go to “Due dates” tab, make sure that this assignment is currently in Review phase, also, make the submission allowed in review phase.
# Add a submitter to the assignment. This submitter will add documents to be reviewed.
# Go to the list of assignments, click “edit” icon of the assignment
# Go to the “Calibration” tab, click on the "Begin" link next to the student artifact for the expert review, and click “Submit Review”
# Go to “Review strategy” tab, select Instructor-Selected as review strategy, then select the radio button “Set number of reviews done by each student” and input the number of reviews
# Login with valid student username and password who is a reviewer for the assignment
# Click on the assignment
# Click on “Other’s work”
# After clicking “Begin”, Expertiza will display peer-review page
# Click “Submit Review”
# Click “Show calibration results” to see expert review
# Login with valid instructor username and password
# Click on "Assignment"
# Click on the “view review report” to see the calibration report

== Creating the Tests==

===Gems involved===
* rspec-rails
* capybara
* selenium-webdriver
* factory_girl_rails

====rspec-rails====
Rspec-rails is a testing framework for Rails 3.x and 4.x. It supports testing of models, controllers, requests, features, views and routes. It does this by accepting test scenarios called specs.<ref>[https://github.com/rspec/rspec-rails rpsce-rails on GitHub]</ref>

====capybara====
Capybara helps you test web applications by simulating how a real user would interact with your application. It comes with built in Rack::Test and Selenium support. WebKit is supported through an external gem.<ref>[https://github.com/jnicklas/capybara capybara on GitHub]</ref> To control the environments in which the scenarios are run, it provides before and after hooks.<ref>[https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/hooks/before-and-after-hooks Before and after hooks]</ref>
*before(:each) blocks are run before each scenario in the group
*before(:all) blocks are run once before all of the scenarios in the group
*after(:each) blocks are run after each scenario in the group
*after(:all) blocks are run once after all of the scenarios in the group

====selenium====
Selenium is a portable software testing framework for web applications. Selenium provides a record/playback tool for authoring tests without learning a test scripting language (Selenium IDE). It is the default javascript webdriver for Capybara.

====factory girl====
Factory Girl is a factory gem meant for use in testing. It allows for easy and highly configurable on-the-fly model creation that allows tests to request a new instance of a model template and optionally override any of the defaults.

===Test Scenarios===
The following scenarios were considered when writing tests for the calibration use case:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An instructor creates a calibrated assignment
:An instructor authenticates to expertiza
:They select to add a new assignment
:While creating the assignment, the instructor selects to turn calibration on
:After creating the assignment the instructor sees a calibration tab on the assignment page
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An instructor edits the calibration configuration
:An instructor authenticates to expertiza
:They select to edit an existing assignment
:The instructor clicks on the calibration tab and sees it is populated with submitted artifacts
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
An expert submits a review for calibration
:An expert has been added to an assignment to provide the expert review
:The expert authenticates to Expertiza and begins the expert review
:The expert finishes and submits the review
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Student Calibration
:A student has submitted a response for the assignment and it is currently in the review phase
:The student authenticates to Expertiza and chooses to view calibration for the assignment
:The student sees their own answers compared to the expert review.
:Answers that match are marked green, and answers that differ are marked red.
</div>

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Instructor Calibration
:It is currently the review phase for an assignment
:An instructor authenticates to Expertiza and chooses to view calibration
:The instructor can see the percentages relating to student responses for the assignment
</div>

===Code===
Code for the feature test consist in two files:
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/assignment_setup.rb assignment_setup.rb] which contains method for creating assignments using controller calls.
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/features/student_submission_spec.rb student_assignment_submission.rb] which contain calls to assignment_setup, scenarios to test assignment submission and commands to delete the created assignments.

====Structure====

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require files

RSpec.feature 'assignment submission when student' do

:before(:all) do
::create assignments for submission
:end

:before(:each) do
::capybara steps to login
:end

:after(:all) do
::delete assignments created
:end

:scenario 'submits only valid link to ongoing assignment' do
::mock steps using capybara
::make assertions
:end

:....
:....
:....

end
</div>

====Sample Scenario====

<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require 'rails_helper'
require 'spec_helper'
require 'assignment_setup'

RSpec.feature 'assignment submission when student' do

active_assignment="FeatureTest"
expired_assignment="LibraryRailsApp"
d = Date.parse(Time.now.to_s)
due_date1=(d >> 1).strftime("%Y-%m-%d %H:%M:00")
due_date2=(d << 1).strftime("%Y-%m-%d %H:%M:00")

# Before all block runs once before all the scenarios are tested
before(:all) do
# Create active/ongoing assignment
create_assignment(active_assignment, due_date1)

# Create expired/finished assignment
create_assignment(expired_assignment, due_date2)
end

# Before each block runs before every scenario
before(:each) do
# Login as a student before each scenario
visit root_path
fill_in 'User Name', :with => 'student13'
fill_in 'Password', :with => 'password'
click_on 'SIGN IN'
end

# After all block runs after all the scenarios are tested
after(:all)do
# Delete active/ongoing assignment created by the test
assignment = Assignment.find_by_name(active_assignment)
assignment.delete

# Delete expired/finished assignment created by the test
assignment = Assignment.find_by_name(expired_assignment)
assignment.delete
end

# Scenario to check whether student is able to submit valid link to an ongoing assignment
scenario 'submits only valid link to ongoing assignment' do
click_on active_assignment
click_on 'Your work'
fill_in 'submission', :with => 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
click_on 'Upload link'
expect(page).to have_content 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
end

end
</pre>

==Running the tests==

The following are steps required to run the test

* Clone the repository in a new directory
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ mkdir review
$ cd review
$ git clone https://github.com/shrenujgandhi/expertiza.git
</pre>

In case you don't have a database with student and instructor entries then download the dump from https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uESEkzSWpJRnhGbmc/view. Extract its contents.
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ cd expertiza
$ rake db:create:all
$ cd Downloads/
$ mysql -u root -p expertiza_development < expertiza_scrubbed_2015_08_14.sql
password:

$ cd expertiza
$ rake db:migrate
</pre>

* Type the command to run tests for assignment submission
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
rspec spec/features/student_submission_spec.rb
</pre>

==Test Results==

The following screenshot shows the result of the rspec command.

[[File:test_result_temp2_expertiza.jpg|Feature Test Result]]

=== Test Analysis ===

* ''7 examples, 0 failures'' imply that there are 7 test scenarios and none of them failed.
* The tests take around 35 seconds to run, which implies that they are fast.
* They are also repeatable as the assignments that are created in the ''before all'' block are also deleted in the ''after all'' block.
* They are also self-verifying as all the results are in green, which mean that all the cases passed.

==Project Resources==
# [https://github.com/shrenujgandhi/expertiza GitHub Link]
# [https://youtu.be/_58l0VPy04M YouTube Demo]

=References=
<references></references>

=External links=
* [http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Documentation]

User:Ewhorton

2016-03-19T01:33:40Z

Ewhorton: /* Gems involved */

'''Expertiza''' is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. <ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref>

==Introduction==
Our contribution to this project is a suite of functional tests for the assignment calibration function. These tests are designed to provide integration, regression, and acceptance testing by using automation technologies.

===Problem Statement===
Expertiza has a feature called Calibration that can be turned on for an assignment. When this feature is enabled an expert, typically the instructor, can provide an expert review for the assignment artifacts. After students finish their own reviews they may compare their responses to the expert review. The instructor may also view calibration results to view the scores for the entire class.

While this is a preexisting feature within Expertiza, there currently exist no tests for it. The goal of this project is to fully test the entire flow of the calibration feature using the '''RSpec''' and '''Capybara''' frameworks.

===Motivation===
The moment a line of code is written it becomes legacy code in need of support. Test cases are used not only to ensure that code is operating properly, but also to ensure that it continues to do so after having been modified. An important aspect of this is acceptance testing to verify that the project meets customer requirements. Rather than performing these tests by hand, it is easier to combine an automated testing system like RSpec with a driver like Capybara which allows testing of an application's functionality from the outside either by running in a headless browser.

===Flow of the calibration function===
A more detailed description of the calibration may be found [https://docs.google.com/document/d/1LcicJCUY0GHN1qzwRQPL9A1Nv89sVtNtxlADOzVQeBk/edit#heading=h.g4vilf87e3f0 here]

Before analyzing code, one must familiarize themselves with the steps involved in assignment submission by student on Expertiza. The steps involved are:
# Login with valid instructor username and password
# Click on "Assignment"
# Click on "New public assignment"
# Input all the information needed, check the “Calibrated peer-review for training?” box, click on Create
# Select the review rubric in “Rubrics” tab
# Go to “Due dates” tab, make sure that this assignment is currently in Review phase, also, make the submission allowed in review phase.
# Add a submitter to the assignment. This submitter will add documents to be reviewed.
# Go to the list of assignments, click “edit” icon of the assignment
# Go to the “Calibration” tab, click on the "Begin" link next to the student artifact for the expert review, and click “Submit Review”
# Go to “Review strategy” tab, select Instructor-Selected as review strategy, then select the radio button “Set number of reviews done by each student” and input the number of reviews
# Login with valid student username and password who is a reviewer for the assignment
# Click on the assignment
# Click on “Other’s work”
# After clicking “Begin”, Expertiza will display peer-review page
# Click “Submit Review”
# Click “Show calibration results” to see expert review
# Login with valid instructor username and password
# Click on "Assignment"
# Click on the “view review report” to see the calibration report

== Creating the Tests==

===Gems involved===
* rspec-rails
* capybara
* selenium-webdriver
* factory_girl_rails

====rspec-rails====
Rspec-rails is a testing framework for Rails 3.x and 4.x. It supports testing of models, controllers, requests, features, views and routes. It does this by accepting test scenarios called specs.<ref>[https://github.com/rspec/rspec-rails rpsce-rails on GitHub]</ref>

====capybara====
Capybara helps you test web applications by simulating how a real user would interact with your application. It comes with built in Rack::Test and Selenium support. WebKit is supported through an external gem.<ref>[https://github.com/jnicklas/capybara capybara on GitHub]</ref> To control the environments in which the scenarios are run, it provides before and after hooks.<ref>[https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/hooks/before-and-after-hooks Before and after hooks]</ref>
*before(:each) blocks are run before each scenario in the group
*before(:all) blocks are run once before all of the scenarios in the group
*after(:each) blocks are run after each scenario in the group
*after(:all) blocks are run once after all of the scenarios in the group

====selenium====
Selenium is a portable software testing framework for web applications. Selenium provides a record/playback tool for authoring tests without learning a test scripting language (Selenium IDE). It is the default javascript webdriver for Capybara.

====factory girl====
Factory Girl is a factory gem meant for use in testing. It allows for easy and highly configurable on-the-fly model creation that allows tests to request a new instance of a model template and optionally override any of the defaults.

===Test Scenarios===
Based on the steps involved in manual submission of the assignment, the following test scenarios are considered:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to login 
:Login with student13 and password 
:Click on Sign In button 
:Updated page should have text content Assignment 
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to submit valid link to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule</nowiki> 
:Updated page should have link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule</nowiki>
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is not able submit invalid link to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link http:// 
:Updated page should display flash message with text URI is not valid
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to upload a file to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload file student_submission_spec.rb 
:Updated page should contain filename student_submission_spec.rb
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to upload valid link and a file to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/assignments</nowiki> 
:Upload file users_spec.rb 
:Updated page should have link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/assignments</nowiki> 
:Updated page should contain filename users_spec.rb
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is not able submit valid link to a finished assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on Finished Assignment 
:Click on Your work 
:Page should not have Upload link button
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able upload file to a finished assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on Finished Assignment 
:Click on Your work 
:Upload file student_submission_spec.rb 
:Updated page should contain filename student_submission_spec.rb
</div>

===Code===
Code for the feature test consist in two files:
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/assignment_setup.rb assignment_setup.rb] which contains method for creating assignments using controller calls.
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/features/student_submission_spec.rb student_assignment_submission.rb] which contain calls to assignment_setup, scenarios to test assignment submission and commands to delete the created assignments.

====Structure====

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require files

RSpec.feature 'assignment submission when student' do

:before(:all) do
::create assignments for submission
:end

:before(:each) do
::capybara steps to login
:end

:after(:all) do
::delete assignments created
:end

:scenario 'submits only valid link to ongoing assignment' do
::mock steps using capybara
::make assertions
:end

:....
:....
:....

end
</div>

====Sample Scenario====

<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require 'rails_helper'
require 'spec_helper'
require 'assignment_setup'

RSpec.feature 'assignment submission when student' do

active_assignment="FeatureTest"
expired_assignment="LibraryRailsApp"
d = Date.parse(Time.now.to_s)
due_date1=(d >> 1).strftime("%Y-%m-%d %H:%M:00")
due_date2=(d << 1).strftime("%Y-%m-%d %H:%M:00")

# Before all block runs once before all the scenarios are tested
before(:all) do
# Create active/ongoing assignment
create_assignment(active_assignment, due_date1)

# Create expired/finished assignment
create_assignment(expired_assignment, due_date2)
end

# Before each block runs before every scenario
before(:each) do
# Login as a student before each scenario
visit root_path
fill_in 'User Name', :with => 'student13'
fill_in 'Password', :with => 'password'
click_on 'SIGN IN'
end

# After all block runs after all the scenarios are tested
after(:all)do
# Delete active/ongoing assignment created by the test
assignment = Assignment.find_by_name(active_assignment)
assignment.delete

# Delete expired/finished assignment created by the test
assignment = Assignment.find_by_name(expired_assignment)
assignment.delete
end

# Scenario to check whether student is able to submit valid link to an ongoing assignment
scenario 'submits only valid link to ongoing assignment' do
click_on active_assignment
click_on 'Your work'
fill_in 'submission', :with => 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
click_on 'Upload link'
expect(page).to have_content 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
end

end
</pre>

==Running the tests==

The following are steps required to run the test

* Clone the repository in a new directory
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ mkdir review
$ cd review
$ git clone https://github.com/shrenujgandhi/expertiza.git
</pre>

In case you don't have a database with student and instructor entries then download the dump from https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uESEkzSWpJRnhGbmc/view. Extract its contents.
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ cd expertiza
$ rake db:create:all
$ cd Downloads/
$ mysql -u root -p expertiza_development < expertiza_scrubbed_2015_08_14.sql
password:

$ cd expertiza
$ rake db:migrate
</pre>

* Type the command to run tests for assignment submission
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
rspec spec/features/student_submission_spec.rb
</pre>

==Test Results==

The following screenshot shows the result of the rspec command.

[[File:test_result_temp2_expertiza.jpg|Feature Test Result]]

=== Test Analysis ===

* ''7 examples, 0 failures'' imply that there are 7 test scenarios and none of them failed.
* The tests take around 35 seconds to run, which implies that they are fast.
* They are also repeatable as the assignments that are created in the ''before all'' block are also deleted in the ''after all'' block.
* They are also self-verifying as all the results are in green, which mean that all the cases passed.

==Project Resources==
# [https://github.com/shrenujgandhi/expertiza GitHub Link]
# [https://youtu.be/_58l0VPy04M YouTube Demo]

=References=
<references></references>

=External links=
* [http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Documentation]

User:Ewhorton

2016-03-19T01:22:38Z

Ewhorton: Adding link to calibration documentation and mentioning assignment submitters.

'''Expertiza''' is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. <ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref>

==Introduction==
Our contribution to this project is a suite of functional tests for the assignment calibration function. These tests are designed to provide integration, regression, and acceptance testing by using automation technologies.

===Problem Statement===
Expertiza has a feature called Calibration that can be turned on for an assignment. When this feature is enabled an expert, typically the instructor, can provide an expert review for the assignment artifacts. After students finish their own reviews they may compare their responses to the expert review. The instructor may also view calibration results to view the scores for the entire class.

While this is a preexisting feature within Expertiza, there currently exist no tests for it. The goal of this project is to fully test the entire flow of the calibration feature using the '''RSpec''' and '''Capybara''' frameworks.

===Motivation===
The moment a line of code is written it becomes legacy code in need of support. Test cases are used not only to ensure that code is operating properly, but also to ensure that it continues to do so after having been modified. An important aspect of this is acceptance testing to verify that the project meets customer requirements. Rather than performing these tests by hand, it is easier to combine an automated testing system like RSpec with a driver like Capybara which allows testing of an application's functionality from the outside either by running in a headless browser.

===Flow of the calibration function===
A more detailed description of the calibration may be found [https://docs.google.com/document/d/1LcicJCUY0GHN1qzwRQPL9A1Nv89sVtNtxlADOzVQeBk/edit#heading=h.g4vilf87e3f0 here]

Before analyzing code, one must familiarize themselves with the steps involved in assignment submission by student on Expertiza. The steps involved are:
# Login with valid instructor username and password
# Click on "Assignment"
# Click on "New public assignment"
# Input all the information needed, check the “Calibrated peer-review for training?” box, click on Create
# Select the review rubric in “Rubrics” tab
# Go to “Due dates” tab, make sure that this assignment is currently in Review phase, also, make the submission allowed in review phase.
# Add a submitter to the assignment. This submitter will add documents to be reviewed.
# Go to the list of assignments, click “edit” icon of the assignment
# Go to the “Calibration” tab, click on the "Begin" link next to the student artifact for the expert review, and click “Submit Review”
# Go to “Review strategy” tab, select Instructor-Selected as review strategy, then select the radio button “Set number of reviews done by each student” and input the number of reviews
# Login with valid student username and password who is a reviewer for the assignment
# Click on the assignment
# Click on “Other’s work”
# After clicking “Begin”, Expertiza will display peer-review page
# Click “Submit Review”
# Click “Show calibration results” to see expert review
# Login with valid instructor username and password
# Click on "Assignment"
# Click on the “view review report” to see the calibration report

== Creating the Tests==

===Gems involved===
The gems used in feature testing are '''rspec-rails''', '''capybara''' and '''selenium'''.

====rspec-rails====
Rspec-rails is a testing framework for Rails 3.x and 4.x. It supports testing of models, controllers, requests, features, views and routes. It does this by accepting test scenarios called specs.<ref>[https://github.com/rspec/rspec-rails rpsce-rails on GitHub]</ref>

====capybara====
Capybara helps you test web applications by simulating how a real user would interact with your application. It comes with built in Rack::Test and Selenium support. WebKit is supported through an external gem.<ref>[https://github.com/jnicklas/capybara capybara on GitHub]</ref> To control the environments in which the scenarios are run, it provides before and after hooks.<ref>[https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/hooks/before-and-after-hooks Before and after hooks]</ref>
*before(:each) blocks are run before each scenario in the group
*before(:all) blocks are run once before all of the scenarios in the group
*after(:each) blocks are run after each scenario in the group
*after(:all) blocks are run once after all of the scenarios in the group

====selenium====
Selenium is a portable software testing framework for web applications. Selenium provides a record/playback tool for authoring tests without learning a test scripting language (Selenium IDE). It is the default javascript webdriver for Capybara.

===Test Scenarios===
Based on the steps involved in manual submission of the assignment, the following test scenarios are considered:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to login 
:Login with student13 and password 
:Click on Sign In button 
:Updated page should have text content Assignment 
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to submit valid link to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule</nowiki> 
:Updated page should have link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule</nowiki>
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is not able submit invalid link to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link http:// 
:Updated page should display flash message with text URI is not valid
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to upload a file to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload file student_submission_spec.rb 
:Updated page should contain filename student_submission_spec.rb
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to upload valid link and a file to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/assignments</nowiki> 
:Upload file users_spec.rb 
:Updated page should have link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/assignments</nowiki> 
:Updated page should contain filename users_spec.rb
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is not able submit valid link to a finished assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on Finished Assignment 
:Click on Your work 
:Page should not have Upload link button
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able upload file to a finished assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on Finished Assignment 
:Click on Your work 
:Upload file student_submission_spec.rb 
:Updated page should contain filename student_submission_spec.rb
</div>

===Code===
Code for the feature test consist in two files:
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/assignment_setup.rb assignment_setup.rb] which contains method for creating assignments using controller calls.
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/features/student_submission_spec.rb student_assignment_submission.rb] which contain calls to assignment_setup, scenarios to test assignment submission and commands to delete the created assignments.

====Structure====

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require files

RSpec.feature 'assignment submission when student' do

:before(:all) do
::create assignments for submission
:end

:before(:each) do
::capybara steps to login
:end

:after(:all) do
::delete assignments created
:end

:scenario 'submits only valid link to ongoing assignment' do
::mock steps using capybara
::make assertions
:end

:....
:....
:....

end
</div>

====Sample Scenario====

<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require 'rails_helper'
require 'spec_helper'
require 'assignment_setup'

RSpec.feature 'assignment submission when student' do

active_assignment="FeatureTest"
expired_assignment="LibraryRailsApp"
d = Date.parse(Time.now.to_s)
due_date1=(d >> 1).strftime("%Y-%m-%d %H:%M:00")
due_date2=(d << 1).strftime("%Y-%m-%d %H:%M:00")

# Before all block runs once before all the scenarios are tested
before(:all) do
# Create active/ongoing assignment
create_assignment(active_assignment, due_date1)

# Create expired/finished assignment
create_assignment(expired_assignment, due_date2)
end

# Before each block runs before every scenario
before(:each) do
# Login as a student before each scenario
visit root_path
fill_in 'User Name', :with => 'student13'
fill_in 'Password', :with => 'password'
click_on 'SIGN IN'
end

# After all block runs after all the scenarios are tested
after(:all)do
# Delete active/ongoing assignment created by the test
assignment = Assignment.find_by_name(active_assignment)
assignment.delete

# Delete expired/finished assignment created by the test
assignment = Assignment.find_by_name(expired_assignment)
assignment.delete
end

# Scenario to check whether student is able to submit valid link to an ongoing assignment
scenario 'submits only valid link to ongoing assignment' do
click_on active_assignment
click_on 'Your work'
fill_in 'submission', :with => 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
click_on 'Upload link'
expect(page).to have_content 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
end

end
</pre>

==Running the tests==

The following are steps required to run the test

* Clone the repository in a new directory
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ mkdir review
$ cd review
$ git clone https://github.com/shrenujgandhi/expertiza.git
</pre>

In case you don't have a database with student and instructor entries then download the dump from https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uESEkzSWpJRnhGbmc/view. Extract its contents.
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ cd expertiza
$ rake db:create:all
$ cd Downloads/
$ mysql -u root -p expertiza_development < expertiza_scrubbed_2015_08_14.sql
password:

$ cd expertiza
$ rake db:migrate
</pre>

* Type the command to run tests for assignment submission
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
rspec spec/features/student_submission_spec.rb
</pre>

==Test Results==

The following screenshot shows the result of the rspec command.

[[File:test_result_temp2_expertiza.jpg|Feature Test Result]]

=== Test Analysis ===

* ''7 examples, 0 failures'' imply that there are 7 test scenarios and none of them failed.
* The tests take around 35 seconds to run, which implies that they are fast.
* They are also repeatable as the assignments that are created in the ''before all'' block are also deleted in the ''after all'' block.
* They are also self-verifying as all the results are in green, which mean that all the cases passed.

==Project Resources==
# [https://github.com/shrenujgandhi/expertiza GitHub Link]
# [https://youtu.be/_58l0VPy04M YouTube Demo]

=References=
<references></references>

=External links=
* [http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Documentation]

User:Ewhorton

2016-03-19T01:13:51Z

Ewhorton: Rewriting motivation to discuss the need for automated acceptance testing.

'''Expertiza''' is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. <ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref>

==Introduction==
Our contribution to this project is a suite of functional tests for the assignment calibration function. These tests are designed to provide integration, regression, and acceptance testing by using automation technologies.

===Problem Statement===
Expertiza has a feature called Calibration that can be turned on for an assignment. When this feature is enabled an expert, typically the instructor, can provide an expert review for the assignment artifacts. After students finish their own reviews they may compare their responses to the expert review. The instructor may also view calibration results to view the scores for the entire class.

While this is a preexisting feature within Expertiza, there currently exist no tests for it. The goal of this project is to fully test the entire flow of the calibration feature using the '''RSpec''' and '''Capybara''' frameworks.

===Motivation===
The moment a line of code is written it becomes legacy code in need of support. Test cases are used not only to ensure that code is operating properly, but also to ensure that it continues to do so after having been modified. An important aspect of this is acceptance testing to verify that the project meets customer requirements. Rather than performing these tests by hand, it is easier to combine an automated testing system like RSpec with a driver like Capybara which allows testing of an application's functionality from the outside either by running in a headless browser.

===Flow of the calibration function===
Before analyzing code, one must familiarize themselves with the steps involved in assignment submission by student on Expertiza. The steps involved are:
# Login with valid instructor username and password
# Click on "Assignment"
# Click on "New public assignment"
# Input all the information needed, check the “Calibrated peer-review for training?” box, click on Create
# Select the review rubric in “Rubrics” tab
# Go to “Due dates” tab, make sure that this assignment is currently in Review phase, also, make the submission allowed in review phase.
# Go to the list of assignments, click “edit” icon of the assignment
# Go to the “Calibration” tab, click on the "Begin" link next to the student artifact for the expert review, and click “Submit Review”
# Go to “Review strategy” tab, select Instructor-Selected as review strategy, then select the radio button “Set number of reviews done by each student” and input the number of reviews
# Login with valid student username and password who is a reviewer for the assignment
# Click on the assignment
# Click on“Other’s work”
# After clicking “Begin”, Expertiza will display peer-review page
# Click “Submit Review”
# Click “Show calibration results” to see expert review
# Login with valid instructor username and password
# Click on "Assignment"
# Click on the “view review report” to see the calibration report

== Creating the Tests==

===Gems involved===
The gems used in feature testing are '''rspec-rails''', '''capybara''' and '''selenium'''.

====rspec-rails====
Rspec-rails is a testing framework for Rails 3.x and 4.x. It supports testing of models, controllers, requests, features, views and routes. It does this by accepting test scenarios called specs.<ref>[https://github.com/rspec/rspec-rails rpsce-rails on GitHub]</ref>

====capybara====
Capybara helps you test web applications by simulating how a real user would interact with your application. It comes with built in Rack::Test and Selenium support. WebKit is supported through an external gem.<ref>[https://github.com/jnicklas/capybara capybara on GitHub]</ref> To control the environments in which the scenarios are run, it provides before and after hooks.<ref>[https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/hooks/before-and-after-hooks Before and after hooks]</ref>
*before(:each) blocks are run before each scenario in the group
*before(:all) blocks are run once before all of the scenarios in the group
*after(:each) blocks are run after each scenario in the group
*after(:all) blocks are run once after all of the scenarios in the group

====selenium====
Selenium is a portable software testing framework for web applications. Selenium provides a record/playback tool for authoring tests without learning a test scripting language (Selenium IDE). It is the default javascript webdriver for Capybara.

===Test Scenarios===
Based on the steps involved in manual submission of the assignment, the following test scenarios are considered:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to login 
:Login with student13 and password 
:Click on Sign In button 
:Updated page should have text content Assignment 
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to submit valid link to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule</nowiki> 
:Updated page should have link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule</nowiki>
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is not able submit invalid link to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link http:// 
:Updated page should display flash message with text URI is not valid
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to upload a file to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload file student_submission_spec.rb 
:Updated page should contain filename student_submission_spec.rb
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to upload valid link and a file to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/assignments</nowiki> 
:Upload file users_spec.rb 
:Updated page should have link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/assignments</nowiki> 
:Updated page should contain filename users_spec.rb
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is not able submit valid link to a finished assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on Finished Assignment 
:Click on Your work 
:Page should not have Upload link button
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able upload file to a finished assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on Finished Assignment 
:Click on Your work 
:Upload file student_submission_spec.rb 
:Updated page should contain filename student_submission_spec.rb
</div>

===Code===
Code for the feature test consist in two files:
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/assignment_setup.rb assignment_setup.rb] which contains method for creating assignments using controller calls.
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/features/student_submission_spec.rb student_assignment_submission.rb] which contain calls to assignment_setup, scenarios to test assignment submission and commands to delete the created assignments.

====Structure====

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require files

RSpec.feature 'assignment submission when student' do

:before(:all) do
::create assignments for submission
:end

:before(:each) do
::capybara steps to login
:end

:after(:all) do
::delete assignments created
:end

:scenario 'submits only valid link to ongoing assignment' do
::mock steps using capybara
::make assertions
:end

:....
:....
:....

end
</div>

====Sample Scenario====

<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require 'rails_helper'
require 'spec_helper'
require 'assignment_setup'

RSpec.feature 'assignment submission when student' do

active_assignment="FeatureTest"
expired_assignment="LibraryRailsApp"
d = Date.parse(Time.now.to_s)
due_date1=(d >> 1).strftime("%Y-%m-%d %H:%M:00")
due_date2=(d << 1).strftime("%Y-%m-%d %H:%M:00")

# Before all block runs once before all the scenarios are tested
before(:all) do
# Create active/ongoing assignment
create_assignment(active_assignment, due_date1)

# Create expired/finished assignment
create_assignment(expired_assignment, due_date2)
end

# Before each block runs before every scenario
before(:each) do
# Login as a student before each scenario
visit root_path
fill_in 'User Name', :with => 'student13'
fill_in 'Password', :with => 'password'
click_on 'SIGN IN'
end

# After all block runs after all the scenarios are tested
after(:all)do
# Delete active/ongoing assignment created by the test
assignment = Assignment.find_by_name(active_assignment)
assignment.delete

# Delete expired/finished assignment created by the test
assignment = Assignment.find_by_name(expired_assignment)
assignment.delete
end

# Scenario to check whether student is able to submit valid link to an ongoing assignment
scenario 'submits only valid link to ongoing assignment' do
click_on active_assignment
click_on 'Your work'
fill_in 'submission', :with => 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
click_on 'Upload link'
expect(page).to have_content 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
end

end
</pre>

==Running the tests==

The following are steps required to run the test

* Clone the repository in a new directory
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ mkdir review
$ cd review
$ git clone https://github.com/shrenujgandhi/expertiza.git
</pre>

In case you don't have a database with student and instructor entries then download the dump from https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uESEkzSWpJRnhGbmc/view. Extract its contents.
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ cd expertiza
$ rake db:create:all
$ cd Downloads/
$ mysql -u root -p expertiza_development < expertiza_scrubbed_2015_08_14.sql
password:

$ cd expertiza
$ rake db:migrate
</pre>

* Type the command to run tests for assignment submission
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
rspec spec/features/student_submission_spec.rb
</pre>

==Test Results==

The following screenshot shows the result of the rspec command.

[[File:test_result_temp2_expertiza.jpg|Feature Test Result]]

=== Test Analysis ===

* ''7 examples, 0 failures'' imply that there are 7 test scenarios and none of them failed.
* The tests take around 35 seconds to run, which implies that they are fast.
* They are also repeatable as the assignments that are created in the ''before all'' block are also deleted in the ''after all'' block.
* They are also self-verifying as all the results are in green, which mean that all the cases passed.

==Project Resources==
# [https://github.com/shrenujgandhi/expertiza GitHub Link]
# [https://youtu.be/_58l0VPy04M YouTube Demo]

=References=
<references></references>

=External links=
* [http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Documentation]

User:Ewhorton

2016-03-19T00:56:35Z

Ewhorton: Expanding the problem statement.

'''Expertiza''' is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. <ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref>

==Introduction==
Our contribution to this project is a suite of functional tests for the assignment calibration function. These tests are designed to provide integration, regression, and acceptance testing by using automation technologies.

===Problem Statement===
Expertiza has a feature called Calibration that can be turned on for an assignment. When this feature is enabled an expert, typically the instructor, can provide an expert review for the assignment artifacts. After students finish their own reviews they may compare their responses to the expert review. The instructor may also view calibration results to view the scores for the entire class.

While this is a preexisting feature within Expertiza, there currently exist no tests for it. The goal of this project is to fully test the entire flow of the calibration feature using the '''RSpec''' and '''Capybara''' frameworks.

===Motivation===
Once the application is built, it is necessary to test its functionality. More importantly, it is essential to test the functionality from users perspective. '''Feature spec''' allows testing of your application's functionality from the outside either by simulating a browser or by headless browser simulation. By manually clicking on the interface, the tests can discover bugs in the system and so has ours.

===Flow of the calibration function===
Before analyzing code, one must familiarize themselves with the steps involved in assignment submission by student on Expertiza. The steps involved are:
# Login with valid instructor username and password
# Click on "Assignment"
# Click on "New public assignment"
# Input all the information needed, check the “Calibrated peer-review for training?” box, click on Create
# Select the review rubric in “Rubrics” tab
# Go to “Due dates” tab, make sure that this assignment is currently in Review phase, also, make the submission allowed in review phase.
# Go to the list of assignments, click “edit” icon of the assignment
# Go to the “Calibration” tab, click on the "Begin" link next to the student artifact for the expert review, and click “Submit Review”
# Go to “Review strategy” tab, select Instructor-Selected as review strategy, then select the radio button “Set number of reviews done by each student” and input the number of reviews
# Login with valid student username and password who is a reviewer for the assignment
# Click on the assignment
# Click on“Other’s work”
# After clicking “Begin”, Expertiza will display peer-review page
# Click “Submit Review”
# Click “Show calibration results” to see expert review
# Login with valid instructor username and password
# Click on "Assignment"
# Click on the “view review report” to see the calibration report

== Creating the Tests==

===Gems involved===
The gems used in feature testing are '''rspec-rails''', '''capybara''' and '''selenium'''.

====rspec-rails====
Rspec-rails is a testing framework for Rails 3.x and 4.x. It supports testing of models, controllers, requests, features, views and routes. It does this by accepting test scenarios called specs.<ref>[https://github.com/rspec/rspec-rails rpsce-rails on GitHub]</ref>

====capybara====
Capybara helps you test web applications by simulating how a real user would interact with your application. It comes with built in Rack::Test and Selenium support. WebKit is supported through an external gem.<ref>[https://github.com/jnicklas/capybara capybara on GitHub]</ref> To control the environments in which the scenarios are run, it provides before and after hooks.<ref>[https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/hooks/before-and-after-hooks Before and after hooks]</ref>
*before(:each) blocks are run before each scenario in the group
*before(:all) blocks are run once before all of the scenarios in the group
*after(:each) blocks are run after each scenario in the group
*after(:all) blocks are run once after all of the scenarios in the group

====selenium====
Selenium is a portable software testing framework for web applications. Selenium provides a record/playback tool for authoring tests without learning a test scripting language (Selenium IDE). It is the default javascript webdriver for Capybara.

===Test Scenarios===
Based on the steps involved in manual submission of the assignment, the following test scenarios are considered:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to login 
:Login with student13 and password 
:Click on Sign In button 
:Updated page should have text content Assignment 
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to submit valid link to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule</nowiki> 
:Updated page should have link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule</nowiki>
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is not able submit invalid link to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link http:// 
:Updated page should display flash message with text URI is not valid
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to upload a file to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload file student_submission_spec.rb 
:Updated page should contain filename student_submission_spec.rb
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to upload valid link and a file to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/assignments</nowiki> 
:Upload file users_spec.rb 
:Updated page should have link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/assignments</nowiki> 
:Updated page should contain filename users_spec.rb
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is not able submit valid link to a finished assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on Finished Assignment 
:Click on Your work 
:Page should not have Upload link button
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able upload file to a finished assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on Finished Assignment 
:Click on Your work 
:Upload file student_submission_spec.rb 
:Updated page should contain filename student_submission_spec.rb
</div>

===Code===
Code for the feature test consist in two files:
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/assignment_setup.rb assignment_setup.rb] which contains method for creating assignments using controller calls.
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/features/student_submission_spec.rb student_assignment_submission.rb] which contain calls to assignment_setup, scenarios to test assignment submission and commands to delete the created assignments.

====Structure====

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require files

RSpec.feature 'assignment submission when student' do

:before(:all) do
::create assignments for submission
:end

:before(:each) do
::capybara steps to login
:end

:after(:all) do
::delete assignments created
:end

:scenario 'submits only valid link to ongoing assignment' do
::mock steps using capybara
::make assertions
:end

:....
:....
:....

end
</div>

====Sample Scenario====

<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require 'rails_helper'
require 'spec_helper'
require 'assignment_setup'

RSpec.feature 'assignment submission when student' do

active_assignment="FeatureTest"
expired_assignment="LibraryRailsApp"
d = Date.parse(Time.now.to_s)
due_date1=(d >> 1).strftime("%Y-%m-%d %H:%M:00")
due_date2=(d << 1).strftime("%Y-%m-%d %H:%M:00")

# Before all block runs once before all the scenarios are tested
before(:all) do
# Create active/ongoing assignment
create_assignment(active_assignment, due_date1)

# Create expired/finished assignment
create_assignment(expired_assignment, due_date2)
end

# Before each block runs before every scenario
before(:each) do
# Login as a student before each scenario
visit root_path
fill_in 'User Name', :with => 'student13'
fill_in 'Password', :with => 'password'
click_on 'SIGN IN'
end

# After all block runs after all the scenarios are tested
after(:all)do
# Delete active/ongoing assignment created by the test
assignment = Assignment.find_by_name(active_assignment)
assignment.delete

# Delete expired/finished assignment created by the test
assignment = Assignment.find_by_name(expired_assignment)
assignment.delete
end

# Scenario to check whether student is able to submit valid link to an ongoing assignment
scenario 'submits only valid link to ongoing assignment' do
click_on active_assignment
click_on 'Your work'
fill_in 'submission', :with => 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
click_on 'Upload link'
expect(page).to have_content 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
end

end
</pre>

==Running the tests==

The following are steps required to run the test

* Clone the repository in a new directory
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ mkdir review
$ cd review
$ git clone https://github.com/shrenujgandhi/expertiza.git
</pre>

In case you don't have a database with student and instructor entries then download the dump from https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uESEkzSWpJRnhGbmc/view. Extract its contents.
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ cd expertiza
$ rake db:create:all
$ cd Downloads/
$ mysql -u root -p expertiza_development < expertiza_scrubbed_2015_08_14.sql
password:

$ cd expertiza
$ rake db:migrate
</pre>

* Type the command to run tests for assignment submission
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
rspec spec/features/student_submission_spec.rb
</pre>

==Test Results==

The following screenshot shows the result of the rspec command.

[[File:test_result_temp2_expertiza.jpg|Feature Test Result]]

=== Test Analysis ===

* ''7 examples, 0 failures'' imply that there are 7 test scenarios and none of them failed.
* The tests take around 35 seconds to run, which implies that they are fast.
* They are also repeatable as the assignments that are created in the ''before all'' block are also deleted in the ''after all'' block.
* They are also self-verifying as all the results are in green, which mean that all the cases passed.

==Project Resources==
# [https://github.com/shrenujgandhi/expertiza GitHub Link]
# [https://youtu.be/_58l0VPy04M YouTube Demo]

=References=
<references></references>

=External links=
* [http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Documentation]

User:Ewhorton

2016-03-19T00:45:07Z

Ewhorton: Expanding the introduction to provide a more in depth explanation.

'''Expertiza''' is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. <ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref>

==Introduction==
Our contribution to this project is a suite of functional tests for the assignment calibration function. These tests are designed to provide integration, regression, and acceptance testing by using automation technologies.

===Problem Statement===
The instructor does expert reviews first, then after students review calibration assignments and submit peer review results, they can check the expert review. Instructor can check "calibration results" to check the calibration results of the whole class. Currently, there is no feature test for calibration function. The goal is to understand the flow of the calibration function by mock this flow in the '''Feature Tests''' using '''RSpec''' and '''Capybara''' framework.

===Motivation===
Once the application is built, it is necessary to test its functionality. More importantly, it is essential to test the functionality from users perspective. '''Feature spec''' allows testing of your application's functionality from the outside either by simulating a browser or by headless browser simulation. By manually clicking on the interface, the tests can discover bugs in the system and so has ours.

===Flow of the calibration function===
Before analyzing code, one must familiarize themselves with the steps involved in assignment submission by student on Expertiza. The steps involved are:
# Login with valid instructor username and password
# Click on "Assignment"
# Click on "New public assignment"
# Input all the information needed, check the “Calibrated peer-review for training?” box, click on Create
# Select the review rubric in “Rubrics” tab
# Go to “Due dates” tab, make sure that this assignment is currently in Review phase, also, make the submission allowed in review phase.
# Go to the list of assignments, click “edit” icon of the assignment
# Go to the “Calibration” tab, click on the "Begin" link next to the student artifact for the expert review, and click “Submit Review”
# Go to “Review strategy” tab, select Instructor-Selected as review strategy, then select the radio button “Set number of reviews done by each student” and input the number of reviews
# Login with valid student username and password who is a reviewer for the assignment
# Click on the assignment
# Click on“Other’s work”
# After clicking “Begin”, Expertiza will display peer-review page
# Click “Submit Review”
# Click “Show calibration results” to see expert review
# Login with valid instructor username and password
# Click on "Assignment"
# Click on the “view review report” to see the calibration report

== Creating the Tests==

===Gems involved===
The gems used in feature testing are '''rspec-rails''', '''capybara''' and '''selenium'''.

====rspec-rails====
Rspec-rails is a testing framework for Rails 3.x and 4.x. It supports testing of models, controllers, requests, features, views and routes. It does this by accepting test scenarios called specs.<ref>[https://github.com/rspec/rspec-rails rpsce-rails on GitHub]</ref>

====capybara====
Capybara helps you test web applications by simulating how a real user would interact with your application. It comes with built in Rack::Test and Selenium support. WebKit is supported through an external gem.<ref>[https://github.com/jnicklas/capybara capybara on GitHub]</ref> To control the environments in which the scenarios are run, it provides before and after hooks.<ref>[https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/hooks/before-and-after-hooks Before and after hooks]</ref>
*before(:each) blocks are run before each scenario in the group
*before(:all) blocks are run once before all of the scenarios in the group
*after(:each) blocks are run after each scenario in the group
*after(:all) blocks are run once after all of the scenarios in the group

====selenium====
Selenium is a portable software testing framework for web applications. Selenium provides a record/playback tool for authoring tests without learning a test scripting language (Selenium IDE). It is the default javascript webdriver for Capybara.

===Test Scenarios===
Based on the steps involved in manual submission of the assignment, the following test scenarios are considered:

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to login 
:Login with student13 and password 
:Click on Sign In button 
:Updated page should have text content Assignment 
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to submit valid link to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule</nowiki> 
:Updated page should have link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule</nowiki>
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is not able submit invalid link to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link http:// 
:Updated page should display flash message with text URI is not valid
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to upload a file to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload file student_submission_spec.rb 
:Updated page should contain filename student_submission_spec.rb
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able to upload valid link and a file to an ongoing assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on OnGoing Assignment 
:Click on Your work 
:Upload link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/assignments</nowiki> 
:Upload file users_spec.rb 
:Updated page should have link <nowiki>http://www.csc.ncsu.edu/faculty/efg/517/f15/assignments</nowiki> 
:Updated page should contain filename users_spec.rb
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is not able submit valid link to a finished assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on Finished Assignment 
:Click on Your work 
:Page should not have Upload link button
</div>

<div style="width:750px; margin-top:20px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
Scenario to check whether student is able upload file to a finished assignment 
:Login with student13 and password 
:Click on Sign In button 
:Click on Finished Assignment 
:Click on Your work 
:Upload file student_submission_spec.rb 
:Updated page should contain filename student_submission_spec.rb
</div>

===Code===
Code for the feature test consist in two files:
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/assignment_setup.rb assignment_setup.rb] which contains method for creating assignments using controller calls.
* [https://github.com/shrenujgandhi/expertiza/blob/master/spec/features/student_submission_spec.rb student_assignment_submission.rb] which contain calls to assignment_setup, scenarios to test assignment submission and commands to delete the created assignments.

====Structure====

<div style="width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require files

RSpec.feature 'assignment submission when student' do

:before(:all) do
::create assignments for submission
:end

:before(:each) do
::capybara steps to login
:end

:after(:all) do
::delete assignments created
:end

:scenario 'submits only valid link to ongoing assignment' do
::mock steps using capybara
::make assertions
:end

:....
:....
:....

end
</div>

====Sample Scenario====

<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
require 'rails_helper'
require 'spec_helper'
require 'assignment_setup'

RSpec.feature 'assignment submission when student' do

active_assignment="FeatureTest"
expired_assignment="LibraryRailsApp"
d = Date.parse(Time.now.to_s)
due_date1=(d >> 1).strftime("%Y-%m-%d %H:%M:00")
due_date2=(d << 1).strftime("%Y-%m-%d %H:%M:00")

# Before all block runs once before all the scenarios are tested
before(:all) do
# Create active/ongoing assignment
create_assignment(active_assignment, due_date1)

# Create expired/finished assignment
create_assignment(expired_assignment, due_date2)
end

# Before each block runs before every scenario
before(:each) do
# Login as a student before each scenario
visit root_path
fill_in 'User Name', :with => 'student13'
fill_in 'Password', :with => 'password'
click_on 'SIGN IN'
end

# After all block runs after all the scenarios are tested
after(:all)do
# Delete active/ongoing assignment created by the test
assignment = Assignment.find_by_name(active_assignment)
assignment.delete

# Delete expired/finished assignment created by the test
assignment = Assignment.find_by_name(expired_assignment)
assignment.delete
end

# Scenario to check whether student is able to submit valid link to an ongoing assignment
scenario 'submits only valid link to ongoing assignment' do
click_on active_assignment
click_on 'Your work'
fill_in 'submission', :with => 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
click_on 'Upload link'
expect(page).to have_content 'http://www.csc.ncsu.edu/faculty/efg/517/f15/schedule'
end

end
</pre>

==Running the tests==

The following are steps required to run the test

* Clone the repository in a new directory
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ mkdir review
$ cd review
$ git clone https://github.com/shrenujgandhi/expertiza.git
</pre>

In case you don't have a database with student and instructor entries then download the dump from https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uESEkzSWpJRnhGbmc/view. Extract its contents.
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
$ cd expertiza
$ rake db:create:all
$ cd Downloads/
$ mysql -u root -p expertiza_development < expertiza_scrubbed_2015_08_14.sql
password:

$ cd expertiza
$ rake db:migrate
</pre>

* Type the command to run tests for assignment submission
<pre style="font-size:12.5px; width:750px; margin-top:10px; border:1px solid lightgrey; background:ivory; color:black; padding-left:15px; padding-top:15px; padding-bottom:15px;">
rspec spec/features/student_submission_spec.rb
</pre>

==Test Results==

The following screenshot shows the result of the rspec command.

[[File:test_result_temp2_expertiza.jpg|Feature Test Result]]

=== Test Analysis ===

* ''7 examples, 0 failures'' imply that there are 7 test scenarios and none of them failed.
* The tests take around 35 seconds to run, which implies that they are fast.
* They are also repeatable as the assignments that are created in the ''before all'' block are also deleted in the ''after all'' block.
* They are also self-verifying as all the results are in green, which mean that all the cases passed.

==Project Resources==
# [https://github.com/shrenujgandhi/expertiza GitHub Link]
# [https://youtu.be/_58l0VPy04M YouTube Demo]

=References=
<references></references>

=External links=
* [http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Documentation]