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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
|
%global _empty_manifest_terminate_build 0
Name: python-django-test-plus
Version: 2.2.1
Release: 1
Summary: "django-test-plus provides useful additions to Django's default TestCase"
License: BSD License
URL: https://github.com/revsys/django-test-plus/
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/fc/66/435ae537414a2dfad119f8162a4e2f7df5f42ec05f8cbdf3f373ea1239c9/django-test-plus-2.2.1.tar.gz
BuildArch: noarch
Requires: python3-factory-boy
Requires: python3-flake8
Requires: python3-pyflakes
Requires: python3-pytest
Requires: python3-pytest-cov
Requires: python3-pytest-django
Requires: python3-pytest-pythonpath
%description
# django-test-plus
Useful additions to Django's default TestCase from [REVSYS](https://www.revsys.com/)
[](https://pypi.org/project/django-test-plus/)
[](https://github.com/revsys/django-test-plus/actions/workflows/actions.yml)
## Rationale
Let's face it, writing tests isn't always fun. Part of the reason for
that is all of the boilerplate you end up writing. django-test-plus is
an attempt to cut down on some of that when writing Django tests. We
guarantee it will increase the time before you get carpal tunnel by at
least 3 weeks!
## Support
Supports: Python 3.6, 3.7, 3.8, 3.9, and 3.10.
Supports Django Versions: 2.0, 2.1, 2.2, 3.0, 3.1. and 3.2.
## Documentation
Full documentation is available at http://django-test-plus.readthedocs.org
## Installation
```shell
$ pip install django-test-plus
```
## Usage
To use django-test-plus, have your tests inherit from test_plus.test.TestCase rather than the normal django.test.TestCase::
```python
from test_plus.test import TestCase
class MyViewTests(TestCase):
...
```
This is sufficient to get things rolling, but you are encouraged to
create *your own* sub-classes for your projects. This will allow you
to add your own project-specific helper methods.
For example, if you have a django project named 'myproject', you might
create the following in `myproject/test.py`:
```python
from test_plus.test import TestCase as PlusTestCase
class TestCase(PlusTestCase):
pass
```
And then in your tests use:
```python
from myproject.test import TestCase
class MyViewTests(TestCase):
...
```
This import, which is similar to the way you would import Django's TestCase,
is also valid:
```python
from test_plus import TestCase
```
## pytest Usage
You can get a TestCase like object as a pytest fixture now by asking for `tp`. All of the methods below would then work in pytest functions. For
example:
```python
def test_url_reverse(tp):
expected_url = '/api/'
reversed_url = tp.reverse('api')
assert expected_url == reversed_url
```
The `tp_api` fixture will provide a `TestCase` that uses django-rest-framework's `APIClient()`:
```python
def test_url_reverse(tp_api):
response = tp_api.client.post("myapi", format="json")
assert response.status_code == 200
```
## Methods
### reverse(url_name, *args, **kwargs)
When testing views you often find yourself needing to reverse the URL's name. With django-test-plus there is no need for the `from django.core.urlresolvers import reverse` boilerplate. Instead, use:
```python
def test_something(self):
url = self.reverse('my-url-name')
slug_url = self.reverse('name-takes-a-slug', slug='my-slug')
pk_url = self.reverse('name-takes-a-pk', pk=12)
```
As you can see our reverse also passes along any args or kwargs you need
to pass in.
## get(url_name, follow=True, *args, **kwargs)
Another thing you do often is HTTP get urls. Our `get()` method
assumes you are passing in a named URL with any args or kwargs necessary
to reverse the url_name.
If needed, place kwargs for `TestClient.get()` in an 'extra' dictionary.:
```python
def test_get_named_url(self):
response = self.get('my-url-name')
# Get XML data via AJAX request
xml_response = self.get(
'my-url-name',
extra={'HTTP_X_REQUESTED_WITH': 'XMLHttpRequest'})
```
When using this get method two other things happen for you: we store the
last response in `self.last_response` and the response's Context in `self.context`.
So instead of:
```python
def test_default_django(self):
response = self.client.get(reverse('my-url-name'))
self.assertTrue('foo' in response.context)
self.assertEqual(response.context['foo'], 12)
```
You can write:
```python
def test_testplus_get(self):
self.get('my-url-name')
self.assertInContext('foo')
self.assertEqual(self.context['foo'], 12)
```
It's also smart about already reversed URLs, so you can be lazy and do:
```python
def test_testplus_get(self):
url = self.reverse('my-url-name')
self.get(url)
self.response_200()
```
If you need to pass query string parameters to your url name, you can do so like this. Assuming the name 'search' maps to '/search/' then:
```python
def test_testplus_get_query(self):
self.get('search', data={'query': 'testing'})
```
Would GET `/search/?query=testing`.
## post(url_name, data, follow=True, *args, **kwargs)
Our `post()` method takes a named URL, an optional dictionary of data you wish
to post and any args or kwargs necessary to reverse the url_name.
If needed, place kwargs for `TestClient.post()` in an 'extra' dictionary.:
```python
def test_post_named_url(self):
response = self.post('my-url-name', data={'coolness-factor': 11.0},
extra={'HTTP_X_REQUESTED_WITH': 'XMLHttpRequest'})
```
*NOTE* Along with the frequently used get and post, we support all of the HTTP verbs such as put, patch, head, trace, options, and delete in the same fashion.
## get_context(key)
Often you need to get things out of the template context:
```python
def test_context_data(self):
self.get('my-view-with-some-context')
slug = self.get_context('slug')
```
## assertInContext(key)
You can ensure a specific key exists in the last response's context by
using:
```python
def test_in_context(self):
self.get('my-view-with-some-context')
self.assertInContext('some-key')
```
## assertContext(key, value)
We can get context values and ensure they exist, but we can also test
equality while we're at it. This asserts that key == value:
```python
def test_in_context(self):
self.get('my-view-with-some-context')
self.assertContext('some-key', 'expected value')
```
## assert_http_###_<status_name>(response, msg=None) - status code checking
Another test you often need to do is check that a response has a certain
HTTP status code. With Django's default TestCase you would write:
```python
from django.core.urlresolvers import reverse
def test_status(self):
response = self.client.get(reverse('my-url-name'))
self.assertEqual(response.status_code, 200)
```
With django-test-plus you can shorten that to be:
```python
def test_better_status(self):
response = self.get('my-url-name')
self.assert_http_200_ok(response)
```
Django-test-plus provides a majority of the status codes assertions for you. The status assertions
can be found in their own [mixin](https://github.com/revsys/django-test-plus/blob/main/test_plus/status_codes.py)
and should be searchable if you're using an IDE like pycharm. It should be noted that in previous
versions, django-test-plus had assertion methods in the pattern of `response_###()`, which are still
available but have since been deprecated. See below for a list of those methods.
Each of the assertion methods takes an optional Django test client `response` and a string `msg` argument
that, if specified, is used as the error message when a failure occurs. The methods,
`assert_http_301_moved_permanently` and `assert_http_302_found` also take an optional `url` argument that
if passed, will check to make sure the `response.url` matches.
If it's available, the `assert_http_###_<status_name>` methods will use the last response. So you
can do:
```python
def test_status(self):
self.get('my-url-name')
self.assert_http_200_ok()
```
Which is a bit shorter.
The `response_###()` methods that are deprecated, but still available for use, include:
- `response_200()`
- `response_201()`
- `response_204()`
- `response_301()`
- `response_302()`
- `response_400()`
- `response_401()`
- `response_403()`
- `response_404()`
- `response_405()`
- `response_409()`
- `response_410()`
All of which take an optional Django test client response and a str msg argument that, if specified, is used as the error message when a failure occurs. Just like the `assert_http_###_<status_name>()` methods, these methods will use the last response if it's available.
## get_check_200(url_name, *args, **kwargs)
GETing and checking views return status 200 is a common test. This method makes it more convenient::
```python
def test_even_better_status(self):
response = self.get_check_200('my-url-name')
```
## make_user(username='testuser', password='password', perms=None)
When testing out views you often need to create various users to ensure
all of your logic is safe and sound. To make this process easier, this
method will create a user for you:
```python
def test_user_stuff(self)
user1 = self.make_user('u1')
user2 = self.make_user('u2')
```
If creating a User in your project is more complicated, say for example
you removed the `username` field from the default Django Auth model,
you can provide a [Factory
Boy](https://factoryboy.readthedocs.org/en/latest/) factory to create
it or override this method on your own sub-class.
To use a Factory Boy factory, create your class like this::
```python
from test_plus.test import TestCase
from .factories import UserFactory
class MySpecialTest(TestCase):
user_factory = UserFactory
def test_special_creation(self):
user1 = self.make_user('u1')
```
**NOTE:** Users created by this method will have their password
set to the string 'password' by default, in order to ease testing.
If you need a specific password, override the `password` parameter.
You can also pass in user permissions by passing in a string of
'`<app_name>.<perm name>`' or '`<app_name>.*`'. For example:
```python
user2 = self.make_user(perms=['myapp.create_widget', 'otherapp.*'])
```
## print_form_errors(response_or_form=None)
When debugging a failing test for a view with a form, this method helps you
quickly look at any form errors.
Example usage:
```python
class MyFormTest(TestCase):
self.post('my-url-name', data={})
self.print_form_errors()
# or
resp = self.post('my-url-name', data={})
self.print_form_errors(resp)
# or
form = MyForm(data={})
self.print_form_errors(form)
```
## Authentication Helpers
### assertLoginRequired(url_name, *args, **kwargs)
This method helps you test that a given named URL requires authorization:
```python
def test_auth(self):
self.assertLoginRequired('my-restricted-url')
self.assertLoginRequired('my-restricted-object', pk=12)
self.assertLoginRequired('my-restricted-object', slug='something')
```
### login context
Along with ensuring a view requires login and creating users, the next
thing you end up doing is logging in as various users to test your
restriction logic:
```python
def test_restrictions(self):
user1 = self.make_user('u1')
user2 = self.make_user('u2')
self.assertLoginRequired('my-protected-view')
with self.login(username=user1.username, password='password'):
response = self.get('my-protected-view')
# Test user1 sees what they should be seeing
with self.login(username=user2.username, password='password'):
response = self.get('my-protected-view')
# Test user2 see what they should be seeing
```
Since we're likely creating our users using `make_user()` from above,
the login context assumes the password is 'password' unless specified
otherwise. Therefore you you can do:
```python
def test_restrictions(self):
user1 = self.make_user('u1')
with self.login(username=user1.username):
response = self.get('my-protected-view')
```
We can also derive the username if we're using `make_user()` so we can
shorten that up even further like this:
```python
def test_restrictions(self):
user1 = self.make_user('u1')
with self.login(user1):
response = self.get('my-protected-view')
```
## Ensuring low query counts
### assertNumQueriesLessThan(number) - context
Django provides
[assertNumQueries](https://docs.djangoproject.com/en/1.8/topics/testing/tools/#django.test.TransactionTestCase.assertNumQueries)
which is great when your code generates a specific number of
queries. However, if this number varies due to the nature of your data, with
this method you can still test to ensure the code doesn't start producing a ton
more queries than you expect:
```python
def test_something_out(self):
with self.assertNumQueriesLessThan(7):
self.get('some-view-with-6-queries')
```
### assertGoodView(url_name, *args, **kwargs)
This method does a few things for you. It:
- Retrieves the name URL
- Ensures the view does not generate more than 50 queries
- Ensures the response has status code 200
- Returns the response
Often a wide, sweeping test like this is better than no test at all. You
can use it like this:
```python
def test_better_than_nothing(self):
response = self.assertGoodView('my-url-name')
```
## Testing DRF views
To take advantage of the convenience of DRF's test client, you can create a subclass of `TestCase` and set the `client_class` property:
```python
from test_plus import TestCase
from rest_framework.test import APIClient
class APITestCase(TestCase):
client_class = APIClient
```
For convenience, `test_plus` ships with `APITestCase`, which does just that:
```python
from test_plus import APITestCase
class MyAPITestCase(APITestCase):
def test_post(self):
data = {'testing': {'prop': 'value'}}
self.post('view-json', data=data, extra={'format': 'json'})
self.assert_http_200_ok()
```
Note that using `APITestCase` requires Django >= 1.8 and having installed `django-rest-framework`.
## Testing class-based "generic" views
The TestCase methods `get()` and `post()` work for both function-based
and class-based views. However, in doing so they invoke Django's
URL resolution, middleware, template processing, and decorator systems.
For integration testing this is desirable, as you want to ensure your
URLs resolve properly, view permissions are enforced, etc.
For unit testing this is costly because all these Django request/response
systems are invoked in addition to your method, and they typically do not
affect the end result.
Class-based views (derived from Django's `generic.models.View` class)
contain methods and mixins which makes granular unit testing (more) feasible.
Quite often your usage of a generic view class comprises an override
of an existing method. Invoking the entire view and the Django request/response
stack is a waste of time when you really want to call the overridden
method directly and test the result.
CBVTestCase to the rescue!
As with TestCase above, have your tests inherit
from test_plus.test.CBVTestCase rather than TestCase like so:
```python
from test_plus.test import CBVTestCase
class MyViewTests(CBVTestCase):
```
## Methods
### get_instance(cls, initkwargs=None, request=None, *args, **kwargs)
This core method simplifies the instantiation of your class, giving you
a way to invoke class methods directly.
Returns an instance of `cls`, initialized with `initkwargs`.
Sets `request`, `args`, and `kwargs` attributes on the class instance.
`args` and `kwargs` are the same values you would pass to `reverse()`.
Sample usage:
```python
from django.views import generic
from test_plus.test import CBVTestCase
class MyClass(generic.DetailView)
def get_context_data(self, **kwargs):
kwargs['answer'] = 42
return kwargs
class MyTests(CBVTestCase):
def test_context_data(self):
my_view = self.get_instance(MyClass, {'object': some_object})
context = my_view.get_context_data()
self.assertEqual(context['answer'], 42)
```
### get(cls, initkwargs=None, *args, **kwargs)
Invokes `cls.get()` and returns the response, rendering template if possible.
Builds on the `CBVTestCase.get_instance()` foundation.
All test_plus.test.TestCase methods are valid, so the following works:
```python
response = self.get(MyClass)
self.assertContext('my_key', expected_value)
```
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.get()`.
**NOTE:** This method bypasses Django's middleware, and therefore context
variables created by middleware are not available. If this affects your
template/context testing, you should use TestCase instead of CBVTestCase.
### post(cls, data=None, initkwargs=None, *args, **kwargs)
Invokes `cls.post()` and returns the response, rendering template if possible.
Builds on the `CBVTestCase.get_instance()` foundation.
Example:
```python
response = self.post(MyClass, data={'search_term': 'revsys'})
self.response_200(response)
self.assertContext('company_name', 'RevSys')
```
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.post()`.
**NOTE:** This method bypasses Django's middleware, and therefore context
variables created by middleware are not available. If this affects your
template/context testing you should use TestCase instead of CBVTestCase.
### get_check_200(cls, initkwargs=None, *args, **kwargs)
Works just like `TestCase.get_check_200()`.
Caller must provide a view class instead of a URL name or path parameter.
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.post()`.
### assertGoodView(cls, initkwargs=None, *args, **kwargs)
Works just like `TestCase.assertGoodView()`.
Caller must provide a view class instead of a URL name or path parameter.
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.post()`.
## Development
To work on django-test-plus itself, clone this repository and run the following commands:
```shell
$ pip install -r requirements.txt
$ pip install -e .
```
**NOTE**: You will also need to ensure that the `test_project` directory, located
at the root of this repo, is in your virtualenv's path.
## Keep in touch!
If you have a question about this project, please open a GitHub issue. If you love us and want to keep track of our goings-on, here's where you can find us online:
<a href="https://revsys.com?utm_medium=github&utm_source=django-test-plus"><img src="https://pbs.twimg.com/profile_images/915928618840285185/sUdRGIn1_400x400.jpg" height="50" /></a>
<a href="https://twitter.com/revsys"><img src="https://cdn1.iconfinder.com/data/icons/new_twitter_icon/256/bird_twitter_new_simple.png" height="43" /></a>
<a href="https://www.facebook.com/revsysllc/"><img src="https://cdn3.iconfinder.com/data/icons/picons-social/57/06-facebook-512.png" height="50" /></a>
<a href="https://github.com/revsys/"><img src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png" height="53" /></a>
<a href="https://gitlab.com/revsys"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/1/18/GitLab_Logo.svg/2000px-GitLab_Logo.svg.png" height="44" /></a>
%package -n python3-django-test-plus
Summary: "django-test-plus provides useful additions to Django's default TestCase"
Provides: python-django-test-plus
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-django-test-plus
# django-test-plus
Useful additions to Django's default TestCase from [REVSYS](https://www.revsys.com/)
[](https://pypi.org/project/django-test-plus/)
[](https://github.com/revsys/django-test-plus/actions/workflows/actions.yml)
## Rationale
Let's face it, writing tests isn't always fun. Part of the reason for
that is all of the boilerplate you end up writing. django-test-plus is
an attempt to cut down on some of that when writing Django tests. We
guarantee it will increase the time before you get carpal tunnel by at
least 3 weeks!
## Support
Supports: Python 3.6, 3.7, 3.8, 3.9, and 3.10.
Supports Django Versions: 2.0, 2.1, 2.2, 3.0, 3.1. and 3.2.
## Documentation
Full documentation is available at http://django-test-plus.readthedocs.org
## Installation
```shell
$ pip install django-test-plus
```
## Usage
To use django-test-plus, have your tests inherit from test_plus.test.TestCase rather than the normal django.test.TestCase::
```python
from test_plus.test import TestCase
class MyViewTests(TestCase):
...
```
This is sufficient to get things rolling, but you are encouraged to
create *your own* sub-classes for your projects. This will allow you
to add your own project-specific helper methods.
For example, if you have a django project named 'myproject', you might
create the following in `myproject/test.py`:
```python
from test_plus.test import TestCase as PlusTestCase
class TestCase(PlusTestCase):
pass
```
And then in your tests use:
```python
from myproject.test import TestCase
class MyViewTests(TestCase):
...
```
This import, which is similar to the way you would import Django's TestCase,
is also valid:
```python
from test_plus import TestCase
```
## pytest Usage
You can get a TestCase like object as a pytest fixture now by asking for `tp`. All of the methods below would then work in pytest functions. For
example:
```python
def test_url_reverse(tp):
expected_url = '/api/'
reversed_url = tp.reverse('api')
assert expected_url == reversed_url
```
The `tp_api` fixture will provide a `TestCase` that uses django-rest-framework's `APIClient()`:
```python
def test_url_reverse(tp_api):
response = tp_api.client.post("myapi", format="json")
assert response.status_code == 200
```
## Methods
### reverse(url_name, *args, **kwargs)
When testing views you often find yourself needing to reverse the URL's name. With django-test-plus there is no need for the `from django.core.urlresolvers import reverse` boilerplate. Instead, use:
```python
def test_something(self):
url = self.reverse('my-url-name')
slug_url = self.reverse('name-takes-a-slug', slug='my-slug')
pk_url = self.reverse('name-takes-a-pk', pk=12)
```
As you can see our reverse also passes along any args or kwargs you need
to pass in.
## get(url_name, follow=True, *args, **kwargs)
Another thing you do often is HTTP get urls. Our `get()` method
assumes you are passing in a named URL with any args or kwargs necessary
to reverse the url_name.
If needed, place kwargs for `TestClient.get()` in an 'extra' dictionary.:
```python
def test_get_named_url(self):
response = self.get('my-url-name')
# Get XML data via AJAX request
xml_response = self.get(
'my-url-name',
extra={'HTTP_X_REQUESTED_WITH': 'XMLHttpRequest'})
```
When using this get method two other things happen for you: we store the
last response in `self.last_response` and the response's Context in `self.context`.
So instead of:
```python
def test_default_django(self):
response = self.client.get(reverse('my-url-name'))
self.assertTrue('foo' in response.context)
self.assertEqual(response.context['foo'], 12)
```
You can write:
```python
def test_testplus_get(self):
self.get('my-url-name')
self.assertInContext('foo')
self.assertEqual(self.context['foo'], 12)
```
It's also smart about already reversed URLs, so you can be lazy and do:
```python
def test_testplus_get(self):
url = self.reverse('my-url-name')
self.get(url)
self.response_200()
```
If you need to pass query string parameters to your url name, you can do so like this. Assuming the name 'search' maps to '/search/' then:
```python
def test_testplus_get_query(self):
self.get('search', data={'query': 'testing'})
```
Would GET `/search/?query=testing`.
## post(url_name, data, follow=True, *args, **kwargs)
Our `post()` method takes a named URL, an optional dictionary of data you wish
to post and any args or kwargs necessary to reverse the url_name.
If needed, place kwargs for `TestClient.post()` in an 'extra' dictionary.:
```python
def test_post_named_url(self):
response = self.post('my-url-name', data={'coolness-factor': 11.0},
extra={'HTTP_X_REQUESTED_WITH': 'XMLHttpRequest'})
```
*NOTE* Along with the frequently used get and post, we support all of the HTTP verbs such as put, patch, head, trace, options, and delete in the same fashion.
## get_context(key)
Often you need to get things out of the template context:
```python
def test_context_data(self):
self.get('my-view-with-some-context')
slug = self.get_context('slug')
```
## assertInContext(key)
You can ensure a specific key exists in the last response's context by
using:
```python
def test_in_context(self):
self.get('my-view-with-some-context')
self.assertInContext('some-key')
```
## assertContext(key, value)
We can get context values and ensure they exist, but we can also test
equality while we're at it. This asserts that key == value:
```python
def test_in_context(self):
self.get('my-view-with-some-context')
self.assertContext('some-key', 'expected value')
```
## assert_http_###_<status_name>(response, msg=None) - status code checking
Another test you often need to do is check that a response has a certain
HTTP status code. With Django's default TestCase you would write:
```python
from django.core.urlresolvers import reverse
def test_status(self):
response = self.client.get(reverse('my-url-name'))
self.assertEqual(response.status_code, 200)
```
With django-test-plus you can shorten that to be:
```python
def test_better_status(self):
response = self.get('my-url-name')
self.assert_http_200_ok(response)
```
Django-test-plus provides a majority of the status codes assertions for you. The status assertions
can be found in their own [mixin](https://github.com/revsys/django-test-plus/blob/main/test_plus/status_codes.py)
and should be searchable if you're using an IDE like pycharm. It should be noted that in previous
versions, django-test-plus had assertion methods in the pattern of `response_###()`, which are still
available but have since been deprecated. See below for a list of those methods.
Each of the assertion methods takes an optional Django test client `response` and a string `msg` argument
that, if specified, is used as the error message when a failure occurs. The methods,
`assert_http_301_moved_permanently` and `assert_http_302_found` also take an optional `url` argument that
if passed, will check to make sure the `response.url` matches.
If it's available, the `assert_http_###_<status_name>` methods will use the last response. So you
can do:
```python
def test_status(self):
self.get('my-url-name')
self.assert_http_200_ok()
```
Which is a bit shorter.
The `response_###()` methods that are deprecated, but still available for use, include:
- `response_200()`
- `response_201()`
- `response_204()`
- `response_301()`
- `response_302()`
- `response_400()`
- `response_401()`
- `response_403()`
- `response_404()`
- `response_405()`
- `response_409()`
- `response_410()`
All of which take an optional Django test client response and a str msg argument that, if specified, is used as the error message when a failure occurs. Just like the `assert_http_###_<status_name>()` methods, these methods will use the last response if it's available.
## get_check_200(url_name, *args, **kwargs)
GETing and checking views return status 200 is a common test. This method makes it more convenient::
```python
def test_even_better_status(self):
response = self.get_check_200('my-url-name')
```
## make_user(username='testuser', password='password', perms=None)
When testing out views you often need to create various users to ensure
all of your logic is safe and sound. To make this process easier, this
method will create a user for you:
```python
def test_user_stuff(self)
user1 = self.make_user('u1')
user2 = self.make_user('u2')
```
If creating a User in your project is more complicated, say for example
you removed the `username` field from the default Django Auth model,
you can provide a [Factory
Boy](https://factoryboy.readthedocs.org/en/latest/) factory to create
it or override this method on your own sub-class.
To use a Factory Boy factory, create your class like this::
```python
from test_plus.test import TestCase
from .factories import UserFactory
class MySpecialTest(TestCase):
user_factory = UserFactory
def test_special_creation(self):
user1 = self.make_user('u1')
```
**NOTE:** Users created by this method will have their password
set to the string 'password' by default, in order to ease testing.
If you need a specific password, override the `password` parameter.
You can also pass in user permissions by passing in a string of
'`<app_name>.<perm name>`' or '`<app_name>.*`'. For example:
```python
user2 = self.make_user(perms=['myapp.create_widget', 'otherapp.*'])
```
## print_form_errors(response_or_form=None)
When debugging a failing test for a view with a form, this method helps you
quickly look at any form errors.
Example usage:
```python
class MyFormTest(TestCase):
self.post('my-url-name', data={})
self.print_form_errors()
# or
resp = self.post('my-url-name', data={})
self.print_form_errors(resp)
# or
form = MyForm(data={})
self.print_form_errors(form)
```
## Authentication Helpers
### assertLoginRequired(url_name, *args, **kwargs)
This method helps you test that a given named URL requires authorization:
```python
def test_auth(self):
self.assertLoginRequired('my-restricted-url')
self.assertLoginRequired('my-restricted-object', pk=12)
self.assertLoginRequired('my-restricted-object', slug='something')
```
### login context
Along with ensuring a view requires login and creating users, the next
thing you end up doing is logging in as various users to test your
restriction logic:
```python
def test_restrictions(self):
user1 = self.make_user('u1')
user2 = self.make_user('u2')
self.assertLoginRequired('my-protected-view')
with self.login(username=user1.username, password='password'):
response = self.get('my-protected-view')
# Test user1 sees what they should be seeing
with self.login(username=user2.username, password='password'):
response = self.get('my-protected-view')
# Test user2 see what they should be seeing
```
Since we're likely creating our users using `make_user()` from above,
the login context assumes the password is 'password' unless specified
otherwise. Therefore you you can do:
```python
def test_restrictions(self):
user1 = self.make_user('u1')
with self.login(username=user1.username):
response = self.get('my-protected-view')
```
We can also derive the username if we're using `make_user()` so we can
shorten that up even further like this:
```python
def test_restrictions(self):
user1 = self.make_user('u1')
with self.login(user1):
response = self.get('my-protected-view')
```
## Ensuring low query counts
### assertNumQueriesLessThan(number) - context
Django provides
[assertNumQueries](https://docs.djangoproject.com/en/1.8/topics/testing/tools/#django.test.TransactionTestCase.assertNumQueries)
which is great when your code generates a specific number of
queries. However, if this number varies due to the nature of your data, with
this method you can still test to ensure the code doesn't start producing a ton
more queries than you expect:
```python
def test_something_out(self):
with self.assertNumQueriesLessThan(7):
self.get('some-view-with-6-queries')
```
### assertGoodView(url_name, *args, **kwargs)
This method does a few things for you. It:
- Retrieves the name URL
- Ensures the view does not generate more than 50 queries
- Ensures the response has status code 200
- Returns the response
Often a wide, sweeping test like this is better than no test at all. You
can use it like this:
```python
def test_better_than_nothing(self):
response = self.assertGoodView('my-url-name')
```
## Testing DRF views
To take advantage of the convenience of DRF's test client, you can create a subclass of `TestCase` and set the `client_class` property:
```python
from test_plus import TestCase
from rest_framework.test import APIClient
class APITestCase(TestCase):
client_class = APIClient
```
For convenience, `test_plus` ships with `APITestCase`, which does just that:
```python
from test_plus import APITestCase
class MyAPITestCase(APITestCase):
def test_post(self):
data = {'testing': {'prop': 'value'}}
self.post('view-json', data=data, extra={'format': 'json'})
self.assert_http_200_ok()
```
Note that using `APITestCase` requires Django >= 1.8 and having installed `django-rest-framework`.
## Testing class-based "generic" views
The TestCase methods `get()` and `post()` work for both function-based
and class-based views. However, in doing so they invoke Django's
URL resolution, middleware, template processing, and decorator systems.
For integration testing this is desirable, as you want to ensure your
URLs resolve properly, view permissions are enforced, etc.
For unit testing this is costly because all these Django request/response
systems are invoked in addition to your method, and they typically do not
affect the end result.
Class-based views (derived from Django's `generic.models.View` class)
contain methods and mixins which makes granular unit testing (more) feasible.
Quite often your usage of a generic view class comprises an override
of an existing method. Invoking the entire view and the Django request/response
stack is a waste of time when you really want to call the overridden
method directly and test the result.
CBVTestCase to the rescue!
As with TestCase above, have your tests inherit
from test_plus.test.CBVTestCase rather than TestCase like so:
```python
from test_plus.test import CBVTestCase
class MyViewTests(CBVTestCase):
```
## Methods
### get_instance(cls, initkwargs=None, request=None, *args, **kwargs)
This core method simplifies the instantiation of your class, giving you
a way to invoke class methods directly.
Returns an instance of `cls`, initialized with `initkwargs`.
Sets `request`, `args`, and `kwargs` attributes on the class instance.
`args` and `kwargs` are the same values you would pass to `reverse()`.
Sample usage:
```python
from django.views import generic
from test_plus.test import CBVTestCase
class MyClass(generic.DetailView)
def get_context_data(self, **kwargs):
kwargs['answer'] = 42
return kwargs
class MyTests(CBVTestCase):
def test_context_data(self):
my_view = self.get_instance(MyClass, {'object': some_object})
context = my_view.get_context_data()
self.assertEqual(context['answer'], 42)
```
### get(cls, initkwargs=None, *args, **kwargs)
Invokes `cls.get()` and returns the response, rendering template if possible.
Builds on the `CBVTestCase.get_instance()` foundation.
All test_plus.test.TestCase methods are valid, so the following works:
```python
response = self.get(MyClass)
self.assertContext('my_key', expected_value)
```
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.get()`.
**NOTE:** This method bypasses Django's middleware, and therefore context
variables created by middleware are not available. If this affects your
template/context testing, you should use TestCase instead of CBVTestCase.
### post(cls, data=None, initkwargs=None, *args, **kwargs)
Invokes `cls.post()` and returns the response, rendering template if possible.
Builds on the `CBVTestCase.get_instance()` foundation.
Example:
```python
response = self.post(MyClass, data={'search_term': 'revsys'})
self.response_200(response)
self.assertContext('company_name', 'RevSys')
```
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.post()`.
**NOTE:** This method bypasses Django's middleware, and therefore context
variables created by middleware are not available. If this affects your
template/context testing you should use TestCase instead of CBVTestCase.
### get_check_200(cls, initkwargs=None, *args, **kwargs)
Works just like `TestCase.get_check_200()`.
Caller must provide a view class instead of a URL name or path parameter.
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.post()`.
### assertGoodView(cls, initkwargs=None, *args, **kwargs)
Works just like `TestCase.assertGoodView()`.
Caller must provide a view class instead of a URL name or path parameter.
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.post()`.
## Development
To work on django-test-plus itself, clone this repository and run the following commands:
```shell
$ pip install -r requirements.txt
$ pip install -e .
```
**NOTE**: You will also need to ensure that the `test_project` directory, located
at the root of this repo, is in your virtualenv's path.
## Keep in touch!
If you have a question about this project, please open a GitHub issue. If you love us and want to keep track of our goings-on, here's where you can find us online:
<a href="https://revsys.com?utm_medium=github&utm_source=django-test-plus"><img src="https://pbs.twimg.com/profile_images/915928618840285185/sUdRGIn1_400x400.jpg" height="50" /></a>
<a href="https://twitter.com/revsys"><img src="https://cdn1.iconfinder.com/data/icons/new_twitter_icon/256/bird_twitter_new_simple.png" height="43" /></a>
<a href="https://www.facebook.com/revsysllc/"><img src="https://cdn3.iconfinder.com/data/icons/picons-social/57/06-facebook-512.png" height="50" /></a>
<a href="https://github.com/revsys/"><img src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png" height="53" /></a>
<a href="https://gitlab.com/revsys"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/1/18/GitLab_Logo.svg/2000px-GitLab_Logo.svg.png" height="44" /></a>
%package help
Summary: Development documents and examples for django-test-plus
Provides: python3-django-test-plus-doc
%description help
# django-test-plus
Useful additions to Django's default TestCase from [REVSYS](https://www.revsys.com/)
[](https://pypi.org/project/django-test-plus/)
[](https://github.com/revsys/django-test-plus/actions/workflows/actions.yml)
## Rationale
Let's face it, writing tests isn't always fun. Part of the reason for
that is all of the boilerplate you end up writing. django-test-plus is
an attempt to cut down on some of that when writing Django tests. We
guarantee it will increase the time before you get carpal tunnel by at
least 3 weeks!
## Support
Supports: Python 3.6, 3.7, 3.8, 3.9, and 3.10.
Supports Django Versions: 2.0, 2.1, 2.2, 3.0, 3.1. and 3.2.
## Documentation
Full documentation is available at http://django-test-plus.readthedocs.org
## Installation
```shell
$ pip install django-test-plus
```
## Usage
To use django-test-plus, have your tests inherit from test_plus.test.TestCase rather than the normal django.test.TestCase::
```python
from test_plus.test import TestCase
class MyViewTests(TestCase):
...
```
This is sufficient to get things rolling, but you are encouraged to
create *your own* sub-classes for your projects. This will allow you
to add your own project-specific helper methods.
For example, if you have a django project named 'myproject', you might
create the following in `myproject/test.py`:
```python
from test_plus.test import TestCase as PlusTestCase
class TestCase(PlusTestCase):
pass
```
And then in your tests use:
```python
from myproject.test import TestCase
class MyViewTests(TestCase):
...
```
This import, which is similar to the way you would import Django's TestCase,
is also valid:
```python
from test_plus import TestCase
```
## pytest Usage
You can get a TestCase like object as a pytest fixture now by asking for `tp`. All of the methods below would then work in pytest functions. For
example:
```python
def test_url_reverse(tp):
expected_url = '/api/'
reversed_url = tp.reverse('api')
assert expected_url == reversed_url
```
The `tp_api` fixture will provide a `TestCase` that uses django-rest-framework's `APIClient()`:
```python
def test_url_reverse(tp_api):
response = tp_api.client.post("myapi", format="json")
assert response.status_code == 200
```
## Methods
### reverse(url_name, *args, **kwargs)
When testing views you often find yourself needing to reverse the URL's name. With django-test-plus there is no need for the `from django.core.urlresolvers import reverse` boilerplate. Instead, use:
```python
def test_something(self):
url = self.reverse('my-url-name')
slug_url = self.reverse('name-takes-a-slug', slug='my-slug')
pk_url = self.reverse('name-takes-a-pk', pk=12)
```
As you can see our reverse also passes along any args or kwargs you need
to pass in.
## get(url_name, follow=True, *args, **kwargs)
Another thing you do often is HTTP get urls. Our `get()` method
assumes you are passing in a named URL with any args or kwargs necessary
to reverse the url_name.
If needed, place kwargs for `TestClient.get()` in an 'extra' dictionary.:
```python
def test_get_named_url(self):
response = self.get('my-url-name')
# Get XML data via AJAX request
xml_response = self.get(
'my-url-name',
extra={'HTTP_X_REQUESTED_WITH': 'XMLHttpRequest'})
```
When using this get method two other things happen for you: we store the
last response in `self.last_response` and the response's Context in `self.context`.
So instead of:
```python
def test_default_django(self):
response = self.client.get(reverse('my-url-name'))
self.assertTrue('foo' in response.context)
self.assertEqual(response.context['foo'], 12)
```
You can write:
```python
def test_testplus_get(self):
self.get('my-url-name')
self.assertInContext('foo')
self.assertEqual(self.context['foo'], 12)
```
It's also smart about already reversed URLs, so you can be lazy and do:
```python
def test_testplus_get(self):
url = self.reverse('my-url-name')
self.get(url)
self.response_200()
```
If you need to pass query string parameters to your url name, you can do so like this. Assuming the name 'search' maps to '/search/' then:
```python
def test_testplus_get_query(self):
self.get('search', data={'query': 'testing'})
```
Would GET `/search/?query=testing`.
## post(url_name, data, follow=True, *args, **kwargs)
Our `post()` method takes a named URL, an optional dictionary of data you wish
to post and any args or kwargs necessary to reverse the url_name.
If needed, place kwargs for `TestClient.post()` in an 'extra' dictionary.:
```python
def test_post_named_url(self):
response = self.post('my-url-name', data={'coolness-factor': 11.0},
extra={'HTTP_X_REQUESTED_WITH': 'XMLHttpRequest'})
```
*NOTE* Along with the frequently used get and post, we support all of the HTTP verbs such as put, patch, head, trace, options, and delete in the same fashion.
## get_context(key)
Often you need to get things out of the template context:
```python
def test_context_data(self):
self.get('my-view-with-some-context')
slug = self.get_context('slug')
```
## assertInContext(key)
You can ensure a specific key exists in the last response's context by
using:
```python
def test_in_context(self):
self.get('my-view-with-some-context')
self.assertInContext('some-key')
```
## assertContext(key, value)
We can get context values and ensure they exist, but we can also test
equality while we're at it. This asserts that key == value:
```python
def test_in_context(self):
self.get('my-view-with-some-context')
self.assertContext('some-key', 'expected value')
```
## assert_http_###_<status_name>(response, msg=None) - status code checking
Another test you often need to do is check that a response has a certain
HTTP status code. With Django's default TestCase you would write:
```python
from django.core.urlresolvers import reverse
def test_status(self):
response = self.client.get(reverse('my-url-name'))
self.assertEqual(response.status_code, 200)
```
With django-test-plus you can shorten that to be:
```python
def test_better_status(self):
response = self.get('my-url-name')
self.assert_http_200_ok(response)
```
Django-test-plus provides a majority of the status codes assertions for you. The status assertions
can be found in their own [mixin](https://github.com/revsys/django-test-plus/blob/main/test_plus/status_codes.py)
and should be searchable if you're using an IDE like pycharm. It should be noted that in previous
versions, django-test-plus had assertion methods in the pattern of `response_###()`, which are still
available but have since been deprecated. See below for a list of those methods.
Each of the assertion methods takes an optional Django test client `response` and a string `msg` argument
that, if specified, is used as the error message when a failure occurs. The methods,
`assert_http_301_moved_permanently` and `assert_http_302_found` also take an optional `url` argument that
if passed, will check to make sure the `response.url` matches.
If it's available, the `assert_http_###_<status_name>` methods will use the last response. So you
can do:
```python
def test_status(self):
self.get('my-url-name')
self.assert_http_200_ok()
```
Which is a bit shorter.
The `response_###()` methods that are deprecated, but still available for use, include:
- `response_200()`
- `response_201()`
- `response_204()`
- `response_301()`
- `response_302()`
- `response_400()`
- `response_401()`
- `response_403()`
- `response_404()`
- `response_405()`
- `response_409()`
- `response_410()`
All of which take an optional Django test client response and a str msg argument that, if specified, is used as the error message when a failure occurs. Just like the `assert_http_###_<status_name>()` methods, these methods will use the last response if it's available.
## get_check_200(url_name, *args, **kwargs)
GETing and checking views return status 200 is a common test. This method makes it more convenient::
```python
def test_even_better_status(self):
response = self.get_check_200('my-url-name')
```
## make_user(username='testuser', password='password', perms=None)
When testing out views you often need to create various users to ensure
all of your logic is safe and sound. To make this process easier, this
method will create a user for you:
```python
def test_user_stuff(self)
user1 = self.make_user('u1')
user2 = self.make_user('u2')
```
If creating a User in your project is more complicated, say for example
you removed the `username` field from the default Django Auth model,
you can provide a [Factory
Boy](https://factoryboy.readthedocs.org/en/latest/) factory to create
it or override this method on your own sub-class.
To use a Factory Boy factory, create your class like this::
```python
from test_plus.test import TestCase
from .factories import UserFactory
class MySpecialTest(TestCase):
user_factory = UserFactory
def test_special_creation(self):
user1 = self.make_user('u1')
```
**NOTE:** Users created by this method will have their password
set to the string 'password' by default, in order to ease testing.
If you need a specific password, override the `password` parameter.
You can also pass in user permissions by passing in a string of
'`<app_name>.<perm name>`' or '`<app_name>.*`'. For example:
```python
user2 = self.make_user(perms=['myapp.create_widget', 'otherapp.*'])
```
## print_form_errors(response_or_form=None)
When debugging a failing test for a view with a form, this method helps you
quickly look at any form errors.
Example usage:
```python
class MyFormTest(TestCase):
self.post('my-url-name', data={})
self.print_form_errors()
# or
resp = self.post('my-url-name', data={})
self.print_form_errors(resp)
# or
form = MyForm(data={})
self.print_form_errors(form)
```
## Authentication Helpers
### assertLoginRequired(url_name, *args, **kwargs)
This method helps you test that a given named URL requires authorization:
```python
def test_auth(self):
self.assertLoginRequired('my-restricted-url')
self.assertLoginRequired('my-restricted-object', pk=12)
self.assertLoginRequired('my-restricted-object', slug='something')
```
### login context
Along with ensuring a view requires login and creating users, the next
thing you end up doing is logging in as various users to test your
restriction logic:
```python
def test_restrictions(self):
user1 = self.make_user('u1')
user2 = self.make_user('u2')
self.assertLoginRequired('my-protected-view')
with self.login(username=user1.username, password='password'):
response = self.get('my-protected-view')
# Test user1 sees what they should be seeing
with self.login(username=user2.username, password='password'):
response = self.get('my-protected-view')
# Test user2 see what they should be seeing
```
Since we're likely creating our users using `make_user()` from above,
the login context assumes the password is 'password' unless specified
otherwise. Therefore you you can do:
```python
def test_restrictions(self):
user1 = self.make_user('u1')
with self.login(username=user1.username):
response = self.get('my-protected-view')
```
We can also derive the username if we're using `make_user()` so we can
shorten that up even further like this:
```python
def test_restrictions(self):
user1 = self.make_user('u1')
with self.login(user1):
response = self.get('my-protected-view')
```
## Ensuring low query counts
### assertNumQueriesLessThan(number) - context
Django provides
[assertNumQueries](https://docs.djangoproject.com/en/1.8/topics/testing/tools/#django.test.TransactionTestCase.assertNumQueries)
which is great when your code generates a specific number of
queries. However, if this number varies due to the nature of your data, with
this method you can still test to ensure the code doesn't start producing a ton
more queries than you expect:
```python
def test_something_out(self):
with self.assertNumQueriesLessThan(7):
self.get('some-view-with-6-queries')
```
### assertGoodView(url_name, *args, **kwargs)
This method does a few things for you. It:
- Retrieves the name URL
- Ensures the view does not generate more than 50 queries
- Ensures the response has status code 200
- Returns the response
Often a wide, sweeping test like this is better than no test at all. You
can use it like this:
```python
def test_better_than_nothing(self):
response = self.assertGoodView('my-url-name')
```
## Testing DRF views
To take advantage of the convenience of DRF's test client, you can create a subclass of `TestCase` and set the `client_class` property:
```python
from test_plus import TestCase
from rest_framework.test import APIClient
class APITestCase(TestCase):
client_class = APIClient
```
For convenience, `test_plus` ships with `APITestCase`, which does just that:
```python
from test_plus import APITestCase
class MyAPITestCase(APITestCase):
def test_post(self):
data = {'testing': {'prop': 'value'}}
self.post('view-json', data=data, extra={'format': 'json'})
self.assert_http_200_ok()
```
Note that using `APITestCase` requires Django >= 1.8 and having installed `django-rest-framework`.
## Testing class-based "generic" views
The TestCase methods `get()` and `post()` work for both function-based
and class-based views. However, in doing so they invoke Django's
URL resolution, middleware, template processing, and decorator systems.
For integration testing this is desirable, as you want to ensure your
URLs resolve properly, view permissions are enforced, etc.
For unit testing this is costly because all these Django request/response
systems are invoked in addition to your method, and they typically do not
affect the end result.
Class-based views (derived from Django's `generic.models.View` class)
contain methods and mixins which makes granular unit testing (more) feasible.
Quite often your usage of a generic view class comprises an override
of an existing method. Invoking the entire view and the Django request/response
stack is a waste of time when you really want to call the overridden
method directly and test the result.
CBVTestCase to the rescue!
As with TestCase above, have your tests inherit
from test_plus.test.CBVTestCase rather than TestCase like so:
```python
from test_plus.test import CBVTestCase
class MyViewTests(CBVTestCase):
```
## Methods
### get_instance(cls, initkwargs=None, request=None, *args, **kwargs)
This core method simplifies the instantiation of your class, giving you
a way to invoke class methods directly.
Returns an instance of `cls`, initialized with `initkwargs`.
Sets `request`, `args`, and `kwargs` attributes on the class instance.
`args` and `kwargs` are the same values you would pass to `reverse()`.
Sample usage:
```python
from django.views import generic
from test_plus.test import CBVTestCase
class MyClass(generic.DetailView)
def get_context_data(self, **kwargs):
kwargs['answer'] = 42
return kwargs
class MyTests(CBVTestCase):
def test_context_data(self):
my_view = self.get_instance(MyClass, {'object': some_object})
context = my_view.get_context_data()
self.assertEqual(context['answer'], 42)
```
### get(cls, initkwargs=None, *args, **kwargs)
Invokes `cls.get()` and returns the response, rendering template if possible.
Builds on the `CBVTestCase.get_instance()` foundation.
All test_plus.test.TestCase methods are valid, so the following works:
```python
response = self.get(MyClass)
self.assertContext('my_key', expected_value)
```
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.get()`.
**NOTE:** This method bypasses Django's middleware, and therefore context
variables created by middleware are not available. If this affects your
template/context testing, you should use TestCase instead of CBVTestCase.
### post(cls, data=None, initkwargs=None, *args, **kwargs)
Invokes `cls.post()` and returns the response, rendering template if possible.
Builds on the `CBVTestCase.get_instance()` foundation.
Example:
```python
response = self.post(MyClass, data={'search_term': 'revsys'})
self.response_200(response)
self.assertContext('company_name', 'RevSys')
```
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.post()`.
**NOTE:** This method bypasses Django's middleware, and therefore context
variables created by middleware are not available. If this affects your
template/context testing you should use TestCase instead of CBVTestCase.
### get_check_200(cls, initkwargs=None, *args, **kwargs)
Works just like `TestCase.get_check_200()`.
Caller must provide a view class instead of a URL name or path parameter.
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.post()`.
### assertGoodView(cls, initkwargs=None, *args, **kwargs)
Works just like `TestCase.assertGoodView()`.
Caller must provide a view class instead of a URL name or path parameter.
All test_plus TestCase side-effects are honored and all test_plus
TestCase assertion methods work with `CBVTestCase.post()`.
## Development
To work on django-test-plus itself, clone this repository and run the following commands:
```shell
$ pip install -r requirements.txt
$ pip install -e .
```
**NOTE**: You will also need to ensure that the `test_project` directory, located
at the root of this repo, is in your virtualenv's path.
## Keep in touch!
If you have a question about this project, please open a GitHub issue. If you love us and want to keep track of our goings-on, here's where you can find us online:
<a href="https://revsys.com?utm_medium=github&utm_source=django-test-plus"><img src="https://pbs.twimg.com/profile_images/915928618840285185/sUdRGIn1_400x400.jpg" height="50" /></a>
<a href="https://twitter.com/revsys"><img src="https://cdn1.iconfinder.com/data/icons/new_twitter_icon/256/bird_twitter_new_simple.png" height="43" /></a>
<a href="https://www.facebook.com/revsysllc/"><img src="https://cdn3.iconfinder.com/data/icons/picons-social/57/06-facebook-512.png" height="50" /></a>
<a href="https://github.com/revsys/"><img src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png" height="53" /></a>
<a href="https://gitlab.com/revsys"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/1/18/GitLab_Logo.svg/2000px-GitLab_Logo.svg.png" height="44" /></a>
%prep
%autosetup -n django-test-plus-2.2.1
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-django-test-plus -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 2.2.1-1
- Package Spec generated
|