aiden
/
depot_tools
mirror of https://chromium.googlesource.com/chromium/tools/depot_tools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revert "Use git_dependencies variable in gitlink check"

Browse Source 
This reverts commit a83906be85.

Reason for revert: may break presubmit checks in some cases

Original change's description:
> Use git_dependencies variable in gitlink check
>
> The old implementation was written before gclient got git_dependencies
> property. Instead of relying on arbitrary string, use actual content of
> git_dependencies.
>
> R=jojwang@google.com
>
> Change-Id: Iea90e531ac6e9a9aaf58ca1dc73347692448107a
> Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/4818788
> Commit-Queue: Josip Sokcevic <sokcevic@chromium.org>
> Reviewed-by: Joanna Wang <jojwang@chromium.org>

Change-Id: I526a633b0bda647684ed87888ead9d02e24e9da4
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/4818794
Bot-Commit: Rubber Stamper <rubber-stamper@appspot.gserviceaccount.com>
Auto-Submit: Josip Sokcevic <sokcevic@chromium.org>
Commit-Queue: Rubber Stamper <rubber-stamper@appspot.gserviceaccount.com>
changes/94/4818794/2
Josip Sokcevic 2 years ago committed by LUCI CQ
parent a83906be85
commit f69f58e2c8
1 changed files with 62 additions and 87 deletions
Show Stats Download Patch File Download Diff File

149
presubmit_canned_checks.py
Unescape Escape View File

