fast-regression-test.py

#!/usr/bin/env python
# Copyright (C) 2012 Red Hat, Inc.
# Authors: Jan Kaluza <jkaluza@redhat.com>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
# USA.

"""Do a quick comparison of output of file(1) with that saved in db."""

from __future__ import print_function

import sys
import getopt
import mutex
from pyfile import *
from pyfile.threadpool import *


#: return value from test_all_files
#: TODO: make this a nonlocal in py3
ret = 0


def test_all_files(exact=False, binary="file"):
    """Compare output of given file(1) binary with db for all entries."""
    global ret
    ret = 0

    print_file_info(binary)

    print_lock = mutex.mutex()

    entries = sorted(get_stored_files("db"))

    def store_mimedata(filename):
        """Compare file(1) output with db for single entry."""
        metadata = get_simple_metadata(filename, binary)
        try:
            stored_metadata = get_stored_metadata(filename)
        except IOError:
            # file not found or corrupt
            text = "FAIL " + filename + "\n" + \
                   "FAIL   could not find stored metadata!\n" + \
                   "This can mean that the File failed to generate " + \
                   "any output for this file."
        else:
            text = "PASS " + filename
            if is_regression(stored_metadata, metadata, exact):
                text = "FAIL " + filename + "\n" + \
                       get_diff(stored_metadata, metadata, exact)
        return text

    def data_print(data):
        """Print given text, set global return value, unlock print lock."""
        print(data)
        if data[0] == "F":
            global ret
            ret = 1
        print_lock.unlock()

    def data_stored(data):
        """Acquire print lock and call :py:function:`data_print`."""
        print_lock.lock(data_print, data)

    # create here so program exits if error occurs earlier
    n_threads = 1
    pool = ThreadPool(n_threads)

    for entry in entries:
        # Insert tasks into the queue and let them run
        pool.queueTask(store_mimedata, entry, data_stored)

    # When all tasks are finished, allow the threads to terminate
    pool.joinAll()
    print('')
    return ret


def usage(ecode):
    """Print info on how to use this program. Return given code."""
    print("Runs regressions.")
    print(sys.argv[0] + " [-e] [-b <file-binary>]")
    print("  Default file_binary='file'")
    print("Examples:")
    print("  " + sys.argv[0] + " -e -b '../file -m ../../magic/magic.mgc'")
    print("  " + sys.argv[0] + " -e")
    sys.exit(ecode)


def main():
    """Called when running this as script. Parse args, call test_all_files."""
    exact = False
    file_binary = "file"
    args = sys.argv[1:]

    optlist, args = getopt.getopt(args, 'b:e')

    for option, arg in optlist:
        if option == '-b':
            file_binary = arg
        elif option == '-e':
            exact = True
        else:
            usage(1)

    sys.exit(test_all_files(exact, file_binary))


# run this only if started as script from command line
if __name__ == '__main__':
    main()