Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1986. Allow reviewers to bid on what to review

2019-11-11T06:23:46Z

Arungta: Created page with "== '''Why Should Participants bid for Reviews''' == If the choice of which submission to review is left to student itself, he/she would choose to review those topics which are r..."

== '''Why Should Participants bid for Reviews''' ==

If the choice of which submission to review is left to student itself, he/she would choose to review those topics which are related to their project or whatever they are highly interested in. This would benefit both the reviewer and reviewer because

From Student's Perspective:

*Because he/she does not have to spend a lot of time on understanding what is going on.
*The Student would be more focused on giving the review and hence judgement made tend to be more objective than subjective.
*This would improve the quality of reviews and will also be helpful for the reviewer.
*Also, Bidding in Fun !!!!!!!

From Instructor's Standpoint:

*Because opinions expressed in the reviews are a result of informed decisions, the inference made from the Machine Learning models trained on these data sets would make more sense.

== '''Problem Statement''' ==

=== Current situation ===

When an assignment participant wants to review others’ work, they will be asked to choose an assignment topic. The participant will be allowed to choose from among those assignment topics that have not been already assigned to 10 other participants. If they choose the ‘I do not care about the topic I review’ option, a random topic will be chosen from all the available topics and will be assigned to them.

'''Previous Work on this issue'''

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1856_Allow_reviewers_to_bid_on_what_to_review '''E1856 Work''']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1928._Allow_reviewers_to_bid_on_what_to_review '''E1928 Work''']

=== What’s Deeply wrong in those implementations ===

To understand what's wrong, first consider the differences between Teams Bidding for Assignments and Students Bidding for Reviews. Both of these are Matching or resource Allocation Problems.

The former can be modelled as a one-to-one matching problem. (i.e team and assignment has one-to-one correspondence).

[[File:Teams_Assignments_2.png |center|]]

However, Students and Reviews have many-to-many relationship (a student can choose multiple submissions for review and a submission can be given to multiple students for review)

[[File:Teams_Assignments.png |center|]]

The Mathematical formulation is itself wrong in E1856 and E1928 and they have used the below shown diagram to represent the relationship.

[[File:Teams_Assignments_3.png |center|]]

=== Why does the difference is representation matter ===

Since they have modeled the problem on the same lines, they have used the same version of Gale-Shapley or Top Trading Cycles Algorithm used for one-to-many or one-to-one approach.
Famous Problems Dealt on these lines.

