autograder.testing.server

1953def _no_init_or_replace_init(self, *args, **kwargs):
1954    cls = type(self)
1955
1956    if cls._is_protocol:
1957        raise TypeError('Protocols cannot be instantiated')
1958
1959    # Already using a custom `__init__`. No need to calculate correct
1960    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
1961    if cls.__init__ is not _no_init_or_replace_init:
1962        return
1963
1964    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
1965    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
1966    # searches for a proper new `__init__` in the MRO. The new `__init__`
1967    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
1968    # instantiation of the protocol subclass will thus use the new
1969    # `__init__` and no longer call `_no_init_or_replace_init`.
1970    for base in cls.__mro__:
1971        init = base.__dict__.get('__init__', _no_init_or_replace_init)
1972        if init is not _no_init_or_replace_init:
1973            cls.__init__ = init
1974            break
1975    else:
1976        # should not happen
1977        cls.__init__ = object.__init__
1978
1979    cls.__init__(self, *args, **kwargs)

1953def _no_init_or_replace_init(self, *args, **kwargs):
1954    cls = type(self)
1955
1956    if cls._is_protocol:
1957        raise TypeError('Protocols cannot be instantiated')
1958
1959    # Already using a custom `__init__`. No need to calculate correct
1960    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
1961    if cls.__init__ is not _no_init_or_replace_init:
1962        return
1963
1964    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
1965    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
1966    # searches for a proper new `__init__` in the MRO. The new `__init__`
1967    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
1968    # instantiation of the protocol subclass will thus use the new
1969    # `__init__` and no longer call `_no_init_or_replace_init`.
1970    for base in cls.__mro__:
1971        init = base.__dict__.get('__init__', _no_init_or_replace_init)
1972        if init is not _no_init_or_replace_init:
1973            cls.__init__ = init
1974            break
1975    else:
1976        # should not happen
1977        cls.__init__ = object.__init__
1978
1979    cls.__init__(self, *args, **kwargs)

53    @classmethod
54    def child_class_setup(cls) -> None:
55        # Make the API request source information consistent.
56        autograder.api.common.set_testing_source_info()
57
58        # Don't exit on error.
59        autograder.error._exit_on_error_for_testing = False

61    @classmethod
62    def setup_server(cls, server: edq.net.exchangeserver.HTTPExchangeServer) -> None:
63        context = edq.util.serial.SerializationContext(json_options = {
64            'strict': True,
65        })
66
67        edq.testing.httpserver.HTTPServerTest.setup_server(server)
68        server.load_exchanges_dir(EXCHANGES_DIR, context = context)

 70    def base_api_test(self,
 71            api_function: typing.Callable,
 72            test_cases: typing.List[typing.Tuple[autograder.model.config.Config, typing.Dict[str, typing.Any], typing.Any, typing.Union[str, None]]],
 73            actual_clean_func: typing.Union[CleanFunction, typing.Callable, None] = None,
 74            expected_clean_func: typing.Union[CleanFunction, typing.Callable, None] = None,
 75            assertion_func: typing.Union[AssertionFunction, None] = None,
 76            ) -> None:
 77        """
 78        A common test for the base API functionality.
 79        Test cases are passed in as: `[(configs (and overrides), kwargs, expected, error substring), ...]`.
 80        """
 81
 82        for (i, test_case) in enumerate(test_cases):
 83            (config, kwargs, expected, error_substring) = test_case
 84
 85            with self.subTest(msg = f"Case {i}:"):
 86                config.server = self.get_server_url()
 87
 88                try:
 89                    actual = api_function(config, **kwargs)
 90                except Exception as ex:
 91                    error_string = self.format_error_string(ex)
 92                    if (error_substring is None):
 93                        self.fail(f"Unexpected error: '{error_string}'.")
 94
 95                    self.assertIn(error_substring, error_string, 'Error is not as expected.')
 96
 97                    continue
 98
 99                if (error_substring is not None):
100                    self.fail(f"Did not get expected error: '{error_substring}'.")
101
102                if (actual_clean_func is not None):
103                    actual = actual_clean_func(actual)
104
105                if (expected_clean_func is not None):
106                    expected = expected_clean_func(expected)
107
108                # If we expect a tuple, compare the tuple contents instead of the tuple itself.
109                if (isinstance(expected, tuple)):
110                    if (not isinstance(actual, tuple)):
111                        raise ValueError(f"Expected results to be a tuple, found '{type(actual)}'.")
112
113                    if (len(expected) != len(actual)):
114                        raise ValueError(f"Result size mismatch. Expected: {len(expected)}, Actual: {len(actual)}.")
115                else:
116                    # Wrap the results in a tuple.
117                    expected = (expected, )
118                    actual = (actual, )
119
120                for i in range(len(expected)):  # pylint: disable=consider-using-enumerate
121                    expected_value = expected[i]
122                    actual_value = actual[i]
123
124                    if (assertion_func is not None):
125                        assertion_func(expected_value, actual_value)
126                    elif (isinstance(expected_value, lms.model.base.BaseType)):
127                        self.assertJSONEqual(expected_value, actual_value)
128                    elif (isinstance(expected_value, dict)):
129                        self.assertJSONDictEqual(expected_value, actual_value)
130                    elif (isinstance(expected_value, list)):
131                        self.assertJSONListEqual(expected_value, actual_value)
132                    else:
133                        self.assertEqual(expected_value, actual_value)