@ -1699,18 +1699,21 @@ def CheckCIPDClientDigests(input_api, output_api, client_version_file):
def CheckForCommitObjects(input_api, output_api):
"""Validates that commit objects match DEPS.
"""Validates that there are no commit objects in the repository.
Commit objects are put into the git tree typically by submodule tooling.
Because we use gclient to handle external repository references instead,
we want to ensure DEPS content and Git are in sync when desired.
we want to avoid this. Having commit objects in the tree can confuse git
tooling in some scenarios into thinking that the tree is dirty (e.g. the
presence of a DEPS subrepo at a location where a commit object is stored
in the tree).
Args:
input_api: Bag of input related interfaces.
output_api: Bag of output related interfaces.
Returns:
A presubmit error if a commit object is not expected.
A presubmit error if a commit object is present in the tree.
"""
def parse_tree_entry(ent):
@ -1727,96 +1730,68 @@ def CheckForCommitObjects(input_api, output_api):
return (spaceparts[0], spaceparts[1], spaceparts[2], tabparts[1])
full_tree = input_api.subprocess.check_output(
['git', 'ls-tree', '-r', '--full-tree', '-z', 'HEAD'],
cwd=input_api.PresubmitLocalPath())
['git', 'ls-tree', '-r', '--full-tree', 'HEAD'],
cwd=input_api.PresubmitLocalPath()
).decode('utf8')
# deps_entry holds tree entry for the root DEPS file.
deps_entry = None
# commit_tree_entries holds all commit entries (ie gitlink, submodule record).
commit_tree_entries = []
for entry in full_tree.strip().split(b'\00'):
if not entry.startswith(b'160000'):
# Remove entries that we don't care about. 160000 indicates a gitlink.
continue
tree_entry = parse_tree_entry(entry.decode('utf-8'))
for entry in full_tree.strip().split('\n'):
tree_entry = parse_tree_entry(entry)
if tree_entry[1] == 'commit':
commit_tree_entries.append(tree_entry)
if tree_entry[3] == 'DEPS':
deps_entry = tree_entry
if len(commit_tree_entries) > 0:
if not deps_entry:
# No DEPS file, carry on!
return []
# This gets DEPS file from HEAD (the same as local DEPS file if there's no
# modification).
deps_content = input_api.subprocess.check_output(
['git', 'cat-file', 'blob', deps_entry[2]],
cwd=input_api.PresubmitLocalPath()).decode('utf8')
if 'use_git_submodules' in deps_content:
# git submodule is source of truth, so no further action needed.
return []
if not 'SUBMODULE_MIGRATION' in deps_content:
commit_tree_entries = [x[3] for x in commit_tree_entries]
return [
output_api.PresubmitError(
'Commit objects present within tree.\n'
'This may be due to submodule-related interactions;\n'
'the presence of a commit object in the tree may lead to odd\n'
'situations where files are inconsistently checked-out.\n'
'Remove these commit entries and validate your changeset '
'again:\n', commit_tree_entries)
]
# No gitlinks found, return early.
if len(commit_tree_entries) == 0:
return []
# This gets DEPS file.
deps_file = input_api.os_path.join(input_api.PresubmitLocalPath(), 'DEPS')
if not input_api.os_path.isfile(deps_file):
# No DEPS file, carry on!
return []
with open(deps_file) as f:
deps_content = f.read()
deps = _ParseDeps(deps_content)
if not 'git_dependencies' in deps or deps['git_dependencies'] == 'DEPS':
commit_tree_entries = [x[3] for x in commit_tree_entries]
return [
output_api.PresubmitError(
'Commit objects present within tree.\n'
'This may be due to submodule-related interactions;\n'
'the presence of a commit object in the tree may lead to odd\n'
'situations where files are inconsistently checked-out.\n'
'Remove these commit entries and validate your changeset '
'again:\n', commit_tree_entries)
]
if deps['git_dependencies'] == 'SUBMODULES':
# git submodule is source of truth, so no further action needed.
return []
assert deps['git_dependencies'] == 'SYNC', 'unexpected git_dependencies.'
mismatch_entries = []
deps_msg = ""
for commit_tree_entry in commit_tree_entries:
# Search for commit hashes in DEPS file - they must be present
if commit_tree_entry[2] not in deps_content:
mismatch_entries.append(commit_tree_entry[3])
deps_msg += f"\n {commit_tree_entry[3]} -> {commit_tree_entry[2]}"
if mismatch_entries:
return [
output_api.PresubmitError(
'DEPS file indicates git submodule migration is in progress,\n'
'but the commit objects do not match DEPS entries.\n\n'
'To reset all git submodule git entries to match DEPS, run\n'
'the following command in the root of this repository:\n'
' gclient gitmodules'
'\n\n'
'If git submodule changes are correct, update the following DEPS '
'entries to: ' + deps_msg)
]
def _ParseDeps(contents):
"""Simple helper for parsing DEPS files."""
# Stubs for handling special syntax in the root DEPS file.
class _VarImpl:
def __init__(self, local_scope):
self._local_scope = local_scope
def Lookup(self, var_name):
"""Implements the Var syntax."""
try:
return self._local_scope['vars'][var_name]
except KeyError:
raise Exception('Var is not defined: %s' % var_name)
local_scope = {}
global_scope = {
'Var': _VarImpl(local_scope).Lookup,
'Str': str,
}
mismatch_entries = []
deps_msg = ""
for commit_tree_entry in commit_tree_entries:
# Search for commit hashes in DEPS file - they must be present
if commit_tree_entry[2] not in deps_content:
mismatch_entries.append(commit_tree_entry[3])
deps_msg += f"\n {commit_tree_entry[3]} -> {commit_tree_entry[2]}"
if mismatch_entries:
return [
output_api.PresubmitError(
'DEPS file indicates git submodule migration is in progress,\n'
'but the commit objects do not match DEPS entries.\n\n'
'To reset all git submodule git entries to match DEPS, run\n'
'the following command in the root of this repository:\n'
' gclient gitmodules'
'\n\n'
'If git submodule changes are correct, update the following DEPS '
'entries to: ' + deps_msg)
]
exec(contents, global_scope, local_scope)
return local_scope
return []
def CheckVPythonSpec(input_api, output_api, file_filter=None):

Write Preview
Loading…
Cancel
Save