test/Help.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 import TestSCons
  27
  28 test = TestSCons.TestSCons()
  29
  30 wpath = test.workpath()
  31
  32 test.write('SConstruct', r"""
  33 Help("Help text\ngoes here.\n")
  34 """)
  35
  36 expect = """scons: Reading SConscript files ...
  37 scons: done reading SConscript files.
  38 Help text
  39 goes here.
  40
  41 Use scons -H for help about SCons built-in command-line options.
  42 """
  43
  44 test.run(arguments = '-h', stdout = expect)
  45
  46 test.write('SConstruct', r"""
  47 env = Environment(MORE='more', HELP='help')
  48 env.Help("\nEven $MORE\n$HELP text!\n")
  49 """)
  50
  51 expect = """scons: Reading SConscript files ...
  52 scons: done reading SConscript files.
  53
  54 Even more
  55 help text!
  56
  57 Use scons -H for help about SCons built-in command-line options.
  58 """
  59
  60 test.run(arguments = '-h', stdout = expect)
  61
  62 test.write('SConstruct', r"""
  63 Help('\nMulti')
  64 Help('line\n')
  65 Help('''\
  66 help
  67 text!
  68 ''')
  69 """)
  70
  71 expect = """\
  72 scons: Reading SConscript files ...
  73 scons: done reading SConscript files.
  74
  75 Multiline
  76 help
  77 text!
  78
  79 Use scons -H for help about SCons built-in command-line options.
  80 """
  81
  82 test.run(arguments = '-h', stdout = expect)
  83
  84 # Bug #2831 - append flag to Help doesn't wipe out addoptions and variables used together
  85 test.write('SConstruct', r"""
  86
  87 AddOption(
  88     '--debugging',
  89     dest='debugging',
  90     action='store_true',
  91     default=False,
  92     metavar='BDEBUGGING',
  93     help='Compile with debugging symbols',
  94 )
  95
  96 vars = Variables()
  97 vars.Add(ListVariable('buildmod', 'List of modules to build', 'none', ['python']))
  98 DefaultEnvironment(tools=[])
  99 env = Environment()
 100 Help(vars.GenerateHelpText(env), append=True)
 101 """)
 102
 103 expect = ".*--debugging.*Compile with debugging symbols.*buildmod: List of modules to build.*"
 104 test.run(arguments = '-h', stdout = expect, match=TestSCons.match_re_dotall)
 105
 106 # Bug 2831
 107 # This test checks to verify that append=False doesn't include anything
 108 # but the expected help for the specified Variable()
 109
 110 test.write('SConstruct', r"""
 111 AddOption(
 112     '--debugging',
 113     dest='debugging',
 114     action='store_true',
 115     default=False,
 116     metavar='BDEBUGGING',
 117     help='Compile with debugging symbols',
 118 )
 119
 120 vars = Variables()
 121 vars.Add(ListVariable('buildmod', 'List of modules to build', 'none', ['python']))
 122
 123 DefaultEnvironment(tools=[])
 124 env = Environment()
 125
 126 Help(vars.GenerateHelpText(env), append=False)
 127 """)
 128
 129 expect = """\
 130 scons: Reading SConscript files ...
 131 scons: done reading SConscript files.
 132
 133 buildmod: List of modules to build
 134     (all|none|comma-separated list of names)
 135     allowed names: python
 136     default: none
 137     actual: None
 138
 139 Use scons -H for help about SCons built-in command-line options.
 140 """
 141
 142 test.run(arguments='-h', stdout=expect)
 143
 144 # Enhancement: keep_local flag saves the AddOption help,
 145 # but not SCons' own help.
 146 test.write('SConstruct', r"""
 147 AddOption(
 148     '--debugging',
 149     dest='debugging',
 150     action='store_true',
 151     default=False,
 152     metavar='BDEBUGGING',
 153     help='Compile with debugging symbols',
 154 )
 155
 156 vars = Variables()
 157 vars.Add(ListVariable('buildmod', 'List of modules to build', 'none', ['python']))
 158
 159 DefaultEnvironment(tools=[])
 160 env = Environment()
 161
 162 Help(vars.GenerateHelpText(env), append=True, keep_local=True)
 163 """)
 164
 165 expect = """\
 166 scons: Reading SConscript files ...
 167 scons: done reading SConscript files.
 168 Local Options:
 169   --debugging  Compile with debugging symbols
 170
 171 buildmod: List of modules to build
 172     (all|none|comma-separated list of names)
 173     allowed names: python
 174     default: none
 175     actual: None
 176
 177 Use scons -H for help about SCons built-in command-line options.
 178 """
 179
 180 test.run(arguments='-h', stdout=expect)
 181
 182
 183 test.pass_test()
 184
 185 # Local Variables:
 186 # tab-width:4
 187 # indent-tabs-mode:nil
 188 # End:
 189 # vim: set expandtab tabstop=4 shiftwidth=4: