CSC/ECE 517 Spring 2018 E1813 Menu item tests - Revision history

Bjain at 05:17, 3 April 2018

2018-04-03T05:17:11Z

← Older revision		Revision as of 05:17, 3 April 2018
Line 184:		Line 184:

	For our case, the C0 coverage of the menu_items.rb file in the Models folder increased from 0 to 100.		For our case, the C0 coverage of the menu_items.rb file in the Models folder increased from 0 to 100.
	Following are the screenshots of the completed code coverage:		Following are the screenshots of the completed code coverage taken from coverage/index.html:
	[[File:Coverage1.PNG]]		[[File:Coverage1.PNG]]
	[[File:Coverage2.PNG]]		[[File:Coverage2.PNG]]

Bjain at 05:16, 3 April 2018

2018-04-03T05:16:28Z

← Older revision		Revision as of 05:16, 3 April 2018
Line 184:		Line 184:

	For our case, the C0 coverage of the menu_items.rb file in the Models folder increased from 0 to 100.		For our case, the C0 coverage of the menu_items.rb file in the Models folder increased from 0 to 100.
			Following are the screenshots of the completed code coverage:
			[[File:Coverage1.PNG]]
			[[File:Coverage2.PNG]]
			[[File:Coverage3.PNG]]
	==References==		==References==

Bjain at 03:55, 27 March 2018

2018-03-27T03:55:56Z

← Older revision		Revision as of 03:55, 27 March 2018
Line 78:		Line 78:
	3. Understand the linked data attributes being used, like controller_actions, content_page, permissions_id		3. Understand the linked data attributes being used, like controller_actions, content_page, permissions_id

	4. Creating ~~dummy~~ entries for testing different functionalities.		4. Creating stub entries for testing different functionalities.

	5. Writing testing conditions for different functions and cross checking with the expected outputs.		5. Writing testing conditions for different functions and cross checking with the expected outputs.
Line 137:		Line 137:

	=== Test Entries Creation ===		=== Test Entries Creation ===
	~~Mock/dummy~~ objects are needed to be created for any unit testing criteria.These objects are loaded freshly and deleted after every testing condition.		Stub objects are needed to be created for any unit testing criteria.These objects are loaded freshly and deleted after every testing condition.

	Several methods exist for creating such a objects, whose parameters need to be designed to satisfy the conditions under test. Using 'factories' is one such method where few of the attributes are filled in with predefined values when an created. Here, for this specific case, we haven't used, factories method as, the number of attributes were limited in menu_items model and could be filled in completely with the required values each time.		Several methods exist for creating such a objects, whose parameters need to be designed to satisfy the conditions under test. Using 'factories' is one such method where few of the attributes are filled in with predefined values when an created. Here, for this specific case, we haven't used, factories method as, the number of attributes were limited in menu_items model and could be filled in completely with the required values each time.

Bjain at 03:54, 27 March 2018

2018-03-27T03:54:36Z

← Older revision		Revision as of 03:54, 27 March 2018
Line 148:		Line 148:

	=== Testing Conditions ===		=== Testing Conditions ===
	~~=== Testing Conditions ===~~
	A total of 13 unit tests were performed for testing all the functions in menu items model file and achieving complete code coverage.		A total of 13 unit tests were performed for testing all the functions in menu items model file and achieving complete code coverage.

Bjain at 03:52, 27 March 2018

2018-03-27T03:52:09Z

Show changes

Bjain at 03:38, 27 March 2018

2018-03-27T03:38:41Z

