CSC517 Fall 2017 OSS M1705 - Revision history

Nbalaji: /* Test Plan */

2017-04-29T03:26:36Z

Test Plan

← Older revision		Revision as of 03:26, 29 April 2017
Line 158:		Line 158:
	=== Test Plan ===		=== Test Plan ===

	[[File:~~test~~.png]]		[[File:bbtest.png]]

	==Conclusion==		==Conclusion==

Nbalaji: /* Test Plan */

2017-04-29T03:26:16Z

Test Plan

← Older revision		Revision as of 03:26, 29 April 2017
Line 158:		Line 158:
	=== Test Plan ===		=== Test Plan ===

	[[File:~~Table4~~.png]]		[[File:test.png]]

	==Conclusion==		==Conclusion==

Hgala2: /* Test Plan */

2017-04-29T02:36:41Z

Test Plan

← Older revision		Revision as of 02:36, 29 April 2017
Line 158:		Line 158:
	=== Test Plan ===		=== Test Plan ===

	[[File:~~Table1~~.png]]		[[File:Table4.png]]


	~~[[File:Table2.PNG]]~~


	~~[[File:Table3.PNG~~]]

	==Conclusion==		==Conclusion==

Sjha5: /* Testing */

2017-04-28T23:31:52Z

Testing

← Older revision		Revision as of 23:31, 28 April 2017
Line 147:		Line 147:
	== Testing ==		== Testing ==

	To test our tools we used both white-box and black-box testing. For white-box testing we used the Mocha framework, with Chai for the assertion library. We chose to use the ''assert'' style because the syntax makes the most sense to us. Additionally, we ~~will use~~ the Nock library to mock our Github API requests. We've unit tested all of the tools, following the methodology provided by Sandi Metz in her “Magic Tricks of Testing” lecture. Our black box test plan is shown in the figure below.		To test our tools we used both white-box and black-box testing. For white-box testing we used the Mocha framework, with Chai for the assertion library. We chose to use the ''assert'' style because the syntax makes the most sense to us. Additionally, we used the Nock library to mock our Github API requests. We've unit tested all of the tools, following the methodology provided by Sandi Metz in her “Magic Tricks of Testing” lecture. Our black box test plan is shown in the figure below.

	1. White Box Testing - Using Mocha, Chai, and Nock.		1. White Box Testing - Using Mocha, Chai, and Nock.

Hgala2: /* Tool # 2: Initialization Tool */

2017-04-28T23:31:27Z

Tool # 2: Initialization Tool

← Older revision		Revision as of 23:31, 28 April 2017
Line 92:		Line 92:
	* Parameters		* Parameters
	* folderPath - the path to the folder that holds ''repos'', the folder with the local repositories, cloned by the CloneTool.		* folderPath - the path to the folder that holds ''repos'', the folder with the local repositories, cloned by the CloneTool.
			* untilDate - fetches the authors who have committed until that particular date.
	* Logic		* Logic
	* First, the tool uses the ''git log'' command to find all author names from all the commits in a repository		* First, the tool uses the ''git log'' command to find all author names from all the commits in a repository

Hgala2: /* Tool # 3: Pull Request Tool */

2017-04-28T23:29:31Z

Tool # 3: Pull Request Tool

← Older revision		Revision as of 23:29, 28 April 2017
Line 104:		Line 104:
	* token - the GITHUB token, required to use the GitHub API		* token - the GITHUB token, required to use the GitHub API
	* organization - the organization whose repositories will be cloned		* organization - the organization whose repositories will be cloned
			* sinceDate - fetches the pull request from that particular date till the present date
	* Logic		* Logic
	* First, the tool gets all closed pull requests for each repo in an organization		* First, the tool gets all closed pull requests for each repo in an organization

Sjha5: /* Second Phase */

2017-04-28T23:25:40Z

Second Phase

← Older revision		Revision as of 23:25, 28 April 2017
Line 29:		Line 29:

	==Second Phase==		==Second Phase==
	As we ~~are~~ familiar using GitHub APIs ~~now~~, we ~~are ready to move~~ to subsequent steps mentioned on the [https://github.com/servo/servo/wiki/Report-new-contributors-projectgithub wiki page]<ref>https://github.com/servo/servo/wiki/Report-new-contributors-project</ref>		As we got familiar using GitHub APIs after first phase, we moved to subsequent steps mentioned on the [https://github.com/servo/servo/wiki/Report-new-contributors-projectgithub wiki page]<ref>https://github.com/servo/servo/wiki/Report-new-contributors-project</ref>
	We ~~have~~ three main tasks. We ~~will be working~~ on them in parallel, since they are independent.		We had three main tasks. We worked on them in parallel, since they are independent.

	===Task 1===		===Task 1===

	First of all, we ~~will~~ extended the Initialization Tool to support stopping at a particular date.		First of all, we extended the Initialization Tool to support stopping at a particular date.
	* We used the ''until'' flag for the ''git log'' command to achieve this. <ref>https://git-scm.com/docs/git-log</ref>		* We used the ''until'' flag for the ''git log'' command to achieve this. <ref>https://git-scm.com/docs/git-log</ref>

	===Task 2===		===Task 2===

	(Tool #3 - Pull Request Tool) Created a tool that processes all of the closed pull requests for a GitHub organization during a particular time period		(Tool #3 - Pull Request Tool) Created a tool that processes all of the closed pull requests for a GitHub organization during a particular time period.
	* For each pull requests, we got the list of commits present.		* For each pull requests, we got the list of commits present.
	* For each commit, we retrieved the authors/committers present.		* For each commit, we retrieved the authors/committers present.

Sjha5: /* Initial Phase */

2017-04-28T23:23:03Z

Initial Phase

← Older revision		Revision as of 23:23, 28 April 2017
Line 13:		Line 13:

	The first part of the project was to complete the following steps:		The first part of the project was to complete the following steps:
	* ~~Created~~ a GitHub organization with several repositories that can be used for manual tests		* Create a GitHub organization with several repositories that can be used for manual tests
	* ~~Created~~ a tool that initializes a JSON file with the known authors for a local git repository		* Create a tool that initializes a JSON file with the known authors for a local git repository
	* ~~Created~~ a tool that clones every git repository in a given GitHub organization (use the GitHub API to retrieve this information)		* Create a tool that clones every git repository in a given GitHub organization (use the GitHub API to retrieve this information)

	More details about it can be found directly on the [https://github.com/OODD-Mozilla/ToolRepository/blob/master/Wiki.md#project-description Project Description] page.		More details about it can be found directly on the [https://github.com/OODD-Mozilla/ToolRepository/blob/master/Wiki.md#project-description Project Description] page.
Line 24:		Line 24:
	We had to make decisions on what language and tools would be best to accomplish the initial tasks. The rationale behind our choices can be found in the [[#Design\|Design]] subsection below.		We had to make decisions on what language and tools would be best to accomplish the initial tasks. The rationale behind our choices can be found in the [[#Design\|Design]] subsection below.

	In this phase, we ~~build~~ two tools: Clone Tool and Initialization Tool. For more details, please see the ''Tools'' section below. We also created a test GitHub organization, [https://github.com/OODD-Mozilla OODD-Mozilla].		In this phase, we built two tools: Clone Tool and Initialization Tool. For more details, please see the ''Tools'' section below. We also created a test GitHub organization, [https://github.com/OODD-Mozilla OODD-Mozilla].

	In the initial phase, we did not explore any testing frameworks. However, we put a test plan in place and created very basic test cases for both tools.		In the initial phase, we did not explore any testing frameworks. However, we put a test plan in place and created very basic test cases for both tools.

Hgala2: /* Task 3 */

2017-04-28T23:17:05Z

Task 3

← Older revision		Revision as of 23:17, 28 April 2017
Line 49:		Line 49:
	===Task 3===		===Task 3===

	~~Test~~ the tools we have created.		Tested the tools we have created.
	* ~~Create~~ unit tests mocking the GitHub API usage for validating the tools. ~~Check~~ the [[#Test Plan\|Test Plan]] section on this page for more information.		* Created unit tests mocking the GitHub API usage for validating the tools. Checked the [[#Test Plan\|Test Plan]] section on this page for more information.
	* Black box test cases can also be found in the ''Test'' section.		* Black box test cases can also be found in the ''Test'' section.

Hgala2: /* Task 2 */

2017-04-28T23:16:02Z

Task 2

← Older revision		Revision as of 23:16, 28 April 2017
Line 39:		Line 39:
	===Task 2===		===Task 2===

	(Tool #3 - Pull Request Tool) ~~Create~~ a tool that processes all of the closed pull requests for a ~~github~~ organization during a particular time period		(Tool #3 - Pull Request Tool) Created a tool that processes all of the closed pull requests for a GitHub organization during a particular time period
	* For each pull requests, we ~~will get~~ the list of commits present.		* For each pull requests, we got the list of commits present.
	* For each commit, we ~~will retrieve~~ the ~~author~~/committers present.		* For each commit, we retrieved the authors/committers present.
	* Each of the author/committer is checked with list of known author/committers. If they are new, add it to a list of new contributors. Return this list along with link to the author profiles.		* Each of the author/committer is checked with list of known author/committers. If they are new, add it to a list of new contributors. Return this list along with link to the author profiles.
	* Update the JSON file containing the known authors with the new authors.		* Update the JSON file containing the known authors with the new authors.

	Using the GitHub web API to get the commits has limitations. We can only get the last 30 commits present. However, for organizations like servo, the number of commits can be much higher. Hence, we first need to clone all the repositories present in an organization (using tool #1) and then fetch the list of commits (modified version tool #2) in order to build on our tool #3. The images below task 3 ~~show~~ how these tools come together along with a sketch plan for the pull request tool.		Using the GitHub web API to get the commits has limitations. We can only get the last 30 commits present. However, for organizations like servo, the number of commits can be much higher. Hence, we first need to clone all the repositories present in an organization (using tool #1) and then fetch the list of commits (modified version tool #2) in order to build on our tool #3. The images below task 3 shows how these tools come together along with a sketch plan for the pull request tool.

	===Task 3===		===Task 3===