The test report is stored in the test_runs directory under the program directory, and is saved in the format mm-dd-yyyy.xml. In other words, a report of a test run on January 1, 2008 would be stored as 01-01-2008.xml.

If you open the XML file (which you don't have to do to run the program), it will look like this:

<testresult>
    <testfirstname>PASSED</testfirstname>
    <testlastname>PASSED</testlastname>
    <testprimenumber>FAILED - 4 is not a prime number</testprimenumber>
    <testspassed>2</testspassed>
    <testsfailed>1</testsfailed>
    <testserror>0</testserror>
</testresult>

If you enter incorrect information in one of the first two prompts and the test fails, the test results indicate a failure and provide troubleshooting information, as shown in the following example:

================================
    RUN TESTS
    ================================

        Enter your first name: Joe
        Enter your last name: Knowlton
        Prime number test - enter a number: 2

    ================================
    TEST RUN RESULTS
    ================================
    Test first name - FAILED - EXPECTED Jim but was Joe
    Test last name - PASSED
    Test prime number - PASSED
    ================================
    Total tests passed:  2
    Total tests failed:  1
    Total tests with errors:  0

Press [Enter] to continue:

If you enter a non-prime number for the third test and the test fails, the program shows a failure and simply tells you it is not a prime number:

================================
    RUN TESTS
    ================================

        Enter your first name: Jim
        Enter your last name: Knowlton
        Prime number test - enter a number: 4

    ================================
    TEST RUN RESULTS
    ================================

Test first name - PASSED
    Test last name - PASSED
    Test prime number - FAILED - 4 is not a prime number
    ================================
    Total tests passed:  2
    Total tests failed:  1
    Total tests with errors:  0

Press [Enter] to continue:

Press Enter to return to the main menu.

If for some reason the program cannot find the test run file, you will get an appropriate error message:

================================
    SHOW TEST RESULTS
    ================================


    Enter the date of the test run in the
    following format: '01-01-2008'
    01-20-2008

        Problem opening test run file!

Press [Enter] to continue:

Press Enter to return to the main menu.

If for some reason the program cannot find the test run file, you will get an appropriate error message:

================================
    GENERATE HTML REPORT
    ================================


    Enter the date of the test run in the
    following format: '01-01-2008'
    01-20-2008

        Problem opening test run file!

Press [Enter] to continue:

Press Enter to return to the main menu.

test_manager.py is the module that a user actually loads. It contains the user menu and has one function. Table 6-1 shows the test_manager module function.

test_run.py is the module that actually runs the tests, writes the results to an XML file, and outputs the results to the screen. It has four functions, described in Table 6-2.

test_list.py lists, by date, all test runs. It has one function, described in Table 6-3.

test_results.py is the module that enables the user to enter a date corresponding to a completed test run, displaying the results of the test on the screen. It has one function, described in Table 6-4.

test_html is the module that enables the user to enter a date corresponding to a completed test run, outputting the results to a formatted HTML file. It has one function, described in Table 6-5.

Initially, the program imports modules that will be used:

import os, sys
import test_run, test_list, test_results, test_html

Notice that the user-created modules are on a different line than the standard modules (os and system). This is just to make the program more readable.

Just below the import statements is a block of code to initialize variables based on the operating system the user is running:

if sys.executable.find("exe") != −1:
    clearscreen = "cls"
    testpath = ".\test_runs\"
else:
    clearscreen = "clear"
    testpath = "./test_runs/"

Skipping over the menu() function for now, you can see the main program code:

#TAKE CHOICE AND LAUNCH MODULE
choice = ""
while choice != "6":
    choice = menu()
    if choice == "1":
        os.system(clearscreen)
        test_run.run_tests(testpath)
    elif choice == "2":
        os.system(clearscreen)
        test_list.list_tests()
    elif choice == "3":
        os.system(clearscreen)
        test_results.show_test_results(testpath)
    elif choice == "4":
        os.system(clearscreen)
        test_html.test_html_report(testpath)
    elif choice == "5":
        os.system(clearscreen)
        print """
    ================================
    TEST MANAGEMENT/REPORTING SYSTEM
    ================================
    Welcome to the Test Management/Reporting system.
    Using this program, you can run tests, list test
    runs, show test results to the screen, and generate
    HTML reports.
        """
        raw_input("Press [Enter] to continue: ")

As in previous programs, you initialize the choice variable, and then use a while loop to call the menu() function and assign the return value to the variable choice:

choice = ""
while choice != "6":
    choice = menu()

You then use an if-elif construct to perform different operations based on what the user entered (and what was assigned to the choice variable):

choice = ""
while choice != "6":
    choice = menu()
    if choice == "1":
        os.system(clearscreen)
        test_run.run_tests(testpath)
    elif choice == "2":
        os.system(clearscreen)
        test_list.list_tests()
    elif choice == "3":
        os.system(clearscreen)
        test_results.show_test_results(testpath)
    elif choice == "4":
        os.system(clearscreen)
        test_html.test_html_report(testpath)
    elif choice == "5":
        os.system(clearscreen)
        print """
    ================================
    TEST MANAGEMENT/REPORTING SYSTEM
    ================================
    Welcome to the Test Management/Reporting system.
    Using this program, you can run tests, list test
    runs, show test results to the screen, and generate
    HTML reports.
        """
        raw_input("Press [Enter] to continue: ")

If the user enters 6, then execution falls through the end of the if statement, and the program terminates.

The menu() function displays a user menu, takes a user selection, and returns that choice to the caller:

def menu():
    os.system('cls')
    print """
    ================================
    TEST MANAGEMENT/REPORTING SYSTEM
    ================================
    1 - Run tests
    2 - List test runs
    3 - Show test results
    4 - Generate HTML test report
    5 - Help
    6 - Exit
    ================================
    """
    choice = raw_input("Enter a choice and press enter: ")
    return choice

As shown in the preceding code, this function first clears the screen:

os.system(clarscreen)

After that, a menu is displayed:

print """
    ================================
    TEST MANAGEMENT/REPORTING SYSTEM
    ================================
    1 - Run tests
    2 - List test runs
    3 - Show test results
    4 - Generate HTML test report
    5 - Help
    6 - Exit
    ================================
    """

Finally, the user's selection is assigned to a variable, whose value is returned to the caller:

choice = raw_input("Enter a choice and press enter: ")
    return choice

The first three functions are the tests. Let's look at the first of them:

def test_firstname(fname):
    fname_input = raw_input("	Enter your first name: ")
    if fname_input == fname:
        return "PASSED"
    else:
        return "FAILED - EXPECTED " + fname + " but was " + fname_input

This function simply takes a string parameter fname. It prompts the user to enter a first name and assigns the result to a string variable:

fname_input = raw_input("	Enter your first name: ")

It then compares what the user has entered to the string passed as a parameter. If they match, then the string "PASSED" is returned; otherwise, a failure string is returned:

if fname_input == fname:
        return "PASSED"
    else:
        return "FAILED - EXPECTED " + fname + " but was " + fname_input

The second test function looks very similar:

def test_lastname(lname):
    lname_input = raw_input("	Enter your last name: ")
    if lname_input == lname:
        return "PASSED"
    else:
        return "FAILED - EXPECTED " + lname + " but was " + lname_input

This function simply takes a string parameter lname. It prompts the user to enter a last name and assigns the result to a string variable:

lname_input = raw_input("	Enter your last name: ")

It then compares what the user has entered to the string passed as a parameter. If they match, then the string "PASSED" is returned; otherwise, a failure string is returned:

if lname_input == lname:
        return "PASSED"
    else:
        return "FAILED - EXPECTED " + lname + " but was " + lname_input

The final test function determines whether a number is a prime number:

def test_prime_number():
    primes = [2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 
              53, 59, 61, 67, 71, 73, 79, 83, 89, 97]
    num = raw_input("	Prime number test - enter a number from 1 to 99: ")
    number = int(num)
    if number in primes:
        return "PASSED"
    else:
        return "FAILED - " + str(number) + " is not a prime number 1 to 99"

First, it initializes a list comprising all the prime numbers less than 100. Then it prompts the user to enter a number, assigns the number to a variable, and converts the string entered to its integer equivalent:

num = raw_input("	Prime number test - enter a number from 1 to 99: ")
    number = int(num)

The next block of code tests the number to determine whether it is in the list. If it is, then it returns a "PASSED" string; otherwise, it returns a failure string:

if number in primes:
        return "PASSED"
    else:
        return "FAILED - " + str(number) + " is not a prime number 1 to 99"

Although this function shows up last in the module sequentially, it drives everything else:

def run_tests(testpath):

    def testcount(test_results):
    #Compile test results and return them in a list
        tests_passed = 0
        tests_failed = 0
        tests_error = 0
        for test_result in test_results:
            if test_result == "PASSED":
                tests_passed += 1
            elif test_result[0:6] == "FAILED":
                tests_failed += 1
            else:
                tests_error += 1
        results = [tests_passed, tests_failed, tests_error]
        return results

#Run tests
    print """
    ================================
    RUN TESTS
    ================================
    """
    result_firstname = test_firstname("Jim")
    result_lastname = test_lastname("Knowlton")
    result_prime_number = test_prime_number()
    total_results = [result_firstname, result_lastname, result_prime_number]
    results = testcount(total_results)

    #Output test results to screen
    print """
    ================================
    TEST RUN RESULTS
    ================================
    Test first name - %s
    Test last name - %s
    Test prime number - %s
    ================================
    Total tests passed:  %i
    Total tests failed:  %i
    Total tests with errors:  %i
    """ % (result_firstname, result_lastname, result_prime_number, 
    results[0], results[1], results[2])

    #Format XML output for test run
    test_output_xml = """<testresult>
    <testfirstname>%s</testfirstname>
    <testlastname>%s</testlastname>
    <testprimenumber>%s</testprimenumber>
    <testspassed>%i</testspassed>
    <testsfailed>%i</testsfailed>
    <testserror>%i</testserror>
    </testresult>""" % 
    (result_firstname, result_lastname, result_prime_number, 
        results[0], results[1], results[2])

    today = datetime.datetime.now().strftime("%m-%d-%Y")
    output_filename = testpath + today + ".xml"
try:
        test_output = open(output_filename, "w")
        test_output.write(test_output_xml)
        test_output.close()
    except:
        print "Problem writing to file!"
    raw_input("Press [Enter] to continue: ")

We'll skip over the testcount() function for now, returning to it in a minute.

The first bit of code inside the function displays a menu banner:

print """
    ================================
    RUN TESTS
    ================================
    """

Notice that the first block of code is a nested function. A nice feature of Python is that functions can be nested, enabling you to provide a service to just the functions they are nested inside of.

The next three lines of code actually call the test functions and assign the results to variables:

result_firstname = test_firstname("Jim")
    result_lastname = test_lastname("Knowlton")
    result_prime_number = test_prime_number()

As you can see, I set the correct answers for the first two tests to correspond with my name (naturally). Feel free to change them to your name — or anything else you choose, for that matter.

The next line creates an array with the results for each test that has been run:

total_results = [result_firstname, result_lastname, result_prime_number]

Then, the testcount() function is called, which returns a list containing the cumulative count of passed, failed, and error tests. (We'll look more at that function in a minute). The cumulative counts are assigned to variable results:

results = testcount(total_results)

The next step is to output the results to the screen, in a readable format:

#Output test results to screen
    print """
    ================================
    TEST RUN RESULTS
    ================================
    Test first name - %s
    Test last name - %s
    Test prime number - %s
    ================================
    Total tests passed:  %i
    Total tests failed:  %i
    Total tests with errors:  %i
    """ % (result_firstname, result_lastname, result_prime_number, 
    results[0], results[1], results[2])

Next, the program needs to write the results to an XML file. First, the program creates a string variable and populates it with the XML text to go in the file:

test_output_xml = """<testresult>
    <testfirstname>%s</testfirstname>
    <testlastname>%s</testlastname>
    <testprimenumber>%s</testprimenumber>
    <testspassed>%i</testspassed>
    <testsfailed>%i</testsfailed>
    <testserror>%i</testserror>
    </testresult>""" % 
    (result_firstname, result_lastname, result_prime_number, 
        results[0], results[1], results[2])

Because the filename is based on the date, the next step is to get the system date and then format a string that will be the name of the file:

today = datetime.datetime.now().strftime("%m-%d-%Y")
    output_filename = testpath + today + ".xml"

Finally, the file is opened, written to using the formatted string (with the XML code), and closed:

try:
        test_output = open(output_filename, "w")
        test_output.write(test_output_xml)
        test_output.close()
    except:
        print "Problem writing to file!"

The testcount() function, which is nested inside of test_run(), takes a list of test results and counts the number of passed, failed, and error tests:

def testcount(test_results):
    #Compile test results and return them in a list
        tests_passed = 0
        tests_failed = 0
        tests_error = 0
        for test_result in test_results:
            if test_result == "PASSED":
                tests_passed += 1
            elif test_result[0:6] == "FAILED":
                tests_failed += 1
            else:
                tests_error += 1
        results = [tests_passed, tests_failed, tests_error]
        return results

The function first initializes the variables for passed, failed, and error tests to zero:

tests_passed = 0
        tests_failed = 0
        tests_error = 0

Following that, the function implements a for loop, which iterates through all the results and increments the count of each category based on the respective results found:

for test_result in test_results:
            if test_result == "PASSED":
                tests_passed += 1
            elif test_result[0:6] == "FAILED":
                tests_failed += 1
            else:
                tests_error += 1

Finally, the results are compiled into a list and returned to the caller:

results = [tests_passed, tests_failed, tests_error]
        return results

list_tests() is the only function in the module:

import os, glob

def list_tests():
    os.chdir("test_runs")
    filelist = glob.glob("*.xml")

    print """
    ================================
    LIST TEST RUNS
    ================================
    """
    for f in filelist:
        item = f.strip('.xml')
        print "	" + item
    print """
    ================================
    """
    raw_input("Press [Enter] to continue: ")

The function starts by changing the current directory to the directory where the test run files are located:

os.chdir("test_runs")

Then it uses the glob module to assign to the list filelist all XML files in the directory:

filelist = glob.glob("*.xml")

The next step is to print the menu item banner:

print """
    ================================
    LIST TEST RUNS
    ================================
    """

To print the list of test runs, a for loop is used to iterate through the list that was created. The strip string method is used to strip out the .xml extension from each file, so that it just shows a date for each item:

for f in filelist:
        item = f.strip('.xml')
        print "	" + item

Finally, the bottom bar of the banner is displayed on the screen:

print """
    ================================
    """

This function starts out by displaying the menu item banner:

print """
    ================================
    SHOW TEST RESULTS
    ================================
    """

Then the user is prompted to enter a date corresponding to a test run, and the user's entry is assigned to a variable:

prompt = """
    Enter the date of the test run in the
    following format: '01-01-2008'
    """
    test_date = raw_input (prompt)

A variable is then created for the path and name of the XML file:

test_run_file = testpath + test_date + ".xml"

Next, it is time to open the XML file and parse it, using the minidom module:

#Get nodes from XML document
    try:
        test_run = minidom.parse(test_run_file)
    except:
        print "
	Problem opening test run file!
"
        raw_input("Press [Enter] to continue: ")
        return

Notice that the opening of the file is enclosed in a try/except block, just in case there is a problem, such as the file not being found.

The next step is to use the node stored in the test_run variable and create variables corresponding to all the nodes from which we need to extract data:

test_result_node = test_run.childNodes[0]
    test_firstname_node = test_result_node.childNodes[1]
    test_lastname_node = test_result_node.childNodes[3]
    test_prime_node = test_result_node.childNodes[5]
    test_passed_node = test_result_node.childNodes[7]
    test_failed_node = test_result_node.childNodes[9]
    test_error_node = test_result_node.childNodes[11]

Once the nodes are assigned to variables, the data from those nodes can be extracted and assigned to variables:

#Get text from relevant nodes
    test_firstname_result = test_firstname_node.firstChild.data
    test_lastname_result = test_lastname_node.firstChild.data
    test_prime_result = test_prime_node.firstChild.data
    test_passed_result = test_passed_node.firstChild.data
    test_failed_result = test_failed_node.firstChild.data
    test_error_result = test_error_node.firstChild.data

Finally, the test results for the retrieved XML file can be displayed on the screen:

#Produce result to screen
    print """
    ================================
    TEST RUN RESULTS %s
    ================================
    Test first name - %s
    Test last name - %s
    Test prime number - %s
    ================================
    Total tests passed:  %s
    Total tests failed:  %s
    Total tests with errors:  %s
    """ % (test_date, test_firstname_result, test_lastname_result, 
    test_prime_result, test_passed_result, test_failed_result, 
    test_error_result)

This function starts out by displaying the menu item banner:

print """
    ================================
    GENERATE HTML REPORT
    ================================
    """

The user is prompted to enter the date associated with a test run, in the appropriate format:

prompt = """
    Enter the date of the test run in the
    following format: '01-01-2008'
    """
    test_date = raw_input (prompt)

The function then has a line of code to construct a string variable with the date input above, adding the path to the test run files and the .XML extension:

test_run_file = testpath + test_date + ".xml"

The XML test run file is then opened and parsed, using the minidom module:

#Get nodes from XML document
    try:
        test_run = minidom.parse(test_run_file)
    except:
        print "
	Problem opening test run file!
"
        raw_input("Press [Enter] to continue: ")
        return

Variables associated with all the nodes to be accessed are then created:

test_result_node = test_run.childNodes[0]
    test_firstname_node = test_result_node.childNodes[1]
    test_lastname_node = test_result_node.childNodes[3]
    test_prime_node = test_result_node.childNodes[5]
    test_passed_node = test_result_node.childNodes[7]
    test_failed_node = test_result_node.childNodes[9]
    test_error_node = test_result_node.childNodes[11]

With the nodes assigned to variables, the data can be extracted from the nodes and assigned to variables:

#Get text from relevant nodes
    test_firstname_result = test_firstname_node.firstChild.data
    test_lastname_result = test_lastname_node.firstChild.data
    test_prime_result = test_prime_node.firstChild.data
    test_passed_result = test_passed_node.firstChild.data
    test_failed_result = test_failed_node.firstChild.data
    test_error_result = test_error_node.firstChild.data

After all the needed data from the XML file is assigned to variables, the HTML text can be constructed:

html_output = """
    <HTML>
    <TITLE>Test Report - %s</TITLE>
    <HR>
    <H1>TEST RUN RESULTS %s</H1>
    <HR>
    <BODY>
    Test first name - %s<br>
    Test last name - %s<br>
    Test prime number - %s<br>
    <HR>
    Total tests passed:  %s<br>
    Total tests failed:  %s<br>
    Total tests with errors:  %s<br>
    </BODY>
    </HTML>
    """ % (test_date, test_date, test_firstname_result, test_lastname_result, 
    test_prime_result, test_passed_result, test_failed_result, test_error_result)

The next bit of code is to open the HTML file for writing, and then write the HTML to the file:

filename = os.path.join(os.curdir, 'test_report_html', test_date + ".html")
    output_file = open(filename, 'w')
    output_file.write(html_output)
    output_file.close()

Finally, a status message is displayed, letting the user know that the HTML file has been created:

print "
	-- HTML Report Generated --"