← Older revision		Revision as of 03:38, 27 March 2018
Line 37:		Line 37:
	Some of the advantages of unit testing are:		Some of the advantages of unit testing are:

	1. Finds problems early:		1. Finds problems early: Unit testing finds problems early in the development cycle. This includes both bugs in the programmer's implementation and flaws or missing parts of the specification for the unit.

	Unit testing finds problems early in the development cycle. This includes both bugs in the programmer's implementation and flaws or missing parts of the specification for the unit.
	In test-driven development (TDD), which is frequently used in both extreme programming and scrum, unit tests are created before the code itself is written. When the tests pass, that code is considered complete.		In test-driven development (TDD), which is frequently used in both extreme programming and scrum, unit tests are created before the code itself is written. When the tests pass, that code is considered complete.

	2. Facilitates change:		2. Facilitates change: Unit testing allows the programmer to refactor code or upgrade system libraries at a later date, and make sure the module still works correctly (e.g., in regression testing). The procedure is to write test cases for all functions and methods so that whenever a change causes a fault, it can be quickly identified. Unit tests detect changes which may break a design contract.

	Unit testing allows the programmer to refactor code or upgrade system libraries at a later date, and make sure the module still works correctly (e.g., in regression testing). The procedure is to write test cases for all functions and methods so that whenever a change causes a fault, it can be quickly identified. Unit tests detect changes which may break a design contract.

	~~3. Simplifies Integration:~~

	Unit testing may reduce uncertainty in the units themselves and can be used in a bottom-up testing style approach. By testing the parts of a program first and then testing the sum of its parts, integration testing becomes much easier.

	4. ~~Documentation~~:		3. Simplifies Integration: Unit testing may reduce uncertainty in the units themselves and can be used in a bottom-up testing style approach. By testing the parts of a program first and then testing the sum of its parts, integration testing becomes much easier.

	Developers looking to learn what functionality is provided by a unit, and how to use it, can look at the unit tests to gain a basic understanding of the unit's interface's API.		4. Documentation: Developers looking to learn what functionality is provided by a unit, and how to use it, can look at the unit tests to gain a basic understanding of the unit's interface's API.

	5. Design:		5. Design: When software is developed using a test-driven approach, the combination of writing the unit test to specify the interface plus the refactoring activities performed after the test is passing, may take the place of formal design. Each unit test can be seen as a design element specifying classes, methods, and observable behavior.

	When software is developed using a test-driven approach, the combination of writing the unit test to specify the interface plus the refactoring activities performed after the test is passing, may take the place of formal design. Each unit test can be seen as a design element specifying classes, methods, and observable behavior.

	== Problem Statement ==		== Problem Statement ==
Line 109:		Line 99:
	Following are the parameters associated with the menu_item model:		Following are the parameters associated with the menu_item model:

	1. Name : This parameter gives the name to the menu item.		1. Name: This parameter gives the name to the menu item.

	2. Label : This parameter gives the label to the menu item.		2. Label: This parameter gives the label to the menu item.

	3. Parent id : It gives the id of the parent and establishes the hierarchy of the various objects of the menu item model. It can also be 'null' which means that it will be the base category.		3. Parent id: It gives the id of the parent and establishes the hierarchy of the various objects of the menu item model. It can also be 'null' which means that it will be the base category.

	4. Sequence id : It gives the sequence numbering for determining the way the attributes are ordered within a parent.		4. Sequence id: It gives the sequence numbering for determining the way the attributes are ordered within a parent.

	5. Controller action id : This parameter is associated with the direction in which the user is directed onto.		5. Controller action id: This parameter is associated with the direction in which the user is directed onto.

	6. Content page id : This parameter is also associated with the direction in which the user is directed onto.		6. Content page id: This parameter is also associated with the direction in which the user is directed onto.

	====Methods====		====Methods====
Line 125:		Line 115:
	Different instance methods and class methods exist in this models . Brief description of each of them are:		Different instance methods and class methods exist in this models . Brief description of each of them are:

	1. find_or_create_by_name(params) : Class Method		1. find_or_create_by_name(params): Class Method
	This method finds or creates a new entry with the given name obtained in params.		This method finds or creates a new entry with the given name obtained in params.

	2. delete : Instance Method		2. delete: Instance Method
	This methods deletes the entry and all the child entries (entries having the same parent id) lined to it		This methods deletes the entry and all the child entries (entries having the same parent id) lined to it

	3. above : Instance Method		3. above: Instance Method
	It returns the entry that is above a present sequence number for a given parent id		It returns the entry that is above a present sequence number for a given parent id

	4. below : Instance Method		4. below: Instance Method
	It returns the entry that is below a present sequence number for a given parent id		It returns the entry that is below a present sequence number for a given parent id

	5. repack(repack_id) : Class Method		5. repack(repack_id): Class Method
	It modifies the sequence numbers, making them in order, removing the skip entries present in it. It is performed after certain sequences have been deleted. repack_id tells the parent id under which these changes are to be made		It modifies the sequence numbers, making them in order, removing the skip entries present in it. It is performed after certain sequences have been deleted. repack_id tells the parent id under which these changes are to be made

	6. next_seq(parent id) : Class Method		6. next_seq(parent id): Class Method
	It returns the next possible sequence id corresponding to a given parent id entries. This function would be helpful if we wish to add a new entry and find out which sequence id is to be given to it.		It returns the next possible sequence id corresponding to a given parent id entries. This function would be helpful if we wish to add a new entry and find out which sequence id is to be given to it.

	7. items_for_permission : Class Method		7. items_for_permission: Class Method
	It returns the set of items that are possible to be displayed for a given permission id and also based on controller action id and page id being present for it.		It returns the set of items that are possible to be displayed for a given permission id and also based on controller action id and page id being present for it.

Line 244:		Line 234:
	the method should return an empty list.		the method should return an empty list.

	== Conclusion ~~and Learning Outcomes~~ ==		== Conclusion ==

			After writing the test cases we used SimpleCov to measure the C0 coverage of our rails application. After running rake spec to run the test cases, SimpleCov creates a directory called coverage in our rails application folder. This folder called coverage contains an index.html file which when opened in a browser renders an html page which gives the C0 coverage of each of the files in the Controllers, Models, Helpers in the app directory.

	~~After writing the test cases we used SimpleCov to measure the C0 coverage of our rails application.~~		For our case, the C0 coverage of the menu_items.rb file in the Models folder increased from 0 to 100.
	~~In our case we did not have to install SimpleCov explicitly since it was already installed earlier.~~
	~~After running rake spec to run the test cases, SimpleCov creates a directory called coverage in our rails application folder.~~
	This folder called coverage contains an index.html file which when opened in a browser renders an html page which gives the C0 coverage of each of the files in the Controllers,Models,Helpers in the app directory.
	For our case, the C0 coverage of the menu_items.rb file in the Models folder increased from <> to <>.

	The learning outcomes after performing this project can be summarized in the following points:		The learning outcomes after performing this project can be summarized in the following points:
Line 265:		Line 253:

	#[https://github.com/expertiza/expertiza Expertiza on GitHub]		#[https://github.com/expertiza/expertiza Expertiza on GitHub]
	#[https://github.com/~~sandeep993~~/expertiza/~~tree~~/~~menu_item_branch~~ GitHub Project Repository Fork]		#[https://github.com/angad8292/expertiza/blob/master/spec/models/menu_item_spec.rb GitHub Project Repository Fork]
	#[http://expertiza.ncsu.edu/ The live Expertiza website]		#[http://expertiza.ncsu.edu/ The live Expertiza website]
	#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]		#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
	#[https://relishapp.com/rspec Rspec Documentation]		#[https://relishapp.com/rspec Rspec Documentation]

Bjain at 03:32, 27 March 2018

2018-03-27T03:32:19Z

← Older revision		Revision as of 03:32, 27 March 2018
Line 71:		Line 71:

	=== Team Members ===		=== Team Members ===
	Students who collaborated to work on this problem statement are :		Students who collaborated to work on this problem statement are:

	1. Angad Singh Wadhwa (awadhwa3@ncsu.edu)		1. Angad Singh Wadhwa (awadhwa3@ncsu.edu)
Line 123:		Line 123:
	====Methods====		====Methods====

	Different instance methods and class methods exist in this models . Brief description of each of them are : -		Different instance methods and class methods exist in this models . Brief description of each of them are:

	1. find_or_create_by_name(params) : Class Method		1. find_or_create_by_name(params) : Class Method
