summaryrefslogtreecommitdiffstats
path: root/test/OptionsTypes.py
blob: 43cbfbe336142537ed65673bdd1da13621c47d7b (plain)
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
#!/usr/bin/env python
#
# __COPYRIGHT__
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#

__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"

import TestSCons, SCons.Errors
import string, os

test = TestSCons.TestSCons()

def check(expect):
    result = string.split(test.stdout(), '\n')
    assert result[1:len(expect)+1] == expect, (result[1:len(expect)+1], expect)

#### test BoolOption #####

test.write('SConstruct', """
from SCons.Options import BoolOption

opts = Options(args=ARGUMENTS)
opts.AddOptions(
    BoolOption('warnings', 'compilation with -Wall and similiar', 1),
    BoolOption('profile', 'create profiling informations', 0),
    )

env = Environment(options=opts)
Help(opts.GenerateHelpText(env))

print env['warnings']
print env['profile']

Default(env.Alias('dummy', None))
""")

test.run()
check(['1', '0'])

test.run(arguments='warnings=0 profile=no profile=true')
check(['0', '1'])

test.run(arguments='warnings=irgendwas',
         stderr = """
scons: *** Error converting option: warnings
Invalid value for boolean option: irgendwas
File "SConstruct", line 10, in ?
""", status=2)


#### test EnumOption ####

test.write('SConstruct', """
from SCons.Options import EnumOption

list_of_libs = Split('x11 gl qt ical')

opts = Options(args=ARGUMENTS)
opts.AddOptions(
    EnumOption('debug', 'debug output and symbols', 'no',
               allowed_values=('yes', 'no', 'full'),
               map={}, ignorecase=0),  # case sensitive
    EnumOption('guilib', 'gui lib to use', 'gtk',
               allowed_values=('motif', 'gtk', 'kde'),
               map={}, ignorecase=1), # case insensitive
    EnumOption('some', 'some option', 'xaver',
               allowed_values=('xaver', 'eins'),
               map={}, ignorecase=2), # make lowercase
    )

env = Environment(options=opts)
Help(opts.GenerateHelpText(env))

print env['debug']
print env['guilib']
print env['some']

Default(env.Alias('dummy', None))
""")


test.run(); check(['no', 'gtk', 'xaver'])
test.run(arguments='debug=yes guilib=Motif some=xAVER')
check(['yes', 'Motif', 'xaver'])
test.run(arguments='debug=full guilib=KdE some=EiNs')
check(['full', 'KdE', 'eins'])

test.run(arguments='debug=FULL',
         stderr = """
scons: *** Invalid value for option debug: FULL
File "SConstruct", line 19, in ?
""", status=2)

test.run(arguments='guilib=IrGeNdwas',
         stderr = """
scons: *** Invalid value for option guilib: irgendwas
File "SConstruct", line 19, in ?
""", status=2)

test.run(arguments='some=IrGeNdwas',
         stderr = """
scons: *** Invalid value for option some: irgendwas
File "SConstruct", line 19, in ?
""", status=2)
         


#### test ListOption ####

test.write('SConstruct', """
from SCons.Options import ListOption

list_of_libs = Split('x11 gl qt ical')

opts = Options(args=ARGUMENTS)
opts.AddOptions(
    ListOption('shared',
               'libraries to build as shared libraries',
               'all',
               names = list_of_libs),
    )

env = Environment(options=opts)
Help(opts.GenerateHelpText(env))

print env['shared']
if 'ical' in env['shared']: print '1'
else: print '0'
for x in  env['shared']:
    print x,
print
print env.subst('$shared')
Default(env.Alias('dummy', None))
""")

test.run()
check(['all', '1', 'gl ical qt x11', 'gl ical qt x11'])
test.run(arguments='shared=none')
check(['none', '0', '', ''])
test.run(arguments='shared=')
check(['none', '0', '', ''])
test.run(arguments='shared=x11,ical')
check(['ical,x11', '1', 'ical x11', 'ical x11'])
test.run(arguments='shared=x11,,ical,,')
check(['ical,x11', '1', 'ical x11', 'ical x11'])


test.run(arguments='shared=foo',
         stderr = """
scons: *** Error converting option: shared
Invalid value(s) for option: foo
File "SConstruct", line 14, in ?
""", status=2)

# be paranoid in testing some more combinations

test.run(arguments='shared=foo,ical',
         stderr = """
scons: *** Error converting option: shared
Invalid value(s) for option: foo
File "SConstruct", line 14, in ?
""", status=2)

test.run(arguments='shared=ical,foo',
         stderr = """
scons: *** Error converting option: shared
Invalid value(s) for option: foo
File "SConstruct", line 14, in ?
""", status=2)

test.run(arguments='shared=ical,foo,x11',
         stderr = """
scons: *** Error converting option: shared
Invalid value(s) for option: foo
File "SConstruct", line 14, in ?
""", status=2)

test.run(arguments='shared=foo,x11,,,bar',
         stderr = """
scons: *** Error converting option: shared
Invalid value(s) for option: foo,bar
File "SConstruct", line 14, in ?
""", status=2)


#### test PackageOption ####

test.write('SConstruct', """
from SCons.Options import PackageOption

opts = Options(args=ARGUMENTS)
opts.AddOptions(
    PackageOption('x11',
                  'use X11 installed here (yes = search some places',
                  'yes'),
    )

env = Environment(options=opts)
Help(opts.GenerateHelpText(env))

print env['x11']
Default(env.Alias('dummy', None))
""")

