1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
|
# -*- coding: utf-8 -*-
#
# Copyright (C) 2012-2013 Vinay Sajip.
# Licensed to the Python Software Foundation under a contributor agreement.
# See LICENSE.txt and CONTRIBUTORS.txt.
#
from __future__ import unicode_literals
import os
import shutil
import subprocess
import sys
import tempfile
import textwrap
from compat import unittest
from distlib import DistlibException
from distlib.compat import fsencode, sysconfig
from distlib.scripts import ScriptMaker, _enquote_executable
from distlib.util import get_executable
HERE = os.path.abspath(os.path.dirname(__file__))
COPIED_SCRIPT = '''#!python
# This is a copied script
'''
MADE_SCRIPT = 'made = dummy.module:main'
class ScriptTestCase(unittest.TestCase):
def setUp(self):
source_dir = os.path.join(HERE, 'scripts')
target_dir = tempfile.mkdtemp()
self.maker = ScriptMaker(source_dir, target_dir, add_launchers=False)
def tearDown(self):
shutil.rmtree(self.maker.target_dir)
@unittest.skipIf(sysconfig.is_python_build(), 'Test not appropriate for '
'Python source builds')
def test_shebangs(self):
executable = fsencode(get_executable())
for fn in ('foo.py', 'script1.py', 'script2.py', 'script3.py',
'shell.sh'):
files = self.maker.make(fn)
self.assertEqual(len(files), 1)
d, f = os.path.split(files[0])
self.assertEqual(f, fn)
self.assertEqual(d, self.maker.target_dir)
if fn.endswith('.py') and fn != 'foo.py': # no shebang in foo.py
with open(files[0], 'rb') as f:
first_line = f.readline()
self.assertIn(executable, first_line)
def test_shebangs_custom_executable(self):
srcdir = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, srcdir)
dstdir = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, dstdir)
maker = ScriptMaker(srcdir, dstdir, add_launchers=False)
maker.executable = 'this_should_appear_in_the_shebang_line(中文)'
# let's create the script to be copied. It has a vanilla shebang line,
# with some Unicode in it.
fn = os.path.join(srcdir, 'copied')
with open(fn, 'w') as f:
f.write(COPIED_SCRIPT)
# Let's ask the maker to copy the script, and see what the shebang is
# in the copy.
filenames = maker.make('copied')
with open(filenames[0], 'rb') as f:
actual = f.readline().decode('utf-8')
self.assertIn(maker.executable, actual)
# Now let's make a script from a callable
filenames = maker.make(MADE_SCRIPT)
with open(filenames[0], 'rb') as f:
actual = f.readline().decode('utf-8')
self.assertIn(maker.executable, actual)
def test_multiple(self):
specs = ('foo.py', 'script1.py', 'script2.py', 'script3.py',
'shell.sh', 'uwsgi_part')
files = self.maker.make_multiple(specs)
self.assertEqual(len(specs), len(files))
expected = set(specs)
self.assertEqual(expected, set([os.path.basename(f) for f in files]))
ofiles = os.listdir(self.maker.target_dir)
self.assertEqual(expected, set(ofiles))
def test_generation(self):
self.maker.clobber = True
for name in ('main', 'other_main'):
for options in (None, {}, {'gui': False}, {'gui': True}):
gui = options and options.get('gui', False)
spec = 'foo = foo:' + name
files = self.maker.make(spec, options)
self.assertEqual(len(files), 2)
actual = set()
for f in files:
d, f = os.path.split(f)
actual.add(f)
if os.name == 'nt': # pragma: no cover
if gui:
ext = 'pyw'
else:
ext = 'py'
expected = set(['foo.%s' % ext,
'foo-%s.%s' % (sys.version[:3], ext)])
else:
expected = set(['foo', 'foo-%s' % sys.version[:3]])
self.assertEqual(actual, expected)
self.assertEqual(d, self.maker.target_dir)
for fn in files:
with open(fn, 'r') as f:
text = f.read()
self.assertIn("_resolve('foo', '%s')" % name, text)
if options and options['gui'] and os.name == 'nt': # pragma: no cover
first_line, rest = text.split('\n', 1)
self.assertIn('pythonw', first_line)
def test_clobber(self):
files = self.maker.make('foo = foo:main')
saved_files = files
self.assertGreaterEqual(len(files), 2) # foo, foo-X.Y
files = self.maker.make('foo = foo:main')
self.assertFalse(files)
self.maker.clobber = True
files = self.maker.make('foo = foo:main')
self.assertEqual(files, saved_files)
@unittest.skipIf(os.name != 'nt', 'Test is Windows-specific')
def test_launchers(self): # pragma: no cover
tlauncher = self.maker._get_launcher('t')
self.maker.add_launchers = True
specs = ('foo.py', 'script1.py', 'script2.py', 'script3.py',
'shell.sh')
files = self.maker.make_multiple(specs)
self.assertEqual(len(specs), len(files))
filenames = set([os.path.basename(f) for f in files])
self.assertEqual(filenames, set(('foo.py', 'script1.exe',
'script2.exe', 'script3.exe',
'shell.sh')))
for fn in files:
if not fn.endswith('.exe'):
continue
with open(fn, 'rb') as f:
data = f.read()
self.assertTrue(data.startswith(tlauncher))
@unittest.skipIf(os.name != 'nt', 'Test is Windows-specific')
def test_launcher_run(self):
self.maker.add_launchers = True
files = self.maker.make('script6.py')
self.assertEqual(len(files), 1)
p = subprocess.Popen([files[0], 'Test Argument'],
stdout=subprocess.PIPE, stdin=subprocess.PIPE,
stderr=subprocess.STDOUT)
stdout, stderr = p.communicate('input'.encode('ascii'))
actual = stdout.decode('ascii').replace('\r\n', '\n')
expected = textwrap.dedent("""
script6.exe
['Test Argument']
'input'
non-optimized
""").lstrip()
self.assertEqual(actual, expected)
@unittest.skipIf(os.name != 'nt', 'Test is Windows-specific')
def test_launcher_run_with_interpreter_args(self):
srcdir = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, srcdir)
dstdir = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, dstdir)
maker = ScriptMaker(srcdir, dstdir, add_launchers=True)
# add '-O' option to shebang to run in optimized mode
with open(os.path.join(HERE, 'scripts', 'script6.py'), 'r') as src:
with open(os.path.join(srcdir, 'script6-optimized.py'), 'w') as dst:
shebang = src.readline().rstrip()
dst.write(shebang + " -O\n")
dst.write(src.read())
files = maker.make('script6-optimized.py')
self.assertEqual(len(files), 1)
p = subprocess.Popen([files[0], 'Test Argument'],
stdout=subprocess.PIPE, stdin=subprocess.PIPE,
stderr=subprocess.STDOUT)
stdout, stderr = p.communicate('input'.encode('ascii'))
actual = stdout.decode('ascii').replace('\r\n', '\n')
expected = textwrap.dedent("""
script6-optimized.exe
['Test Argument']
'input'
""").lstrip() # 'non-optimized' is not printed this time
self.assertEqual(actual, expected)
@unittest.skipIf(os.name != 'nt', 'Test is Windows-specific')
def test_windows(self): # pragma: no cover
wlauncher = self.maker._get_launcher('w')
tlauncher = self.maker._get_launcher('t')
self.maker.add_launchers = True
executable = os.path.normcase(sys.executable).encode('utf-8')
wexecutable = executable.replace(b'python.exe', b'pythonw.exe')
files = self.maker.make('script4.py')
self.assertEqual(len(files), 1)
filenames = set([os.path.basename(f) for f in files])
self.assertEqual(filenames, set(['script4.exe']))
for fn in files:
with open(fn, 'rb') as f:
data = f.read()
self.assertTrue(data.startswith(wlauncher))
self.assertIn(executable, data)
# Now test making scripts gui and console
files = self.maker.make('foo = foo:main', {'gui': True})
self.assertEqual(len(files), 2)
filenames = set([os.path.basename(f) for f in files])
specific = sys.version[:3]
self.assertEqual(filenames, set(('foo.exe', 'foo-%s.exe' % specific)))
for fn in files:
with open(fn, 'rb') as f:
data = f.read()
self.assertTrue(data.startswith(wlauncher))
self.assertIn(wexecutable, data)
files = self.maker.make('foo = foo:main')
self.assertEqual(len(files), 2)
filenames = set([os.path.basename(f) for f in files])
self.assertEqual(filenames, set(('foo.exe', 'foo-%s.exe' % specific)))
for fn in files:
with open(fn, 'rb') as f:
data = f.read()
self.assertTrue(data.startswith(tlauncher))
self.assertIn(executable, data)
@unittest.skipIf(os.name != 'nt', 'Test is Windows-specific')
def test_windows_run(self):
self.maker.add_launchers = True
files = self.maker.make('script7.pyw')
self.assertEqual(len(files), 1)
test_output = os.path.join(self.maker.target_dir, 'test_output.txt')
p = subprocess.Popen([files[0], test_output, 'Test Argument'],
stdout=subprocess.PIPE, stdin=subprocess.PIPE,
stderr=subprocess.STDOUT)
stdout, stderr = p.communicate()
self.assertFalse(stdout)
self.assertFalse(stderr)
with open(test_output, 'rb') as f:
actual = f.read().decode('ascii')
self.assertEqual(actual, 'Test Argument')
def test_dry_run(self):
self.maker.dry_run = True
self.maker.variants = set([''])
specs = ('foo.py', 'bar = foo:main')
files = self.maker.make_multiple(specs)
self.assertEqual(len(specs), len(files))
if os.name == 'nt': # pragma: no cover
bar = 'bar.py'
else:
bar = 'bar'
self.assertEqual(set(('foo.py', bar)),
set([os.path.basename(f) for f in files]))
ofiles = os.listdir(self.maker.target_dir)
self.assertFalse(ofiles)
def test_script_run(self):
files = self.maker.make('test = cgi:print_directory')
self.assertEqual(len(files), 2)
p = subprocess.Popen([sys.executable, files[0]],
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = p.communicate()
self.assertIn(b'<H3>Current Working Directory:</H3>', stdout)
self.assertIn(os.getcwd().encode('utf-8'), stdout)
@unittest.skipUnless(os.name == 'posix', 'Test only valid for POSIX')
def test_mode(self):
self.maker.set_mode = False
files = self.maker.make('foo = foo:main')
self.assertEqual(len(files), 2)
for f in files:
self.assertIn(os.stat(f).st_mode & 0o7777, (0o644, 0o664))
self.maker.set_mode = True
files = self.maker.make('bar = bar:main')
self.assertEqual(len(files), 2)
for f in files:
self.assertIn(os.stat(f).st_mode & 0o7777, (0o755, 0o775))
def test_interpreter_args(self):
executable = fsencode(get_executable())
options = {
'interpreter_args': ['-E', '"foo bar"', 'baz frobozz']
}
self.maker.variants = set([''])
files = self.maker.make('foo = bar:baz', options=options)
self.assertEqual(len(files), 1)
with open(files[0], 'rb') as f:
shebang_line = f.readline()
if not sysconfig.is_python_build():
self.assertIn(executable, shebang_line)
self.assertIn(b' -E "foo bar" baz frobozz', shebang_line)
def test_args_on_copy(self):
self.maker.variants = set([''])
self.maker.executable = 'mypython'
files = self.maker.make('script5.py')
with open(files[0]) as f:
actual = f.readline().strip()
self.assertEqual(actual, '#!mypython -mzippy.activate')
if not sysconfig.is_python_build():
self.maker.executable = None
os.remove(files[0])
files = self.maker.make('script5.py')
with open(files[0]) as f:
actual = f.readline().strip()
expected = '#!%s -mzippy.activate' % get_executable()
self.assertEqual(actual, expected)
def test_enquote_executable(self):
for executable, expected in (
('/no/spaces', '/no/spaces'),
('/i have/space', '"/i have/space"'),
('"/space prequoted"', '"/space prequoted"'),
('/usr/bin/env nospaces', '/usr/bin/env nospaces'),
('/usr/bin/env with spaces', '/usr/bin/env "with spaces"'),
('/usr/bin/env "pre spaced"', '/usr/bin/env "pre spaced"')
):
self.assertEqual(_enquote_executable(executable),
expected)
if __name__ == '__main__': # pragma: no cover
unittest.main()
|
