test/Help.py

   1 #!/usr/bin/env python
   2 #
   3 # __COPYRIGHT__
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining
   6 # a copy of this software and associated documentation files (the
   7 # "Software"), to deal in the Software without restriction, including
   8 # without limitation the rights to use, copy, modify, merge, publish,
   9 # distribute, sublicense, and/or sell copies of the Software, and to
  10 # permit persons to whom the Software is furnished to do so, subject to
  11 # the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be included
  14 # in all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  17 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  18 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23 #
  24
  25 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  26
  27 import TestSCons
  28
  29 test = TestSCons.TestSCons()
  30
  31 wpath = test.workpath()
  32
  33 test.write('SConstruct', r"""
  34 Help("Help text\ngoes here.\n")
  35 """)
  36
  37 expect = """scons: Reading SConscript files ...
  38 scons: done reading SConscript files.
  39 Help text
  40 goes here.
  41
  42 Use scons -H for help about command-line options.
  43 """
  44
  45 test.run(arguments = '-h', stdout = expect)
  46
  47 test.write('SConstruct', r"""
  48 env = Environment(MORE='more', HELP='help')
  49 env.Help("\nEven $MORE\n$HELP text!\n")
  50 """)
  51
  52 expect = """scons: Reading SConscript files ...
  53 scons: done reading SConscript files.
  54
  55 Even more
  56 help text!
  57
  58 Use scons -H for help about command-line options.
  59 """
  60
  61 test.run(arguments = '-h', stdout = expect)
  62
  63 test.write('SConstruct', r"""
  64 Help('\nMulti')
  65 Help('line\n')
  66 Help('''\
  67 help
  68 text!
  69 ''')
  70 """)
  71
  72 expect = """\
  73 scons: Reading SConscript files ...
  74 scons: done reading SConscript files.
  75
  76 Multiline
  77 help
  78 text!
  79
  80 Use scons -H for help about command-line options.
  81 """
  82
  83 test.run(arguments = '-h', stdout = expect)
  84
  85 # Bug #2831 - append flag to Help doesn't wipe out addoptions and variables used together
  86 test.write('SConstruct', r"""
  87
  88 AddOption('--debugging',
  89         dest='debugging',
  90         action='store_true',
  91         default=False,
  92         metavar='BDEBUGGING',
  93         help='Compile with debugging symbols')
  94
  95 vars = Variables()
  96 vars.Add(ListVariable('buildmod', 'List of modules to build', 'none',
  97                     ['python']))
  98
  99 env = Environment()
 100
 101 Help(vars.GenerateHelpText(env),append=True)
 102 """)
 103
 104 expect = ".*--debugging.*Compile with debugging symbols.*buildmod: List of modules to build.*"
 105
 106 test.run(arguments = '-h', stdout = expect, match=TestSCons.match_re_dotall)
 107
 108
 109 # Bug 2831
 110 # This test checks to verify that append=False doesn't include anything
 111 # but the expected help for the specified Variable()
 112
 113 test.write('SConstruct', r"""
 114
 115 AddOption('--debugging',
 116         dest='debugging',
 117         action='store_true',
 118         default=False,
 119         metavar='BDEBUGGING',
 120         help='Compile with debugging symbols')
 121
 122 vars = Variables()
 123 vars.Add(ListVariable('buildmod', 'List of modules to build', 'none',
 124                     ['python']))
 125
 126 env = Environment()
 127
 128 Help(vars.GenerateHelpText(env),append=False)
 129 """)
 130
 131 expect = """\
 132 scons: Reading SConscript files ...
 133 scons: done reading SConscript files.
 134
 135 buildmod: List of modules to build
 136     (all|none|comma-separated list of names)
 137     allowed names: python
 138     default: none
 139     actual: None
 140
 141 Use scons -H for help about command-line options.
 142 """
 143
 144 test.run(arguments = '-h', stdout = expect)
 145
 146
 147
 148 test.pass_test()
 149
 150 # Local Variables:
 151 # tab-width:4
 152 # indent-tabs-mode:nil
 153 # End:
 154 # vim: set expandtab tabstop=4 shiftwidth=4: