test_matchers.py

"""
Tests for L{twisted.trial.test.matchers}.
"""
from hamcrest import anything, assert_that, contains_string, equal_to, not_
from hamcrest.core.core.allof import AllOf
from hamcrest.core.string_description import StringDescription
from hypothesis import given
from hypothesis.strategies import just, sampled_from, text

from twisted.python.filepath import FilePath
from twisted.trial.unittest import SynchronousTestCase
from .matchers import fileContents

class FileContentsTests(SynchronousTestCase):
    """
    Tests for L{fileContents}.
    """

@given(text(), just("utf-8"))
    def test_matches(self, contents: str, encoding: str) -> None:
        """
        L{fileContents} matches a L{IFilePath} that refers to a file that
        contains a string that is matched by the parameterized matcher.

:param contents: The text string to place in the file and match
            against.

:param encoding: The text encoding to use to encode C{contents} when
            writing to the file.
        """
        p = FilePath(self.mktemp())
        p.setContent(contents.encode(encoding))

description = StringDescription()
        assert_that(
            fileContents(equal_to(contents)).matches(p, description), equal_to(True)
        )
        assert_that(str(description), equal_to(""))

@given(
        just("some text, it doesn't matter what"),
        sampled_from(["ascii", "latin-1", "utf-8"]),
    )
    def test_mismatches(self, contents: str, encoding: str) -> None:
        """
        L{fileContents} does not match an L{IFilePath} that refers to a
        file that contains a string that is not matched by the parameterized
        matcher.

:param contents: The text string to place in the file and match
            against.

:param encoding: The text encoding to use to encode C{contents} when
            writing to the file.
        """
        p = FilePath(self.mktemp())
        p.setContent(contents.encode(encoding))

description = StringDescription()
        assert_that(
            fileContents(not_(anything())).matches(p, description), equal_to(False)
        )
        assert_that(str(description), equal_to(f"was <{p}>"))

def test_ioerror(self) -> None:
        """
        L{fileContents} reports details of any I/O error encountered while
        attempting to match.
        """
        p = FilePath(self.mktemp())

description = StringDescription()
        assert_that(fileContents(anything()).matches(p, description), equal_to(False))
        assert_that(
            str(description),
            # It must contain at least ...
            AllOf(
                # the name of the matcher.
                contains_string("fileContents"),
                # the name of the exception raised.
                contains_string("FileNotFoundError"),
                # the repr (so weird values are escaped) of the path being
                # matched against.
                contains_string(repr(p.path)),
            ),
        )

docroot: /var/www/469ed2f6-4d4b-4a8a-9f5e-ee4ef04d3bc8/public_html

curdir: /usr/lib/python3/dist-packages/twisted/trial/test

	.	4096
	..	4096
X	__init__.py	1716
	__pycache__	4096
X	detests.py	5760
X	erroneous.py	6593
X	matchers.py	2953
X	mockcustomsuite.py	544
X	mockcustomsuite2.py	541
X	mockcustomsuite3.py	684
X	mockdoctest.py	2421
X	moduleself.py	178
X	moduletest.py	302
X	novars.py	182
X	ordertests.py	912
X	packages.py	4651
X	pyunitcases.py	3173
X	sample.py	2180
X	scripttest.py	457
X	skipping.py	6134
X	suppression.py	2499
X	test_assertions.py	60813
X	test_asyncassertions.py	2552
X	test_deferred.py	9864
X	test_doctest.py	1803
X	test_keyboard.py	4054
X	test_loader.py	24522
X	test_log.py	8040
X	test_matchers.py	3037
X	test_output.py	5384
X	test_plugins.py	1468
X	test_pyunitcompat.py	8067
X	test_reporter.py	57793
X	test_runner.py	32255
X	test_script.py	33191
X	test_skip.py	2755
X	test_suppression.py	5911
X	test_testcase.py	1985
X	test_tests.py	49997
X	test_util.py	22166
X	test_warning.py	18842
X	weird.py	675