xref: /OpenGrok/tools/src/main/python/opengrok_tools/scm/mercurial.py (revision ae5b3cb81c9e71cf489cd9e38e66f063f1180c30)

#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# See LICENSE.txt included in this distribution for the specific
# language governing permissions and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at LICENSE.txt.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#

#
# Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
# Portions Copyright (c) 2020, Krystof Tulinger <k.tulinger@seznam.cz>
#

from shutil import which

from .repository import Repository, RepositoryException
from ..utils.command import Command


class MercurialRepository(Repository):
    def __init__(self, name, logger, path, project, command, env, hooks, timeout):
        super().__init__(name, logger, path, project, command, env, hooks, timeout)

        self.command = self._repository_command(command, default=lambda: which('hg'))

        if not self.command:
            raise RepositoryException("Cannot get hg command")

    def get_branch(self):
        hg_command = [self.command, "branch"]
        cmd = self.get_command(hg_command, work_dir=self.path,
                               env_vars=self.env, logger=self.logger)
        cmd.execute()
        self.logger.info("output of {}:".format(cmd))
        self.logger.info(cmd.getoutputstr())
        if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
            cmd.log_error("failed to get branch")
            return None
        else:
            if not cmd.getoutput():
                self.logger.error("no output from {}".
                                  format(hg_command))
                return None
            if len(cmd.getoutput()) == 0:
                self.logger.error("empty output from {}".
                                  format(hg_command))
                return None
            return cmd.getoutput()[0].strip()

    def reposync(self):
        branch = self.get_branch()
        if not branch:
            # Error logged already in get_branch().
            return 1

        hg_command = [self.command, "pull"]
        if branch != "default":
            hg_command.append("-b")
            hg_command.append(branch)
        cmd = self.get_command(hg_command, work_dir=self.path,
                               env_vars=self.env, logger=self.logger)
        cmd.execute()
        self.logger.info("output of {}:".format(cmd))
        self.logger.info(cmd.getoutputstr())
        if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
            cmd.log_error("failed to perform pull")
            return 1

        hg_command = [self.command, "update"]
        # Avoid remote branch lookup for default branches since
        # some servers do not support it.
        if branch == "default":
            hg_command.append("--check")
        cmd = self.get_command(hg_command, work_dir=self.path,
                               env_vars=self.env, logger=self.logger)
        cmd.execute()
        self.logger.info("output of {}:".format(cmd))
        self.logger.info(cmd.getoutputstr())
        if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
            cmd.log_error("failed to perform pull and update")
            return 1

        return 0

    def incoming_check(self):
        branch = self.get_branch()
        if not branch:
            # Error logged already in get_branch().
            raise RepositoryException('cannot get branch for repository {}'.
                                      format(self))

        hg_command = [self.command, 'incoming']
        if branch != "default":
            hg_command.append("-b")
            hg_command.append(branch)
        cmd = self.get_command(hg_command, work_dir=self.path,
                               env_vars=self.env, logger=self.logger)
        cmd.execute()
        self.logger.info("output of {}:".format(cmd))
        self.logger.info(cmd.getoutputstr())
        retcode = cmd.getretcode()
        if cmd.getstate() != Command.FINISHED or retcode not in [0, 1]:
            cmd.log_error("failed to perform incoming")
            raise RepositoryException('failed to perform incoming command '
                                      'for repository {}'.format(self))

        if retcode == 0:
            return True
        else:
            return False