rpc_client: Allow http method declaration consistently with the rpc server

a7d1aa7b introduced that use for the server. Without doing this consistenly in the rpc client part, this won't work though.

The common usage we have is to define an interface in a swh module and make the rpc client and server code out of that interface. So those needs to be consistent.

Related to a7d1aa7b

Related to swh/meta$830 (as the current inconsistency, without the diff)

Test Plan

tox

Test with the vault everything is fine using docker

client code:

time doco exec swh-vault-worker /bin/bash

swh@51a13de681ec:/$ python3
Python 3.7.4 (default, Jul 13 2019, 14:04:11)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from swh.core.config import load_from_envvar
>>> from swh.model.hashutil import hash_to_bytes
>>> from swh.vault import get_vault
>>> config = load_from_envvar()
>>> vault = get_vault(**config['vault'])
>>> vault.task_info(obj_type="directory", obj_id=hash_to_bytes("838bc7ca7541fd96ed6e665c1485a0f8b6d4c3f3"))
{'id': 1, 'type': 'directory', 'object_id': b'\x83\x8b\xc7\xcauA\xfd\x96\xednf\\\x14\x85\xa0\xf8\xb6\xd4\xc3\xf3', 'task_id': None, 'task_status': 'new', 'sticky': False, 'ts_created': datetime.datetime(2020, 10, 23, 10, 1, 21, 384052, tzinfo=datetime.timezone(datetime.timedelta(0), '+00:00')), 'ts_done': None, 'ts_last_access': datetime.datetime(2020, 10, 23, 10, 1, 21, 384052, tzinfo=datetime.timezone(datetime.timedelta(0), '+00:00')), 'progress_msg': None}
>>> vault.cook_request(obj_type="directory", obj_id=hash_to_bytes("838bc7ca7541fd96ed6e665c1485a0f8b6d4c3f3"))
{'id': 1, 'type': 'directory', 'object_id': b'\x83\x8b\xc7\xcauA\xfd\x96\xednf\\\x14\x85\xa0\xf8\xb6\xd4\xc3\xf3', 'task_id': None, 'task_status': 'new', 'sticky': False, 'ts_created': datetime.datetime(2020, 10, 23, 10, 1, 21, 384052, tzinfo=datetime.timezone(datetime.timedelta(0), '+00:00')), 'ts_done': None, 'ts_last_access': datetime.datetime(2020, 10, 23, 10, 1, 21, 384052, tzinfo=datetime.timezone(datetime.timedelta(0), '+00:00')), 'progress_msg': None}
...

server code:

$ doco logs -f swh-vault
...
swh-vault_1                     | INFO:aiohttp.access:192.168.176.30 [23/Oct/2020:10:04:30 +0000] "GET /fetch HTTP/1.1" 400 1132 "-" "python-requests/2.24.0"
swh-vault_1                     | [INFO] aiohttp.access -- 192.168.176.30 [23/Oct/2020:10:04:30 +0000] "GET /fetch HTTP/1.1" 400 1132 "-" "python-requests/2.24.0"
swh-vault_1                     | INFO:aiohttp.access:192.168.176.30 [23/Oct/2020:10:12:55 +0000] "GET /progress HTTP/1.1" 200 394 "-" "python-requests/2.24.0"
swh-vault_1                     | [INFO] aiohttp.access -- 192.168.176.30 [23/Oct/2020:10:12:55 +0000] "GET /progress HTTP/1.1" 200 394 "-" "python-requests/2.24.0"
swh-vault_1                     | INFO:aiohttp.access:192.168.176.30 [23/Oct/2020:10:12:55 +0000] "POST /cook HTTP/1.1" 200 394 "-" "python-requests/2.24.0"
swh-vault_1                     | [INFO] aiohttp.access -- 192.168.176.30 [23/Oct/2020:10:12:55 +0000] "POST /cook HTTP/1.1" 200 394 "-" "python-requests/2.24.0"
...

---

Migrated from D4341 (view on Phabricator)

swh/core/api/tests/test_rpc_client.py

-# Copyright (C) 2018-2019  The Software Heritage developers
+# Copyright (C) 2018-2020  The Software Heritage developers
 # See the AUTHORS file at the top-level directory of this distribution
 # License: GNU General Public License version 3, or any later version
 # See top-level LICENSE file for more information
@@ -27,6 +27,10 @@ def rpc_client(requests_mock):
         def serializer_test(self, data, db=None, cur=None):
             ...
 
+        @remote_api_endpoint("another_endpoint", method="GET")
+        def some_get_method(self, data):
+            ...
+
         @remote_api_endpoint("overridden/endpoint")
         def overridden_method(self, data):
             return "foo"
@@ -39,7 +43,7 @@ def rpc_client(requests_mock):
         def overridden_method(self, data):
             return "bar"
 
-    def callback(request, context):
+    def callback_post(request, context):
         assert request.headers["Content-Type"] == "application/x-msgpack"
         context.headers["Content-Type"] = "application/x-msgpack"
         if request.path == "/test_endpoint_url":
@@ -55,7 +59,17 @@ def rpc_client(requests_mock):
             assert False
         return context.content
 
-    requests_mock.post(re.compile("mock://example.com/"), content=callback)
+    def callback_get(request, context):
+        context.headers["Content-Type"] = "application/x-msgpack"
+
+        if request.path == "/another_endpoint":
+            context.content = b"\xc4\x0eanother-result"
+        else:
+            assert False
+        return context.content
+
+    requests_mock.post(re.compile("mock://example.com/"), content=callback_post)
+    requests_mock.get(re.compile("mock://example.com/"), content=callback_get)
 
     return Testclient(url="mock://example.com")
 
@@ -75,6 +89,9 @@ def test_client(rpc_client):
     res = rpc_client.something(data="whatever")
     assert res == "spam"
 
+    res = rpc_client.some_get_method(data="something")
+    assert res == b"another-result"
+
 
 def test_client_extra_serializers(rpc_client):
     res = rpc_client.serializer_test(["foo", ExtraType("bar", b"baz")])