Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E17A1

2017-12-04T20:47:41Z

Rcoutin:

This wiki page is the description of the E17A1 semester project - Let experts as well as students do reviews - for Fall 2017, CSC/ECE 517.

Demo link: https://www.youtube.com/watch?v=MyMc1RlLEzU&feature=youtu.be
= Introduction =

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

== Environment Setup ==
We have tried two different ways of setting up the Expertiza Environment, first approach used the Ubuntu-Expertiza image while the second approach involved setting up on NCSU's VCL Infrastructure. The process involving both of these approaches are detailed below. We referred the following [https://docs.google.com/document/d/1tXmwju6R7KQbvycku-bdXxa6rXSUN4BMyvjY3ROmMSw/ link].

'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza
bash ./setup.sh
bundle install
rake db:migrate</pre>

'''VCL Setup'''
The process of getting expertiza up and running on VCL is well detailed in the following [https://youtu.be/AStOjov7EQk video].
After completing the steps mentioned in the video, Additionally, we had to install Redis and NodeJS separately to get the expertiza site running. The process is detailed below:
* Steps to install Redis:
<pre>wget http://download.redis.io/redis-stable.tar.gz
tar xvzf redis-stable.tar.gz
cd redis-stable
make</pre>
Run the redis-server using:
<pre>redis-server</pre>

* Steps to install NodeJS on CentOS:
<pre>wget http://nodejs.org/dist/v0.10.30/node-v0.10.30.tar.gz
tar xzvf node-v* && cd node-v*
sudo yum install gcc gcc-c++
./configure
make
sudo make install</pre>

* Run the expertiza Rails server
<pre>thin start</pre>

*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

*For logging in as an student:- 
:Username: student17 
:Password: password 

= Problem Statement and Project Purpose =
=== Existing Limitations ===
At present the calibration functionality is limited, the following points present the scenarios where the current implementation is lacking:
# No support for varying rubric by round feature.
# From the perspective of the student, lack of differentiation of review - whether its from an expert or otherwise.
# A student is not notified once an expert submits a review.
# Additionally, a student should be able to see how an expert rated his/her assignment - similar to how it's done in calibration results for calibrated assignments(''As seen when '''Show Calibration Results''' is clicked.'').

=== Tasks Involved ===
Tasks are broken down into sub-tasks as follows:
* Refactoring:
** a checkbox in the "General" Tab from “Calibrated peer-review for training?” to “Add expert peer review?”
** a tab name for instructor from “Calibration” to “Expert review” on the assignment setting page
** partial file from “_calibration.html.erb” to “_expert_review.html.erb”
** the link title on student side from “show calibration results” to “show expert peer-review results”
** the file “response/show_calibration_results_for_student.html.erb” to “response/show_expert_review_results_for_student.html.erb”
** title in “response/show_calibration_results_for_student.html.erb” to start with “Expert review comparison report for”
* Functionality changes
** Vary-rubric-by-round - Currently, the functionality of calibration is limited. It does not support varying-rubric-by-round feature. We need to add support for having different rubrics for different rounds.
** Both TAs and instructors could do expert reviews - need to modify “response/show_calibration_results_for_student.html.erb” to make it support multiple expert reviews.

=== Affected Codebase ===
==== Database Related ====
A new migration file needs to be written to make the following changes in the DB Schema (''And across all files using these fields''):
* “is_calibrated” field in assignment table to “has_expert_review”
* “calibrate_to” field in response_map table to “expert_review_to”

==== Front-end Related ====
The following files need to be modified and/or refactored based on their respective tasks:
#student_review/_responses.html.erb
#student_review/list.html.erb
#assignments/edit.html.erb
#assignments/edit/_calibration.html.erb
#response/show_calibration_results_for_student.html.erb

= Project Design =
For the purpose of this project, experts in the expertiza domain are Teaching Assistants(TAs) and Instructors.

The following two patterns are implemented in the project -

1.MVC Pattern – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).

2.DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

The following diagram shows the User Interface changes that are to be made as part of the project.

This diagram shows the Assignment Setting page in the General tab.

[[File:Change1 copy.jpg | center ]]

This diagram shows the Assignment Setting page in the Calibration tab.

[[File:17A1Change2.png | center ]]

The following diagram shows the flow of control in case of peer reviews.

[[File:FlowChart.png | center ]]

= Use Case Diagram =
The following is the use case diagram for the feature that we are going to implement.

[[File:UseCaseDiagram_E17A1.jpg | center]]

= Test Plan =
The expertiza project uses RSpec and Capybara to test the various functionality associated with the back-end and front-end components. Hence, we will also be writing test cases for the new functionality - added as a result of this project. We would also need to add additional fixtures in '''spec/feature''' to be used in the testcases.

There are three main actors that interact with the new functionality, these are:
* Instructors
* Teaching Assistants
* Students
Hence, we would have to write tests for each of these types of users and test the expert review functionality.

