deb-mock/mock/py/mockbuild/exception.py

# -*- coding: utf-8 -*-
# vim:expandtab:autoindent:tabstop=4:shiftwidth=4:filetype=python:textwidth=0:
# License: GPL2 or later see COPYING
# Originally written by Seth Vidal
# Sections taken from Mach by Thomas Vander Stichele
# Major reorganization and adaptation by Michael Brown
# Copyright (C) 2007 Michael E Brown <mebrown@michaels-house.net>
"""define most of the exceptions used."""

# classes


class Error(Exception):
    resultcode = 1

    def __init__(self, *args):
        """
        A base class for our errors.  The exit code can be specified as
        self.resultcode.  If multiple ARGS are specified, the second one is
        used as the resultcode.
        """
        super().__init__(*args)
        self.msg = args[0]
        if len(args) > 1:
            self.resultcode = args[1]

    def __str__(self):
        return self.msg

# result/exit codes
# 0 = yay!
# 1 = something happened  - it's bad
# 2 = run without setuid wrapper
# 3 = invalid configuration
# 4 = only some packages were build during --chain
# 5 = cmdline processing error
# 6 = invalid architecture
# 10 = problem building the package
# 11 = command timeouted
# 20 = error in the chroot of some kind
# 25 = LVM manipulation error
# 30 = Yum emitted an error of some sort
# 31 = Unknow external dependency
# 40 = some error in the pkg we're building
# 50 = error in mock command (varies for each command)
# 60 = buildroot locked
# 65 = LVM thinpool locked
# 70 = result dir could not be created
# 80 = unshare of namespace failed
# 90 = bootstrap preparation error
# 110 = unbalanced call to state functions
# 120 = weak dependent package not installed
# 129 = the main process get signal SIGHUP, the console was closed
# 141 = the main process get signal SIGPIPE, the pipe does not exist or was closed
# 143 = the main process get signal SIGTERM, something tries to kill mock process

def get_class_by_code(exit_code):
    if exit_code == 0:
        return None
    elif exit_code == 1:
        return Error("Unknow error happened.")
    elif exit_code == 2:
        return Error("Run without setuid wrapper.", 2)
    elif exit_code == 3:
        return ConfigError("Invalid configuration.")
    elif exit_code == 4:
        return Error("Only some packages were build during --chain.", 4)
    elif exit_code == 5:
        return BadCmdline("Command-line processing error.")
    elif exit_code == 6:
        return InvalidArchitecture("Invalid architecture.")
    elif exit_code == 10:
        return BuildError("Error during rpmbuild phase. Check the build.log.")
    elif exit_code == 11:
        return commandTimeoutExpired("Command timeout expired.")
    elif exit_code == 20:
        return RootError("Error in the chroot. Check the root.log.")
    elif exit_code == 25:
        return LvmError("LVM manipulation failed.")
    elif exit_code == 30:
        return YumError("Package manager emitted an error of some sort.")
    elif exit_code == 31:
        return ExternalDepsError("Unknown external dependency")
    elif exit_code == 40:
        return PkgError("Error with the srpm given to us.")
    elif exit_code == 50:
        return Error("Error in mock command (varies for each command)", 50)
    elif exit_code == 60:
        return BuildRootLocked("Build-root in use by another process.")
    elif exit_code == 65:
        return LvmLocked("LVM thinpool is locked.")
    elif exit_code == 70:
        return ResultDirNotAccessible("Result dir could not be created.")
    elif exit_code == 80:
        return UnshareFailed("Call to C library unshare(2) syscall failed.")
    elif exit_code == 90:
        return BootstrapError("Can not prepare bootstrap chroot")
    elif exit_code == 110:
        return StateError("Unbalanced call to state functions. Check the state.log")
    elif exit_code == 120:
        return Error("Weak dependent package not installed.", 120)
    elif exit_code == 129:
        return Error("The main process get signal SIGHUP, the console was closed.", 129)
    elif exit_code == 141:
        return Error("The main process get signal SIGPIPE, the pipe does not exist or was closed.", 141)
    elif exit_code == 143:
        return Error("The main process get signal SIGTERM, something tries to kill mock process.", 143)
    else:
        return Error("Unknow error %{} happened.".format(exit_code), exit_code)

class BuildError(Error):
    "rpmbuild failed."
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 10


class commandTimeoutExpired(Error):
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 11

class RootError(Error):
    "failed to set up chroot"
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 20


class LvmError(Error):
    "LVM manipulation failed."
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 25


class YumError(RootError):
    "yum failed."
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 30


class ExternalDepsError(RootError):
    "Unknown external dependency."
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 31

class PkgError(Error):
    "error with the srpm given to us."
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 40


class BuildRootLocked(Error):
    "build root in use by another process."
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 60


class LvmLocked(Error):
    "LVM thinpool is locked."
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 65


class BadCmdline(Error):
    "user gave bad/inconsistent command line."
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 5


class InvalidArchitecture(Error):
    "invalid host/target architecture specified."
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 6


class ResultDirNotAccessible(Error):
    """
Could not create output directory for built rpms. The directory specified was:
    %s

Try using the --resultdir= option to select another location. Recommended location is --resultdir=~/mock/.
"""
    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 70


class UnshareFailed(Error):
    "call to C library unshare(2) syscall failed"

    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 80


class BootstrapError(Error):
    "Can not prepare bootstrap chroot"

    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 90


class StateError(Error):
    "unbalanced call to state functions"

    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 110


class ConfigError(Error):
    "invalid configuration"

    def __init__(self, *args):
        super().__init__(*args)
        self.resultcode = 3