forked from testing-cabal/testtools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNEWS
1274 lines (871 loc) · 44.2 KB
/
NEWS
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
testtools NEWS
++++++++++++++
Changes and improvements to testtools_, grouped by release.
NEXT
~~~~
Improvements
------------
* ``AnyMatch`` is now exported properly in ``testtools.matchers``.
(Robert Collins, Rob Kennedy, github #44)
* In Python 3.3, if there are duplicate test ids, tests.sort() will
fail and raise TypeError. Detect the duplicate test ids firstly in
sorted_tests() to ensure that all test ids are unique.
(Kui Shi, #1243922)
* ``json_content`` is now in the ``__all__`` attribute for
``testtools.content``. (Robert Collins)
* Network tests now bind to 127.0.0.1 to avoid (even temporary) network
visible ports. (Benedikt Morbach, github #46)
* Test listing now explicitly indicates by printing 'Failed to import' and
exiting (2) when an import has failed rather than only signalling through the
test name. (Robert Collins, #1245672)
* Added ability for ``testtools.TestCase`` instances to force a test to
fail, even if no assertions failed. (Thomi Richards)
* Added ``testtools.content.StacktraceContent``, a content object that
automatically creates a ``StackLinesContent`` object containing the current
stack trace. (Thomi Richards)
0.9.33
~~~~~~
Improvements
------------
* Added ``addDetailuniqueName`` method to ``testtools.TestCase`` class.
(Thomi Richards)
* Removed some unused code from ``testtools.content.TracebackContent``.
(Thomi Richards)
* Added ``testtools.StackLinesContent``: a content object for displaying
pre-processed stack lines. (Thomi Richards)
* ``StreamSummary`` was calculating testsRun incorrectly: ``exists`` status
tests were counted as run tests, but they are not.
(Robert Collins, #1203728)
0.9.32
~~~~~~
Regular maintenance release. Special thanks to new contributor, Xiao Hanyu!
Changes
-------
* ``testttols.compat._format_exc_info`` has been refactored into several
smaller functions. (Thomi Richards)
Improvements
------------
* Stacktrace filtering no longer hides unittest frames that are surrounded by
user frames. We will reenable this when we figure out a better algorithm for
retaining meaning. (Robert Collins, #1188420)
* The compatibility code for skipped tests with unittest2 was broken.
(Robert Collins, #1190951)
* Various documentation improvements (Clint Byrum, Xiao Hanyu).
0.9.31
~~~~~~
Improvements
------------
* ``ExpectedException`` now accepts a msg parameter for describing an error,
much the same as assertEquals etc. (Robert Collins)
0.9.30
~~~~~~
A new sort of TestResult, the StreamResult has been added, as a prototype for
a revised standard library test result API. Expect this API to change.
Although we will try to preserve compatibility for early adopters, it is
experimental and we might need to break it if it turns out to be unsuitable.
Improvements
------------
* ``assertRaises`` works properly for exception classes that have custom
metaclasses
* ``ConcurrentTestSuite`` was silently eating exceptions that propagate from
the test.run(result) method call. Ignoring them is fine in a normal test
runner, but when they happen in a different thread, the thread that called
suite.run() is not in the stack anymore, and the exceptions are lost. We now
create a synthetic test recording any such exception.
(Robert Collins, #1130429)
* Fixed SyntaxError raised in ``_compat2x.py`` when installing via Python 3.
(Will Bond, #941958)
* New class ``StreamResult`` which defines the API for the new result type.
(Robert Collins)
* New support class ``ConcurrentStreamTestSuite`` for convenient construction
and utilisation of ``StreamToQueue`` objects. (Robert Collins)
* New support class ``CopyStreamResult`` which forwards events onto multiple
``StreamResult`` objects (each of which receives all the events).
(Robert Collins)
* New support class ``StreamSummary`` which summarises a ``StreamResult``
stream compatibly with ``TestResult`` code. (Robert Collins)
* New support class ``StreamTagger`` which adds or removes tags from
``StreamResult`` events. (RobertCollins)
* New support class ``StreamToDict`` which converts a ``StreamResult`` to a
series of dicts describing a test. Useful for writing trivial stream
analysers. (Robert Collins)
* New support class ``TestControl`` which permits cancelling an in-progress
run. (Robert Collins)
* New support class ``StreamFailFast`` which calls a ``TestControl`` instance
to abort the test run when a failure is detected. (Robert Collins)
* New support class ``ExtendedToStreamDecorator`` which translates both regular
unittest TestResult API calls and the ExtendedTestResult API which testtools
has supported into the StreamResult API. ExtendedToStreamDecorator also
forwards calls made in the StreamResult API, permitting it to be used
anywhere a StreamResult is used. Key TestResult query methods like
wasSuccessful and shouldStop are synchronised with the StreamResult API
calls, but the detailed statistics like the list of errors are not - a
separate consumer will be created to support that.
(Robert Collins)
* New support class ``StreamToExtendedDecorator`` which translates
``StreamResult`` API calls into ``ExtendedTestResult`` (or any older
``TestResult``) calls. This permits using un-migrated result objects with
new runners / tests. (Robert Collins)
* New support class ``StreamToQueue`` for sending messages to one
``StreamResult`` from multiple threads. (Robert Collins)
* New support class ``TimestampingStreamResult`` which adds a timestamp to
events with no timestamp. (Robert Collins)
* New ``TestCase`` decorator ``DecorateTestCaseResult`` that adapts the
``TestResult`` or ``StreamResult`` a case will be run with, for ensuring that
a particular result object is used even if the runner running the test doesn't
know to use it. (Robert Collins)
* New test support class ``testtools.testresult.doubles.StreamResult``, which
captures all the StreamResult events. (Robert Collins)
* ``PlaceHolder`` can now hold tags, and applies them before, and removes them
after, the test. (Robert Collins)
* ``PlaceHolder`` can now hold timestamps, and applies them before the test and
then before the outcome. (Robert Collins)
* ``StreamResultRouter`` added. This is useful for demultiplexing - e.g. for
partitioning analysis of events or sending feedback encapsulated in
StreamResult events back to their source. (Robert Collins)
* ``testtools.run.TestProgram`` now supports the ``TestRunner`` taking over
responsibility for formatting the output of ``--list-tests``.
(Robert Collins)
* The error message for setUp and tearDown upcall errors was broken on Python
3.4. (Monty Taylor, Robert Collins, #1140688)
* The repr of object() on pypy includes the object id, which was breaking a
test that accidentally depended on the CPython repr for object().
(Jonathan Lange)
0.9.29
~~~~~~
A simple bug fix, and better error messages when you don't up-call.
Changes
-------
* ``testtools.content_type.ContentType`` incorrectly used ',' rather than ';'
to separate parameters. (Robert Collins)
Improvements
------------
* ``testtools.compat.unicode_output_stream`` was wrapping a stream encoder
around ``io.StringIO`` and ``io.TextIOWrapper`` objects, which was incorrect.
(Robert Collins)
* Report the name of the source file for setUp and tearDown upcall errors.
(Monty Taylor)
0.9.28
~~~~~~
Testtools has moved VCS - https://github.com/testing-cabal/testtools/ is
the new home. Bug tracking is still on Launchpad, and releases are on Pypi.
We made this change to take advantage of the richer ecosystem of tools around
Git, and to lower the barrier for new contributors.
Improvements
------------
* New ``testtools.testcase.attr`` and ``testtools.testcase.WithAttributes``
helpers allow marking up test case methods with simple labels. This permits
filtering tests with more granularity than organising them into modules and
test classes. (Robert Collins)
0.9.27
~~~~~~
Improvements
------------
* New matcher ``HasLength`` for matching the length of a collection.
(Robert Collins)
* New matcher ``MatchesPredicateWithParams`` make it still easier to create
ad hoc matchers. (Robert Collins)
* We have a simpler release process in future - see doc/hacking.rst.
(Robert Collins)
0.9.26
~~~~~~
Brown paper bag fix: failed to document the need for setup to be able to use
extras. Compounded by pip not supporting setup_requires.
Changes
-------
* setup.py now can generate egg_info even if extras is not available.
Also lists extras in setup_requires for easy_install.
(Robert Collins, #1102464)
0.9.25
~~~~~~
Changes
-------
* ``python -m testtools.run --load-list`` will now preserve any custom suites
(such as ``testtools.FixtureSuite`` or ``testresources.OptimisingTestSuite``)
rather than flattening them.
(Robert Collins, #827175)
* Testtools now depends on extras, a small library split out from it to contain
generally useful non-testing facilities. Since extras has been around for a
couple of testtools releases now, we're making this into a hard dependency of
testtools. (Robert Collins)
* Testtools now uses setuptools rather than distutils so that we can document
the extras dependency. (Robert Collins)
Improvements
------------
* Testtools will no longer override test code registered details called
'traceback' when reporting caught exceptions from test code.
(Robert Collins, #812793)
0.9.24
~~~~~~
Changes
-------
* ``testtools.run discover`` will now sort the tests it discovered. This is a
workaround for http://bugs.python.org/issue16709. Non-standard test suites
are preserved, and their ``sort_tests()`` method called (if they have such an
attribute). ``testtools.testsuite.sorted_tests(suite, True)`` can be used by
such suites to do a local sort. (Robert Collins, #1091512)
* ``ThreadsafeForwardingResult`` now defines a stub ``progress`` method, which
fixes ``testr run`` of streams containing progress markers (by discarding the
progress data). (Robert Collins, #1019165)
0.9.23
~~~~~~
Changes
-------
* ``run.TestToolsTestRunner`` now accepts the verbosity, buffer and failfast
arguments the upstream python TestProgram code wants to give it, making it
possible to support them in a compatible fashion. (Robert Collins)
Improvements
------------
* ``testtools.run`` now supports the ``-f`` or ``--failfast`` parameter.
Previously it was advertised in the help but ignored.
(Robert Collins, #1090582)
* ``AnyMatch`` added, a new matcher that matches when any item in a collection
matches the given matcher. (Jonathan Lange)
* Spelling corrections to documentation. (Vincent Ladeuil)
* ``TestProgram`` now has a sane default for its ``testRunner`` argument.
(Vincent Ladeuil)
* The test suite passes on Python 3 again. (Robert Collins)
0.9.22
~~~~~~
Improvements
------------
* ``content_from_file`` and ``content_from_stream`` now accept seek_offset and
seek_whence parameters allowing them to be used to grab less than the full
stream, or to be used with StringIO streams. (Robert Collins, #1088693)
0.9.21
~~~~~~
Improvements
------------
* ``DirContains`` correctly exposed, after being accidentally hidden in the
great matcher re-organization of 0.9.17. (Jonathan Lange)
0.9.20
~~~~~~
Three new matchers that'll rock your world.
Improvements
------------
* New, powerful matchers that match items in a dictionary:
- ``MatchesDict``, match every key in a dictionary with a key in a
dictionary of matchers. For when the set of expected keys is equal to the
set of observed keys.
- ``ContainsDict``, every key in a dictionary of matchers must be
found in a dictionary, and the values for those keys must match. For when
the set of expected keys is a subset of the set of observed keys.
- ``ContainedByDict``, every key in a dictionary must be found in
a dictionary of matchers. For when the set of expected keys is a superset
of the set of observed keys.
The names are a little confusing, sorry. We're still trying to figure out
how to present the concept in the simplest way possible.
0.9.19
~~~~~~
How embarrassing! Three releases in two days.
We've worked out the kinks and have confirmation from our downstreams that
this is all good. Should be the last release for a little while. Please
ignore 0.9.18 and 0.9.17.
Improvements
------------
* Include the matcher tests in the release, allowing the tests to run and
pass from the release tarball. (Jonathan Lange)
* Fix cosmetic test failures in Python 3.3, introduced during release 0.9.17.
(Jonathan Lange)
0.9.18
~~~~~~
Due to an oversight, release 0.9.18 did not contain the new
``testtools.matchers`` package and was thus completely broken. This release
corrects that, returning us all to normality.
0.9.17
~~~~~~
This release brings better discover support and Python3.x improvements. There
are still some test failures on Python3.3 but they are cosmetic - the library
is as usable there as on any other Python 3 release.
Changes
-------
* The ``testtools.matchers`` package has been split up. No change to the
public interface. (Jonathan Lange)
Improvements
------------
* ``python -m testtools.run discover . --list`` now works. (Robert Collins)
* Correctly handling of bytes vs text in JSON content type. (Martin [gz])
0.9.16
~~~~~~
Some new matchers and a new content helper for JSON content.
This is the first release of testtools to drop support for Python 2.4 and 2.5.
If you need support for either of those versions, please use testtools 0.9.15.
Improvements
------------
* New content helper, ``json_content`` (Jonathan Lange)
* New matchers:
* ``ContainsAll`` for asserting one thing is a subset of another
(Raphaël Badin)
* ``SameMembers`` for asserting two iterators have the same members.
(Jonathan Lange)
* Reraising of exceptions in Python 3 is more reliable. (Martin [gz])
0.9.15
~~~~~~
This is the last release to support Python2.4 and 2.5. It brings in a slew of
improvements to test tagging and concurrency, making running large test suites
with partitioned workers more reliable and easier to reproduce exact test
ordering in a given worker. See our sister project ``testrepository`` for a
test runner that uses these features.
Changes
-------
* ``PlaceHolder`` and ``ErrorHolder`` now support being given result details.
(Robert Collins)
* ``ErrorHolder`` is now just a function - all the logic is in ``PlaceHolder``.
(Robert Collins)
* ``TestResult`` and all other ``TestResult``-like objects in testtools
distinguish between global tags and test-local tags, as per the subunit
specification. (Jonathan Lange)
* This is the **last** release of testtools that supports Python 2.4 or 2.5.
These releases are no longer supported by the Python community and do not
receive security updates. If this affects you, you will need to either
stay on this release or perform your own backports.
(Jonathan Lange, Robert Collins)
* ``ThreadsafeForwardingResult`` now forwards global tags as test-local tags,
making reasoning about the correctness of the multiplexed stream simpler.
This preserves the semantic value (what tags apply to a given test) while
consuming less stream size (as no negative-tag statement is needed).
(Robert Collins, Gary Poster, #986434)
Improvements
------------
* API documentation corrections. (Raphaël Badin)
* ``ConcurrentTestSuite`` now takes an optional ``wrap_result`` parameter
that can be used to wrap the ``ThreadsafeForwardingResults`` created by
the suite. (Jonathan Lange)
* ``Tagger`` added. It's a new ``TestResult`` that tags all tests sent to
it with a particular set of tags. (Jonathan Lange)
* ``testresultdecorator`` brought over from subunit. (Jonathan Lange)
* All ``TestResult`` wrappers now correctly forward ``current_tags`` from
their wrapped results, meaning that ``current_tags`` can always be relied
upon to return the currently active tags on a test result.
* ``TestByTestResult``, a ``TestResult`` that calls a method once per test,
added. (Jonathan Lange)
* ``ThreadsafeForwardingResult`` correctly forwards ``tags()`` calls where
only one of ``new_tags`` or ``gone_tags`` are specified.
(Jonathan Lange, #980263)
* ``ThreadsafeForwardingResult`` no longer leaks local tags from one test
into all future tests run. (Jonathan Lange, #985613)
* ``ThreadsafeForwardingResult`` has many, many more tests. (Jonathan Lange)
0.9.14
~~~~~~
Our sister project, `subunit <https://launchpad.net/subunit>`_, was using a
private API that was deleted in the 0.9.13 release. This release restores
that API in order to smooth out the upgrade path.
If you don't use subunit, then this release won't matter very much to you.
0.9.13
~~~~~~
Plenty of new matchers and quite a few critical bug fixes (especially to do
with stack traces from failed assertions). A net win for all.
Changes
-------
* ``MatchesAll`` now takes an ``first_only`` keyword argument that changes how
mismatches are displayed. If you were previously passing matchers to
``MatchesAll`` with keyword arguments, then this change might affect your
test results. (Jonathan Lange)
Improvements
------------
* Actually hide all of the testtools stack for assertion failures. The
previous release promised clean stack, but now we actually provide it.
(Jonathan Lange, #854769)
* ``assertRaises`` now includes the ``repr`` of the callable that failed to raise
properly. (Jonathan Lange, #881052)
* Asynchronous tests no longer hang when run with trial.
(Jonathan Lange, #926189)
* ``Content`` objects now have an ``as_text`` method to convert their contents
to Unicode text. (Jonathan Lange)
* Failed equality assertions now line up. (Jonathan Lange, #879339)
* ``FullStackRunTest`` no longer aborts the test run if a test raises an
error. (Jonathan Lange)
* ``MatchesAll`` and ``MatchesListwise`` both take a ``first_only`` keyword
argument. If True, they will report only on the first mismatch they find,
and not continue looking for other possible mismatches.
(Jonathan Lange)
* New helper, ``Nullary`` that turns callables with arguments into ones that
don't take arguments. (Jonathan Lange)
* New matchers:
* ``DirContains`` matches the contents of a directory.
(Jonathan Lange, James Westby)
* ``DirExists`` matches if a directory exists.
(Jonathan Lange, James Westby)
* ``FileContains`` matches the contents of a file.
(Jonathan Lange, James Westby)
* ``FileExists`` matches if a file exists.
(Jonathan Lange, James Westby)
* ``HasPermissions`` matches the permissions of a file. (Jonathan Lange)
* ``MatchesPredicate`` matches if a predicate is true. (Jonathan Lange)
* ``PathExists`` matches if a path exists. (Jonathan Lange, James Westby)
* ``SamePath`` matches if two paths are the same. (Jonathan Lange)
* ``TarballContains`` matches the contents of a tarball. (Jonathan Lange)
* ``MultiTestResult`` supports the ``tags`` method.
(Graham Binns, Francesco Banconi, #914279)
* ``ThreadsafeForwardingResult`` supports the ``tags`` method.
(Graham Binns, Francesco Banconi, #914279)
* ``ThreadsafeForwardingResult`` no longer includes semaphore acquisition time
in the test duration (for implicitly timed test runs).
(Robert Collins, #914362)
0.9.12
~~~~~~
This is a very big release. We've made huge improvements on three fronts:
1. Test failures are way nicer and easier to read
2. Matchers and ``assertThat`` are much more convenient to use
3. Correct handling of extended unicode characters
We've trimmed off the fat from the stack trace you get when tests fail, we've
cut out the bits of error messages that just didn't help, we've made it easier
to annotate mismatch failures, to compare complex objects and to match raised
exceptions.
Testing code was never this fun.
Changes
-------
* ``AfterPreproccessing`` renamed to ``AfterPreprocessing``, which is a more
correct spelling. Old name preserved for backwards compatibility, but is
now deprecated. Please stop using it.
(Jonathan Lange, #813460)
* ``assertThat`` raises ``MismatchError`` instead of
``TestCase.failureException``. ``MismatchError`` is a subclass of
``AssertionError``, so in most cases this change will not matter. However,
if ``self.failureException`` has been set to a non-default value, then
mismatches will become test errors rather than test failures.
* ``gather_details`` takes two dicts, rather than two detailed objects.
(Jonathan Lange, #801027)
* ``MatchesRegex`` mismatch now says "<value> does not match /<regex>/" rather
than "<regex> did not match <value>". The regular expression contains fewer
backslashes too. (Jonathan Lange, #818079)
* Tests that run with ``AsynchronousDeferredRunTest`` now have the ``reactor``
attribute set to the running reactor. (Jonathan Lange, #720749)
Improvements
------------
* All public matchers are now in ``testtools.matchers.__all__``.
(Jonathan Lange, #784859)
* ``assertThat`` can actually display mismatches and matchers that contain
extended unicode characters. (Jonathan Lange, Martin [gz], #804127)
* ``assertThat`` output is much less verbose, displaying only what the mismatch
tells us to display. Old-style verbose output can be had by passing
``verbose=True`` to assertThat. (Jonathan Lange, #675323, #593190)
* ``assertThat`` accepts a message which will be used to annotate the matcher.
This can be given as a third parameter or as a keyword parameter.
(Robert Collins)
* Automated the Launchpad part of the release process.
(Jonathan Lange, #623486)
* Correctly display non-ASCII unicode output on terminals that claim to have a
unicode encoding. (Martin [gz], #804122)
* ``DocTestMatches`` correctly handles unicode output from examples, rather
than raising an error. (Martin [gz], #764170)
* ``ErrorHolder`` and ``PlaceHolder`` added to docs. (Jonathan Lange, #816597)
* ``ExpectedException`` now matches any exception of the given type by
default, and also allows specifying a ``Matcher`` rather than a mere regular
expression. (Jonathan Lange, #791889)
* ``FixtureSuite`` added, allows test suites to run with a given fixture.
(Jonathan Lange)
* Hide testtools's own stack frames when displaying tracebacks, making it
easier for test authors to focus on their errors.
(Jonathan Lange, Martin [gz], #788974)
* Less boilerplate displayed in test failures and errors.
(Jonathan Lange, #660852)
* ``MatchesException`` now allows you to match exceptions against any matcher,
rather than just regular expressions. (Jonathan Lange, #791889)
* ``MatchesException`` now permits a tuple of types rather than a single type
(when using the type matching mode). (Robert Collins)
* ``MatchesStructure.byEquality`` added to make the common case of matching
many attributes by equality much easier. ``MatchesStructure.byMatcher``
added in case folk want to match by things other than equality.
(Jonathan Lange)
* New convenience assertions, ``assertIsNone`` and ``assertIsNotNone``.
(Christian Kampka)
* New matchers:
* ``AllMatch`` matches many values against a single matcher.
(Jonathan Lange, #615108)
* ``Contains``. (Robert Collins)
* ``GreaterThan``. (Christian Kampka)
* New helper, ``safe_hasattr`` added. (Jonathan Lange)
* ``reraise`` added to ``testtools.compat``. (Jonathan Lange)
0.9.11
~~~~~~
This release brings consistent use of super for better compatibility with
multiple inheritance, fixed Python3 support, improvements in fixture and mather
outputs and a compat helper for testing libraries that deal with bytestrings.
Changes
-------
* ``TestCase`` now uses super to call base ``unittest.TestCase`` constructor,
``setUp`` and ``tearDown``. (Tim Cole, #771508)
* If, when calling ``useFixture`` an error occurs during fixture set up, we
still attempt to gather details from the fixture. (Gavin Panella)
Improvements
------------
* Additional compat helper for ``BytesIO`` for libraries that build on
testtools and are working on Python 3 porting. (Robert Collins)
* Corrected documentation for ``MatchesStructure`` in the test authors
document. (Jonathan Lange)
* ``LessThan`` error message now says something that is logically correct.
(Gavin Panella, #762008)
* Multiple details from a single fixture are now kept separate, rather than
being mooshed together. (Gavin Panella, #788182)
* Python 3 support now back in action. (Martin [gz], #688729)
* ``try_import`` and ``try_imports`` have a callback that is called whenever
they fail to import a module. (Martin Pool)
0.9.10
~~~~~~
The last release of testtools could not be easy_installed. This is considered
severe enough for a re-release.
Improvements
------------
* Include ``doc/`` in the source distribution, making testtools installable
from PyPI again (Tres Seaver, #757439)
0.9.9
~~~~~
Many, many new matchers, vastly expanded documentation, stacks of bug fixes,
better unittest2 integration. If you've ever wanted to try out testtools but
been afraid to do so, this is the release to try.
Changes
-------
* The timestamps generated by ``TestResult`` objects when no timing data has
been received are now datetime-with-timezone, which allows them to be
sensibly serialised and transported. (Robert Collins, #692297)
Improvements
------------
* ``AnnotatedMismatch`` now correctly returns details.
(Jonathan Lange, #724691)
* distutils integration for the testtools test runner. Can now use it for
'python setup.py test'. (Christian Kampka, #693773)
* ``EndsWith`` and ``KeysEqual`` now in testtools.matchers.__all__.
(Jonathan Lange, #692158)
* ``MatchesException`` extended to support a regular expression check against
the str() of a raised exception. (Jonathan Lange)
* ``MultiTestResult`` now forwards the ``time`` API. (Robert Collins, #692294)
* ``MultiTestResult`` now documented in the manual. (Jonathan Lange, #661116)
* New content helpers ``content_from_file``, ``content_from_stream`` and
``attach_file`` make it easier to attach file-like objects to a
test. (Jonathan Lange, Robert Collins, #694126)
* New ``ExpectedException`` context manager to help write tests against things
that are expected to raise exceptions. (Aaron Bentley)
* New matchers:
* ``MatchesListwise`` matches an iterable of matchers against an iterable
of values. (Michael Hudson-Doyle)
* ``MatchesRegex`` matches a string against a regular expression.
(Michael Hudson-Doyle)
* ``MatchesStructure`` matches attributes of an object against given
matchers. (Michael Hudson-Doyle)
* ``AfterPreproccessing`` matches values against a matcher after passing them
through a callable. (Michael Hudson-Doyle)
* ``MatchesSetwise`` matches an iterable of matchers against an iterable of
values, without regard to order. (Michael Hudson-Doyle)
* ``setup.py`` can now build a snapshot when Bazaar is installed but the tree
is not a Bazaar tree. (Jelmer Vernooij)
* Support for running tests using distutils (Christian Kampka, #726539)
* Vastly improved and extended documentation. (Jonathan Lange)
* Use unittest2 exception classes if available. (Jelmer Vernooij)
0.9.8
~~~~~
In this release we bring some very interesting improvements:
* new matchers for exceptions, sets, lists, dicts and more.
* experimental (works but the contract isn't supported) twisted reactor
support.
* The built in runner can now list tests and filter tests (the -l and
--load-list options).
Changes
-------
* addUnexpectedSuccess is translated to addFailure for test results that don't
know about addUnexpectedSuccess. Further, it fails the entire result for
all testtools TestResults (i.e. wasSuccessful() returns False after
addUnexpectedSuccess has been called). Note that when using a delegating
result such as ThreadsafeForwardingResult, MultiTestResult or
ExtendedToOriginalDecorator then the behaviour of addUnexpectedSuccess is
determined by the delegated to result(s).
(Jonathan Lange, Robert Collins, #654474, #683332)
* startTestRun will reset any errors on the result. That is, wasSuccessful()
will always return True immediately after startTestRun() is called. This
only applies to delegated test results (ThreadsafeForwardingResult,
MultiTestResult and ExtendedToOriginalDecorator) if the delegated to result
is a testtools test result - we cannot reliably reset the state of unknown
test result class instances. (Jonathan Lange, Robert Collins, #683332)
* Responsibility for running test cleanups has been moved to ``RunTest``.
This change does not affect public APIs and can be safely ignored by test
authors. (Jonathan Lange, #662647)
Improvements
------------
* New matchers:
* ``EndsWith`` which complements the existing ``StartsWith`` matcher.
(Jonathan Lange, #669165)
* ``MatchesException`` matches an exception class and parameters. (Robert
Collins)
* ``KeysEqual`` matches a dictionary with particular keys. (Jonathan Lange)
* ``assertIsInstance`` supports a custom error message to be supplied, which
is necessary when using ``assertDictEqual`` on Python 2.7 with a
``testtools.TestCase`` base class. (Jelmer Vernooij)
* Experimental support for running tests that return Deferreds.
(Jonathan Lange, Martin [gz])
* Provide a per-test decorator, run_test_with, to specify which RunTest
object to use for a given test. (Jonathan Lange, #657780)
* Fix the runTest parameter of TestCase to actually work, rather than raising
a TypeError. (Jonathan Lange, #657760)
* Non-release snapshots of testtools will now work with buildout.
(Jonathan Lange, #613734)
* Malformed SyntaxErrors no longer blow up the test suite. (Martin [gz])
* ``MismatchesAll.describe`` no longer appends a trailing newline.
(Michael Hudson-Doyle, #686790)
* New helpers for conditionally importing modules, ``try_import`` and
``try_imports``. (Jonathan Lange)
* ``Raises`` added to the ``testtools.matchers`` module - matches if the
supplied callable raises, and delegates to an optional matcher for validation
of the exception. (Robert Collins)
* ``raises`` added to the ``testtools.matchers`` module - matches if the
supplied callable raises and delegates to ``MatchesException`` to validate
the exception. (Jonathan Lange)
* Tests will now pass on Python 2.6.4 : an ``Exception`` change made only in
2.6.4 and reverted in Python 2.6.5 was causing test failures on that version.
(Martin [gz], #689858).
* ``testtools.TestCase.useFixture`` has been added to glue with fixtures nicely.
(Robert Collins)
* ``testtools.run`` now supports ``-l`` to list tests rather than executing
them. This is useful for integration with external test analysis/processing
tools like subunit and testrepository. (Robert Collins)
* ``testtools.run`` now supports ``--load-list``, which takes a file containing
test ids, one per line, and intersects those ids with the tests found. This
allows fine grained control of what tests are run even when the tests cannot
be named as objects to import (e.g. due to test parameterisation via
testscenarios). (Robert Collins)
* Update documentation to say how to use testtools.run() on Python 2.4.
(Jonathan Lange, #501174)
* ``text_content`` conveniently converts a Python string to a Content object.
(Jonathan Lange, James Westby)
0.9.7
~~~~~
Lots of little cleanups in this release; many small improvements to make your
testing life more pleasant.
Improvements
------------
* Cleanups can raise ``testtools.MultipleExceptions`` if they have multiple
exceptions to report. For instance, a cleanup which is itself responsible for
running several different internal cleanup routines might use this.
* Code duplication between assertEqual and the matcher Equals has been removed.
* In normal circumstances, a TestCase will no longer share details with clones
of itself. (Andrew Bennetts, bug #637725)
* Less exception object cycles are generated (reduces peak memory use between
garbage collection). (Martin [gz])
* New matchers 'DoesNotStartWith' and 'StartsWith' contributed by Canonical
from the Launchpad project. Written by James Westby.
* Timestamps as produced by subunit protocol clients are now forwarded in the
ThreadsafeForwardingResult so correct test durations can be reported.
(Martin [gz], Robert Collins, #625594)
* With unittest from Python 2.7 skipped tests will now show only the reason
rather than a serialisation of all details. (Martin [gz], #625583)
* The testtools release process is now a little better documented and a little
smoother. (Jonathan Lange, #623483, #623487)
0.9.6
~~~~~
Nothing major in this release, just enough small bits and pieces to make it
useful enough to upgrade to.
In particular, a serious bug in assertThat() has been fixed, it's easier to
write Matchers, there's a TestCase.patch() method for those inevitable monkey
patches and TestCase.assertEqual gives slightly nicer errors.
Improvements
------------
* 'TestCase.assertEqual' now formats errors a little more nicely, in the
style of bzrlib.
* Added `PlaceHolder` and `ErrorHolder`, TestCase-like objects that can be
used to add results to a `TestResult`.
* 'Mismatch' now takes optional description and details parameters, so
custom Matchers aren't compelled to make their own subclass.
* jml added a built-in UTF8_TEXT ContentType to make it slightly easier to
add details to test results. See bug #520044.
* Fix a bug in our built-in matchers where assertThat would blow up if any
of them failed. All built-in mismatch objects now provide get_details().
* New 'Is' matcher, which lets you assert that a thing is identical to
another thing.
* New 'LessThan' matcher which lets you assert that a thing is less than
another thing.
* TestCase now has a 'patch()' method to make it easier to monkey-patching
objects in tests. See the manual for more information. Fixes bug #310770.
* MultiTestResult methods now pass back return values from the results it
forwards to.