Check provider api version for compatibility

4 files changed, 60 insertions, 0 deletions

diff --git a/changes/feature_2774-check_provider_api_version b/changes/feature_2774-check_provider_api_version
new file mode 100644
index 00000000..82294ce4
--- /dev/null
+++ b/changes/feature_2774-check_provider_api_version
@@ -0,0 +1 @@
+  o Check if the provider api version is supported. Closes feature #2774.
diff --git a/src/leap/provider/__init__.py b/src/leap/provider/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/src/leap/provider/__init__.py
diff --git a/src/leap/provider/supportedapis.py b/src/leap/provider/supportedapis.py
new file mode 100644
index 00000000..3e650ba2
--- /dev/null
+++ b/src/leap/provider/supportedapis.py
@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+# supportedapis.py
+# Copyright (C) 2013 LEAP
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API Support check.
+"""
+
+
+class SupportedAPIs(object):
+    """
+    Class responsible of checking for API compatibility.
+    """
+    SUPPORTED_APIS = ["1"]
+
+    @classmethod
+    def supports(self, api_version):
+        """
+        :param api_version: the version number of the api that we need to check
+        :type api_version: str
+
+        :returns: if that version is supported or not.
+        :return type: bool
+        """
+        return api_version in self.SUPPORTED_APIS
diff --git a/src/leap/services/eip/providerbootstrapper.py b/src/leap/services/eip/providerbootstrapper.py
index 1339e086..e099eee7 100644
--- a/src/leap/services/eip/providerbootstrapper.py
+++ b/src/leap/services/eip/providerbootstrapper.py
@@ -32,10 +32,19 @@ from leap.common.check import leap_assert, leap_assert_type
 from leap.config.providerconfig import ProviderConfig
 from leap.util.request_helpers import get_content
 from leap.services.abstractbootstrapper import AbstractBootstrapper
+from leap.provider.supportedapis import SupportedAPIs
+
 
 logger = logging.getLogger(__name__)
 
 
+class UnsupportedProviderAPI(Exception):
+    """
+    Raised when attempting to use a provider with an incompatible API.
+    """
+    pass
+
+
 class ProviderBootstrapper(AbstractBootstrapper):
     """
     Given a provider URL performs a series of checks and emits signals
@@ -142,6 +151,18 @@ class ProviderBootstrapper(AbstractBootstrapper):
                                   self._domain,
                                   "provider.json"])
 
+            api_version = provider_config.get_api_version()
+            if SupportedAPIs.supports(api_version):
+                logger.debug("Provider definition has been modified")
+            else:
+                api_supported = ', '.join(self._supported_api_versions)
+                error = ('Unsupported provider API version. '
+                         'Supported versions are: {}. '
+                         'Found: {}.').format(api_supported, api_version)
+
+                logger.error(error)
+                raise UnsupportedProviderAPI(error)
+
     def run_provider_select_checks(self, domain, download_if_needed=False):
         """
         Populates the check queue.