git_utils.py

import logging
import pathlib
import subprocess

log = logging.getLogger(__name__)


def git_describe() -> str:
    label = subprocess.check_output(["git", "describe", "--always", "HEAD"]).strip().decode("utf-8")
    return label


def git_clean() -> bool:
    git_output = subprocess.check_output(["git", "status", "--porcelain"]).strip().decode("utf-8")
    is_clean = len(git_output) == 0

    return is_clean


def git_diff() -> str:
    diff = subprocess.check_output(["git", "diff", "HEAD"]).strip().decode("utf-8")
    if len(diff) == 0 or diff[-1] != "\n":
        diff = diff + "\n"
    return diff


def log_git_info(run_dir: pathlib.Path) -> None:
    label = git_describe()
    if git_clean():
        log.info("Working tree is clean! HEAD is {}".format(label))
        return

    diff_path = run_dir / "diff.patch"
    log.warning("Continuing with dirty working tree! HEAD is {}".format(label))
    log.warning("Saving the results of git diff to {}".format(diff_path))
    with open(diff_path, "w") as f:
        f.write(git_diff())