test/Variables/ListVariable.py

   1 #!/usr/bin/env python
   2 #
   3 # MIT License
   4 #
   5 # Copyright The SCons Foundation
   6 #
   7 # Permission is hereby granted, free of charge, to any person obtaining
   8 # a copy of this software and associated documentation files (the
   9 # "Software"), to deal in the Software without restriction, including
  10 # without limitation the rights to use, copy, modify, merge, publish,
  11 # distribute, sublicense, and/or sell copies of the Software, and to
  12 # permit persons to whom the Software is furnished to do so, subject to
  13 # the following conditions:
  14 #
  15 # The above copyright notice and this permission notice shall be included
  16 # in all copies or substantial portions of the Software.
  17 #
  18 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  19 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  20 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  22 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  23 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  24 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25
  26 """
  27 Test the ListVariable canned Variable type.
  28 """
  29
  30 import os
  31
  32 import TestSCons
  33
  34 test = TestSCons.TestSCons()
  35
  36 SConstruct_path = test.workpath('SConstruct')
  37
  38 def check(expect):
  39     result = test.stdout().split('\n')
  40     r = result[1:len(expect)+1]
  41     assert r == expect, (r, expect)
  42
  43
  44
  45 test.write(SConstruct_path, """\
  46 from SCons.Variables.ListVariable import ListVariable
  47 LV = ListVariable
  48
  49 from SCons.Variables import ListVariable
  50
  51 list_of_libs = Split('x11 gl qt ical')
  52
  53 optsfile = 'scons.variables'
  54 opts = Variables(optsfile, args=ARGUMENTS)
  55 opts.AddVariables(
  56     ListVariable('shared',
  57                'libraries to build as shared libraries',
  58                'all',
  59                names = list_of_libs,
  60                map = {'GL':'gl', 'QT':'qt'}),
  61     LV('listvariable', 'listvariable help', 'all', names=['l1', 'l2', 'l3'])
  62     )
  63
  64 DefaultEnvironment(tools=[])  # test speedup
  65 env = Environment(variables=opts)
  66 opts.Save(optsfile, env)
  67 Help(opts.GenerateHelpText(env))
  68
  69 print(env['shared'])
  70
  71 if 'ical' in env['shared']:
  72     print('1')
  73 else:
  74     print('0')
  75
  76 print(" ".join(env['shared']))
  77
  78 print(env.subst('$shared'))
  79 # Test subst_path() because it's used in $CPPDEFINES expansions.
  80 print(env.subst_path('$shared'))
  81 Default(env.Alias('dummy', None))
  82 """)
  83
  84 test.run()
  85 check(['all', '1', 'gl ical qt x11', 'gl ical qt x11',
  86        "['gl ical qt x11']"])
  87
  88 expect = "shared = 'all'"+os.linesep+"listvariable = 'all'"+os.linesep
  89 test.must_match(test.workpath('scons.variables'), expect)
  90
  91 check(['all', '1', 'gl ical qt x11', 'gl ical qt x11',
  92        "['gl ical qt x11']"])
  93
  94 test.run(arguments='shared=none')
  95 check(['none', '0', '', '', "['']"])
  96
  97 test.run(arguments='shared=')
  98 check(['none', '0', '', '', "['']"])
  99
 100 test.run(arguments='shared=x11,ical')
 101 check(['ical,x11', '1', 'ical x11', 'ical x11',
 102        "['ical x11']"])
 103
 104 test.run(arguments='shared=x11,,ical,,')
 105 check(['ical,x11', '1', 'ical x11', 'ical x11',
 106        "['ical x11']"])
 107
 108 test.run(arguments='shared=GL')
 109 check(['gl', '0', 'gl', 'gl'])
 110
 111 test.run(arguments='shared=QT,GL')
 112 check(['gl,qt', '0', 'gl qt', 'gl qt', "['gl qt']"])
 113
 114
 115 expect_stderr = """
 116 scons: *** Error converting option: shared
 117 Invalid value(s) for option: foo
 118 """ + test.python_file_line(SConstruct_path, 20)
 119
 120 test.run(arguments='shared=foo', stderr=expect_stderr, status=2)
 121
 122 # be paranoid in testing some more combinations
 123
 124 expect_stderr = """
 125 scons: *** Error converting option: shared
 126 Invalid value(s) for option: foo
 127 """ + test.python_file_line(SConstruct_path, 20)
 128
 129 test.run(arguments='shared=foo,ical', stderr=expect_stderr, status=2)
 130
 131 expect_stderr = """
 132 scons: *** Error converting option: shared
 133 Invalid value(s) for option: foo
 134 """ + test.python_file_line(SConstruct_path, 20)
 135
 136 test.run(arguments='shared=ical,foo', stderr=expect_stderr, status=2)
 137
 138 expect_stderr = """
 139 scons: *** Error converting option: shared
 140 Invalid value(s) for option: foo
 141 """ + test.python_file_line(SConstruct_path, 20)
 142
 143 test.run(arguments='shared=ical,foo,x11', stderr=expect_stderr, status=2)
 144
 145 expect_stderr = """
 146 scons: *** Error converting option: shared
 147 Invalid value(s) for option: foo,bar
 148 """ + test.python_file_line(SConstruct_path, 20)
 149
 150 test.run(arguments='shared=foo,x11,,,bar', stderr=expect_stderr, status=2)
 151
 152
 153
 154 test.write('SConstruct', """
 155 from SCons.Variables import ListVariable
 156
 157 opts = Variables(args=ARGUMENTS)
 158 opts.AddVariables(
 159     ListVariable('gpib',
 160                'comment',
 161                ['ENET', 'GPIB'],
 162                names = ['ENET', 'GPIB', 'LINUX_GPIB', 'NO_GPIB']),
 163     )
 164
 165 DefaultEnvironment(tools=[])  # test speedup
 166 env = Environment(variables=opts)
 167 Help(opts.GenerateHelpText(env))
 168
 169 print(env['gpib'])
 170 Default(env.Alias('dummy', None))
 171 """)
 172
 173 test.run(stdout=test.wrap_stdout(read_str="ENET,GPIB\n", build_str="""\
 174 scons: Nothing to be done for `dummy'.
 175 """))
 176
 177
 178
 179 test.pass_test()
 180
 181 # Local Variables:
 182 # tab-width:4
 183 # indent-tabs-mode:nil
 184 # End:
 185 # vim: set expandtab tabstop=4 shiftwidth=4: