timabbott
commented
2 years ago @PIG208 this is awesome! I see that we're failing CI with the 18.04/3.2 test case.
The problem is kinda subtle: the API documentation that comes with 3.2 expects an old version of the python-zulip-api library's interface. I guess the bug is that we made a client-side API change that is not backwards-compatible, which was an intentional interface change, but does mean the 3.2 documentation isn't correct anymore.
If there was a magical way to do this, I guess what we want to promise to users and thus want to test is that the modern master API documentation, when run against the module python-zulip-api and an old server version will work correctly. I doubt it's particularly feasible to do that, since the test-api suite requires a bunch of code from the current server version for test database setup (etc.).
I think the next best thing we can do is try to hack around it -- e.g. figuring out a way to have a bit of configuration that lives in python-zulip-api that provides some way to do a compatibility hook for the tests. E.g. we have some mechanism through which if a certain environment variable is set, we rename a LegacyInterfaceClient class to Client, and that class overrides a few methods with thin wrappers to translate the interface for interface migrations. E.g. for the update_members_by_id function, it'd be something like this:
class LegacyInterfaceClient(Client)
def update_user_group_members(self, group_data: Dict[str, Any]) -> Dict[str, Any]:
modern_group_data = group_data.copy()
group_id = group_data['group_id']
del modern_group_data['group_id']
return super().update_user_group_members(group_id, modern_group_data)
if USE_LEGACY_INTERFACE:
Client = LegacyInterfaceClient # type: ignore
PIG208
WIP. Testing the test setup on Github.