Currently the output of dexter --version contains the raw output of `git remote get-url origin`, which may contain a username and password. This patch adds a small change to remove these from the output string. A similar patch for LLVM's default version string* also removes the git URL altogether unless opted-in to; it's not clear whether this is a necessary or desirable step yet, but if so we can trivially remove the URL from Dexter as well. *PR here: https://github.com/llvm/llvm-project/pull/105220
62 lines
1.9 KiB
Python
62 lines
1.9 KiB
Python
# DExTer : Debugging Experience Tester
|
|
# ~~~~~~ ~ ~~ ~ ~~
|
|
#
|
|
# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
# See https://llvm.org/LICENSE.txt for license information.
|
|
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
"""DExTer version output."""
|
|
|
|
import os
|
|
from subprocess import CalledProcessError, check_output, STDOUT
|
|
import sys
|
|
from urllib.parse import urlparse, urlunparse
|
|
|
|
from dex import __version__
|
|
|
|
|
|
def sanitize_repo_url(repo):
|
|
parsed = urlparse(repo)
|
|
# No username present, repo URL is fine.
|
|
if parsed.username is None:
|
|
return repo
|
|
# Otherwise, strip the login details from the URL by reconstructing the netloc from just `<hostname>(:<port>)?`.
|
|
sanitized_netloc = parsed.hostname
|
|
if parsed.port:
|
|
sanitized_netloc = f"{sanitized_netloc}:{parsed.port}"
|
|
return urlunparse(parsed._replace(netloc=sanitized_netloc))
|
|
|
|
|
|
def _git_version():
|
|
dir_ = os.path.dirname(__file__)
|
|
try:
|
|
branch = (
|
|
check_output(
|
|
["git", "rev-parse", "--abbrev-ref", "HEAD"], stderr=STDOUT, cwd=dir_
|
|
)
|
|
.rstrip()
|
|
.decode("utf-8")
|
|
)
|
|
hash_ = (
|
|
check_output(["git", "rev-parse", "HEAD"], stderr=STDOUT, cwd=dir_)
|
|
.rstrip()
|
|
.decode("utf-8")
|
|
)
|
|
repo = sanitize_repo_url(
|
|
check_output(
|
|
["git", "remote", "get-url", "origin"], stderr=STDOUT, cwd=dir_
|
|
)
|
|
.rstrip()
|
|
.decode("utf-8")
|
|
)
|
|
return "[{} {}] ({})".format(branch, hash_, repo)
|
|
except (OSError, CalledProcessError):
|
|
pass
|
|
return None
|
|
|
|
|
|
def version(name):
|
|
lines = []
|
|
lines.append(" ".join([s for s in [name, __version__, _git_version()] if s]))
|
|
lines.append(" using Python {}".format(sys.version))
|
|
return "\n".join(lines)
|