skia2/infra/bots/recipes/check_generated_files.py
Mike Klein e172236e7b rewrite *.gn and #includes on CheckGeneratedFiles bot
In addition to checking .fp files, this ought to make this bot now also
check that our .gn files are formatted and our #includes are consistent
with rewrite_includes.py.

Some .gn files needed formatting; you can see the failure caught on PS 4.

Cq-Include-Trybots: skia.primary:Housekeeper-PerCommit-CheckGeneratedFiles
Change-Id: Ia6669581406212c986da81f2521e4e9d8d3eadb4
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/229802
Commit-Queue: Mike Klein <mtklein@google.com>
Reviewed-by: Eric Boren <borenet@google.com>
2019-07-25 20:48:33 +00:00

117 lines
3.3 KiB
Python

# Copyright 2017 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.
# Recipe for the Skia PerCommit Housekeeper.
DEPS = [
'build',
'infra',
'recipe_engine/context',
'recipe_engine/file',
'recipe_engine/path',
'recipe_engine/properties',
'recipe_engine/python',
'recipe_engine/raw_io',
'recipe_engine/step',
'checkout',
'flavor',
'run',
'vars',
]
def RunSteps(api):
# Checkout, compile, etc.
api.vars.setup()
checkout_root = api.checkout.default_checkout_root
api.checkout.bot_update(checkout_root=checkout_root)
api.file.ensure_directory('makedirs tmp_dir', api.vars.tmp_dir)
api.flavor.setup()
cwd = api.path['checkout']
with api.context(cwd=cwd):
# Get a baseline diff. This should be empty, but we want to be flexible for
# cases where we have local diffs on purpose.
diff1 = api.run(
api.step,
'git diff #1',
cmd=['git', 'diff', '--no-ext-diff'],
stdout=api.m.raw_io.output()).stdout
with api.context(env=api.infra.go_env):
api.step('generate gl interfaces',
cmd=['make', '-C', 'tools/gpu/gl/interface', 'generate'])
# Reformat all tracked .gn files.
api.run(api.python, 'fetch-gn',
script='bin/fetch-gn',
infra_step=True)
files = api.run(api.step, 'list .gn files',
cmd=['git', 'ls-files', '*.gn'],
stdout=api.m.raw_io.output(),
infra_step=True).stdout
for f in files.split():
api.run(api.step, 'format ' + f,
cmd=['bin/gn', 'format', f])
# Rewrite #includes.
api.run(api.python, 'rewrite #includes',
script='tools/rewrite_includes.py')
# Touch all .fp files so that the generated files are rebuilt.
api.run(
api.python.inline,
'touch fp files',
program="""import os
import subprocess
for r, d, files in os.walk('%s'):
for f in files:
if f.endswith('.fp'):
path = os.path.join(r, f)
print 'touch %%s' %% path
subprocess.check_call(['touch', path])
""" % cwd)
# Run GN, regenerate the SKSL files, and make sure rewritten #includes work.
api.build(checkout_root=checkout_root,
out_dir=api.vars.build_dir.join('out', 'Release'))
# Get a second diff. If this doesn't match the first, then there have been
# modifications to the generated files.
diff2 = api.run(
api.step,
'git diff #2',
cmd=['git', 'diff', '--no-ext-diff'],
stdout=api.m.raw_io.output()).stdout
api.run(
api.python.inline,
'compare diffs',
program="""
diff1 = '''%s'''
diff2 = '''%s'''
if diff1 != diff2:
print 'Generated files have been edited!'
exit(1)
""" % (diff1, diff2))
def GenTests(api):
yield (
api.test('Housekeeper-PerCommit-CheckGeneratedFiles') +
api.properties(buildername='Housekeeper-PerCommit-CheckGeneratedFiles',
repository='https://skia.googlesource.com/skia.git',
revision='abc123',
path_config='kitchen',
swarm_out_dir='[SWARM_OUT_DIR]') +
api.path.exists(api.path['start_dir']) +
api.step_data('list .gn files',
stdout=api.raw_io.output('BUILD.gn\ngn/foo.gn\n'))
)