File: test_tracker.py

package info (click to toggle)
tap.py 3.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 476 kB
  • sloc: python: 1,808; makefile: 164; sh: 40
file content (318 lines) | stat: -rw-r--r-- 11,313 bytes parent folder | download | duplicates (2)
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
import inspect
import os
import tempfile
from io import StringIO
from unittest import mock

from tap.tests import TestCase
from tap.tracker import Tracker


class TestTracker(TestCase):
    def _make_header(self, test_case):
        return f"# TAP results for {test_case}"

    def test_has_test_cases(self):
        tracker = Tracker()
        self.assertEqual(tracker._test_cases, {})

    def test_tracks_class(self):
        tracker = Tracker()
        tracker._track("FakeTestClass")
        self.assertEqual(tracker._test_cases.get("FakeTestClass"), [])

    def test_adds_ok(self):
        tracker = Tracker()
        tracker.add_ok("FakeTestCase", "a description")
        line = tracker._test_cases["FakeTestCase"][0]
        self.assertTrue(line.ok)
        self.assertEqual(line.description, "a description")

    def test_adds_not_ok(self):
        tracker = Tracker()
        tracker.add_not_ok("FakeTestCase", "a description")
        line = tracker._test_cases["FakeTestCase"][0]
        self.assertFalse(line.ok)
        self.assertEqual(line.description, "a description")

    def test_adds_skip(self):
        tracker = Tracker()
        tracker.add_skip("FakeTestCase", "a description", "a reason")
        line = tracker._test_cases["FakeTestCase"][0]
        self.assertTrue(line.ok)
        self.assertEqual(line.description, "a description")
        self.assertEqual(line.directive.text, "SKIP a reason")

    def test_generates_tap_reports_in_new_outdir(self):
        tempdir = tempfile.mkdtemp()
        outdir = os.path.join(tempdir, "non", "existent", "path")
        tracker = Tracker(outdir=outdir)
        tracker.add_ok("FakeTestCase", "I should be in the specified dir.")

        tracker.generate_tap_reports()

        tap_file = os.path.join(outdir, "FakeTestCase.tap")
        self.assertTrue(os.path.exists(tap_file))

    def test_generates_tap_reports_in_existing_outdir(self):
        outdir = tempfile.mkdtemp()
        tracker = Tracker(outdir=outdir)
        tracker.add_ok("FakeTestCase", "I should be in the specified dir.")

        tracker.generate_tap_reports()

        tap_file = os.path.join(outdir, "FakeTestCase.tap")
        self.assertTrue(os.path.exists(tap_file))

    def test_results_not_combined_by_default(self):
        tracker = Tracker()
        self.assertFalse(tracker.combined)

    def test_individual_report_has_no_plan_when_combined(self):
        outdir = tempfile.mkdtemp()
        tracker = Tracker(outdir=outdir, combined=True)
        tracker.add_ok("FakeTestCase", "Look ma, no plan!")
        out_file = StringIO()

        tracker.generate_tap_report(
            "FakeTestCase", tracker._test_cases["FakeTestCase"], out_file
        )

        report = out_file.getvalue()
        self.assertTrue("Look ma" in report)
        self.assertFalse("1.." in report)

    @mock.patch("tap.tracker.ENABLE_VERSION_13", False)
    def test_combined_results_in_one_file_tap_version_12(self):
        outdir = tempfile.mkdtemp()
        tracker = Tracker(outdir=outdir, combined=True)
        tracker.add_ok("FakeTestCase", "YESSS!")
        tracker.add_ok("DifferentFakeTestCase", "GOAAL!")

        tracker.generate_tap_reports()

        self.assertFalse(os.path.exists(os.path.join(outdir, "FakeTestCase.tap")))
        self.assertFalse(
            os.path.exists(os.path.join(outdir, "DifferentFakeTestCase.tap"))
        )
        with open(os.path.join(outdir, "testresults.tap")) as f:
            report = f.read()
        expected = inspect.cleandoc(
            """{header_1}
            ok 1 YESSS!
            {header_2}
            ok 2 GOAAL!
            1..2
            """.format(
                header_1=self._make_header("FakeTestCase"),
                header_2=self._make_header("DifferentFakeTestCase"),
            )
        )
        self.assertEqual(report.strip(), expected)

    @mock.patch("tap.tracker.ENABLE_VERSION_13", True)
    def test_combined_results_in_one_file_tap_version_13(self):
        outdir = tempfile.mkdtemp()
        tracker = Tracker(outdir=outdir, combined=True)
        tracker.add_ok("FakeTestCase", "YESSS!")
        tracker.add_ok("DifferentFakeTestCase", "GOAAL!")

        tracker.generate_tap_reports()

        self.assertFalse(os.path.exists(os.path.join(outdir, "FakeTestCase.tap")))
        self.assertFalse(
            os.path.exists(os.path.join(outdir, "DifferentFakeTestCase.tap"))
        )
        with open(os.path.join(outdir, "testresults.tap")) as f:
            report = f.read()
        expected = inspect.cleandoc(
            """
            TAP version 13
            {header_1}
            ok 1 YESSS!
            {header_2}
            ok 2 GOAAL!
            1..2
            """.format(
                header_1=self._make_header("FakeTestCase"),
                header_2=self._make_header("DifferentFakeTestCase"),
            )
        )
        self.assertEqual(report.strip(), expected)

    def test_tracker_does_not_stream_by_default(self):
        tracker = Tracker()
        self.assertFalse(tracker.streaming)

    def test_tracker_has_stream(self):
        tracker = Tracker()
        self.assertTrue(tracker.stream is None)

    @mock.patch("tap.tracker.ENABLE_VERSION_13", False)
    def test_add_ok_writes_to_stream_while_streaming(self):
        stream = StringIO()
        tracker = Tracker(streaming=True, stream=stream)

        tracker.add_ok("FakeTestCase", "YESSS!")
        tracker.add_ok("AnotherTestCase", "Sure.")

        expected = inspect.cleandoc(
            """{header_1}
            ok 1 YESSS!
            {header_2}
            ok 2 Sure.
            """.format(
                header_1=self._make_header("FakeTestCase"),
                header_2=self._make_header("AnotherTestCase"),
            )
        )
        self.assertEqual(stream.getvalue().strip(), expected)

    @mock.patch("tap.tracker.ENABLE_VERSION_13", False)
    def test_add_not_ok_writes_to_stream_while_streaming(self):
        stream = StringIO()
        tracker = Tracker(streaming=True, stream=stream)

        tracker.add_not_ok("FakeTestCase", "YESSS!")

        expected = inspect.cleandoc(
            """{header}
            not ok 1 YESSS!
            """.format(header=self._make_header("FakeTestCase"))
        )
        self.assertEqual(stream.getvalue().strip(), expected)

    @mock.patch("tap.tracker.ENABLE_VERSION_13", False)
    def test_add_skip_writes_to_stream_while_streaming(self):
        stream = StringIO()
        tracker = Tracker(streaming=True, stream=stream)

        tracker.add_skip("FakeTestCase", "YESSS!", "a reason")

        expected = inspect.cleandoc(
            """{header}
            ok 1 YESSS! # SKIP a reason
            """.format(header=self._make_header("FakeTestCase"))
        )
        self.assertEqual(stream.getvalue().strip(), expected)

    def test_streaming_does_not_write_files(self):
        outdir = tempfile.mkdtemp()
        stream = StringIO()
        tracker = Tracker(outdir=outdir, streaming=True, stream=stream)
        tracker.add_ok("FakeTestCase", "YESSS!")

        tracker.generate_tap_reports()

        self.assertFalse(os.path.exists(os.path.join(outdir, "FakeTestCase.tap")))

    @mock.patch("tap.tracker.ENABLE_VERSION_13", False)
    def test_streaming_writes_plan(self):
        stream = StringIO()
        tracker = Tracker(streaming=True, stream=stream)
        tracker.combined_line_number = 42

        tracker.generate_tap_reports()

        self.assertEqual(stream.getvalue(), "1..42\n")

    @mock.patch("tap.tracker.ENABLE_VERSION_13", False)
    def test_write_plan_first_streaming(self):
        outdir = tempfile.mkdtemp()
        stream = StringIO()
        tracker = Tracker(outdir=outdir, streaming=True, stream=stream)
        tracker.set_plan(123)
        tracker.add_ok("FakeTestCase", "YESSS!")

        tracker.generate_tap_reports()

        self.assertEqual(
            stream.getvalue(),
            "1..123\n{header}\nok 1 YESSS!\n".format(
                header=self._make_header("FakeTestCase")
            ),
        )
        self.assertFalse(os.path.exists(os.path.join(outdir, "FakeTestCase.tap")))

    @mock.patch("tap.tracker.ENABLE_VERSION_13", False)
    def test_write_plan_immediate_streaming(self):
        stream = StringIO()
        Tracker(streaming=True, stream=stream, plan=123)
        self.assertEqual(stream.getvalue(), "1..123\n")

    @mock.patch("tap.tracker.ENABLE_VERSION_13", False)
    def test_write_plan_first_combined(self):
        outdir = tempfile.mkdtemp()
        tracker = Tracker(streaming=False, outdir=outdir, combined=True)
        tracker.set_plan(123)
        tracker.generate_tap_reports()
        with open(os.path.join(outdir, "testresults.tap")) as f:
            lines = f.readlines()
        self.assertEqual(lines[0], "1..123\n")

    @mock.patch("tap.tracker.ENABLE_VERSION_13", False)
    def test_write_plan_first_not_combined(self):
        outdir = tempfile.mkdtemp()
        tracker = Tracker(streaming=False, outdir=outdir, combined=False)
        with self.assertRaises(ValueError):
            tracker.set_plan(123)

    @mock.patch("tap.tracker.ENABLE_VERSION_13", True)
    def test_streaming_writes_tap_version_13(self):
        stream = StringIO()
        tracker = Tracker(streaming=True, stream=stream)

        tracker.add_skip("FakeTestCase", "YESSS!", "a reason")

        expected = inspect.cleandoc(
            """
            TAP version 13
            {header}
            ok 1 YESSS! # SKIP a reason
            """.format(header=self._make_header("FakeTestCase"))
        )
        self.assertEqual(stream.getvalue().strip(), expected)

    def test_get_default_tap_file_path(self):
        tracker = Tracker()
        file_path = tracker._get_tap_file_path("foo")
        self.assertEqual("foo.tap", file_path)

    def test_sanitizes_tap_file_path(self):
        tracker = Tracker()
        file_path = tracker._get_tap_file_path("an awful \\ testcase / name\n")
        self.assertEqual("an-awful---testcase---name-.tap", file_path)

    def test_adds_ok_with_diagnostics(self):
        tracker = Tracker()
        tracker.add_ok("FakeTestCase", "a description", diagnostics="# more info\n")
        line = tracker._test_cases["FakeTestCase"][0]
        self.assertEqual("# more info\n", line.diagnostics)

    def test_adds_not_ok_with_diagnostics(self):
        tracker = Tracker()
        tracker.add_not_ok("FakeTestCase", "a description", diagnostics="# more info\n")
        line = tracker._test_cases["FakeTestCase"][0]
        self.assertEqual("# more info\n", line.diagnostics)

    def test_header_displayed_by_default(self):
        tracker = Tracker()
        self.assertTrue(tracker.header)

    def test_header_set_by_init(self):
        tracker = Tracker(header=False)
        self.assertFalse(tracker.header)

    @mock.patch("tap.tracker.ENABLE_VERSION_13", False)
    def test_does_not_write_header(self):
        stream = StringIO()
        tracker = Tracker(streaming=True, stream=stream, header=False)

        tracker.add_skip("FakeTestCase", "YESSS!", "a reason")

        expected = inspect.cleandoc(
            """
            ok 1 YESSS! # SKIP a reason
            """
        )
        self.assertEqual(stream.getvalue().strip(), expected)