import argparse
import collections
import datetime
import json
import logging
import os
import subprocess
import sys
_THIS_DIR = os.path.abspath(os.path.dirname(__file__))
_ROOT_DIR = os.path.abspath(
os.path.join(_THIS_DIR, "..", "..", "third_party/depot_tools"))
sys.path.insert(0, _ROOT_DIR)
import gclient_utils
VersionInfo = collections.namedtuple(
"VersionInfo", ("revision_id", "revision", "commit_position", "timestamp"))
_EMPTY_VERSION_INFO = VersionInfo('0' * 40, '0' * 40, '', 0)
class GitError(Exception):
pass
def RunGitCommand(directory, command):
command = ['git'] + command
if sys.platform == 'cygwin':
command = ['sh', '-c', ' '.join(command)]
try:
proc = subprocess.Popen(command,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
cwd=directory,
shell=(sys.platform=='win32'))
return proc
except OSError as e:
logging.error('Command %r failed: %s' % (' '.join(command), e))
return None
def _RunGitCommand(directory, command):
command = ['git'] + command
if sys.platform == 'cygwin':
command = ['sh', '-c', ' '.join(command)]
try:
logging.info("Executing '%s' in %s", ' '.join(command), directory)
proc = subprocess.Popen(command,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
cwd=directory,
shell=(sys.platform=='win32'))
stdout, stderr = tuple(x.decode(encoding='utf_8')
for x in proc.communicate())
stdout = stdout.strip()
stderr = stderr.strip()
logging.debug("returncode: %d", proc.returncode)
logging.debug("stdout: %s", stdout)
logging.debug("stderr: %s", stderr)
if proc.returncode != 0 or not stdout:
raise GitError((
"Git command '{}' in {} failed: "
"rc={}, stdout='{}' stderr='{}'").format(
" ".join(command), directory, proc.returncode, stdout, stderr))
return stdout
except OSError as e:
raise GitError("Git command 'git {}' in {} failed: {}".format(
" ".join(command), directory, e))
def GetMergeBase(directory, ref):
logging.debug("Calculating merge base between HEAD and %s in %s",
ref, directory)
command = ['merge-base', 'HEAD', ref]
return _RunGitCommand(directory, command)
def FetchGitRevision(directory, commit_filter, start_commit="HEAD"):
hash_ = ''
git_args = ['log', '-1', '--format=%H %ct']
if commit_filter is not None:
git_args.append('--grep=' + commit_filter)
git_args.append(start_commit)
output = _RunGitCommand(directory, git_args)
hash_, commit_timestamp = output.split()
if not hash_:
return VersionInfo('0', '0', '', 0)
revision = hash_
pos = ''
output = _RunGitCommand(directory, ['cat-file', 'commit', hash_])
for line in reversed(output.splitlines()):
if line.startswith('Cr-Commit-Position:'):
pos = line.rsplit()[-1].strip()
logging.debug("Found Cr-Commit-Position '%s'", pos)
revision = "{}-{}".format(hash_, pos)
break
return VersionInfo(hash_, revision, pos, int(commit_timestamp))
def GetHeaderGuard(path):
src_index = path.rfind('src/')
if src_index != -1:
guard = path[src_index + 4:]
else:
guard = path
guard = guard.upper()
return guard.replace('/', '_').replace('.', '_').replace('\\', '_') + '_'
def GetCommitPositionHeaderContents(path, define_prefix, version_info):
header_guard = GetHeaderGuard(path)
commit_position_number = ''
commit_position_ref = ''
if version_info.commit_position:
ref_and_number = version_info.commit_position.split('@', 2)
if len(ref_and_number) == 2:
commit_position_ref = ref_and_number[0]
commit_position_number = ref_and_number[1][2:-1]
header_contents = """/* Generated by lastchange.py, do not edit.*/
#ifndef %(header_guard)s
#define %(header_guard)s
#define %(define)s_COMMIT_POSITION_IS_MAIN %(is_main)s
#define %(define)s_COMMIT_POSITION_NUMBER "%(commit_position_number)s"
#endif // %(header_guard)s
""" % {
'header_guard': header_guard,
'define': define_prefix,
'is_main': ('1' if commit_position_ref == 'refs/heads/main' else '0'),
'commit_position_number': commit_position_number,
}
return header_contents
def GetHeaderContents(path, define, version):
header_guard = GetHeaderGuard(path)
header_contents = """/* Generated by lastchange.py, do not edit.*/
#ifndef %(header_guard)s
#define %(header_guard)s
#define %(define)s "%(version)s"
#endif // %(header_guard)s
"""
header_contents = header_contents % { 'header_guard': header_guard,
'define': define,
'version': version }
return header_contents
def GetGitTopDirectory(source_dir):
return _RunGitCommand(source_dir, ['rev-parse', '--show-toplevel'])
def WriteIfChanged(file_name, contents):
try:
old_contents = open(file_name, 'r').read()
except EnvironmentError:
pass
else:
if contents == old_contents:
return False
os.unlink(file_name)
open(file_name, 'w').write(contents)
return True
def GetVersion(source_dir, commit_filter, merge_base_ref):
if 'BASE_COMMIT_SUBMISSION_MS' in os.environ:
return GetVersionInfoFromEnv()
if gclient_utils.IsEnvCog():
return _EMPTY_VERSION_INFO
git_top_dir = None
try:
git_top_dir = GetGitTopDirectory(source_dir)
except GitError as e:
logging.warning("Failed to get git top directory from '%s': %s", source_dir,
e)
merge_base_sha = 'HEAD'
if git_top_dir and merge_base_ref:
try:
merge_base_sha = GetMergeBase(git_top_dir, merge_base_ref)
except GitError as e:
logging.error(
"You requested a --merge-base-ref value of '%s' but no "
"merge base could be found between it and HEAD. Git "
"reports: %s", merge_base_ref, e)
return None
version_info = None
if git_top_dir:
try:
version_info = FetchGitRevision(git_top_dir, commit_filter,
merge_base_sha)
except GitError as e:
logging.error("Failed to get version info: %s", e)
if not version_info:
logging.warning(
"Falling back to a version of 0.0.0 to allow script to "
"finish. This is normal if you are bootstrapping a new environment "
"or do not have a git repository for any other reason. If not, this "
"could represent a serious error.")
version_info = _EMPTY_VERSION_INFO
return version_info
def GetVersionInfoFromEnv():
hash = os.environ.get('BASE_COMMIT_HASH', _EMPTY_VERSION_INFO.revision)
timestamp = int(
os.environ.get('BASE_COMMIT_SUBMISSION_MS',
_EMPTY_VERSION_INFO.timestamp)) / 1000
return VersionInfo(hash, hash, '', int(timestamp))
def GetFlexibleCppHeaderContents(path, version_info, description, keys):
header_guard = GetHeaderGuard(path)
header_contents = f"""/* Generated by lastchange.py, do not edit.*/
#ifndef {header_guard}
#define {header_guard}
"""
if "hash" in keys:
header_contents += f'#define LAST_COMMIT_HASH "{version_info.revision_id}"\n'
if "time" in keys:
commit_time = datetime.datetime.fromtimestamp(
version_info.timestamp,
datetime.timezone.utc).strftime('%Y-%m-%d %H:%M:%S')
header_contents += f'#define LAST_COMMIT_TIME "{commit_time}"\n'
if "description" in keys:
escaped_description = description.replace('\\', '\\\\').replace(
'"', '\\"').replace('\n', '\\n')
header_contents += f'#define LAST_COMMIT_DESCRIPTION "{escaped_description}"\n'
if "year" in keys:
header_contents += f'#define LAST_COMMIT_YEAR {datetime.datetime.fromtimestamp(version_info.timestamp, datetime.timezone.utc).year}\n'
if "revision" in keys:
header_contents += f'#define LAST_COMMIT_REVISION "{version_info.revision}"\n'
header_contents += f"""
#endif // {header_guard}
"""
return header_contents
def _PrintJsonOutput(version_info, source_dir):
commit_description = _RunGitCommand(
source_dir, ['log', '-1', '--format=%B', version_info.revision_id])
commit_time = datetime.datetime.fromtimestamp(
version_info.timestamp,
datetime.timezone.utc).strftime('%Y-%m-%d %H:%M:%S')
commit_position = None
if version_info.commit_position:
ref_and_number = version_info.commit_position.split('@', 2)
if len(ref_and_number) == 2:
commit_position_ref = ref_and_number[0]
commit_position_number = ref_and_number[1][2:-1]
commit_position = {
"ref": commit_position_ref,
"number": commit_position_number,
"is_main": commit_position_ref == 'refs/heads/main',
}
output = {
"hash":
version_info.revision_id,
"revision":
version_info.revision,
"time":
commit_time,
"year":
datetime.datetime.fromtimestamp(version_info.timestamp,
datetime.timezone.utc).year,
"description":
commit_description,
"commit_position":
commit_position,
}
print(json.dumps(output, indent=2))
def main(argv=None):
if argv is None:
argv = sys.argv
parser = argparse.ArgumentParser(usage="lastchange.py [options]")
parser.add_argument("-m", "--version-macro",
help=("Name of C #define when using --header. Defaults to "
"LAST_CHANGE."))
parser.add_argument("-o",
"--output",
metavar="FILE",
help=("Write last change to FILE. "
"Can be combined with other file-output-related "
"options to write multiple files."))
parser.add_argument("--header",
metavar="FILE",
help=("Write last change to FILE as a C/C++ header. "
"Can be combined with other file-output-related "
"options to write multiple files."))
parser.add_argument(
"--header-out",
nargs=2,
metavar=("FILE", "KEYS"),
help=("Write a C++ header with a custom set of the last commit info. "
"Provide a filename and a comma-separated list of keys. "
"Possible keys: hash, time, description, year, revision."))
parser.add_argument("--commit-position-header",
metavar="FILE",
help=("Write the last commit position to FILE as a C/C++ "
"header. Can be combined with other file-output-"
"related options to write multiple files."))
parser.add_argument(
"--revision",
metavar="FILE",
help=("Write the last change to FILE as a one-line revision. "
"Can be combined with other file-output-related "
"options to write multiple files."))
parser.add_argument("--merge-base-ref",
default=None,
help=("Only consider changes since the merge "
"base between HEAD and the provided ref"))
parser.add_argument("--revision-id-only", action='store_true',
help=("Output the revision as a VCS revision ID only (in "
"Git, a 40-character commit hash, excluding the "
"Cr-Commit-Position)."))
parser.add_argument(
"--print-only",
action="store_true",
help=("Just print the last revision string. Overrides any "
"file-output-related options."))
parser.add_argument(
"--timestamp_only",
action="store_true",
help="Print the last commit timestamp in human-readable format.")
parser.add_argument("--commit-description_only",
action="store_true",
help="Print the last commit description.")
parser.add_argument(
"--json",
action="store_true",
help="Print all available information for the last commit as a JSON "
"object. "
"This is a useful debugging tool. "
"Outputs: hash, revision, time, year, description, commit_position.")
parser.add_argument("-s", "--source-dir", metavar="DIR",
help="Use repository in the given directory.")
parser.add_argument("--filter", metavar="REGEX",
help=("Only use log entries where the commit message "
"matches the supplied filter regex. Defaults to "
"'^Change-Id:' to suppress local commits."),
default='^Change-Id:')
args, extras = parser.parse_known_args(argv[1:])
logging.basicConfig(level=logging.WARNING)
out_file = args.output
header = args.header
header_out = args.header_out
revision = args.revision
commit_filter = args.filter
commit_position_header = args.commit_position_header
while len(extras) and out_file is None:
if out_file is None:
out_file = extras.pop(0)
if extras:
sys.stderr.write('Unexpected arguments: %r\n\n' % extras)
parser.print_help()
sys.exit(2)
source_dir = args.source_dir or os.path.dirname(os.path.abspath(__file__))
version_info = GetVersion(source_dir, commit_filter, args.merge_base_ref)
if args.json:
_PrintJsonOutput(version_info, source_dir)
return 0
if header_out:
commit_description = _RunGitCommand(
source_dir, ['log', '-1', '--format=%B', version_info.revision_id])
if header_out:
file_path, keys_string = header_out
keys = keys_string.split(',')
WriteIfChanged(
file_path,
GetFlexibleCppHeaderContents(file_path, version_info,
commit_description, keys))
if args.timestamp_only:
print(
datetime.datetime.fromtimestamp(
version_info.timestamp,
datetime.timezone.utc).strftime('%Y-%m-%d %H:%M:%S'))
return 0
if args.commit_description_only:
print(
_RunGitCommand(source_dir,
['log', '-1', '--format=%B', version_info.revision_id]))
return 0
revision_string = version_info.revision
if args.revision_id_only:
revision_string = version_info.revision_id
if args.print_only:
print(revision_string)
else:
lastchange_year = datetime.datetime.fromtimestamp(
version_info.timestamp, datetime.timezone.utc).year
contents_lines = [
"LASTCHANGE=%s" % revision_string,
"LASTCHANGE_YEAR=%s" % lastchange_year,
]
contents = '\n'.join(contents_lines) + '\n'
if not (out_file or header or commit_position_header or revision
or header_out):
sys.stdout.write(contents)
else:
if out_file:
committime_file = out_file + '.committime'
out_changed = WriteIfChanged(out_file, contents)
if out_changed or not os.path.exists(committime_file):
with open(committime_file, 'w') as timefile:
timefile.write(str(version_info.timestamp))
if header:
WriteIfChanged(header,
GetHeaderContents(header, args.version_macro,
revision_string))
if commit_position_header:
WriteIfChanged(
commit_position_header,
GetCommitPositionHeaderContents(commit_position_header,
args.version_macro, version_info))
if revision:
WriteIfChanged(revision, revision_string)
if header_out:
file_path, keys_string = header_out
keys = keys_string.split(',')
commit_description = _RunGitCommand(
source_dir, ['log', '-1', '--format=%B', version_info.revision_id])
WriteIfChanged(
file_path,
GetFlexibleCppHeaderContents(file_path, version_info,
commit_description, keys))
return 0
if __name__ == '__main__':
sys.exit(main())