patacrep/test/test_chordpro/test_parser.py

"""Tests for the chordpro parser."""

# pylint: disable=too-few-public-methods

import glob
import os
import unittest
from pkg_resources import resource_filename

from patacrep import files
from patacrep.build import DEFAULT_CONFIG

from .. import disable_logging

LANGUAGES = {
    'tex': 'latex',
    'sgc': 'chordpro',
    'html': 'html',
}

class FileTestMeta(type):
    """Metaclass that creates on-the-fly test function according to files.

    See the :class:`FileTest` documentation for more information.
    """

    def __init__(cls, name, bases, nmspc):
        super().__init__(name, bases, nmspc)

        # Setting datadir
        cls.config = DEFAULT_CONFIG
        if 'datadir' not in cls.config:
            cls.config['datadir'] = []
        cls.config['datadir'].append(resource_filename(__name__, 'datadir'))

        cls.song_plugins = files.load_plugins(
            datadirs=cls.config['datadir'],
            root_modules=['songs'],
            keyword='SONG_RENDERERS',
            )
        for source in sorted(glob.glob(os.path.join(
                os.path.dirname(__file__),
                '*.source',
            ))):
            base = os.path.relpath(source, os.getcwd())[:-len(".source")]
            for dest in LANGUAGES:
                destname = "{}.{}".format(base, dest)
                if not os.path.exists(destname):
                    continue
                setattr(
                    cls,
                    "test_{}_{}".format(os.path.basename(base), dest),
                    cls._create_test(base, dest),
                    )

    @staticmethod
    def _create_test(base, dest):
        """Return a function testing that `base` compilation in `dest` format.
        """

        def test_parse_render(self):
            """Test that `base` is correctly parsed and rendered."""
            if base is None or dest is None:
                return
            destname = "{}.{}".format(base, dest)
            with open(destname, 'r', encoding='utf8') as expectfile:
                chordproname = "{}.source".format(base)
                with disable_logging():
                    self.assertMultiLineEqual(
                        self.song_plugins[LANGUAGES[dest]]['sgc'](chordproname, self.config).render(
                            output=chordproname,
                            ).strip(),
                        expectfile.read().strip(),
                        )

        test_parse_render.__doc__ = (
            "Test that '{base}' is correctly parsed and rendererd into '{format}' format."
            ).format(base=os.path.basename(base), format=dest)
        return test_parse_render

class FileTest(unittest.TestCase, metaclass=FileTestMeta):
    """Test of chorpro parser, and several renderers.

    For any given `foo.source`, it is parsed as a chordpro file, and should be
    rendered as `foo.sgc` with the chordpro renderer, and `foo.tex` with the
    latex renderer.

    This class does nothing by itself, but its metaclass populates it with test
    methods testing parser and renderers.
    """

    maxDiff = None