Move exceptions to their own submodule

datadog_checks_downloader/datadog_checks/downloader/cli.py

@@ -9,84 +9,21 @@
 
 # 2nd party.
 from .download import TUFDownloader
+from .exceptions import (
+    InconsistentSimpleIndex,
+    MissingVersions,
+    NonCanonicalVersion,
+    NonDatadogPackage,
+    NoSuchDatadogPackage,
+    NoSuchDatadogPackageOrVersion,
+)
 
 # 3rd party.
 # NOTE: We assume that setuptools is installed by default.
 from pkg_resources import parse_version
 from tuf.exceptions import UnknownTargetError
 
 
-# Exceptions
-
-
-class NonCanonicalVersionException(Exception):
-
-
-    def __init__(self, version):
-        self.version = version
-
-
-    def __str__(self):
-        return '{} is not a valid PEP 440 version!'.format(self.version)
-
-
-class NonDatadogPackageException(Exception):
-
-
-    def __init__(self, standard_distribution_name):
-        self.standard_distribution_name = standard_distribution_name
-
-
-    def __str__(self):
-        return '{} is not a Datadog package!'.format(self.standard_distribution_name)
-
-
-class NoSuchDatadogPackageException(Exception):
-
-
-    def __init__(self, standard_distribution_name):
-        self.standard_distribution_name = standard_distribution_name
-
-
-    def __str__(self):
-        return 'Could not find the {} package!'.format(self.standard_distribution_name)
-
-
-class NoSuchDatadogPackageOrVersionException(Exception):
-
-
-    def __init__(self, standard_distribution_name, version):
-        self.standard_distribution_name = standard_distribution_name
-        self.version = version
-
-
-    def __str__(self):
-        return 'Either no {} package, or {} version!'.format(self.standard_distribution_name, self.version)
-
-
-class SimpleIndexException(Exception):
-
-
-    def __init__(self, href, text):
-        self.href = href
-        self.text = text
-
-
-    def __str__(self):
-        return '{} != {}'.format(self.href, self.text)
-
-
-class MissingVersionsException(Exception):
-
-
-    def __init__(self, standard_distribution_name):
-        self.standard_distribution_name = standard_distribution_name
-
-
-    def __str__(self):
-        return 'No version found for {} !'.format(self.standard_distribution_name)
-
-
 # Private module functions.
 
 