The tests for the aforementioned changes will be incorpoirated in a new test file called 'expert_review_spec.rb' located in [https://github.com/expertiza/expertiza/tree/master/spec/features spec/features] folder.

Some of the tests that we have in mind as of now, are as follows:
* '''Instructor'''
** Login as instructor using pre-configured credential.
** Go to "General" tab
*** Verify "Add expert peer review?" present instead of "Calibrated peer-review for training?"
** Verify whether the instructor can see "Expert Review" on the assignment setting page.
** Perform Expert Review, based on values declared in Fixtures available to Instructor.

* '''Teaching Assistant'''
** Login as TA using pre-configured credential.
** Go to "General" tab
*** Verify "Add expert peer review?" present instead of "Calibrated peer-review for training?"
** Verify whether the TA can see "Expert Review" on the assignment setting page.
** Perform Expert Review, based on values declared in Fixtures available to TA.

* '''Student'''
** Log in as Student using pre-configured credential.
** Verify if student can see "Show expert peer-review results"
*** When a new expert-review is available.
*** Show nothing when nothing is available.
** Testing to check if the reviews show up.
*** If added by TA.
*** If added by instructor.
*** If multiple reviews from either TA or instructor show up as a list.
** Testing varying-rubric-by-round feature.

File:UseCaseDiagram E17A1.jpg

2017-11-14T17:35:57Z

Rcoutin: uploaded a new version of "File:UseCaseDiagram E17A1.jpg": Reverted to version as of 17:34, 14 November 2017

Use Case diagram for E17A1 - Let experts as well as students do reviews

File:UseCaseDiagram E17A1.jpg

2017-11-14T17:35:19Z

Rcoutin: uploaded a new version of "File:UseCaseDiagram E17A1.jpg"

Use Case diagram for E17A1 - Let experts as well as students do reviews

File:UseCaseDiagram E17A1.jpg

2017-11-14T17:34:22Z

Rcoutin: uploaded a new version of "File:UseCaseDiagram E17A1.jpg"

Use Case diagram for E17A1 - Let experts as well as students do reviews

File:UseCaseDiagram E17A1.jpg

2017-11-14T17:33:16Z

Rcoutin: uploaded a new version of "File:UseCaseDiagram E17A1.jpg"

Use Case diagram for E17A1 - Let experts as well as students do reviews

CSC/ECE 517 Fall 2017/E17A1

2017-11-14T16:59:15Z

Rcoutin: Adding use case diagram

This wiki page is the description of the E17A1 semester project - Let experts as well as students do reviews - for Fall 2017, CSC/ECE 517.

= Introduction =

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

== Environment Setup ==
We have tried two different ways of setting up the Expertiza Environment, first approach used the Ubuntu-Expertiza image while the second approach involved setting up on NCSU's VCL Infrastructure. The process involving both of these approaches are detailed below. We referred the following [https://docs.google.com/document/d/1tXmwju6R7KQbvycku-bdXxa6rXSUN4BMyvjY3ROmMSw/ link].

'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza
bash ./setup.sh
bundle install
rake db:migrate</pre>

'''VCL Setup'''
The process of getting expertiza up and running on VCL is well detailed in the following [https://youtu.be/AStOjov7EQk video].
After completing the steps mentioned in the video, Additionally, we had to install Redis and NodeJS separately to get the expertiza site running. The process is detailed below:
* Steps to install Redis:
<pre>wget http://download.redis.io/redis-stable.tar.gz
tar xvzf redis-stable.tar.gz
cd redis-stable
make</pre>
Run the redis-server using:
<pre>redis-server</pre>

* Steps to install NodeJS on CentOS:
<pre>wget http://nodejs.org/dist/v0.10.30/node-v0.10.30.tar.gz
tar xzvf node-v* && cd node-v*
sudo yum install gcc gcc-c++
./configure
make
sudo make install</pre>

* Run the expertiza Rails server
<pre>thin start</pre>

*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

*For logging in as an student:- 
:Username: student17 
:Password: password 

= Problem Statement and Project Purpose =
=== Existing Limitations ===
At present the calibration functionality is limited, the following points present the scenarios where the current implementation is lacking:
# No support for varying rubric by round feature.
# From the perspective of the student, lack of differentiation of review - whether its from an expert or otherwise.
# A student is not notified once an expert submits a review.
# Additionally, a student should be able to see how an expert rated his/her assignment - similar to how it's done in calibration results for calibrated assignments(''As seen when '''Show Calibration Results''' is clicked.'').

=== Tasks Involved ===
Tasks are broken down into sub-tasks as follows:
* Refactoring:
** a checkbox in the "General" Tab from “Calibrated peer-review for training?” to “Add expert peer review?”
** a tab name for instructor from “Calibration” to “Expert review” on the assignment setting page
** partial file from “_calibration.html.erb” to “_expert_review.html.erb”
** the link title on student side from “show calibration results” to “show expert peer-review results”
** the file “response/show_calibration_results_for_student.html.erb” to “response/show_expert_review_results_for_student.html.erb”
** title in “response/show_calibration_results_for_student.html.erb” to start with “Expert review comparison report for”
* Functionality changes
** Vary-rubric-by-round - Currently, the functionality of calibration is limited. It does not support varying-rubric-by-round feature. We need to add support for having different rubrics for different rounds.
** Both TAs and instructors could do expert reviews - need to modify “response/show_calibration_results_for_student.html.erb” to make it support multiple expert reviews.

=== Affected Codebase ===
==== Database Related ====
A new migration file needs to be written to make the following changes in the DB Schema (''And across all files using these fields''):
* “is_calibrated” field in assignment table to “has_expert_review”
* “calibrate_to” field in response_map table to “expert_review_to”

==== Front-end Related ====
The following files need to be modified and/or refactored based on their respective tasks:
#student_review/_responses.html.erb
#student_review/list.html.erb
#assignments/edit.html.erb
#assignments/edit/_calibration.html.erb
#response/show_calibration_results_for_student.html.erb

= Project Design =
For the purpose of this project, experts in the expertiza domain are Teaching Assistants(TAs) and Instructors.

The following two patterns are implemented in the project -

1.MVC Pattern – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).

2.DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

The following diagram shows the User Interface changes that are to be made as part of the project.

This diagram shows the Assignment Setting page in the General tab.

[[File:Change1 copy.jpg | center ]]

This diagram shows the Assignment Setting page in the Calibration tab.

[[File:17A1Change2.png | center ]]

The following diagram shows the flow of control in case of peer reviews.

[[File:FlowChart.png | center ]]

= Use Case Diagram =
The following is the use case diagram for the feature that we are going to implement.

[[File:UseCaseDiagram_E17A1.jpg | center]]

= Test Plan =
The expertiza project uses RSpec and Capybara to test the various functionality associated with the back-end and front-end components. Hence, we will also be writing test cases for the new functionality - added as a result of this project. We would also need to add additional fixtures in '''spec/feature''' to be used in the testcases.

There are three main actors that interact with the new functionality, these are:
* Instructors
* Teaching Assistants
* Students
Hence, we would have to write tests for each of these types of users and test the expert review functionality.

The tests for the aforementioned changes will be incorpoirated in a new test file called 'expert_review_spec.rb' located in [https://github.com/expertiza/expertiza/tree/master/spec/features spec/features] folder.

Some of the tests that we have in mind as of now, are as follows:
* '''Instructor'''
** Login as instructor using pre-configured credential.
** Go to "General" tab
*** Verify "Add expert peer review?" present instead of "Calibrated peer-review for training?"
** Verify whether the instructor can see "Expert Review" on the assignment setting page.
** Perform Expert Review, based on values declared in Fixtures available to Instructor.

* '''Teaching Assistant'''
** Login as TA using pre-configured credential.
** Go to "General" tab
*** Verify "Add expert peer review?" present instead of "Calibrated peer-review for training?"
** Verify whether the TA can see "Expert Review" on the assignment setting page.
** Perform Expert Review, based on values declared in Fixtures available to TA.

* '''Student'''
** Log in as Student using pre-configured credential.
** Verify if student can see "Show expert peer-review results"
*** When a new expert-review is available.
*** Show nothing when nothing is available.
** Testing to check if the reviews show up.
*** If added by TA.
*** If added by instructor.
*** If multiple reviews from either TA or instructor show up as a list.
** Testing varying-rubric-by-round feature.

File:UseCaseDiagram E17A1.jpg

2017-11-14T16:58:28Z

Rcoutin: Use Case diagram for E17A1 - Let experts as well as students do reviews

Use Case diagram for E17A1 - Let experts as well as students do reviews

File:UseCaseDiagram E17A1.jpg.jpg

2017-11-14T16:56:09Z

Rcoutin:

CSC/ECE 517 Fall 2017/E17A1

2017-11-08T04:07:13Z

Rcoutin: /* Database Related */

This wiki page is the description of the E17A1 semester project - Let experts as well as students do reviews - for Fall 2017, CSC/ECE 517.

= Introduction =

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

== Environment Setup ==
We have tried two different ways of setting up the Expertiza Environment, first approach used the Ubuntu-Expertiza image while the second approach involved setting up on NCSU's VCL Infrastructure. The process involving both of these approaches are detailed below. We referred the following [https://docs.google.com/document/d/1tXmwju6R7KQbvycku-bdXxa6rXSUN4BMyvjY3ROmMSw/ link].

'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza
bash ./setup.sh
bundle install
rake db:migrate</pre>

'''VCL Setup'''
The process of getting expertiza up and running on VCL is well detailed in the following [https://youtu.be/AStOjov7EQk video].
After completing the steps mentioned in the video, Additionally, we had to install Redis and NodeJS separately to get the expertiza site running. The process is detailed below:
* Steps to install Redis:
<pre>wget http://download.redis.io/redis-stable.tar.gz
tar xvzf redis-stable.tar.gz
cd redis-stable
make</pre>
Run the redis-server using:
<pre>redis-server</pre>

* Steps to install NodeJS on CentOS:
<pre>wget http://nodejs.org/dist/v0.10.30/node-v0.10.30.tar.gz
tar xzvf node-v* && cd node-v*
sudo yum install gcc gcc-c++
./configure
make
sudo make install</pre>

* Run the expertiza Rails server
<pre>thin start</pre>

*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

*For logging in as an student:- 
:Username: student17 
:Password: password 

= Action Items =
=== Existing Limitations ===
At present the calibration functionality is limited, the following points present the scenarios where the current implementation is lacking:
# No support for varying rubric by round feature.
# From the perspective of the student, lack of differentiation of review - whether its from an expert or otherwise.
# A student is not notified once an expert submits a review.
# Additionally, a student should be able to see how an expert rated his/her assignment - similar to how it's done in calibration results for calibrated assignments(''As seen when '''Show Calibration Results''' is clicked.'').

=== Tasks Involved ===
Tasks are broken down into sub-tasks as follows:
* Refactoring:
** a checkbox in the "General" Tab from “Calibrated peer-review for training?” to “Add expert peer review?”
** a tab name for instructor from “Calibration” to “Expert review” on the assignment setting page
** partial file from “_calibration.html.erb” to “_expert_review.html.erb”
** the link title on student side from “show calibration results” to “show expert peer-review results”
** the file “response/show_calibration_results_for_student.html.erb” to “response/show_expert_review_results_for_student.html.erb”
** title in “response/show_calibration_results_for_student.html.erb” to start with “Expert review comparison report for”
* Functionality changes
** Vary-rubric-by-round - Currently, the functionality of calibration is limited. It does not support varying-rubric-by-round feature. We need to add support for having different rubrics for different rounds.
** Both TAs and instructors could do expert reviews - need to modify “response/show_calibration_results_for_student.html.erb” to make it support multiple expert reviews.

=== Affected Codebase ===
==== Database Related ====
A new migration file needs to be written to make the following changes in the DB Schema (''And across all files using these fields''):
* “is_calibrated” field in assignment table to “has_expert_review”
* “calibrate_to” field in response_map table to “expert_review_to”

==== Front-end Related ====
The following files need to be modified and/or refactored based on their respective tasks:
#student_review/_responses.html.erb
#student_review/list.html.erb
#assignments/edit.html.erb
#assignments/edit/_calibration.html.erb
#response/show_calibration_results_for_student.html.erb

= Design Overview =
For the purpose of this project, experts in the expertiza domain are Teaching Assistants(TAs) and Instructors.

The following two patterns are implemented in the project -

1.MVC Pattern – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).

2.DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

The following diagram shows the control flow of reviews in expertiza.

= Test Plan =
The expertiza project uses RSpec and Capybara to test the various functionality associated with the back-end and front-end components. Hence, we will also be writing test cases for the new functionality - added as a result of this project. We would also need to add additional fixtures in '''spec/feature''' to be used in the testcases.

There are three main actors that interact with the new functionality, these are:
* Instructors
* Teaching Assistants
* Students
Hence, we would have to write tests for each of these types of users and test the expert review functionality.

The tests for the aforementioned changes will be incorpoirated in a new test file called 'expert_review_spec.rb' located in [https://github.com/expertiza/expertiza/tree/master/spec/features spec/features] folder.

Some of the tests that we have in mind as of now, are as follows:
* '''Instructor'''
** Login as instructor using pre-configured credential.
** Go to "General" tab
*** Verify "Add expert peer review?" present instead of "Calibrated peer-review for training?"
** Verify whether the instructor can see "Expert Review" on the assignment setting page.
** Perform Expert Review, based on values declared in Fixtures available to Instructor.

* '''Teaching Assistant'''
** Login as TA using pre-configured credential.
** Go to "General" tab
*** Verify "Add expert peer review?" present instead of "Calibrated peer-review for training?"
** Verify whether the TA can see "Expert Review" on the assignment setting page.
** Perform Expert Review, based on values declared in Fixtures available to TA.

* '''Student'''
** Log in as Student using pre-configured credential.
** Verify if student can see "Show expert peer-review results"
*** When a new expert-review is available.
*** Show nothing when nothing is available.
** Testing to check if the reviews show up.
*** If added by TA.
*** If added by instructor.
*** If multiple reviews from either TA or instructor show up as a list.
** Testing varying-rubric-by-round feature.

CSC/ECE 517 Fall 2017/E17A1

2017-11-08T04:06:32Z

Rcoutin: /* Tasks Involved */

This wiki page is the description of the E17A1 semester project - Let experts as well as students do reviews - for Fall 2017, CSC/ECE 517.

= Introduction =

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

== Environment Setup ==
We have tried two different ways of setting up the Expertiza Environment, first approach used the Ubuntu-Expertiza image while the second approach involved setting up on NCSU's VCL Infrastructure. The process involving both of these approaches are detailed below. We referred the following [https://docs.google.com/document/d/1tXmwju6R7KQbvycku-bdXxa6rXSUN4BMyvjY3ROmMSw/ link].

'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza
bash ./setup.sh
bundle install
rake db:migrate</pre>

'''VCL Setup'''
The process of getting expertiza up and running on VCL is well detailed in the following [https://youtu.be/AStOjov7EQk video].
After completing the steps mentioned in the video, Additionally, we had to install Redis and NodeJS separately to get the expertiza site running. The process is detailed below:
* Steps to install Redis:
<pre>wget http://download.redis.io/redis-stable.tar.gz
tar xvzf redis-stable.tar.gz
cd redis-stable
make</pre>
Run the redis-server using:
<pre>redis-server</pre>

* Steps to install NodeJS on CentOS:
<pre>wget http://nodejs.org/dist/v0.10.30/node-v0.10.30.tar.gz
tar xzvf node-v* && cd node-v*
sudo yum install gcc gcc-c++
./configure
make
sudo make install</pre>

* Run the expertiza Rails server
<pre>thin start</pre>

*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

*For logging in as an student:- 
:Username: student17 
:Password: password 

= Action Items =
=== Existing Limitations ===
At present the calibration functionality is limited, the following points present the scenarios where the current implementation is lacking:
# No support for varying rubric by round feature.
# From the perspective of the student, lack of differentiation of review - whether its from an expert or otherwise.
# A student is not notified once an expert submits a review.
# Additionally, a student should be able to see how an expert rated his/her assignment - similar to how it's done in calibration results for calibrated assignments(''As seen when '''Show Calibration Results''' is clicked.'').

=== Tasks Involved ===
Tasks are broken down into sub-tasks as follows:
* Refactoring:
** a checkbox in the "General" Tab from “Calibrated peer-review for training?” to “Add expert peer review?”
** a tab name for instructor from “Calibration” to “Expert review” on the assignment setting page
** partial file from “_calibration.html.erb” to “_expert_review.html.erb”
** the link title on student side from “show calibration results” to “show expert peer-review results”
** the file “response/show_calibration_results_for_student.html.erb” to “response/show_expert_review_results_for_student.html.erb”
** title in “response/show_calibration_results_for_student.html.erb” to start with “Expert review comparison report for”
* Functionality changes
** Vary-rubric-by-round - Currently, the functionality of calibration is limited. It does not support varying-rubric-by-round feature. We need to add support for having different rubrics for different rounds.
** Both TAs and instructors could do expert reviews - need to modify “response/show_calibration_results_for_student.html.erb” to make it support multiple expert reviews.

=== Affected Codebase ===
==== Database Related ====
A new migration file needs to written to make the following changes in the DB Schema (''And across all files using these fields''):
* “is_calibrated” field in assignment table to “has_expert_review”
* “calibrate_to” field in response_map table to “expert_review_to”

==== Front-end Related ====
The following files need to be modified and/or refactored based on their respective tasks:
#student_review/_responses.html.erb
#student_review/list.html.erb
#assignments/edit.html.erb
#assignments/edit/_calibration.html.erb
#response/show_calibration_results_for_student.html.erb

= Design Overview =
For the purpose of this project, experts in the expertiza domain are Teaching Assistants(TAs) and Instructors.

The following two patterns are implemented in the project -

1.MVC Pattern – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).

2.DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

The following diagram shows the control flow of reviews in expertiza.

= Test Plan =
The expertiza project uses RSpec and Capybara to test the various functionality associated with the back-end and front-end components. Hence, we will also be writing test cases for the new functionality - added as a result of this project. We would also need to add additional fixtures in '''spec/feature''' to be used in the testcases.

There are three main actors that interact with the new functionality, these are:
* Instructors
* Teaching Assistants
* Students
Hence, we would have to write tests for each of these types of users and test the expert review functionality.

The tests for the aforementioned changes will be incorpoirated in a new test file called 'expert_review_spec.rb' located in [https://github.com/expertiza/expertiza/tree/master/spec/features spec/features] folder.

Some of the tests that we have in mind as of now, are as follows:
* '''Instructor'''
** Login as instructor using pre-configured credential.
** Go to "General" tab
*** Verify "Add expert peer review?" present instead of "Calibrated peer-review for training?"
** Verify whether the instructor can see "Expert Review" on the assignment setting page.
** Perform Expert Review, based on values declared in Fixtures available to Instructor.

* '''Teaching Assistant'''
** Login as TA using pre-configured credential.
** Go to "General" tab
*** Verify "Add expert peer review?" present instead of "Calibrated peer-review for training?"
** Verify whether the TA can see "Expert Review" on the assignment setting page.
** Perform Expert Review, based on values declared in Fixtures available to TA.

* '''Student'''
** Log in as Student using pre-configured credential.
** Verify if student can see "Show expert peer-review results"
*** When a new expert-review is available.
*** Show nothing when nothing is available.
** Testing to check if the reviews show up.
*** If added by TA.
*** If added by instructor.
*** If multiple reviews from either TA or instructor show up as a list.
** Testing varying-rubric-by-round feature.

CSC/ECE 517 Fall 2017/E17A1

2017-11-07T17:14:26Z

Rcoutin: /* Design Overview */

This wiki page is the description of the E17A1 semester project - Let experts as well as students do reviews - for Fall 2017, CSC/ECE 517.

= Introduction =

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

=== Environment Setup ===
We have tried two different ways of setting up the Expertiza Environment, first approach used the Ubuntu-Expertiza image while the second approach involved setting up on NCSU's VCL Infrastructure. The process involving both of these approaches are detailed below. We referred the following [https://docs.google.com/document/d/1tXmwju6R7KQbvycku-bdXxa6rXSUN4BMyvjY3ROmMSw/ link].

'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza
bash ./setup.sh
bundle install
rake db:migrate</pre>

'''VCL Setup'''
The process of getting expertiza up and running on VCL is well detailed in the following [https://youtu.be/AStOjov7EQk video].
After completing the steps mentioned in the video, Additionally, we had to install Redis and NodeJS separately to get the expertiza site running. The process is detailed below:
* Steps to install Redis:
<pre>wget http://download.redis.io/redis-stable.tar.gz
tar xvzf redis-stable.tar.gz
cd redis-stable
make</pre>
Run the redis-server using:
<pre>redis-server</pre>

* Steps to install NodeJS on CentOS:
<pre>wget http://nodejs.org/dist/v0.10.30/node-v0.10.30.tar.gz
tar xzvf node-v* && cd node-v*
sudo yum install gcc gcc-c++
./configure
make
sudo make install</pre>

*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

= Action Items =
=== Existing Limitations ===
At present the calibration functionality is limited, the following points present the scenarios where the current implementation is lacking:
# No support for varying rubric by round feature.
# From the perspective of the student, lack of differentiation of review - whether its from an expert or otherwise.
# A student is not notified once an expert submits a review.
# Additionally, a student should be able to see how an expert rated his/her assignment - similar to how it's done in calibration results for calibrated assignments(''As seen when '''Show Calibration Results''' is clicked.'').

=== Tasks Involved ===
Tasks are broken down into sub-tasks as follows:
* Refactoring:
** a checkbox in the "General" Tab from “Calibrated peer-review for training?” to “Add expert peer review?”
** a tab name for instructor from “Calibration” to “Expert review” on the assignment setting page
** partial file from “_calibration.html.erb” to “_expert_review.html.erb”
** the link title on student side from “show calibration results” to “show expert peer-review results”
** the file “response/show_calibration_results_for_student.html.erb” to “response/show_expert_review_results_for_student.html.erb”
** title in “response/show_calibration_results_for_student.html.erb” to start with “Expert review comparison report for”
* Functionality changes
** Vary-rubric-by-round - Currently, the functionality of calibration is limited. It does not support varying-rubric-by-round feature
** Both TAs and instructors could do expert reviews - need to modify “response/show_calibration_results_for_student.html.erb” to make it support multiple expert reviews

=== Affected Codebase ===
==== Database Related ====
A new migration file needs to written to make the following changes in the DB Schema (''And across all files using these fields''):
* “is_calibrated” field in assignment table to “has_expert_review”
* “calibrate_to” field in response_map table to “expert_review_to”

==== Front-end Related ====
The following files need to be modified and/or refactored based on their respective tasks:
#student_review/_responses.html.erb
#student_review/list.html.erb
#assignments/edit.html.erb
#assignments/edit/_calibration.html.erb
#response/show_calibration_results_for_student.html.erb

= Design Overview =
For the purpose of this project, experts in the expertiza domain are Teaching Assistants(TAs) and Instructors.

The following two patterns are implemented in the project -

1.MVC Pattern – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).

2.DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

The following diagram shows the control flow of reviews in expertiza.

= Test Plan =
To test aforementioned changes a new test file would be created called 'expert_review_spec.rb' file in [https://github.com/expertiza/expertiza/tree/master/spec/features spec/features] folder. Based on the new functionality added, we will perform the following tests:
* Login as instructor or TA using their respective credentials.
* "General" tab has "Add expert peer review?" instead of "Calibrated peer-review for training?"
* An instructor should be able to see "Expert Review" on the assignment setting page.
* When logging in as a student, the student should get "show expert peer-review results" link when a new expert-review is available.
* Testing varying-rubric-by-round feature
* Testing to check if the reviews added by TA also show up in expert-peer review along with the review from instructor.

CSC/ECE 517 Fall 2017/E17A1

2017-11-07T17:13:50Z

Rcoutin: /* Design Overview */

This wiki page is the description of the E17A1 semester project - Let experts as well as students do reviews - for Fall 2017, CSC/ECE 517.

= Introduction =

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

=== Environment Setup ===
We have tried two different ways of setting up the Expertiza Environment, first approach used the Ubuntu-Expertiza image while the second approach involved setting up on NCSU's VCL Infrastructure. The process involving both of these approaches are detailed below. We referred the following [https://docs.google.com/document/d/1tXmwju6R7KQbvycku-bdXxa6rXSUN4BMyvjY3ROmMSw/ link].

'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza
bash ./setup.sh
bundle install
rake db:migrate</pre>

'''VCL Setup'''
The process of getting expertiza up and running on VCL is well detailed in the following [https://youtu.be/AStOjov7EQk video].
After completing the steps mentioned in the video, Additionally, we had to install Redis and NodeJS separately to get the expertiza site running. The process is detailed below:
* Steps to install Redis:
<pre>wget http://download.redis.io/redis-stable.tar.gz
tar xvzf redis-stable.tar.gz
cd redis-stable
make</pre>
Run the redis-server using:
<pre>redis-server</pre>

* Steps to install NodeJS on CentOS:
<pre>wget http://nodejs.org/dist/v0.10.30/node-v0.10.30.tar.gz
tar xzvf node-v* && cd node-v*
sudo yum install gcc gcc-c++
./configure
make
sudo make install</pre>

*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

= Action Items =
=== Existing Limitations ===
At present the calibration functionality is limited, the following points present the scenarios where the current implementation is lacking:
# No support for varying rubric by round feature.
# From the perspective of the student, lack of differentiation of review - whether its from an expert or otherwise.
# A student is not notified once an expert submits a review.
# Additionally, a student should be able to see how an expert rated his/her assignment - similar to how it's done in calibration results for calibrated assignments(''As seen when '''Show Calibration Results''' is clicked.'').

=== Tasks Involved ===
Tasks are broken down into sub-tasks as follows:
* Refactoring:
** a checkbox in the "General" Tab from “Calibrated peer-review for training?” to “Add expert peer review?”
** a tab name for instructor from “Calibration” to “Expert review” on the assignment setting page
** partial file from “_calibration.html.erb” to “_expert_review.html.erb”
** the link title on student side from “show calibration results” to “show expert peer-review results”
** the file “response/show_calibration_results_for_student.html.erb” to “response/show_expert_review_results_for_student.html.erb”
** title in “response/show_calibration_results_for_student.html.erb” to start with “Expert review comparison report for”
* Functionality changes
** Vary-rubric-by-round - Currently, the functionality of calibration is limited. It does not support varying-rubric-by-round feature
** Both TAs and instructors could do expert reviews - need to modify “response/show_calibration_results_for_student.html.erb” to make it support multiple expert reviews

=== Affected Codebase ===
==== Database Related ====
A new migration file needs to written to make the following changes in the DB Schema (''And across all files using these fields''):
* “is_calibrated” field in assignment table to “has_expert_review”
* “calibrate_to” field in response_map table to “expert_review_to”

==== Front-end Related ====
The following files need to be modified and/or refactored based on their respective tasks:
#student_review/_responses.html.erb
#student_review/list.html.erb
#assignments/edit.html.erb
#assignments/edit/_calibration.html.erb
#response/show_calibration_results_for_student.html.erb

= Design Overview =
For the purpose of this project, experts in the expertiza domain are Teaching Assistants(TAs) and Instructors.

The following two patterns are implemented in the project -
1.MVC Design Pattern – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).
2.DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

The following diagram shows the control flow of reviews in expertiza.

= Test Plan =
To test aforementioned changes a new test file would be created called 'expert_review_spec.rb' file in [https://github.com/expertiza/expertiza/tree/master/spec/features spec/features] folder. Based on the new functionality added, we will perform the following tests:
* Login as instructor or TA using their respective credentials.
* "General" tab has "Add expert peer review?" instead of "Calibrated peer-review for training?"
* An instructor should be able to see "Expert Review" on the assignment setting page.
* When logging in as a student, the student should get "show expert peer-review results" link when a new expert-review is available.
* Testing varying-rubric-by-round feature
* Testing to check if the reviews added by TA also show up in expert-peer review along with the review from instructor.

CSC/ECE 517 Fall 2017/E17A1

2017-11-07T17:09:16Z

Rcoutin: /* Design Overview */

CSC/ECE 517 Fall 2017/E17A1

2017-11-06T23:47:20Z

Rcoutin: /* Action Items */

CSC/ECE 517 Fall 2017

2017-11-06T23:17:22Z

Rcoutin: Adding E17A1 to the list

'''Design Project Documentation'''
*[[CSC/ECE 517 Fall 2017/E17A8. Use a profiler to identify the problems / pages that take some time to load & fix them]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]]
*[[CSC/ECE 517 Fall 2017/E17A0 Team-based reviewing]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join_Team1964]]
*[[CSC/ECE 517 Fall 2017/E1799 Improve self-review Link peer review & self-review to derive grades]]
*[[CSC/ECE_517_Fall_2017/E1797_Timestamps_for_students_submissions]]
*[[CSC/ECE_517_Fall_2017/E17A1|CSC/ECE_517_Fall_2017/E17A1 - Let experts as well as students do reviews]]
'''Writing Assignment 2'''
*[[CSC/ECE 517 Fall 2017/E1779. Fix teammate advertisements and requests to join a team]]
*[[CSC/ECE_517_Fall_2017/E1773 Investigate and Fix Expertiza Production Version Runtime Exceptions.rb]]
*[[CSC/ECE_517_Fall_2017/E1774 Metareview fixes and improvements.rb]]
*[[CSC/ECE_517_Fall_2017/E1788 OSS project Maroon Heatmap fixes]]
*[[CSC/ECE 517 Fall 2017/E1781 Topic Management]]
*[[CSC/ECE_517_Fall_2017/E1745_Refactor_response_controller.rb]]
*[[CSC/ECE_517_Fall_2017/E1752 Refactor assignments controller]]
*[[CSC/ECE_517_Fall_2017/E1776_Enhance_Imports]]
*[[CSC/ECE_517_Fall_2017/E1756 TLD Refactor response.rb]]
*[[CSC/ECE_517_Fall_2017/E1772_Refactor reputation_web_service_controller.rb]]
*[[CSC/ECE_517_Fall_2017/M1754_Mutation Testing on Servo]]
*[[CSC/ECE_517_Fall_2017/E1753 OSS project bidding tests]]
*[[CSC/ECE_517_Fall_2017/E1766_Test team functionality]]
*[[CSC/ECE 517 Fall 2017/E1767 Improve imports]]
*[[CSC/ECE_517_Fall_2017/E1786_OSS project Juniper Bookmark Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1787_OSS project Bronze Score calculations]]
*[[CSC/ECE_517_Fall_2017/E1763 Fix Staggered-Deadline Assignments]]
*[[CSC/ECE 517 Fall 2017/E1757 Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2017/E1769_Refactor assignment_form.rb]]
*[[CSC/ECE 517 Fall 2017/E1754_Feature_test_of_rubric_advice]]
*[[CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories]]
*[[CSC/ECE 517 Fall 2017/E1748 Add past-due assignments to task list]]
*[[CSC/ECE 517 Fall 2017/E1761 Test First Development Refactor assignment.rb]]
*[[CSC/ECE_517_Fall_2017/E1780_OSS_Project_Teal_Email_Notification_Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1762 Test various kinds of response-map hierarchies]]
*[[CSC/ECE_517_Fall_2017/E1759 ]]
*[[CSC/ECE_517_Fall_2017/E1749_Test First Development Refactor questionnaire_controller.rb]]
*[[CSC/ECE 517 Fall 2017/E1777 Coherent specification of review requirements.rb]]
*[[CSC/ECE 517 Fall 2017/E1771_Refactor_team.rb]]

CSC/ECE 517 Fall 2017/E1754 Feature test of rubric advice

2017-10-27T20:29:13Z

Rcoutin:

== Introduction ==

Expertiza is a web application which provides a dashboard to the students where they can submit and peer-review assignments, projects, codes, and other such objects. It allows students to review each other’s work and improve their work upon this feedback. Rubric advice allows reviewers to see what characteristics of work merit a particular score.

== The problem statement ==

Rubric advice lets a user see what criterion or characteristics of work merit a particular score. An instructor can retrieve peer review assignments and leave some advice or give scores based on some criteria. Similarly, students can log in and retrieve the rubric advice left by the instructor. We mocked the behavior of the user (both as an instructor and student) to see how different scenarios work, like modifying, saving and retrieving advice and building feature tests for it. The testing frameworks used for the same were Selenium and Capybara.

== Tasks identified ==

'''Student Side:'''
A student, when filling a peer review should be able to see the rubric advice associated with a particular test score. We test this task through adding a test case in the peer_review_spec.rb since Peer Review is superset of the Rubric Advice feature as it is a task where a student uses the rubric advice and submit it.

Files changed: peer_review_spec.rb
The test case checks if student is able to select a rubric advice that the instructor has created and then submit it.
<pre>
it "able to view and use rubric advice", :js => true do
load_questionnaire
expect(page).to have_content "Show advice"
page.find('#showAdivce_1').click
expect(page).to have_content "5 - Good"
page.find("a", :text => "5 - Good").click
click_button "Save Review"
expect(page).to have_content "Your response was successfully saved."
end
</pre>

The existing code given creates the required environment for the test student. It sets up a team, assignment and other required elements for the test student to submit a review.
<pre>
before(:each) do
create(:assignment, name: "TestAssignment", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
create(:question_advices)
end
</pre>

The rubric advice is prepared in factory.rb with the following code addition . This allows our test Student to get a ready rubric advice that he can choose.
<pre>
factory :question_advices, class: QuestionAdvice do
question_id 1
score 5
advice "Good work"
end
</pre>

'''Instructor side:'''

Edit a certain review rubric, and add advice to it.
Test that when advice is added for a particular criterion, the advice can be retrieved and that it is exactly the advice that was added. Files added: review_rubric_spec.rb

<pre>
describe "Edit a rubric advice" do
it "is able to edit a review rubric advice" do
# creating a new rubric advice
load_question 'Criterion'
click_button "Edit/View advice"
expect(page).to have_content('Edit an existing questionnaire')
# setting intital advice in the field
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Initial advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Initial advice')
# editing a review rubric - Setting any element with new data
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Edited the advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Edited the advice')
end
end

describe "Remove a rubric advice" do
it "should be able to delete a rubric advice" do
load_question 'Criterion'
click_button "Edit/View advice"
expect(page).to have_content('Edit an existing questionnaire')
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Initial advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Initial advice')
# edit review advice to set to blank i.e. delete rubric advice
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
end
end
end
</pre>

Apart from the major test case for Rubric advice, it is essential to test if the logged in instructor is an authorized instructor. To test this, we have added the following test in review_rubric_spec.rb.
Also, the task of loading the questionnaire and the question types is implemented in separate methods to allow reuse.

<pre>

include InstructorInterfaceHelperSpec

# Feature test of rubric advice
describe "Edit rubric advice" do
before(:each) do
assignment_setup
end

# Login test
describe "Login as instructor" do
it "logs in with valid username and password" do
login_as("instructor6")
visit '/tree_display/list'
expect(page).to have_content("Manage content")
end

it "logs in with invalid username and password" do
visit root_path
fill_in 'login_name', with: 'instructor6'
fill_in 'login_password', with: 'wrongpassword'
click_button 'SIGN IN'
expect(page).to have_text('Your username or password is incorrect.')
end
end

def load_questionnaire
login_as("instructor6")
visit '/questionnaires/new?model=ReviewQuestionnaire&private=0'
fill_in('questionnaire_name', with: 'DummyReview')
fill_in('questionnaire_min_question_score', with: '0')
fill_in('questionnaire_max_question_score', with: '5')
select('no', from: 'questionnaire_private')
click_button "Create"
end

def load_question question_type
load_questionnaire
fill_in('question_total_num', with: '1')
select(question_type, from: 'question_type')
click_button "Add"
end
</pre>

== Testing Instructions ==
* [https://github.com/expertiza/expertiza Clone Expertiza on local Repository]
* [http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation#Development_Environment_Setup_Guides Setup expertiza on your local machine]
* Run the test cases: spec/features/peer_review_spec.rb and spec/features/review_rubric_spec.rb using [https://relishapp.com/rspec Rspec]

== References ==

* [https://github.com/rcoutin/expertiza Forked Github Expertiza Repository]
* [https://github.com/expertiza/expertiza Github Expertiza Repository]
* [https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1754 Feature test of rubric advice

2017-10-27T20:24:35Z

Rcoutin:

== Introduction ==

Expertiza is a web application which provides a dashboard to the students where they can submit and peer-review assignments, projects, codes, and other such objects. It allows students to review each other’s work and improve their work upon this feedback. Rubric advice allows reviewers to see what characteristics of work merit a particular score.

== The problem statement ==

Rubric advice lets a user see what criterion or characteristics of work merit a particular score. An instructor can retrieve peer review assignments and leave some advice or give scores based on some criteria. Similarly, students can log in and retrieve the rubric advice left by the instructor. We mocked the behavior of the user (both as an instructor and student) to see how different scenarios work, like modifying, saving and retrieving advice and building feature tests for it. The testing frameworks used for the same were Selenium and Capybara.

== Tasks identified ==

'''Student Side:'''
A student, when filling a peer review should be able to see the rubric advice associated with a particular test score. We test this task through adding a test case in the peer_review_spec.rb since Peer Review is superset of the Rubric Advice feature as it is a task where a student uses the rubric advice and submit it.

Files changed: peer_review_spec.rb
The test case checks if student is able to select a rubric advice that the instructor has created and then submit it.
<pre>
it "able to view and use rubric advice", :js => true do
load_questionnaire
expect(page).to have_content "Show advice"
page.find('#showAdivce_1').click
expect(page).to have_content "5 - Good"
page.find("a", :text => "5 - Good").click
click_button "Save Review"
expect(page).to have_content "Your response was successfully saved."
end
</pre>

The existing code given creates the required environment for the test student. It sets up a team, assignment and other required elements for the test student to submit a review.
<pre>
before(:each) do
create(:assignment, name: "TestAssignment", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
create(:question_advices)
end
</pre>

The rubric advice is prepared in factory.rb with the following code addition . This allows our test Student to get a ready rubric advice that he can choose.
<pre>
factory :question_advices, class: QuestionAdvice do
question_id 1
score 5
advice "Good work"
end
</pre>

'''Instructor side:'''

Edit a certain review rubric, and add advice to it.
Test that when advice is added for a particular criterion, the advice can be retrieved and that it is exactly the advice that was added. Files added: review_rubric_spec.rb

<pre>
describe "Edit a rubric advice" do
it "is able to edit a review rubric advice" do
# creating a new rubric advice
load_question 'Criterion'
click_button "Edit/View advice"
expect(page).to have_content('Edit an existing questionnaire')
# setting intital advice in the field
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Initial advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Initial advice')
# editing a review rubric - Setting any element with new data
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Edited the advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Edited the advice')
end
end

describe "Remove a rubric advice" do
it "should be able to delete a rubric advice" do
load_question 'Criterion'
click_button "Edit/View advice"
expect(page).to have_content('Edit an existing questionnaire')
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Initial advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Initial advice')
# edit review advice to set to blank i.e. delete rubric advice
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
end
end
end
</pre>

<pre>

include InstructorInterfaceHelperSpec

# Feature test of rubric advice
describe "Edit rubric advice" do
before(:each) do
assignment_setup
end

# Login test
describe "Login as instructor" do
it "logs in with valid username and password" do
login_as("instructor6")
visit '/tree_display/list'
expect(page).to have_content("Manage content")
end

it "logs in with invalid username and password" do
visit root_path
fill_in 'login_name', with: 'instructor6'
fill_in 'login_password', with: 'wrongpassword'
click_button 'SIGN IN'
expect(page).to have_text('Your username or password is incorrect.')
end
end

def load_questionnaire
login_as("instructor6")
visit '/questionnaires/new?model=ReviewQuestionnaire&private=0'
fill_in('questionnaire_name', with: 'DummyReview')
fill_in('questionnaire_min_question_score', with: '0')
fill_in('questionnaire_max_question_score', with: '5')
select('no', from: 'questionnaire_private')
click_button "Create"
end

def load_question question_type
load_questionnaire
fill_in('question_total_num', with: '1')
select(question_type, from: 'question_type')
click_button "Add"
end
</pre>

== Testing Instructions ==
* [https://github.com/expertiza/expertiza Clone Expertiza on local Repository]
* [http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation#Development_Environment_Setup_Guides Setup expertiza on your local machine]
* Run the test cases: spec/features/peer_review_spec.rb and spec/features/review_rubric_spec.rb using [https://relishapp.com/rspec Rspec]

== References ==

* [https://github.com/rcoutin/expertiza Forked Github Expertiza Repository]
* [https://github.com/expertiza/expertiza Github Expertiza Repository]
* [https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1754 Feature test of rubric advice

2017-10-27T20:21:27Z

Rcoutin:

== Introduction ==

Expertiza is a web application which provides a dashboard to the students where they can submit and peer-review assignments, projects, codes, and other such objects. It allows students to review each other’s work and improve their work upon this feedback. Rubric advice allows reviewers to see what characteristics of work merit a particular score.

== The problem statement ==

Rubric advice lets a user see what criterion or characteristics of work merit a particular score. An instructor can retrieve peer review assignments and leave some advice or give scores based on some criteria. Similarly, students can log in and retrieve the rubric advice left by the instructor. We mocked the behavior of the user (both as an instructor and student) to see how different scenarios work, like modifying, saving and retrieving advice and building feature tests for it. The testing frameworks used for the same were Selenium and Capybara.

== Tasks identified ==

'''Student Side:'''
A student, when filling a peer review should be able to see the rubric advice associated with a particular test score. We test this task through adding a test case in the peer_review_spec.rb since Peer Review is superset of the Rubric Advice feature as it is a task where a student uses the rubric advice and submit it.

Files changed: peer_review_spec.rb
The test case checks if student is able to select a rubric advice that the instructor has created and then submit it.
<pre>
it "able to view and use rubric advice", :js => true do
load_questionnaire
expect(page).to have_content "Show advice"
page.find('#showAdivce_1').click
expect(page).to have_content "5 - Good"
page.find("a", :text => "5 - Good").click
click_button "Save Review"
expect(page).to have_content "Your response was successfully saved."
end
</pre>

The existing code given creates the required environment for the test student. It sets up a team, assignment and other required elements for the test student to submit a review.
<pre>
before(:each) do
create(:assignment, name: "TestAssignment", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
create(:question_advices)
end
</pre>

The rubric advice is prepared in factory.rb with the following code addition . This allows our test Student to get a ready rubric advice that he can choose.
<pre>
factory :question_advices, class: QuestionAdvice do
question_id 1
score 5
advice "Good work"
end
</pre>

'''Instructor side:'''

Edit a certain review rubric, and add advice to it.
Test that when advice is added for a particular criterion, the advice can be retrieved and that it is exactly the advice that was added. Files added: review_rubric_spec.rb

<pre>
describe "Edit a rubric advice" do
it "is able to edit a review rubric advice" do
# creating a new rubric advice
load_question 'Criterion'
click_button "Edit/View advice"
expect(page).to have_content('Edit an existing questionnaire')
# setting intital advice in the field
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Initial advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Initial advice')
# editing a review rubric - Setting any element with new data
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Edited the advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Edited the advice')
end
end

describe "Remove a rubric advice" do
it "should be able to delete a rubric advice" do
load_question 'Criterion'
click_button "Edit/View advice"
expect(page).to have_content('Edit an existing questionnaire')
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Initial advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Initial advice')
# edit review advice to set to blank i.e. delete rubric advice
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
end
end
end
</pre>

== Testing Instructions ==
* [https://github.com/expertiza/expertiza Clone Expertiza on local Repository]
* [http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation#Development_Environment_Setup_Guides Setup expertiza on your local machine]
* Run the test cases: spec/features/peer_review_spec.rb and spec/features/review_rubric_spec.rb using [https://relishapp.com/rspec Rspec]

== References ==

* [https://github.com/rcoutin/expertiza Forked Github Expertiza Repository]
* [https://github.com/expertiza/expertiza Github Expertiza Repository]
* [https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1754 Feature test of rubric advice

2017-10-27T20:19:52Z

Rcoutin:

== Introduction ==

Expertiza is a web application which provides a dashboard to the students where they can submit and peer-review assignments, projects, codes, and other such objects. It allows students to review each other’s work and improve their work upon this feedback. Rubric advice allows reviewers to see what characteristics of work merit a particular score.

== The problem statement ==

Rubric advice lets a user see what criterion or characteristics of work merit a particular score. An instructor can retrieve peer review assignments and leave some advice or give scores based on some criteria. Similarly, students can log in and retrieve the rubric advice left by the instructor. We mocked the behavior of the user (both as an instructor and student) to see how different scenarios work, like modifying, saving and retrieving advice and building feature tests for it. The testing frameworks used for the same were Selenium and Capybara.

== Tasks identified ==

'''Student Side:'''
A student, when filling a peer review should be able to see the rubric advice associated with a particular test score. We test this task through adding a test case in the peer_review_spec.rb since Peer Review is superset of the Rubric Advice feature as it is a task where a student uses the rubric advice and submit it.

Files changed: peer_review_spec.rb
The test case checks if student is able to select a rubric advice that the instructor has created and then submit it.
<pre>
it "able to view and use rubric advice", :js => true do
load_questionnaire
expect(page).to have_content "Show advice"
page.find('#showAdivce_1').click
expect(page).to have_content "5 - Good"
page.find("a", :text => "5 - Good").click
click_button "Save Review"
expect(page).to have_content "Your response was successfully saved."
end
</pre>

The existing code given creates the required environment for the test student. It sets up a team, assignment and other required elements for the test student to submit a review.
<pre>
before(:each) do
create(:assignment, name: "TestAssignment", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
create(:question_advices)
end
</pre>

The rubric advice is prepared in factory.rb with the following code addition . This allows our test Student to get a ready rubric advice that he can choose.
<pre>
factory :question_advices, class: QuestionAdvice do
question_id 1
score 5
advice "Good work"
end
</pre>

'''Instructor side:'''

Edit a certain review rubric, and add advice to it.
Test that when advice is added for a particular criterion, the advice can be retrieved and that it is exactly the advice that was added.

<pre>
describe "Edit a rubric advice" do
it "is able to edit a review rubric advice" do
# creating a new rubric advice
load_question 'Criterion'
click_button "Edit/View advice"
expect(page).to have_content('Edit an existing questionnaire')
# setting intital advice in the field
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Initial advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Initial advice')
# editing a review rubric - Setting any element with new data
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Edited the advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Edited the advice')
end
end

describe "Remove a rubric advice" do
it "should be able to delete a rubric advice" do
load_question 'Criterion'
click_button "Edit/View advice"
expect(page).to have_content('Edit an existing questionnaire')
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Initial advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Initial advice')
# edit review advice to set to blank i.e. delete rubric advice
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
end
end
end
</pre>

== Testing Instructions ==
* [https://github.com/expertiza/expertiza Clone Expertiza on local Repository]
* [http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation#Development_Environment_Setup_Guides Setup expertiza on your local machine]
* Run the test cases: spec/features/peer_review_spec.rb and spec/features/review_rubric_spec.rb using [https://relishapp.com/rspec Rspec]

== References ==

* [https://github.com/rcoutin/expertiza Forked Github Expertiza Repository]
* [https://github.com/expertiza/expertiza Github Expertiza Repository]
* [https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1754 Feature test of rubric advice

2017-10-27T20:19:24Z

Rcoutin:

== Introduction ==

Expertiza is a web application which provides a dashboard to the students where they can submit and peer-review assignments, projects, codes, and other such objects. It allows students to review each other’s work and improve their work upon this feedback. Rubric advice allows reviewers to see what characteristics of work merit a particular score.

== The problem statement ==

Rubric advice lets a user see what criterion or characteristics of work merit a particular score. An instructor can retrieve peer review assignments and leave some advice or give scores based on some criteria. Similarly, students can log in and retrieve the rubric advice left by the instructor. We mocked the behavior of the user (both as an instructor and student) to see how different scenarios work, like modifying, saving and retrieving advice and building feature tests for it. The testing frameworks used for the same were Selenium and Capybara.

== Tasks identified ==

'''Student Side:'''
A student, when filling a peer review should be able to see the rubric advice associated with a particular test score. We test this task through adding a test case in the peer_review_spec.rb since Peer Review is superset of the Rubric Advice feature as it is a task where a student uses the rubric advice and submit it.

Files changed: peer_review_spec.rb
The test case checks if student is able to select a rubric advice that the instructor has created and then submit it.
<pre>
it "able to view and use rubric advice", :js => true do
load_questionnaire
expect(page).to have_content "Show advice"
page.find('#showAdivce_1').click
expect(page).to have_content "5 - Good"
page.find("a", :text => "5 - Good").click
click_button "Save Review"
expect(page).to have_content "Your response was successfully saved."
end
</pre>

The existing code given creates the required environment for the test student. It sets up a team, assignment and other required elements for the test student to submit a review.
<pre>
before(:each) do
create(:assignment, name: "TestAssignment", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
create(:question_advices)
end
</pre>

The rubric advice is prepared in factory.rb with the following code addition . This allows our test Student to get a ready rubric advice that he can choose.
<pre>
factory :question_advices, class: QuestionAdvice do
question_id 1
score 5
advice "Good work"
end
</pre>

Instructor side:

Edit a certain review rubric, and add advice to it.
Test that when advice is added for a particular criterion, the advice can be retrieved and that it is exactly the advice that was added.

<pre>
describe "Edit a rubric advice" do
it "is able to edit a review rubric advice" do
# creating a new rubric advice
load_question 'Criterion'
click_button "Edit/View advice"
expect(page).to have_content('Edit an existing questionnaire')
# setting intital advice in the field
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Initial advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Initial advice')
# editing a review rubric - Setting any element with new data
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Edited the advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Edited the advice')
end
end

describe "Remove a rubric advice" do
it "should be able to delete a rubric advice" do
load_question 'Criterion'
click_button "Edit/View advice"
expect(page).to have_content('Edit an existing questionnaire')
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("Initial advice")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
expect(page).to have_content('Initial advice')
# edit review advice to set to blank i.e. delete rubric advice
first(:css, "textarea[id^='horizontal_'][id$='advice']").set("")
click_button "Save and redisplay advice"
expect(page).to have_content('advice was successfully saved')
end
end
end
</pre>

== Testing Instructions ==
* [https://github.com/expertiza/expertiza Clone Expertiza on local Repository]
* [http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation#Development_Environment_Setup_Guides Setup expertiza on your local machine]
* Run the test cases: spec/features/peer_review_spec.rb and spec/features/review_rubric_spec.rb using [https://relishapp.com/rspec Rspec]

== References ==

* [https://github.com/rcoutin/expertiza Forked Github Expertiza Repository]
* [https://github.com/expertiza/expertiza Github Expertiza Repository]
* [https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1754 Feature test of rubric advice

2017-10-27T19:07:04Z

Rcoutin: /* Testing Intructions */

CSC/ECE 517 Fall 2017

2017-10-27T17:14:15Z

Rcoutin: Adding feature test of rubric advice - E1754

'''Writing Assignment 2'''
*[[CSC/ECE 517 Fall 2017/E1779. Fix teammate advertisements and requests to join a team]]
*[[CSC/ECE_517_Fall_2017/E1773 Investigate and Fix Expertiza Production Version Runtime Exceptions.rb]]
*[[CSC/ECE_517_Fall_2017/E1774 Metareview fixes and improvements.rb]]
*[[CSC/ECE_517_Fall_2017/E1788 OSS project Maroon Heatmap fixes]]
*[[CSC/ECE 517 Fall 2017/E1781 Topic Management]]
*[[CSC/ECE_517_Fall_2017/E1745_Refactor_response_controller.rb]]
*[[CSC/ECE_517_Fall_2017/E1752 Refactor assignments controller]]
*[[CSC/ECE_517_Fall_2017/E1776_Enhance_Imports]]
*[[CSC/ECE_517_Fall_2017/E1756 TLD Refactor response.rb]]
*[[CSC/ECE_517_Fall_2017/E1772_Refactor reputation_web_service_controller.rb]]
*[[CSC/ECE_517_Fall_2017/M1754_Mutation Testing on Servo]]
*[[CSC/ECE_517_Fall_2017/E1753 OSS project bidding tests]]
*[[CSC/ECE_517_Fall_2017/E1766_Test team functionality]]
*[[CSC/ECE_517_Fall_2017/E1787_OSS project Bronze Score calculations]]
*[[CSC/ECE_517_Fall_2017/E1763 Fix Staggered-Deadline Assignments]]
*[[CSC/ECE 517 Fall 2017/E1757 Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2017/E1769_Refactor assignment_form.rb]]
*[[CSC/ECE 517 Fall 2017/E1754_Feature_test_of_rubric_advice]]