bumpver/src/pycalver/vcs.py

# This file is part of the pycalver project
# https://github.com/mbarkhau/pycalver
#
# (C) 2018 Manuel Barkhau (@mbarkhau)
# SPDX-License-Identifier: MIT
#
# pycalver/vcs.py (this file) is based on code from the
# bumpversion project: https://github.com/peritus/bumpversion
# MIT License - (C) 2013-2014 Filip Noetzel

import os
import sys
import logging
import tempfile
import typing as typ
import subprocess as sp


log = logging.getLogger("pycalver.vcs")


class BaseVCS:

    _TEST_USABLE_COMMAND: typ.List[str]
    _COMMIT_COMMAND     : typ.List[str]
    _STATUS_COMMAND     : typ.List[str]

    @classmethod
    def commit(cls, message: str) -> None:
        message_data = message.encode("utf-8")

        tmp_file = tempfile.NamedTemporaryFile("wb", delete=False)

        with tmp_file as fh:
            fh.write(message_data)

        cmd = cls._COMMIT_COMMAND + [tmp_file.name]
        env = os.environ.copy()
        # TODO (mb 2018-09-04): check that this works on py27,
        #   might need to be bytes there, idk.
        env['HGENCODING'] = "utf-8"
        sp.check_output(cmd, env=env)
        os.unlink(tmp_file.name)

    @classmethod
    def is_usable(cls) -> bool:
        try:
            return sp.call(cls._TEST_USABLE_COMMAND, stderr=sp.PIPE, stdout=sp.PIPE) == 0
        except OSError as e:
            if e.errno == 2:
                # mercurial is not installed then, ok.
                return False
            raise

    @classmethod
    def dirty_files(cls) -> typ.List[str]:
        status_output = sp.check_output(cls._STATUS_COMMAND)
        return [
            line.decode("utf-8")[2:].strip()
            for line in status_output.splitlines()
            if not line.strip().startswith(b"??")
        ]

    @classmethod
    def assert_not_dirty(cls, filepaths: typ.Set[str], allow_dirty=False) -> None:
        dirty_files = cls.dirty_files()

        if dirty_files:
            log.warn(f"{cls.__name__} working directory is not clean:")
            for dirty_file in dirty_files:
                log.warn("    " + dirty_file)

        if not allow_dirty and dirty_files:
            sys.exit(1)

        dirty_pattern_files = set(dirty_files) & filepaths
        if dirty_pattern_files:
            log.error("Not commiting when pattern files are dirty:")
            for dirty_file in dirty_pattern_files:
                log.warn("    " + dirty_file)
            sys.exit(1)


class Git(BaseVCS):

    _TEST_USABLE_COMMAND = ["git", "rev-parse", "--git-dir"]
    _COMMIT_COMMAND      = ["git", "commit"   , "-F"]
    _STATUS_COMMAND      = ["git", "status"   , "--porcelain"]

    @classmethod
    def tag(cls, name):
        sp.check_output(["git", "tag", name])

    @classmethod
    def add_path(cls, path):
        sp.check_output(["git", "add", "--update", path])


class Mercurial(BaseVCS):

    _TEST_USABLE_COMMAND = ["hg", 'root']
    _COMMIT_COMMAND      = ["hg", "commit", "--logfile"]
    _STATUS_COMMAND      = ["hg", "status", "-mard"]

    @classmethod
    def tag(cls, name):
        sp.check_output(["hg", "tag", name])

    @classmethod
    def add_path(cls, path):
        pass


VCS = [Git, Mercurial]


def get_vcs() -> typ.Optional[typ.Type[BaseVCS]]:
    for vcs in VCS:
        if vcs.is_usable():
            return vcs

    return None