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

pylib/gyp/generator/msvs.py

Index: pylib/gyp/generator/msvs.py
diff --git a/pylib/gyp/generator/msvs.py b/pylib/gyp/generator/msvs.py
index c61142ea9748f9e6975d8cfb8ee3898be5c3983b..513f4869af5c6f4f3a2ef17ff9c5eb8fc12ae0f2 100644
--- a/pylib/gyp/generator/msvs.py
+++ b/pylib/gyp/generator/msvs.py
@@ -880,6 +880,8 @@ def _GenerateMSVSProject(project, options, version, generator_flags):
   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():
@@ -905,7 +907,8 @@ def _GenerateMSVSProject(project, options, version, generator_flags):
 
   _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)
 
@@ -1441,13 +1444,21 @@ def _HandlePreCompiledHeaders(p, sources, spec):
     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,
@@ -2892,9 +2903,6 @@ def _GenerateMSBuildProject(project, options, version, generator_flags):
   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.
@@ -2912,7 +2920,7 @@ def _GenerateMSBuildProject(project, options, version, generator_flags):
                                                 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.