[https://en.wikipedia.org/wiki/Stable_marriage_problem Stable_marriage_problem]

[https://www.jstor.org/stable/3132114?seq=1&cid=pdf-reference#references_tab_contents Jsror reference tab content]

=== Other Implementation pitfalls ===

'''E1928'''

*Once the bidding for review topics is done, the selections needs to be saved to the database which is not happening currently that means when the page is refreshed, the UI does not retain the bids.
*The button responsible for running the algorithm cannot be checked and it is a hunk- like icon.
*The button appears multiple times on the page.
*The algorithm needs to be implemented in the web service which should be ideally be used from the lottery controller which is not they have tried to implement. The entire code is written in Ruby.
*The algorithm needs to skip the review topic that the user has worked on. This Code already exists for topic and again written in the new implementation that needs to be integrated into the existing one and hence needs refactoring.
*Proper tests need to be written.

== '''What needs to be done''' ==

The participants should be able to bid for topics to review in the same way they bid for topics to work on.
=== Functional Requirements===
*Each participant should be able to submit a list of preferences in decreasing preference order for the topics they would like to review. The list may contain any number of topics.
*During bidding, the topics should be color coded according to the number of participants who are contending for each topic. The colors should range from green to red with green representing a topic with a low number of bids and red representing a topic with a high number of bids.
*There should be a deadline before which all participants must submit their list of preferences.
*After the deadline, the course instructor should be able to run the bidding algorithm after which each participant will be assigned a list of topics to review. The number of topics assigned to a participant should be minimum(4,k) where ‘k’ is the number of topics in their preference list.
*Once the topics to review have been assigned, the participants should be able to see those topics they have been assigned and give feedback to the submission for each topic.
*If a participant has given feedback to less than 4 topics and choose to review a submission, the topic with the minimum number of current reviewers will be assigned to that participant.

=== Non-functional Requirements ===

*There must exist a web service which takes the participants and their respective preference lists as input, runs a bidding algorithm like top trading cycles and returns a map of the participants and the list of topics assigned to each participant.
*This web service must either be called from the LotteryController or a new controller can be created on the same (if Lottery Controller becomes too complex).

== '''Bidding Algorithm''' ==

We have a many-to-many matching problem in our hand. The assignment topics each have a quota 10 of reviewers the topic can be assigned to at maximum. Each of the students have a quota 4 of topics they can be assigned at maximum. Gale and Shapely have proposed a mechanism called the Deferred Acceptance (DA) algorithm for finding a stable solution for one-to-one and many-to-one matching problems. The generalization of the DA algorithm other case of many-to-many matching with different preferences and quotas proposed by Freer et al. can be used as our bidding algorithm.

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

*Check whether the UI reflects the bids made by the user
*Check if a user is assigned a maximum of 4 reviews and not more than that even though he bids for more.
*Regression testing if the code is added in the lottery controller. If new model/controller is added then relevant tests will be included based on the proposal acceptance.
*Tests to ensure that each review topic gets minimum number of reviews.
*Tests for color coding
*Tests to check whether the web service functionality works as expected.

== Important references ==

[https://github.com/peerlogic/IntelligentAssignment/blob/master/app/app.py InteligentAssignment]

[http://ices.gmu.edu/wp-content/uploads/2015/02/Many-to-Many-Matching-Problem-with-Quotas-by-Freer-and-Titova.pdf Many-to-Many-Matching-Problem-with-Quotas-by-Freer-and-Titova]

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1928._Allow_reviewers_to_bid_on_what_to_review Project_E1928._Allow_reviewers_to_bid_on_what_to_review]

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1856_Allow_reviewers_to_bid_on_what_to_review E1856_Allow_reviewers_to_bid_on_what_to_review]

File:Teams Assignments 3.png

2019-11-11T06:21:00Z

Arungta:

File:Teams Assignments.png

2019-11-11T06:20:16Z

Arungta:

File:Teams Assignments 2.png

2019-11-11T06:19:28Z

Arungta:

CSC/ECE 517 Fall 2019

2019-11-11T05:35:58Z

Arungta:

* [[CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz_questionnaire_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews]]
* [[CSC/ECE 517 Fall 2019 - Project E1943. Refactor sign up sheet controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics]]
* [[CSC/ECE 517 Fall 2019 - E1961. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2019 - E1971. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2019 - E1953. Tagging report for student]]
* [[CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student_task.rb]]
* [[CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names]]
* [[CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management]]
* [[CSC/ECE 517 Fall 2019 - E1948. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics]]
* [[CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams]]
* [[CSC/ECE 517 Fall 2019 - E1969. Fixes for reviews not being available]]
* [[CSC/ECE 517 Fall 2019 - E1951. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2019 - E1957. Time travel Not Allowed..!!! Restrict TAs’ ability to change their own grade + limit file-size upload]]
* [[CSC/ECE 517 Fall 2019 - E1963. Changing assignment participant role]]
* [[CSC/ECE 517 Fall 2019 - E1941. Issues related to topic deadlines]]
* [[CSC/ECE 517 Fall 2019 - E1966. Tabbed_reviews partial file refactor for displaying the alternate view of reviews]]
* [[CSC/ECE 517 Fall 2019 - E1962. Email notification upon account creation]]
* [[CSC/ECE 517 Fall 2019 - E1967. Fix glitches in author feedback]]
* [[CSC/ECE 517 Fall 2019 - E1960. Create new late policy successfully and fixing "Back" link]]
* [[CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements]]
* [[CSC/ECE 517 Fall 2019 - M1950. Support Asynchronous Web Assembly Compilation]]
* [[CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches]]
* [[CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews]]
* [[CSC/ECE 517 Fall 2019 - M1951. Implement missing OffscreenCanvas APIs]]
* [[CSC/ECE 517 Fall 2019 - E1940. Improving email notification]]
* [[CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug]]
* [[CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb]]
* [[CSC/ECE 517 Fall 2019 - M1952. Missing DOM features project]]
* [[CSC/ECE 517 Fall 2019 - E1945. Refactor users_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1964. Export review scores for projects]]
* [[CSC/ECE 517 Fall 2019 - E1949. Write Unit Tests for Importing assignment participants and import glitches]]
* [[CSC/ECE 517 Fall 2019 - E1944. Refactor review mapping controller]]
* [[CSC/ECE 517 Fall 2019 - E1946. Refactor Questionnaire controller]]
* [[CSC/ECE 517 Fall 2019 - E1982. Regulate changing of rubrics while projects are in progress]]
* [[CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions]]
* [[CSC/ECE 517 Fall 2019 - E1990. Integrate suggestion detection algorithm]]
* [[CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality]]
* [[CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]]
* [[CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view]]
* [[CSC/ECE 517 Fall 2019 - E1995. Weights in grade calculation]]
* [[CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.]]
* [[CSC/ECE 517 Fall 2019 - E1984. Improve self-review Link peer review & self-review to derive grades]]
* [[CSC/ECE 517 Fall 2019 - E1994. Mentor management for assignments without topics]]
* [[CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing]]
* [[CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric]]
* [[CSC/ECE 517 Fall 2019 - E1996. Enhancements to review grader]]
* [[CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza]]
* [[CSC/ECE 517 Fall 2019 - E1978. Fix issues related to deadlines and late policies]]
* [[CSC/ECE 517 Fall 2019 - E1991. Improvements to anonymized view]]
* [[CSC/ECE 517 Fall 2019 - E1998. Weights in grade calculation]]
* [[CSC/ECE 517 Fall 2019 - E1986. Allow reviewers to bid on what to review]]

CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student task.rb

2019-11-08T00:36:06Z

Arungta: /* Test Plan */

This page provides a description of the Expertiza based OSS project.

== About Expertiza ==

[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ 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.

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

== About RSpec ==

RSpec is a unit test framework for the Ruby programming language. RSpec is different than traditional xUnit frameworks like JUnit because RSpec is a Behavior driven development tool. What this means is that, tests written in RSpec focus on the "behavior" of an application being tested. RSpec does not put emphasis on, how the application works but instead on how it behaves, in other words, what the application actually does.Each RSpec file contains one or more tests. Each test ensures if a particular feature of our website is working properly.The output of an RSpec run will tell you exactly what features aren't working. The benefit is that tested code is unlikely to break unnoticed.The tests are run every time someone makes, or updates, a [https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests Pull Request].

== DB Schema ==
Below are the tables that are related ti student task functionality
[http://wiki.expertiza.ncsu.edu/images/7/7a/ExpertizaDbSchema.jpg DB Schema]

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the student_task.rb and student_task_spec.rb. It focuses on writing RSpec unit tests for the code affected or added. The goal of this project is to attempt to add sufficient unit tests to this part of the application and increase its path coverage to above 90 percent.
The following tasks were accomplished in this project:

* Complete the insufficient unit tests for student_task.rb.
* Increase path coverage from only 31.91% with 30 lines covered to above 92.55% with 87 lines covered.
* Cover edge cases.
* High branch coverage to be achieved.

There are different tasks that a student can perform.
* He can see all the assignments that he has been assigned to.
* He can see details of each assignment like marks, his team, send invitation to student to join a team
* Review other students' work

[http://wiki.expertiza.ncsu.edu/images/4/4c/StudentTaskHomePage.png Student Task Home Page]

[http://wiki.expertiza.ncsu.edu/images/4/4d/StudentTaskAssignmentTasks.png Assignment Submission Tasks]

The following functions were tested:

* complete?
This function returns true if the participant stage deadline is "complete" or else return false.
* content_submitted_in_current_stage?
This function returns true if the participant has submitted hyperlinks in the current stage and the stage is in "submission"
* hyperlinks
This function returns all the hyperlinks submitted by the participant team
* in_work_stage?
A assignment is said to be in work stage if its stage is any of "submission", "review" or "metareview"
* incomplete?
This function returns true if the participant stage deadline is not "complete" or else return false.
* metareviews_given? * reviews_given?
A participant can review other people's work and add comments.
Also a user can review a review, called "metareview" that is given to him.
A review comment is mapped to assignments or other reviews by the table response_tags via the reviewed_object_id.
This method checks if the participant has given any metareview and return true otherwise.
* metareviews_given_in_current_stage?
This function checks if the assignment is in "metareview" stage and metareviews.
* not_started?
This function checks if the assignment is in any of "submission", "review" or "metareview" stage
* relative_deadline
* reviews_given_in_current_stage?
* revision?
* from_participant(participant)
This function return the StudentTask from the participant with assignment, topic, current_stage
* from_participant_id(id)
This function return the StudentTask from the participant with assignment, topic, current_stage using the participant id
* from_user(user)
* get_author_feedback_data(participant_id, timeline_list)
* get_due_date_data(assignment, timeline_list)
* get_peer_review_data(participant_id, timeline_list)
* get_submission_data(assignment_id, team_id, timeline_list)
* get_timeline_data(assignment, participant, team)
* teamed_students(user, ip_address = nil)
This function return the list of all the students that the logged on user has teamed up until now.
* started?
Checks if the current stage is "incomplete" and content_submitted_in_current_stage? reviews_given_in_current_stage? || metareviews_given_in_current_stage? and return true and false
* topic_name
Return the name of the topic

== Test Plan ==

* Mock Objects
The following mock objects were created/built before the commencement of automated testing for student_task.rb (model) code.
<pre>
let(:participant) { build(:participant, id: 1, user_id: user.id, parent_id: assignment.id) }
let(:participant2) { build(:participant, id: 2, user_id: user2.id, parent_id: assignment.id) }
let(:participant3) { build(:participant, id: 3, user_id: user3.id, parent_id: assignment2.id) }
let(:user) { create(:student) }
let(:user2) { create(:student, name: "qwertyui", id: 5) }
let(:user3) { create(:student, name: "qwertyui1234", id: 6) }
let(:course) { build(:course) }
let(:assignment) { build(:assignment, name: 'assignment 1') }
let(:assignment2) { create(:assignment, name: 'assignment 2', is_calibrated: true) }
let(:team) { create(:assignment_team, id: 1, name: 'team 1', parent_id: assignment.id, users: [user, user2]) }
let(:team2) { create(:assignment_team, id: 2, name: 'team 2', parent_id: assignment2.id, users: [user3]) }
let(:team_user) { create(:team_user, id: 3, team_id: team.id, user_id: user.id) }
let(:team_user2) { create(:team_user, id: 4, team_id: team.id, user_id: user2.id) }
let(:team2_user3) { create(:team_user, id: 5, team_id: team2.id, user_id: user3.id) }
let(:course_team) { create(:course_team, id: 3, name: 'course team 1', parent_id: course.id) }
let(:cource_team_user) { create(:team_user, id: 6, team_id: course_team.id, user_id: user.id) }
let(:cource_team_user2) { create(:team_user, id: 7, team_id: course_team.id, user_id: user2.id) }
let(:topic) { build(:topic) }
let(:topic2) { create(:topic, topic_name: "TestReview") }
let(:due_date) { build(:assignment_due_date, deadline_type_id: 1) }
let(:deadline_type) { build(:deadline_type, id: 1) }
let(:review_response_map) { build(:review_response_map, assignment: assignment, reviewer: participant, reviewee: team2) }
let(:metareview_response_map) { build(:meta_review_response_map, reviewed_object_id: 1) }
let(:response) { build(:response, id: 1, map_id: 1, response_map: review_response_map) }
let(:response2) { build(:response, id: 2, map_id: 1, response_map: review_response_map) }
let(:submission_record) {build(:submission_record, id:1, team_id: 1, assignment_id: 1) } #added for submission_record method call test.
let(:student_task) do
StudentTask.new(
participant: participant,
assignment: participant.assignment,
topic: participant.topic,
current_stage: participant.current_stage,
stage_deadline: (Time.parse(participant.stage_deadline) rescue Time.now + 1.year)
)
end
</pre>
Below are some of the functions tested
* Function: teamed_students - Write a test case to find teamed up students.
This method is an instance method, having a user passed to it. It return the list of students that the current user has teamed up. It does not consider the teammates that are from calibration assignments
The test cases described check for the following scenarios:
1. When not in any team returns empty
2. When assigned in a cource_team returns empty
3. When assigned in a assignment_team return the list of teammates

<pre>
describe "#teamed_students" do
context 'when not in any team' do
it 'returns empty' do
expect(StudentTask.teamed_students(user3)).to eq({})
end
end
context 'when assigned in a cource_team ' do
it 'returns empty' do
allow(user).to receive(:teams).and_return([course_team])
expect(StudentTask.teamed_students(user)).to eq({})
end
end
context 'when assigned in a assignment_team ' do
it 'returns empty' do
allow(user).to receive(:teams).and_return([team])
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: assignment.id).and_return(participant)
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 5, parent_id: assignment.id).and_return(participant2)
allow(Assignment).to receive(:find_by).with(id: team.parent_id).and_return(assignment)
# allow(Team).to receive(:find).with(team.id).and_return(team)
expect(StudentTask.teamed_students(user)).to eq({assignment.course_id => [user2.fullname]})
end
end
end
</pre>

* Function: get_due_date_data - Write a test case to get the due dates of the assignment.
This method is an instance method, having an assignment and timeline_list list passed to it. The test cases described check for the following scenarios:
1. When an assignment passed to the method has no assignment attributes.
2. When an assignment passed to the method has some attributes but not the attribute due_at
3. When an assignment passed to the method has some attributes along with due_at

due_at attribute is checked, upon which the timeline_list is populated with the updated_at and label values.
<pre>
describe "#get_due_date_data" do
context 'when called with assignment having empty due dates' do
it "return empty time_list array" do
timeline_list = []
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when called with assignment having due date' do
context 'and due_at value nil' do
it "return empty time_list array" do
allow(due_date).to receive(:deadline_type).and_return(deadline_type)
timeline_list = []
due_date.due_at=nil;
assignment.due_dates = [due_date]
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([])
end
end
context 'and due_at value not nil' do
it "return time_list array" do
allow(due_date).to receive(:deadline_type).and_return(deadline_type)
timeline_list = []
assignment.due_dates = [due_date]
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([{
:label=>(due_date.deadline_type.name + ' Deadline').humanize,
:updated_at=>due_date.due_at.strftime('%a, %d %b %Y %H:%M')
}])
end
end
end
end
</pre>

* Function: get_peer_review_data - Write a test case to get the peer review data.
This method is an instance method, having an review and timeline_list list passed to it. The test cases described check for the following scenarios:
1. When no review response is mapped.
2. When review response is mapped.

<pre>
describe "#get_peer_review_data" do
context 'when no review response mapped' do
it 'returns empty' do
timeline_list=[]
StudentTask.get_peer_review_data(user2,timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when mapped to review response map' do
it 'returns timeline array' do
timeline_list=[]
allow(ReviewResponseMap).to receive_message_chain(:where, :find_each).with(reviewer_id: 1).with(no_args).and_yield(review_response_map)
allow(review_response_map).to receive(:id).and_return(1)
allow(Response).to receive_message_chain(:where, :last).with(map_id: 1).with(no_args).and_return(response)
allow(response).to receive(:round).and_return(1)
allow(response).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_peer_review_data(1,timeline_list)).to eq([{:id=>1, :label=>"Round 1 peer review", :updated_at=>timevalue}])
end
end
end
</pre>

* Function: get_author_feedback_data - Write a test case to get the feedback response
This method is an instance method, having feedback and timeline_list list passed to it. The test cases described check for the following scenarios:
1. when no feedback response is mapped.
2. when feedback response is mapped.

<pre>
describe "#get_author_feedback_data" do
context 'when no feedback response mapped' do
it 'returns empty' do
timeline_list=[]
StudentTask.get_author_feedback_data(user2,timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when mapped to feedback response map' do
it 'returns timeline array' do
timeline_list=[]
allow(FeedbackResponseMap).to receive_message_chain(:where, :find_each).with(reviewer_id: 1).with(no_args).and_yield(review_response_map)
allow(review_response_map).to receive(:id).and_return(1)
allow(Response).to receive_message_chain(:where, :last).with(map_id: 1).with(no_args).and_return(response)
allow(response).to receive(:updated_at).and_return(Time.now)
timevalue = Time.now.strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_author_feedback_data(1,timeline_list)).to eq([{:id=>1, :label=>"Author feedback", :updated_at=>timevalue}])
end
end
end
</pre>

* Function: get_submission_data - Write a test case to import participants
This method is an instance method, having a submission and timeline_list list passed to it. The test cases described check for the following scenarios:
1. When no submission data is mapped.
2. When submission data is mapped and hyperlink is not submitted or hyperlink is removed.
3. When submission data is mapped and operation is submit_hyperlink.
4. When submission data mapped and operation is Remove Hyperlink.
<pre>
describe '#get_submission_data' do
context 'when no submission data mapped' do
it 'returns nil' do
timeline_list=[]
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq(nil)
end
end
context 'when submission data mapped and not submit hyperlink or Remove hyperlink' do
it 'returns timeline_list' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('testing_label')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Testing label", :updated_at=>timevalue}])
end
end
context 'when submission data mapped and operation is submit_hyperlink' do
it 'returns timeline_list with link' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('Submit Hyperlink')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Submit hyperlink", :updated_at=>timevalue, :link=>"www.wolfware.edu"}])
end
end
context 'when submission data mapped and operation is Remove Hyperlink' do
it 'returns timeline_list with link' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('Remove Hyperlink')
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Remove hyperlink", :updated_at=>timevalue, :link=>"www.wolfware.edu"}])
end
end
end
</pre>

=== Team ===

Carmen Bentley,Mentor

* Tushar Kundra,tkundra

* Ram Chavali,ramlohith

* Ayushi Rungta,Rungta1001

=== Running Tests ===

What we need to do is to set up the environment and complete the 'student_task.rb' and 'student_task_spec.rb' to increase the path coverage from only 43.0% with 43 lines covered and 57 lines missed to above 90%.

You can run RSpec tests by executing the command:

<pre>

rspec spec/models/student_task_spec.rb

</pre>

After that, you can see the detailed coverage information by opening this file in your Expertiza folder.

<pre>

coverage/index.html

</pre>

====Our work====
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1549 Pull request]
*[https://drive.google.com/file/d/1O-1k3mqo1yRMp0yxgTIuM3P5cegB5DCy/view?usp=sharing Video of tests running]

Test Coverage: [http://wiki.expertiza.ncsu.edu/images/b/b0/E1955before.png Initial] [http://wiki.expertiza.ncsu.edu/images/0/05/E1955after.png Final]

== Running the Project Locally ==
The project could be run locally by cloning the Github repository [https://github.com/tusharkundra/expertiza Expertiza] and then running the following commands sequentially.

<pre>

bundle install
rake db:create:all
rake db:migrate
rails s

</pre>

== Issues/Erros During Testing ==
* While creating the test for "reviews_given?", given below, it seems the function is returning string value instead of boolean value as "j.class.to_s[/Review/]" gives a string when the class of "j" starts with "Review"

<pre>
def reviews_given?
response_maps.inject(nil) {|i, j| i || (j.response && j.class.to_s[/Review/]) }
end
</pre>

CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student task.rb

2019-11-08T00:29:08Z

Arungta: /* Test Plan */

This page provides a description of the Expertiza based OSS project.

== About Expertiza ==

[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ 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.

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

== About RSpec ==

RSpec is a unit test framework for the Ruby programming language. RSpec is different than traditional xUnit frameworks like JUnit because RSpec is a Behavior driven development tool. What this means is that, tests written in RSpec focus on the "behavior" of an application being tested. RSpec does not put emphasis on, how the application works but instead on how it behaves, in other words, what the application actually does.Each RSpec file contains one or more tests. Each test ensures if a particular feature of our website is working properly.The output of an RSpec run will tell you exactly what features aren't working. The benefit is that tested code is unlikely to break unnoticed.The tests are run every time someone makes, or updates, a [https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests Pull Request].

== DB Schema ==
Below are the tables that are related ti student task functionality
[http://wiki.expertiza.ncsu.edu/images/7/7a/ExpertizaDbSchema.jpg DB Schema]

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the student_task.rb and student_task_spec.rb. It focuses on writing RSpec unit tests for the code affected or added. The goal of this project is to attempt to add sufficient unit tests to this part of the application and increase its path coverage to above 90 percent.
The following tasks were accomplished in this project:

* Complete the insufficient unit tests for student_task.rb.
* Increase path coverage from only 31.91% with 30 lines covered to above 92.55% with 87 lines covered.
* Cover edge cases.
* High branch coverage to be achieved.

There are different tasks that a student can perform.
* He can see all the assignments that he has been assigned to.
* He can see details of each assignment like marks, his team, send invitation to student to join a team
* Review other students' work

[http://wiki.expertiza.ncsu.edu/images/4/4c/StudentTaskHomePage.png Student Task Home Page]

[http://wiki.expertiza.ncsu.edu/images/4/4d/StudentTaskAssignmentTasks.png Assignment Submission Tasks]

The following functions were tested:

* complete?
This function returns true if the participant stage deadline is "complete" or else return false.
* content_submitted_in_current_stage?
This function returns true if the participant has submitted hyperlinks in the current stage and the stage is in "submission"
* hyperlinks
This function returns all the hyperlinks submitted by the participant team
* in_work_stage?
A assignment is said to be in work stage if its stage is any of "submission", "review" or "metareview"
* incomplete?
This function returns true if the participant stage deadline is not "complete" or else return false.
* metareviews_given? * reviews_given?
A participant can review other people's work and add comments.
Also a user can review a review, called "metareview" that is given to him.
A review comment is mapped to assignments or other reviews by the table response_tags via the reviewed_object_id.
This method checks if the participant has given any metareview and return true otherwise.
* metareviews_given_in_current_stage?
This function checks if the assignment is in "metareview" stage and metareviews.
* not_started?
This function checks if the assignment is in any of "submission", "review" or "metareview" stage
* relative_deadline
* reviews_given_in_current_stage?
* revision?
* from_participant(participant)
This function return the StudentTask from the participant with assignment, topic, current_stage
* from_participant_id(id)
This function return the StudentTask from the participant with assignment, topic, current_stage using the participant id
* from_user(user)
* get_author_feedback_data(participant_id, timeline_list)
* get_due_date_data(assignment, timeline_list)
* get_peer_review_data(participant_id, timeline_list)
* get_submission_data(assignment_id, team_id, timeline_list)
* get_timeline_data(assignment, participant, team)
* teamed_students(user, ip_address = nil)
This function return the list of all the students that the logged on user has teamed up until now.
* started?
Checks if the current stage is "incomplete" and content_submitted_in_current_stage? reviews_given_in_current_stage? || metareviews_given_in_current_stage? and return true and false
* topic_name
Return the name of the topic

== Test Plan ==

* Mock Objects
The following mock objects were created/built before the commencement of automated testing for student_task.rb (model) code.
<pre>
let(:participant) { build(:participant, id: 1, user_id: user.id, parent_id: assignment.id) }
let(:participant2) { build(:participant, id: 2, user_id: user2.id, parent_id: assignment.id) }
let(:participant3) { build(:participant, id: 3, user_id: user3.id, parent_id: assignment2.id) }
let(:user) { create(:student) }
let(:user2) { create(:student, name: "qwertyui", id: 5) }
let(:user3) { create(:student, name: "qwertyui1234", id: 6) }
let(:course) { build(:course) }
let(:assignment) { build(:assignment, name: 'assignment 1') }
let(:assignment2) { create(:assignment, name: 'assignment 2', is_calibrated: true) }
let(:team) { create(:assignment_team, id: 1, name: 'team 1', parent_id: assignment.id, users: [user, user2]) }
let(:team2) { create(:assignment_team, id: 2, name: 'team 2', parent_id: assignment2.id, users: [user3]) }
let(:team_user) { create(:team_user, id: 3, team_id: team.id, user_id: user.id) }
let(:team_user2) { create(:team_user, id: 4, team_id: team.id, user_id: user2.id) }
let(:team2_user3) { create(:team_user, id: 5, team_id: team2.id, user_id: user3.id) }
let(:course_team) { create(:course_team, id: 3, name: 'course team 1', parent_id: course.id) }
let(:cource_team_user) { create(:team_user, id: 6, team_id: course_team.id, user_id: user.id) }
let(:cource_team_user2) { create(:team_user, id: 7, team_id: course_team.id, user_id: user2.id) }
let(:topic) { build(:topic) }
let(:topic2) { create(:topic, topic_name: "TestReview") }
let(:due_date) { build(:assignment_due_date, deadline_type_id: 1) }
let(:deadline_type) { build(:deadline_type, id: 1) }
let(:review_response_map) { build(:review_response_map, assignment: assignment, reviewer: participant, reviewee: team2) }
let(:metareview_response_map) { build(:meta_review_response_map, reviewed_object_id: 1) }
let(:response) { build(:response, id: 1, map_id: 1, response_map: review_response_map) }
let(:response2) { build(:response, id: 2, map_id: 1, response_map: review_response_map) }
let(:submission_record) {build(:submission_record, id:1, team_id: 1, assignment_id: 1) } #added for submission_record method call test.
let(:student_task) do
StudentTask.new(
participant: participant,
assignment: participant.assignment,
topic: participant.topic,
current_stage: participant.current_stage,
stage_deadline: (Time.parse(participant.stage_deadline) rescue Time.now + 1.year)
)
end
</pre>
Below are some of the functions tested
* Function: teamed_students - Write a test case to find teamed up students.
This method is an instance method, having a user passed to it. It return the list of students that the current user has teamed up. It does not consider the teammates that are from calibration assignments
The test cases described check for the following scenarios:
1. When not in any team returns empty
2. When assigned in a cource_team returns empty
3. When assigned in a assignment_team return the list of teammates

<pre>
describe "#teamed_students" do
context 'when not in any team' do
it 'returns empty' do
expect(StudentTask.teamed_students(user3)).to eq({})
end
end
context 'when assigned in a cource_team ' do
it 'returns empty' do
allow(user).to receive(:teams).and_return([course_team])
expect(StudentTask.teamed_students(user)).to eq({})
end
end
context 'when assigned in a assignment_team ' do
it 'returns empty' do
allow(user).to receive(:teams).and_return([team])
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: assignment.id).and_return(participant)
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 5, parent_id: assignment.id).and_return(participant2)
allow(Assignment).to receive(:find_by).with(id: team.parent_id).and_return(assignment)
# allow(Team).to receive(:find).with(team.id).and_return(team)
expect(StudentTask.teamed_students(user)).to eq({assignment.course_id => [user2.fullname]})
end
end
end
</pre>

* Function: get_due_date_data - Write a test case to get the due dates of the assignment.
This method is an instance method, having an assignment and timeline_list list passed to it. The test cases described check for the following scenarios:
1. When an assignment passed to the method has no assignment attributes.
2. When an assignment passed to the method has some attributes but not the attribute due_at
3. When an assignment passed to the method has some attributes along with due_at

due_at attribute is checked, upon which the timeline_list is populated with the updated_at and label values.
<pre>
describe "#get_due_date_data" do
context 'when called with assignment having empty due dates' do
it "return empty time_list array" do
timeline_list = []
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when called with assignment having due date' do
context 'and due_at value nil' do
it "return empty time_list array" do
allow(due_date).to receive(:deadline_type).and_return(deadline_type)
timeline_list = []
due_date.due_at=nil;
assignment.due_dates = [due_date]
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([])
end
end
context 'and due_at value not nil' do
it "return time_list array" do
allow(due_date).to receive(:deadline_type).and_return(deadline_type)
timeline_list = []
assignment.due_dates = [due_date]
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([{
:label=>(due_date.deadline_type.name + ' Deadline').humanize,
:updated_at=>due_date.due_at.strftime('%a, %d %b %Y %H:%M')
}])
end
end
end
end
</pre>

* Function: get_peer_review_data - Write a test case to get the peer review data.
This method is an instance method, having an review and timeline_list list passed to it. The test cases described check for the following scenarios:
1. When no review response is mapped.
2. When review response is mapped.

<pre>
describe "#get_peer_review_data" do
context 'when no review response mapped' do
it 'returns empty' do
timeline_list=[]
StudentTask.get_peer_review_data(user2,timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when mapped to review response map' do
it 'returns timeline array' do
timeline_list=[]
allow(ReviewResponseMap).to receive_message_chain(:where, :find_each).with(reviewer_id: 1).with(no_args).and_yield(review_response_map)
allow(review_response_map).to receive(:id).and_return(1)
allow(Response).to receive_message_chain(:where, :last).with(map_id: 1).with(no_args).and_return(response)
allow(response).to receive(:round).and_return(1)
allow(response).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_peer_review_data(1,timeline_list)).to eq([{:id=>1, :label=>"Round 1 peer review", :updated_at=>timevalue}])
end
end
end
</pre>

* Function: get_author_feedback_data - Write a test case to get the feedback response

<pre>
describe "#get_author_feedback_data" do
context 'when no feedback response mapped' do
it 'returns empty' do
timeline_list=[]
StudentTask.get_author_feedback_data(user2,timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when mapped to feedback response map' do
it 'returns timeline array' do
timeline_list=[]
allow(FeedbackResponseMap).to receive_message_chain(:where, :find_each).with(reviewer_id: 1).with(no_args).and_yield(review_response_map)
allow(review_response_map).to receive(:id).and_return(1)
allow(Response).to receive_message_chain(:where, :last).with(map_id: 1).with(no_args).and_return(response)
allow(response).to receive(:updated_at).and_return(Time.now)
timevalue = Time.now.strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_author_feedback_data(1,timeline_list)).to eq([{:id=>1, :label=>"Author feedback", :updated_at=>timevalue}])
end
end
end
</pre>

* Function: get_submission_data - Write a test case to import participants
<pre>
describe '#get_submission_data' do
context 'when no submission data mapped' do
it 'returns nil' do
timeline_list=[]
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq(nil)
end
end
context 'when submission data mapped and not submit hyperlink or Remove hyperlink' do
it 'returns timeline_list' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('testing_label')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Testing label", :updated_at=>timevalue}])
end
end
context 'when submission data mapped and operation is submit_hyperlink' do
it 'returns timeline_list with link' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('Submit Hyperlink')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Submit hyperlink", :updated_at=>timevalue, :link=>"www.wolfware.edu"}])
end
end
context 'when submission data mapped and operation is Remove Hyperlink' do
it 'returns timeline_list with link' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('Remove Hyperlink')
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Remove hyperlink", :updated_at=>timevalue, :link=>"www.wolfware.edu"}])
end
end
end
</pre>

=== Team ===

Carmen Bentley,Mentor

* Tushar Kundra,tkundra

* Ram Chavali,ramlohith

* Ayushi Rungta,Rungta1001

=== Running Tests ===

What we need to do is to set up the environment and complete the 'student_task.rb' and 'student_task_spec.rb' to increase the path coverage from only 43.0% with 43 lines covered and 57 lines missed to above 90%.

You can run RSpec tests by executing the command:

<pre>

rspec spec/models/student_task_spec.rb

</pre>

After that, you can see the detailed coverage information by opening this file in your Expertiza folder.

<pre>

coverage/index.html

</pre>

====Our work====
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1549 Pull request]
*[https://drive.google.com/file/d/1O-1k3mqo1yRMp0yxgTIuM3P5cegB5DCy/view?usp=sharing Video of tests running]

Test Coverage: [http://wiki.expertiza.ncsu.edu/images/b/b0/E1955before.png Initial] [http://wiki.expertiza.ncsu.edu/images/0/05/E1955after.png Final]

== Running the Project Locally ==
The project could be run locally by cloning the Github repository [https://github.com/tusharkundra/expertiza Expertiza] and then running the following commands sequentially.

<pre>

bundle install
rake db:create:all
rake db:migrate
rails s

</pre>

== Issues/Erros During Testing ==
* While creating the test for "reviews_given?", given below, it seems the function is returning string value instead of boolean value as "j.class.to_s[/Review/]" gives a string when the class of "j" starts with "Review"

<pre>
def reviews_given?
response_maps.inject(nil) {|i, j| i || (j.response && j.class.to_s[/Review/]) }
end
</pre>

CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student task.rb

2019-10-24T04:59:53Z

Arungta:

CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student task.rb

2019-10-24T04:55:38Z

Arungta:

CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student task.rb

2019-10-24T04:37:44Z

Arungta:

CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student task.rb

2019-10-24T04:35:33Z

Arungta:

CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student task.rb

2019-10-24T04:34:35Z

Arungta:

CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student task.rb

2019-10-24T04:24:12Z

Arungta: Created page with "This page provides a description of the Expertiza based OSS project. == About Expertiza == [https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://..."

CSC/ECE 517 Fall 2019

2019-10-24T03:03:36Z

Arungta:

* [[CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz_questionnaire_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews]]
* [[CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics]]
* [[CSC/ECE 517 Fall 2019 - E1961. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2019 - E1971. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student_task.rb]]