imgdiff/tests.py at master · Foxglove144/imgdiff · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
import doctest
import os
import shutil
import sys
import tempfile
import unittest

import mock

import imgdiff

from io import StringIO


@mock.patch("sys.stderr", StringIO())
class TestMain(unittest.TestCase):

    def setUp(self):
        self.tmpdir = None
        # Patch spawn_viewer to prevent subprocess calls during tests
        self.patcher = mock.patch("imgdiff.spawn_viewer")
        self.mock_spawn_viewer = self.patcher.start()

    def tearDown(self):
        self.patcher.stop()
        if self.tmpdir:
            shutil.rmtree(self.tmpdir)

    def mkdtemp(self):
        if self.tmpdir is None:
            self.tmpdir = tempfile.mkdtemp(prefix="imgdiff-tests-")
        return self.tmpdir

    def main(self, *args):
        try:
            imgdiff.main(["imgdiff"] + list(args))
        except SystemExit:
            pass

    def test_color_parsing_in_options(self):
        self.main("--bgcolor", "invalid", "foo", "bar")
        self.assertIn(
            "error: option --bgcolor: invalid color value: 'invalid'",
            sys.stderr.getvalue(),
        )

    def test_wrong_number_of_arguments(self):
        self.main("foo.png")
        self.assertIn("error: expecting two arguments, got 1", sys.stderr.getvalue())
        self.main("foo.png", "bar.png", "baz.png")
        self.assertIn("error: expecting two arguments, got 3", sys.stderr.getvalue())

    def test_two_directories(self):
        self.main("set1", "set2")
        self.assertIn(
            "error: at least one argument must be a file, not a directory",
            sys.stderr.getvalue(),
        )

    def test_all_ok(self):
        self.main("example1.png", "example2.png", "--viewer=true")

    def test_highlight(self):
        self.main("example1.png", "example2.png", "-H", "--viewer=true")

    def test_smart_highlight(self):
        self.main("example1.png", "example2.png", "-S", "--viewer=true")

    def test_outfile(self):
        fn = os.path.join(self.mkdtemp(), "diff.png")
        self.main("example1.png", "example2.png", "-o", fn)
        self.assertTrue(os.path.exists(fn))

    @mock.patch("imgdiff.Image.Image.show")
    def test_builtin_viewer(self, mock_show):
        self.main("example1.png", "example2.png")
        self.assertTrue(mock_show.called)

    def test_one_directory(self):
        self.main("set1/canary.png", "set2", "--viewer", "true")
        self.main("set1", "set2/canary.png", "--viewer", "true", "--tb")

    def test_different_size_images(self):
        # tickle the unexplored branches in best_diff()
        self.main("set1/extra-info.png", "set1/sample-graph.png", "--viewer=true", "-H")

    def test_different_size_images_sloow(self):
        # tickle the unexplored branches in slow_highlight()
        self.main("set1/extra-info.png", "set1/sample-graph.png", "--viewer=true", "-S")


class TestProgress(unittest.TestCase):

    def test_terminal_output(self):
        p = imgdiff.Progress(3, delay=0)
        p.stream = StringIO()
        p.isatty = True
        for n in range(3):
            p.next()
        p.done()
        self.assertEqual(
            p.stream.getvalue(),
            "\r33% (1 out of 3 possible alignments)"
            "\r66% (2 out of 3 possible alignments)"
            "\r100% (3 out of 3 possible alignments)"
            "\r\n",
        )

    def test_not_a_terminal(self):
        p = imgdiff.Progress(3, delay=0)
        p.stream = StringIO()
        p.isatty = False
        for n in range(3):
            p.next()
        p.done()
        self.assertEqual(p.stream.getvalue(), "")

    def test_cancel(self):
        cancel_event = mock.Mock()
        cancel_event.is_set.return_value = False

        p = imgdiff.Progress(3, cancel_event=cancel_event)
        p.stream = StringIO()
        p.isatty = False

        # should run fine if not cancelled
        p.next()

        # now cancel
        cancel_event.is_set.return_value = True
        self.assertRaises(imgdiff.Timeout, p.next)

        # done() shouldn't do anything since nothing was printed to the stream
        p.done()
        self.assertEqual(p.stream.getvalue(), "")


def test_suite():
    return unittest.TestSuite(
        [
            doctest.DocTestSuite(imgdiff),
            unittest.defaultTestLoader.loadTestsFromName(__name__),
        ]
    )


if __name__ == "__main__":
    unittest.main(defaultTest="test_suite")