1 | n/a | """Tests for distutils.command.register.""" |
---|
2 | n/a | import os |
---|
3 | n/a | import unittest |
---|
4 | n/a | import getpass |
---|
5 | n/a | import urllib |
---|
6 | n/a | import warnings |
---|
7 | n/a | |
---|
8 | n/a | from test.support import check_warnings, run_unittest |
---|
9 | n/a | |
---|
10 | n/a | from distutils.command import register as register_module |
---|
11 | n/a | from distutils.command.register import register |
---|
12 | n/a | from distutils.errors import DistutilsSetupError |
---|
13 | n/a | from distutils.log import INFO |
---|
14 | n/a | |
---|
15 | n/a | from distutils.tests.test_config import BasePyPIRCCommandTestCase |
---|
16 | n/a | |
---|
17 | n/a | try: |
---|
18 | n/a | import docutils |
---|
19 | n/a | except ImportError: |
---|
20 | n/a | docutils = None |
---|
21 | n/a | |
---|
22 | n/a | PYPIRC_NOPASSWORD = """\ |
---|
23 | n/a | [distutils] |
---|
24 | n/a | |
---|
25 | n/a | index-servers = |
---|
26 | n/a | server1 |
---|
27 | n/a | |
---|
28 | n/a | [server1] |
---|
29 | n/a | username:me |
---|
30 | n/a | """ |
---|
31 | n/a | |
---|
32 | n/a | WANTED_PYPIRC = """\ |
---|
33 | n/a | [distutils] |
---|
34 | n/a | index-servers = |
---|
35 | n/a | pypi |
---|
36 | n/a | |
---|
37 | n/a | [pypi] |
---|
38 | n/a | username:tarek |
---|
39 | n/a | password:password |
---|
40 | n/a | """ |
---|
41 | n/a | |
---|
42 | n/a | class Inputs(object): |
---|
43 | n/a | """Fakes user inputs.""" |
---|
44 | n/a | def __init__(self, *answers): |
---|
45 | n/a | self.answers = answers |
---|
46 | n/a | self.index = 0 |
---|
47 | n/a | |
---|
48 | n/a | def __call__(self, prompt=''): |
---|
49 | n/a | try: |
---|
50 | n/a | return self.answers[self.index] |
---|
51 | n/a | finally: |
---|
52 | n/a | self.index += 1 |
---|
53 | n/a | |
---|
54 | n/a | class FakeOpener(object): |
---|
55 | n/a | """Fakes a PyPI server""" |
---|
56 | n/a | def __init__(self): |
---|
57 | n/a | self.reqs = [] |
---|
58 | n/a | |
---|
59 | n/a | def __call__(self, *args): |
---|
60 | n/a | return self |
---|
61 | n/a | |
---|
62 | n/a | def open(self, req, data=None, timeout=None): |
---|
63 | n/a | self.reqs.append(req) |
---|
64 | n/a | return self |
---|
65 | n/a | |
---|
66 | n/a | def read(self): |
---|
67 | n/a | return b'xxx' |
---|
68 | n/a | |
---|
69 | n/a | def getheader(self, name, default=None): |
---|
70 | n/a | return { |
---|
71 | n/a | 'content-type': 'text/plain; charset=utf-8', |
---|
72 | n/a | }.get(name.lower(), default) |
---|
73 | n/a | |
---|
74 | n/a | |
---|
75 | n/a | class RegisterTestCase(BasePyPIRCCommandTestCase): |
---|
76 | n/a | |
---|
77 | n/a | def setUp(self): |
---|
78 | n/a | super(RegisterTestCase, self).setUp() |
---|
79 | n/a | # patching the password prompt |
---|
80 | n/a | self._old_getpass = getpass.getpass |
---|
81 | n/a | def _getpass(prompt): |
---|
82 | n/a | return 'password' |
---|
83 | n/a | getpass.getpass = _getpass |
---|
84 | n/a | urllib.request._opener = None |
---|
85 | n/a | self.old_opener = urllib.request.build_opener |
---|
86 | n/a | self.conn = urllib.request.build_opener = FakeOpener() |
---|
87 | n/a | |
---|
88 | n/a | def tearDown(self): |
---|
89 | n/a | getpass.getpass = self._old_getpass |
---|
90 | n/a | urllib.request._opener = None |
---|
91 | n/a | urllib.request.build_opener = self.old_opener |
---|
92 | n/a | super(RegisterTestCase, self).tearDown() |
---|
93 | n/a | |
---|
94 | n/a | def _get_cmd(self, metadata=None): |
---|
95 | n/a | if metadata is None: |
---|
96 | n/a | metadata = {'url': 'xxx', 'author': 'xxx', |
---|
97 | n/a | 'author_email': 'xxx', |
---|
98 | n/a | 'name': 'xxx', 'version': 'xxx'} |
---|
99 | n/a | pkg_info, dist = self.create_dist(**metadata) |
---|
100 | n/a | return register(dist) |
---|
101 | n/a | |
---|
102 | n/a | def test_create_pypirc(self): |
---|
103 | n/a | # this test makes sure a .pypirc file |
---|
104 | n/a | # is created when requested. |
---|
105 | n/a | |
---|
106 | n/a | # let's create a register instance |
---|
107 | n/a | cmd = self._get_cmd() |
---|
108 | n/a | |
---|
109 | n/a | # we shouldn't have a .pypirc file yet |
---|
110 | n/a | self.assertFalse(os.path.exists(self.rc)) |
---|
111 | n/a | |
---|
112 | n/a | # patching input and getpass.getpass |
---|
113 | n/a | # so register gets happy |
---|
114 | n/a | # |
---|
115 | n/a | # Here's what we are faking : |
---|
116 | n/a | # use your existing login (choice 1.) |
---|
117 | n/a | # Username : 'tarek' |
---|
118 | n/a | # Password : 'password' |
---|
119 | n/a | # Save your login (y/N)? : 'y' |
---|
120 | n/a | inputs = Inputs('1', 'tarek', 'y') |
---|
121 | n/a | register_module.input = inputs.__call__ |
---|
122 | n/a | # let's run the command |
---|
123 | n/a | try: |
---|
124 | n/a | cmd.run() |
---|
125 | n/a | finally: |
---|
126 | n/a | del register_module.input |
---|
127 | n/a | |
---|
128 | n/a | # we should have a brand new .pypirc file |
---|
129 | n/a | self.assertTrue(os.path.exists(self.rc)) |
---|
130 | n/a | |
---|
131 | n/a | # with the content similar to WANTED_PYPIRC |
---|
132 | n/a | f = open(self.rc) |
---|
133 | n/a | try: |
---|
134 | n/a | content = f.read() |
---|
135 | n/a | self.assertEqual(content, WANTED_PYPIRC) |
---|
136 | n/a | finally: |
---|
137 | n/a | f.close() |
---|
138 | n/a | |
---|
139 | n/a | # now let's make sure the .pypirc file generated |
---|
140 | n/a | # really works : we shouldn't be asked anything |
---|
141 | n/a | # if we run the command again |
---|
142 | n/a | def _no_way(prompt=''): |
---|
143 | n/a | raise AssertionError(prompt) |
---|
144 | n/a | register_module.input = _no_way |
---|
145 | n/a | |
---|
146 | n/a | cmd.show_response = 1 |
---|
147 | n/a | cmd.run() |
---|
148 | n/a | |
---|
149 | n/a | # let's see what the server received : we should |
---|
150 | n/a | # have 2 similar requests |
---|
151 | n/a | self.assertEqual(len(self.conn.reqs), 2) |
---|
152 | n/a | req1 = dict(self.conn.reqs[0].headers) |
---|
153 | n/a | req2 = dict(self.conn.reqs[1].headers) |
---|
154 | n/a | |
---|
155 | n/a | self.assertEqual(req1['Content-length'], '1374') |
---|
156 | n/a | self.assertEqual(req2['Content-length'], '1374') |
---|
157 | n/a | self.assertIn(b'xxx', self.conn.reqs[1].data) |
---|
158 | n/a | |
---|
159 | n/a | def test_password_not_in_file(self): |
---|
160 | n/a | |
---|
161 | n/a | self.write_file(self.rc, PYPIRC_NOPASSWORD) |
---|
162 | n/a | cmd = self._get_cmd() |
---|
163 | n/a | cmd._set_config() |
---|
164 | n/a | cmd.finalize_options() |
---|
165 | n/a | cmd.send_metadata() |
---|
166 | n/a | |
---|
167 | n/a | # dist.password should be set |
---|
168 | n/a | # therefore used afterwards by other commands |
---|
169 | n/a | self.assertEqual(cmd.distribution.password, 'password') |
---|
170 | n/a | |
---|
171 | n/a | def test_registering(self): |
---|
172 | n/a | # this test runs choice 2 |
---|
173 | n/a | cmd = self._get_cmd() |
---|
174 | n/a | inputs = Inputs('2', 'tarek', 'tarek@ziade.org') |
---|
175 | n/a | register_module.input = inputs.__call__ |
---|
176 | n/a | try: |
---|
177 | n/a | # let's run the command |
---|
178 | n/a | cmd.run() |
---|
179 | n/a | finally: |
---|
180 | n/a | del register_module.input |
---|
181 | n/a | |
---|
182 | n/a | # we should have send a request |
---|
183 | n/a | self.assertEqual(len(self.conn.reqs), 1) |
---|
184 | n/a | req = self.conn.reqs[0] |
---|
185 | n/a | headers = dict(req.headers) |
---|
186 | n/a | self.assertEqual(headers['Content-length'], '608') |
---|
187 | n/a | self.assertIn(b'tarek', req.data) |
---|
188 | n/a | |
---|
189 | n/a | def test_password_reset(self): |
---|
190 | n/a | # this test runs choice 3 |
---|
191 | n/a | cmd = self._get_cmd() |
---|
192 | n/a | inputs = Inputs('3', 'tarek@ziade.org') |
---|
193 | n/a | register_module.input = inputs.__call__ |
---|
194 | n/a | try: |
---|
195 | n/a | # let's run the command |
---|
196 | n/a | cmd.run() |
---|
197 | n/a | finally: |
---|
198 | n/a | del register_module.input |
---|
199 | n/a | |
---|
200 | n/a | # we should have send a request |
---|
201 | n/a | self.assertEqual(len(self.conn.reqs), 1) |
---|
202 | n/a | req = self.conn.reqs[0] |
---|
203 | n/a | headers = dict(req.headers) |
---|
204 | n/a | self.assertEqual(headers['Content-length'], '290') |
---|
205 | n/a | self.assertIn(b'tarek', req.data) |
---|
206 | n/a | |
---|
207 | n/a | @unittest.skipUnless(docutils is not None, 'needs docutils') |
---|
208 | n/a | def test_strict(self): |
---|
209 | n/a | # testing the script option |
---|
210 | n/a | # when on, the register command stops if |
---|
211 | n/a | # the metadata is incomplete or if |
---|
212 | n/a | # long_description is not reSt compliant |
---|
213 | n/a | |
---|
214 | n/a | # empty metadata |
---|
215 | n/a | cmd = self._get_cmd({}) |
---|
216 | n/a | cmd.ensure_finalized() |
---|
217 | n/a | cmd.strict = 1 |
---|
218 | n/a | self.assertRaises(DistutilsSetupError, cmd.run) |
---|
219 | n/a | |
---|
220 | n/a | # metadata are OK but long_description is broken |
---|
221 | n/a | metadata = {'url': 'xxx', 'author': 'xxx', |
---|
222 | n/a | 'author_email': 'éxéxé', |
---|
223 | n/a | 'name': 'xxx', 'version': 'xxx', |
---|
224 | n/a | 'long_description': 'title\n==\n\ntext'} |
---|
225 | n/a | |
---|
226 | n/a | cmd = self._get_cmd(metadata) |
---|
227 | n/a | cmd.ensure_finalized() |
---|
228 | n/a | cmd.strict = 1 |
---|
229 | n/a | self.assertRaises(DistutilsSetupError, cmd.run) |
---|
230 | n/a | |
---|
231 | n/a | # now something that works |
---|
232 | n/a | metadata['long_description'] = 'title\n=====\n\ntext' |
---|
233 | n/a | cmd = self._get_cmd(metadata) |
---|
234 | n/a | cmd.ensure_finalized() |
---|
235 | n/a | cmd.strict = 1 |
---|
236 | n/a | inputs = Inputs('1', 'tarek', 'y') |
---|
237 | n/a | register_module.input = inputs.__call__ |
---|
238 | n/a | # let's run the command |
---|
239 | n/a | try: |
---|
240 | n/a | cmd.run() |
---|
241 | n/a | finally: |
---|
242 | n/a | del register_module.input |
---|
243 | n/a | |
---|
244 | n/a | # strict is not by default |
---|
245 | n/a | cmd = self._get_cmd() |
---|
246 | n/a | cmd.ensure_finalized() |
---|
247 | n/a | inputs = Inputs('1', 'tarek', 'y') |
---|
248 | n/a | register_module.input = inputs.__call__ |
---|
249 | n/a | # let's run the command |
---|
250 | n/a | try: |
---|
251 | n/a | cmd.run() |
---|
252 | n/a | finally: |
---|
253 | n/a | del register_module.input |
---|
254 | n/a | |
---|
255 | n/a | # and finally a Unicode test (bug #12114) |
---|
256 | n/a | metadata = {'url': 'xxx', 'author': '\u00c9ric', |
---|
257 | n/a | 'author_email': 'xxx', 'name': 'xxx', |
---|
258 | n/a | 'version': 'xxx', |
---|
259 | n/a | 'description': 'Something about esszet \u00df', |
---|
260 | n/a | 'long_description': 'More things about esszet \u00df'} |
---|
261 | n/a | |
---|
262 | n/a | cmd = self._get_cmd(metadata) |
---|
263 | n/a | cmd.ensure_finalized() |
---|
264 | n/a | cmd.strict = 1 |
---|
265 | n/a | inputs = Inputs('1', 'tarek', 'y') |
---|
266 | n/a | register_module.input = inputs.__call__ |
---|
267 | n/a | # let's run the command |
---|
268 | n/a | try: |
---|
269 | n/a | cmd.run() |
---|
270 | n/a | finally: |
---|
271 | n/a | del register_module.input |
---|
272 | n/a | |
---|
273 | n/a | @unittest.skipUnless(docutils is not None, 'needs docutils') |
---|
274 | n/a | def test_register_invalid_long_description(self): |
---|
275 | n/a | description = ':funkie:`str`' # mimic Sphinx-specific markup |
---|
276 | n/a | metadata = {'url': 'xxx', 'author': 'xxx', |
---|
277 | n/a | 'author_email': 'xxx', |
---|
278 | n/a | 'name': 'xxx', 'version': 'xxx', |
---|
279 | n/a | 'long_description': description} |
---|
280 | n/a | cmd = self._get_cmd(metadata) |
---|
281 | n/a | cmd.ensure_finalized() |
---|
282 | n/a | cmd.strict = True |
---|
283 | n/a | inputs = Inputs('2', 'tarek', 'tarek@ziade.org') |
---|
284 | n/a | register_module.input = inputs |
---|
285 | n/a | self.addCleanup(delattr, register_module, 'input') |
---|
286 | n/a | |
---|
287 | n/a | self.assertRaises(DistutilsSetupError, cmd.run) |
---|
288 | n/a | |
---|
289 | n/a | def test_check_metadata_deprecated(self): |
---|
290 | n/a | # makes sure make_metadata is deprecated |
---|
291 | n/a | cmd = self._get_cmd() |
---|
292 | n/a | with check_warnings() as w: |
---|
293 | n/a | warnings.simplefilter("always") |
---|
294 | n/a | cmd.check_metadata() |
---|
295 | n/a | self.assertEqual(len(w.warnings), 1) |
---|
296 | n/a | |
---|
297 | n/a | def test_list_classifiers(self): |
---|
298 | n/a | cmd = self._get_cmd() |
---|
299 | n/a | cmd.list_classifiers = 1 |
---|
300 | n/a | cmd.run() |
---|
301 | n/a | results = self.get_logs(INFO) |
---|
302 | n/a | self.assertEqual(results, ['running check', 'xxx']) |
---|
303 | n/a | |
---|
304 | n/a | def test_show_response(self): |
---|
305 | n/a | # test that the --show-response option return a well formatted response |
---|
306 | n/a | cmd = self._get_cmd() |
---|
307 | n/a | inputs = Inputs('1', 'tarek', 'y') |
---|
308 | n/a | register_module.input = inputs.__call__ |
---|
309 | n/a | cmd.show_response = 1 |
---|
310 | n/a | try: |
---|
311 | n/a | cmd.run() |
---|
312 | n/a | finally: |
---|
313 | n/a | del register_module.input |
---|
314 | n/a | |
---|
315 | n/a | results = self.get_logs(INFO) |
---|
316 | n/a | self.assertEqual(results[3], 75 * '-' + '\nxxx\n' + 75 * '-') |
---|
317 | n/a | |
---|
318 | n/a | |
---|
319 | n/a | def test_suite(): |
---|
320 | n/a | return unittest.makeSuite(RegisterTestCase) |
---|
321 | n/a | |
---|
322 | n/a | if __name__ == "__main__": |
---|
323 | n/a | run_unittest(test_suite()) |
---|