20.8. Unit Tests

Now that you have learned about classes and inheritance we can explain how to write your own unit tests.

20.8.1. Testing your Code

How do you test that your program worked? You may put in print statements about what you expect the output to be and compare that to what you actually get to see if your code is correct.

In fact in test-driven development you should write test cases before you start writing any code. That way you will know when your code works.

Run the code below to see what it prints.

# Return the total of the even numbers in a list of numbers called nums def total_even(nums): total = 0 for num in nums: if num % 2 == 0: total += num return total # Test cases for total_even def test(): print(f"Testing total_even([1, 2]) should return 2 and returns {total_even([1, 2])}") print(f"Testing total_even([1, 3]) should return 0 and returns {total_even([1, 3])}") print(f"Testing total_even([2, 6]) should return 8 and returns {total_even([2, 6])}") print(f"Testing total_even([2, 3, 4]) should return 6 and returns {total_even([2, 3, 4])}") print(f"Testing total_even([]) should return 0 and returns {total_even([])}") print(f"Testing total_even([1]) should return 0 and returns {total_even([1])}") print(f"Testing total_even([2]) should return 2 and returns {total_even([2])}") # function call test()

This type of test is better than just printing out actual output because then you have to think about what the correct value should be. It lets you quickly compare the expected value and the actual value. However, you have to visually compare the two, which takes some time and you could miss something that doesn’t match.

Note

The tests above are using a f-string which is an easier way to create a string with expression results in the string. Just add f before the start of the string and {expression} in the string.

Another way to write the code above would be to use a list comprehension. These are a quick way to return a new list by applying some logic to each element of the list.

result_list = [returned_value for item in list logic]

Run the code below to see what it prints.

# Return the total of the even numbers in a list of numbers called nums def total_even(nums): evens = [num for num in nums if num % 2 == 0] return sum(evens) # Test cases for total_even def test(): print(f"Testing total_even([1, 2]) should return 2 and returns {total_even([1, 2])}") print(f"Testing total_even([1, 3]) should return 0 and returns {total_even([1, 3])}") print(f"Testing total_even([2, 6]) should return 8 and returns {total_even([2, 6])}") print(f"Testing total_even([2, 3, 4]) should return 6 and returns {total_even([2, 3, 4])}") print(f"Testing total_even([]) should return 0 and returns {total_even([])}") print(f"Testing total_even([1]) should return 0 and returns {total_even([1])}") print(f"Testing total_even([2]) should return 2 and returns {total_even([2])}") # function call test()

20.8.2. Creating Test Cases

What types of tests should you create? You should create tests that check that the function works for a variety of normal input. You should also think about how to handle unusual input such as checking that total_even works even for an empty list or a list with only one item.

20.8.3. Understanding Unit Tests

Another way to test your code is to write unit tests. You have already been using hidden unit tests in this ebook to check your code as shown below. You probably quickly realized that you wanted all the tests to “pass” which is highlighted in green. This gives you an even quicker visual indication that your code is working than having to compare the expected output to the actual.

Let’s look at the unit tests that have usually been hidden.

Run the code below to see the unit tests again. See the unit tests after the code. The last unit test compares the result of recPerimeter(3.0, 2) to wrong value. Fix the value so that all of the tests pass.

def recPerimeter(length, width): perimeter = 2 * (length + width) return perimeter from unittest.gui import TestCaseGui class myTests(TestCaseGui): def testOne(self): self.assertEqual(recPerimeter(10, 20),60,"Tested recPerimeter on inputs 10 and 20") self.assertEqual(recPerimeter(1, 2),6,"Tested recPerimeter on inputs 1 and 2") self.assertEqual(recPerimeter(23.2, 12.3),71,"Tested recPerimeter on inputs 23.2 and 12.3") self.assertEqual(recPerimeter(3.0, 2),12,"Tested recPerimeter on inputs 3.0 and 2") myTests().main()

Look at the unit tests above and answer the questions below.

Run the code below to see what the unit tests do and then add another test to test the result when x is higher than y.

