blob: a6e785aa2389726655a19f4afd1355d800355950 [file] [log] [blame]
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001#!/usr/bin/env python3
Patrick Williamsc124f4f2015-09-15 14:41:29 -05002
3# Report significant differences in the buildhistory repository since a specific revision
4#
5# Copyright (C) 2013 Intel Corporation
6# Author: Paul Eggleton <paul.eggleton@linux.intel.com>
Brad Bishopc342db32019-05-15 21:57:59 -04007#
8# SPDX-License-Identifier: GPL-2.0-only
9#
Patrick Williamsc124f4f2015-09-15 14:41:29 -050010
11import sys
12import os
Brad Bishopd7bf8c12018-02-25 22:55:05 -050013import argparse
Patrick Williamsc124f4f2015-09-15 14:41:29 -050014
15# Ensure PythonGit is installed (buildhistory_analysis needs it)
16try:
17 import git
18except ImportError:
Patrick Williamsc0f7c042017-02-23 20:41:17 -060019 print("Please install GitPython (python3-git) 0.3.4 or later in order to use this script")
Patrick Williamsc124f4f2015-09-15 14:41:29 -050020 sys.exit(1)
21
Brad Bishopd7bf8c12018-02-25 22:55:05 -050022def get_args_parser():
23 description = "Reports significant differences in the buildhistory repository."
24
25 parser = argparse.ArgumentParser(description=description,
26 usage="""
27 %(prog)s [options] [from-revision [to-revision]]
28 (if not specified, from-revision defaults to build-minus-1, and to-revision defaults to HEAD)""")
29
Andrew Geisslerc9f78652020-09-18 14:11:35 -050030 default_dir = os.path.join(os.environ.get('BUILDDIR', '.'), 'buildhistory')
31
Brad Bishopd7bf8c12018-02-25 22:55:05 -050032 parser.add_argument('-p', '--buildhistory-dir',
33 action='store',
34 dest='buildhistory_dir',
Andrew Geisslerc9f78652020-09-18 14:11:35 -050035 default=default_dir,
Brad Bishopd7bf8c12018-02-25 22:55:05 -050036 help="Specify path to buildhistory directory (defaults to buildhistory/ under cwd)")
37 parser.add_argument('-v', '--report-version',
38 action='store_true',
39 dest='report_ver',
40 default=False,
41 help="Report changes in PKGE/PKGV/PKGR even when the values are still the default (PE/PV/PR)")
42 parser.add_argument('-a', '--report-all',
43 action='store_true',
44 dest='report_all',
Brad Bishop316dfdd2018-06-25 12:45:53 -040045 default=False,
Brad Bishopd7bf8c12018-02-25 22:55:05 -050046 help="Report all changes, not just the default significant ones")
47 parser.add_argument('-s', '---signatures',
48 action='store_true',
49 dest='sigs',
50 default=False,
51 help="Report list of signatures differing instead of output")
52 parser.add_argument('-S', '--signatures-with-diff',
53 action='store_true',
54 dest='sigsdiff',
55 default=False,
56 help="Report on actual signature differences instead of output (requires signature data to have been generated, either by running the actual tasks or using bitbake -S)")
57 parser.add_argument('-e', '--exclude-path',
58 action='append',
59 help="Exclude path from the output")
Brad Bishop316dfdd2018-06-25 12:45:53 -040060 parser.add_argument('-c', '--colour',
61 choices=('yes', 'no', 'auto'),
62 default="auto",
63 help="Whether to colourise (defaults to auto)")
Brad Bishopd7bf8c12018-02-25 22:55:05 -050064 parser.add_argument('revisions',
65 default = ['build-minus-1', 'HEAD'],
66 nargs='*',
67 help=argparse.SUPPRESS)
68 return parser
69
Patrick Williamsc124f4f2015-09-15 14:41:29 -050070def main():
Patrick Williamsc124f4f2015-09-15 14:41:29 -050071
Brad Bishopd7bf8c12018-02-25 22:55:05 -050072 parser = get_args_parser()
73 args = parser.parse_args()
Patrick Williamsc124f4f2015-09-15 14:41:29 -050074
Brad Bishopd7bf8c12018-02-25 22:55:05 -050075 if len(args.revisions) > 2:
76 sys.stderr.write('Invalid argument(s) specified: %s\n\n' % ' '.join(args.revisions[2:]))
77 parser.print_help()
78
79 sys.exit(1)
Brad Bishopd7bf8c12018-02-25 22:55:05 -050080
81 if not os.path.exists(args.buildhistory_dir):
82 sys.stderr.write('Buildhistory directory "%s" does not exist\n\n' % args.buildhistory_dir)
Patrick Williamsc124f4f2015-09-15 14:41:29 -050083 parser.print_help()
84 sys.exit(1)
85
86 scripts_path = os.path.abspath(os.path.dirname(os.path.abspath(sys.argv[0])))
87 lib_path = scripts_path + '/lib'
88 sys.path = sys.path + [lib_path]
89
90 import scriptpath
91
92 # Set path to OE lib dir so we can import the buildhistory_analysis module
93 scriptpath.add_oe_lib_path()
94 # Set path to bitbake lib dir so the buildhistory_analysis module can load bb.utils
95 bitbakepath = scriptpath.add_bitbake_lib_path()
Brad Bishopd7bf8c12018-02-25 22:55:05 -050096
Patrick Williamsc124f4f2015-09-15 14:41:29 -050097 if not bitbakepath:
98 sys.stderr.write("Unable to find bitbake by searching parent directory of this script or PATH\n")
99 sys.exit(1)
100
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500101 if len(args.revisions) == 1:
102 if '..' in args.revisions[0]:
103 fromrev, torev = args.revisions[0].split('..')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500104 else:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500105 fromrev, torev = args.revisions[0], 'HEAD'
106 elif len(args.revisions) == 2:
107 fromrev, torev = args.revisions
108
Brad Bishop316dfdd2018-06-25 12:45:53 -0400109 from oe.buildhistory_analysis import init_colours, process_changes
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500110 import gitdb
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500111
Brad Bishop316dfdd2018-06-25 12:45:53 -0400112 init_colours({"yes": True, "no": False, "auto": sys.stdout.isatty()}[args.colour])
113
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500114 try:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500115 changes = process_changes(args.buildhistory_dir, fromrev, torev,
116 args.report_all, args.report_ver, args.sigs,
117 args.sigsdiff, args.exclude_path)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500118 except gitdb.exc.BadObject as e:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500119 if not args.revisions:
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500120 sys.stderr.write("Unable to find previous build revision in buildhistory repository\n\n")
121 parser.print_help()
122 else:
123 sys.stderr.write('Specified git revision "%s" is not valid\n' % e.args[0])
124 sys.exit(1)
125
126 for chg in changes:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500127 out = str(chg)
128 if out:
129 print(out)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500130
131 sys.exit(0)
132
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500133if __name__ == "__main__":
134 main()