test/MSVC/MSVC_SCRIPTERROR_POLICY.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 MSVC_SCRIPTERROR_POLICY construction variable and functions.
  28 """
  29
  30 import TestSCons
  31 import textwrap
  32
  33 from SCons.Tool.MSCommon.vc import get_installed_vcs_components
  34
  35 test = TestSCons.TestSCons()
  36 test.skip_if_not_msvc()
  37
  38 installed_versions = get_installed_vcs_components()
  39 default_version = installed_versions[0]
  40
  41 # Test construction variable with valid symbols
  42 test.write('SConstruct', textwrap.dedent(
  43     """
  44     env_list = []
  45     DefaultEnvironment(tools=[])
  46     for symbol in ['Error', 'Exception', 'Warn', 'Warning', 'Ignore', 'Suppress']:
  47         for policy in [symbol, symbol.upper(), symbol.lower()]:
  48             env = Environment(MSVC_SCRIPTERROR_POLICY=policy, tools=['msvc'])
  49             env_list.append(env)
  50     """
  51 ))
  52 test.run(arguments='-Q -s', stdout='')
  53
  54 if default_version.msvc_vernum >= 14.1:
  55     # Need VS2017 or later for MSVC_SCRIPT_ARGS
  56
  57     # Test environment construction with construction variable (invalid)
  58     test.write('SConstruct', textwrap.dedent(
  59         """
  60         DefaultEnvironment(tools=[])
  61         env = Environment(MSVC_SCRIPT_ARGS=['-thisdoesnotexist=somevalue'], MSVC_SCRIPTERROR_POLICY='Undefined', tools=['msvc'])
  62         """
  63     ))
  64     test.run(arguments='-Q -s', status=2, stderr=None)
  65     expect = "MSVCArgumentError: Value specified for MSVC_SCRIPTERROR_POLICY is not supported: 'Undefined'."
  66     test.must_contain_all(test.stderr(), expect)
  67
  68     # Test environment construction with construction variable (override global)
  69     test.write('SConstruct', textwrap.dedent(
  70         """
  71         from SCons.Tool.MSCommon import msvc_set_scripterror_policy
  72         DefaultEnvironment(tools=[])
  73         msvc_set_scripterror_policy('Exception')
  74         env = Environment(MSVC_SCRIPT_ARGS=['-thisdoesnotexist=somevalue'], MSVC_SCRIPTERROR_POLICY='Ignore', tools=['msvc'])
  75         """
  76     ))
  77     test.run(arguments='-Q -s', stdout='')
  78
  79     # Test environment construction with global policy
  80     test.write('SConstruct', textwrap.dedent(
  81         """
  82         from SCons.Tool.MSCommon import msvc_set_scripterror_policy
  83         DefaultEnvironment(tools=[])
  84         msvc_set_scripterror_policy('Exception')
  85         env = Environment(MSVC_SCRIPT_ARGS=['-thisdoesnotexist=somevalue'], tools=['msvc'])
  86         """
  87     ))
  88     test.run(arguments='-Q -s', status=2, stderr=None)
  89     expect = "MSVCScriptExecutionError: vc script errors detected:"
  90     test.must_contain_all(test.stderr(), expect)
  91
  92     # Test environment construction with global policy and construction variable ignored
  93     test.write('SConstruct', textwrap.dedent(
  94         """
  95         from SCons.Tool.MSCommon import msvc_set_scripterror_policy
  96         DefaultEnvironment(tools=[])
  97         msvc_set_scripterror_policy('Exception')
  98         env = Environment(MSVC_SCRIPT_ARGS=['-thisdoesnotexist=somevalue'], MSVC_SCRIPTERROR_POLICY=None, tools=['msvc'])
  99         """
 100     ))
 101     test.run(arguments='-Q -s', status=2, stderr=None)
 102     expect = "MSVCScriptExecutionError: vc script errors detected:"
 103     test.must_contain_all(test.stderr(), expect)
 104
 105     # Test environment construction with construction variable
 106     test.write('SConstruct', textwrap.dedent(
 107         """
 108         DefaultEnvironment(tools=[])
 109         env = Environment(MSVC_SCRIPT_ARGS=['-thisdoesnotexist=somevalue'], MSVC_SCRIPTERROR_POLICY='Error', tools=['msvc'])
 110         """
 111     ))
 112     test.run(arguments='-Q -s', status=2, stderr=None)
 113     expect = "MSVCScriptExecutionError: vc script errors detected:"
 114     test.must_contain_all(test.stderr(), expect)
 115
 116     # Test environment construction with global policy
 117     test.write('SConstruct', textwrap.dedent(
 118         """
 119         from SCons.Tool.MSCommon import msvc_set_scripterror_policy
 120         DefaultEnvironment(tools=[])
 121         msvc_set_scripterror_policy('Warning')
 122         env = Environment(MSVC_SCRIPT_ARGS=['-thisdoesnotexist=somevalue'], tools=['msvc'])
 123         """
 124     ))
 125     test.run(arguments='-Q -s', status=0, stderr=None)
 126     expect = "scons: warning: vc script errors detected:"
 127     test.must_contain_all(test.stderr(), expect)
 128
 129     # Test environment construction with construction variable
 130     test.write('SConstruct', textwrap.dedent(
 131         """
 132         DefaultEnvironment(tools=[])
 133         env = Environment(MSVC_SCRIPT_ARGS=['-thisdoesnotexist=somevalue'], MSVC_SCRIPTERROR_POLICY='Warning', tools=['msvc'])
 134         """
 135     ))
 136     test.run(arguments='-Q -s', status=0, stderr=None)
 137     expect = "scons: warning: vc script errors detected:"
 138     test.must_contain_all(test.stderr(), expect)
 139
 140 test.pass_test()
 141
 142 # Local Variables:
 143 # tab-width:4
 144 # indent-tabs-mode:nil
 145 # End:
 146 # vim: set expandtab tabstop=4 shiftwidth=4: