MSVS: Fix to ensure that actions are re-run when the action command changes

pylib/gyp/generator/msvs.py

 # Copyright (c) 2012 Google Inc. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import copy
 import ntpath
 import os
 import posixpath
 import re
 import subprocess
@@ skipping 862 matching lines @@
     os.makedirs(vcproj_dir)
 
   platforms = _GetUniquePlatforms(spec)
   p = MSVSProject.Writer(project.path, version, spec['target_name'],
                          project.guid, platforms)
 
   # Get directory project file is in.
   project_dir = os.path.split(project.path)[0]
   gyp_path = _NormalizedSource(project.build_file)
   relative_path_of_gyp_file = gyp.common.RelativePath(gyp_path, project_dir)
+  relative_path_of_vcproj_file = \
+      gyp.common.RelativePath(project.path, project_dir)
 
   config_type = _GetMSVSConfigurationType(spec, project.build_file)
   for config_name, config in spec['configurations'].iteritems():
     _AddConfigurationToMSVSProject(p, spec, config_type, config_name, config)
 
   # Prepare list of sources and excluded sources.
   gyp_file = os.path.split(project.build_file)[1]
   sources, excluded_sources = _PrepareListOfSources(spec, gyp_file)
 
   # Add rules.
   actions_to_add = {}
   _GenerateRulesForMSVS(p, project_dir, options, spec,
                         sources, excluded_sources,
                         actions_to_add)
   list_excluded = generator_flags.get('msvs_list_excluded_files', True)
   sources, excluded_sources, excluded_idl = (
       _AdjustSourcesAndConvertToFilterHierarchy(
           spec, options, project_dir, sources, excluded_sources, list_excluded))
 
   # Add in files.
   missing_sources = _VerifySourcesExist(sources, project_dir)
   p.AddFiles(sources)
 
   _AddToolFilesToMSVS(p, spec)
   _HandlePreCompiledHeaders(p, sources, spec)
-  _AddActions(actions_to_add, spec, relative_path_of_gyp_file)
+  _AddActions(actions_to_add, spec, relative_path_of_gyp_file,
+              relative_path_of_vcproj_file)
   _AddCopies(actions_to_add, spec)
   _WriteMSVSUserFile(project.path, version, spec)
 
   # NOTE: this stanza must appear after all actions have been decided.
   # Don't excluded sources with actions attached, or they won't run.
   excluded_sources = _FilterActionsFromExcluded(
       excluded_sources, actions_to_add)
   _ExcludeFilesFromBeingBuilt(p, spec, excluded_sources, excluded_idl,
                               list_excluded)
   _AddAccumulatedActionsToMSVS(p, spec, actions_to_add)
@@ skipping 515 matching lines @@
                                     {'UsePrecompiledHeader': '0',
                                      'ForcedIncludeFiles': '$(NOINHERIT)'})
             p.AddFileConfig(_FixPath(source),
                             _ConfigFullName(config_name, config),
                             {}, tools=[tool])
   # Do nothing if there was no precompiled source.
   if extensions_excluded_from_precompile:
     DisableForSourceTree(sources)
 
 
-def _AddActions(actions_to_add, spec, relative_path_of_gyp_file):
+def _AddActions(actions_to_add, spec, relative_path_of_gyp_file,
+                relative_path_of_project_file):
   # Add actions.
   actions = spec.get('actions', [])
   for a in actions:
     cmd = _BuildCommandLineForRule(spec, a, has_input_path=False)
     # Attach actions to the gyp file if nothing else is there.
     inputs = a.get('inputs') or [relative_path_of_gyp_file]

[jeanluc1, 2012/05/02 23:50:24]

I'm curious... what was the problem with only using
relative_path_of_project_file?

[Mark Seaborn, 2012/05/03 00:39:20]

The trybot failures were caused by my change after all.  The original version of
the change in patchset 1 failed in the case where an action's "inputs" field is
empty, which was covered by test\intermediate_dir\gyptest-intermediate-dir.py.

The generator has to choose an input file for the action to hang off of
(inputs[0] is picked in _AddActionStep()), and the chosen file has to be a
target known by the check in AddFileConfig(), otherwise it fails like this:

Traceback (most recent call last):
  File "E:\b\build\slave\gyp\build\trunk\/gyp", line 18, in <module>
    sys.exit(gyp.main(sys.argv[1:]))
  File "E:\b\build\slave\gyp\build\trunk\pylib\gyp\__init__.py", line 480, in
main
    generator.GenerateOutput(flat_list, targets, data, params)
  File "E:\b\build\slave\gyp\build\trunk\pylib\gyp\generator\msvs.py", line
1788, in GenerateOutput
    generator_flags))
  File "E:\b\build\slave\gyp\build\trunk\pylib\gyp\generator\msvs.py", line 858,
in _GenerateProject
    return _GenerateMSVSProject(project, options, version, generator_flags)
  File "E:\b\build\slave\gyp\build\trunk\pylib\gyp\generator\msvs.py", line 918,
in _GenerateMSVSProject
    _AddAccumulatedActionsToMSVS(p, spec, actions_to_add)
  File "E:\b\build\slave\gyp\build\trunk\pylib\gyp\generator\msvs.py", line 418,
in _AddAccumulatedActionsToMSVS
    cmd=command)
  File "E:\b\build\slave\gyp\build\trunk\pylib\gyp\generator\msvs.py", line 388,
in _AddCustomBuildToolForMSVS
    _ConfigFullName(config_name, c_data), tools=[tool])
  File "E:\b\build\slave\gyp\build\trunk\pylib\gyp\MSVSProject.py", line 181, in
AddFileConfig
    raise ValueError('AddFileConfig: file "%s" not in project.' % path)
ValueError: AddFileConfig: file "target1.vcproj" not in project.

+    # Additionally, we mark the project file as a dependency of the
+    # action so that when the action's command changes, the action
+    # will get re-run even if no other input files change.  However,
+    # this will re-run unchanged actions unnecessarily when the
+    # project file changes.
+    # TODO(mseaborn): Detect changes at a finer granularity.
+    inputs = inputs + [relative_path_of_project_file]
     # Add the action.
     _AddActionStep(actions_to_add,
                    inputs=inputs,
                    outputs=a.get('outputs', []),
                    description=a.get('message', a['action_name']),
                    command=cmd)
 
 
 def _WriteMSVSUserFile(project_path, version, spec):
   # Add run_as and test targets.
@@ skipping 1424 matching lines @@
 
 
 def _GenerateMSBuildProject(project, options, version, generator_flags):
   spec = project.spec
   configurations = spec['configurations']
   project_dir, project_file_name = os.path.split(project.path)
   msbuildproj_dir = os.path.dirname(project.path)
   if msbuildproj_dir and not os.path.exists(msbuildproj_dir):
     os.makedirs(msbuildproj_dir)
   # Prepare list of sources and excluded sources.
-  gyp_path = _NormalizedSource(project.build_file)
-  relative_path_of_gyp_file = gyp.common.RelativePath(gyp_path, project_dir)
-
   gyp_file = os.path.split(project.build_file)[1]
   sources, excluded_sources = _PrepareListOfSources(spec, gyp_file)
   # Add rules.
   actions_to_add = {}
   props_files_of_rules = set()
   targets_files_of_rules = set()
   extension_to_rule_name = {}
   list_excluded = generator_flags.get('msvs_list_excluded_files', True)
   _GenerateRulesForMSBuild(project_dir, options, spec,
                            sources, excluded_sources,
                            props_files_of_rules, targets_files_of_rules,
                            actions_to_add, extension_to_rule_name)
   sources, excluded_sources, excluded_idl = (
       _AdjustSourcesAndConvertToFilterHierarchy(spec, options,
                                                 project_dir, sources,
                                                 excluded_sources,
                                                 list_excluded))
-  _AddActions(actions_to_add, spec, project.build_file)
+  _AddActions(actions_to_add, spec, project.build_file, project.path)
   _AddCopies(actions_to_add, spec)
 
   # NOTE: this stanza must appear after all actions have been decided.
   # Don't excluded sources with actions attached, or they won't run.
   excluded_sources = _FilterActionsFromExcluded(
       excluded_sources, actions_to_add)
 
   exclusions = _GetExcludedFilesFromBuild(spec, excluded_sources, excluded_idl)
   actions_spec, sources_handled_by_action = _GenerateActionsForMSBuild(
       spec, actions_to_add)
@@ skipping 121 matching lines @@
   action_spec.extend(
       # TODO(jeanluc) 'Document' for all or just if as_sources?
       [['FileType', 'Document'],
        ['Command', command],
        ['Message', description],
        ['Outputs', outputs]
       ])
   if additional_inputs:
     action_spec.append(['AdditionalInputs', additional_inputs])
   actions_spec.append(action_spec)