547012dc05
The motivation for this CL is because it is not very obvious on how to submit when tree is closed in git. Also added a section 'How to submit when tree is closed' in https://sites.google.com/site/skiadocs/developer-documentation/tree-sheriff (SkipBuildbotRuns) Review URL: https://codereview.chromium.org/13932026 git-svn-id: http://skia.googlecode.com/svn/trunk@8666 2bbb7eff-a529-9590-31e7-b0007b416f81
114 lines
4.0 KiB
Python
114 lines
4.0 KiB
Python
# Copyright (c) 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.
|
|
|
|
|
|
"""Top-level presubmit script for Skia.
|
|
|
|
See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
|
|
for more details about the presubmit API built into gcl.
|
|
"""
|
|
|
|
import os
|
|
import sys
|
|
|
|
|
|
SKIA_TREE_STATUS_URL = 'http://skia-tree-status.appspot.com'
|
|
|
|
|
|
def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
|
|
"""Checks that files end with atleast one \n (LF)."""
|
|
eof_files = []
|
|
for f in input_api.AffectedSourceFiles(source_file_filter):
|
|
contents = input_api.ReadFile(f, 'rb')
|
|
# Check that the file ends in atleast one newline character.
|
|
if len(contents) > 1 and contents[-1:] != '\n':
|
|
eof_files.append(f.LocalPath())
|
|
|
|
if eof_files:
|
|
return [output_api.PresubmitPromptWarning(
|
|
'These files should end in a newline character:',
|
|
items=eof_files)]
|
|
return []
|
|
|
|
|
|
def _CommonChecks(input_api, output_api):
|
|
"""Presubmit checks common to upload and commit."""
|
|
results = []
|
|
sources = lambda x: (x.LocalPath().endswith('.h') or
|
|
x.LocalPath().endswith('.gypi') or
|
|
x.LocalPath().endswith('.gyp') or
|
|
x.LocalPath().endswith('.py') or
|
|
x.LocalPath().endswith('.sh') or
|
|
x.LocalPath().endswith('.cpp'))
|
|
results.extend(
|
|
_CheckChangeHasEol(
|
|
input_api, output_api, source_file_filter=sources))
|
|
return results
|
|
|
|
|
|
def CheckChangeOnUpload(input_api, output_api):
|
|
"""Presubmit checks for the change on upload.
|
|
|
|
The following are the presubmit checks:
|
|
* Check change has one and only one EOL.
|
|
"""
|
|
results = []
|
|
results.extend(_CommonChecks(input_api, output_api))
|
|
return results
|
|
|
|
|
|
def _CheckTreeStatus(input_api, output_api, json_url):
|
|
"""Check whether to allow commit.
|
|
|
|
Args:
|
|
input_api: input related apis.
|
|
output_api: output related apis.
|
|
json_url: url to download json style status.
|
|
"""
|
|
tree_status_results = input_api.canned_checks.CheckTreeIsOpen(
|
|
input_api, output_api, json_url=json_url)
|
|
if not tree_status_results:
|
|
# Check for caution state only if tree is not closed.
|
|
connection = input_api.urllib2.urlopen(json_url)
|
|
status = input_api.json.loads(connection.read())
|
|
connection.close()
|
|
if ('caution' in status['message'].lower() and
|
|
os.isatty(sys.stdout.fileno())):
|
|
# Display a prompt only if we are in an interactive shell. Without this
|
|
# check the commit queue behaves incorrectly because it considers
|
|
# prompts to be failures.
|
|
short_text = 'Tree state is: ' + status['general_state']
|
|
long_text = status['message'] + '\n' + json_url
|
|
tree_status_results.append(
|
|
output_api.PresubmitPromptWarning(
|
|
message=short_text, long_text=long_text))
|
|
else:
|
|
# Tree status is closed. Put in message about contacting sheriff.
|
|
connection = input_api.urllib2.urlopen(
|
|
SKIA_TREE_STATUS_URL + '/current-sheriff')
|
|
sheriff_details = input_api.json.loads(connection.read())
|
|
if sheriff_details:
|
|
tree_status_results[0]._message += (
|
|
'\n\nPlease contact the current Skia sheriff (%s) if you are trying '
|
|
'to submit a build fix\nand do not know how to submit because the '
|
|
'tree is closed') % sheriff_details['username']
|
|
return tree_status_results
|
|
|
|
|
|
def CheckChangeOnCommit(input_api, output_api):
|
|
"""Presubmit checks for the change on commit.
|
|
|
|
The following are the presubmit checks:
|
|
* Check change has one and only one EOL.
|
|
* Ensures that the Skia tree is open in
|
|
http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
|
|
state and an error if it is in 'Closed' state.
|
|
"""
|
|
results = []
|
|
results.extend(_CommonChecks(input_api, output_api))
|
|
results.extend(
|
|
_CheckTreeStatus(input_api, output_api, json_url=(
|
|
SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
|
|
return results
|