Line 151:		Line 151:
	Several methods exist for creating such a objects, whose parameters need to be designed to satisfy the conditions under test. Using 'factories' is one such method where few of the attributes are filled in with predefined values when an created. Here, for this specific case, we haven't used, factories method as, the number of attributes were limited in menu_items model and could be filled in completely with the required values each time.		Several methods exist for creating such a objects, whose parameters need to be designed to satisfy the conditions under test. Using 'factories' is one such method where few of the attributes are filled in with predefined values when an created. Here, for this specific case, we haven't used, factories method as, the number of attributes were limited in menu_items model and could be filled in completely with the required values each time.

	For testing menu_items, we created required entries into the database using "MenuItem.~~new()~~" method, giving different values for each of the test inputs to cover the required testing conditions.		For testing menu_items, we created required entries into the database using "Let" and "MenuItem.create" method, giving different values for each of the test inputs to cover the required testing conditions.

	~~before~~(:~~each~~) do		let!(:menuitem) {MenuItem.create id: 1, parent_id: nil, name: "navigate", label: "Navigate", seq: 1, controller_action_id: 1, content_page_id: 1}
	~~@test1 =~~ MenuItem.~~new(~~name: "~~home1~~", ~~parent_id~~: ~~nil~~, seq: 1, controller_action_id: ~~nil~~, content_page_id: ~~nil, label: "newlabel")~~
	~~@test1.save~~
	~~end~~

	The above is an example entry used for ~~creating objects~~. ~~6 such test~~ objects were created with entries giving combinations of parent_id ~~and~~ sequence numbers.		The above is an example entry used for menu item. 5 more similar objects were created with entries giving combinations of parent_id, sequence numbers and controller_action_id. We also created objects for controller_action and content_page which were used to define conditions for coverage of items_for_permission.

	~~Before each test, all the objects are~~ created~~, which is done using "before(:each)" key word.~~
	~~Also several~~ objects ~~of 'ControllerAction'~~ and ~~'ContentPage' had~~ to ~~be created~~ for ~~testing one~~ of ~~the methods which acted based on those values~~.

	=== Testing Conditions ===		=== Testing Conditions ===

Bjain at 03:21, 27 March 2018

2018-03-27T03:21:15Z

← Older revision		Revision as of 03:21, 27 March 2018
Line 10:		Line 10:
	BDD focuses on:		BDD focuses on:

	Where to start in the process		1. Where to start in the process
	What to test and what not to test
	How much to test in one go		2. What to test and what not to test
	What to call the tests
	How to understand why a test fails		3. How much to test in one go

			4. What to call the tests

			5. How to understand why a test fails

	Test-driven development is a software development methodology which essentially states that for each unit of software, a software developer must:		Test-driven development is a software development methodology which essentially states that for each unit of software, a software developer must:

	Define a test set for the unit first;		Define a test set for the unit first;

	Make the tests fail;		Make the tests fail;

	Then implement the unit;		Then implement the unit;

	Finally, verify that the implementation of the unit makes the tests succeed.		Finally, verify that the implementation of the unit makes the tests succeed.

	This definition is rather non-specific in that it allows tests in terms of high-level software requirements, low-level technical details or anything in between. One way of looking at BDD therefore, is that it is a continued development of TDD which makes more specific choices than TDD.		This definition is rather non-specific in that it allows tests in terms of high-level software requirements, low-level technical details or anything in between. One way of looking at BDD therefore, is that it is a continued development of TDD which makes more specific choices than TDD.

Line 102:		Line 110:

	1. Name : This parameter gives the name to the menu item.		1. Name : This parameter gives the name to the menu item.
	2. Label : This parameter gives the label to the menu item
			2. Label : This parameter gives the label to the menu item.

	3. Parent id : It gives the id of the parent and establishes the hierarchy of the various objects of the menu item model. It can also be 'null' which means that it will be the base category.		3. Parent id : It gives the id of the parent and establishes the hierarchy of the various objects of the menu item model. It can also be 'null' which means that it will be the base category.

	4. Sequence id : It gives the sequence numbering for determining the way the attributes are ordered within a parent.		4. Sequence id : It gives the sequence numbering for determining the way the attributes are ordered within a parent.
	5. Controller action id :
	6. Content page id :~~- These attributes tell, to~~ which ~~direction/ page, this selection directs~~ the user onto.		5. Controller action id : This parameter is associated with the direction in which the user is directed onto.

			6. Content page id : This parameter is also associated with the direction in which the user is directed onto.

	====Methods====		====Methods====
