1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
# Copyright (C) 2014 Google Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
# * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""DevTools JSDoc validator presubmit script
See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
for more details about the presubmit API built into gcl.
"""
import sys
compile_note = "Be sure to run your patch by the compile_frontend.py script prior to committing!"
def _CompileDevtoolsFrontend(input_api, output_api):
local_paths = [f.LocalPath() for f in input_api.AffectedFiles()]
# FIXME: The compilation does not actually run if injected script-related files
# have changed, as they reside in core/inspector, which is not affected
# by this presubmit.
# Once this is fixed, injected_script_externs.js
# should be added to the list of triggers.
devtools_front_end = input_api.os_path.join("devtools", "front_end")
if (any(devtools_front_end in path for path in local_paths) or
any("protocol.json" in path for path in local_paths) or
any("compile_frontend.py" in path for path in local_paths) or
any("InjectedScriptSource.js" in path for path in local_paths)):
lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
"scripts", "compile_frontend.py")
out, _ = input_api.subprocess.Popen(
[input_api.python_executable, lint_path],
stdout=input_api.subprocess.PIPE,
stderr=input_api.subprocess.STDOUT).communicate()
if "ERROR" in out or "WARNING" in out:
return [output_api.PresubmitError(out)]
if "NOTE" in out:
return [output_api.PresubmitPromptWarning(out + compile_note)]
return []
def _CheckConvertSVGToPNGHashes(input_api, output_api):
if not input_api.platform.startswith('linux'):
return []
original_sys_path = sys.path
try:
sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
import devtools_file_hashes
finally:
sys.path = original_sys_path
absolute_local_paths = [af.AbsoluteLocalPath() for af in input_api.AffectedFiles(include_deletes=False)]
images_src_path = input_api.os_path.join("devtools", "front_end", "Images", "src")
image_source_file_paths = [path for path in absolute_local_paths if images_src_path in path and path.endswith(".svg")]
image_sources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), "front_end", "Images", "src")
hashes_file_name = "svg2png.hashes"
hashes_file_path = input_api.os_path.join(image_sources_path, hashes_file_name)
invalid_hash_file_paths = devtools_file_hashes.files_with_invalid_hashes(hashes_file_path, image_source_file_paths)
if len(invalid_hash_file_paths) == 0:
return []
invalid_hash_file_names = [input_api.os_path.basename(file_path) for file_path in invalid_hash_file_paths]
file_paths_str = ", ".join(invalid_hash_file_names)
error_message = "The following SVG files should be converted to PNG using convert_svg_images_png.py script before uploading: \n - %s" % file_paths_str
return [output_api.PresubmitError(error_message)]
def _CheckOptimizePNGHashes(input_api, output_api):
if not input_api.platform.startswith('linux'):
return []
original_sys_path = sys.path
try:
sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
import devtools_file_hashes
finally:
sys.path = original_sys_path
absolute_local_paths = [af.AbsoluteLocalPath() for af in input_api.AffectedFiles(include_deletes=False)]
images_src_path = input_api.os_path.join("devtools", "front_end", "Images", "src")
image_source_file_paths = [path for path in absolute_local_paths if images_src_path in path and path.endswith(".svg")]
image_sources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), "front_end", "Images", "src")
hashes_file_name = "optimize_png.hashes"
hashes_file_path = input_api.os_path.join(image_sources_path, hashes_file_name)
invalid_hash_file_paths = devtools_file_hashes.files_with_invalid_hashes(hashes_file_path, image_source_file_paths)
if len(invalid_hash_file_paths) == 0:
return []
invalid_hash_file_names = [input_api.os_path.basename(file_path) for file_path in invalid_hash_file_paths]
file_paths_str = ", ".join(invalid_hash_file_names)
error_message = "The following PNG files should be optimized using optimize_png_images.py script before uploading: \n - %s" % file_paths_str
return [output_api.PresubmitError(error_message)]
def _CheckCSSViolations(input_api, output_api):
results = []
for f in input_api.AffectedFiles(include_deletes=False):
if not f.LocalPath().endswith(".css"):
continue
for line_number, line in f.ChangedContents():
if "/deep/" in line:
results.append(output_api.PresubmitError(("%s:%d uses /deep/ selector") % (f.LocalPath(), line_number)))
if "::shadow" in line:
results.append(output_api.PresubmitError(("%s:%d uses ::shadow selector") % (f.LocalPath(), line_number)))
return results
def CheckChangeOnUpload(input_api, output_api):
results = []
results.extend(_CompileDevtoolsFrontend(input_api, output_api))
results.extend(_CheckConvertSVGToPNGHashes(input_api, output_api))
results.extend(_CheckOptimizePNGHashes(input_api, output_api))
results.extend(_CheckCSSViolations(input_api, output_api))
return results
def CheckChangeOnCommit(input_api, output_api):
return []
|
