Main Page/CSC/CSC 517 Spring 2020 Refactor impersonate controller - Revision history

Mramani: Added test snips to testing plan

2020-04-01T03:22:20Z

Added test snips to testing plan

← Older revision		Revision as of 03:22, 1 April 2020
Line 226:		Line 226:
	- In the form, give the user ID as "student5890"		- In the form, give the user ID as "student5890"
	Now you will be able to see that user "student5890" has been impersonated.		Now you will be able to see that user "student5890" has been impersonated.
	~~You can now "revert" to the original user to return to the instructor's profile.~~

	2. Input: User that cannot be impersonated		[[File:imp test 1.jpg\| figure 7\| frame\|center]]
			[[File:imp test 2.jpg\| figure 8\| frame\|center]]

			[[File:imp test 4.jpg\| figure 9\| frame\|center]]

			2. Input: Reverting from impersonated account

			We will have the user "student5890" impersonated.
			- Press the blue revert button at the top of the window
			Now you will have returned to the instructor profile

			[[File:imp test 4.jpg\| figure 10\| frame\|center]]
			[[File:imp test 8.jpg\| figure 11\| frame\|center]]

			3. Input: User that cannot be impersonated
	- Login as the instructor (username -> instructor6 , password -> password		- Login as the instructor (username -> instructor6 , password -> password
	- Under "Manage" tab, select "impersonate user" option		- Under "Manage" tab, select "impersonate user" option
	- In the form, give the user ID as "super_administrator2"		- In the form, give the user ID as "super_administrator2"
	Now you will be able to see a message being displayed on the screen, that tells that the given user cannot be impersonated.		Now you will be able to see a message being displayed on the screen, that tells that the given user cannot be impersonated.
			[[File:imp test 6.jpg\| figure 12\| frame\|center]]
			[[File:imp test 5.jpg\| figure 13\| frame\|center]]


	3. Input: User that does not exist		4. Input: User that does not exist
	- Login as the instructor (username -> instructor6 , password -> password		- Login as the instructor (username -> instructor6 , password -> password
	- Under "Manage" tab, select "impersonate user" option		- Under "Manage" tab, select "impersonate user" option
	- In the form, give the user ID as "studentstudent"		- In the form, give the user ID as "studentstudent"
	Now you will be able to see a message being displayed on the screen, that tells that the given user does not exist.		Now you will be able to see a message being displayed on the screen, that tells that the given user does not exist.
			[[File:imp test 7.jpg\| figure 14\| frame\|center]]
			[[File:imp test 3.jpg\| figure 15\| frame\|center]]

Nradhak2: /* Test Plan */

2020-03-31T23:57:10Z

Test Plan

← Older revision		Revision as of 23:57, 31 March 2020
Line 218:		Line 218:

	=== Test Plan ===		=== Test Plan ===
			The project can be tested from the UI as follows.

			Checking if impersonating a user is working
			1. Input: User that can be impersonated
			- Login as the instructor (username -> instructor6 , password -> password
			- Under "Manage" tab, select "impersonate user" option
			- In the form, give the user ID as "student5890"
			Now you will be able to see that user "student5890" has been impersonated.
			You can now "revert" to the original user to return to the instructor's profile.

			2. Input: User that cannot be impersonated
			- Login as the instructor (username -> instructor6 , password -> password
			- Under "Manage" tab, select "impersonate user" option
			- In the form, give the user ID as "super_administrator2"
			Now you will be able to see a message being displayed on the screen, that tells that the given user cannot be impersonated.

			3. Input: User that does not exist
			- Login as the instructor (username -> instructor6 , password -> password
			- Under "Manage" tab, select "impersonate user" option
			- In the form, give the user ID as "studentstudent"
			Now you will be able to see a message being displayed on the screen, that tells that the given user does not exist.

Nradhak2 at 23:07, 31 March 2020

2020-03-31T23:07:02Z

← Older revision		Revision as of 23:07, 31 March 2020
Line 8:		Line 8:

	[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza is a complete instructor-student usage website where the instructor can assign assignments, deadlines, grades, etc that is required for the course. Similarly, the students can use this website to perform the tasks required as part of the course like project or assignments submission, forming groups and collaborating with them, as well as reviewing projects and teammates.		[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza is a complete instructor-student usage website where the instructor can assign assignments, deadlines, grades, etc that is required for the course. Similarly, the students can use this website to perform the tasks required as part of the course like project or assignments submission, forming groups and collaborating with them, as well as reviewing projects and teammates.

			This project focuses on a specific feature of expertiza which allows administrators, instructors or teaching assistants to impersonate another user (like a student) and access their account.
			The demonstration for the feature is as shown below.

	[[File:Impersonate guide.jpg\|figure 1\|frame\|center]]		[[File:Impersonate guide.jpg\|figure 1\|frame\|center]]
Line 17:		Line 20:

	===Problem Statement===		===Problem Statement===
	The aim of the project is to refactor the impersonate controller. The pre-existing code had ~~two~~ major issues.		The aim of the project is to refactor the impersonate controller. The pre-existing code had the following major issues.
	*All functions related to impersonate controller were present in a single method ( from figure 4a and 4b)		*All functions related to impersonate controller were present in a single method ( from figure 4a and 4b)
	*Presence of repetitive code ( from figure 4a and 4b)		*Presence of repetitive code ( from figure 4a and 4b)
Line 26:		Line 29:
	[[File:code climate3.jpg\| figure 5\| frame\|center]]		[[File:code climate3.jpg\| figure 5\| frame\|center]]
	[[File:code climate2.jpg\| figure 6\| frame\|center]]		[[File:code climate2.jpg\| figure 6\| frame\|center]]

			This project is focused on resolving the issues mentioned above.


	===About Impersonate Controller===		===About Impersonate Controller===
	Expertiza allows the administrators, instructors or teaching assistants to impersonate another user (like a student) and access their account. For example, an instructor impersonating a student’s account can view their assignments, stage deadlines, peer reviews and anything else that the student can view. One thing to be noted is that most of these users ~~con~~ only impersonate users for whom they are a parent. For example, instructor6 is a parent of student3841 and not student3836; as a result, instructor6 can impersonate only 3841.		Expertiza allows the administrators, instructors or teaching assistants to impersonate another user (like a student) and access their account. For example, an instructor impersonating a student’s account can view their assignments, stage deadlines, peer reviews and anything else that the student can view.

			One thing to be noted is that most of these users can only impersonate users for whom they are a parent. For example, instructor6 is a parent of student3841 and not student3836; as a result, instructor6 can impersonate only 3841.

	===Impersonate functionality navigation===		===Impersonate functionality navigation===
	1. Instructor login: username -> instructor6, password -> password		1. Instructor login: username -> instructor6, password -> password

	when logged in as an instructor, under the manage option in the ribbon as in Figure 1, select impersonate user. Upon redirected to impersonate page, enter the account which needs to be impersonated. ~~If possible it~~ impersonates that user. Now a new button called revert appears on the ribbon as in figure 3, this can be used to revert the impersonation and return to the instructor profile.		when logged in as an instructor, under the manage option in the ribbon as in Figure 1, select impersonate user.
			Upon redirected to impersonate page, enter the account which needs to be impersonated. It impersonates that user provided that user can be impersonated. Now a new button called revert appears on the ribbon as in figure 3, this can be used to revert the impersonation and return to the instructor profile.

	===Problem Solution===		===Problem Solution===
Line 208:		Line 216:
	end		end
	</pre>		</pre>

	=== Test Plan ===		=== Test Plan ===

Mramani: added code snips and explained the methods

2020-03-31T20:39:29Z

added code snips and explained the methods

@@ Line 39: / Line 39: @@
 The above-mentioned issues have been tackled by refactoring the impersonate controller by splitting into many smaller methods which are later called by the main impersonate controller.
-The following are the refactored new methods that hep in tackling the issue:
+The following are the refactored new methods that help in tackling the issue1 apart from each being specifically for some issue rectification:
 *check_if_user_impersonateable
 *display_error_msg
@@ Line 45: / Line 45: @@
 *check_if_special_char
 *do_main_operartion
 =====check_if_user_impersonateable=====
-This method plays a main role in tackling issue3 - 3 levels of block nesting apart from issue1 which is the recurrent idea behind all of these methods.
+This method plays the main role in tackling issue3 - 3 levels of block nesting apart from issue1.
 <pre>
      def check_if_user_impersonateable
@@ Line 70: / Line 81: @@
 =====display_error_msg=====
 <pre>
      def display_error_msg
@@ Line 93: / Line 105: @@
 </pre>
 =====overwrite_session=====
 <pre>
       def overwrite_session
@@ Line 123: / Line 188: @@
 </pre>
 =====check_if_special_char=====
 <pre>
    def check_if_special_char
@@ Line 132: / Line 198: @@
 </pre>
 =====do_main_operation=====
 <pre>
      def do_main_operation(user)

Mramani at 19:39, 31 March 2020

2020-03-31T19:39:39Z

Show changes

Mramani: added intial code pics and usage guide images

2020-03-31T18:24:47Z

added intial code pics and usage guide images

@@ Line 4: / Line 4: @@
 . Instructor login: username -> instructor6, password -> password
-when logged in as an instructor, under the manage option in the ribbon, select impersonate user. Upon redirected to impersonate page, enter the account which needs to be impersonated. If possible it impersonates that user. Now a new button called revert appears on the ribbon, this can be used to revert the impersonation and return to the instructor profile.
+when logged in as an instructor, under the manage option in the ribbon as in Figure 1, select impersonate user. Upon redirected to impersonate page, enter the account which needs to be impersonated. If possible it impersonates that user. Now a new button called revert appears on the ribbon as in figure 3, this can be used to revert the impersonation and return to the instructor profile.
 ===About Expertiza===
@@ Line 15: / Line 23: @@
 *All functions related to impersonate controller were present in a single method
 *Presence of repetitive code
 These two issues have been tackled by
 Creating new methods which were called inside the impersonate controller. The new methods were:
@@ Line 22: / Line 39: @@
 *display_error_msg
 *clear_session

Mramani at 22:58, 23 March 2020

2020-03-23T22:58:35Z

← Older revision		Revision as of 22:58, 23 March 2020
Line 13:		Line 13:
	===Problem Statement===		===Problem Statement===
	The aim of the project is to refactor the impersonate controller. The pre-existing code had two major issues.		The aim of the project is to refactor the impersonate controller. The pre-existing code had two major issues.
	1. All functions related to impersonate controller were present in a single method		*All functions related to impersonate controller were present in a single method
	2.Presence of repetitive code		*Presence of repetitive code

	These two issues have been tackled by		These two issues have been tackled by
	1. Creating new methods which were called inside the impersonate controller. The new methods were:		Creating new methods which were called inside the impersonate controller. The new methods were:
	a.checkif_user_impersonateable
	b.display_error_msg		*checkif_user_impersonateable
	c.clear_session		*display_error_msg
			*clear_session

	===About Impersonate Controller===		===About Impersonate Controller===
	Expertiza allows the administrators, instructors or teaching assistants to impersonate another user (like a student) and access their account. For example, an instructor impersonating a student’s account can view their assignments, stage deadlines, peer reviews and anything else that the student can view. One thing to be noted is that most of these users con only impersonate users for whom they are a parent. For example, instructor6 is a parent of student3841 and not student3836; as a result, instructor6 can impersonate only 3841.		Expertiza allows the administrators, instructors or teaching assistants to impersonate another user (like a student) and access their account. For example, an instructor impersonating a student’s account can view their assignments, stage deadlines, peer reviews and anything else that the student can view. One thing to be noted is that most of these users con only impersonate users for whom they are a parent. For example, instructor6 is a parent of student3841 and not student3836; as a result, instructor6 can impersonate only 3841.

Mramani: Creation of the page

2020-03-23T22:55:41Z

Creation of the page

← Older revision		Revision as of 22:55, 23 March 2020
Line 1:		Line 1:
	This wiki page describes the work done under E2002 OSS Program for Spring 2020, in the CSC/ECE 517 course.		This wiki page describes the work done under E2002 OSS Program for Spring 2020, in the CSC/ECE 517 course.

			===Peer Review Information===
			1. Instructor login: username -> instructor6, password -> password

			when logged in as an instructor, under the manage option in the ribbon, select impersonate user. Upon redirected to impersonate page, enter the account which needs to be impersonated. If possible it impersonates that user. Now a new button called revert appears on the ribbon, this can be used to revert the impersonation and return to the instructor profile.

			===About Expertiza===

			[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza is a complete instructor-student usage website where the instructor can assign assignments, deadlines, grades, etc that is required for the course. Similarly, the students can use this website to perform the tasks required as part of the course like project or assignments submission, forming groups and collaborating with them, as well as reviewing projects and teammates.


			===Problem Statement===
			The aim of the project is to refactor the impersonate controller. The pre-existing code had two major issues.
			1. All functions related to impersonate controller were present in a single method
			2.Presence of repetitive code

			These two issues have been tackled by
			1. Creating new methods which were called inside the impersonate controller. The new methods were:
			a.checkif_user_impersonateable
			b.display_error_msg
			c.clear_session

			===About Impersonate Controller===
			Expertiza allows the administrators, instructors or teaching assistants to impersonate another user (like a student) and access their account. For example, an instructor impersonating a student’s account can view their assignments, stage deadlines, peer reviews and anything else that the student can view. One thing to be noted is that most of these users con only impersonate users for whom they are a parent. For example, instructor6 is a parent of student3841 and not student3836; as a result, instructor6 can impersonate only 3841.

Nradhak2: Created page with "This wiki page describes the work done under E2002 OSS Program for Spring 2020, in the CSC/ECE 517 course."

2020-03-21T15:55:09Z

Created page with "This wiki page describes the work done under E2002 OSS Program for Spring 2020, in the CSC/ECE 517 course."

New page

This wiki page describes the work done under E2002 OSS Program for Spring 2020, in the CSC/ECE 517 course.