Line 112:		Line 125:
	Different instance methods and class methods exist in this models . Brief description of each of them are : -		Different instance methods and class methods exist in this models . Brief description of each of them are : -

	1. find_or_create_by_name(params) :- Class Method		1. find_or_create_by_name(params) : Class Method
	This method finds or creates a new entry with the given name obtained in params		This method finds or creates a new entry with the given name obtained in params.

	2. delete :- Instance Method		2. delete : Instance Method
	This methods deletes the entry and all the child entries ( entries having the same parent id ) lined to it		This methods deletes the entry and all the child entries (entries having the same parent id) lined to it

	3. above :- Instance Method		3. above : Instance Method
	It returns the entry that is above a present sequence number for a given parent id		It returns the entry that is above a present sequence number for a given parent id

	4. below :- Instance Method		4. below : Instance Method
	It returns the entry that is below a present sequence number for a given parent id		It returns the entry that is below a present sequence number for a given parent id

	5. repack(repack_id) :- Class Method		5. repack(repack_id) : Class Method
	It modifies the sequence numbers, making them in order, removing the skip entries present in it. It is performed after certain sequences have been deleted. repack_id tells the parent id under which these changes are to be made		It modifies the sequence numbers, making them in order, removing the skip entries present in it. It is performed after certain sequences have been deleted. repack_id tells the parent id under which these changes are to be made

	6. next_seq(parent id) :- Class Method		6. next_seq(parent id) : Class Method
	It returns the next possible sequence id corresponding to a given parent id entries. This function would be helpful if we wish to add a new entry and find out which sequence id is to be given to it.		It returns the next possible sequence id corresponding to a given parent id entries. This function would be helpful if we wish to add a new entry and find out which sequence id is to be given to it.

	7. items_for_permission :- Class Method		7. items_for_permission : Class Method
	It returns the set of items that are possible to be displayed for a given permission id and also based on controller action id and page id being present for it.		It returns the set of items that are possible to be displayed for a given permission id and also based on controller action id and page id being present for it.

Bjain at 03:16, 27 March 2018

2018-03-27T03:16:27Z

