ppapi/PRESUBMIT.py

# Copyright (c) 2012 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 os
import sys
import subprocess

def RunCmdAndCheck(cmd, err_string, output_api, cwd=None):
  results = []
  p = subprocess.Popen(cmd, cwd=cwd,
                       stdout=subprocess.PIPE,
                       stderr=subprocess.PIPE)
  (p_stdout, p_stderr) = p.communicate()
  if p.returncode:
    results.append(
        output_api.PresubmitError(err_string,
                                  long_text=p_stderr))
  return results


def RunUnittests(input_api, output_api):
  # Run some Generator unittests if the generator source was changed.
  results = []
  files = input_api.LocalPaths()
  generator_files = []
  for filename in files:
    name_parts = filename.split(os.sep)
    if name_parts[0:2] == ['ppapi', 'generators']:
      generator_files.append(filename)
  if generator_files != []:
    cmd = [ sys.executable, 'idl_gen_pnacl.py', '--wnone', '--test']
    ppapi_dir = input_api.PresubmitLocalPath()
    results.extend(RunCmdAndCheck(cmd,
                                  'PPAPI IDL Pnacl unittest failed.',
                                  output_api,
                                  os.path.join(ppapi_dir, 'generators')))
  return results


# If any .srpc files were changed, run run_srpcgen.py --diff_mode.
def CheckSrpcChange(input_api, output_api):
  if [True for filename in input_api.LocalPaths() if
      os.path.splitext(filename)[1] == '.srpc']:
    return RunCmdAndCheck([sys.executable,
                           os.path.join(input_api.PresubmitLocalPath(),
                                        'native_client', 'src',
                                        'shared', 'ppapi_proxy',
                                        'run_srpcgen.py'),
                           '--diff_mode'],
                          'PPAPI SRPC Diff detected: Run run_srpcgen.py.',
                          output_api)
  return []

def CheckChange(input_api, output_api):
  results = []

  results.extend(CheckSrpcChange(input_api, output_api))

  results.extend(RunUnittests(input_api, output_api))

  # Verify all modified *.idl have a matching *.h
  files = input_api.LocalPaths()
  h_files = []
  idl_files = []

  for filename in files:
    name, ext = os.path.splitext(filename)
    name_parts = name.split(os.sep)
    if name_parts[0:2] == ['ppapi', 'c'] and ext == '.h':
      h_files.append('/'.join(name_parts[2:]))
    if name_parts[0:2] == ['ppapi', 'api'] and ext == '.idl':
      idl_files.append('/'.join(name_parts[2:]))

  # Generate a list of all appropriate *.h and *.idl changes in this CL.
  both = h_files + idl_files

  # If there aren't any, we are done checking.
  if not both: return results

  missing = []
  for filename in idl_files:
    if filename not in set(h_files):
      missing.append('  ppapi/c/%s.h' % filename)
  for filename in h_files:
    if filename not in set(idl_files):
      missing.append('  ppapi/api/%s.idl' % filename)

  if missing:
    results.append(
        output_api.PresubmitPromptWarning('Missing matching PPAPI definition:',
                                          long_text='\n'.join(missing)))

  # Verify all *.h files match *.idl definitions, use:
  #   --test to prevent output to disk
  #   --diff to generate a unified diff
  #   --out to pick which files to examine (only the ones in the CL)
  ppapi_dir = input_api.PresubmitLocalPath()
  cmd = [ sys.executable, 'generator.py',
          '--wnone', '--diff', '--test','--cgen', '--range=start,end']

  # Only generate output for IDL files references (as *.h or *.idl) in this CL
  cmd.append('--out=' + ','.join([name + '.idl' for name in both]))
  results.extend(RunCmdAndCheck(cmd,
                                'PPAPI IDL Diff detected: Run the generator.',
                                output_api,
                                os.path.join(ppapi_dir, 'generators')))
  return results

def CheckChangeOnUpload(input_api, output_api):
#  return []
  return CheckChange(input_api, output_api)

def CheckChangeOnCommit(input_api, output_api):
#  return []
  return CheckChange(input_api, output_api)