Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-11T22:40:06Z

Zma24: /* Project Scope */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 1.jpg|1200px]]

* '''Issue 2''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 2.jpg|1200px]]

* '''Issue 3''' - After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
[[File:Issue 3.png|1200px]]

* '''Issue 4''' - There is also no indication of this penalty policy for students, and no proof it actually works
[[File:Issue 4.png|1200px]]

* '''Issue 5''' - No Botton navigating to the list of all late policies
[[File:Issue 5.jpg|1200px]]

* '''Issue 6''' - When creating/editing an assignment, you can’t see the detail of each late policy
[[File:Issue 6.png|1200px]]

* '''Issue 7''' - Adding test cases to check the late policy applied actually works to subtract points from the students.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:517_Final_flow_chart.drawio.png|600px]]

=== Files to be refactored ===

* '''Issue 1'''
Check how to store assignment information into session and fix it. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 2'''
Store assignment information in session through the creation of late policies. 
1. app/views/late_policies/new.html.erb 
2. app/views/assignments/edit/_due_dates.html.erb 
3. app/controllers/assignments_controller.rb 

* '''Issue 3'''
Save late policy information of this assignment into database. 
1. app/views/assignments/edit/_due_dates.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 4'''
Show late policy of current assignment on student view page. 
1. app/views/student_task/view.html.erb 
2. app/controllers/student_task_controller.rb 

* '''Issue 5'''
Create buttons link to all late policies on both main page and assigment view page. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 6'''
A button link to all late policies on assignment/new page to show all policies. 
1. app/views/assignments/edit/_late_policy.html.erb 
2. app/controllers/assignments_controller.rb 

* '''Issue 7'''
Fix the late policy function to make it work. 
1. app/controllers/late_policies_controller.rb 
2. app/controllers/assignments_controller.rb 

== Testing ==
=== Testing Goals and Test Objects ===

#When logging in as a student:
##You can see the late policy details of your assignments
##The late policy works correctly if you submit your assignment late
#When logging in as an instructor:
##There is a button to navigate you to the page showing all the late policies
##You can see the details of the late policy when creating or editing an assignment
##The "back" button will lead to a correct webpage when creating or editing an assignment
##The "Apply penalty policy" box is saved after submitting the form when creating or editing an assignment

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Student Waitlist
<pre>
Scenario: Getting added to the waitlist for a topic
Given: Logged in as a Student
When: The topic for an assignment has no available slots
And: Student tries to signup for a topic
Then: The team that the student is a part of should be added to the waitlist for the topic.
</pre>
<pre>
Scenario: Getting enrolled in a topic
Given: Logged in as a Student
When: The topic for an assignment has available slots
And: Student tries to signup for a topic
Then: The team that the student is a part of should be enrolled for the topic.
</pre>
<pre>
Scenario: All waitlisted topics getting dropped
Given: Logged in as a Student
When: Student gets enrolled into a course for which he was waitlisted before.
Then: The team that the student is a part of should be dropped from the remaining waitlisted topics.
</pre>
<pre>
Scenario: All waitlisted teams getting dropped
Given: Logged in as a Student
When: The deadline for a topic passes.
Then: All the waitlisted teams for that particular topic must be dropped.
</pre>
<pre>
Scenario: Getting enrolled in a topic
Given: Logged in as a Student
When: The enrolled team for a topic drops
Then: The team that was waitlisted earlier for the topics must be enrolled.
</pre>

=== Regression Testing ===
''In order to ensure complete coverage, testing of the changes done between the end of last semester and this project will be done to ensure that ''
''old test cases still pass.''

# Make sure all existing waitlist functionality still passes

==Project Mentors==
* Nicholas Himes

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2236===
#[https://github.com/517-E2236/expertiza/tree/beta GitHub Repository]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-11T22:19:23Z

Zma24: Undo revision 144718 by Zma24 (talk)

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-11T22:19:03Z

Zma24: /* Project Scope */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 1.jpg|1200px]]

* '''Issue 2''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue 2.jpg|1200px]]

* '''Issue 3''' - After checking the "Apply penalty policy" box and clicking the 'save' or 'create' button on the Due dates tab, the box is unchecked on page refresh.
[[File:Issue 3.png|1200px]]

* '''Issue 4''' - There is also no indication of this penalty policy for students, and no proof it actually works
[[File:Issue 4.png|1200px]]

* '''Issue 5''' - No Botton navigating to the list of all late policies
[[File:Issue 5.jpg|1200px]]

* '''Issue 6''' - When creating/editing an assignment, you can’t see the detail of each late policy
[[File:Issue 6.png|1200px]]

* '''Issue 7''' - Adding test cases to check the late policy applied actually works to subtract points from the students.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:517_Final_flow_chart.drawio.png|600px]]

=== Files and methods to be refactored ===

#Issue 1
We need to check how to store assignment information into session and fix it.
##app/views/late_policies/new.html.erb
##app/views/assignments/edit/_due_dates.html.erb
##app/controllers/assignments_controller.rb

#Issue 2
##app/views/late_policies/new.html.erb
##app/views/assignments/edit/_due_dates.html.erb
##app/controllers/assignments_controller.rb
We need to check how to store assignment information into session and fix it.

#sign_up_sheet_controller.rb
##switch_original_topic_to_approved_suggested_topic
###Change usage of is_waitlisted attribute in the signed_up_teams table to use the new table
###Add additional checks and transactions to make sure perform operations in an atomic way in case of failures.
#sign_up_sheet.rb
##cancel_all_wailists (typo in code) - This method currently does 2 things, it cancels waitlist and also updates the signed_up_team topic which needs to be split
##create_SignUpTeam
###It checks if topic has slots if yes it adds to signed up team, else creates a signup as waitlist
###This method should use the new table and call the helper functions of waitlist to perform actions on waitlists
#sign_up_topic.rb
##users_on_waiting_list - Move method to fetch all users on waitlist for a topic to waitlist_teams method.
##assign_to_first_waiting_team - The same functionality is being called in multiple places, it should be made DRY and moved to the waitlist_teams model
##reassign_topic - Use methods that perform actions on waitlist that should be moved to waitlist_helper, also use transactions to make it atomic.
##update_waitlisted_users - Move method to waitlist_teams model and use the new table
##find_slots_waitlisted - Move method to waitlist_teams model
##find_waitlisted_topics - Move method to waitlist_teams model
#suggestion_controller.rb
##notification
##Clean waitlist functionality should be moved to a method in waitlist_teams model. team id should be passed as a parameter to delete the waitlist for that team.
#invitation.rb
##remove_waitlists_for_team
###Removing from waitlist and adding to team to sign up should be as a single transaction
###There should be additional checks to make sure that there is enough space left before adding team to signed_up_sheet
###All functionality should be moved to waitlist_helper and implemented in a robust and dry manner

== Testing ==
=== Testing Goals and Test Objects ===

#When logging in as a student:
##You can see the late policy details of your assignments
##The late policy works correctly if you submit your assignment late
#When logging in as an instructor:
##There is a button to navigate you to the page showing all the late policies
##You can see the details of the late policy when creating or editing an assignment
##The "back" button will lead to a correct webpage when creating or editing an assignment
##The "Apply penalty policy" box is saved after submitting the form when creating or editing an assignment

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Student Waitlist
<pre>
Scenario: Getting added to the waitlist for a topic
Given: Logged in as a Student
When: The topic for an assignment has no available slots
And: Student tries to signup for a topic
Then: The team that the student is a part of should be added to the waitlist for the topic.
</pre>
<pre>
Scenario: Getting enrolled in a topic
Given: Logged in as a Student
When: The topic for an assignment has available slots
And: Student tries to signup for a topic
Then: The team that the student is a part of should be enrolled for the topic.
</pre>
<pre>
Scenario: All waitlisted topics getting dropped
Given: Logged in as a Student
When: Student gets enrolled into a course for which he was waitlisted before.
Then: The team that the student is a part of should be dropped from the remaining waitlisted topics.
</pre>
<pre>
Scenario: All waitlisted teams getting dropped
Given: Logged in as a Student
When: The deadline for a topic passes.
Then: All the waitlisted teams for that particular topic must be dropped.
</pre>
<pre>
Scenario: Getting enrolled in a topic
Given: Logged in as a Student
When: The enrolled team for a topic drops
Then: The team that was waitlisted earlier for the topics must be enrolled.
</pre>

=== Regression Testing ===
''In order to ensure complete coverage, testing of the changes done between the end of last semester and this project will be done to ensure that ''
''old test cases still pass.''

# Make sure all existing waitlist functionality still passes

==Project Mentors==
* Nicholas Himes

==Team Members==
* Zhiyuan Ma

* Gaolin Zhang

* Zhijin Yang

* Yuyang Jiang

==Useful Links==
===E2236===
#[https://github.com/517-E2236/expertiza/tree/beta GitHub Repository]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T01:55:13Z

Zma24: /* Project Scope */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T01:53:15Z

Zma24: /* Project Scope */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T01:00:29Z

Zma24: /* E2236 */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T00:58:44Z

Zma24: /* E2236 */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T00:54:25Z

Zma24: /* Problem Description */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T00:51:45Z

Zma24: /* Problem Description */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T00:46:46Z

Zma24: /* Issues with the Current Implementation */

CSC/ECE 517 Spring 2022 - E2236: Fix issues related to deadlines and late policies

2022-04-05T00:39:53Z

Zma24: /* Problem Description */

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:45:17Z

Zma24: /* Links */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do
expect(controller.send(:action_allowed?)).to be false
end
it 'for student' do
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
Here is the link for the screenshots of the coverage:

[https://i.imgur.com/IYDSPU3.png Versions Controller Test Coverage]

[https://i.imgur.com/IwDWIcy.png Participants Controller Test Coverage]

=== Links ===
[https://github.com/expertiza/expertiza/pull/2289 The pull request]

[https://github.com/jiangyy12/expertiza/tree/beta The forked git repository ]

[https://drive.google.com/file/d/1X5AS8-cETX-60j6qzIovXsKADGMZiBtu/view?usp=sharing Test video ]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:44:27Z

Zma24: /* Links */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do
expect(controller.send(:action_allowed?)).to be false
end
it 'for student' do
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
Here is the link for the screenshots of the coverage:

[https://i.imgur.com/IYDSPU3.png Versions Controller Test Coverage]

[https://i.imgur.com/IwDWIcy.png Participants Controller Test Coverage]

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

Test video [https://drive.google.com/file/d/1X5AS8-cETX-60j6qzIovXsKADGMZiBtu/view?usp=sharing]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:29:07Z

Zma24: /* Conclusion */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do
expect(controller.send(:action_allowed?)).to be false
end
it 'for student' do
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
Here is the link for the screenshots of the coverage:

[https://i.imgur.com/IYDSPU3.png Versions Controller Test Coverage]

[https://i.imgur.com/IwDWIcy.png Participants Controller Test Coverage]

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:22:58Z

Zma24: /* Conclusion */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do
expect(controller.send(:action_allowed?)).to be false
end
it 'for student' do
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
[https://i.imgur.com/IYDSPU3.png Versions Controller Test Coverage]

[https://i.imgur.com/IwDWIcy.png Participants Controller Test Coverage]

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:22:51Z

Zma24: /* Conclusion */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do
expect(controller.send(:action_allowed?)).to be false
end
it 'for student' do
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
[https://i.imgur.com/IYDSPU3.png Versions Controller Test Coverage]
[https://i.imgur.com/IwDWIcy.png Participants Controller Test Coverage]

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:22:34Z

Zma24: /* Conclusion */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do
expect(controller.send(:action_allowed?)).to be false
end
it 'for student' do
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
[https://i.imgur.com/IYDSPU3.png Versions Controller Test Coverage]
[https://i.imgur.com/IwDWIcy.png Participants Controller Test Coverage]

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:21:08Z

Zma24: /* Conclusion */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do
expect(controller.send(:action_allowed?)).to be false
end
it 'for student' do
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
[https://i.imgur.com/IYDSPU3.png Versions controller test coverage]

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:20:04Z

Zma24: /* Conclusion */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do
expect(controller.send(:action_allowed?)).to be false
end
it 'for student' do
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
[https://i.imgur.com/IYDSPU3.png versions controller test coverage]

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:19:44Z

Zma24: /* Conclusion */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do
expect(controller.send(:action_allowed?)).to be false
end
it 'for student' do
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
[https://i.imgur.com/IYDSPU3.png]

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:19:10Z

Zma24: /* Conclusion */

== About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is the software benefits for both instructors and students by supporting various types of submissions and providing reusable objects for peer review. It is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It allows the instructors not only to create and customize new or existing assignments but also to create a list of topics the students can sign up for. Students can form teams to work on various projects and assignments. Expertiza also lets students peer-review other students' submissions, enabling them to work together to improve others' learning experiences.

== Description about project ==
This page is a description of Expertiza OSS project E2205 which is testing for participants_controller and versions_controller

=== Files Involved ===
* participants_controller_spec.rb
* versions_controller_spec.rb

=== Running Tests ===
<pre>
rspec ./spec/controllers/participants_controller_spec.rb
rspec ./spec/controllers/versions_controller_spec.rb
</pre>

=== Requirement ===

In participants controller had some methods not tested, also some edge cases not included in the previous test work. And There were no tests for the versions controller. Our aim is to test all the methods in these two controllers and try to cover more edge cases when testing.

=== Analysis ===

==== Test for Participants Controller====
1. controller_locale - This is to test the function 'controller_locale' which is to search the courses' locale of current user.
<pre>
describe '#controller_locale' do
it 'should return I18n.default_locale' do
user = student
stub_current_user(user, user.role.name, user.role)
expect(controller.send(:controller_locale)).to eq(I18n.default_locale)
end
end
</pre>

2. update_authorizations
<pre>
describe '#update_authorizations' do
it 'updates the authorizations for the participant' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(response).to redirect_to('/participants/list?id=1&model=Assignment')
end
it 'updates the authorizations fails' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'participant', id: 1 }
session = { user: student }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'A student is not allowed to update_authorizations this/these participants'
expect(response).to redirect_to('/')
end
end
</pre>

3. change_handle
<pre>
describe '#change_handle' do
it 'changes the handle of the participant' do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
params = { id: 1, participant: { handle: 'new_handle' } }
session = { user: student1 }
xhr :get, :change_handle, params, session
expect(response).to have_http_status(200)
end
end
</pre>

4. view_copyright_grants
<pre>
describe '#view_copyright_grants' do
it 'renders the copyright_grants template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
params = { id: 1 }
session = { user: instructor }
get :view_copyright_grants, params, session
expect(response).to render_template('view_copyright_grants')
end
end
</pre>

5. validate_authorizations
<pre>
describe '#validate_authorizations' do
# Test case for successful update of participant to reviewer, expects the success flash message after role is updated.
it 'updates the authorizations for the participant to make them reviewer' do
allow(Participant).to receive(:find).with('1').and_return(participant)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:success]).to eq 'The role of the selected participants has been successfully updated.'
expect(participant.can_review).to eq(true)
expect(participant.can_submit).to eq(false)
expect(participant.can_take_quiz).to eq(false)
end

# Test for case where we expect to encounter an error in update_attributes method
it ' throws an exception while validating authorizations' do
allow(Participant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:update_attributes).and_raise(StandardError)
params = { authorization: 'reviewer', id: 1 }
session = { user: instructor }
get :update_authorizations, params, session
expect(flash[:error]).to eq 'The update action failed.'
end
end
</pre>

6. get_user_info
<pre>
describe '#get_user_info' do
it 'gives the user information from the the team user' do
allow(assignment).to receive(:participants).and_return([participant])
allow(participant).to receive(:permission_granted?).and_return(true)
allow(participant).to receive(:user).and_return(student)
allow(student).to receive(:name).and_return('name')
allow(student).to receive(:fullname).and_return('fullname')
pc = ParticipantsController.new
expect(pc.send(:get_user_info, student, assignment)).to eq(name: 'name', fullname: 'fullname', pub_rights: 'Granted', verified: false)
end
end
</pre>

7. get_signup_topics_for_assignment
<pre>
describe '#get_signup_topics_for_assignment' do
it 'gives the signup topics for assignment' do
pc = ParticipantsController.new
expect(pc.send(:get_signup_topics_for_assignment, topic.assignment.id, topic, signed_up_team.team_id)).to eq(true)
end
end
</pre>

==== Test for Versions Controller====
1. action_allowed? - This is the first method that would be called when a user is accessing the version controller. This method ensures that only the users with admin privileges can assess the features.
<pre>
describe '#action_allowed?' do
context 'when user does not have right privilege, it denies action' do
it 'for no user' do
expect(controller.send(:action_allowed?)).to be false
end
it 'for student' do
allow(controller).to receive(:current_user).and_return(build(:student))
expect(controller.send(:action_allowed?)).to be false
end
it 'for instructor' do
stub_current_user(instructor, instructor.role.name, instructor.role)
expect(controller.send(:action_allowed?)).to be false
end
end
context 'when user has right privilege, it allows action' do
it 'for admin' do
stub_current_user(admin, admin.role.name, admin.role)
expect(controller.send(:action_allowed?)).to be true
end
it 'for super_admin' do
stub_current_user(super_admin, super_admin.role.name, super_admin.role)
expect(controller.send(:action_allowed?)).to be true
end
end
end
</pre>

2. index - This method is to display the versions with given id with 25 records each page
<pre>
describe 'GET /index' do
it 'redirect to search' do
stub_current_user(admin, admin.role.name, admin.role)
get 'index'
expect(response).to redirect_to('/versions/search')
end
end
</pre>

3. show
<pre>
describe 'GET /show' do
it 'render show' do
stub_current_user(admin, admin.role.name, admin.role)
allow(Version).to receive(:find).with('1').and_return(version)
get 'show', id: 1
expect(response).to render_template('show')
end
end
</pre>

4. search - This method is called to search the versions records of given user id
<pre>
describe 'GET /search' do
it 'returns http success' do
stub_current_user(admin, admin.role.name, admin.role)
params = { id: 3 }
get 'search', params
expect(response).to be_success
end
it 'should render search template' do
stub_current_user(admin, admin.role.name, admin.role)
get 'search'
expect(response).to render_template('search')
end
end
</pre>

=== Conclusion ===
[[File:P.png]]

=== Links ===

The pull request [https://github.com/expertiza/expertiza/pull/2289]

The forked git repository [https://github.com/jiangyy12/expertiza/tree/beta]

File:P.png

2022-03-22T01:18:26Z

Zma24: Zma24 uploaded a new version of File:P.png

CSC/ECE 517 Spring 2022 - E2205: Testing for participants controller, versions controller

2022-03-22T01:06:36Z