Source code for ferenda.testutil

# -*- coding: utf-8 -*-
""":py:mod:`unittest`-based classes and accompanying functions to
create some types of ferenda-specific tests easier."""
from __future__ import (absolute_import, division,
                        print_function, unicode_literals)
from builtins import *

from difflib import unified_diff
from io import BytesIO
import builtins
import codecs
import logging
import filecmp
import inspect
import json
import os
import re
import shutil
import sys
import tempfile
import time
import unicodedata
from urllib.parse import unquote

from ferenda.compat import unittest

import rdflib
from import graph_diff
from rdflib.util import guess_format
from lxml import etree
import requests.exceptions
import responses

from ferenda import DocumentRepository, TextReader
from ferenda import elements, util
from ferenda.errors import ExternalCommandError, MaxDownloadsReached

[docs]class FerendaTestCase(object): """Convenience class with extra AssertEqual methods. Note that even though this method provides :py:class:`unittest.TestCase`-like assert methods, it does not derive from :py:class:`~unittest.TestCase`. When creating a test case that makes use of these methods, you need to inherit from both :py:class:`~unittest.TestCase` and this class, ie:: class MyTestcase(unittest.TestCase, ferenda.testutil.FerendaTestCase): def test_simple(self): self.assertEqualXML("<foo arg1='x' arg2='y'/>", "<foo arg2='y' arg1='x'></foo>") """ # FIXME: Some of these should (at least optionally) be registered # with TestCase.assertEqual through .addTypeEqualityFunc, but some # (eg. assertEqualDirs) have non-unique types
[docs] def assertEqualGraphs(self, want, got, exact=True): """Assert that two RDF graphs are identical (isomorphic). :param want: The graph as expected, as an :py:class:`~rdflib.graph.Graph` object or the filename of a serialized graph :param got: The actual graph, as an :py:class:`~rdflib.graph.Graph` object or the filename of a serialized graph :param exact: Whether to require that the graphs are exactly alike (True) or only if all triples in `want` exists in `got` (False) :type exact: bool """ def _loadgraph(filename): g = rdflib.Graph() # we must read the data ourself, providing a non-ascii # filename to Graph.parse fails deep in rdflib internals format = guess_format(filename) if format == "nt": data = util.readfile(filename, "r", encoding="utf-8") else: data = util.readfile(filename, "rb") g.parse(data=data, format=format) return g if not isinstance(want, rdflib.Graph): want = _loadgraph(want) if not isinstance(got, rdflib.Graph): got = _loadgraph(got) (in_both, in_first, in_second) = graph_diff(want, got) msg = "" if in_first: for (s, p, o) in sorted(in_first, key=lambda t: (t[0], t[1], t[2])): msg += "- %s %s %s\n" % (s.n3(), p.n3(), o.n3()) if (exact and in_second) or in_first: for (s, p, o) in sorted(in_second, key=lambda t: (t[0], t[1], t[2])): msg += "+ %s %s %s\n" % (s.n3(), p.n3(), o.n3()) if ((len(in_first) > 0) or (len(in_second) > 0 and exact)): if len(in_first) > 0: msg = "%s expected triples were not found\n" % len(in_first) + msg if len(in_second) > 0: msg = "%s unexpected triples were found\n" % len(in_second) + msg ntdiff = True if ntdiff: msg = "%r != %r\n" % (want, got) + msg else: import difflib d = difflib.unified_diff(want.serialize(format="turtle").decode("utf-8").split("\n"), got.serialize(format="turtle").decode("utf-8").split("\n"), n=10000) msg = msg + "\n".join(d) # print("=======WANT=======") # print(want.serialize(format="n3")) # print("=======GOT========") # print(got.serialize(format="n3")) # sys.exit(0) return
[docs] def assertAlmostEqualDatetime(self, datetime1, datetime2, delta=1): """Assert that two datetime objects are reasonably equal. :param datetime1: The first datetime to compare :type datetime1: datetime :param datetime2: The second datetime to compare :type datetime2: datetime :param delta: How much the datetimes are allowed to differ, in seconds. :type delta: int """ # if the datetimes differ with max 1 second, they're almost # equal) time1 = time.mktime(datetime1.timetuple()) time2 = time.mktime(datetime2.timetuple()) absdiff = abs(time1 - time2) # FIXME: The "return" is due to a badly written testcase return self.assertLessEqual(absdiff, delta, "Difference between %s and %s " "is %s seconds which is NOT almost equal" % (datetime1.isoformat(), datetime2.isoformat(), absdiff))
[docs] def assertEqualXML(self, want, got, namespace_aware=True, tidy_xhtml=False): """Assert that two xml trees are canonically identical. :param want: The XML document as expected, as a string, byte string or ElementTree element :param got: The actual XML document, as a string, byte string or ElementTree element """ # Adapted from formencode, def xml_compare(want, got, reporter): if namespace_aware: wanttag = want.tag gottag = got.tag else: wanttag = want.tag.rsplit("}")[-1] gottag = got.tag.rsplit("}")[-1] if wanttag != gottag: reporter("Tags do not match: 'want': %s, 'got': %s" % (wanttag, gottag)) return False for name, value in want.attrib.items(): if got.attrib.get(name) != value: reporter("Attributes do not match: 'want': %s=%r, 'got': %s=%r" % (name, value, name, got.attrib.get(name))) return False for name in got.attrib.keys(): if name not in want.attrib: reporter("'got' has an attribute 'want' is missing: %s" % name) return False if not text_compare(want.text, got.text): reporter("text: 'want': %r != 'got': %r" % (want.text, got.text)) return False if not text_compare(want.tail, got.tail): reporter("tail: 'want': %r != 'got': %r" % (want.tail, got.tail)) return False cl1 = want.getchildren() cl2 = got.getchildren() if len(cl1) != len(cl2): reporter("children length differs, 'want': %i, 'got': %i" % (len(cl1), len(cl2))) return False i = 0 for c1, c2 in zip(cl1, cl2): i += 1 if not xml_compare(c1, c2, reporter=reporter): reporter('children %i do not match: %s' % (i, c1.tag)) return False return True def text_compare(want, got): if not want and not got: return True return (want or '').strip() == (got or '').strip() def treeify(something): if isinstance(something, str): fp = BytesIO(something.encode('utf-8')) # return etree.fromstring(something) return etree.parse(fp) elif isinstance(something, bytes): fp = BytesIO(something) # return etree.parse(fp).getroot() return etree.parse(fp) elif isinstance(something, etree._Element): return etree.ElementTree(something) else: raise ValueError("Can't convert a %s into an ElementTree" % type(something)) def tidy(tree): import subprocess # without the "--drop-empty-elements no" argument, empty # span tags (containing RDFa data) will be # dropped. Unfortunately this seems to be a new argument # only available in the tidy-html5 branch. Assume that we # have the new version, and fall back to the old, worse, # version otherwise: for cmdline in ("tidy -i -q -asxhtml -w 100 -utf8 --drop-empty-elements no", "tidy -i -q -asxhtml -w 100 -utf8"): p = subprocess.Popen(cmdline, shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE) treestr = etree.tostring(tree, encoding="utf-8") stdout, stderr = p.communicate(treestr) if stdout.strip(): rawres = stdout cookedres = stdout.decode( "utf-8").replace("&nbsp;", "&#160;").encode("utf-8") newtree = etree.parse(BytesIO(cookedres)) return newtree elif p.returncode and stderr: log = logging.getLogger("tidy") log.warning("'%s' failed: %s" % (cmdline, stderr.decode().split("\n")[0])) # if we reach this point, all command lines have failed raise ExternalCommandError(stderr) def c14nize(tree): tmp = BytesIO() tree.write_c14n(tmp) return tmp.getvalue().decode('utf-8') errors = [] want_tree = treeify(want) got_tree = treeify(got) # example on how to filter attributes from one of the trees to # compare. In this case, b/c we want to test without some # attributes that a newly added change added to all # 'pagebreak' spans (to see if the change broke anything # else). # for tree in (got_tree, want_tree): # for pagebreak in tree.findall("//{}span"): # if pagebreak.get("id") and pagebreak.get("id").startswith("sid"): # if "src" in pagebreak.attrib: # del pagebreak.attrib["src"] # del pagebreak.attrib["width"] # del pagebreak.attrib["height"] xml_compare(want_tree.getroot(), got_tree.getroot(), errors.append) if errors: if tidy_xhtml: want_tree = tidy(want_tree) got_tree = tidy(got_tree) want_lines = [x + "\n" for x in c14nize(want_tree).split("\n")] got_lines = [x + "\n" for x in c14nize(got_tree).split("\n")] diff = unified_diff(want_lines, got_lines, "want.xml", "got.xml") # convert '@@ -1,1 +1,1 @@' (which py26 difflib produces) # to '@@ -1 +1 @@' (wich later versions produces) diff = [re.sub(r"@@ -(\d+),\1 \+(\d+),\2 @@", r"@@ -\1 +\2 @@", x) for x in diff] # remove trailing space for other control lines (py26...) diff = [re.sub(r"((?:\+\+\+|\-\-\- ).*) $", r"\1", x) for x in diff] msg = "".join(diff) + "\n\nERRORS:" + "\n".join(errors) return
[docs] def assertEqualDirs(self, want, got, suffix=None, subset=False, filterdir="entries"): """Assert that two directory trees contains identical files :param want: The expected directory tree :type want: str :param got: The actual directory tree :type got: str :param suffix: If given, only check files ending in suffix (otherwise check all the files :type suffix: str :param subset: If True, require only that files in want is a subset of files in got (otherwise require that the sets are identical) :type subset: bool :param filterdir: If given, don't compare the parts of the tree that starts with filterdir :type suffix: str """ wantfiles = [x[len(want) + 1:] for x in util.list_dirs(want, suffix) if not x.startswith(want + os.sep + filterdir)] gotfiles = [x[len(got) + 1:] for x in util.list_dirs(got, suffix) if not x.startswith(got + os.sep + filterdir)] self.maxDiff = None if subset: self.assertTrue(set(wantfiles).issubset(set(gotfiles))) else: self.assertEqual(wantfiles, gotfiles) # or assertIn? for f in wantfiles: if not filecmp.cmp(os.path.join(want, f), os.path.join(got, f), shallow=False): self.assertEqual(util.readfile(os.path.join(want, f), mode="rb"), util.readfile(os.path.join(got, f), mode="rb"))
def assertRegex(self, test, expected_regexp, msg=None): # in older versions of unittest, this method was named assertRegexpMatches if sys.version_info < (3, 2, 0): return self.assertRegexpMatches(test, expected_regexp, msg) else: return super(FerendaTestCase, self).assertRegex(test, expected_regexp, msg)
[docs]class RepoTester(unittest.TestCase, FerendaTestCase): """A unittest.TestCase-based convenience class for creating file-based integration tests for an entire docrepo. To use this, you only need a very small amount of boilerplate code, and some files containing data to be downloaded or parsed. The actual tests are dynamically created from these files. The boilerplate can look something like this:: class TestRFC(RepoTester): repoclass = RFC # the docrepo class to test docroot = os.path.dirname(__file__)+"/files/repo/rfc" parametrize_repotester(TestRFC) """ # A subclass must override these two FIXME: Sphinx really wants to # treat this class as a reference (thinking it must be a class # alias), but cannot resolve it repoclass = DocumentRepository """The actual documentrepository class to be tested. Must be overridden when creating a testcase class.""" docroot = '/tmp' """The location of test files to create tests from. Must be overridden when creating a testcase class""" datadir = None # this should be the only setting of maxDiff we need maxDiff = None setupclass = False
[docs] @classmethod def setUpClass(cls): cls.datadir = tempfile.mkdtemp() if isinstance(cls.datadir, bytes): cls.datadir = cls.datadir.decode() # Setting up a class can be pretty expensive (if it loads a # lot of RDF and/or minter objects) so we create it in # setUpClass instead. If your test needs a fresh repo for each # case, make sure your tearDown deletes self.repo, so that # next setUp will recreate it. if hasattr(cls, 'repoconfig'): repoconfig = cls.repoconfig else: repoconfig = {} cls.repo = cls.repoclass(datadir=cls.datadir, storelocation=cls.datadir + "/ferenda.sqlite", indexlocation=cls.datadir + "/whoosh", develurl=None, **repoconfig) cls.setupclass = True
[docs] def setUp(self): # if test_download, copy only self.docroot + "/source" (all of # it) if test_{parse,distill}, copy all of self.docroot (can # omit /source, but must include intermediate, entries etc) to # self.datadir. Note that this means that we copy files for # all tests when running a single test, and that we remove # them for each test as well. This might make it impractical # to run 10+ tests for a single repo. if self.docroot != '/tmp': method = self._testMethodName dest = source = None if method.startswith("test_download_"): source = self.docroot + os.sep + "source" dest = os.sep.join([self.datadir, self.repo.alias, "source"]) ignore = None elif (method.startswith("test_parse_") or method.startswith("test_distill_")): source = self.docroot dest = self.datadir + os.sep + self.repo.alias ignore = shutil.ignore_patterns('source', 'parsed') if os.path.exists(dest): shutil.rmtree(dest) # FIXME: maybe we could warn or fail if this copy operation # takes more than, say, 0.5 seconds? shutil.copytree(source, dest, ignore=ignore) if not hasattr(self, 'repo'): self.datadir = tempfile.mkdtemp() if isinstance(self.datadir, bytes): self.datadir = self.datadir.decode() self.repo = self.repoclass(datadir=self.datadir, storelocation=self.datadir + "/ferenda.sqlite", indexlocation=self.datadir + "/whoosh",)
[docs] @classmethod def tearDownClass(cls): if cls.setupclass and os.path.exists(cls.datadir): shutil.rmtree(cls.datadir)
[docs] def tearDown(self): if hasattr(self.repo, 'tearDown'): self.repo.tearDown(self) if os.path.exists(self.datadir): shutil.rmtree(self.datadir)
[docs] def filename_to_basefile(self, filename): """Converts a test filename to a basefile. Default implementation attempts to find out basefile from the repoclass being tested (or rather it's documentstore), but returns a hard-coded basefile if it fails. :param filename: The test file :type filename: str :returns: Corresponding basefile :rtype: str """ try: filename = self.p(filename) # Adapted from DocumentStore.list_basefiles_for: Find out a # path fragment from the entire filename path. if self.repo.storage_policy == "file": suffixlen = len(os.path.splitext(filename)[1]) # eg '.pdf' else: suffixlen = len(os.path.basename(filename)) + 1 if "test/files/repo" in filename: # take advantage of this well known direcotry structure relfilename = filename[filename.index("test/files/repo"):] directory = os.sep.join(relfilename.split(os.sep)[:5]) pathfrag = relfilename[len(directory) + 1:-suffixlen] elif "downloaded" in filename.split(os.sep): # find the first (or last?) segment named "downloaded" idx = filename.index(os.sep + "downloaded" + os.sep) pathfrag = filename[idx + 12:-suffixlen] else: pathfrag = "1" basefile = return basefile except: return "1"
[docs] @responses.activate def download_test(self, specfile, basefile=None): """This test is run for each json file found in docroot/source.""" # this function can run in normal test mode or in # FERENDA_SET_TESTFILE mode. In the latter, all the normal download # code, including net access, is run. Calls to requests.get # are intercepted and notes are made of which URLs are # requested, and if this results in files on disk. The end # result is a JSON file and a set of cached files, all placed under # "source/" def add_downloaded_files(filelist, spec, url): downloaddir = os.sep.join([self.datadir, self.repoclass.alias, "downloaded"]) for f in list(util.list_dirs(downloaddir)): if f.endswith(".etag"): continue # FIXME: this is ugly if f not in filelist: # print("Fetching %s resulted in downloaded file %s" % (url, f)) filelist.append(f) expect = "downloaded" + f.replace(downloaddir, "") if os.sep != "/": expect = expect.replace(os.sep, "/") spec[url]['expect'] = expect reldest = os.path.relpath( ".." + os.sep + "downloaded", os.path.dirname(f)) dest = os.path.normpath( os.path.join( os.path.dirname(specfile), reldest)) util.ensure_dir(dest) shutil.copy2(f, dest) with, encoding="utf-8") as fp: spec = json.load(fp) for k in list(spec.keys()): # NB: This exposes the encoded, possibly non-ascii, values # of the URL as byte strings. The encoding of these is # unknown (and we cannot generally assume UTF-8. Let's see # if this bites us. nk = unquote(k) if k != nk: spec[nk] = spec[k] del spec[k] # process the special '@settings' key (FIXME: didn't I already # implement this somewhere else?) # # a @settings like this: # "@settings": { # "config": {"next_sfsnr": "2014:913"} # }, # # will have the effect of this: # # self.repo.config.next_sfsnr = "2014:913" if '@settings' in spec: for attribute in spec['@settings']: if isinstance(spec['@settings'][attribute], dict): thing = getattr(self.repo, attribute) for key, value in spec['@settings'][attribute].items(): setattr(thing, key, value) else: setattr(self.repo, attribute, spec['@settings'][attribute]) if os.environ.get("FERENDA_SET_TESTFILE"): downloaddir = os.sep.join([self.datadir, self.repoclass.alias, "downloaded"]) state = {'downloaded': list(util.list_dirs(downloaddir)), 'previous_url': None, 'requests': 0} try: rc = int(os.environ.get("FERENDA_SET_TESTFILE")) state['total_requests'] = rc except (ValueError, TypeError): state['total_requests'] = 2 # search page, single payload def callback(req): # clean up after last callback add_downloaded_files(state['downloaded'], spec, state['previous_url']) if state['requests'] == state['total_requests']: raise MaxDownloadsReached() # make a real requests call somehow responses.stop() # when testing this testing function # (testTestutil.RepoTester.test_download_setfile) we # still want to disable responses, but we don't want # to make an actual HTTP call. Detect if we are # running that test by examining the stack, and if so, # mock the requests.get call in a different way. frames = [f for f in inspect.stack() if f[3] == "test_download_setfile"] if frames: frame = frames[0][0] resp = frame.f_locals['self']._myget(req.url) else: resp = requests.get(req.url) responses.start() # create a filename. use .html as suffix unless we # should use something else contenttype = resp.headers["Content-type"] stem = os.path.splitext(specfile)[0] suffix = {'application/pdf': 'pdf', 'application/json': 'json', 'text/plain': 'txt'}.get(contenttype, "html") outfile = "%s-%s.%s" % (stem, state['requests'], suffix) with open(outfile, "wb") as fp: fp.write(resp.content) if not frames and os.environ.get("TRAVIS") != "true": if suffix == "html": print( "requested %s, saved as %s. Edit if needed, then press enter" % (req.url, outfile)) x = input() else: print("requested %s, saved %s" % (req.url, outfile)) with open(outfile, "rb") as fp: content = spec[req.url] = {'file': os.path.basename(outfile)} if resp.encoding != 'utf-8': spec[req.url]['encoding'] = resp.encoding state['requests'] += 1 state['previous_url'] = req.url return (resp.status_code, resp.headers, content) else: def callback(req): headers = {'Content-type': 'text/html'} try: # normalize req.url. req.url might be a (byte)str # but keys in spec will be (and should be) # unicode. Assume that req.url is all ascii if isinstance(req.url, bytes): url = req.url.decode() else: url = req.url urlspec = spec[unquote(url)] if isinstance(urlspec, str): urlspec = {'file': urlspec} url_location = os.path.join(os.path.dirname(specfile), urlspec['file']) # load the .content property with open(url_location, "rb") as fp: content = return (200, headers, content) except KeyError: return (404, headers, "Not found") responses.add_callback(responses.GET, re.compile("(.*)"), callback) # PERFORM THE TEST try: except MaxDownloadsReached: pass if os.environ.get("FERENDA_SET_TESTFILE"): # process final file and save specfile add_downloaded_files(state['downloaded'], spec, state['previous_url']) with open(specfile, "w") as fp: j = json.dumps(spec, indent=4, separators=(', ', ': ')) fp.write(j) # organize a temporary copy of files that we can compare our results to wantdir = "%s/%s-want" % (self.datadir, self.repoclass.alias) expected = False for url in spec: if url == "@settings": continue if "expect" in spec[url]: expected = True sourcefile = os.path.join(os.path.dirname(specfile), spec[url]['file']) wantfile = "%s/%s" % (wantdir, spec[url]['expect']) util.copy_if_different(sourcefile, wantfile) if expected: self.assertEqualDirs(wantdir, "%s/%s" % (self.datadir, self.repoclass.alias), subset=True) else: # the test doesn't actually result in any downloaded file if hasattr(self.repo, 'expect') and self.repo.expect is False: pass else:'No files were marked as "expect" in specfile %s' % specfile)
[docs] def distill_test(self, downloaded_file, rdf_file, docroot): """This test is run once for each basefile found in docroot/downloaded. It performs a full parse, and verifies that the distilled RDF metadata is equal to the TTL files placed in docroot/distilled/. """ basefile = self.filename_to_basefile(downloaded_file) self.repo.parse(basefile) print = builtins.print if 'FERENDA_SET_TESTFILE' in os.environ: print("Overwriting '%s' with result of parse ('%s')" % (rdf_file, basefile)) g = rdflib.Graph() g.parse(data=util.readfile( util.robust_rename(rdf_file, rdf_file + "~") with open(rdf_file, "wb") as fp: fp.write(g.serialize(format="turtle")) return self.assertEqualGraphs(rdf_file,, exact=False)
[docs] def parse_test(self, downloaded_file, xhtml_file, docroot): """This test is run once for each basefile found in docroot/downloaded. It performs a full parse, and verifies that the resulting XHTML document is equal to the XHTML file placed in docroot/parsed/. """ basefile = self.filename_to_basefile(downloaded_file) def runtest(): if "FERENDA_LOG_TEST" in os.environ: loglevel = { "DEBUG": logging.DEBUG, "INFO": logging.INFO, "WARNING": logging.WARNING, "ERROR": logging.ERROR, "CRITICAL": logging.CRITICAL }.get(os.environ["FERENDA_LOG_TEST"], logging.INFO) logformat = "%(asctime)s %(name)s %(levelname)s %(message)s" datefmt = "%H:%M:%S" handler = logging.StreamHandler() handler.setLevel(loglevel) handler.setFormatter(logging.Formatter(logformat, datefmt=datefmt)) logger = logging.getLogger() logger.setLevel(loglevel) # shut some non-core loggers up for logname in ['requests.packages.urllib3.connectionpool', 'rdflib.plugins.sleepycat', 'rdflib.plugins.parsers.pyRdfa', 'ferenda.thirdparty.patch']: log = logging.getLogger(logname) log.propagate = False logger.addHandler(handler) self.repo.parse(basefile) if "FERENDA_LOG_TEST" in os.environ: logger.removeHandler(handler) if "FERENDA_PROFILE_TEST" in os.environ: print("Profiling test") import cProfile cProfile.runctx("runtest()", globals(), locals(), sort="cumtime") else: runtest() print = builtins.print if 'FERENDA_SET_TESTFILE' in os.environ: print("Overwriting '%s' with result of parse ('%s')" % (xhtml_file, basefile)) util.robust_rename(xhtml_file, xhtml_file + "~") shutil.copy2(, xhtml_file) return self.assertEqualXML(util.readfile(xhtml_file), util.readfile(, tidy_xhtml=True)
# for win32 compatibility and simple test case code def p(self, path, prepend_datadir=True): if prepend_datadir: path = self.datadir + "/" + path return path.replace('/', '\\') if os.sep == '\\' else path
# Adapted from # import doctest
[docs]class Py23DocChecker(doctest.OutputChecker): """Checker to use in conjuction with :py:class:`doctest.DocTestSuite`."""
[docs] def check_output(self, want, got, optionflags): #return doctest.OutputChecker.check_output(self, want, got, optionflags) if sys.version_info[0] < 3: if want != got: # if running on py2, attempt to prefix all the strings # with a u (since all our apis use unicode strings) want = re.sub(b"'(.*?)'", b"u'\\1'", want) # want = re.sub('"(.*?)"', 'u"\\1"', want) -- doctest strings always (?) # only use singlequoted strings return doctest.OutputChecker.check_output(self, want, got, optionflags)
[docs]def parametrize(cls, template_method, name, params, wrapper=None): """Creates a new test method on a TestCase class, which calls a specific template method with the given parameters (ie. a parametrized test). Given a testcase like this:: class MyTest(unittest.TestCase): def my_general_test(self, parameter): self.assertEqual(parameter, "hello") and the following top-level initalization code:: parametrize(MyTest,MyTest.my_general_test, "test_one", ["hello"]) parametrize(MyTest,MyTest.my_general_test, "test_two", ["world"]) you end up with a test case class with two methods. Using e.g. ``unittest discover`` (or any other unittest-compatible test runner), the following should be the result:: test_one (test_parametric.MyTest) ... ok test_two (test_parametric.MyTest) ... FAIL ====================================================================== FAIL: test_two (test_parametric.MyTest) ---------------------------------------------------------------------- Traceback (most recent call last): File "./ferenda/", line 365, in test_method template_method(self, *params) File "./", line 6, in my_general_test self.assertEqual(parameter, "hello") AssertionError: 'world' != 'hello' - world + hello :param cls: The ``TestCase`` class to add the parametrized test to. :param template_method: The method to use for parametrization :param name: The name for the new test method :type name: str :param params: The parameter list (Note: keyword parameters are not supported) :type params: list :param wrapper: A unittest decorator like :py:func:`unittest.skip` or :py:func:`unittest.expectedFailure`. :param wrapper: callable """ # internal entrypoint for tesst def test_method(self): template_method(self, *params) try: test_method.__name__ = name except TypeError: # In py2, all method names (eg all identifiers) must be ascii only # represented as bytestrings. test_method.__name__ = name.encode() # wrapper is a unittest decorator like skip or expectedFailure if wrapper: setattr(cls, name, wrapper(test_method)) else: setattr(cls, name, test_method)
[docs]def file_parametrize(cls, directory, suffix, filter=None, wrapper=None): """Creates a test for each file in a given directory. Call with any class that subclasses unittest.TestCase and which has a method called `` parametric_test``, eg:: class MyTest(unittest.TestCase): def parametric_test(self,filename): self.assertTrue(os.path.exists(filename)) from ferenda.testutil import file_parametrize file_parametrize(Parse,"test/files/legaluri",".txt") For each .txt file in the directory ``test/files/legaluri``, a corresponding test is created, which calls ``parametric_test`` with the full path to the .txt file as parameter. :param cls: TestCase to add the parametrized test to. :type cls: class :param directory: The path to the files to turn into tests :type directory: str :param suffix: Suffix of the files that should be turned into tests (other files in the directory are ignored) :type directory: str :param filter: A function to be called with the name of each found file. If this function returns True, no test is created :type params: callable :param wrapper: A unittest decorator like :py:func:`unittest.skip` or :py:func:`unittest.expectedFailure`. :param wrapper: callable (decorator) """ params = [] for filename in os.listdir(directory): if filename.endswith(suffix): if filter and filter(filename): continue testname = filename[:-len(suffix)] testname = "test_" + testname.replace("-", "_") params.append((testname, directory + os.path.sep + filename)) for (name, param) in params: parametrize(cls, cls.parametric_test, name, (param,), wrapper)
[docs]def parametrize_repotester(cls, include_failures=True): """Helper function to activate a :py:class:`ferenda.testutil.RepoTester` based class (see the documentation for that class). :param cls: The RepoTester-based class to create tests on. :type param: class :param include_failures: Create parse/distill tests even if the corresponding xhtml/ttl files doesn't exist :type include_failures: bool """ docroot = cls.docroot # 1. download tests if os.path.exists(docroot + "/source"): for filename in os.listdir(docroot + "/source"): if filename.endswith(".json"): testname = "test_download_" + filename[:-5].replace("-", "_") fullname = docroot + "/source/" + filename parametrize(cls, cls.download_test, testname, (fullname,)) # 2. parse tests # for filename in os.listdir(docroot + "/downloaded"): basedir = docroot + "/downloaded" store = cls.repoclass.documentstore_class(docroot) store.downloaded_suffix = cls.repoclass.downloaded_suffix store.storage_policy = cls.repoclass.storage_policy for basefile in store.list_basefiles_for("parse"): pathfrag = store.basefile_to_pathfrag(basefile) filename = store.downloaded_path(basefile) filename = filename[len(basedir) + 1:] downloaded_file = "%s/downloaded/%s" % (docroot, filename) basetest = basefile.replace( "-", "_").replace( os.sep, "_").replace( "/", "_").replace( ":", "_").replace( " ", "_") # transliterate basetest (ie å -> a) basetest = "".join((c for c in unicodedata.normalize('NFKD', basetest) if not unicodedata.combining(c))) if "FERENDA_SKIP_DISTILL_TEST" not in os.environ: # Test 1: is rdf distilled correctly? rdf_file = "%s/distilled/%s.ttl" % (docroot, pathfrag) testname = ("test_distill_" + basetest) # wrapper = None wrapper = unittest.expectedFailure if not os.path.exists(rdf_file) else None if wrapper is None or include_failures: parametrize( cls, cls.distill_test, testname, (downloaded_file, rdf_file, docroot), wrapper) # Test 2: is xhtml parsed correctly? xhtml_file = "%s/parsed/%s.xhtml" % (docroot, pathfrag) testname = ("test_parse_" + basetest) wrapper = unittest.expectedFailure if not os.path.exists(xhtml_file) else None if wrapper is None or include_failures: parametrize( cls, cls.parse_test, testname, (downloaded_file, xhtml_file, docroot), wrapper)
[docs]def testparser(testcase, parser, filename): """Helper function to test :py:class:`~ferenda.FSMParser` based parsers.""" wantfilename = filename.replace(".txt", ".xml") if not os.path.exists(wantfilename) or 'FERENDA_FSMDEBUG' in os.environ: parser.debug = True tr = TextReader(filename, encoding="utf-8", linesep=TextReader.UNIX) b = parser.parse(tr.getiterator(tr.readparagraph)) if 'FERENDA_FSMDEBUG' in os.environ: print(elements.serialize(b)) testcase.maxDiff = 4096 if os.path.exists(wantfilename): with, encoding="utf-8") as fp: want = got = elements.serialize(b).strip() testcase.assertEqualXML(want, got) else: raise AssertionError("Want file not found. Result of parse:\n" + elements.serialize(b))