@@ -97,7 +34,7 @@ def __get_latest_version(tuf_downloader, standard_distribution_name, wheel_distr
         # NOTE: We do not perform in-toto inspection for simple indices; only for wheels.
         target_abspath = tuf_downloader.download(target_relpath, download_in_toto_metadata=False)
     except UnknownTargetError:
-        raise NoSuchDatadogPackageException(standard_distribution_name)
+        raise NoSuchDatadogPackage(standard_distribution_name)
 
     pattern = "<a href='(" + wheel_distribution_name + "-(.*?)-py2\\.py3-none-any\\.whl)'>(.*?)</a><br />"
     versions = []
@@ -110,13 +47,13 @@ def __get_latest_version(tuf_downloader, standard_distribution_name, wheel_distr
                 version = match.group(2)
                 text = match.group(3)
                 if href != text:
-                    raise SimpleIndexException(href, text)
+                    raise InconsistentSimpleIndex(href, text)
                 else:
                     # https://setuptools.readthedocs.io/en/latest/pkg_resources.html#parsing-utilities
                     versions.append(parse_version(version))
 
     if not len(versions):
-        raise MissingVersionsException(standard_distribution_name)
+        raise MissingVersions(standard_distribution_name)
     else:
         return max(versions)
 
@@ -153,7 +90,7 @@ def download():
     verbose = args.verbose
 
     if not standard_distribution_name.startswith('datadog-'):
-        raise NonDatadogPackageException(standard_distribution_name)
+        raise NonDatadogPackage(standard_distribution_name)
     else:
         wheel_distribution_name = __wheel_distribution_name(standard_distribution_name)
         tuf_downloader = TUFDownloader(verbose=verbose)
@@ -162,7 +99,7 @@ def download():
             version = __get_latest_version(tuf_downloader, standard_distribution_name, wheel_distribution_name)
         else:
             if not __is_canonical(version):
-                raise NonCanonicalVersionException(version)
+                raise NonCanonicalVersion(version)
 
         target_relpath = 'simple/{}/{}-{}-py2.py3-none-any.whl'\
                          .format(standard_distribution_name,
@@ -171,6 +108,6 @@ def download():
         try:
             target_abspath = tuf_downloader.download(target_relpath)
         except UnknownTargetError:
-            raise NoSuchDatadogPackageOrVersionException(standard_distribution_name, version)
+            raise NoSuchDatadogPackageOrVersion(standard_distribution_name, version)
 
         print(target_abspath)

datadog_checks_downloader/datadog_checks/downloader/download.py

@@ -38,6 +38,12 @@
 # The module is expected to live here.
 from .parameters import substitute
 
+# Exceptions.
+from .exceptions import (
+    NoInTotoLinkMetadataFound,
+    NoInTotoRootLayoutPublicKeysFound,
+)
+
 
 # CONSTANTS.
 here = os.path.abspath(os.path.dirname(__file__))
@@ -58,31 +64,6 @@
 logger = logging.getLogger(__name__)
 
 
-class TUFInTotoError(Exception):
-
-
-    def __init__(self, target_relpath):
-        self.target_relpath = target_relpath
-
-
-    def __str__(self):
-        return 'Unexpected tuf-in-toto error for {}!'.format(self.target_relpath)
-
-
-class NoInTotoLinkMetadataFound(TUFInTotoError):
-
-
-    def __str__(self):
-        return 'in-toto link metadata expected, but not found for {}!'.format(self.target_relpath)
-
-
-class NoInTotoRootLayoutPublicKeysFound(TUFInTotoError):
-
-
-    def __str__(self):
-        return 'in-toto root layout public keys expected, but not found for {}!'.format(self.target_relpath)
-
-
 class TUFDownloader:
 
 

datadog_checks_downloader/datadog_checks/downloader/exceptions.py

@@ -0,0 +1,101 @@
+# (C) Datadog, Inc. 2019
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+
+
+# Exceptions for the CLI module.
+
+
+class CLIError(Exception):
+
+
+    def __init__(self, standard_distribution_name):
+        self.standard_distribution_name = standard_distribution_name
+
+
+    def __str__(self):
+        return 'Unexpected CLI error for {}!'.format(self.standard_distribution_name)
+
+
+class InconsistentSimpleIndex(CLIError):
+
+
+    def __init__(self, href, text):
+        self.href = href
+        self.text = text
+
+
+    def __str__(self):
+        return '{} != {}'.format(self.href, self.text)
+
+
+class MissingVersions(CLIError):
+
+
+    def __str__(self):
+        return 'No version found for {} !'.format(self.standard_distribution_name)
+
+
+class NonCanonicalVersion(CLIError):
+
+
+    def __init__(self, version):
+        self.version = version
+
+
+    def __str__(self):
+        return '{} is not a valid PEP 440 version!'.format(self.version)
+
+
+class NonDatadogPackage(CLIError):
+
+
+    def __str__(self):
+        return '{} is not a Datadog package!'.format(self.standard_distribution_name)
+
+
+class NoSuchDatadogPackage(CLIError):
+
+
+    def __str__(self):
+        return 'Could not find the {} package!'.format(self.standard_distribution_name)
+
+
+class NoSuchDatadogPackageOrVersion(CLIError):
+
+
+    def __init__(self, standard_distribution_name, version):
+        super(NoSuchDatadogPackageOrVersion, self).__init__(standard_distribution_name)
+        self.version = version
+
+
+    def __str__(self):
+        return 'Either no {} package, or {} version!'.format(self.standard_distribution_name, self.version)
+
+
+# Exceptions for the download module.
+
+
+class TUFInTotoError(Exception):
+
+
+    def __init__(self, target_relpath):
+        self.target_relpath = target_relpath
+
+
+    def __str__(self):
+        return 'Unexpected tuf-in-toto error for {}!'.format(self.target_relpath)
+
+
+class NoInTotoLinkMetadataFound(TUFInTotoError):
+
+
+    def __str__(self):
+        return 'in-toto link metadata expected, but not found for {}!'.format(self.target_relpath)
+
+
+class NoInTotoRootLayoutPublicKeysFound(TUFInTotoError):
+
+
+    def __str__(self):
+        return 'in-toto root layout public keys expected, but not found for {}!'.format(self.target_relpath)