text: #!/usr/bin/env python
  #
  # Copyright (c) 2001 - 2016 The SCons Foundation
  #
  # Permission is hereby granted, free of charge, to any person obtaining
  # a copy of this software and associated documentation files (the
  # "Software"), to deal in the Software without restriction, including
  # without limitation the rights to use, copy, modify, merge, publish,
  # distribute, sublicense, and/or sell copies of the Software, and to
  # permit persons to whom the Software is furnished to do so, subject to
  # the following conditions:
  #
  # The above copyright notice and this permission notice shall be included
  # in all copies or substantial portions of the Software.
  #
  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  #
  
  __revision__ = "test/implicit-cache/basic.py rel_2.5.1:3735:9dc6cee5c168 2016/11/03 14:02:02 bdbaddog"
  
  """
  Verify basic interactions of the --implicit-cache-* options.
  
  This test used to set TargetSignatures('build') because we were
  relying on the old behavior of non-essential changes in .h files
  propagate to cause a rebuilt executable.  We now just rely on
  the default Decider('content') behavior and only check for the
  rebuild of the object file itself when necessary.
  """
  
  import os.path
  
  import TestSCons
  
  _exe = TestSCons._exe
  _obj = TestSCons._obj
  
  prog = 'prog' + _exe
  subdir_prog = os.path.join('subdir', 'prog' + _exe)
  variant_prog = os.path.join('variant', 'prog' + _exe)
  variant_prog_obj = os.path.join('variant', 'prog' + _obj)
  
  args = prog + ' ' + subdir_prog + ' ' + variant_prog
  
  test = TestSCons.TestSCons()
  
  test.subdir('include', 'subdir', ['subdir', 'include'], 'inc2')
  
  test.write('SConstruct', """
  env = Environment(CPPPATH = Split('inc2 include'))
  obj = env.Object(target='prog', source='subdir/prog.c')
  env.Program(target='prog', source=obj)
  SConscript('subdir/SConscript', "env")
  
  VariantDir('variant', 'subdir', 0)
  include = Dir('include')
  env = Environment(CPPPATH=['inc2', include])
  SConscript('variant/SConscript', "env")
  
  def copy(target, source, env):
      open(str(target[0]), 'wt').write(open(str(source[0]), 'rt').read())
  nodep = env.Command('nodeps.c', 'nodeps.in', action=copy)
  env.Program('nodeps', 'nodeps.c')
  
  env.Object(['one', 'two'], ['one.c'])
  """)
  
  test.write(['subdir', 'SConscript'],
  """
  Import("env")
  env.Program(target='prog', source='prog.c')
  """)
  
  test.write('nodeps.in', r"""
  int
  main(int argc, char *argv[])
  {
      argv[argc++] = "--";
      return 0;
  }
  """)
  
  
  test.write(['include', 'foo.h'], r"""
  #define FOO_STRING "include/foo.h 1\n"
  #include <bar.h>
  """)
  
  test.write(['include', 'bar.h'], r"""
  #define BAR_STRING "include/bar.h 1\n"
  """)
  
  test.write(['include', 'baz.h'], r"""
  #define BAZ_STRING "include/baz.h 1\n"
  """)
  
  test.write(['subdir', 'prog.c'], r"""
  #include <foo.h>
  #include <stdio.h>
  
  int
  main(int argc, char *argv[])
  {
      argv[argc++] = "--";
      printf("subdir/prog.c\n");
      printf(FOO_STRING);
      printf(BAR_STRING);
      return 0;
  }
  """)
  
  test.write(['subdir', 'include', 'foo.h'], r"""
  #define FOO_STRING "subdir/include/foo.h 1\n"
  #include "bar.h"
  """)
  
  test.write(['subdir', 'include', 'bar.h'], r"""
  #define BAR_STRING "subdir/include/bar.h 1\n"
  """)
  
  test.write('one.c' , r"""
  #include <foo.h>
  
  void one(void) { }
  """)
  
  test.run(arguments = "--implicit-cache " + args)
  
  test.run(program = test.workpath(prog),
           stdout = "subdir/prog.c\ninclude/foo.h 1\ninclude/bar.h 1\n")
  
  test.run(program = test.workpath(subdir_prog),
           stdout = "subdir/prog.c\nsubdir/include/foo.h 1\nsubdir/include/bar.h 1\n")
  
  test.run(program = test.workpath(variant_prog),
           stdout = "subdir/prog.c\ninclude/foo.h 1\ninclude/bar.h 1\n")
  
  test.up_to_date(arguments = args)
  
  
  
  # Make sure implicit dependencies work right when one is modifed:
  test.write(['include', 'foo.h'], r"""
  #define FOO_STRING "include/foo.h 2\n"
  #include "bar.h"
  """)
  
  test.run(arguments = "--implicit-cache " + args)
  
  test.run(program = test.workpath(prog),
           stdout = "subdir/prog.c\ninclude/foo.h 2\ninclude/bar.h 1\n")
  
  test.run(program = test.workpath(subdir_prog),
           stdout = "subdir/prog.c\nsubdir/include/foo.h 1\nsubdir/include/bar.h 1\n")
  
  test.run(program = test.workpath(variant_prog),
           stdout = "subdir/prog.c\ninclude/foo.h 2\ninclude/bar.h 1\n")
  
  test.up_to_date(arguments = args)
  
  
  
  # Make sure that changing the order of includes causes rebuilds and
  # doesn't produce redundant rebuilds:
  test.write(['include', 'foo.h'], r"""
  #define FOO_STRING "include/foo.h 2\n"
  #include "bar.h"
  #include "baz.h"
  """)
  
  test.run(arguments = "--implicit-cache " + args)
  
  test.run(program = test.workpath(prog),
           stdout = "subdir/prog.c\ninclude/foo.h 2\ninclude/bar.h 1\n")
  
  test.run(program = test.workpath(subdir_prog),
           stdout = "subdir/prog.c\nsubdir/include/foo.h 1\nsubdir/include/bar.h 1\n")
  
  test.run(program = test.workpath(variant_prog),
           stdout = "subdir/prog.c\ninclude/foo.h 2\ninclude/bar.h 1\n")
  
  test.up_to_date(arguments = args)
  
  
  
  test.write(['include', 'foo.h'], r"""
  #define FOO_STRING "include/foo.h 2\n"
  #include "baz.h"
  #include "bar.h"
  """)
  
  test.run(arguments = "--implicit-cache " + args)
  
  test.run(program = test.workpath(prog),
           stdout = "subdir/prog.c\ninclude/foo.h 2\ninclude/bar.h 1\n")
  
  test.run(program = test.workpath(subdir_prog),
           stdout = "subdir/prog.c\nsubdir/include/foo.h 1\nsubdir/include/bar.h 1\n")
  
  test.run(program = test.workpath(variant_prog),
           stdout = "subdir/prog.c\ninclude/foo.h 2\ninclude/bar.h 1\n")
  
  test.up_to_date(arguments = args)
  
  
  
  # Add inc2/foo.h that should shadow include/foo.h, but
  # because of implicit dependency caching, scons doesn't
  # detect this:
  test.write(['inc2', 'foo.h'], r"""
  #define FOO_STRING "inc2/foo.h 1\n"
  #include <bar.h>
  """)
  
  test.run(arguments = "--implicit-cache " + args)
  
  test.run(program = test.workpath(prog),
           stdout = "subdir/prog.c\ninclude/foo.h 2\ninclude/bar.h 1\n")
  
  test.run(program = test.workpath(subdir_prog),
           stdout = "subdir/prog.c\nsubdir/include/foo.h 1\nsubdir/include/bar.h 1\n")
  
  test.run(program = test.workpath(variant_prog),
           stdout = "subdir/prog.c\ninclude/foo.h 2\ninclude/bar.h 1\n")
  
  
  
  # Now modifying include/foo.h should make scons aware of inc2/foo.h
  test.write(['include', 'foo.h'], r"""
  #define FOO_STRING "include/foo.h 3\n"
  #include "bar.h"
  """)
  
  test.run(arguments = "--implicit-cache " + args)
  
  test.run(program = test.workpath(prog),
           stdout = "subdir/prog.c\ninc2/foo.h 1\ninclude/bar.h 1\n")
  
  test.run(program = test.workpath(subdir_prog),
           stdout = "subdir/prog.c\nsubdir/include/foo.h 1\nsubdir/include/bar.h 1\n")
  
  test.run(program = test.workpath(variant_prog),
           stdout = "subdir/prog.c\ninclude/foo.h 3\ninclude/bar.h 1\n")
  
  
  
  # test a file with no dependencies where the source file is generated:
  test.run(arguments = "--implicit-cache nodeps%s"%_exe)
  
  test.write('nodeps.in', r"""
  #include <foo.h>
  
  int
  main(int argc, char *argv[])
  {
      argv[argc++] = "--";
      return 0;
  }
  """)
  
  test.run(arguments = "--implicit-cache one%s"%_obj)
  
  
  
  # Test forcing of implicit caching:
  test.write(['include', 'foo.h'], r"""
  #define FOO_STRING "include/foo.h 3\n"
  #include "bar.h"
  """)
  
  # Cache the dependencies of prog_obj:  foo.h and its included bar.h.
  test.run(arguments = "--implicit-cache " + args)
  
  # Now add baz.h to the implicit dependencies in foo.h.
  test.write(['include', 'foo.h'], r"""
  #define FOO_STRING "include/foo.h 3\n"
  #include "baz.h"
  #include "bar.h"
  """)
  
  # Rebuild variant_prog_obj because the already-cached foo.h changed,
  # but use --implicit-deps-unchanged to avoid noticing the addition
  # of baz.h to the implicit dependencies.
  test.not_up_to_date(options = "--implicit-deps-unchanged",
                      arguments = variant_prog_obj)
  
  test.write(['include', 'baz.h'], r"""
  #define BAZ_STRING "include/baz.h 2\n"
  """)
  
  # variant_prog_obj is still up to date, because it doesn't know about
  # baz.h and therefore the change we just made to it.
  test.up_to_date(options = "--implicit-deps-unchanged",
                  arguments = variant_prog_obj)
  
  # Now rebuild it normally.
  test.not_up_to_date(arguments = variant_prog_obj)
  
  # And rebuild its executable, just so everything's normal.
  test.run(arguments = variant_prog)
  
  
  # Test forcing rescanning:
  test.write(['include', 'foo.h'], r"""
  #define FOO_STRING "include/foo.h 3\n"
  #include "bar.h"
  """)
  
  test.run(arguments = "--implicit-cache " + args)
  
  test.write(['include', 'foo.h'], r"""
  #define FOO_STRING "include/foo.h 3\n"
  #include "baz.h"
  #include "bar.h"
  """)
  
  test.not_up_to_date(options = "--implicit-deps-unchanged",
                      arguments = variant_prog_obj)
  
  test.write(['include', 'baz.h'], r"""
  #define BAZ_STRING "include/baz.h 2\n"
  """)
  
  test.up_to_date(options = "--implicit-deps-unchanged",
                  arguments = variant_prog_obj)
  
  test.not_up_to_date(options = "--implicit-deps-changed",
                      arguments = variant_prog_obj)
  
  
  
  test.pass_test()
  
  # Local Variables:
  # tab-width:4
  # indent-tabs-mode:nil
  # End:
  # vim: set expandtab tabstop=4 shiftwidth=4:
  