E1853 write unit tests for menu - Revision history

Jfgiall2: /* Design */

2018-10-30T23:15:23Z

Design

← Older revision		Revision as of 23:15, 30 October 2018
Line 63:		Line 63:
	We address this issue by neatly creating all of the mock objects that we need in 'let' blocks before the tests, and explaining any of the tricky nuances (like how MenuItems and Roles interact using the role_(user_type).yml file). We also add additional comments to some of the more complex test cases (#select) to explain why we're expecting the particular side effects we're expecting, when our 'it' and 'context' block descriptions cannot easily convey all of the complexities.		We address this issue by neatly creating all of the mock objects that we need in 'let' blocks before the tests, and explaining any of the tricky nuances (like how MenuItems and Roles interact using the role_(user_type).yml file). We also add additional comments to some of the more complex test cases (#select) to explain why we're expecting the particular side effects we're expecting, when our 'it' and 'context' block descriptions cannot easily convey all of the complexities.

	Here is ~~a snapshot~~ of the Node unit tests, which shows proper utilization of Rspec best practices. We define all of our necessary mock objects. We utilize short, coherent expectations. We use contexts to provide more information about the branches in a function that we are testing. We avoid binding ourselves to implementation by stubbing methods which are called in other classes.		Here is an example of how we mock objects for the Node unit tests.

	[[File:~~Csc517_oss_menu_unit_tests~~.png]]		[[File:Csc517_e1853_mocking_objects_example.png]]

			Here is a snapshot of the Node unit tests, which shows proper utilization of Rspec best practices. We utilize short, coherent expectations. We use contexts to provide more information about the branches in a function that we are testing. We avoid binding ourselves to implementation by stubbing methods which are called in other classes.

			[[File:Csc517_e1853_rspec_unit_test_examples.png]]

	===Impact===		===Impact===

Jfgiall2: remove extraneous expertiza background section.

2018-10-30T23:09:36Z

remove extraneous expertiza background section.

← Older revision		Revision as of 23:09, 30 October 2018
Line 15:		Line 15:

	==Background==		==Background==
	~~===Expertiza===~~
	[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework. It provides instructors with the ability to create, customize, and assign projects. It provides students with the ability to form teams and collaborate on these assignments, submit those assignments, as well as review others and be reviewed on their work.

	===Menus and Nodes===		===Menus and Nodes===

Jfgiall2: /* Video of Test Suite Running */

2018-10-27T17:11:19Z

Video of Test Suite Running

← Older revision		Revision as of 17:11, 27 October 2018
Line 94:		Line 94:
	====Video of Test Suite Running====		====Video of Test Suite Running====
	A video of our test suite running properly can be found here!		A video of our test suite running properly can be found here!

			[https://youtu.be/PGRU7dfAsXk E1853 Menu Unit Tests Running (Hosted on Youtube)]

Jfgiall2: formatting

2018-10-27T17:04:16Z

formatting

← Older revision		Revision as of 17:04, 27 October 2018
Line 12:		Line 12:

	===Task===		===Task===
	For this project, our task was to achieve at least 90% code coverage on the menu.rb model.		For this project, our task was to achieve at least 90% code coverage on the menu.rb model.



	==Background==		==Background==

Jfgiall2: More Formatting. Like literally just so much.

2018-10-27T17:04:02Z

More Formatting. Like literally just so much.

← Older revision		Revision as of 17:04, 27 October 2018
Line 10:		Line 10:
	*Senthil Sankar (ssankar9)		*Senthil Sankar (ssankar9)
	*Vato Maskhulia (vmaskhu)		*Vato Maskhulia (vmaskhu)
	~~===Task and Results===~~
	====Task====		===Task===
	For this project, our task was to achieve at least 90% code coverage on the menu.rb model.		For this project, our task was to achieve at least 90% code coverage on the menu.rb model.

	~~====Results====~~
	We ended up with 100% code coverage, and mutation testing on our test suite yielded 90.21% mutant-slaying capabilities. We believe this is a demonstration of the exemplary thoroughness of our test suite, and that these changes should be pulled in to the Expertiza master branch.
	~~This image shows our test suite running.~~

	~~[[File:Csc517_oss_project_rspec_run.png]]~~

	~~This image shows an abbreviated version of /coverage/index.html page which is generate after running rspec. It shows us achieving 100% code coverage.~~

	~~[[File:Csc517_oss_project_rspec_run_results.png]]~~

	This image shows our mutation score. Of 531 mutations, we killed 479 and 52 were left alive. This is a mutation coverage of 90.21%. While we will leave it to the TA to verify this claim, examination of the living mutants shows that many of the mutations replaced lines with equivalent code (fetching a variable as opposed to just accessing it, or substituting equivalent variables for one another). Similarly, killing the remainder of the mutants would require binding our tests to implementation, to ensure that particular methods get called. As such, we believe our mutation score is quite good.

	~~[[File:Csc517_oss_project_mutation_score.png]]~~

	~~====Effected Files====~~
	~~The files involved in this commit are:~~
	* menu.rb - the model being tested. Contains the menu class and the node class.
	* menu_spec.rb - the spec file for menu. Contains all of our tests.
	* spec_helper.rb - we added a limit on how long tests can take to run, as one of the mutations which was generated had infinite runtime.

	~~====Video of Test Suite Running====~~
	~~A video of our test suite running properly can be found here!~~


	===Background===		==Background==
	====Expertiza====		===Expertiza===
	[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework. It provides instructors with the ability to create, customize, and assign projects. It provides students with the ability to form teams and collaborate on these assignments, submit those assignments, as well as review others and be reviewed on their work.		[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework. It provides instructors with the ability to create, customize, and assign projects. It provides students with the ability to form teams and collaborate on these assignments, submit those assignments, as well as review others and be reviewed on their work.

	====Menus and Nodes====		===Menus and Nodes===
	Menus (and their sub-component, Nodes) provide the foundation for navigation within the Expertiza platform. With the role of the user as input, they present to the user all possible options a user of their role can have from the top of each Expertiza screen. The Menu is critical for navigating Expertiza and exposing the correct functionality to the correct users.		Menus (and their sub-component, Nodes) provide the foundation for navigation within the Expertiza platform. With the role of the user as input, they present to the user all possible options a user of their role can have from the top of each Expertiza screen. The Menu is critical for navigating Expertiza and exposing the correct functionality to the correct users.

	====Motivation====		===Motivation===
	Testing is critical to ensuring that software is functional. A robust test suite which tests the returns of query messages and the side effects of command messages will help expedite development by quickly ensuring nothing has broken when changes are made. While manually testing the behavior of the menu is quite straight-forward, automating the underlying mechanics of the menu, which are abstract and generic, is a good best practice to prove that the system for generating menus is not broken.		Testing is critical to ensuring that software is functional. A robust test suite which tests the returns of query messages and the side effects of command messages will help expedite development by quickly ensuring nothing has broken when changes are made. While manually testing the behavior of the menu is quite straight-forward, automating the underlying mechanics of the menu, which are abstract and generic, is a good best practice to prove that the system for generating menus is not broken.

	===Test Plan===		==Test Plan==
	In order to fully test menu.rb, we composed a total of 29 tests, 12 for the Node class and 17 for the Menu class.		In order to fully test menu.rb, we composed a total of 29 tests, 12 for the Node class and 17 for the Menu class.
	*'''Node'''		*'''Node'''
Line 82:		Line 60:
	*# Menu#crumbs - When bottom-level menu item is selected, crumbs are ordered from child to parent and all are present up to root.		*# Menu#crumbs - When bottom-level menu item is selected, crumbs are ordered from child to parent and all are present up to root.

	===Design and Impact===		==Design and Impact==

	====Design====		===Design===
	Because of the nature of our assignment, our only design decisions were made with respect to making our Rspec tests as clean and readable as possible. We did not modify the application code itself. That being said, the Menu model is highly compositional, and it touches on MenuItem, ControllerAction, Controller, ContentPage, and Role (in addition to Node, which is in the same model). As a result, one of our main objectives was to make sure that we were transparent about all the different models which need to exist and how they interact with each other, in order for the Menu model to work.		Because of the nature of our assignment, our only design decisions were made with respect to making our Rspec tests as clean and readable as possible. We did not modify the application code itself. That being said, the Menu model is highly compositional, and it touches on MenuItem, ControllerAction, Controller, ContentPage, and Role (in addition to Node, which is in the same model). As a result, one of our main objectives was to make sure that we were transparent about all the different models which need to exist and how they interact with each other, in order for the Menu model to work.

Line 93:		Line 71:
	[[File:Csc517_oss_menu_unit_tests.png]]		[[File:Csc517_oss_menu_unit_tests.png]]

	====Impact====		===Impact===
	In the future, it will be very easy to test whether changes to the menu model have broken the original functionality. It will also be easy to add more tests to raise our test suite's mutant-killing rank, as we have done the hard part of defining all the mock objects and prototyping the relations they all have with each other in this initial set of tests.		In the future, it will be very easy to test whether changes to the menu model have broken the original functionality. It will also be easy to add more tests to raise our test suite's mutant-killing rank, as we have done the hard part of defining all the mock objects and prototyping the relations they all have with each other in this initial set of tests.

			==Results==
			We ended up with 100% code coverage, and mutation testing on our test suite yielded 90.21% mutant-slaying capabilities. We believe this is a demonstration of the exemplary thoroughness of our test suite, and that these changes should be pulled in to the Expertiza master branch.
			This image shows our test suite running.

			[[File:Csc517_oss_project_rspec_run.png]]

			This image shows an abbreviated version of /coverage/index.html page which is generate after running rspec. It shows us achieving 100% code coverage.

			[[File:Csc517_oss_project_rspec_run_results.png]]

			This image shows our mutation score. Of 531 mutations, we killed 479 and 52 were left alive. This is a mutation coverage of 90.21%. While we will leave it to the TA to verify this claim, examination of the living mutants shows that many of the mutations replaced lines with equivalent code (fetching a variable as opposed to just accessing it, or substituting equivalent variables for one another). Similarly, killing the remainder of the mutants would require binding our tests to implementation, to ensure that particular methods get called. As such, we believe our mutation score is quite good.

			[[File:Csc517_oss_project_mutation_score.png]]

			====Effected Files====
			The files involved in this commit are:
			* menu.rb - the model being tested. Contains the menu class and the node class.
			* menu_spec.rb - the spec file for menu. Contains all of our tests.
			* spec_helper.rb - we added a limit on how long tests can take to run, as one of the mutations which was generated had infinite runtime.

			====Video of Test Suite Running====
			A video of our test suite running properly can be found here!

Jfgiall2: /* Test Plan */

2018-10-27T17:01:32Z

Test Plan

← Older revision		Revision as of 17:01, 27 October 2018
Line 50:		Line 50:
	===Test Plan===		===Test Plan===
	In order to fully test menu.rb, we composed a total of 29 tests, 12 for the Node class and 17 for the Menu class.		In order to fully test menu.rb, we composed a total of 29 tests, 12 for the Node class and 17 for the Menu class.


	*'''Node'''		*'''Node'''
	*# Node#setup - Node#setup appropriately sets a Node's parent_id, name, id, and label to those of the MenuItem passed to it as an argument.		*# Node#setup - Node#setup appropriately sets a Node's parent_id, name, id, and label to those of the MenuItem passed to it as an argument.

Jfgiall2: Fixed moooooore formatting.

2018-10-27T17:01:02Z

Fixed moooooore formatting.

← Older revision		Revision as of 17:01, 27 October 2018
Line 50:		Line 50:
	===Test Plan===		===Test Plan===
	In order to fully test menu.rb, we composed a total of 29 tests, 12 for the Node class and 17 for the Menu class.		In order to fully test menu.rb, we composed a total of 29 tests, 12 for the Node class and 17 for the Menu class.
	'''Node'''
	1. Node#setup - Node#setup appropriately sets a Node's parent_id, name, id, and label to those of the MenuItem passed to it as an argument.
	2. Node#setup - When MenuItem has a ControllerAction, Node#setup(MenuItem) makes Node's controller_action_id becomes that ControllerAction's id.		*'''Node'''
	3. Node#setup - When MenuItem has a ControllerAction, Node#setup(MenuItem) makes Node's url become ControllerAction's url_to_use.		*# Node#setup - Node#setup appropriately sets a Node's parent_id, name, id, and label to those of the MenuItem passed to it as an argument.
	4. Node#setup - When MenuItem's ControllerAction has a Controller, Node#setup(MenuItem) makes Node's site_controller_id equal to Controller's id.		*# Node#setup - When MenuItem has a ControllerAction, Node#setup(MenuItem) makes Node's controller_action_id becomes that ControllerAction's id.
	5. Node#setup - When MenuItem's ControllerAction has no url_to_use, Node#setup(MenuItem) makes Node's url equal to "/#{controller.name}/#{controller_action.name}", the controller_action's name appended to the controller's name.		*# Node#setup - When MenuItem has a ControllerAction, Node#setup(MenuItem) makes Node's url become ControllerAction's url_to_use.
	6. Node#setup - When MenuItem has a ContentPage, Node#setup(MenuItem) makes Node's content_page_id equal to ContentPage's id.		*# Node#setup - When MenuItem's ControllerAction has a Controller, Node#setup(MenuItem) makes Node's site_controller_id equal to Controller's id.
	7. Node#setup - When MenuItem has a ContentPage, Node#setup(MenuItem) makes Node's url equal to ContentPage's name.		*# Node#setup - When MenuItem's ControllerAction has no url_to_use, Node#setup(MenuItem) makes Node's url equal to "/#{controller.name}/#{controller_action.name}", the controller_action's name appended to the controller's name.
	8. Node#site_controller - #site_controller sets the @site_controller instance variable.		*# Node#setup - When MenuItem has a ContentPage, Node#setup(MenuItem) makes Node's content_page_id equal to ContentPage's id.
	9. Node#controller_action - #controller_action sets the @controller_action instance variable.		*# Node#setup - When MenuItem has a ContentPage, Node#setup(MenuItem) makes Node's url equal to ContentPage's name.
	~~10.~~ Node#content_page - #content_page sets the @content_page instance variable.		*# Node#site_controller - #site_controller sets the @site_controller instance variable.
	~~11.~~ Node#add_child - #add_child updates Node's children		*# Node#controller_action - #controller_action sets the @controller_action instance variable.
	~~12.~~ Node#add_child - #add_child adds multiple children to Node's children.		*# Node#content_page - #content_page sets the @content_page instance variable.
	'''Menu'''		*# Node#add_child - #add_child updates Node's children
	1. Menu#select - it returns if select(name) is not in @by_name		*# Node#add_child - #add_child adds multiple children to Node's children.
	2. Menu#select - when name is in @by_name, Menu.selected is equal to name, @crumbs ends with the lowest level node and begins with the highest level node, and #selected? returns true for all nodes from the selected node to the root.		*'''Menu'''
	3. Menu#get_item - returns nil when id is not in @by_id		*# Menu#select - it returns if select(name) is not in @by_name
	4. Menu#get_item - returns the equivalent item when id is in @by_id (item is not identical, but all components of item are the same).		*# Menu#select - when name is in @by_name, Menu.selected is equal to name, @crumbs ends with the lowest level node and begins with the highest level node, and #selected? returns true for all nodes from the selected node to the root.
	5. Menu#get_menu - returns nil if level has no children.		*# Menu#get_item - returns nil when id is not in @by_id
	6. Menu#get_menu - return children of a level if level has children.		*# Menu#get_item - returns the equivalent item when id is in @by_id (item is not identical, but all components of item are the same).
	7. Menu#get_menu - return all nodes except root if level is root.		*# Menu#get_menu - returns nil if level has no children.
	8. Menu#selected - returns root if nothing has been selected.		*# Menu#get_menu - return children of a level if level has children.
	9. Menu#selected - returns the name of the last selected menu_item.		*# Menu#get_menu - return all nodes except root if level is root.
	~~10.~~ Menu#selected? - if nothing has been selected, selected?(root_node) returns true.		*# Menu#selected - returns root if nothing has been selected.
	~~11.~~ Menu#selected? - if a node has been selected, selected? returns true for selected node and all its parents.		*# Menu#selected - returns the name of the last selected menu_item.
	~~12.~~ Menu#selected? - if there are no menu items corresponding to the permission's of the role provided to menu, selected? does not return true.		*# Menu#selected? - if nothing has been selected, selected?(root_node) returns true.
	~~13.~~ Menu#selected? - if MenuItem returns an empty array, selected? returns false for all input.		*# Menu#selected? - if a node has been selected, selected? returns true for selected node and all its parents.
	~~14.~~ Menu#crumbs - When top-level menu item is selected, crumbs has length one.		*# Menu#selected? - if there are no menu items corresponding to the permission's of the role provided to menu, selected? does not return true.
	~~15.~~ Menu#crumbs - When top-level menu item is selected, crumbs has the root node's id.		*# Menu#selected? - if MenuItem returns an empty array, selected? returns false for all input.
	~~16.~~ Menu#crumbs - When bottom-level menu item is selected, crumbs has two crumbs (assuming lowest level is two).		*# Menu#crumbs - When top-level menu item is selected, crumbs has length one.
	~~17.~~ Menu#crumbs - When bottom-level menu item is selected, crumbs are ordered from child to parent and all are present up to root.		*# Menu#crumbs - When top-level menu item is selected, crumbs has the root node's id.
			*# Menu#crumbs - When bottom-level menu item is selected, crumbs has two crumbs (assuming lowest level is two).
			*# Menu#crumbs - When bottom-level menu item is selected, crumbs are ordered from child to parent and all are present up to root.

	===Design and Impact===		===Design and Impact===

Jfgiall2: Fixed formatting typo.

2018-10-27T16:54:54Z

Fixed formatting typo.

← Older revision		Revision as of 16:54, 27 October 2018
Line 34:		Line 34:
	* spec_helper.rb - we added a limit on how long tests can take to run, as one of the mutations which was generated had infinite runtime.		* spec_helper.rb - we added a limit on how long tests can take to run, as one of the mutations which was generated had infinite runtime.

	====Video of Test Suite Running===		====Video of Test Suite Running====
	A video of our test suite running properly can be found here!		A video of our test suite running properly can be found here!

Jfgiall2: Changed formatting.

2018-10-27T16:54:29Z

Changed formatting.

← Older revision		Revision as of 16:54, 27 October 2018
Line 11:		Line 11:
	*Vato Maskhulia (vmaskhu)		*Vato Maskhulia (vmaskhu)
	===Task and Results===		===Task and Results===
	For this project, our task was to achieve at least 90% code coverage on the menu.rb model. We ended up with 100% code coverage, and mutation testing on our test suite yielded 90.21% mutant-slaying capabilities. We believe this is a demonstration of the exemplary thoroughness of our test suite, and that these changes should be pulled in to the Expertiza master branch.		====Task====
			For this project, our task was to achieve at least 90% code coverage on the menu.rb model.

			====Results====
			We ended up with 100% code coverage, and mutation testing on our test suite yielded 90.21% mutant-slaying capabilities. We believe this is a demonstration of the exemplary thoroughness of our test suite, and that these changes should be pulled in to the Expertiza master branch.
	This image shows our test suite running.		This image shows our test suite running.

Line 24:		Line 28:
	[[File:Csc517_oss_project_mutation_score.png]]		[[File:Csc517_oss_project_mutation_score.png]]

			====Effected Files====
	The files involved in this commit are:		The files involved in this commit are:
	* menu.rb - the model being tested. Contains the menu class and the node class.		* menu.rb - the model being tested. Contains the menu class and the node class.
Line 29:		Line 34:
	* spec_helper.rb - we added a limit on how long tests can take to run, as one of the mutations which was generated had infinite runtime.		* spec_helper.rb - we added a limit on how long tests can take to run, as one of the mutations which was generated had infinite runtime.

			====Video of Test Suite Running===
	A video of our test suite running properly can be found here!		A video of our test suite running properly can be found here!

Jfgiall2: Filled out test plan, design choices, and impact.

2018-10-27T16:52:49Z

Filled out test plan, design choices, and impact.

@@ Line 28: / Line 28: @@
 * menu_spec.rb - the spec file for menu. Contains all of our tests.
 * spec_helper.rb - we added a limit on how long tests can take to run, as one of the mutations which was generated had infinite runtime.
 ===Background===
@@ Line 38: / Line 41: @@
 ====Motivation====
 Testing is critical to ensuring that software is functional. A robust test suite which tests the returns of query messages and the side effects of command messages will help expedite development by quickly ensuring nothing has broken when changes are made. While manually testing the behavior of the menu is quite straight-forward, automating the underlying mechanics of the menu, which are abstract and generic, is a good best practice to prove that the system for generating menus is not broken.