testutils.py

import glob
import os
import os.path
import sys

from pathlib import Path
from infrastructure.extraLoggers import mustsee


def configureTestImportPaths(testFile):
    """Make project modules and the local compare_pdf helper importable.

    Tests are useful both through pytest and when a developer executes one
    test file directly.  The latter has the test's directory, rather than the
    repository root, on ``sys.path``.  Deriving paths from ``testFile`` avoids
    depending on the current working directory used by Visual Studio, pytest,
    or a command prompt.

    The local compare_pdf directory is retained as a fallback for developers
    who have not installed that helper package.  Both paths are inserted ahead
    of installed packages so the test always exercises this working tree.
    """
    projectRoot = Path(testFile).resolve().parents[2]
    comparePdfPath = projectRoot / 'tests' / 'compare-pdf' / 'compare_pdf'

    for importPath in reversed((projectRoot, comparePdfPath)):
        importPathText = str(importPath)
        if importPathText in sys.path:
            sys.path.remove(importPathText)
        sys.path.insert(0, importPathText)


def getLatestResultFile(albumFolderBasename, pattern: str) -> str:
    resultpdfpattern = str(Path(Path.cwd(), 'tests', f"{albumFolderBasename}", 'previous_result_pdfs', pattern))
    resultpdffiles = glob.glob(resultpdfpattern)
    # I used to sort on the modification date in order to find the latest file:
    #   resultpdffiles.sort(key=os.path.getmtime, reverse=True)
    # but that doesn't work when we run automated tests on github machines. So
    # I guess we'll just have to rely on the naming convention:
    resultpdffiles.sort(key=os.path.basename, reverse=True)
    return resultpdffiles[0] if len(resultpdffiles) > 0 else None


def createVariationMcf(dom, outFile):
    # Write the variation mcf and build a book from it. The effort in getting the edited
    #  mcf file in a particular form is done that we can potentially manually compare it
    #  with the original mcf file and be sure that it is not changed in unexpected ways
    # Parse the mcf file to create variations using xml.dom.minidom rather than xml.etree.ElementTree
    #  Copilot suggested this choice because etree is bad at parsing CDATA
    with open(outFile, "w", encoding="utf-8") as file:
        # Write a custom xml declaration including the encoding which is
        # not emitted by the simplest one-line solution here:
        #   file.write(dom.toxml())
        file.write('<?xml version="1.0" encoding="UTF-8"?>\n')

        # Write the xml content, skipping the declaration we have just done
        pretty_xml = dom.documentElement.toprettyxml(indent="  ")
        # Remove excess blank lines introduced by `toprettyxml`
        clean_xml = "\n".join([line for line in pretty_xml.splitlines() if line.strip()])
        file.write(clean_xml)


def runModifications(main, tryToBuildBook, albumFolderBasename, albumBasename, dom, attribute_modifications, elementToModify):
    # build a pdf with the supplied tryToBuildBook method with the sets of attribute modifications
    # on the supplied element to modify in the document dom
    filesToDelete = []
    for variationName, modifications in attribute_modifications.items():
        for attr, value in modifications.items():
            elementToModify.setAttribute(attr, value)  # Modify attributes

        # Save the modified xml to a new file
        outFileBasename = f'{albumBasename}_{variationName}.mcf'
        outFile = str(Path(Path.cwd(), 'tests', f"{albumFolderBasename}", outFileBasename))
        pdfFile = f'{outFile}.pdf'
        latestResultFile = getLatestResultFile(albumFolderBasename, f"*{variationName}.mcf.pdf")

        createVariationMcf(dom, outFile)
        try:
            result = tryToBuildBook(outFile, pdfFile, latestResultFile, False, 28)
        except AssertionError:
            if not main:
                # if we're not testing "by hand" (i.e. we're using pytest) then raise
                # the exception further and abandon the test
                raise
            # but if we're testing by hand, continue to complete all the tests in the run
            mustsee.error(f"Test variation {variationName} had an assertion error, but continuing in a non-pytest run")
            result = False
        if result:
            mustsee.info(f"Test variation {variationName} ok, variation files added to deletion list")
            filesToDelete.append(outFile)
            filesToDelete.append(pdfFile)

    # do not delete the variation files until all test are run, so they
    # are present while we are debugging
    if not main:
        for f in filesToDelete:
            os.remove(f)


def getOutFileBasename(main, albumBasename, yyyymmdd, styleid):
    if (main):
        # use an undated output file name when running as main rather than via pytest
        outFileBasename = f'{albumBasename}.mcf.{styleid}.pdf'
    else:
        outFileBasename = f'{albumBasename}.mcf.{yyyymmdd}{styleid}.pdf'
    return outFileBasename