CSC/ECE 517 Spring 2017/final T1701 - Revision history

Kmishra: /* Running Tests */

2017-05-04T23:16:09Z

Running Tests

← Older revision		Revision as of 23:16, 4 May 2017
Line 227:		Line 227:

	=== Running Tests ===		=== Running Tests ===
	In order to run the unit ~~test~~ and integration tests on your system, follow these steps:		In order to run the unit and integration tests on your system, follow these steps:
	* Clone the repo:		* Clone the repo:
	** git clone https://github.com/aapatel8/tago-sdk-python.git		** git clone https://github.com/aapatel8/tago-sdk-python.git

Kmishra: /* Test Plan */ adding images for services and extra module unit tests.

2017-05-04T23:13:18Z

Test Plan: adding images for services and extra module unit tests.

← Older revision		Revision as of 23:13, 4 May 2017
Line 185:		Line 185:
	This requests-mock module stubs out HTTP request part of the testing code.		This requests-mock module stubs out HTTP request part of the testing code.
	\|-		\|-
	\| '''Services Module''' \|\|		\| '''Services Module''' \|\| [[File:Services unit.png]]
	\|-		\|-
	\| '''Description''' \|\|		\| '''Description''' \|\|
Line 194:		Line 194:
	# Response returned and message asserted with the correct expected value		# Response returned and message asserted with the correct expected value
	\|-		\|-
	\| '''Extra Module''' \|\|		\| '''Extra Module''' \|\| [[File:Extra unit.png]]
	\|-		\|-
	\| '''Description''' \|\|		\| '''Description''' \|\|

Kmishra: /* Test Plan */ updating testing tool explanation.

2017-05-04T22:54:56Z

Test Plan: updating testing tool explanation.

← Older revision		Revision as of 22:54, 4 May 2017
Line 182:		Line 182:
	\| '''Test Type''' \|\| '''Unit Test'''		\| '''Test Type''' \|\| '''Unit Test'''
	\|-		\|-
	\| '''Testing Tool''' \|\| '''pytest'''		\| '''Testing Tool''' \|\| [https://docs.pytest.org/en/latest/ '''pytest'''] and [https://pypi.python.org/pypi/requests-mock '''requests-mock''']
			This requests-mock module stubs out HTTP request part of the testing code.
	\|-		\|-
	\| '''Services Module''' \|\| ~~The [https://pypi.python.org/pypi/requests-mock requests-mock] module was used to unit test services module classes.~~		\| '''Services Module''' \|\|
	~~This modules stubs out HTTP request port of the testing code.~~
	\|-		\|-
	\| '''Description''' \|\|		\| '''Description''' \|\|
Line 194:		Line 194:
	# Response returned and message asserted with the correct expected value		# Response returned and message asserted with the correct expected value
	\|-		\|-
	\| '''Extra Module''' \|\| ~~The [https://pypi.python.org/pypi/requests-mock requests-mock] module was used to unit test extra module classes.~~		\| '''Extra Module''' \|\|
	~~This modules stubs out HTTP request port of the testing code.~~
	\|-		\|-
	\| '''Description''' \|\|		\| '''Description''' \|\|

Kmishra: /* Test Plan */ updating unit test and adding integration tests.

2017-05-04T22:50:00Z

Test Plan: updating unit test and adding integration tests.

← Older revision		Revision as of 22:50, 4 May 2017
Line 184:		Line 184:
	\| '''Testing Tool''' \|\| '''pytest'''		\| '''Testing Tool''' \|\| '''pytest'''
	\|-		\|-
	\| '''Services Module''' \|\| [~~[File~~:~~Unit~~ test ~~service~~.~~jpg]]~~		\| '''Services Module''' \|\| The [https://pypi.python.org/pypi/requests-mock requests-mock] module was used to unit test services module classes.
			This modules stubs out HTTP request port of the testing code.
	\|-		\|-
	\| '''Description''' \|\|		\| '''Description''' \|\|
Line 190:		Line 191:
	# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))		# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
	# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))		# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
	# Request ~~sent~~ to ~~tago server~~		# Request is hijacked by the requests-mock stubs.
	# Response returned (~~as SMS~~) and ~~message~~ asserted with the correct expected value		# Response returned and message asserted with the correct expected value
			\|-
			\| '''Extra Module''' \|\| The [https://pypi.python.org/pypi/requests-mock requests-mock] module was used to unit test extra module classes.
			This modules stubs out HTTP request port of the testing code.
			\|-
			\| '''Description''' \|\|
			Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
			# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
			# Function called with appropriate parameters (eg. w.forecast("27516"))
			# Request is hijacked by the requests-mock stubs.
			# Response returned (Promise - success) and asserted with the correct expected value(s)
			\|-
			\| '''Test Type''' \|\| '''Integration Test'''
			\|-
			\| '''Testing Tool''' \|\| '''pytest'''
	\|-		\|-
	\| '''Extra Module''' \|\| [[File:Extra unit tests.png]]		\| '''Extra Module''' \|\| [[File:Extra unit tests.png]]
Line 199:		Line 214:
	# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))		# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
	# Function called with appropriate parameters (eg. w.forecast("27516"))		# Function called with appropriate parameters (eg. w.forecast("27516"))
	# Request sent to ~~tago~~ server		# Request sent to Third-party API server
	# Response returned (Promise - success) and asserted with the correct expected value(s)		# Response returned (Promise - success) and asserted with the correct expected value(s)
	\|-		\|-

Kmishra: /* Running Tests */

2017-05-04T21:54:30Z

Running Tests

← Older revision		Revision as of 21:54, 4 May 2017
Line 213:		Line 213:

	=== Running Tests ===		=== Running Tests ===
	In order to run the tests on your system, follow these steps:		In order to run the unit test and integration tests on your system, follow these steps:
	* Clone the repo:		* Clone the repo:
	** git clone https://github.com/aapatel8/tago-sdk-python.git		** git clone https://github.com/aapatel8/tago-sdk-python.git

Kmishra: /* Running Tests */

2017-05-04T21:53:52Z

Running Tests

← Older revision		Revision as of 21:53, 4 May 2017
Line 216:		Line 216:
	* Clone the repo:		* Clone the repo:
	** git clone https://github.com/aapatel8/tago-sdk-python.git		** git clone https://github.com/aapatel8/tago-sdk-python.git
	* Then set ~~two~~ environment ~~variables~~		* Then set environment variable
	** export TAGO_TOKEN_DEVICE=6ea148d0-e75c-11e6-a091-5756b91044c4		** export TAGO_TOKEN_DEVICE=6ea148d0-e75c-11e6-a091-5756b91044c4
	* From the top folder run		* From the top folder run

Kmishra: /* Test Plan */

2017-05-01T17:27:31Z

Test Plan

← Older revision		Revision as of 17:27, 1 May 2017
Line 211:		Line 211:
	\| '''Extra Module''' \|\| Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.		\| '''Extra Module''' \|\| Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
	\|}		\|}

			=== Running Tests ===
			In order to run the tests on your system, follow these steps:
			* Clone the repo:
			** git clone https://github.com/aapatel8/tago-sdk-python.git
			* Then set two environment variables
			** export TAGO_TOKEN_DEVICE=6ea148d0-e75c-11e6-a091-5756b91044c4
			* From the top folder run
			** python setup.py test

	==References==		==References==

Aapatel8: /* Services */

2017-04-28T02:01:57Z

Services

@@ Line 56: / Line 56: @@
 ***Message to be sent
 ***E-mail address for the receiver to reply to
 ===Third Party APIs (Extra) ===

Aapatel8: /* Design */

2017-04-28T01:18:24Z

Design

← Older revision		Revision as of 01:18, 28 April 2017
Line 24:		Line 24:
	The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.		The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

	[[File:Tago_uml_diagram.png~~\|200px~~\|center\|alt=Class diagram\|Class diagram for tago-python SDK]]		[[File:Tago_uml_diagram.png\|center\|alt=Class diagram\|Class diagram for tago-python SDK]]
	<div align="center">'''Tago-SDK Class Diagram'''</div>		<div align="center">'''Tago-SDK Class Diagram'''</div>

Aapatel8: /* Design */

2017-04-28T01:15:31Z

Design

← Older revision		Revision as of 01:15, 28 April 2017
Line 24:		Line 24:
	The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.		The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

	[[File:Tago_uml_diagram.png\|center\|alt=Class diagram\|Class diagram for tago-python SDK]]		[[File:Tago_uml_diagram.png\|200px\|center\|alt=Class diagram\|Class diagram for tago-python SDK]]
	<div align="center">'''Tago-SDK Class Diagram'''</div>		<div align="center">'''Tago-SDK Class Diagram'''</div>