Mailroom with full test coverage!

Author: Eowyn42

students/eowyn/session06/mailroom/mailroom.py

@@ -2,9 +2,10 @@
 
 import sys
 
-''' --------------------------------------------------------------
-GLOBAL VARIABLE: DONORS is the database of donor names, amounts
--------------------------------------------------------------------'''
+#  --------------------------------------------------------------
+# GLOBAL VARIABLE: DONORS is the database of donor names, amounts
+# -------------------------------------------------------------------
+
 donor_names = ["Margaret Atwood", "Fred Armisen",
                "Heinz the Baron Krauss von Espy"]
 donations = [[300, 555], [240, 422, 1000], [1500, 2300]]
@@ -13,9 +14,9 @@
 del donations
 
 
-''' --------------------------------------------------------------
-Following are helper functions to control program flow
--------------------------------------------------------------------'''
+# --------------------------------------------------------------
+# Following are helper functions to control program flow
+# -------------------------------------------------------------------
 
 
 def safe_input():
@@ -31,9 +32,9 @@ def return_to_menu():
     return True
 
 
-''' --------------------------------------------------------------
-Following are helper functions for generating reports
--------------------------------------------------------------------'''
+# --------------------------------------------------------------
+# Following are helper functions for generating reports
+# -------------------------------------------------------------------
 
 
 def generate_report_data():
@@ -80,10 +81,10 @@ def print_table(list_data):
     print(setup_body(list_data))
 
 
-''' --------------------------------------------------------------
-Following are helper functions for adding donations to DONORS and
-sending thank you notes to donors
--------------------------------------------------------------------'''
+# --------------------------------------------------------------
+# Following are helper functions for adding donations to DONORS and
+# sending thank you notes to donors
+# -------------------------------------------------------------------
 
 
 def collect_donor_input():
@@ -117,8 +118,13 @@ def update_donors():
 
 def list_donors():
     ''' List all DONORS '''
-    print("All Donors:")
-    [print(x) for x in DONORS]
+    print(make_donor_list())
+
+
+def make_donor_list():
+    ''' generate string of donor names '''
+    outputstr = ""
+    return ("Donor Names:" + "".join([outputstr + '\n' + x for x in DONORS]))
 
 
 def generate_letter(donor_name):
@@ -130,10 +136,10 @@ def generate_letter(donor_name):
     return fs.format(donor_name, DONORS[donor_name][-1])
 
 
-''' --------------------------------------------------------------
-Following are helper functions for accepting and responding to
-keyboard input
--------------------------------------------------------------------'''
+# --------------------------------------------------------------
+# Following are helper functions for accepting and responding to
+# keyboard input
+# -------------------------------------------------------------------
 
 
 def remove_inputquotes(a_string):
@@ -156,14 +162,14 @@ def select_action(arg_dict, answer):
     ''' Execute an action from arg_dict that corresponds to answer.
     Return None if action was executed and False if an error occurs'''
     try:
-        return arg_dict.get(answer)()
-    except (KeyError, TypeError):
+        return arg_dict[answer]()
+    except (KeyError):
         return False
 
 
-''' --------------------------------------------------------------
-Following are primary actions called by MAINLOOP
--------------------------------------------------------------------'''
+# --------------------------------------------------------------
+# Following are primary actions called by MAINLOOP
+# --------------------------------------------------------------
 
 
 def send_letters():
@@ -175,6 +181,15 @@ def send_letters():
     print("Successfully saved letters for each donor.")
 
 