def checkValue(x, y): if x < y: return "lower" elif x == y: return "equal" else: return "higher" from unittest.gui import TestCaseGui class myTests(TestCaseGui): def test_checkValue(self): self.assertEqual(checkValue(3, 5), "lower", 'checkValue(3, 5)') self.assertEqual(checkValue(5, 5), "equal", 'checkValue(5, 5)') myTests().main()

Fix the function below to return the middle characters from the passed string. If the string has an odd length then return the middle character. If the string has an even length return the two middle characters. For example, get_middle('abc') returns 'b' and get_middle('abcd') returns 'bc'. Also add tests cases to test the result when str has only one or two characters in it.

def get_middle(str): len_s = len(str) mid = len_s // 2 if len_s % 2 == 0: return str[mid - 1: mid + 1] else: return str from unittest.gui import TestCaseGui class myTests(TestCaseGui): def testOne(self): self.assertEqual(get_middle('abc'), 'b', "get_middle('abc')") self.assertEqual(get_middle('abcd'), 'bc', "get_middle('abcd')") self.assertEqual(get_middle('12345'), '3', "get_middle('12345')") self.assertEqual(get_middle('123456'), '34', "get_middle('123456')") myTests().main()

Add tests to check the result when str has one or two letters.

Note

Unit tests in this ebook must include the line from unittest.gui import TestCaseGui and inherit from TestCaseGui. Outside of this ebook you should include the line import unittest and inherit from unittest.TestCase.

Unit tests inherit from a class that includes several methods. As you can see from the code above one of the methods is assertEqual which returns the result of a == b.

Q-8: Drag each method to what it returns. Read this page and try again.
• assertTrue(x)
• x == True
• assertIn(a, b)
• a in b
• assertIsInstance(a, b)
• isinstance(a, b)
• assertEqual(a, b)
• a == b
• assertNotEqual(a, b)
• a != b
• assertFalse(x)
• x == False

Note

All of the assert methods can take a third parameter which is a message (string) that explains what was tested.

20.8.4. Writing Unit Tests

To write a unit test you need to do the following.

1. Import the library (from unittest.gui import TestCaseGui in this ebook and import unittest elsewhere)

2. Create a class that inherits from the correct class (TestCaseGui in this ebook and unittest.TestCase elsewhere )

3. Optionally create a setUp method which is called before every test method is run.

4. Create one or more methods that start with test to test different things in your code

   • Test one or more results using assert methods such as self.assertEqual

5. Optionally create a tearDown method which is called after every test method is run

6. Run the tests using ClassName.main() in the ebook and otherwise unittest.main()

Note

The order that the tests run is not the order they are defined.

Fix the code below to run and notice the test results.

class Car: def __init__(self, make, model, color): self.make = make model = model self.color = color def __str__(self) return f"{self.make} {self.model} {self.color}" def set_color(self, new_color): self.color = new_color from unittest.gui import TestCaseGui class myTests(TestCaseGui): def setUp(): self.c1 = Car("Ford", "Volt", "blue") self.c2 = Car("Toyota", "Prius", "red") def testInitAndStr(self): self.assertEqual(c1.__str__(), 'Ford Volt blue', "Test of init and str") self.assertEqual(self.c2.__str__(), 'Toyota Prius red', "Test of init and str") def testSetColor(self): # try to set the color self.c1.set_color("white") # check that it changed to the new color self.assertEqual(self.c1.color, "white", "Test of set color") myTests().main()

Modify the code above to add a method in the Car class to set (change) the model name and add a test method to test that the new method works.

Put the code in order to create tests for a Person class initials method that returns the first letter from the first name followed by the first letter of the last name. The Person class initializer takes the person’s first name and last name. First define a setUp method to create two Person objects and then define the test_initials method.

        import unittest
---
class TestPerson(unittest.TestCase):
---
class TestPerson(TestCase): #paired
---
    def setUp(self):
---
    def setUp(): #paired
---
        self.p1 = Person("Lionel", "Roberts")
---
        self.p2 = Person("Kayla", "Wig")
---
        p2 = Person("Kayla", "Wig") #paired
---
    def test_initials(self):
---
        p1i = self.p1.initials()
        self.assertEqual(p1i, "LR", "p1.initials()")
        p2i = self.p2.initials()
        self.assertEqual(p2i, "KW", "p2.initials()")
        

You have attempted of activities on this page