blob: 122345536b0b35070607ef6336c82c496f8d150a [file] [log] [blame]
#!/usr/bin/env vpython
# Copyright 2018 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.
"""Checks go package imports to ensure they're not too wacky."""
import os
import subprocess
import sys
import urlparse
import yaml
# This lists the go packages to scan. Can be any package pattern accepted
# by `go list`
# We have imports which only occur in some OS-specific .go files, so run
# `go list` under these $GOOS values to catch 'em all.
SCRIPT_DIR = os.path.realpath(os.path.dirname(__file__))
DEVNULL = open(os.devnull, 'wb')
def scan_os_async(goos):
env = os.environ.copy()
env['GOOS'] = goos
FMT = (
'{{$pkg := .ImportPath}}'
'{{range .Imports}}'
'{{printf "%s %s\\n" $pkg .}}'
'{{range .TestImports}}'
'{{printf "%s %s\\n" $pkg .}}'
p = subprocess.Popen(
['go', 'list', '-f', FMT] + PKGS_TO_CHECK, env=env,
stdout=subprocess.PIPE, stderr=DEVNULL)
return lambda: p.communicate()[0]
def read_and_merge(*go_list_data_func):
ret = {}
for fn in go_list_data_func:
for line in fn().splitlines():
pkgname, import_pkg = line.split()
ret.setdefault(import_pkg, set()).add(pkgname)
return ret
def apply_whitelist(import_to_users, whitelist):
used_whitelist = set()
def matches(imp):
for x in whitelist:
if imp.startswith(x):
return True
return False
for imp in import_to_users.keys():
if matches(imp):
del import_to_users[imp]
# Does it look like stdlib?
if '.' not in imp.split('/')[0]:
del import_to_users[imp]
return whitelist - used_whitelist
def load_whitelist(path):
ret = set()
with open(path, 'r') as f:
for line in f.readlines():
line = line.strip()
if not line or line.startswith('#'):
return set(ret)
def check_all_googlesource_mirrors():
ret = []
with open(os.path.join(SCRIPT_DIR, 'deps.lock')) as f:
lock_file = yaml.safe_load(f)
bad_urls = {}
for imp in lock_file['imports']:
repo = urlparse.urlparse(imp['repo'])
if not repo.netloc.endswith(''):
bad_urls[imp['name']] = '%s/%s' % (repo.scheme, repo.netloc)
if bad_urls:
ret.append(' dep repos:')
for name, url in sorted(bad_urls.items()):
ret.append(' %s: %s' % (name, url))
return ret
def check_only_whitelisted_deps():
ret = []
whitelist = load_whitelist(os.path.join(SCRIPT_DIR, 'check_deps.whitelist'))
import_to_users = read_and_merge(*map(scan_os_async, GOOS_TO_CHECK))
unused_whitelist = apply_whitelist(import_to_users, whitelist)
if import_to_users:
pkg_to_bad_imports = {}
for bad_import, pkg_users in sorted(import_to_users.items()):
for pkg in pkg_users:
pkg_to_bad_imports.setdefault(pkg, []).append(bad_import)
ret.append('Invalid Go package dependencies:')
for i, (pkg, bad_imports) in enumerate(sorted(pkg_to_bad_imports.items())):
if i != 0:
ret.append(' in %s' % pkg)
for imp in bad_imports:
ret.append(' - %s' % imp)
if unused_whitelist:
ret.append('Unused whitelist entries:')
for entry in sorted(unused_whitelist):
ret.append(' %s' % entry)
return ret
def main():
lines = []
lines += check_all_googlesource_mirrors()
lines += check_only_whitelisted_deps()
for l in lines:
print l
if lines:
if __name__ == '__main__':