Python code coverage for Lib/packaging/tests/pypi_server.py

#	count	content
1	n/a	"""Mock PyPI Server implementation, to use in tests.
2	n/a
3	n/a	This module also provides a simple test case to extend if you need to use
4	n/a	the PyPIServer all along your test case. Be sure to read the documentation
5	n/a	before any use.
6	n/a
7	n/a	XXX TODO:
8	n/a
9	n/a	The mock server can handle simple HTTP request (to simulate a simple index) or
10	n/a	XMLRPC requests, over HTTP. Both does not have the same intergface to deal
11	n/a	with, and I think it's a pain.
12	n/a
13	n/a	A good idea could be to re-think a bit the way dstributions are handled in the
14	n/a	mock server. As it should return malformed HTML pages, we need to keep the
15	n/a	static behavior.
16	n/a
17	n/a	I think of something like that:
18	n/a
19	n/a	>>> server = PyPIMockServer()
20	n/a	>>> server.startHTTP()
21	n/a	>>> server.startXMLRPC()
22	n/a
23	n/a	Then, the server must have only one port to rely on, eg.
24	n/a
25	n/a	>>> server.fulladdress()
26	n/a	"http://ip:port/"
27	n/a
28	n/a	It could be simple to have one HTTP server, relaying the requests to the two
29	n/a	implementations (static HTTP and XMLRPC over HTTP).
30	n/a	"""
31	n/a
32	n/a	import os
33	n/a	import queue
34	n/a	import select
35	n/a	import threading
36	n/a	from functools import wraps
37	n/a	from http.server import HTTPServer, SimpleHTTPRequestHandler
38	n/a	from xmlrpc.server import SimpleXMLRPCServer
39	n/a
40	n/a	from packaging.tests import unittest
41	n/a
42	n/a
43	n/a	PYPI_DEFAULT_STATIC_PATH = os.path.join(
44	n/a	os.path.dirname(os.path.abspath(__file__)), 'pypiserver')
45	n/a
46	n/a
47	n/a	def use_xmlrpc_server(server_args, *server_kwargs):
48	n/a	server_kwargs['serve_xmlrpc'] = True
49	n/a	return use_pypi_server(server_args, *server_kwargs)
50	n/a
51	n/a
52	n/a	def use_http_server(server_args, *server_kwargs):
53	n/a	server_kwargs['serve_xmlrpc'] = False
54	n/a	return use_pypi_server(server_args, *server_kwargs)
55	n/a
56	n/a
57	n/a	def use_pypi_server(server_args, *server_kwargs):
58	n/a	"""Decorator to make use of the PyPIServer for test methods,
59	n/a	just when needed, and not for the entire duration of the testcase.
60	n/a	"""
61	n/a	def wrapper(func):
62	n/a	@wraps(func)
63	n/a	def wrapped(args, *kwargs):
64	n/a	server = PyPIServer(server_args, *server_kwargs)
65	n/a	server.start()
66	n/a	try:
67	n/a	func(server=server, args, *kwargs)
68	n/a	finally:
69	n/a	server.stop()
70	n/a	return wrapped
71	n/a	return wrapper
72	n/a
73	n/a
74	n/a	class PyPIServerTestCase(unittest.TestCase):
75	n/a
76	n/a	def setUp(self):
77	n/a	super(PyPIServerTestCase, self).setUp()
78	n/a	self.pypi = PyPIServer()
79	n/a	self.pypi.start()
80	n/a	self.addCleanup(self.pypi.stop)
81	n/a
82	n/a
83	n/a	class PyPIServer(threading.Thread):
84	n/a	"""PyPI Mocked server.
85	n/a	Provides a mocked version of the PyPI API's, to ease tests.
86	n/a
87	n/a	Support serving static content and serving previously given text.
88	n/a	"""
89	n/a
90	n/a	def __init__(self, test_static_path=None,
91	n/a	static_filesystem_paths=None,
92	n/a	static_uri_paths=["simple", "packages"], serve_xmlrpc=False):
93	n/a	"""Initialize the server.
94	n/a
95	n/a	Default behavior is to start the HTTP server. You can either start the
96	n/a	xmlrpc server by setting xmlrpc to True. Caution: Only one server will
97	n/a	be started.
98	n/a
99	n/a	static_uri_paths and static_base_path are parameters used to provides
100	n/a	respectively the http_paths to serve statically, and where to find the
101	n/a	matching files on the filesystem.
102	n/a	"""
103	n/a	# we want to launch the server in a new dedicated thread, to not freeze
104	n/a	# tests.
105	n/a	super(PyPIServer, self).__init__()
106	n/a	self._run = True
107	n/a	self._serve_xmlrpc = serve_xmlrpc
108	n/a	if static_filesystem_paths is None:
109	n/a	static_filesystem_paths = ["default"]
110	n/a
111	n/a	#TODO allow to serve XMLRPC and HTTP static files at the same time.
112	n/a	if not self._serve_xmlrpc:
113	n/a	self.server = HTTPServer(('127.0.0.1', 0), PyPIRequestHandler)
114	n/a	self.server.RequestHandlerClass.pypi_server = self
115	n/a
116	n/a	self.request_queue = queue.Queue()
117	n/a	self._requests = []
118	n/a	self.default_response_status = 404
119	n/a	self.default_response_headers = [('Content-type', 'text/plain')]
120	n/a	self.default_response_data = "The page does not exists"
121	n/a
122	n/a	# initialize static paths / filesystems
123	n/a	self.static_uri_paths = static_uri_paths
124	n/a
125	n/a	# append the static paths defined locally
126	n/a	if test_static_path is not None:
127	n/a	static_filesystem_paths.append(test_static_path)
128	n/a	self.static_filesystem_paths = [
129	n/a	PYPI_DEFAULT_STATIC_PATH + "/" + path
130	n/a	for path in static_filesystem_paths]
131	n/a	else:
132	n/a	# XMLRPC server
133	n/a	self.server = PyPIXMLRPCServer(('127.0.0.1', 0))
134	n/a	self.xmlrpc = XMLRPCMockIndex()
135	n/a	# register the xmlrpc methods
136	n/a	self.server.register_introspection_functions()
137	n/a	self.server.register_instance(self.xmlrpc)
138	n/a
139	n/a	self.address = ('127.0.0.1', self.server.server_port)
140	n/a	# to not have unwanted outputs.
141	n/a	self.server.RequestHandlerClass.log_request = lambda *_: None
142	n/a
143	n/a	def run(self):
144	n/a	# loop because we can't stop it otherwise, for python < 2.6
145	n/a	while self._run:
146	n/a	r, w, e = select.select([self.server], [], [], 0.5)
147	n/a	if r:
148	n/a	self.server.handle_request()
149	n/a
150	n/a	def stop(self):
151	n/a	"""self shutdown is not supported for python < 2.6"""
152	n/a	self._run = False
153	n/a	if self.is_alive():
154	n/a	self.join()
155	n/a	self.server.server_close()
156	n/a
157	n/a	def get_next_response(self):
158	n/a	return (self.default_response_status,
159	n/a	self.default_response_headers,
160	n/a	self.default_response_data)
161	n/a
162	n/a	@property
163	n/a	def requests(self):
164	n/a	"""Use this property to get all requests that have been made
165	n/a	to the server
166	n/a	"""
167	n/a	while True:
168	n/a	try:
169	n/a	self._requests.append(self.request_queue.get_nowait())
170	n/a	except queue.Empty:
171	n/a	break
172	n/a	return self._requests
173	n/a
174	n/a	@property
175	n/a	def full_address(self):
176	n/a	return "http://%s:%s" % self.address
177	n/a
178	n/a
179	n/a	class PyPIRequestHandler(SimpleHTTPRequestHandler):
180	n/a	# we need to access the pypi server while serving the content
181	n/a	pypi_server = None
182	n/a
183	n/a	def serve_request(self):
184	n/a	"""Serve the content.
185	n/a
186	n/a	Also record the requests to be accessed later. If trying to access an
187	n/a	url matching a static uri, serve static content, otherwise serve
188	n/a	what is provided by the `get_next_response` method.
189	n/a
190	n/a	If nothing is defined there, return a 404 header.
191	n/a	"""
192	n/a	# record the request. Read the input only on PUT or POST requests
193	n/a	if self.command in ("PUT", "POST"):
194	n/a	if 'content-length' in self.headers:
195	n/a	request_data = self.rfile.read(
196	n/a	int(self.headers['content-length']))
197	n/a	else:
198	n/a	request_data = self.rfile.read()
199	n/a
200	n/a	elif self.command in ("GET", "DELETE"):
201	n/a	request_data = ''
202	n/a
203	n/a	self.pypi_server.request_queue.put((self, request_data))
204	n/a
205	n/a	# serve the content from local disc if we request an URL beginning
206	n/a	# by a pattern defined in `static_paths`
207	n/a	url_parts = self.path.split("/")
208	n/a	if (len(url_parts) > 1 and
209	n/a	url_parts[1] in self.pypi_server.static_uri_paths):
210	n/a	data = None
211	n/a	# always take the last first.
212	n/a	fs_paths = []
213	n/a	fs_paths.extend(self.pypi_server.static_filesystem_paths)
214	n/a	fs_paths.reverse()
215	n/a	relative_path = self.path
216	n/a	for fs_path in fs_paths:
217	n/a	try:
218	n/a	if self.path.endswith("/"):
219	n/a	relative_path += "index.html"
220	n/a
221	n/a	if relative_path.endswith('.tar.gz'):
222	n/a	with open(fs_path + relative_path, 'rb') as file:
223	n/a	data = file.read()
224	n/a	headers = [('Content-type', 'application/x-gtar')]
225	n/a	else:
226	n/a	with open(fs_path + relative_path) as file:
227	n/a	data = file.read().encode()
228	n/a	headers = [('Content-type', 'text/html')]
229	n/a
230	n/a	headers.append(('Content-Length', len(data)))
231	n/a	self.make_response(data, headers=headers)
232	n/a
233	n/a	except IOError:
234	n/a	pass
235	n/a
236	n/a	if data is None:
237	n/a	self.make_response("Not found", 404)
238	n/a
239	n/a	# otherwise serve the content from get_next_response
240	n/a	else:
241	n/a	# send back a response
242	n/a	status, headers, data = self.pypi_server.get_next_response()
243	n/a	self.make_response(data, status, headers)
244	n/a
245	n/a	do_POST = do_GET = do_DELETE = do_PUT = serve_request
246	n/a
247	n/a	def make_response(self, data, status=200,
248	n/a	headers=[('Content-type', 'text/html')]):
249	n/a	"""Send the response to the HTTP client"""
250	n/a	if not isinstance(status, int):
251	n/a	try:
252	n/a	status = int(status)
253	n/a	except ValueError:
254	n/a	# we probably got something like YYY Codename.
255	n/a	# Just get the first 3 digits
256	n/a	status = int(status[:3])
257	n/a
258	n/a	self.send_response(status)
259	n/a	for header, value in headers:
260	n/a	self.send_header(header, value)
261	n/a	self.end_headers()
262	n/a
263	n/a	if isinstance(data, str):
264	n/a	data = data.encode('utf-8')
265	n/a
266	n/a	self.wfile.write(data)
267	n/a
268	n/a
269	n/a	class PyPIXMLRPCServer(SimpleXMLRPCServer):
270	n/a	def server_bind(self):
271	n/a	"""Override server_bind to store the server name."""
272	n/a	super(PyPIXMLRPCServer, self).server_bind()
273	n/a	host, port = self.socket.getsockname()[:2]
274	n/a	self.server_port = port
275	n/a
276	n/a
277	n/a	class MockDist:
278	n/a	"""Fake distribution, used in the Mock PyPI Server"""
279	n/a
280	n/a	def __init__(self, name, version="1.0", hidden=False, url="http://url/",
281	n/a	type="sdist", filename="", size=10000,
282	n/a	digest="123456", downloads=7, has_sig=False,
283	n/a	python_version="source", comment="comment",
284	n/a	author="John Doe", author_email="john@doe.name",
285	n/a	maintainer="Main Tayner", maintainer_email="maintainer_mail",
286	n/a	project_url="http://project_url/", homepage="http://homepage/",
287	n/a	keywords="", platform="UNKNOWN", classifiers=[], licence="",
288	n/a	description="Description", summary="Summary", stable_version="",
289	n/a	ordering="", documentation_id="", code_kwalitee_id="",
290	n/a	installability_id="", obsoletes=[], obsoletes_dist=[],
291	n/a	provides=[], provides_dist=[], requires=[], requires_dist=[],
292	n/a	requires_external=[], requires_python=""):
293	n/a
294	n/a	# basic fields
295	n/a	self.name = name
296	n/a	self.version = version
297	n/a	self.hidden = hidden
298	n/a
299	n/a	# URL infos
300	n/a	self.url = url
301	n/a	self.digest = digest
302	n/a	self.downloads = downloads
303	n/a	self.has_sig = has_sig
304	n/a	self.python_version = python_version
305	n/a	self.comment = comment
306	n/a	self.type = type
307	n/a
308	n/a	# metadata
309	n/a	self.author = author
310	n/a	self.author_email = author_email
311	n/a	self.maintainer = maintainer
312	n/a	self.maintainer_email = maintainer_email
313	n/a	self.project_url = project_url
314	n/a	self.homepage = homepage
315	n/a	self.keywords = keywords
316	n/a	self.platform = platform
317	n/a	self.classifiers = classifiers
318	n/a	self.licence = licence
319	n/a	self.description = description
320	n/a	self.summary = summary
321	n/a	self.stable_version = stable_version
322	n/a	self.ordering = ordering
323	n/a	self.cheesecake_documentation_id = documentation_id
324	n/a	self.cheesecake_code_kwalitee_id = code_kwalitee_id
325	n/a	self.cheesecake_installability_id = installability_id
326	n/a
327	n/a	self.obsoletes = obsoletes
328	n/a	self.obsoletes_dist = obsoletes_dist
329	n/a	self.provides = provides
330	n/a	self.provides_dist = provides_dist
331	n/a	self.requires = requires
332	n/a	self.requires_dist = requires_dist
333	n/a	self.requires_external = requires_external
334	n/a	self.requires_python = requires_python
335	n/a
336	n/a	def url_infos(self):
337	n/a	return {
338	n/a	'url': self.url,
339	n/a	'packagetype': self.type,
340	n/a	'filename': 'filename.tar.gz',
341	n/a	'size': '6000',
342	n/a	'md5_digest': self.digest,
343	n/a	'downloads': self.downloads,
344	n/a	'has_sig': self.has_sig,
345	n/a	'python_version': self.python_version,
346	n/a	'comment_text': self.comment,
347	n/a	}
348	n/a
349	n/a	def metadata(self):
350	n/a	return {
351	n/a	'maintainer': self.maintainer,
352	n/a	'project_url': [self.project_url],
353	n/a	'maintainer_email': self.maintainer_email,
354	n/a	'cheesecake_code_kwalitee_id': self.cheesecake_code_kwalitee_id,
355	n/a	'keywords': self.keywords,
356	n/a	'obsoletes_dist': self.obsoletes_dist,
357	n/a	'requires_external': self.requires_external,
358	n/a	'author': self.author,
359	n/a	'author_email': self.author_email,
360	n/a	'download_url': self.url,
361	n/a	'platform': self.platform,
362	n/a	'version': self.version,
363	n/a	'obsoletes': self.obsoletes,
364	n/a	'provides': self.provides,
365	n/a	'cheesecake_documentation_id': self.cheesecake_documentation_id,
366	n/a	'_pypi_hidden': self.hidden,
367	n/a	'description': self.description,
368	n/a	'_pypi_ordering': 19,
369	n/a	'requires_dist': self.requires_dist,
370	n/a	'requires_python': self.requires_python,
371	n/a	'classifiers': [],
372	n/a	'name': self.name,
373	n/a	'licence': self.licence, # XXX licence or license?
374	n/a	'summary': self.summary,
375	n/a	'home_page': self.homepage,
376	n/a	'stable_version': self.stable_version,
377	n/a	# FIXME doesn't that reproduce the bug from 6527d3106e9f?
378	n/a	'provides_dist': (self.provides_dist or
379	n/a	"%s (%s)" % (self.name, self.version)),
380	n/a	'requires': self.requires,
381	n/a	'cheesecake_installability_id': self.cheesecake_installability_id,
382	n/a	}
383	n/a
384	n/a	def search_result(self):
385	n/a	return {
386	n/a	'_pypi_ordering': 0,
387	n/a	'version': self.version,
388	n/a	'name': self.name,
389	n/a	'summary': self.summary,
390	n/a	}
391	n/a
392	n/a
393	n/a	class XMLRPCMockIndex:
394	n/a	"""Mock XMLRPC server"""
395	n/a
396	n/a	def __init__(self, dists=[]):
397	n/a	self._dists = dists
398	n/a	self._search_result = []
399	n/a
400	n/a	def add_distributions(self, dists):
401	n/a	for dist in dists:
402	n/a	self._dists.append(MockDist(**dist))
403	n/a
404	n/a	def set_distributions(self, dists):
405	n/a	self._dists = []
406	n/a	self.add_distributions(dists)
407	n/a
408	n/a	def set_search_result(self, result):
409	n/a	"""set a predefined search result"""
410	n/a	self._search_result = result
411	n/a
412	n/a	def _get_search_results(self):
413	n/a	results = []
414	n/a	for name in self._search_result:
415	n/a	found_dist = [d for d in self._dists if d.name == name]
416	n/a	if found_dist:
417	n/a	results.append(found_dist[0])
418	n/a	else:
419	n/a	dist = MockDist(name)
420	n/a	results.append(dist)
421	n/a	self._dists.append(dist)
422	n/a	return [r.search_result() for r in results]
423	n/a
424	n/a	def list_packages(self):
425	n/a	return [d.name for d in self._dists]
426	n/a
427	n/a	def package_releases(self, package_name, show_hidden=False):
428	n/a	if show_hidden:
429	n/a	# return all
430	n/a	return [d.version for d in self._dists if d.name == package_name]
431	n/a	else:
432	n/a	# return only un-hidden
433	n/a	return [d.version for d in self._dists if d.name == package_name
434	n/a	and not d.hidden]
435	n/a
436	n/a	def release_urls(self, package_name, version):
437	n/a	return [d.url_infos() for d in self._dists
438	n/a	if d.name == package_name and d.version == version]
439	n/a
440	n/a	def release_data(self, package_name, version):
441	n/a	release = [d for d in self._dists
442	n/a	if d.name == package_name and d.version == version]
443	n/a	if release:
444	n/a	return release[0].metadata()
445	n/a	else:
446	n/a	return {}
447	n/a
448	n/a	def search(self, spec, operator="and"):
449	n/a	return self._get_search_results()