test/Repository/signature-order.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 """
  28 Verify that we don't rebuild things unnecessarily when the order of
  29 signatures changes because an included file shifts from the local sandbox
  30 to a Repository and vice versa.
  31 """
  32
  33 import TestSCons
  34
  35 _exe = TestSCons._exe
  36
  37 test = TestSCons.TestSCons()
  38
  39 test.subdir('repository', 'work')
  40
  41 repository = test.workpath('repository')
  42 work_foo = test.workpath('work', 'foo' + _exe)
  43 work_foo_h = test.workpath('work', 'foo.h')
  44
  45 test.write(['work', 'SConstruct'], """
  46 Repository(r'%s')
  47 env = Environment(CPPPATH = ['.'])
  48 env.Program(target = 'foo', source = 'foo.c')
  49 """ % repository)
  50
  51 foo_h_contents = """\
  52 #define STRING1 "foo.h"
  53 """
  54
  55 bar_h_contents = """\
  56 #define STRING2 "bar.h"
  57 """
  58
  59 test.write(['repository', 'foo.h'], foo_h_contents)
  60
  61 test.write(['repository', 'bar.h'], bar_h_contents)
  62
  63 test.write(['repository', 'foo.c'], r"""
  64 #include <stdio.h>
  65 #include <stdlib.h>
  66 #include <foo.h>
  67 #include <bar.h>
  68 int
  69 main(int argc, char *argv[])
  70 {
  71         argv[argc++] = "--";
  72         printf("%s\n", STRING1);
  73         printf("%s\n", STRING2);
  74         printf("repository/foo.c\n");
  75         exit (0);
  76 }
  77 """)
  78
  79 # Make the entire repository non-writable, so we'll detect
  80 # if we try to write into it accidentally.
  81 test.writable('repository', 0)
  82
  83
  84
  85 test.run(chdir = 'work', arguments = '.')
  86
  87 test.run(program = work_foo, stdout =
  88 """foo.h
  89 bar.h
  90 repository/foo.c
  91 """)
  92
  93 test.up_to_date(chdir = 'work', arguments = '.')
  94
  95
  96
  97 # Now create the bar.h file locally, and make sure it's still up-to-date.
  98 # This will change the order in which the include files are listed when
  99 # calculating the signature; the old order was something like:
 100 #       /var/tmp/.../bar.h
 101 #       /var/tmp/.../far.h
 102 # and the new order will be:
 103 #       /var/tmp/.../far.h
 104 #       bar.h
 105 # Because we write the same bar.h file contents, this should not cause
 106 # a rebuild (because we sort the resulting signatures).
 107
 108 test.write(['work', 'bar.h'], bar_h_contents)
 109
 110 test.up_to_date(chdir = 'work', arguments = '.')
 111
 112
 113
 114 # And for good measure, write the same foo.h file locally.
 115
 116 test.write(['work', 'foo.h'], foo_h_contents)
 117
 118 test.up_to_date(chdir = 'work', arguments = '.')
 119
 120
 121
 122 test.pass_test()
 123
 124 # Local Variables:
 125 # tab-width:4
 126 # indent-tabs-mode:nil
 127 # End:
 128 # vim: set expandtab tabstop=4 shiftwidth=4: