Merge lp:~tartley/canonical-identity-provider/status-code-diagnostics into lp:canonical-identity-provider/release

[Jonathan Hartley]

Test fail diagnostics for bad response status code.

If a response has an unexpected status code,
display the response content
and the expected/actual status codes.

This is an annoyingly tiny MP, but I wanted to make sure this change gets in regardless what happens to my other MPs, which are all potentially more controversial.

[Daniel Manrique (roadmr)]

LGTM with two caveats/comments.

1- Would .format() syntax be clearer/nicer? (I prefer .format but don't mind old % syntax)
2- If response is big, this will cause horrid test output spew. It might be desirable, or may not. Not sure there's a good alternative :/ truncating it might risk losing the actual part in conflict.

review: Approve

[Jonathan Hartley (tartley)]

> LGTM with two caveats/comments.
>
> 1- Would .format() syntax be clearer/nicer? (I prefer .format but don't mind
> old % syntax)
> 2- If response is big, this will cause horrid test output spew. It might be
> desirable, or may not. Not sure there's a good alternative :/ truncating it
> might risk losing the actual part in conflict.

FWIW, the original code already output the response content, with potential spew. This change just adds the actual/expected response code too.

Having said that, truncating seems harmless. Worse case, for massive responses, the dev will need to do some more investigation.

[Jonathan Hartley (tartley)]

From IRC

<roadmr>: for status-code-diagnostics, I think it can land as-is, no need to truncate the spew

=== modified file 'src/api/v20/tests/test_handlers.py'
--- src/api/v20/tests/test_handlers.py	2020-01-09 16:04:03 +0000
+++ src/api/v20/tests/test_handlers.py	2020-01-09 16:04:03 +0000
@@ -95,7 +95,10 @@
         response = getattr(self.client, method.lower())(url, **kwargs)
         if status_code is not None:
             self.assertEqual(
-                response.status_code, status_code, response.content)
+                response.status_code, status_code, "%s != %s\n%s" % (
+                    response.status_code, status_code, response.content
+                )
+            )
         return response
 
     def do_request(self, method, data=None, raw_data=None, url=None,