+def run_interactive_loop(arg_dict, prompt_string):
+    while True:
+        answer = get_user_input(prompt_string)
+        if answer:
+            result = select_action(arg_dict, answer)
+            if result:
+                    return
+
+
 def thank_you_loop():
     ''' Primary loop to update and thank DONORS
     update DONORS, print donor names, or return to main menu
@@ -184,12 +199,7 @@ def thank_you_loop():
     (1) Update donor and send thank-you\n
     (2) List all existing DONORS\n
     (3) Return to main menu\n >"""
-    while True:
-        answer = get_user_input(prompt_string)
-        if answer:
-            result = select_action(arg_dict, answer)
-            if result:
-                    return
+    run_interactive_loop(arg_dict, prompt_string)
 
 
 def print_report_loop():
@@ -200,17 +210,12 @@ def print_report_loop():
     prompt_string = """Select one:\n
     (1) Generate a summary report\n
     (2) Return to the main menu\n"""
-    while True:
-        answer = get_user_input(prompt_string)
-        if answer:
-            result = select_action(arg_dict, answer)
-            if result:
-                    return
+    run_interactive_loop(arg_dict, prompt_string)
 
 
-''' --------------------------------------------------------------
-The MAINLOOP to control the entire program
--------------------------------------------------------------------'''
+# --------------------------------------------------------------
+# The MAINLOOP to control the entire program
+# -------------------------------------------------------------------
 
 
 def mainloop():
@@ -224,12 +229,7 @@ def mainloop():
     (2) Create a Report\n
     (3) Send letters to everyone\n
     (4) Quit\n>"""
-    while True:
-        answer = get_user_input(prompt_string)
-        if answer:
-            result = select_action(arg_dict, answer)
-            if result:
-                continue
+    run_interactive_loop(arg_dict, prompt_string)
 
 
 if __name__ == "__main__":

students/eowyn/session06/mailroom/test_mailroom.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
 
 import mailroom
-import pytest
 import os.path
 
 
@@ -15,53 +14,49 @@ def test_return_to_menu():
     assert result is True
 
 
-def test_remove_inputquotes():
-    astring = "'hello'"
-    output = 'hello'
-    assert mailroom.remove_inputquotes(astring) == output
-
-
 def test_generate_letter():
     mailroom.DONORS = {'Fred Armisen': [240, 422, 1000],
                        'Heinz the Baron Krauss von Espy': [1500, 2300],
                        'Margaret Atwood': [300, 555]}
-    output = 'Thank you, Margaret Atwood, for your generosity and recent gift of $555.'
-    assert mailroom.generate_letter('Margaret Atwood') == output
+    returnval = mailroom.generate_letter('Margaret Atwood')
+    assert "Margaret Atwood" in returnval
+    assert "$555" in returnval
 
 
 def test_generate_report_data():
     mailroom.DONORS = {'Fred Armisen': [240, 422, 1000],
                        'Heinz the Baron Krauss von Espy': [1500, 2300],
                        'Margaret Atwood': [300, 555]}
-    output = [('Heinz the Baron Krauss von Espy', 3800, 2, 1900),
-              ('Fred Armisen', 1662, 3, 554),
-              ('Margaret Atwood', 855, 2, 428)]
-    assert mailroom.generate_report_data() == output
+    returnval = set(mailroom.generate_report_data())
+    assert len(mailroom.DONORS) == len(returnval)
+    assert ('Fred Armisen', 1662, 3, 554) in returnval
 
 
 def test_setup_table():
-    ''' this is not working'''
-    output = """'Donor Name                              |
-    Total Given |Num Gifts |Average Gift'\n,
-    '----------------------------------------
-    -------------------------------------'"""
-    assert mailroom.setup_table() == output
+    returnval = mailroom.setup_table()
+    assert returnval.startswith("Donor Name")
+    assert "Total Given" in returnval
+    assert "Num Gifts" in returnval
+    assert "Average Gift" in returnval
 
 
 def test_setup_body():
-    ''' this is not working'''
+    mailroom.DONORS = {'Fred Armisen': [240, 422, 1000],
+                       'Heinz the Baron Krauss von Espy': [1500, 2300],
+                       'Margaret Atwood': [300, 555]}
     list_data = mailroom.generate_report_data()
-    output = """'Heinz the Baron Krauss von Espy         $  3800.00        2      $  1900.00   \nFred Armisen                            $  1662.00
-3      $   554.00   \nMargaret Atwood                         $   855.00        2      $   428.00   \n'
-"""
-    assert mailroom.setup_body(list_data) == output
+    returnval = mailroom.setup_body(list_data)
+    nlines = returnval.count('\n')
+    assert "Margaret Atwood" in returnval
+    assert "Fred Armisen" in returnval
+    assert nlines == len(mailroom.DONORS)
+
 
 def test_remove_inputquotes():
     output = 'hello'
     assert mailroom.remove_inputquotes("hello") == output
 
 
-
 def test_retrieve_donor_exists():
     mailroom.DONORS = {'Fred Armisen': [240, 422, 1000],
                        'Heinz the Baron Krauss von Espy': [1500, 2300],
@@ -70,13 +65,12 @@ def test_retrieve_donor_exists():
     output = [300, 555]
     assert mailroom.retrieve_donations(name) == output
 
+
 def test_retrieve_donations_new():
     mailroom.DONORS = {'Fred Armisen': [240, 422, 1000],
                        'Heinz the Baron Krauss von Espy': [1500, 2300],
                        'Margaret Atwood': [300, 555]}
-    name = "Paul Simon"
-    output = None
-    assert mailroom.retrieve_donations(name) == output
+    assert mailroom.retrieve_donations("Paul Simon") is None
 
 
 def test_add_donation_new():
@@ -96,27 +90,42 @@ def test_add_donation_existing():
     name = "Fred Armisen"
     amount = 500
     mailroom.add_donation(name, amount)
-    assert mailroom.retrieve_donations(name) == [240, 422, 1000, 500]
-
-
-def test_select_action1():
-    ''' not sure how to test if correct action was completed
-    something called "mock" has this capability?'''
-    pass
+    assert mailroom.retrieve_donations(name)[-1] == amount
 
 
 def test_file_existance():
     mailroom.DONORS = {'Fred Armisen': [240, 422, 1000],
                        'Heinz the Baron Krauss von Espy': [1500, 2300],
                        'Margaret Atwood': [300, 555]}
     mailroom.send_letters()
-    c1 = os.path.isfile("Margaret_Atwood.txt")
-    c2 = os.path.isfile("Fred_Armisen.txt")
-    c3 = os.path.isfile("Heinz_the_Baron_Krauss_von_Espy.txt")
-    output = c1 and c2 and c3
-    assert output is True
+    assert os.path.isfile("Margaret_Atwood.txt")
+    assert os.path.isfile("Fred_Armisen.txt")
+    assert os.path.isfile("Heinz_the_Baron_Krauss_von_Espy.txt")
+
+
+def test_select_action_bad():
+    arg_dict = {"1": mailroom.update_donors,
+                "2": mailroom.send_letters}
+    assert mailroom.select_action(arg_dict, "5") is False
+
+
+def test_donor_list():
+    mailroom.DONORS = {'Fred Armisen': [240, 422, 1000],
+                       'Heinz the Baron Krauss von Espy': [1500, 2300],
+                       'Margaret Atwood': [300, 555]}
+    returnval = mailroom.make_donor_list()
+    nlines = returnval.count('\n')
+    assert returnval.startswith("Donor Names:")
+    assert "Margaret Atwood" in returnval
+    assert "Fred Armisen" in returnval
+    assert nlines == len(mailroom.DONORS)
+
+
+def test_elect_action_good():
+    arg_dict = {"1": some_function, "2": mailroom.send_letters}
+    x = mailroom.select_action(arg_dict, "1")
+    assert x == 'this worked'
 
 
-def test_select_actionbad():
-    arg_dict = {"1": "dummy1", "2": "dummy2", "3": "dummy3"}
-    assert mailroom.select_action(arg_dict,"5") == False
+def some_function():
+    return "this worked"