-
Notifications
You must be signed in to change notification settings - Fork 169
/
test_course.py
1794 lines (1350 loc) · 68.2 KB
/
test_course.py
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
from __future__ import absolute_import, division, print_function, unicode_literals
import unittest
import uuid
import warnings
import requests
import requests_mock
from six import text_type
from six.moves.urllib.parse import quote
from canvasapi import Canvas
from canvasapi.assignment import Assignment, AssignmentGroup, AssignmentOverride
from canvasapi.blueprint import BlueprintSubscription
from canvasapi.blueprint import BlueprintTemplate
from canvasapi.course import Course, CourseNickname, Page
from canvasapi.discussion_topic import DiscussionTopic
from canvasapi.grading_standard import GradingStandard
from canvasapi.enrollment import Enrollment
from canvasapi.course_epub_export import CourseEpubExport
from canvasapi.exceptions import ResourceDoesNotExist, RequiredFieldMissing
from canvasapi.external_feed import ExternalFeed
from canvasapi.external_tool import ExternalTool
from canvasapi.feature import Feature, FeatureFlag
from canvasapi.file import File
from canvasapi.folder import Folder
from canvasapi.grading_period import GradingPeriod
from canvasapi.group import Group, GroupCategory
from canvasapi.module import Module
from canvasapi.outcome import OutcomeGroup, OutcomeLink
from canvasapi.outcome_import import OutcomeImport
from canvasapi.paginated_list import PaginatedList
from canvasapi.progress import Progress
from canvasapi.quiz import Quiz, QuizExtension
from canvasapi.rubric import Rubric
from canvasapi.section import Section
from canvasapi.submission import GroupedSubmission, Submission
from canvasapi.tab import Tab
from canvasapi.user import User
from canvasapi.user import UserDisplay
from canvasapi.content_migration import ContentMigration, Migrator
from canvasapi.content_export import ContentExport
from tests import settings
from tests.util import cleanup_file, register_uris
@requests_mock.Mocker()
class TestCourse(unittest.TestCase):
def setUp(self):
warnings.simplefilter("always", DeprecationWarning)
self.canvas = Canvas(settings.BASE_URL, settings.API_KEY)
with requests_mock.Mocker() as m:
requires = {
"course": ["get_assignment_by_id", "get_by_id", "get_page"],
"quiz": ["get_by_id"],
"user": ["get_by_id"],
}
register_uris(requires, m)
self.course = self.canvas.get_course(1)
self.page = self.course.get_page("my-url")
self.quiz = self.course.get_quiz(1)
self.user = self.canvas.get_user(1)
self.assignment = self.course.get_assignment(1)
# __str__()
def test__str__(self, m):
string = str(self.course)
self.assertIsInstance(string, str)
# conclude()
def test_conclude(self, m):
register_uris({"course": ["conclude"]}, m)
success = self.course.conclude()
self.assertTrue(success)
# create_assignment_overrides()
def test_create_assignment_overrides(self, m):
register_uris({"assignment": ["batch_create_assignment_overrides"]}, m)
override_list = [
{
"student_ids": [1, 2, 3],
"title": "New Assignment Override",
"assignment_id": 1,
},
{
"assignment_id": 2,
"student_ids": [1, 2, 3],
"title": "New Assignment Override 2",
},
]
created_overrides = self.course.create_assignment_overrides(override_list)
created_list = [created for created in created_overrides]
self.assertEqual(len(created_list), 2)
self.assertIsInstance(created_list[0], AssignmentOverride)
self.assertIsInstance(created_list[1], AssignmentOverride)
# delete()
def test_delete(self, m):
register_uris({"course": ["delete"]}, m)
success = self.course.delete()
self.assertTrue(success)
# update()
def test_update(self, m):
register_uris({"course": ["update"]}, m)
new_name = "New Name"
self.course.update(course={"name": new_name})
self.assertEqual(self.course.name, new_name)
# update_assignment_overrides()
def test_update_assignment_overrides(self, m):
register_uris({"assignment": ["batch_update_assignment_overrides"]}, m)
override_list = [
{
"student_ids": [4, 5, 6],
"title": "Updated Assignment Override",
"assignment_id": 1,
},
{
"assignment_id": 2,
"student_ids": [6, 7],
"title": "Updated Assignment Override 2",
},
]
updated_overrides = self.course.update_assignment_overrides(override_list)
updated_list = [updated for updated in updated_overrides]
self.assertEqual(len(updated_list), 2)
self.assertIsInstance(updated_list[0], AssignmentOverride)
self.assertIsInstance(updated_list[1], AssignmentOverride)
# get_user()
def test_get_user(self, m):
register_uris({"course": ["get_user"]}, m)
user_by_id = self.course.get_user(1)
self.assertIsInstance(user_by_id, User)
self.assertTrue(hasattr(user_by_id, "name"))
user_by_obj = self.course.get_user(user_by_id)
self.assertIsInstance(user_by_obj, User)
self.assertTrue(hasattr(user_by_obj, "name"))
def test_get_user_id_type(self, m):
register_uris({"course": ["get_user_id_type"]}, m)
user = self.course.get_user("LOGINID", "login_id")
self.assertIsInstance(user, User)
self.assertTrue(hasattr(user, "name"))
# get_users()
def test_get_users(self, m):
register_uris({"course": ["get_users", "get_users_p2"]}, m)
users = self.course.get_users()
user_list = [user for user in users]
self.assertEqual(len(user_list), 4)
self.assertIsInstance(user_list[0], User)
# enroll_user()
def test_enroll_user(self, m):
requires = {"course": ["enroll_user"], "user": ["get_by_id"]}
register_uris(requires, m)
enrollment_type = "TeacherEnrollment"
user_by_id = self.canvas.get_user(1)
enrollment_by_id = self.course.enroll_user(user_by_id, enrollment_type)
self.assertIsInstance(enrollment_by_id, Enrollment)
self.assertTrue(hasattr(enrollment_by_id, "type"))
self.assertEqual(enrollment_by_id.type, enrollment_type)
user_by_obj = self.canvas.get_user(self.user)
enrollment_by_obj = self.course.enroll_user(user_by_obj, enrollment_type)
self.assertIsInstance(enrollment_by_obj, Enrollment)
self.assertTrue(hasattr(enrollment_by_obj, "type"))
self.assertEqual(enrollment_by_obj.type, enrollment_type)
# get_recent_students()
def test_get_recent_students(self, m):
recent = {"course": ["get_recent_students", "get_recent_students_p2"]}
register_uris(recent, m)
students = self.course.get_recent_students()
student_list = [student for student in students]
self.assertEqual(len(student_list), 4)
self.assertIsInstance(student_list[0], User)
self.assertTrue(hasattr(student_list[0], "name"))
# preview_html()
def test_preview_html(self, m):
register_uris({"course": ["preview_html"]}, m)
html_str = "<script></script><p>hello</p>"
prev_html = self.course.preview_html(html_str)
self.assertIsInstance(prev_html, text_type)
self.assertEqual(prev_html, "<p>hello</p>")
# get_settings()
def test_get_settings(self, m):
register_uris({"course": ["settings"]}, m)
settings = self.course.get_settings()
self.assertIsInstance(settings, dict)
# update_settings()
def test_update_settings(self, m):
register_uris({"course": ["update_settings"]}, m)
settings = self.course.update_settings()
self.assertIsInstance(settings, dict)
self.assertTrue(settings["hide_final_grades"])
# upload()
def test_upload(self, m):
register_uris({"course": ["upload", "upload_final"]}, m)
filename = "testfile_course_{}".format(uuid.uuid4().hex)
try:
with open(filename, "w+") as file:
response = self.course.upload(file)
self.assertTrue(response[0])
self.assertIsInstance(response[1], dict)
self.assertIn("url", response[1])
finally:
cleanup_file(filename)
# reset()
def test_reset(self, m):
register_uris({"course": ["reset"]}, m)
course = self.course.reset()
self.assertIsInstance(course, Course)
self.assertTrue(hasattr(course, "name"))
# create_quiz()
def test_create_quiz(self, m):
register_uris({"course": ["create_quiz"]}, m)
title = "Newer Title"
new_quiz = self.course.create_quiz({"title": title})
self.assertIsInstance(new_quiz, Quiz)
self.assertTrue(hasattr(new_quiz, "title"))
self.assertEqual(new_quiz.title, title)
self.assertTrue(hasattr(new_quiz, "course_id"))
self.assertEqual(new_quiz.course_id, self.course.id)
def test_create_quiz_fail(self, m):
with self.assertRaises(RequiredFieldMissing):
self.course.create_quiz({})
# get_quiz()
def test_get_quiz(self, m):
register_uris({"course": ["get_quiz"]}, m)
target_quiz_by_id = self.course.get_quiz(1)
self.assertIsInstance(target_quiz_by_id, Quiz)
self.assertTrue(hasattr(target_quiz_by_id, "course_id"))
self.assertEqual(target_quiz_by_id.course_id, self.course.id)
target_quiz_by_obj = self.course.get_quiz(target_quiz_by_id)
self.assertIsInstance(target_quiz_by_obj, Quiz)
self.assertTrue(hasattr(target_quiz_by_obj, "course_id"))
self.assertEqual(target_quiz_by_obj.course_id, self.course.id)
def test_get_quiz_fail(self, m):
register_uris({"generic": ["not_found"]}, m)
with self.assertRaises(ResourceDoesNotExist):
self.course.get_quiz(settings.INVALID_ID)
# get_quizzes()
def test_get_quizzes(self, m):
register_uris({"course": ["list_quizzes", "list_quizzes2"]}, m)
quizzes = self.course.get_quizzes()
quiz_list = [quiz for quiz in quizzes]
self.assertEqual(len(quiz_list), 4)
self.assertIsInstance(quiz_list[0], Quiz)
self.assertTrue(hasattr(quiz_list[0], "course_id"))
self.assertEqual(quiz_list[0].course_id, self.course.id)
# get_modules()
def test_get_modules(self, m):
register_uris({"course": ["list_modules", "list_modules2"]}, m)
modules = self.course.get_modules()
module_list = [module for module in modules]
self.assertEqual(len(module_list), 4)
self.assertIsInstance(module_list[0], Module)
self.assertTrue(hasattr(module_list[0], "course_id"))
self.assertEqual(module_list[0].course_id, self.course.id)
# get_module()
def test_get_module(self, m):
register_uris({"course": ["get_module_by_id"]}, m)
target_module_by_id = self.course.get_module(1)
self.assertIsInstance(target_module_by_id, Module)
self.assertTrue(hasattr(target_module_by_id, "course_id"))
self.assertEqual(target_module_by_id.course_id, self.course.id)
target_module_by_obj = self.course.get_module(target_module_by_id)
self.assertIsInstance(target_module_by_obj, Module)
self.assertTrue(hasattr(target_module_by_obj, "course_id"))
self.assertEqual(target_module_by_obj.course_id, self.course.id)
# create_module()
def test_create_module(self, m):
register_uris({"course": ["create_module"]}, m)
name = "Name"
new_module = self.course.create_module(module={"name": name})
self.assertIsInstance(new_module, Module)
self.assertTrue(hasattr(new_module, "name"))
self.assertTrue(hasattr(new_module, "course_id"))
self.assertEqual(new_module.course_id, self.course.id)
def test_create_module_fail(self, m):
with self.assertRaises(RequiredFieldMissing):
self.course.create_module(module={})
# get_enrollments()
def test_get_enrollments(self, m):
register_uris({"course": ["list_enrollments", "list_enrollments_2"]}, m)
enrollments = self.course.get_enrollments()
enrollment_list = [enrollment for enrollment in enrollments]
self.assertEqual(len(enrollment_list), 4)
self.assertIsInstance(enrollment_list[0], Enrollment)
# get_sections()
def test_get_sections(self, m):
register_uris({"course": ["get_sections", "get_sections_p2"]}, m)
sections = self.course.get_sections()
section_list = [section for section in sections]
self.assertEqual(len(section_list), 4)
self.assertIsInstance(section_list[0], Section)
# get_section
def test_get_section(self, m):
register_uris({"course": ["get_section"]}, m)
section_by_id = self.course.get_section(1)
self.assertIsInstance(section_by_id, Section)
section_by_obj = self.course.get_section(section_by_id)
self.assertIsInstance(section_by_obj, Section)
# create_assignment()
def test_create_assignment(self, m):
register_uris({"course": ["create_assignment"]}, m)
name = "Newly Created Assignment"
assignment = self.course.create_assignment(assignment={"name": name})
self.assertIsInstance(assignment, Assignment)
self.assertTrue(hasattr(assignment, "name"))
self.assertEqual(assignment.name, name)
self.assertEqual(assignment.id, 1)
def test_create_assignment_fail(self, m):
with self.assertRaises(RequiredFieldMissing):
self.course.create_assignment(assignment={})
# get_assignment()
def test_get_assignment(self, m):
register_uris({"course": ["get_assignment_by_id"]}, m)
assignment_by_id = self.course.get_assignment(1)
self.assertIsInstance(assignment_by_id, Assignment)
self.assertTrue(hasattr(assignment_by_id, "name"))
assignment_by_obj = self.course.get_assignment(self.assignment)
self.assertIsInstance(assignment_by_obj, Assignment)
self.assertTrue(hasattr(assignment_by_obj, "name"))
# get_assignment_overrides()
def test_get_assignment_overrides(self, m):
register_uris(
{
"assignment": [
"batch_get_assignment_overrides",
"batch_get_assignment_overrides_p2",
]
},
m,
)
bulk_select = [{"id": 1, "assignment_id": 1}, {"id": 20, "assignment_id": 2}]
overrides = self.course.get_assignment_overrides(bulk_select)
override_list = [override for override in overrides]
self.assertEqual(len(override_list), 2)
self.assertIsInstance(override_list[0], AssignmentOverride)
# get_assignments()
def test_get_assignments(self, m):
requires = {"course": ["get_all_assignments", "get_all_assignments2"]}
register_uris(requires, m)
assignments = self.course.get_assignments()
assignment_list = [assignment for assignment in assignments]
self.assertIsInstance(assignments[0], Assignment)
self.assertEqual(len(assignment_list), 4)
# show_front_page()
def test_show_front_page(self, m):
register_uris({"course": ["show_front_page"]}, m)
front_page = self.course.show_front_page()
self.assertIsInstance(front_page, Page)
self.assertTrue(hasattr(front_page, "url"))
self.assertTrue(hasattr(front_page, "title"))
# create_front_page()
def test_edit_front_page(self, m):
register_uris({"course": ["edit_front_page"]}, m)
new_front_page = self.course.edit_front_page()
self.assertIsInstance(new_front_page, Page)
self.assertTrue(hasattr(new_front_page, "url"))
self.assertTrue(hasattr(new_front_page, "title"))
# get_page()
def test_get_page(self, m):
register_uris({"course": ["get_page"]}, m)
url = "my-url"
page = self.course.get_page(url)
self.assertIsInstance(page, Page)
# get_pages()
def test_get_pages(self, m):
register_uris({"course": ["get_pages", "get_pages2"]}, m)
pages = self.course.get_pages()
page_list = [page for page in pages]
self.assertEqual(len(page_list), 4)
self.assertIsInstance(page_list[0], Page)
self.assertTrue(hasattr(page_list[0], "course_id"))
self.assertEqual(page_list[0].course_id, self.course.id)
# create_page()
def test_create_page(self, m):
register_uris({"course": ["create_page"]}, m)
title = "Newest Page"
new_page = self.course.create_page(wiki_page={"title": title})
self.assertIsInstance(new_page, Page)
self.assertTrue(hasattr(new_page, "title"))
self.assertEqual(new_page.title, title)
self.assertTrue(hasattr(new_page, "course_id"))
self.assertEqual(new_page.course_id, self.course.id)
def test_create_page_fail(self, m):
with self.assertRaises(RequiredFieldMissing):
self.course.create_page(settings.INVALID_ID)
# get_external_tool()
def test_get_external_tool(self, m):
register_uris({"external_tool": ["get_by_id_course"]}, m)
tool_by_id = self.course.get_external_tool(1)
self.assertIsInstance(tool_by_id, ExternalTool)
self.assertTrue(hasattr(tool_by_id, "name"))
tool_by_obj = self.course.get_external_tool(tool_by_id)
self.assertIsInstance(tool_by_obj, ExternalTool)
self.assertTrue(hasattr(tool_by_obj, "name"))
# get_external_tools()
def test_get_external_tools(self, m):
requires = {"course": ["get_external_tools", "get_external_tools_p2"]}
register_uris(requires, m)
tools = self.course.get_external_tools()
tool_list = [tool for tool in tools]
self.assertIsInstance(tool_list[0], ExternalTool)
self.assertEqual(len(tool_list), 4)
def test_list_sections(self, m):
register_uris({"course": ["get_sections", "get_sections_p2"]}, m)
with warnings.catch_warnings(record=True) as warning_list:
sections = self.course.list_sections()
section_list = [sect for sect in sections]
self.assertEqual(len(section_list), 4)
self.assertIsInstance(section_list[0], Section)
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
def test_create_course_section(self, m):
register_uris({"course": ["create_section"]}, m)
section = self.course.create_course_section()
self.assertIsInstance(section, Section)
# list_groups()
def test_list_groups(self, m):
requires = {"course": ["list_groups_context", "list_groups_context2"]}
register_uris(requires, m)
with warnings.catch_warnings(record=True) as warning_list:
groups = self.course.list_groups()
group_list = [group for group in groups]
self.assertIsInstance(group_list[0], Group)
self.assertEqual(len(group_list), 4)
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
# get_groups()
def test_get_groups(self, m):
requires = {"course": ["list_groups_context", "list_groups_context2"]}
register_uris(requires, m)
groups = self.course.get_groups()
group_list = [group for group in groups]
self.assertIsInstance(group_list[0], Group)
self.assertEqual(len(group_list), 4)
# create_group_category()
def test_create_group_category(self, m):
register_uris({"course": ["create_group_category"]}, m)
name_str = "Test String"
response = self.course.create_group_category(name=name_str)
self.assertIsInstance(response, GroupCategory)
# list_group_categories()
def test_list_group_categories(self, m):
register_uris({"course": ["list_group_categories"]}, m)
with warnings.catch_warnings(record=True) as warning_list:
response = self.course.list_group_categories()
category_list = [category for category in response]
self.assertIsInstance(category_list[0], GroupCategory)
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
# get_group_categories()
def test_get_group_categories(self, m):
register_uris({"course": ["list_group_categories"]}, m)
response = self.course.get_group_categories()
category_list = [category for category in response]
self.assertIsInstance(category_list[0], GroupCategory)
# get_discussion_topic()
def test_get_discussion_topic(self, m):
register_uris({"course": ["get_discussion_topic"]}, m)
topic_id = 1
discussion_by_id = self.course.get_discussion_topic(topic_id)
self.assertIsInstance(discussion_by_id, DiscussionTopic)
self.assertTrue(hasattr(discussion_by_id, "course_id"))
self.assertEqual(discussion_by_id.course_id, 1)
discussion_by_obj = self.course.get_discussion_topic(discussion_by_id)
self.assertIsInstance(discussion_by_obj, DiscussionTopic)
self.assertTrue(hasattr(discussion_by_obj, "course_id"))
self.assertEqual(discussion_by_obj.course_id, 1)
# get_file()
def test_get_file(self, m):
register_uris({"course": ["get_file"]}, m)
file_by_id = self.course.get_file(1)
self.assertIsInstance(file_by_id, File)
self.assertEqual(file_by_id.display_name, "Course_File.docx")
self.assertEqual(file_by_id.size, 2048)
file_by_obj = self.course.get_file(file_by_id)
self.assertIsInstance(file_by_obj, File)
self.assertEqual(file_by_obj.display_name, "Course_File.docx")
self.assertEqual(file_by_obj.size, 2048)
# get_full_discussion_topic()
def test_get_full_discussion_topic(self, m):
register_uris(
{"course": ["get_discussion_topics", "get_full_discussion_topic"]}, m
)
topic_id = 1
discussion_by_id = self.course.get_full_discussion_topic(topic_id)
self.assertIsInstance(discussion_by_id, dict)
self.assertIn("view", discussion_by_id)
self.assertIn("participants", discussion_by_id)
self.assertIn("id", discussion_by_id)
self.assertEqual(discussion_by_id["id"], topic_id)
discussion_topics = self.course.get_discussion_topics()
discussion_by_obj = self.course.get_full_discussion_topic(discussion_topics[0])
self.assertIsInstance(discussion_by_obj, dict)
self.assertIn("view", discussion_by_obj)
self.assertIn("participants", discussion_by_obj)
self.assertIn("id", discussion_by_obj)
self.assertEqual(discussion_by_obj["id"], topic_id)
# get_discussion_topics()
def test_get_discussion_topics(self, m):
register_uris({"course": ["get_discussion_topics"]}, m)
response = self.course.get_discussion_topics()
discussion_list = [discussion for discussion in response]
self.assertIsInstance(discussion_list[0], DiscussionTopic)
self.assertTrue(hasattr(discussion_list[0], "course_id"))
self.assertEqual(2, len(discussion_list))
# create_discussion_topic()
def test_create_discussion_topic(self, m):
register_uris({"course": ["create_discussion_topic"]}, m)
title = "Topic 1"
discussion = self.course.create_discussion_topic()
self.assertIsInstance(discussion, DiscussionTopic)
self.assertTrue(hasattr(discussion, "course_id"))
self.assertEqual(title, discussion.title)
self.assertEqual(discussion.course_id, 1)
# reorder_pinned_topics()
def test_reorder_pinned_topics(self, m):
# Custom matcher to test that params are set correctly
def custom_matcher(request):
match_text = "1,2,3"
if request.text == "order={}".format(quote(match_text)):
resp = requests.Response()
resp._content = b'{"reorder": true, "order": [1, 2, 3]}'
resp.status_code = 200
return resp
m.add_matcher(custom_matcher)
order = [1, 2, 3]
discussions = self.course.reorder_pinned_topics(order=order)
self.assertTrue(discussions)
def test_reorder_pinned_topics_tuple(self, m):
register_uris({"course": ["reorder_pinned_topics"]}, m)
order = (1, 2, 3)
discussions = self.course.reorder_pinned_topics(order=order)
self.assertTrue(discussions)
def test_reorder_pinned_topics_comma_separated_string(self, m):
register_uris({"course": ["reorder_pinned_topics"]}, m)
order = "1,2,3"
discussions = self.course.reorder_pinned_topics(order=order)
self.assertTrue(discussions)
def test_reorder_pinned_topics_invalid_input(self, m):
order = "invalid string"
with self.assertRaises(ValueError):
self.course.reorder_pinned_topics(order=order)
# get_assignment_group()
def test_get_assignment_group(self, m):
register_uris({"assignment": ["get_assignment_group"]}, m)
assignment_group_by_id = self.course.get_assignment_group(5)
self.assertIsInstance(assignment_group_by_id, AssignmentGroup)
self.assertTrue(hasattr(assignment_group_by_id, "id"))
self.assertTrue(hasattr(assignment_group_by_id, "name"))
self.assertTrue(hasattr(assignment_group_by_id, "course_id"))
self.assertEqual(assignment_group_by_id.course_id, 1)
assignment_group_by_obj = self.course.get_assignment_group(
assignment_group_by_id
)
self.assertIsInstance(assignment_group_by_obj, AssignmentGroup)
self.assertTrue(hasattr(assignment_group_by_obj, "id"))
self.assertTrue(hasattr(assignment_group_by_obj, "name"))
self.assertTrue(hasattr(assignment_group_by_obj, "course_id"))
self.assertEqual(assignment_group_by_obj.course_id, 1)
# list_assignment_groups()
def test_list_assignment_groups(self, m):
register_uris(
{"assignment": ["list_assignment_groups", "get_assignment_group"]}, m
)
with warnings.catch_warnings(record=True) as warning_list:
response = self.course.list_assignment_groups()
asnt_group_list = [assignment_group for assignment_group in response]
self.assertIsInstance(asnt_group_list[0], AssignmentGroup)
self.assertTrue(hasattr(asnt_group_list[0], "id"))
self.assertTrue(hasattr(asnt_group_list[0], "name"))
self.assertTrue(hasattr(asnt_group_list[0], "course_id"))
self.assertEqual(asnt_group_list[0].course_id, 1)
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
# get_assignment_groups()
def test_get_assignment_groups(self, m):
register_uris(
{"assignment": ["list_assignment_groups", "get_assignment_group"]}, m
)
response = self.course.get_assignment_groups()
asnt_group_list = [assignment_group for assignment_group in response]
self.assertIsInstance(asnt_group_list[0], AssignmentGroup)
self.assertTrue(hasattr(asnt_group_list[0], "id"))
self.assertTrue(hasattr(asnt_group_list[0], "name"))
self.assertTrue(hasattr(asnt_group_list[0], "course_id"))
self.assertEqual(asnt_group_list[0].course_id, 1)
# create_assignment_group()
def test_create_assignment_group(self, m):
register_uris({"assignment": ["create_assignment_group"]}, m)
response = self.course.create_assignment_group()
self.assertIsInstance(response, AssignmentGroup)
self.assertTrue(hasattr(response, "id"))
self.assertEqual(response.id, 3)
# create_external_tool()
def test_create_external_tool(self, m):
register_uris({"external_tool": ["create_tool_course"]}, m)
response = self.course.create_external_tool(
name="External Tool - Course",
privacy_level="public",
consumer_key="key",
shared_secret="secret",
)
self.assertIsInstance(response, ExternalTool)
self.assertTrue(hasattr(response, "id"))
self.assertEqual(response.id, 20)
# get_collaborations
def test_get_collaborations(self, m):
register_uris({"course": ["get_collaborations"]}, m)
from canvasapi.collaboration import Collaboration
collab_list = self.course.get_collaborations()
self.assertIsInstance(collab_list, PaginatedList)
self.assertIsInstance(collab_list[0], Collaboration)
self.assertIsInstance(collab_list[1], Collaboration)
self.assertEqual(collab_list[0].id, 1)
self.assertEqual(collab_list[1].id, 2)
self.assertEqual(collab_list[0].document_id, "oinwoenfe8w8ef_onweufe89fef")
self.assertEqual(collab_list[1].document_id, "oinwoenfe8w8ef_onweufe89zzz")
# get_course_level_participation_data()
def test_get_course_level_participation_data(self, m):
register_uris({"course": ["get_course_level_participation_data"]}, m)
response = self.course.get_course_level_participation_data()
self.assertIsInstance(response, list)
# get_course_level_assignment_data()
def test_get_course_level_assignment_data(self, m):
register_uris({"course": ["get_course_level_assignment_data"]}, m)
response = self.course.get_course_level_assignment_data()
self.assertIsInstance(response, list)
# get_course_level_student_summary_data()
def test_get_course_level_student_summary_data(self, m):
register_uris({"course": ["get_course_level_student_summary_data"]}, m)
response = self.course.get_course_level_student_summary_data()
self.assertIsInstance(response, list)
# get_user_in_a_course_level_participation_data()
def test_get_user_in_a_course_level_participation_data(self, m):
register_uris({"course": ["get_user_in_a_course_level_participation_data"]}, m)
response = self.course.get_user_in_a_course_level_participation_data(1)
self.assertIsInstance(response, list)
response = self.course.get_user_in_a_course_level_participation_data(self.user)
self.assertIsInstance(response, list)
# get_user_in_a_course_level_assignment_data()
def test_get_user_in_a_course_level_assignment_data(self, m):
register_uris({"course": ["get_user_in_a_course_level_assignment_data"]}, m)
response = self.course.get_user_in_a_course_level_assignment_data(1)
self.assertIsInstance(response, list)
response = self.course.get_user_in_a_course_level_assignment_data(self.user)
self.assertIsInstance(response, list)
# get_user_in_a_course_level_messaging_data()
def test_get_user_in_a_course_level_messaging_data(self, m):
register_uris({"course": ["get_user_in_a_course_level_messaging_data"]}, m)
response = self.course.get_user_in_a_course_level_messaging_data(1)
self.assertIsInstance(response, list)
response = self.course.get_user_in_a_course_level_messaging_data(self.user)
self.assertIsInstance(response, list)
# submit_assignment()
def test_submit_assignment(self, m):
register_uris({"assignment": ["submit"]}, m)
with warnings.catch_warnings(record=True) as warning_list:
assignment_id = 1
sub_type = "online_upload"
sub_dict = {"submission_type": sub_type}
submission_by_id = self.course.submit_assignment(assignment_id, sub_dict)
self.assertIsInstance(submission_by_id, Submission)
self.assertTrue(hasattr(submission_by_id, "submission_type"))
self.assertEqual(submission_by_id.submission_type, sub_type)
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
with warnings.catch_warnings(record=True) as warning_list:
submission_by_obj = self.course.submit_assignment(self.assignment, sub_dict)
self.assertIsInstance(submission_by_obj, Submission)
self.assertTrue(hasattr(submission_by_obj, "submission_type"))
self.assertEqual(submission_by_obj.submission_type, sub_type)
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
def test_submit_assignment_fail(self, m):
with warnings.catch_warnings(record=True) as warning_list:
with self.assertRaises(RequiredFieldMissing):
self.course.submit_assignment(1, {})
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
# list_submissions()
def test_list_submissions(self, m):
register_uris({"submission": ["list_submissions"]}, m)
with warnings.catch_warnings(record=True) as warning_list:
assignment_id = 1
submissions_by_id = self.course.list_submissions(assignment_id)
submission_list_by_id = [submission for submission in submissions_by_id]
self.assertEqual(len(submission_list_by_id), 2)
self.assertIsInstance(submission_list_by_id[0], Submission)
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
with warnings.catch_warnings(record=True) as warning_list:
submissions_by_obj = self.course.list_submissions(self.assignment)
submission_list_by_obj = [submission for submission in submissions_by_obj]
self.assertEqual(len(submission_list_by_obj), 2)
self.assertIsInstance(submission_list_by_obj[0], Submission)
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
# list_multiple_submission()
def test_list_multiple_submissions(self, m):
register_uris({"course": ["list_multiple_submissions"]}, m)
with warnings.catch_warnings(record=True) as warning_list:
submissions = self.course.list_multiple_submissions()
submission_list = [submission for submission in submissions]
self.assertEqual(len(submission_list), 2)
self.assertIsInstance(submission_list[0], Submission)
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
# get_multiple_submission()
def test_get_multiple_submissions(self, m):
register_uris({"course": ["list_multiple_submissions"]}, m)
submissions = self.course.get_multiple_submissions()
submission_list = [submission for submission in submissions]
self.assertEqual(len(submission_list), 2)
self.assertIsInstance(submission_list[0], Submission)
def test_get_multiple_submissions_grouped_true(self, m):
register_uris({"course": ["list_multiple_submissions_grouped"]}, m)
submissions = self.course.get_multiple_submissions(grouped=True)
submission_list = [submission for submission in submissions]
self.assertEqual(len(submission_list), 2)
self.assertIsInstance(submission_list[0], GroupedSubmission)
def test_get_multiple_submissions_grouped_false(self, m):
register_uris({"course": ["list_multiple_submissions"]}, m)
submissions = self.course.get_multiple_submissions(grouped=False)
submission_list = [submission for submission in submissions]
self.assertEqual(len(submission_list), 2)
self.assertIsInstance(submission_list[0], Submission)
def test_get_multiple_submissions_grouped_invalid(self, m):
with self.assertRaises(ValueError) as cm:
self.course.get_multiple_submissions(grouped="blargh")
self.assertIn("Parameter `grouped` must", cm.exception.args[0])
# get_submission()
def test_get_submission(self, m):
register_uris(
{"course": ["get_assignment_by_id"], "submission": ["get_by_id_course"]}, m
)
assignment_for_id = 1
user_id = 1
with warnings.catch_warnings(record=True) as warning_list:
submission_by_id = self.course.get_submission(assignment_for_id, user_id)
self.assertIsInstance(submission_by_id, Submission)
self.assertTrue(hasattr(submission_by_id, "submission_type"))
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
with warnings.catch_warnings(record=True) as warning_list:
assignment_for_obj = self.course.get_assignment(1)
submission_by_obj = self.course.get_submission(
assignment_for_obj, self.user
)
self.assertIsInstance(submission_by_obj, Submission)
self.assertTrue(hasattr(submission_by_obj, "submission_type"))
self.assertEqual(len(warning_list), 1)
self.assertEqual(warning_list[-1].category, DeprecationWarning)
# update_submission()
def test_update_submission(self, m):
register_uris(
{
"course": ["get_assignment_by_id"],
"submission": ["edit", "get_by_id_course"],
},
m,
)
assignment_for_id = 1
user_id = 1
with warnings.catch_warnings(record=True) as warning_list:
submission = self.course.update_submission(