test_multi_media_repo.py 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. # Copyright 2020-2021 The Matrix.org Foundation C.I.C.
  2. #
  3. # Licensed under the Apache License, Version 2.0 (the "License");
  4. # you may not use this file except in compliance with the License.
  5. # You may obtain a copy of the License at
  6. #
  7. # http://www.apache.org/licenses/LICENSE-2.0
  8. #
  9. # Unless required by applicable law or agreed to in writing, software
  10. # distributed under the License is distributed on an "AS IS" BASIS,
  11. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. # See the License for the specific language governing permissions and
  13. # limitations under the License.
  14. import logging
  15. import os
  16. from typing import Optional, Tuple
  17. from twisted.internet.interfaces import IOpenSSLServerConnectionCreator
  18. from twisted.internet.protocol import Factory
  19. from twisted.protocols.tls import TLSMemoryBIOFactory, TLSMemoryBIOProtocol
  20. from twisted.test.proto_helpers import MemoryReactor
  21. from twisted.web.http import HTTPChannel
  22. from twisted.web.server import Request
  23. from synapse.rest import admin
  24. from synapse.rest.client import login
  25. from synapse.server import HomeServer
  26. from synapse.util import Clock
  27. from tests.http import TestServerTLSConnectionFactory, get_test_ca_cert_file
  28. from tests.replication._base import BaseMultiWorkerStreamTestCase
  29. from tests.server import FakeChannel, FakeSite, FakeTransport, make_request
  30. from tests.test_utils import SMALL_PNG
  31. logger = logging.getLogger(__name__)
  32. test_server_connection_factory: Optional[TestServerTLSConnectionFactory] = None
  33. class MediaRepoShardTestCase(BaseMultiWorkerStreamTestCase):
  34. """Checks running multiple media repos work correctly."""
  35. servlets = [
  36. admin.register_servlets_for_client_rest_resource,
  37. login.register_servlets,
  38. ]
  39. def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
  40. self.user_id = self.register_user("user", "pass")
  41. self.access_token = self.login("user", "pass")
  42. self.reactor.lookups["example.com"] = "1.2.3.4"
  43. def default_config(self) -> dict:
  44. conf = super().default_config()
  45. conf["federation_custom_ca_list"] = [get_test_ca_cert_file()]
  46. return conf
  47. def _get_media_req(
  48. self, hs: HomeServer, target: str, media_id: str
  49. ) -> Tuple[FakeChannel, Request]:
  50. """Request some remote media from the given HS by calling the download
  51. API.
  52. This then triggers an outbound request from the HS to the target.
  53. Returns:
  54. The channel for the *client* request and the *outbound* request for
  55. the media which the caller should respond to.
  56. """
  57. resource = hs.get_media_repository_resource().children[b"download"]
  58. channel = make_request(
  59. self.reactor,
  60. FakeSite(resource, self.reactor),
  61. "GET",
  62. f"/{target}/{media_id}",
  63. shorthand=False,
  64. access_token=self.access_token,
  65. await_result=False,
  66. )
  67. self.pump()
  68. clients = self.reactor.tcpClients
  69. self.assertGreaterEqual(len(clients), 1)
  70. (host, port, client_factory, _timeout, _bindAddress) = clients.pop()
  71. # build the test server
  72. server_tls_protocol = _build_test_server(get_connection_factory())
  73. # now, tell the client protocol factory to build the client protocol (it will be a
  74. # _WrappingProtocol, around a TLSMemoryBIOProtocol, around an
  75. # HTTP11ClientProtocol) and wire the output of said protocol up to the server via
  76. # a FakeTransport.
  77. #
  78. # Normally this would be done by the TCP socket code in Twisted, but we are
  79. # stubbing that out here.
  80. client_protocol = client_factory.buildProtocol(None)
  81. client_protocol.makeConnection(
  82. FakeTransport(server_tls_protocol, self.reactor, client_protocol)
  83. )
  84. # tell the server tls protocol to send its stuff back to the client, too
  85. server_tls_protocol.makeConnection(
  86. FakeTransport(client_protocol, self.reactor, server_tls_protocol)
  87. )
  88. # fish the test server back out of the server-side TLS protocol.
  89. http_server: HTTPChannel = server_tls_protocol.wrappedProtocol # type: ignore[assignment]
  90. # give the reactor a pump to get the TLS juices flowing.
  91. self.reactor.pump((0.1,))
  92. self.assertEqual(len(http_server.requests), 1)
  93. request = http_server.requests[0]
  94. self.assertEqual(request.method, b"GET")
  95. self.assertEqual(
  96. request.path,
  97. f"/_matrix/media/r0/download/{target}/{media_id}".encode("utf-8"),
  98. )
  99. self.assertEqual(
  100. request.requestHeaders.getRawHeaders(b"host"), [target.encode("utf-8")]
  101. )
  102. return channel, request
  103. def test_basic(self) -> None:
  104. """Test basic fetching of remote media from a single worker."""
  105. hs1 = self.make_worker_hs("synapse.app.generic_worker")
  106. channel, request = self._get_media_req(hs1, "example.com:443", "ABC123")
  107. request.setResponseCode(200)
  108. request.responseHeaders.setRawHeaders(b"Content-Type", [b"text/plain"])
  109. request.write(b"Hello!")
  110. request.finish()
  111. self.pump(0.1)
  112. self.assertEqual(channel.code, 200)
  113. self.assertEqual(channel.result["body"], b"Hello!")
  114. def test_download_simple_file_race(self) -> None:
  115. """Test that fetching remote media from two different processes at the
  116. same time works.
  117. """
  118. hs1 = self.make_worker_hs("synapse.app.generic_worker")
  119. hs2 = self.make_worker_hs("synapse.app.generic_worker")
  120. start_count = self._count_remote_media()
  121. # Make two requests without responding to the outbound media requests.
  122. channel1, request1 = self._get_media_req(hs1, "example.com:443", "ABC123")
  123. channel2, request2 = self._get_media_req(hs2, "example.com:443", "ABC123")
  124. # Respond to the first outbound media request and check that the client
  125. # request is successful
  126. request1.setResponseCode(200)
  127. request1.responseHeaders.setRawHeaders(b"Content-Type", [b"text/plain"])
  128. request1.write(b"Hello!")
  129. request1.finish()
  130. self.pump(0.1)
  131. self.assertEqual(channel1.code, 200, channel1.result["body"])
  132. self.assertEqual(channel1.result["body"], b"Hello!")
  133. # Now respond to the second with the same content.
  134. request2.setResponseCode(200)
  135. request2.responseHeaders.setRawHeaders(b"Content-Type", [b"text/plain"])
  136. request2.write(b"Hello!")
  137. request2.finish()
  138. self.pump(0.1)
  139. self.assertEqual(channel2.code, 200, channel2.result["body"])
  140. self.assertEqual(channel2.result["body"], b"Hello!")
  141. # We expect only one new file to have been persisted.
  142. self.assertEqual(start_count + 1, self._count_remote_media())
  143. def test_download_image_race(self) -> None:
  144. """Test that fetching remote *images* from two different processes at
  145. the same time works.
  146. This checks that races generating thumbnails are handled correctly.
  147. """
  148. hs1 = self.make_worker_hs("synapse.app.generic_worker")
  149. hs2 = self.make_worker_hs("synapse.app.generic_worker")
  150. start_count = self._count_remote_thumbnails()
  151. channel1, request1 = self._get_media_req(hs1, "example.com:443", "PIC1")
  152. channel2, request2 = self._get_media_req(hs2, "example.com:443", "PIC1")
  153. request1.setResponseCode(200)
  154. request1.responseHeaders.setRawHeaders(b"Content-Type", [b"image/png"])
  155. request1.write(SMALL_PNG)
  156. request1.finish()
  157. self.pump(0.1)
  158. self.assertEqual(channel1.code, 200, channel1.result["body"])
  159. self.assertEqual(channel1.result["body"], SMALL_PNG)
  160. request2.setResponseCode(200)
  161. request2.responseHeaders.setRawHeaders(b"Content-Type", [b"image/png"])
  162. request2.write(SMALL_PNG)
  163. request2.finish()
  164. self.pump(0.1)
  165. self.assertEqual(channel2.code, 200, channel2.result["body"])
  166. self.assertEqual(channel2.result["body"], SMALL_PNG)
  167. # We expect only three new thumbnails to have been persisted.
  168. self.assertEqual(start_count + 3, self._count_remote_thumbnails())
  169. def _count_remote_media(self) -> int:
  170. """Count the number of files in our remote media directory."""
  171. path = os.path.join(
  172. self.hs.get_media_repository().primary_base_path, "remote_content"
  173. )
  174. return sum(len(files) for _, _, files in os.walk(path))
  175. def _count_remote_thumbnails(self) -> int:
  176. """Count the number of files in our remote thumbnails directory."""
  177. path = os.path.join(
  178. self.hs.get_media_repository().primary_base_path, "remote_thumbnail"
  179. )
  180. return sum(len(files) for _, _, files in os.walk(path))
  181. def get_connection_factory() -> TestServerTLSConnectionFactory:
  182. # this needs to happen once, but not until we are ready to run the first test
  183. global test_server_connection_factory
  184. if test_server_connection_factory is None:
  185. test_server_connection_factory = TestServerTLSConnectionFactory(
  186. sanlist=[b"DNS:example.com"]
  187. )
  188. return test_server_connection_factory
  189. def _build_test_server(
  190. connection_creator: IOpenSSLServerConnectionCreator,
  191. ) -> TLSMemoryBIOProtocol:
  192. """Construct a test server
  193. This builds an HTTP channel, wrapped with a TLSMemoryBIOProtocol
  194. Args:
  195. connection_creator: thing to build SSL connections
  196. Returns:
  197. TLSMemoryBIOProtocol
  198. """
  199. server_factory = Factory.forProtocol(HTTPChannel)
  200. # Request.finish expects the factory to have a 'log' method.
  201. server_factory.log = _log_request
  202. server_tls_factory = TLSMemoryBIOFactory(
  203. connection_creator, isClient=False, wrappedFactory=server_factory
  204. )
  205. return server_tls_factory.buildProtocol(None)
  206. def _log_request(request: Request) -> None:
  207. """Implements Factory.log, which is expected by Request.finish"""
  208. logger.info("Completed request %s", request)