blob: 9b8bc15a2af7de03c9c3a9bfa637879d7bb33aee [file] [log] [blame]
# Copyright (c) 2020 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.
"""Enforces workaround list is alphabetically sorted.
See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
for more details on the presubmit API built into depot_tools.
"""
import difflib
import os.path
def _CheckGPUWorkaroundListSorted(input_api, output_api):
"""Check: gpu_workaround_list.txt feature list sorted alphabetically.
"""
filename = os.path.join(input_api.PresubmitLocalPath(),
'gpu_workaround_list.txt')
workaround_list = [line.rstrip('\n') for line in open(filename)]
workaround_list_sorted = sorted(workaround_list, key=lambda s: s.lower())
if workaround_list == workaround_list_sorted:
return []
# Diff the sorted/unsorted versions.
differ = difflib.Differ()
diff = differ.compare(workaround_list, workaround_list_sorted)
return [output_api.PresubmitError(
'gpu_workaround_list.txt features must be sorted alphabetically. '
'Diff of feature order follows:', long_text='\n'.join(diff))]
def CheckChangeOnUpload(input_api, output_api):
return _CheckGPUWorkaroundListSorted(input_api, output_api)
def CheckChangeOnCommit(input_api, output_api):
return _CheckGPUWorkaroundListSorted(input_api, output_api)