refactor: merge legacy rdopkg.utils.exception

In the ancient times, rdopkg.utils was shared between other projects using `git
subtree` so it had relative imports and own set of exceptions. However, that is
no longer the case so we can have all the exceptions in exception.py. Yay!

Change-Id: I09ed85fe3dbcec1bae37d067e63d5828e7e27cfe

Author: Jakub Ruzicka

rdopkg/actionmods/cbsbuild.py

@@ -7,7 +7,7 @@
 import os
 import subprocess
 
-from rdopkg.utils.exception import ModuleNotAvailable, RpmModuleNotAvailable
+from rdopkg.exception import ModuleNotAvailable, RpmModuleNotAvailable
 from rdopkg.utils.specfile import spec_fn, Spec
 from rdopkg.utils.log import log
 from rdopkg import exception, guess

rdopkg/exception.py

@@ -1,18 +1,77 @@
-from rdopkg.utils.exception import RdopkgException
-# TODO before 1.0: merge utils.exception.* here.
-# Legacy reasons to have them separate no longer apply.
-from rdopkg.utils.exception import BranchNotFound  # NOQA
-from rdopkg.utils.exception import BuildArchSanityCheckFailed  # NOQA
-from rdopkg.utils.exception import CommandFailed  # NOQA
-from rdopkg.utils.exception import CommandNotFound  # NOQA
-from rdopkg.utils.exception import DuplicatePatchesBaseError  # NOQA
-from rdopkg.utils.exception import IncompleteChangelog  # NOQA
-from rdopkg.utils.exception import InvalidAction  # NOQA
-from rdopkg.utils.exception import ModuleNotAvailable  # NOQA
-from rdopkg.utils.exception import MultipleSpecFilesFound  # NOQA
-from rdopkg.utils.exception import RpmModuleNotAvailable  # NOQA
-from rdopkg.utils.exception import SpecFileNotFound  # NOQA
-from rdopkg.utils.exception import SpecFileParseError  # NOQA
+class RdopkgException(Exception):
+    msg_fmt = "An unknown error occurred"
+    exit_code = 1
+
+    def __init__(self, msg=None, exit_code=None, **kwargs):
+        self.kwargs = kwargs
+        if not msg:
+            try:
+                msg = self.msg_fmt % kwargs
+            except Exception:
+                # kwargs doesn't match those in message.
+                # Returning this is still better than nothing.
+                msg = self.msg_fmt
+        if exit_code is not None:
+            self.exit_code = exit_code
+        super(RdopkgException, self).__init__(msg)
+
+
+class CommandFailed(RdopkgException):
+    msg_fmt = "Command failed: %(cmd)s"
+
+
+class CommandNotFound(RdopkgException):
+    msg_fmt = "Command not found: %(cmd)s"
+
+
+class InvalidRemoteBranch(RdopkgException):
+    msg_fmt = "Git remote not found for remote branch: %(branch)s"
+
+
+class BranchNotFound(RdopkgException):
+    msg_fmt = "Expected git branch not found: %(branch)s"
+
+
+class SpecFileNotFound(RdopkgException):
+    msg_fmt = "No .spec files found."
+
+
+class IncompleteChangelog(RdopkgException):
+    msg_fmt = "Description of changes is missing in %%changelog."
+
+
+class MultipleSpecFilesFound(RdopkgException):
+    msg_fmt = "Multiple .spec files found. Expected only one."
+
+
+class SpecFileParseError(RdopkgException):
+    msg_fmt = "Error parsing .spec file '%(spec_fn)s': %(error)s"
+
+
+class ModuleNotAvailable(RdopkgException):
+    msg_fmt = "Module %(module)s is not available. Unable to continue."
+
+
+class RpmModuleNotAvailable(ModuleNotAvailable):
+    msg_fmt = ("Module rpm is not available. It is required to parse .spec "
+               "files. Pro tip: `yum install rpm-python`")
+
+
+class InvalidAction(RdopkgException):
+    msg_fmt = "Invalid action: %(action)s"
+
+
+class BuildArchSanityCheckFailed(RdopkgException):
+    msg_fmt = ("Due to mysterious ways of rpm, BuildArch needs to be placed "
+               "AFTER SourceX and PatchX lines in .spec file, "
+               "otherwise %%{patches} macro will be empty "
+               "and both %%autosetup and `git am %%{patches}` will fail.\n\n"
+               "Please move BuildArch AFTER SourceX and PatchX.")
+
+
+class DuplicatePatchesBaseError(RdopkgException):
+    msg_fmt = ("Please make sure to only have one "
+               "# patches_base= entry in .spec")
 
 
 class UserAbort(RdopkgException):

rdopkg/utils/exception.py

@@ -1,5 +1,5 @@
-from rdopkg.utils.exception import CommandFailed
-from rdopkg.utils.exception import RdopkgException
+from rdopkg.exception import CommandFailed
+from rdopkg.exception import RdopkgException
 
 
 def test_exception_default():

tests/test_exception.py

@@ -4,7 +4,7 @@
 from rdopkg.actions.distgit.actions import update_patches
 from rdopkg.utils.cmd import git
 from rdopkg.utils import specfile
-import rdopkg.utils.exception
+import rdopkg.exception
 
 import test_common as common
 
@@ -146,7 +146,7 @@ def test_update_git_am_buildarch_fail(tmpdir):
         common.prep_patches_branch()
         commit_before = git('rev-parse', 'HEAD')
         common.add_patches(extra=True)
-        with pytest.raises(rdopkg.utils.exception.BuildArchSanityCheckFailed):
+        with pytest.raises(rdopkg.exception.BuildArchSanityCheckFailed):
             update_patches('master',
                            local_patches_branch='master-patches',
                            version='1.2.3')
@@ -237,7 +237,7 @@ def test_update_double_patches_base(tmpdir):
     with dist_path.as_cwd():
         common.prep_patches_branch()
         commit_before = git('rev-parse', 'HEAD')
-        with pytest.raises(rdopkg.utils.exception.DuplicatePatchesBaseError):
+        with pytest.raises(rdopkg.exception.DuplicatePatchesBaseError):
             update_patches('master',
                            local_patches_branch='master-patches',
                            version='1.2.3')