How to test while-loop (once) with nosetest (Python 2.7)

Question

I'm pretty new to this whole "programming thing" but at age 34 I thought that I'd like to learn the basics. I unfortunately don't know any python programmers. I'm learning programming due to personal interest (and more and more for the fun of it) but my "social habitat" is not "where the programmers roam" ;) . I'm almost finished with Zed Shaws "Learn Python the Hard Way" and for the first time I can't figure out a solution to a problem. The last two days I didn't even stumble upon useful hints where to look when I repeatedly rephrased (and searched for) my question. So stackoverflow seems to be the right place. Btw.: I lack also the correct vocabular quite often so please don't hesitate to correct me :) . This may be one reason why I can't find an answer. I use Python 2.7 and nosetests.

How far I solved the problem (I think) in the steps I solved it:

Function 1:

def inp_1():
    s = raw_input(">>> ")
    return s

All tests import the following to be able to do the things below:

from nose.tools import *
import sys
from StringIO import StringIO
from mock import *
import __builtin__
# and of course the module with the functions

Here is the test for inp_1:

import __builtin__
from mock import *

def test_inp_1():
    __builtin__.raw_input = Mock(return_value="foo")
    assert_equal(inp_1(), 'foo')

This function/test is ok.

Quite similar is the following function 2:

def inp_2():
    s = raw_input(">>> ")
    if s == '1':
        return s
    else:
        print "wrong"

Test:

def test_inp_2():
    __builtin__.raw_input = Mock(return_value="1")
    assert_equal(inp_1(), '1')

    __builtin__.raw_input = Mock(return_value="foo")
    out = StringIO()
    sys.stdout = out
    inp_1()
    output = out.getvalue().strip()
    assert_equal(output, 'wrong')

This function/test is also ok.

Please don't assume that I really know what is happening "behind the scenes" when I use all the stuff above. I have some layman-explanations how this is all functioning and why I get the results I want but I also have the feeling that these explanations may not be entirely true. It wouldn't be the first time that how I think sth. works turns out to be different after I've learned more. Especially everything with "__" confuses me and I'm scared to use it since I don't really understand what's going on. Anyway, now I "just" want to add a while-loop to ask for input until it is correct:

def inp_3():
    while True:
        s = raw_input(">>> ")
        if s == '1':
            return s
        else:
            print "wrong"

The test for inp_3 I thought would be the same as for inp_2 . At least I am not getting error messages. But the output is the following:

$ nosetests
......

     # <- Here I press ENTER to provoke a reaction
     # Nothing is happening though.

^C   # <- Keyboard interrupt (is this the correct word for it?)
----------------------------------------------------------------------
Ran 7 tests in 5.464s

OK
$ 

The other 7 tests are sth. else (and ok). The test for inp_3 would be test nr. 8. The time is just the times passed until I press CTRL-C. I don't understand why I don't get error- or "test failed"-meassages but just an "ok".

So beside the fact that you may be able to point out bad syntax and other things that can be improved (I really would appreciate it, if you would do this), my question is:

How can I test and abort while-loops with nosetest?

Answer 1

So, the problem here is when you call inp_3 in test for second time, while mocking raw_input with Mock(return_value="foo"). Your inp_3 function runs infinite loop (while True) , and you're not interrupting it in any way except for if s == '1' condition. So with Mock(return_value="foo") that condition is never satisfied, and you loop keeps running until you interrupt it with outer means (Ctrl + C in your example). If it's intentional behavior, then How to limit execution time of a function call in Python will help you to limit execution time of inp_3 in test. However, in cases of input like in your example, developers often implement a limit to how many input attempts user have. You can do it with using variable to count attempts and when it reaches max, loop should be stopped.

def inp_3():
    max_attempts = 5
    attempts = 0
    while True:
        s = raw_input(">>> ")
        attempts += 1 # this is equal to "attempts = attempts + 1"
        if s == '1':
            return s
        else:
            print "wrong"
            if attempts == max_attempts:
                print "Max attempts used, stopping."
                break # this is used to stop loop execution
                # and go to next instruction after loop block

    print "Stopped."

Also, to learn python I can recommend book "Learning Python" by Mark Lutz. It greatly explains basics of python.

UPDATE:

I couldn't find a way to mock python's True (or a builtin.True) (and yea, that sounds a bit crazy), looks like python didn't (and won't) allow me to do this. However, to achieve exactly what you desire, to run infinite loop once, you can use a little hack.

Define a function to return True

def true_func():
    return True

, use it in while loop

while true_func():

and then mock it in test with such logic:

def true_once():
    yield True
    yield False


class MockTrueFunc(object):
    def __init__(self):
        self.gen = true_once()

    def __call__(self):
        return self.gen.next()

Then in test:

true_func = MockTrueFunc()

With this your loop will run only once. However, this construction uses a few advanced python tricks, like generators, "__" methods etc. So use it carefully.

But anyway, generally infinite loops considered to be bad design solutions. Better to not getting used to it :).

Answer 2

It's always important to remind me that infinite loops are bad. So thank you for that and even more so for the short example how to make it better. I will do that whenever possible.

However, in the actual program the infinite loop is how I'd like to do it this time. The code here is just the simplified problem. I very much appreciate your idea with the modified "true function". I never would have thought about that and thus I learned a new "method" how tackle programming problems :) . It is still not the way I would like to do it this time, but this was the so important clue I needed to solve my problem with existing methods. I never would have thought about returning a different value the 2nd time I call the same method. It's so simple and brilliant it's astonishing me :).

The mock-module has some features that allows a different value to be returned each time the mocked method is called - side effect .

side_effect can also be set to […] an iterable. [when] your mock is going to be called several times, and you want each call to return a different value. When you set side_effect to an iterable every call to the mock returns the next value from the iterable:

The while-loop HAS an "exit" (is this the correct term for it?). It just needs the '1' as input. I will use this to exit the loop.

def test_inp_3():
    # Test if input is correct
    __builtin__.raw_input = Mock(return_value="1")
    assert_equal(inp_1(), '1')

    # Test if output is correct if input is correct two times.
    # The third time the input is corrct to exit the loop.
    __builtin__.raw_input = Mock(side_effect=['foo', 'bar', '1'])
    out = StringIO()
    sys.stdout = out
    inp_3()
    output = out.getvalue().strip()

    # Make sure to compare as many times as the loop 
    # is "used".
    assert_equal(output, 'wrong\nwrong')

Now the test runs and returns "ok" or an error e.g. if the first input already exits the loop.

Thank you very much again for the help. That made my day :)