test/VariantDir/errors.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 Validate successful handling of errors when duplicating things in
  28 VariantDirs.  This is generally when the VariantDir, or something in it,
  29 is read-only.
  30 """
  31
  32 import os
  33 import stat
  34 import sys
  35 import TestSCons
  36 from TestCmd import IS_ROOT
  37
  38 test = TestSCons.TestSCons()
  39
  40 if IS_ROOT:
  41     test.skip_test('SConscript permissions meaningless when running as root; skipping test.\n')
  42
  43 for dir in ['normal', 'ro-dir', 'ro-SConscript', 'ro-src']:
  44     test.subdir(dir, [dir, 'src'])
  45
  46     test.write([dir, 'SConstruct'], """\
  47 import os.path
  48 VariantDir('build', 'src')
  49 SConscript(os.path.join('build', 'SConscript'))
  50 """)
  51
  52     test.write([dir, 'src', 'SConscript'], """\
  53 def fake_scan(node, env, target):
  54     # We fetch the contents here, even though we don't examine
  55     # them, because get_contents() will cause the engine to
  56     # try to link the source file into the build directory,
  57     # potentially triggering a different failure case.
  58     contents = node.get_contents()
  59     return []
  60
  61 def cat(env, source, target):
  62     target = str(target[0])
  63     with open(target, "w") as f:
  64         for src in source:
  65             with open(str(src), "r") as f2:
  66                 f.write(f2.read())
  67
  68 env = Environment(BUILDERS={'Build':Builder(action=cat)},
  69                   SCANNERS=[Scanner(fake_scan, skeys = ['.in'])])
  70
  71 # Do some Node test operations to ensure no side-effects cause failures
  72 File('file.in').exists()
  73 File('file.in').is_derived()
  74
  75 env.Build('file.out', 'file.in')
  76 """)
  77
  78     test.write([dir, 'src', 'file.in'], dir + "/src/file.in\n")
  79
  80 # Just verify that the normal case works fine.
  81 test.run(chdir = 'normal', arguments = ".")
  82
  83 test.must_match(['normal', 'build', 'file.out'], "normal/src/file.in\n", mode='r')
  84
  85 # Verify the error when the VariantDir itself is read-only.  Don't bother
  86 # to test this on Windows, because the ACL (I think) still allows the
  87 # owner to create files in the directory even when it's read-only.
  88 if sys.platform != 'win32':
  89     dir = os.path.join('ro-dir', 'build')
  90     test.subdir(dir)
  91     os.chmod(dir, os.stat(dir)[stat.ST_MODE] & ~stat.S_IWUSR)
  92
  93     test.run(chdir = 'ro-dir',
  94              arguments = ".",
  95              status = 2,
  96              stderr = "scons: *** Cannot duplicate `%s' in `build': Permission denied.  Stop.\n" % os.path.join('src', 'SConscript'))
  97
  98 # Verify the error when the SConscript file within the VariantDir is
  99 # read-only.  Note that we have to make the directory read-only too,
 100 # because otherwise our duplication logic will be able to unlink
 101 # the read-only SConscript and duplicate the new one.
 102 dir = os.path.join('ro-SConscript', 'build')
 103 test.subdir(dir)
 104 SConscript = test.workpath(dir, 'SConscript')
 105 test.write(SConscript, '')
 106 os.chmod(SConscript, os.stat(SConscript)[stat.ST_MODE] & ~stat.S_IWUSR)
 107 with open(SConscript, 'r'):
 108     os.chmod(dir, os.stat(dir)[stat.ST_MODE] & ~stat.S_IWUSR)
 109
 110     test.run(chdir = 'ro-SConscript',
 111              arguments = ".",
 112              status = 2,
 113              stderr = "scons: *** Cannot duplicate `%s' in `build': Permission denied.  Stop.\n" % os.path.join('src', 'SConscript'))
 114
 115     os.chmod('ro-SConscript', os.stat('ro-SConscript')[stat.ST_MODE] | stat.S_IWUSR)
 116
 117 test.run(chdir = 'ro-SConscript',
 118          arguments = ".",
 119          status = 2,
 120          stderr = "scons: *** Cannot duplicate `%s' in `build': Permission denied.  Stop.\n" % os.path.join('src', 'SConscript'))
 121
 122 # Verify the error when the source file within the VariantDir is
 123 # read-only.  Note that we have to make the directory read-only too,
 124 # because otherwise our duplication logic will be able to unlink the
 125 # read-only source file and duplicate the new one.  But because we've
 126 # made the VariantDir read-only, we must also create a writable SConscript
 127 # file there so it can be duplicated from the source directory.
 128 dir = os.path.join('ro-src', 'build')
 129 test.subdir(dir)
 130 test.write([dir, 'SConscript'], '')
 131 file_in = test.workpath(dir, 'file.in')
 132 test.write(file_in, '')
 133 os.chmod(file_in, os.stat(file_in)[stat.ST_MODE] & ~stat.S_IWUSR)
 134 with open(file_in, 'r'):
 135     os.chmod(dir, os.stat(dir)[stat.ST_MODE] & ~stat.S_IWUSR)
 136
 137     test.run(chdir = 'ro-src',
 138              arguments = ".",
 139              status = 2,
 140              stderr = """\
 141 scons: *** Cannot duplicate `%s' in `build': Permission denied.  Stop.
 142 """ % (os.path.join('src', 'file.in')))
 143
 144     test.run(chdir = 'ro-src',
 145              arguments = "-k .",
 146              status = 2,
 147              stderr = """\
 148 scons: *** Cannot duplicate `%s' in `build': Permission denied.  Stop.
 149 """ % (os.path.join('src', 'file.in')))
 150
 151 # ensure that specifying multiple source directories for one
 152 # build directory results in an error message, rather
 153 # than just silently failing.
 154 test.subdir('duplicate', ['duplicate', 'src1'], ['duplicate', 'src2'])
 155
 156 duplicate_SConstruct_path = test.workpath('duplicate', 'SConstruct')
 157
 158 test.write(duplicate_SConstruct_path, """\
 159 VariantDir('build', 'src1')
 160 VariantDir('build', 'src2')
 161 """)
 162
 163 expect_stderr = """
 164 scons: *** 'build' already has a source directory: 'src1'.
 165 """ + test.python_file_line(duplicate_SConstruct_path, 2)
 166
 167 test.run(chdir = 'duplicate',
 168          arguments = ".",
 169          status = 2,
 170          stderr = expect_stderr)
 171
 172 test.pass_test()
 173
 174 # Local Variables:
 175 # tab-width:4
 176 # indent-tabs-mode:nil
 177 # End:
 178 # vim: set expandtab tabstop=4 shiftwidth=4: