Nancyvarkey at 05:14, 2 November 2018

2018-11-02T05:14:57Z

Nirmala Venkat at 07:49, 24 October 2018

2018-10-24T07:49:34Z

Priyacst: Created page with "'''Title of script''': '''Testing and debugging''' '''Author: Puneeth, Thirumalesh H S, Arun KP''' '''Keywords: Python, Ipython, testing, debugging, automate test, coding st..."

2018-10-24T06:19:58Z

Created page with "'''Title of script''': '''Testing and debugging''' '''Author: Puneeth, Thirumalesh H S, Arun KP''' '''Keywords: Python, Ipython, testing, debugging, automate test, coding st..."

New page

'''Title of script''': '''Testing and debugging'''

'''Author: Puneeth, Thirumalesh H S, Arun KP'''

'''Keywords: Python, Ipython, testing, debugging, automate test, coding style, python community, video tutorial'''

{| style="border-spacing:0;"
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| '''Visual Cue'''
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| '''Narration'''

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide title
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Welcome to the spoken tutorial on '''Testing and debugging'''.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

Objectives

| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| In this tutorial, you will,

* Understand what is '''software''' '''testing'''
* Test simple '''functions''' for their '''functionality'''
* '''Automate''' '''tests'''
* Understand the need for '''coding''' '''style''' and
* Learn some of the '''standards''' followed by the '''Python''' '''Community'''

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

System Specifications
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| To record this tutorial, I am using

* '''Ubuntu Linux 16.04''' operating system
* '''Python 3.4.3'''
* '''IPython 5.1.0''' and
* '''Gedit text editor'''

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

Prerequisite
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| To practise this tutorial, you should know how to

* use''' functions.'''

If not, see the relevant '''Python''' tutorials on this website.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

Software Testing

| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| First we will learn about software testing.

'''Software''' '''testing''' is the process to evaluate the functionality of a software or a '''program.'''

It helps to find whether the program met the specified requirements or not.

It ensures a defect free program so that we will get a quality program.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show slide:

Source code

| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| All the codes used in this tutorial are available in the '''Code Files''' link of this tutorial.

You should download in the current working directory and use them.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| gcd function

'''def gcd(a, b): if b == 0:''' ''' return a''' '''return gcd(b, a%b)'''

Highlight def gcd(a,b):''' '''
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Open any text editor and type the following code.

This is a simple '''function''' to calculate '''gcd''' of two numbers.

We need a set of '''inputs''' for the variable a and b.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Save the file find_gcd.py
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Save the file as '''find''''' underscore '''''gcd.py '''in the current working '''directory'''.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| '''Open '''the''' file test_gcd.py'''
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Next we will open''' '''the''' '''file''' test''''' underscore '''''gcd.py.'''

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| '''from find_gcd import gcd'''

'''if __name__ == '__main__':'''

'''result = gcd(48, 64)'''

'''if result != 16:'''

'''print("Test failed")'''

'''print("Test Passed")'''
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Let our test case be 48 and 64 as '''''a''' ''and '''''b.'''''

For this test case we know that the GCD is 16.

So that is the expected '''output'''.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| <nowiki>[Terminal]</nowiki>

'''python3 test_gcd.py'''

| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Let us now run the '''script''' and '''test''' our '''code'''.

Open the terminal and type

'''python3 test''''' underscore '''''gcd.py'''

We get the '''output''' as '''''Test''' '''Passed'''' which means our '''code''' is correct.''' '''

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"|
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| But there can be a number of cases where the '''gcd''' '''function''' might break.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Slide: Test cases
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| So to check where our code is breaking we should run many tests.

This is where the concept of automating tests comes in.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Open the file '''testcases.txt''' and show
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Let us first try and automate tests on the '''gcd''' '''function.'''

Open the file''' textcases.txt''' where the various testing parameters are given.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Open '''testcases.txt'''

12 28 4

18 36 18

4678 39763 2339
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| The structure of the file will have two '''input''' '''parameters'''.

The third '''parameter''' is the correct '''output''' '''result'''.

We have separated the elements by a space.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Open '''automate_test_gcd.py'''
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Next let us open the file''' automate''''' underscore '''''test''''' underscore '''''gcd.py'''

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| '''Highlight the code:'''

from find_gcd import gcd

if __name__ == '__main__':

for line in open('testcases.txt'):

numbers = line.split()

<nowiki>x, y = int(numbers[0]) , int(numbers[1])</nowiki>

<nowiki>result = int(numbers[2])</nowiki>

if gcd(x, y) != result:

print ("Failed gcd test for", x, y)

else:

print ("Test passed", result)

| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| First we need '''import gcd''' function from '''find''''' underscore '''''gcd''' in order to use it for testing.

Next the '''testcases.txt '''file is read line by line.

The first two '''input''' '''parameters''' are assigned to the variables '''x '''and''' y. '''

The third '''parameter''' which is the correct '''output''' value is assigned to the variable '''result'''.

We check whether the value returned by the '''gcd function '''is equal to the value in the variable''' result.'''

Finally it prints the message accordingly.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| In the '''terminal, '''type

'''python3 automate_test_gcd.py'''
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| In the '''terminal, '''type

'''python3 automate''''' underscore '''''test''''' underscore '''''gcd.py'''

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Point to the output
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| As you can see, all the three test cases in '''testcases.txt''' are passed.

The value calculated by the gcd function is equal to the output value provided in the '''testcases.txt.'''

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"|
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Pause the video.

Try this exercise and then resume the video.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide''' '''

Assignment 1

| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| For the same inputs as '''gcd''' write '''automated''' '''tests''' for '''LCM'''.

Use the data from the file '''lcmtestcases.txt'''

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Switch terminal
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Switch to the terminal for the solution.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Open the find_lcm.py

Open '''lcmtestcases.txt'''

| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Let us see the code to calculate '''lcd''' of two numbers.

The file name is '''find''' ''underscore'' '''lcm.py'''

This is the data file for the '''lcm''' test cases.

This file name is '''lcmtestcases.txt'''

Note that both these files should be in the current working directory.

Let us now run the '''script''' and '''test''' our '''code'''.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Type '''python3 find_lcm.py'''
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Type '''python3 find''''' underscore '''''lcm.py'''

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Open '''find_lcm.py '''and show.

<nowiki>[Terminal]</nowiki>

'''python3 find_lcm.py'''
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Here, the third test case failed.

Because the corresponding input in '''lcmtestcases.txt''' is incorrect.

This is to check the behavior of the program on incorrect conditions.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

Coding Style
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| * A good '''program''' should be '''readable.'''
* So others can extend and improve it.
* '''Code''' is read more often than it is written.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

Meaningfull names

| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| We choose a name so that it becomes easier to understand its usage.

Let’s look at this with an example.

As we can see in the example,

it is very easy to understand what the '''code''' is doing.

Proper naming helps so much in understanding the '''code'''.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

Coding Instructions
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Also one should keep in mind the following things while writing a code in Python.

* '''Four Space Indentation '''
* 79 characters limit on a line
* '''Functions''' and '''methods''' should be separated with two '''blank''' '''lines'''.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

Code Instructions
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| * Use '''Docstring''' to document a specific segment of code.
* Use '''whitespace''' around '''operators''' and after punctuations.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

Summary
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| This brings us to the end of this tutorial. Let us summarize.

In this tutorial, we have learnt to,

* Create simple '''tests''' for a '''function'''
* '''Automate''' '''tests''' using many '''predefined''' '''test''' '''cases''' and
* Use '''python''' '''coding''' '''standards'''.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

Self assessment questions
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Here is a self assessment question for you to solve

# What is the proper indentation for python code according to the style guidelines?

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide Solutions
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| And the answer,

# '''Four''' '''Space''' '''Indentation''' is required for writing a python code according to the style guidelines.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide Forum
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Please post your timed queries in this forum.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide Fossee Forum
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Please post your general queries on Python in this forum.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Slide Textbook Companion
| style="background-color:#ffffff;border:0.5pt solid #000001;padding:0.106cm;"| FOSSEE team coordinates the TBC project.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Show Slide

Acknowledgment

http://spoken-tutorial.org
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Spoken Tutorial Project is funded by NMEICT, MHRD, Govt. of India.

For more details, visit this website.

|-
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| Previous slide
| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"| This is Priya from IIT Bombay signing off.

Thanks for watching.

|}

← Older revision		Revision as of 07:49, 24 October 2018
Line 329:		Line 329:

	\| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"\| We choose a name so that it becomes easier to understand its usage.		\| style="background-color:#ffffff;border:0.5pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.097cm;padding-right:0.191cm;"\| We choose a name so that it becomes easier to understand its usage.
−
−
−	~~Let’s look at this with an example.~~

Python-3.4.3/C4/Testing-and-Debugging/English - Revision history

Nancyvarkey at 05:14, 2 November 2018

Nirmala Venkat at 07:49, 24 October 2018

Priyacst: Created page with "'''Title of script''': '''Testing and debugging''' '''Author: Puneeth, Thirumalesh H S, Arun KP''' '''Keywords: Python, Ipython, testing, debugging, automate test, coding st..."