Add tests of with_metadata option #657
Conversation
|
|
||
|
|
||
| @pytest.fixture(scope="function") | ||
| def with_metadata_checker(monkeypatch): |
There was a problem hiding this comment.
This fixture monkeypatches the urllib3 pool manager to intercept outgoing requests. It's a lightweight alternative to setting up a proxy or some other more complicated software.
| """Intercept requests to arrays and groups list endpoints and checks the URLs.""" | ||
|
|
||
| def fake_and_check_request(self, method, url, *args, **kwargs): | ||
| assert "with_metadata=True" in url |
There was a problem hiding this comment.
Here's the actual test assertion, inside the fixture. If it fails, pytest does the right thing and reports an error that's quite understandable.
There was a problem hiding this comment.
@ktsitsi @spencerseale @gspowley what do you think of this approach for testing our SDK - API interface? Is it one that you'd be comfortable using and maintaining with me?
There was a problem hiding this comment.
So basically we mock the actual request and just ensure that whatever selection we're testing is passed into the request?
There was a problem hiding this comment.
@spencerseale correct. Actual integration tests are good, too, but these new tests run really fast and could help eliminate a lot of lurking generic bugs living between the high level Python API and the low level auto-generated API.
HTTP is not the best communication protocol ever, but it is sure easy to peek into. I guess that's why we're still using it :)
There was a problem hiding this comment.
I love the mocking! Great way to test and interate in the development and allow more comprehensive testing in the future without needing a full stack.
There was a problem hiding this comment.
Thanks @sgillies, I will be sure to follow this strategy.
| """Intercept requests to arrays and groups list endpoints and checks the URLs.""" | ||
|
|
||
| def fake_and_check_request(self, method, url, *args, **kwargs): | ||
| assert "with_metadata=True" in url |
There was a problem hiding this comment.
I honestly don't know which side, client or server, has the responsibility for getting the values of these boolean options right. The server accepts with_metadata=True but will it always do so?
There was a problem hiding this comment.
I usually opt for the server to be more flexible but we should also standardize it in the openapi definition
|
I have a project that could use this new feature, will happily use it if it can go into next cloud-py release |
The low-level autogenerated API changes have already been merged. Wiring up the high-level API is straight forward. I've run the functions against my own groups and arrays and see what I expect. Note well: some of our arrays have very large metadata and listing them using
with_metadata=Truewill appear to hang your computer. It's really just transferring a lot of bytes across the network.I've added some new tests. They don't check the results, but do check that we make a request to the API endpoints with the right query params.