nautobot.apps.testing
¶
Utilities for apps to implement test automation.
nautobot.apps.testing.APITestCase
¶
Bases: views.ModelTestCase
Base test case for API requests.
api_version: Specific API version to test. Leave unset to test the default behavior. Override with set_api_version()
Source code in nautobot/core/testing/api.py
assert_no_verboten_content(response)
¶
Check an API response for content that should not be exposed in the API.
If a specific API has a false failure here (maybe it has security-related strings as model flags or something?), its test case should overload self.VERBOTEN_STRINGS appropriately.
Source code in nautobot/core/testing/api.py
setUp()
¶
Create a token for API calls.
Source code in nautobot/core/testing/api.py
set_api_version(api_version)
¶
Set or unset a specific API version for requests in this test case.
Source code in nautobot/core/testing/api.py
nautobot.apps.testing.APITransactionTestCase
¶
Bases: _APITransactionTestCase
, mixins.NautobotTestCaseMixin
Source code in nautobot/core/testing/api.py
setUp()
¶
Create a superuser and token for API calls.
Source code in nautobot/core/testing/api.py
nautobot.apps.testing.APIViewTestCases
¶
Source code in nautobot/core/testing/api.py
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 |
|
CreateObjectViewTestCase
¶
Bases: APITestCase
Source code in nautobot/core/testing/api.py
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 |
|
test_bulk_create_objects()
¶
POST a set of objects in a single request.
Source code in nautobot/core/testing/api.py
test_create_object()
¶
POST a single object with permission.
Source code in nautobot/core/testing/api.py
test_create_object_without_permission()
¶
POST a single object without permission.
Source code in nautobot/core/testing/api.py
test_recreate_object_csv()
¶
CSV export an object, delete it, and recreate it via CSV import.
Source code in nautobot/core/testing/api.py
DeleteObjectViewTestCase
¶
Bases: APITestCase
Source code in nautobot/core/testing/api.py
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 |
|
get_deletable_object()
¶
Get an instance that can be deleted.
For some models this may just be any random object, but when we have FKs with on_delete=models.PROTECT
(as is often the case) we need to find or create an instance that doesn't have such entanglements.
Source code in nautobot/core/testing/api.py
get_deletable_object_pks()
¶
Get a list of PKs corresponding to objects that can be safely bulk-deleted.
For some models this may just be any random objects, but when we have FKs with on_delete=models.PROTECT
(as is often the case) we need to find or create an instance that doesn't have such entanglements.
Source code in nautobot/core/testing/api.py
test_bulk_delete_objects()
¶
DELETE a set of objects in a single request.
Source code in nautobot/core/testing/api.py
test_delete_object()
¶
DELETE a single object identified by its primary key.
Source code in nautobot/core/testing/api.py
test_delete_object_without_permission()
¶
DELETE a single object without permission.
Source code in nautobot/core/testing/api.py
GetObjectViewTestCase
¶
Bases: APITestCase
Source code in nautobot/core/testing/api.py
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 |
|
test_get_object()
¶
GET a single object as an authenticated user with permission to view the object.
Source code in nautobot/core/testing/api.py
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 |
|
test_get_object_anonymous()
¶
GET a single object as an unauthenticated user.
Source code in nautobot/core/testing/api.py
test_get_object_without_permission()
¶
GET a single object as an authenticated user without the required permission.
Source code in nautobot/core/testing/api.py
test_options_object()
¶
Make an OPTIONS request for a single object.
Source code in nautobot/core/testing/api.py
ListObjectsViewTestCase
¶
Bases: APITestCase
Source code in nautobot/core/testing/api.py
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 |
|
get_depth_fields()
¶
Get a list of model fields that could be tested with the ?depth query parameter
Source code in nautobot/core/testing/api.py
test_list_objects()
¶
GET a list of objects as an authenticated user with permission to view the objects.
Source code in nautobot/core/testing/api.py
test_list_objects_anonymous()
¶
GET a list of objects as an unauthenticated user.
Source code in nautobot/core/testing/api.py
test_list_objects_csv()
¶
GET a list of objects in CSV format as an authenticated user with permission to view some objects.
Source code in nautobot/core/testing/api.py
test_list_objects_depth_0()
¶
GET a list of objects using the "?depth=0" parameter.
Source code in nautobot/core/testing/api.py
test_list_objects_depth_1()
¶
GET a list of objects using the "?depth=1" parameter.
Source code in nautobot/core/testing/api.py
test_list_objects_filtered()
¶
GET a list of objects filtered by ID.
Source code in nautobot/core/testing/api.py
test_list_objects_unknown_filter_no_strict_filtering()
¶
GET a list of objects with an unknown filter parameter and no strict filtering, expect it to be ignored.
Source code in nautobot/core/testing/api.py
test_list_objects_unknown_filter_strict_filtering()
¶
GET a list of objects with an unknown filter parameter and strict filtering, expect a 400 response.
Source code in nautobot/core/testing/api.py
test_list_objects_without_permission()
¶
GET a list of objects as an authenticated user without the required permission.
Source code in nautobot/core/testing/api.py
test_options_objects()
¶
Make an OPTIONS request for a list endpoint.
Source code in nautobot/core/testing/api.py
NotesURLViewTestCase
¶
Bases: APITestCase
Validate Notes URL on objects that have the Note model Mixin.
Source code in nautobot/core/testing/api.py
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 |
|
TreeModelAPIViewTestCaseMixin
¶
Test ?depth=2
query parameter for TreeModel
Source code in nautobot/core/testing/api.py
test_list_objects_depth_2()
¶
GET a list of objects using the "?depth=2" parameter. TreeModel Only
Source code in nautobot/core/testing/api.py
UpdateObjectViewTestCase
¶
Bases: APITestCase
Source code in nautobot/core/testing/api.py
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 |
|
test_bulk_update_objects()
¶
PATCH a set of objects in a single request.
Source code in nautobot/core/testing/api.py
test_get_put_round_trip()
¶
GET and then PUT an object and verify that it's accepted and unchanged.
Source code in nautobot/core/testing/api.py
test_options_returns_expected_choices()
¶
Make an OPTIONS request for a list endpoint and validate choices match expected choices for serializer.
Source code in nautobot/core/testing/api.py
test_update_object()
¶
PATCH a single object identified by its ID.
Source code in nautobot/core/testing/api.py
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 |
|
test_update_object_without_permission()
¶
PATCH a single object without permission.
Source code in nautobot/core/testing/api.py
nautobot.apps.testing.FilterTestCases
¶
Source code in nautobot/core/testing/filters.py
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 |
|
BaseFilterTestCase
¶
Bases: views.TestCase
Base class for testing of FilterSets.
Source code in nautobot/core/testing/filters.py
get_filterset_test_values(field_name, queryset=None)
¶
Returns a list of distinct values from the requested queryset field to use in filterset tests.
Returns a list for use in testing multiple choice filters. The size of the returned list is random but will contain at minimum 2 unique values. The list of values will match at least 2 instances when passed to the queryset's filter(field_name__in=[]) method but will fail to match at least one instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field_name |
str
|
The name of the field to retrieve test values from. |
required |
queryset |
QuerySet
|
The queryset to retrieve test values. Defaults to |
None
|
Returns:
Type | Description |
---|---|
list
|
A list of unique values derived from the queryset. |
Raises:
Type | Description |
---|---|
ValueError
|
Raised if unable to find a combination of 2 or more unique values to filter the queryset to a subset of the total instances. |
Source code in nautobot/core/testing/filters.py
FilterTestCase
¶
Bases: BaseFilterTestCase
Add common tests for all FilterSets.
Source code in nautobot/core/testing/filters.py
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 |
|
test_boolean_filters_generic()
¶
Test all RelatedMembershipBooleanFilter
filters found in self.filterset.get_filters()
except for the ones with custom filter logic defined in its method
attribute.
This test asserts that filter=True
matches self.queryset.filter(field__isnull=False)
and
that filter=False
matches self.queryset.filter(field__isnull=True)
.
Source code in nautobot/core/testing/filters.py
test_filters_generic()
¶
Test all multiple choice filters declared in self.generic_filter_tests
.
This test uses get_filterset_test_values()
to retrieve a valid set of test data and asserts
that the filterset filter output matches the corresponding queryset filter.
The majority of Nautobot filters use conjoined=False, so the extra logic to support conjoined=True has not
been implemented here. TagFilter and similar "AND" filters are not supported.
Examples:
Multiple tests can be performed for the same filter by adding multiple entries in
generic_filter_tests
with explicit field names.
For example, to test a NaturalKeyOrPKMultipleChoiceFilter, use:
generic_filter_tests = (
["filter_name", "field_name__name"],
["filter_name", "field_name__id"],
)
If a field name is not declared, the filter name will be used for the field name:
generic_filter_tests = (
["devices"],
)
This expects a field named devices
on the model and a filter named devices
on the filterset.
Source code in nautobot/core/testing/filters.py
test_id()
¶
Verify that the filterset supports filtering by id.
Source code in nautobot/core/testing/filters.py
test_invalid_filter()
¶
Verify that the filterset reports as invalid when initialized with an unsupported filter parameter.
Source code in nautobot/core/testing/filters.py
test_tags_filter()
¶
Test the tags
filter which should be present on all PrimaryModel filtersets.
Source code in nautobot/core/testing/filters.py
NameOnlyFilterTestCase
¶
Bases: FilterTestCase
Add simple tests for filtering by name.
Source code in nautobot/core/testing/filters.py
test_name()
¶
Verify that the filterset supports filtering by name.
Source code in nautobot/core/testing/filters.py
NameSlugFilterTestCase
¶
Bases: NameOnlyFilterTestCase
Add simple tests for filtering by name and by slug.
Source code in nautobot/core/testing/filters.py
test_slug()
¶
Verify that the filterset supports filtering by slug.
Source code in nautobot/core/testing/filters.py
TenancyFilterTestCaseMixin
¶
Bases: views.TestCase
Add test cases for tenant and tenant-group filters.
Source code in nautobot/core/testing/filters.py
nautobot.apps.testing.ModelTestCase
¶
Bases: TestCase
Parent class for TestCases which deal with models.
Source code in nautobot/core/testing/views.py
nautobot.apps.testing.ModelTestCases
¶
Source code in nautobot/core/testing/models.py
BaseModelTestCase
¶
Bases: TestCase
Base class for generic model tests.
Source code in nautobot/core/testing/models.py
test_composite_key()
¶
Check that composite_key
and filtering by composite_key
both work.
Source code in nautobot/core/testing/models.py
test_get_docs_url()
¶
test_natural_key_symmetry()
¶
Check that natural_key()
and get_by_natural_key()
work reciprocally.
Source code in nautobot/core/testing/models.py
nautobot.apps.testing.ModelViewTestCase
¶
Bases: ModelTestCase
Base TestCase for model views. Subclass to test individual views.
Source code in nautobot/core/testing/views.py
reverse_url_attribute = None
class-attribute
instance-attribute
¶
Name of instance field to pass as a kwarg when looking up URLs for creating/editing/deleting a model instance.
If unspecified, "pk" and "slug" will be tried, in that order.
nautobot.apps.testing.NautobotDataMigrationTest
¶
Bases: TestCase
Source code in nautobot/core/testing/migrations.py
populateDataBeforeMigration(installed_apps)
¶
nautobot.apps.testing.NautobotTestCaseMixin
¶
Base class for all Nautobot-specific unit tests.
Source code in nautobot/core/testing/mixins.py
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 |
|
absolute_api_url(obj)
¶
Get the absolute API URL ("http://nautobot.example.com/api/...") for a given object.
Source code in nautobot/core/testing/mixins.py
add_permissions(*names)
¶
Assign a set of permissions to the test user. Accepts permission names in the form
Source code in nautobot/core/testing/mixins.py
assertHttpStatus(response, expected_status, msg=None)
¶
TestCase method. Provide more detail in the event of an unexpected HTTP response.
Source code in nautobot/core/testing/mixins.py
assertInstanceEqual(instance, data, exclude=None, api=False)
¶
Compare a model instance to a dictionary, checking that its attribute values match those specified in the dictionary.
:param instance: Python object instance :param data: Dictionary of test data used to define the instance :param exclude: List of fields to exclude from comparison (e.g. passwords, which get hashed) :param api: Set to True is the data is a JSON representation of the instance
Source code in nautobot/core/testing/mixins.py
assertQuerysetEqualAndNotEmpty(qs, values, *args, **kwargs)
¶
Wrapper for assertQuerysetEqual with additional logic to assert input queryset and values are not empty
Source code in nautobot/core/testing/mixins.py
create_tags(*names)
classmethod
¶
Create and return a Tag instance for each name given.
DEPRECATED: use TagFactory instead.
Source code in nautobot/core/testing/mixins.py
model_to_dict(instance, fields, api=False)
¶
Return a dictionary representation of an instance.
Source code in nautobot/core/testing/mixins.py
prepare_instance(instance)
¶
Test cases can override this method to perform any necessary manipulation of an instance prior to its evaluation against test data. For example, it can be used to decrypt a Secret's plaintext attribute.
Source code in nautobot/core/testing/mixins.py
setUpNautobot(client=True, populate_status=False)
¶
Setup shared testuser, statuses and client.
Source code in nautobot/core/testing/mixins.py
nautobot.apps.testing.NautobotTestClient
¶
Bases: APIClient
Base client class for Nautobot testing.
DO NOT USE THIS IN PRODUCTION NAUTOBOT CODE.
Source code in nautobot/core/testing/mixins.py
__init__(*args, **kwargs)
¶
Default the SERVER_NAME to "nautobot.example.com" rather than Django's default "testserver".
This matches the ALLOWED_HOSTS set in nautobot/core/tests/nautobot_config.py and helps to protect us against issues like https://github.com/nautobot/nautobot/issues/3065.
Source code in nautobot/core/testing/mixins.py
nautobot.apps.testing.OpenAPISchemaTestCases
¶
Source code in nautobot/core/testing/schema.py
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 |
|
BaseSchemaTestCase
¶
Bases: views.TestCase
Base class for testing of the OpenAPI schema.
Source code in nautobot/core/testing/schema.py
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 |
|
assert_component_mapped_by_object_type(schema, models)
¶
Test method to assert that this polymorphic component has the expected permitted types.
Source code in nautobot/core/testing/schema.py
assert_not_nullable_property(component_schema, property_name)
¶
Test method to assert that the given component property is marked as non-nullable.
Source code in nautobot/core/testing/schema.py
assert_not_read_only_property(component_schema, property_name)
¶
Test method to assert that the given component property is not marked as read-only.
Source code in nautobot/core/testing/schema.py
assert_nullable_property(component_schema, property_name)
¶
Test method to assert that the given component property is marked as nullable.
Source code in nautobot/core/testing/schema.py
assert_read_only_property(component_schema, property_name)
¶
Test method to assert that the given component property is marked as read-only.
Source code in nautobot/core/testing/schema.py
get_component_schema(component_name, api_version=None)
¶
Helper method to pull a specific component schema from the larger OpenAPI schema already loaded.
Source code in nautobot/core/testing/schema.py
get_property_ref_component_name(component_schema, property_name)
¶
Helper method to identify a component referenced by the given property of the current component.
Source code in nautobot/core/testing/schema.py
get_schema_property(component_schema, property_name)
¶
Helper method to pull a specific property schema from a larger component schema already extracted.
Source code in nautobot/core/testing/schema.py
validate_polymorphic_property(component_name, property_name, models=None, nullable=False, read_only=True, many=False)
¶
Bringing it all together.
This validates the schema to show that:
- The component exists and has such a property
- The property has the correct nullable
and readOnly
values
- The property has the correct multiplicity
- The property is a reference to another component
- The property's referenced component is polymorphic and has the expected set of model content-types.
Returns:
Type | Description |
---|---|
Tuple[ref_component_name, ref_component_schema]
|
The referenced component's name and schema. |
Source code in nautobot/core/testing/schema.py
nautobot.apps.testing.SeleniumTestCase
¶
Bases: StaticLiveServerTestCase
, testing.NautobotTestCaseMixin
Base test case for Splinter Selenium integration testing with custom helper methods.
This extends django.contrib.staticfiles.testing.StaticLiveServerTestCase
so there is no need to run collectstatic
prior to running tests.
Source code in nautobot/core/testing/integration.py
login(username, password, login_url=LOGIN_URL, button_text='Log In')
¶
Navigate to login_url
and perform a login w/ the provided username
and password
.
Source code in nautobot/core/testing/integration.py
nautobot.apps.testing.TestCase
¶
Bases: mixins.NautobotTestCaseMixin
, _TestCase
Base class for all Nautobot-specific unit tests.
Source code in nautobot/core/testing/views.py
nautobot.apps.testing.TransactionTestCase
¶
Bases: _TransactionTestCase
, NautobotTestCaseMixin
Base test case class using the TransactionTestCase for unit testing
Source code in nautobot/core/testing/__init__.py
setUp()
¶
Provide a clean, post-migration state before each test case.
django.test.TransactionTestCase truncates the database after each test runs. We need at least the default statuses present in the database in order to run tests.
Source code in nautobot/core/testing/__init__.py
nautobot.apps.testing.ViewTestCases
¶
We keep any TestCases with test_* methods inside a class to prevent unittest from trying to run them.
Source code in nautobot/core/testing/views.py
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 |
|
BulkDeleteObjectsViewTestCase
¶
Bases: ModelViewTestCase
Delete multiple instances.
Source code in nautobot/core/testing/views.py
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 |
|
get_deletable_object_pks()
¶
Get a list of PKs corresponding to objects that can be safely bulk-deleted.
For some models this may just be any random objects, but when we have FKs with on_delete=models.PROTECT
(as is often the case) we need to find or create an instance that doesn't have such entanglements.
Source code in nautobot/core/testing/views.py
BulkEditObjectsViewTestCase
¶
Bases: ModelViewTestCase
Edit multiple instances.
:bulk_edit_data: A dictionary of data to be used when bulk editing a set of objects. This data should differ from that used for initial object creation within setUpTestData().
Source code in nautobot/core/testing/views.py
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 |
|
BulkImportObjectsViewTestCase
¶
Bases: ModelViewTestCase
Create multiple instances from imported data.
Note that CSV import, since it's now implemented via the REST API, is also exercised by APIViewTestCases.CreateObjectViewTestCase.test_recreate_object_csv().
:csv_data: A list of CSV-formatted lines (starting with the headers) to be used for bulk object import.
Source code in nautobot/core/testing/views.py
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 |
|
BulkRenameObjectsViewTestCase
¶
Bases: ModelViewTestCase
Rename multiple instances.
Source code in nautobot/core/testing/views.py
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 |
|
CreateMultipleObjectsViewTestCase
¶
Bases: ModelViewTestCase
Create multiple instances using a single form. Expects the creation of three new instances by default.
:bulk_create_count: The number of objects expected to be created (default: 3). :bulk_create_data: A dictionary of data to be used for bulk object creation.
Source code in nautobot/core/testing/views.py
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 |
|
CreateObjectViewTestCase
¶
Bases: ModelViewTestCase
Create a single new instance.
:form_data: Data to be used when creating a new object.
Source code in nautobot/core/testing/views.py
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 |
|
test_slug_autocreation()
¶
Test that slug is autocreated through ORM.
Source code in nautobot/core/testing/views.py
test_slug_not_modified()
¶
Ensure save method does not modify slug that is passed in.
Source code in nautobot/core/testing/views.py
DeleteObjectViewTestCase
¶
Bases: ModelViewTestCase
Delete a single instance.
Source code in nautobot/core/testing/views.py
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 |
|
get_deletable_object()
¶
Get an instance that can be deleted.
For some models this may just be any random object, but when we have FKs with on_delete=models.PROTECT
(as is often the case) we need to find or create an instance that doesn't have such entanglements.
Source code in nautobot/core/testing/views.py
DeviceComponentTemplateViewTestCase
¶
Bases: EditObjectViewTestCase
, DeleteObjectViewTestCase
, CreateMultipleObjectsViewTestCase
, BulkEditObjectsViewTestCase
, BulkRenameObjectsViewTestCase
, BulkDeleteObjectsViewTestCase
TestCase suitable for testing device component template models (ConsolePortTemplates, InterfaceTemplates, etc.)
Source code in nautobot/core/testing/views.py
DeviceComponentViewTestCase
¶
Bases: GetObjectViewTestCase
, GetObjectChangelogViewTestCase
, GetObjectNotesViewTestCase
, EditObjectViewTestCase
, DeleteObjectViewTestCase
, ListObjectsViewTestCase
, CreateMultipleObjectsViewTestCase
, BulkImportObjectsViewTestCase
, BulkEditObjectsViewTestCase
, BulkRenameObjectsViewTestCase
, BulkDeleteObjectsViewTestCase
TestCase suitable for testing device component models (ConsolePorts, Interfaces, etc.)
Source code in nautobot/core/testing/views.py
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 |
|
bulk_add_data = None
class-attribute
instance-attribute
¶
Used for bulk-add (distinct from bulk-create) view testing; self.bulk_create_data will be used if unset.
test_bulk_add_component()
¶
Test bulk-adding this component to devices/virtual-machines.
Source code in nautobot/core/testing/views.py
EditObjectViewTestCase
¶
Bases: ModelViewTestCase
Edit a single existing instance.
:form_data: Data to be used when updating the first existing object.
Source code in nautobot/core/testing/views.py
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 |
|
GetObjectChangelogViewTestCase
¶
Bases: ModelViewTestCase
View the changelog for an instance.
Source code in nautobot/core/testing/views.py
GetObjectNotesViewTestCase
¶
Bases: ModelViewTestCase
View the notes for an instance.
Source code in nautobot/core/testing/views.py
GetObjectViewTestCase
¶
Bases: ModelViewTestCase
Retrieve a single instance.
Source code in nautobot/core/testing/views.py
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 |
|
ListObjectsViewTestCase
¶
Bases: ModelViewTestCase
Retrieve multiple instances.
Source code in nautobot/core/testing/views.py
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 |
|
test_list_objects_unknown_filter_no_strict_filtering()
¶
Verify that without STRICT_FILTERING, an unknown filter is ignored.
Source code in nautobot/core/testing/views.py
test_list_objects_unknown_filter_strict_filtering()
¶
Verify that with STRICT_FILTERING, an unknown filter results in an error message and no matches.
Source code in nautobot/core/testing/views.py
test_list_view_plugin_banner()
¶
If example plugin is installed, check if the plugin banner is rendered correctly in ObjectListView.
Source code in nautobot/core/testing/views.py
OrganizationalObjectViewTestCase
¶
Bases: GetObjectViewTestCase
, GetObjectChangelogViewTestCase
, GetObjectNotesViewTestCase
, CreateObjectViewTestCase
, EditObjectViewTestCase
, DeleteObjectViewTestCase
, ListObjectsViewTestCase
, BulkImportObjectsViewTestCase
, BulkDeleteObjectsViewTestCase
TestCase suitable for all organizational objects
Source code in nautobot/core/testing/views.py
PrimaryObjectViewTestCase
¶
Bases: GetObjectViewTestCase
, GetObjectChangelogViewTestCase
, GetObjectNotesViewTestCase
, CreateObjectViewTestCase
, EditObjectViewTestCase
, DeleteObjectViewTestCase
, ListObjectsViewTestCase
, BulkImportObjectsViewTestCase
, BulkEditObjectsViewTestCase
, BulkDeleteObjectsViewTestCase
TestCase suitable for testing all standard View functions for primary objects
Source code in nautobot/core/testing/views.py
nautobot.apps.testing.create_job_result_and_run_job(module, name, source='local', *args, **kwargs)
¶
Test helper function to call get_job_class_and_model() then call run_job_for_testing().
Source code in nautobot/core/testing/__init__.py
nautobot.apps.testing.create_test_user(username='testuser', permissions=None)
¶
Create a User with the given permissions.
Source code in nautobot/core/testing/utils.py
nautobot.apps.testing.disable_warnings(logger_name)
¶
Temporarily suppress expected warning messages to keep the test output clean.
Source code in nautobot/core/testing/utils.py
nautobot.apps.testing.extract_form_failures(content)
¶
Given decoded HTML content from an HTTP response, return a list of form errors.
nautobot.apps.testing.extract_page_body(content)
¶
Given raw HTML content from an HTTP response, extract the main div only.
...
Source code in nautobot/core/testing/utils.py
nautobot.apps.testing.generate_random_device_asset_tag_of_specified_size(size)
¶
This function is for testing purposes only and it will return a random string of size 100 consists of letters and numbers.
Source code in nautobot/core/testing/utils.py
nautobot.apps.testing.get_deletable_objects(model, queryset)
¶
Returns a queryset of objects in the supplied queryset that have no protected relationships that would prevent deletion.
Source code in nautobot/core/testing/utils.py
nautobot.apps.testing.get_job_class_and_model(module, name, source='local')
¶
Test helper function to look up a job class and job model and ensure the latter is enabled.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
module |
str
|
Job module name |
required |
name |
str
|
Job class name |
required |
source |
str
|
Job grouping (default: "local") |
'local'
|
Returns:
Type | Description |
---|---|
JobClassInfo
|
Named 2-tuple of (job_class, job_model) |
Source code in nautobot/core/testing/__init__.py
nautobot.apps.testing.post_data(data)
¶
Take a dictionary of test data (suitable for comparison to an instance) and return a dict suitable for POSTing.
Source code in nautobot/core/testing/utils.py
nautobot.apps.testing.run_job_for_testing(job, username='test-user', profile=False, **kwargs)
¶
Provide a common interface to run Nautobot jobs as part of unit tests.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
job |
Job
|
Job model instance (not Job class) to run |
required |
username |
str
|
Username of existing or to-be-created User account to own the JobResult. |
'test-user'
|
profile |
bool
|
Whether to profile the job execution. |
False
|
Other Parameters:
Name | Type | Description |
---|---|---|
**kwargs |
any
|
Input keyword arguments for Job run method. |
Returns:
Type | Description |
---|---|
JobResult
|
representing the executed job |