Patch path filtering script.

scripts/slave/apply_svn_patch.py

 #!/usr/bin/python
 # Copyright 2013 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import optparse
 import subprocess
 import sys
 
 
 def main():
   parser = optparse.OptionParser()
   parser.add_option('-p', '--patch-url',
                     help='The SVN URL to download the patch from.')
   parser.add_option('-r', '--root-dir',
                     help='The root dir in which to apply patch.')
+  parser.add_option('', '--path-filter-script',
+                    help=('A script that filter out contents of a patch. The '

[iannucci, 2013/12/05 21:40:57]

s/filter/filters/

Should also mention that the script MUST be python.

I would also make a point of passing -r, -p, and --strip-level directly through
to the filter script as the first arguments.

[kjellander_chromium, 2013/12/10 20:46:02]

I rephrased so it shouldn't be needed now. I also renamed to --filter-script to
make it a bit more generic.
Done.
I think it would be annoying to have to support arguments that are not used, so
I disagree there. However I need the --root-dir in my case, so that one is
added. Additional flags can be passed using -- --flag

+                          'script must use stdin for input and stdout for '
+                          'output.'))
+  parser.add_option('', '--path-filter',
+                    help=('The paths that shall be allowed (must specify the '
+                          'path filter script to use this).'))

[iannucci, 2013/12/05 21:40:57]

What about:

apply_svn_patch.py ... --path-filter-script cool.py -- -f something -o "special
option" ...

Then anything after the '--' gets appended to the path-filter-script's command
line, and we don't hard-code the '-f' below. Then the filter Popen could be:

index_of_dashes = sys.argv.index('--') if '--' in sys.argv else None
extra_args = ['--'] + sys.argv[index_of_dashes:] if index_of_dashes else []
Popen([sys.executable, options.path_filter_script,
 '-p', options.patch_url,
 '-r', options.root_dir,
 '--strip-level', options.strip_level] + extra_args, ...)

[kjellander_chromium, 2013/12/10 20:46:02]

I guess this makes perfect sense for --path-filter since that's only used by the
path-filter-script. However --root-dir is used both by it and the patch command.
I removed --path-filter from this file and made it pass only the --root-dir now.

The -- terminator will have to be used to pass the --path-filter flag (and
possible other flags to the script), but the implementation is much simpler as
you can see.

+  parser.add_option('', '--strip-level', type='int', default=0,
+                    help=('The number of components to be stripped from the '
+                          'filenames in the patch. Default: %default.'))
 
   options, args = parser.parse_args()
   if args:
     parser.error('Unused args: %s' % args)
   if not (options.patch_url and options.root_dir):
     parser.error('A patch URL and root directory should be specified.')
+  if ((options.path_filter_script and not options.path_filter) or
+      (options.path_filter and not options.path_filter_script)):
+    parser.error('You must specify both path filter and a path filter script '
+                 'in order to use path filtering for patches.')
 
   svn_cat = subprocess.Popen(['svn', 'cat', options.patch_url],
                              stdout=subprocess.PIPE)
-  patch = subprocess.Popen(['patch', '-t', '-p', '0', '-d', options.root_dir],
-                           stdin=svn_cat.stdout)
+  patch_input = svn_cat.stdout
+  if options.path_filter_script:
+    filtering = subprocess.Popen([sys.executable, options.path_filter_script,
+                                  '-f', options.path_filter,
+                                  '-r', options.root_dir],
+                                 stdin=svn_cat.stdout, stdout=subprocess.PIPE)
+    patch_input = filtering.stdout
+  patch = subprocess.Popen(['patch', '-t', '-p', str(options.strip_level),
+                            '-d', options.root_dir],
+                           stdin=patch_input)
 
   _, err = patch.communicate()
   return err or None
 
 
 if __name__ == '__main__':
   sys.exit(main())