|
| 1 | +"""Test suite for the LMSBackendsValue custom field.""" |
| 2 | + |
| 3 | +import json |
| 4 | + |
| 5 | +from django.test import TestCase |
| 6 | + |
| 7 | +from joanie.core.utils import LMSBackendsValue, LMSBackendValidator |
| 8 | + |
| 9 | + |
| 10 | +class TestCaseLMSBackendsValue(TestCase): |
| 11 | + """Test suite for the LMSBackendsValue custom field.""" |
| 12 | + |
| 13 | + def setUp(self): |
| 14 | + self.lms_configuration = { |
| 15 | + "API_TOKEN": "FakeEdXAPIKey", |
| 16 | + "BACKEND": "joanie.lms_handler.backends.dummy.DummyLMSBackend", |
| 17 | + "BASE_URL": "http://edx:8073", |
| 18 | + "SELECTOR_REGEX": "^.*/courses/(?P<course_id>.*)/course/?$", |
| 19 | + "COURSE_REGEX": "^.*/courses/(?P<course_id>.*)/course/?$", |
| 20 | + "COURSE_RUN_SYNC_NO_UPDATE_FIELDS": ["languages"], |
| 21 | + } |
| 22 | + |
| 23 | + def test_lms_backends_value_return_list_of_configuration(self): |
| 24 | + """If all validation pass, the return value should be a list of configuration.""" |
| 25 | + |
| 26 | + envvar = json.dumps([self.lms_configuration]) |
| 27 | + value = LMSBackendsValue().to_python(envvar) |
| 28 | + |
| 29 | + self.assertIsInstance(value, list) |
| 30 | + self.assertEqual(len(value), 1) |
| 31 | + backend = value[0] |
| 32 | + self.assertIsInstance(backend, dict) |
| 33 | + self.assertEqual(backend["API_TOKEN"], "FakeEdXAPIKey") |
| 34 | + self.assertEqual( |
| 35 | + backend["BACKEND"], "joanie.lms_handler.backends.dummy.DummyLMSBackend" |
| 36 | + ) |
| 37 | + self.assertEqual(backend["BASE_URL"], "http://edx:8073") |
| 38 | + self.assertEqual( |
| 39 | + backend["SELECTOR_REGEX"], "^.*/courses/(?P<course_id>.*)/course/?$" |
| 40 | + ) |
| 41 | + self.assertEqual( |
| 42 | + backend["COURSE_REGEX"], "^.*/courses/(?P<course_id>.*)/course/?$" |
| 43 | + ) |
| 44 | + self.assertEqual(backend["COURSE_RUN_SYNC_NO_UPDATE_FIELDS"], ["languages"]) |
| 45 | + |
| 46 | + def test_lms_backends_value_validate_required_keys(self): |
| 47 | + """It should ensure that all required keys are defined.""" |
| 48 | + |
| 49 | + for key in LMSBackendValidator.BACKEND_REQUIRED_KEYS: |
| 50 | + with self.subTest("Missing key", key=key): |
| 51 | + values = self.lms_configuration.copy() |
| 52 | + values.pop(key) |
| 53 | + envvar = json.dumps([values]) |
| 54 | + |
| 55 | + with self.assertRaises(ValueError): |
| 56 | + LMSBackendsValue().to_python(envvar) |
| 57 | + |
| 58 | + def test_lms_backends_value_validate_regex_properties(self): |
| 59 | + """It should ensure that the regex properties are valid.""" |
| 60 | + |
| 61 | + invalid_regex = r"ˆ][$" |
| 62 | + |
| 63 | + # Both selector and course regex should be validated |
| 64 | + for key in ["SELECTOR_REGEX", "COURSE_REGEX"]: |
| 65 | + with self.subTest("Invalid regex", key=key): |
| 66 | + values = self.lms_configuration.copy() |
| 67 | + values[key] = invalid_regex |
| 68 | + envvar = json.dumps([values]) |
| 69 | + |
| 70 | + with self.assertRaises(ValueError) as exception: |
| 71 | + LMSBackendsValue().to_python(envvar) |
| 72 | + |
| 73 | + self.assertEqual( |
| 74 | + str(exception.exception), "Invalid regex ˆ][$ in LMS Backend." |
| 75 | + ) |
| 76 | + |
| 77 | + def test_lms_backends_value_validate_backend_path(self): |
| 78 | + """It should ensure that the backend path string is valid.""" |
| 79 | + values = self.lms_configuration.copy() |
| 80 | + values["BACKEND"] = "invalid.path..to.backend" |
| 81 | + envvar = json.dumps([values]) |
| 82 | + |
| 83 | + with self.assertRaises(ValueError) as exception: |
| 84 | + LMSBackendsValue().to_python(envvar) |
| 85 | + |
| 86 | + self.assertEqual( |
| 87 | + str(exception.exception), |
| 88 | + "invalid.path..to.backend must be a valid python module path string.", |
| 89 | + ) |
| 90 | + |
| 91 | + def test_lms_backends_value_validate_no_update_fields_value(self): |
| 92 | + """ |
| 93 | + It should ensure that the COURSE_RUN_SYNC_NO_UPDATE_FIELDS value is a list |
| 94 | + if defined |
| 95 | + """ |
| 96 | + values = self.lms_configuration.copy() |
| 97 | + values.pop("COURSE_RUN_SYNC_NO_UPDATE_FIELDS") |
| 98 | + envvar = json.dumps([values]) |
| 99 | + |
| 100 | + # No error should be raised if the value is not defined |
| 101 | + LMSBackendsValue().to_python(envvar) |
| 102 | + |
| 103 | + values.update({"COURSE_RUN_SYNC_NO_UPDATE_FIELDS": "invalid"}) |
| 104 | + envvar = json.dumps([values]) |
| 105 | + |
| 106 | + with self.assertRaises(ValueError) as exception: |
| 107 | + LMSBackendsValue().to_python(envvar) |
| 108 | + |
| 109 | + self.assertEqual( |
| 110 | + str(exception.exception), "COURSE_RUN_SYNC_NO_UPDATE_FIELDS must be a list." |
| 111 | + ) |
0 commit comments