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

#	count	content
1	n/a	"""Tests for packaging.command.upload_docs."""
2	n/a	import os
3	n/a	import shutil
4	n/a	import logging
5	n/a	import zipfile
6	n/a	try:
7	n/a	import _ssl
8	n/a	except ImportError:
9	n/a	_ssl = None
10	n/a
11	n/a	from packaging.command import upload_docs as upload_docs_mod
12	n/a	from packaging.command.upload_docs import upload_docs, zip_dir
13	n/a	from packaging.dist import Distribution
14	n/a	from packaging.errors import PackagingFileError, PackagingOptionError
15	n/a
16	n/a	from packaging.tests import unittest, support
17	n/a	try:
18	n/a	import threading
19	n/a	from packaging.tests.pypi_server import PyPIServerTestCase
20	n/a	except ImportError:
21	n/a	threading = None
22	n/a	PyPIServerTestCase = unittest.TestCase
23	n/a
24	n/a
25	n/a	PYPIRC = """\
26	n/a	[distutils]
27	n/a	index-servers = server1
28	n/a
29	n/a	[server1]
30	n/a	repository = %s
31	n/a	username = real_slim_shady
32	n/a	password = long_island
33	n/a	"""
34	n/a
35	n/a
36	n/a	@unittest.skipIf(threading is None, "Needs threading")
37	n/a	class UploadDocsTestCase(support.TempdirManager,
38	n/a	support.EnvironRestorer,
39	n/a	support.LoggingCatcher,
40	n/a	PyPIServerTestCase):
41	n/a
42	n/a	restore_environ = ['HOME']
43	n/a
44	n/a	def setUp(self):
45	n/a	super(UploadDocsTestCase, self).setUp()
46	n/a	self.tmp_dir = self.mkdtemp()
47	n/a	self.rc = os.path.join(self.tmp_dir, '.pypirc')
48	n/a	os.environ['HOME'] = self.tmp_dir
49	n/a	self.dist = Distribution()
50	n/a	self.dist.metadata['Name'] = "distr-name"
51	n/a	self.cmd = upload_docs(self.dist)
52	n/a
53	n/a	def test_default_uploaddir(self):
54	n/a	sandbox = self.mkdtemp()
55	n/a	os.chdir(sandbox)
56	n/a	os.mkdir("build")
57	n/a	self.prepare_sample_dir("build")
58	n/a	self.cmd.ensure_finalized()
59	n/a	self.assertEqual(self.cmd.upload_dir, os.path.join("build", "docs"))
60	n/a
61	n/a	def test_default_uploaddir_looks_for_doc_also(self):
62	n/a	sandbox = self.mkdtemp()
63	n/a	os.chdir(sandbox)
64	n/a	os.mkdir("build")
65	n/a	self.prepare_sample_dir("build")
66	n/a	os.rename(os.path.join("build", "docs"), os.path.join("build", "doc"))
67	n/a	self.cmd.ensure_finalized()
68	n/a	self.assertEqual(self.cmd.upload_dir, os.path.join("build", "doc"))
69	n/a
70	n/a	def prepare_sample_dir(self, sample_dir=None):
71	n/a	if sample_dir is None:
72	n/a	sample_dir = self.mkdtemp()
73	n/a	os.mkdir(os.path.join(sample_dir, "docs"))
74	n/a	self.write_file((sample_dir, "docs", "index.html"), "Ce mortel ennui")
75	n/a	self.write_file((sample_dir, "index.html"), "Oh la la")
76	n/a	return sample_dir
77	n/a
78	n/a	def test_zip_dir(self):
79	n/a	source_dir = self.prepare_sample_dir()
80	n/a	compressed = zip_dir(source_dir)
81	n/a
82	n/a	zip_f = zipfile.ZipFile(compressed)
83	n/a	self.assertEqual(zip_f.namelist(), ['index.html', 'docs/index.html'])
84	n/a
85	n/a	def prepare_command(self):
86	n/a	self.cmd.upload_dir = self.prepare_sample_dir()
87	n/a	self.cmd.ensure_finalized()
88	n/a	self.cmd.repository = self.pypi.full_address
89	n/a	self.cmd.username = "username"
90	n/a	self.cmd.password = "password"
91	n/a
92	n/a	def test_upload(self):
93	n/a	self.prepare_command()
94	n/a	self.cmd.run()
95	n/a
96	n/a	self.assertEqual(len(self.pypi.requests), 1)
97	n/a	handler, request_data = self.pypi.requests[-1]
98	n/a	self.assertIn(b"content", request_data)
99	n/a	self.assertIn("Basic", handler.headers['authorization'])
100	n/a	self.assertTrue(handler.headers['content-type']
101	n/a	.startswith('multipart/form-data;'))
102	n/a
103	n/a	action, name, version, content = request_data.split(
104	n/a	b'----------------GHSKFJDLGDS7543FJKLFHRE75642756743254')[1:5]
105	n/a
106	n/a	# check that we picked the right chunks
107	n/a	self.assertIn(b'name=":action"', action)
108	n/a	self.assertIn(b'name="name"', name)
109	n/a	self.assertIn(b'name="version"', version)
110	n/a	self.assertIn(b'name="content"', content)
111	n/a
112	n/a	# check their contents
113	n/a	self.assertIn(b'doc_upload', action)
114	n/a	self.assertIn(b'distr-name', name)
115	n/a	self.assertIn(b'docs/index.html', content)
116	n/a	self.assertIn(b'Ce mortel ennui', content)
117	n/a
118	n/a	@unittest.skipIf(_ssl is None, 'Needs SSL support')
119	n/a	def test_https_connection(self):
120	n/a	self.https_called = False
121	n/a	self.addCleanup(
122	n/a	setattr, upload_docs_mod.http.client, 'HTTPSConnection',
123	n/a	upload_docs_mod.http.client.HTTPSConnection)
124	n/a
125	n/a	def https_conn_wrapper(*args):
126	n/a	self.https_called = True
127	n/a	# the testing server is http
128	n/a	return upload_docs_mod.http.client.HTTPConnection(*args)
129	n/a
130	n/a	upload_docs_mod.http.client.HTTPSConnection = https_conn_wrapper
131	n/a
132	n/a	self.prepare_command()
133	n/a	self.cmd.run()
134	n/a	self.assertFalse(self.https_called)
135	n/a
136	n/a	self.cmd.repository = self.cmd.repository.replace("http", "https")
137	n/a	self.cmd.run()
138	n/a	self.assertTrue(self.https_called)
139	n/a
140	n/a	def test_handling_response(self):
141	n/a	self.pypi.default_response_status = '403 Forbidden'
142	n/a	self.prepare_command()
143	n/a	self.cmd.run()
144	n/a	errors = self.get_logs(logging.ERROR)
145	n/a	self.assertEqual(len(errors), 1)
146	n/a	self.assertIn('Upload failed (403): Forbidden', errors[0])
147	n/a
148	n/a	self.pypi.default_response_status = '301 Moved Permanently'
149	n/a	self.pypi.default_response_headers.append(
150	n/a	("Location", "brand_new_location"))
151	n/a	self.cmd.run()
152	n/a	lastlog = self.get_logs(logging.INFO)[-1]
153	n/a	self.assertIn('brand_new_location', lastlog)
154	n/a
155	n/a	def test_reads_pypirc_data(self):
156	n/a	self.write_file(self.rc, PYPIRC % self.pypi.full_address)
157	n/a	self.cmd.repository = self.pypi.full_address
158	n/a	self.cmd.upload_dir = self.prepare_sample_dir()
159	n/a	self.cmd.ensure_finalized()
160	n/a	self.assertEqual(self.cmd.username, "real_slim_shady")
161	n/a	self.assertEqual(self.cmd.password, "long_island")
162	n/a
163	n/a	def test_checks_index_html_presence(self):
164	n/a	self.cmd.upload_dir = self.prepare_sample_dir()
165	n/a	os.remove(os.path.join(self.cmd.upload_dir, "index.html"))
166	n/a	self.assertRaises(PackagingFileError, self.cmd.ensure_finalized)
167	n/a
168	n/a	def test_checks_upload_dir(self):
169	n/a	self.cmd.upload_dir = self.prepare_sample_dir()
170	n/a	shutil.rmtree(os.path.join(self.cmd.upload_dir))
171	n/a	self.assertRaises(PackagingOptionError, self.cmd.ensure_finalized)
172	n/a
173	n/a	def test_show_response(self):
174	n/a	self.prepare_command()
175	n/a	self.cmd.show_response = True
176	n/a	self.cmd.run()
177	n/a	record = self.get_logs(logging.INFO)[-1]
178	n/a	self.assertTrue(record, "should report the response")
179	n/a	self.assertIn(self.pypi.default_response_data, record)
180	n/a
181	n/a
182	n/a	def test_suite():
183	n/a	return unittest.makeSuite(UploadDocsTestCase)
184	n/a
185	n/a	if __name__ == "__main__":
186	n/a	unittest.main(defaultTest="test_suite")