blob: c44fcd7f74d36a3e3047df11cd6c2b7384ea14bd [file] [log] [blame]
Caroline Tice90723912018-03-28 11:26:59 -07001# -*- coding: utf-8 -*-
2# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
3# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
6"""Generates a clang-tidy tarball for the clang-tidy builder."""
7
8from __future__ import print_function
9
10import os
Caroline Ticed2c34b32018-04-04 15:08:55 -070011import shutil
Caroline Tice90723912018-03-28 11:26:59 -070012
13from chromite.lib import cros_build_lib
14from chromite.lib import commandline
15from chromite.lib import osutils
16from chromite.lib import sudo
17
18DEFAULT_NAME = 'clang_tidy_warnings.tar.xz'
19TIDY_WARNINGS = 'clang_tidy_warnings'
20PARSING_SCRIPT = '/usr/bin/clang-tidy-parse-build-log.py'
21WORKING_DIR = '/usr/bin'
22
23
24def ParseCommandLine(argv):
25 """Parse args, and run environment-independent checks."""
26 parser = commandline.ArgumentParser(description=__doc__)
27 parser.add_argument('--board', required=True,
28 help=('The board to generate the sysroot for.'))
Caroline Ticed2c34b32018-04-04 15:08:55 -070029 parser.add_argument('--logs-dir', required=True,
30 help=('The directory containg the logs files to '
31 'be parsed.'))
Caroline Tice90723912018-03-28 11:26:59 -070032 parser.add_argument('--out-dir', type='path', required=True,
33 help='Directory to place the generated tarball.')
34 parser.add_argument('--out-file', default=DEFAULT_NAME,
35 help='The name to give to the tarball. '
36 'Defaults to %(default)s.')
37 options = parser.parse_args(argv)
38
39 return options
40
41
42class GenerateTidyWarnings(object):
43 """Wrapper for generation functionality."""
44
45 def __init__(self, warnings_dir, options):
46 """Initialize
47
48 Args:
49 warnings_dir: Path to warnings directory.
50 options: Parsed options.
51 """
52 self.warnings_dir = warnings_dir
53 self.options = options
54
Caroline Ticed2c34b32018-04-04 15:08:55 -070055 def _FindLogFiles(self, logs_dir):
56 files = []
57 filelist = os.listdir(logs_dir)
58 for f in filelist:
59 logfile = os.path.join(logs_dir, f)
60 files.append(logfile)
61 return files
62
Caroline Tice90723912018-03-28 11:26:59 -070063 def _ParseLogFiles(self):
Caroline Ticed2c34b32018-04-04 15:08:55 -070064 log_files = self._FindLogFiles(self.options.logs_dir)
Caroline Tice90723912018-03-28 11:26:59 -070065 for f in log_files:
66 cmd = [PARSING_SCRIPT, '--log_file', f, '--output_dir', self.warnings_dir]
67 cros_build_lib.RunCommand(cmd, cwd=WORKING_DIR, enter_chroot=True)
Caroline Ticed2c34b32018-04-04 15:08:55 -070068 # Copy log file to output directory. We want the log files in the
69 # tarball, for now, in case we ever need to re-process them. (A
70 # possibility, since the final dashboard details have not been worked out
71 # yet.)
72 shutil.copy2(f, self.warnings_dir)
Caroline Tice90723912018-03-28 11:26:59 -070073
74 def _CreateTarball(self):
75 target = os.path.join(self.options.out_dir, self.options.out_file)
76 cros_build_lib.CreateTarball(target, self.warnings_dir, sudo=True)
77
78 def Perform(self):
79 """Generate the warnings files."""
80 self._ParseLogFiles()
81 self._CreateTarball()
82
83
84def FinishParsing(options):
85 """Run environment dependent checks on parsed args."""
86 target = os.path.join(options.out_dir, options.out_file)
87 if os.path.exists(target):
88 cros_build_lib.Die('Output file %r already exists.' % target)
89
90 if not os.path.isdir(options.out_dir):
91 cros_build_lib.Die(
92 'Non-existent directory %r specified for --out-dir' % options.out_dir)
93
94
95def main(argv):
96 options = ParseCommandLine(argv)
97 FinishParsing(options)
98
99 cros_build_lib.AssertInsideChroot()
100
101 with sudo.SudoKeepAlive(ttyless_sudo=False):
102 with osutils.TempDir(set_global=True, sudo_rm=True) as tempdir:
103 warnings_dir = os.path.join(tempdir, TIDY_WARNINGS)
104 os.mkdir(warnings_dir)
105 GenerateTidyWarnings(warnings_dir, options).Perform()