← Older revision		Revision as of 03:16, 27 March 2018
Line 5:		Line 5:
	[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.		[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
	It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.		It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.
	===~~Test~~ Driven-Development===		===Behavior Driven-Development===
	~~Test~~-driven development (~~TDD~~) is a software development process that ~~relies on the repetition of a very short development cycle: Requirements are turned into very specific~~ test ~~cases, then the software is improved to pass the new tests, only. This is opposed to software~~ development ~~that allows software to be added that is not proven to meet requirements~~.		In software engineering, behavior-driven development (BDD) is a software development process that emerged from test-driven development (TDD). Behavior-driven development combines the general techniques and principles of TDD with ideas from domain-driven design and object-oriented analysis and design to provide software development and management teams with shared tools and a shared process to collaborate on software development.
	~~Test~~-driven development ~~is related to~~ the ~~test-first programming concepts~~ of ~~extreme programming, begun in 1999,but more recently has created more general interest in its own right.~~
	~~The~~ TDD ~~sequence can be can be summarized in following steps~~.

	~~1.Add a Test~~:		BDD focuses on:

	~~TDD begins by writing succinct test cases~~ to ~~test each of~~ the ~~features. This is opposite~~ to ~~traditional software development paradigm where code is written first~~ and ~~then~~ test ~~cases are later written~~ to test the ~~application.~~		Where to start in the process
			What to test and what not to test
			How much to test in one go
			What to call the tests
			How to understand why a test fails

	~~2.Run all tests and see if the new test fails~~:		Test-driven development is a software development methodology which essentially states that for each unit of software, a software developer must:

	~~This step validates that the~~ test harness is working correctly, shows that the new test does not pass without requiring new code because the required behavior already exists, and it rules out the possibility that the new test is flawed and will always pass. The new test should fail for the ~~expected reason. This step increases the developer's confidence in the new test.~~		Define a test set for the unit first;
			Make the tests fail;
	~~3.Write the code:~~		Then implement the unit;
			Finally, verify that the implementation of the unit makes the tests succeed.
	~~The next step is to write~~ the ~~minimum amount of code that causes the test case to pass.~~		This definition is rather non-specific in that it allows tests in terms of high-level software requirements, low-level technical details or anything in between. One way of looking at BDD therefore, is that it is a continued development of TDD which makes more specific choices than TDD.

	~~4.Run~~ tests:

	~~In this steps the test cases are run.If all test cases now pass~~, ~~the programmer can be confident~~ that the ~~new code meets~~ the ~~test requirements, and does not break or degrade any existing features. If they do not,~~ the ~~new code must be adjusted until they do~~.

	~~5. Refactor code:~~

	~~In this step, refactoring of code~~ is ~~performed by following good design principles like removal~~ of ~~duplicate code~~, ~~improving the readability and maintainability~~ of ~~the code.~~

	~~6. Repeat:~~

	~~Starting with another new test~~,~~the next step~~ is ~~to repeat the cycle to push the functionality forward.~~


	~~Advantages~~ of ~~using~~ TDD:
	~~1. Narrowing Problem Focus~~
	~~2. Tidier Code~~
	~~3. Not worrying about dependencies~~
	~~4. Easier refactoring~~
	5. ~~Better Test coverage and fewer bugs~~

	===Unit Testing===		===Unit Testing===
Line 116:		Line 98:
	A super admin has the permission to edit the menu bar, by adding or deleting menu item blocks from it. Upon adding each item, he gets to position it either in the main menu bar or into different sub categories.		A super admin has the permission to edit the menu bar, by adding or deleting menu item blocks from it. Upon adding each item, he gets to position it either in the main menu bar or into different sub categories.

	====~~Table~~ ====		====Parameters ====
	~~Table corresponding to menu item model has~~ the ~~following attributes:-~~		Following are the parameters associated with the menu_item model:

	~~1. Name 2. Label :- These attributes talk about~~ the ~~labeling being given to the attributes~~

	~~3. Parent id :- It tells about under which attribute does this particular attribute fall . If it is set has <null> it is the base category.~~

	~~4. Sequence id~~ :~~- It gives sequence numbering for determining the way the attributes are ordered within a parent.~~

	5. ~~controller~~ action id 6. Content page id :- These attributes tell, to which direction/ page, this selection directs the user onto.		1. Name : This parameter gives the name to the menu item.
			2. Label : This parameter gives the label to the menu item
			3. Parent id : It gives the id of the parent and establishes the hierarchy of the various objects of the menu item model. It can also be 'null' which means that it will be the base category.
			4. Sequence id : It gives the sequence numbering for determining the way the attributes are ordered within a parent.
			5. Controller action id :
			6. Content page id :- These attributes tell, to which direction/ page, this selection directs the user onto.

	====Methods ~~in the Model~~====		====Methods====

	Different instance methods and class methods exist in this models . Brief description of each of them are : -		Different instance methods and class methods exist in this models . Brief description of each of them are : -

Bjain at 03:06, 27 March 2018

2018-03-27T03:06:51Z

← Older revision		Revision as of 03:06, 27 March 2018
Line 33:		Line 33:

	Starting with another new test,the next step is to repeat the cycle to push the functionality forward.		Starting with another new test,the next step is to repeat the cycle to push the functionality forward.



	Advantages of using TDD:		Advantages of using TDD:
	*Narrowing Problem Focus		1. Narrowing Problem Focus
	*Tidier Code		2. Tidier Code
	*Not worrying about dependencies		3. Not worrying about dependencies
	*Easier refactoring		4. Easier refactoring
	*Better Test coverage and fewer bugs		5. Better Test coverage and fewer bugs

	===Unit Testing===		===Unit Testing===