Python 3 Unit tests with user input

Question

I'm absolutely brand new to Python unit test. I need to use it for a project I have to submit. I sort of have an idea of where to begin, it looks like we basically put in test parameters to functions we have defined in our program and we enter the expected result. If the expected result is output, we get OK, otherwise we will get Failure, or an error.

So my problem is that I have multiple user inputs stored into variables that are within for loops or while loops. I don't know where to even begin with this to set test values in for them.

Here is all of my code:

studentTripExpenses = {}

def dictCreate(studentAmount):
    for i in range(0, studentAmount):
        studentName = input("What is the name of the student? ")
        expenseList = []
        print("Enter 'done' to move to the next student.")
        while True:
            expense = input("What is the cost of this expense? ")
            if expense.lower() == 'done':
                break
            elif (float(expense) >= 0) or (float(expense) < 0):
                expenseList.append(float(expense))
            elif not expense.isdigit():
                print("Please enter a number or enter 'done' to move on.")
        studentTripExpenses[studentName] = expenseList
    return studentTripExpenses

def studentCost(dct):
    for i in dct:
        #Variable for individual costs of student
        personalCost = 0
        #Determines the total cost for each student
        for x in dct[i]:
            personalCost = personalCost + x
        #Sets each students value to their total cost to two decimal places
        dct[i] = float("%.2f" % personalCost)
    return dct

def amountsDue(expenseLst, studentAvgPrice):
        #Runs through the dictionary of students and individual total trip costs
        for key in expenseLst:
            maxPerson = max(expenseLst, key=expenseLst.get)
            costDifference = 0
            #Determines who owes who how much money
            if max(expenseLst.values()) > expenseLst[key]:
                costDifference = studentAvgPrice-expenseLst[key]
                if (costDifference < 0):
                    costDifference = costDifference * -1
                print("%s owes %s $%.2f" % (key, maxPerson, costDifference))

def main():
    numOfStudents = int(input("How many students are going on the trip? "))
    studentCostDict = dictCreate(numOfStudents)
    studentTripExpenses = studentCost(studentCostDict)

    totalCost = 0

    #Gets the total cost for all students
    for key in (studentTripExpenses):
        totalCost = totalCost + studentTripExpenses[key]

    #Changes the total cost to 2 decimal places
    totalCost = float("%.2f" % totalCost)

    #Determines the average amount spent per student
    avgCost = float("%.2f" % (totalCost/len(studentTripExpenses)))

    amountsDue(studentTripExpenses, avgCost)

main()

Martijn Pieters · Accepted Answer · 2017-12-07 08:10:58Z

32

You can use mocking, where you replace a function or class with a test-supplied version. You can do this with the unittest.mock() module.

In this case, you can patch the input() name in your module; instead of the built-in function, the mock object will be called:

from unittest import mock
from unittest import TestCase
import module_under_test

class DictCreateTests(TestCase):
    @mock.patch('module_under_test.input', create=True)
    def testdictCreateSimple(self, mocked_input):
        mocked_input.side_effect = ['Albert Einstein', '42.81', 'done']
        result = dictCreate(1)
        self.assertEqual(result, {'Albert Einstein': [42.81]})

Because input doesn't exist in your module (it is a built-in function), I told the mock.patch() decorator to create the name; now this input will be used instead of the built-in function.

The side_effect attribute lets you state multiple results; each time the mock is called, it'll return the next value in that list. So the first time 'Albert Einstein' is returned, the next time '42.81', etc.

Together, this lets you simulate actual user inputs.

If you do your test right, you'll notice that there is a bug in your function; the float() call will throw a ValueError exception when anything other than done or a valid numeric value is entered. You need to rework your code to account for that. Try with mocked_input.side_effect = ['Albert Einstein', 'Not an expense', '42.81', 'done'] to trigger the bug.

edited Dec 7, 2017 at 8:10

answered Dec 7, 2017 at 8:00

Martijn Pieters

1.1m326 gold badges4.2k silver badges3.4k bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Brystephor Over a year ago

Hi there! First off, thanks @martijn So the code worked out great. I got it to work with some slight modifications that I assume you meant for me to do. I changed 'module_under_test' to the name of the file I'm testing and then it worked. So to be clear on the 'side_effect' attribute, whatever I enter for it, it basically reads from left to right and enters in each item as if it was user input? The bug you showed was correct to! I see that now for my code and appreciate the insight! I can see what this unit testing is useful for now.

Martijn Pieters Over a year ago

@Brystephor: yes, you didn't specify a module name, so I used one that I hoped would be obvious as a placeholder. The side_effect takes values from the list, and list literals are ordered from left to right, yes.

Nandini Raja · Accepted Answer · 2022-11-08 14:46:20Z

In case we do not have classes.

In the names.py file, we have the get_names function.

def get_names() -> list:
    names = [str(input("Enter name: "))]
    while str(input("Do you want to add another name")) == "Y":
        names.append(str(input("Enter name: ")))
    return categories

In the test_names.py file, we can write test like the following

import numpy as np
from unittest import mock
from src.main.names import get_names

@mock.patch('src.main.names.input', create=True)
def test_should_get_names_from_users(mocked_input):
    mocked_input.side_effect = ["John", "Y", "Robert", "N"]
    actual_names = get_names()
    expected_names = ['John', "Robert"]
    assert actual_names == expected_names

Collectives™ on Stack Overflow

Python 3 Unit tests with user input

2 Answers 2

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related