#! /usr/bin/env python

# this is the test script for jbig2dec

import os, re

import sys, time

class SelfTest:

  'generic class for self tests'

  def __init__(self):

    self.result = 'unrun'

    self.msg = ''

  def shortDescription(self):

    'returns a short name for the test'

    return "generic self test"

  def runTest(self):

    'call this to execute the test'

    pass

  def fail(self, msg=None):

    self.result = 'FAIL'

    self.msg = msg

  def failIf(self, check, msg=None):

    if check: self.fail(msg)

  def assertEqual(self, a, b, msg=None):

    if a != b: self.fail(msg)

class SelfTestSuite:

  'generic class for running a collection of SelfTest instances'

  def __init__(self, stream=sys.stderr):

    self.stream = stream

    self.tests = []

    self.fails = []

    self.xfails = []

    self.errors = []

  def addTest(self, test):

    self.tests.append(test)

  def run(self):

    starttime = time.time()

    for test in self.tests:

      self.stream.write("%s ... " % test.shortDescription())

      test.result = 'ok'

      test.runTest()

      if test.result != 'ok':

        self.fails.append(test)

      self.stream.write("%s\n" % test.result)

    stoptime = time.time()

    self.stream.write('-'*72 + '\n')

    self.stream.write('ran %d tests in %.3f seconds\n\n' %

        (len(self.tests), stoptime - starttime))

    if len(self.fails):

      self.stream.write('FAILED %d of %d tests\n' %

        (len(self.fails),len(self.tests)))

      return False

    else:

      self.stream.write('PASSED all %d tests\n' % len(self.tests))

      return True

class KnownFileHash(SelfTest):

  'self test to check for correct decode of known test files'

  # hashes of known test inputs

  known_NOTHING_DECODED = "da39a3ee5e6b4b0d3255bfef95601890afd80709"

  known_042_DECODED = "ebfdf6e2fc5ff3ee2271c2fa19de0e52712046e8"

  known_amb_DECODED = "3d4b7992d506894662b53415bd3d0d2a2f8b7953"

  # these are known test files in the form

  # (filename, sha-1(file), sha-1(decoded document)

  known_hashes = ( ('../ubc/042_1.jb2',

			"673e1ee5c55ab241b171e476ba1168a42733ddaa",

			known_042_DECODED),

                   ('../ubc/042_2.jb2', 

                        "9aa2804e2d220952035c16fb3c907547884067c5",

                        known_042_DECODED),

                   ('../ubc/042_3.jb2',

			"9663a5f35727f13e61a0a2f0a64207b1f79e7d67",

			known_042_DECODED),

                   ('../ubc/042_4.jb2',

			"014df658c8b99b600c2ceac3f1d53c7cc2b4917c",

                        known_042_DECODED),

                   ('../ubc/042_5.jb2',

			"264720a6ccbbf72aa6a2cfb6343f43b8e6f2da4b",

                        known_042_DECODED),

                   ('../ubc/042_6.jb2',

			"96f7dc9df4a1b305f9ac082dd136f85ef5b108fe",

			known_042_DECODED),

                   ('../ubc/042_7.jb2',

			"5526371ba9dc2b8743f20ae3e05a7e60b3dcba76",

			known_042_DECODED),

                   ('../ubc/042_8.jb2',

			"4bf0c87dfaf40d67c36f2a083579eeda26d54641",

			known_042_DECODED),

                   ('../ubc/042_9.jb2',

			"53e630e7fe2fe6e1d6164758e15fc93382e07f55",

			known_042_DECODED),

                   ('../ubc/042_10.jb2',

			"5ca1364367e25cb8f642e9dc677a94d5cfed0c8b",

			known_042_DECODED),

                   ('../ubc/042_11.jb2',

			"bc194caf022bc5345fc41259e05cea3c08245216",

			known_042_DECODED),

                   ('../ubc/042_12.jb2',

			"f354df8eb4849bc707f088739e322d1fe3a14ef3",

			known_042_DECODED),

                   ('../ubc/042_13.jb2',

			"7d428bd542f58591b254d9827f554b0552c950a7",

			known_NOTHING_DECODED),

                   ('../ubc/042_14.jb2',

			"c40fe3a02acb6359baf9b40fc9c49bc0800be589",

			known_NOTHING_DECODED),

                   ('../ubc/042_15.jb2',

			"a9e39fc1ecb178aec9f05039514d75ea3246246c",

			known_042_DECODED),

                   ('../ubc/042_16.jb2',

			"4008bbca43670f3c90eaee26516293ba95baaf3d",

			known_042_DECODED),

                   ('../ubc/042_17.jb2',

			"0ff95637b64c57d659a41c582da03e25321551fb",

			known_042_DECODED),

                   ('../ubc/042_18.jb2',

			"87381d044f00c4329200e44decbe91bebfa31595",

			known_042_DECODED),

                   ('../ubc/042_19.jb2',

			"387d95a140b456d4742622c788cf5b51cebbf438",

			known_042_DECODED),

                   ('../ubc/042_20.jb2',

			"85c19e9ec42b8ddd6b860a1bebea1c67610e7a59",

			known_042_DECODED),

                   ('../ubc/042_21.jb2',

			"ab535c7d7a61a7b9dc53d546e7419ca78ac7f447",

			known_042_DECODED),

                   ('../ubc/042_22.jb2',

			"a9e2b365be63716dbde74b0661c3c6efd2a6844d",

			known_042_DECODED),

                   ('../ubc/042_23.jb2',

			"8ffa40a05e93e10982b38a2233a8da58c1b5c343",

			known_042_DECODED),

                   ('../ubc/042_24.jb2',

			"2553fe65111c58f6412de51d8cdc71651e778ccf",

			known_042_DECODED),

                   ('../ubc/042_25.jb2',

			"52de4a3b86252d896a8d783ba71dd0699333dd69",

			known_042_DECODED),

                   ('../ubc/amb_1.jb2',

			"d6d6d1c981dc37a09108c1e3ed990aa5b345fa6a",

                        known_amb_DECODED),

                   ('../ubc/amb_2.jb2',

			"9af6616a89eb03f8934de72626e301a716366c3c",

                        known_amb_DECODED)

                 )

  def __init__(self, file, file_hash, decode_hash):

    SelfTest.__init__(self)

    self.file = file

    self.file_hash = file_hash

    self.decode_hash = decode_hash

  def shortDescription(self):

    return "Checking '%s' for correct decoded document hash" % self.file

  def runTest(self):

    '''jbig2dec should return proper document hashes for known files'''

    # invoke jbig2dec on our file

    instance = os.popen('./jbig2dec -q -o /dev/null --hash ' + self.file)

    lines = instance.readlines()

    exit_code = instance.close()

    self.failIf(exit_code, 'jbig2dec should exit normally')

    # test here for correct hash

    hash_pattern = re.compile('[0-9a-f]{%d}' % len(decode_hash))

    for line in lines:

      m = hash_pattern.search(line.lower())

      if m:

        self.assertEqual(self.decode_hash, m.group(),

          'hash of known decoded document must be correct')

        return

    self.fail('document hash was not found in the output')

suite = SelfTestSuite()

for filename, file_hash, decode_hash in KnownFileHash.known_hashes:

  # only add tests for files we can find

  if not os.access(filename, os.R_OK): continue

  # todo: verify our file matches its encoded document hash

  suite.addTest(KnownFileHash(filename, file_hash, decode_hash))

# run the defined tests if we're called as a script

if __name__ == "__main__":

    result = suite.run()

    sys.exit(not result)