test.run()
check(['1'])
test.run(arguments='x11=no'); check(['0'])
test.run(arguments='"x11=%s"' % test.workpath()); check([test.workpath()])

test.run(arguments='x11=0',
         stderr = """
scons: *** Path does not exist for option x11: 0
File "SConstruct", line 11, in ?
""", status=2)

test.run(arguments='x11=/non/existing/path/',
         stderr = """
scons: *** Path does not exist for option x11: /non/existing/path/
File "SConstruct", line 11, in ?
""", status=2)
         


#### test PathOption ####

test.subdir('lib', 'qt', ['qt', 'lib'], 'nolib' )
workpath = test.workpath()
libpath = os.path.join(workpath, 'lib')

test.write('SConstruct', """
from SCons.Options import PathOption

qtdir = '%s'

opts = Options(args=ARGUMENTS)
opts.AddOptions(
    PathOption('qtdir', 'where the root of Qt is installed', qtdir),
    PathOption('qt_libraries', 'where the Qt library is installed', '%s'),
    )

env = Environment(options=opts)
Help(opts.GenerateHelpText(env))

print env['qtdir']
print env['qt_libraries']
print env.subst('$qt_libraries')

Default(env.Alias('dummy', None))
""" % (workpath, os.path.join('$qtdir', 'lib') ))

qtpath = workpath
libpath = os.path.join(qtpath, 'lib')
test.run()
check([qtpath, os.path.join('$qtdir', 'lib'), libpath])

qtpath = os.path.join(workpath, 'qt')
libpath = os.path.join(qtpath, 'lib')
test.run(arguments='"qtdir=%s"' % qtpath)
check([qtpath, os.path.join('$qtdir', 'lib'), libpath])

qtpath = workpath
libpath = os.path.join(qtpath, 'nolib')
test.run(arguments='"qt_libraries=%s"' % libpath)
check([qtpath, libpath, libpath])

qtpath = os.path.join(workpath, 'qt')
libpath = os.path.join(workpath, 'nolib')
test.run(arguments='"qtdir=%s" "qt_libraries=%s"' % (qtpath, libpath))
check([qtpath, libpath, libpath])

qtpath = os.path.join(workpath, 'non', 'existing', 'path')
test.run(arguments='"qtdir=%s"' % qtpath,
         stderr = """
scons: *** Path does not exist for option qtdir: %s
File "SConstruct", line 12, in ?
""" % qtpath, status=2)

test.run(arguments='"qt_libraries=%s"' % qtpath,
         stderr = """
scons: *** Path does not exist for option qt_libraries: %s
File "SConstruct", line 12, in ?
""" % qtpath, status=2)


### test help messages ####

workpath = test.workpath()
qtpath  = os.path.join(workpath, 'qt')
libpath = os.path.join(qtpath, 'lib')
libdirvar = os.path.join('$qtdir', 'lib')
         
test.write('SConstruct', """
from SCons.Options import BoolOption, EnumOption, ListOption, \
   PackageOption, PathOption

list_of_libs = Split('x11 gl qt ical')
qtdir = '%(qtdir)s'

opts = Options(args=ARGUMENTS)
opts.AddOptions(
    BoolOption('warnings', 'compilation with -Wall and similiar', 1),
    BoolOption('profile', 'create profiling informations', 0),
    EnumOption('debug', 'debug output and symbols', 'no',
               allowed_values=('yes', 'no', 'full'),
               map={}, ignorecase=0),  # case sensitive
    EnumOption('guilib', 'gui lib to use', 'gtk',
               allowed_values=('motif', 'gtk', 'kde'),
               map={}, ignorecase=1), # case insensitive
    EnumOption('some', 'some option', 'xaver',
               allowed_values=('xaver', 'eins'),
               map={}, ignorecase=2), # make lowercase
    ListOption('shared',
               'libraries to build as shared libraries',
               'all',
               names = list_of_libs),
    PackageOption('x11',
                  'use X11 installed here (yes = search some places)',
                  'yes'), PathOption('qtdir', 'where the root of Qt is installed', qtdir),
    PathOption('qt_libraries',
               'where the Qt library is installed',
               '%(libdirvar)s'),
    )

env = Environment(options=opts)
Help(opts.GenerateHelpText(env))

print env['warnings']
print env['profile']

Default(env.Alias('dummy', None))
""" % {'qtdir': qtpath, 'libdirvar': libdirvar, 'libdir': libpath})


test.run(arguments='-h',
         stdout = """scons: Reading SConscript files ...
scons: done reading SConscript files.

warnings: compilation with -Wall and similiar (yes|no)
    default: 1
    actual: 1

profile: create profiling informations (yes|no)
    default: 0
    actual: 0

debug: debug output and symbols (yes|no|full)
    default: no
    actual: no

guilib: gui lib to use (motif|gtk|kde)
    default: gtk
    actual: gtk

some: some option (xaver|eins)
    default: xaver
    actual: xaver

shared: libraries to build as shared libraries
    (all|none|comma-separated list of names)
    allowed names: x11 gl qt ical
    default: all
    actual: x11 gl qt ical

x11: use X11 installed here (yes = search some places)
    ( yes | no | /path/to/x11 )
    default: yes
    actual: 1

qtdir: where the root of Qt is installed ( /path/to/qtdir )
    default: %(qtdir)s
    actual: %(qtdir)s

qt_libraries: where the Qt library is installed ( /path/to/qt_libraries )
    default: $qtdir/lib
    actual: %(libdir)s

Use scons -H for help about command-line options.
""" % {'qtdir': qtpath, 'libdirvar': libdirvar, 'libdir': libpath})


test.pass_test()