Added MarketplaceResource and its tests.

Author: JaviCerveraIngram

connect/exceptions.py

@@ -145,3 +145,15 @@ class FileRetrievalError(Message):
     def __init__(self, message):
         # type: (str) -> None
         super(FileRetrievalError, self).__init__(message, 'fileretrieval')
+
+
+class UpdateResourceError(Message):
+    def __init__(self, message):
+        # type: (str) -> None
+        super(UpdateResourceError, self).__init__(message, 'updateresource')
+
+
+class DeleteResourceError(Message):
+    def __init__(self, message):
+        # type: (str) -> None:
+        super(DeleteResourceError, self).__init__(message, 'deleteresource')

connect/resources/__init__.py

@@ -5,6 +5,7 @@
 
 from .directory import Directory
 from .fulfillment_automation import FulfillmentAutomation
+from .marketplace import MarketplaceResource
 from .template import TemplateResource
 from .tier_config_automation import TierConfigAutomation
 from .usage_automation import UsageAutomation
@@ -17,6 +18,7 @@
 __all__ = [
     'Directory',
     'FulfillmentAutomation',
+    'MarketplaceResource',
     'TemplateResource',
     'TierConfigAutomation',
     'UsageAutomation',

connect/resources/directory.py

@@ -11,6 +11,7 @@
 from connect.models.product import Product
 from connect.models.tier_config import TierConfig
 from connect.resources.base import ApiClient
+from connect.resources.marketplace import MarketplaceResource
 from connect.resources.tier_account import TierAccountResource
 from connect.rql import Query
 
@@ -55,9 +56,7 @@ def list_marketplaces(self, filters=None):
         :return: List of marketplaces matching given filters.
         :rtype: list[Marketplace]
         """
-        query = self._get_filters_query(filters, False)
-        text, code = ApiClient(self._config, 'marketplaces' + query.compile()).get()
-        return Marketplace.deserialize(text)
+        return MarketplaceResource(self._config).list(filters)
 
     def get_marketplace(self, marketplace_id):
         """ Obtains Marketplace object given its ID.
@@ -66,8 +65,7 @@ def get_marketplace(self, marketplace_id):
         :return: The marketplace with the given id, or ``None`` if such marketplace does not exist.
         :rtype: Marketplace|None
         """
-        text, code = ApiClient(self._config, 'marketplaces/' + marketplace_id).get()
-        return Marketplace.deserialize(text)
+        return MarketplaceResource(self._config).get(marketplace_id)
 
     def list_products(self, filters=None):
         """ List the products.

connect/resources/marketplace.py

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+
+# This file is part of the Ingram Micro Cloud Blue Connect SDK.
+# Copyright (c) 2019-2020 Ingram Micro. All Rights Reserved.
+
+from requests import RequestException
+
+from .base import BaseResource
+from connect.exceptions import DeleteResourceError, ServerError, UpdateResourceError
+from ..models import Marketplace
+
+
+class MarketplaceResource(BaseResource):
+    """ Resource to work with :py:class:`connect.models.Marketplace` models.
+        :param Config config: Config object or ``None`` to use environment config (default).
+    """
+    DELETE_ERR = 'Error deleting marketplace {}: {}'
+    UPLOAD_ERR = 'Error uploading icon for Marketplace {}: {}'
+    RESPONSE_ERR = 'Unexpected server response, returned code {} -- Raw response: {}'
+    resource = 'marketplaces'
+    model_class = Marketplace
+
+    def __init__(self, config=None):
+        super(MarketplaceResource, self).__init__(config)
+
+    def set_icon(self, id_, path):
+        """ Sets or updates the Marketplace icon.
+
+        :param str id_: Id of the Marketplace.
+        :param str path: Path to the icon file that will be sent to Connect.
+        :return: Whether the icon was successfully uploaded.
+        :rtype: bool
+        """
+        icon = self._load_icon(id_, path)
+        request_path, headers, multipart = self._setup_icon_request(id_, path, icon)
+        self._post_icon_request(id_, request_path, headers, multipart)
+
+    def _load_icon(self, id_, path):
+        # type: (str, str) -> bytes
+        try:
+            with open(path, 'rb') as f:
+                return f.read()
+        except IOError as ex:
+            raise UpdateResourceError(self.UPLOAD_ERR.format(id_, ex))
+
+    def _setup_icon_request(self, id_, path, icon):
+        # type: (str, str, bytes) -> (str, dict, dict)
+        request_path = self._api.urljoin(id_, 'icon')
+        headers = self._api.headers
+        headers['Accept'] = 'application/json'
+        del headers['Content-Type']  # This must NOT be set for multipart post requests
+        multipart = {'icon': (path, icon)}
+        self.logger.info('HTTP Request: {} - {} - {}'.format(request_path, headers, multipart))
+        return request_path, headers, multipart
+
+    def _post_icon_request(self, id_, path, headers, multipart):
+        # type: (str, str, dict, dict) -> None
+        try:
+            content, status = self._api.post(
+                path=path,
+                headers=headers,
+                files=multipart)
+        except (RequestException, ServerError) as ex:
+            raise UpdateResourceError(self.UPLOAD_ERR.format(id_, ex))
+        self._raise_if_invalid_status(200, status, content, UpdateResourceError)
+
+    def _raise_if_invalid_status(self, required, obtained, content, ex_class):
+        # type: (int, int, str, type) -> None
+        self.logger.info('HTTP Code: {}'.format(obtained))
+        if obtained != required:
+            msg = self.RESPONSE_ERR.format(obtained, content)
+            self.logger.error(msg)
+            raise ex_class(msg)
+
+    def delete(self, id_):
+        """ Deletes a Marketplace.
+
+        :param id_: Id of the Marketplace.
+        :return:
+        """
+        try:
+            content, status = self._api.delete(path=id_)
+        except (RequestException, ServerError) as ex:
+            raise DeleteResourceError(self.DELETE_ERR.format(id_, ex))
+        self._raise_if_invalid_status(204, status, content, DeleteResourceError)

tests/data/icon.png

@@ -102,6 +102,7 @@ def test_list_marketplaces(get_mock):
     get_mock.assert_called_with(
         url='http://localhost:8080/api/public/v1/marketplaces',
         headers={'Content-Type': 'application/json', 'Authorization': 'ApiKey XXXX:YYYYY'},
+        params={'limit': 100},
         timeout=300)
 
 

tests/test_directory.py

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+
+# This file is part of the Ingram Micro Cloud Blue Connect SDK.
+# Copyright (c) 2019-2020 Ingram Micro. All Rights Reserved.
+
+from mock import MagicMock, patch
+
+import pytest
+from requests import RequestException
+
+from .common import Response
+from connect.exceptions import DeleteResourceError, ServerError, UpdateResourceError
+from connect.models import ServerErrorResponse
+from connect.resources import MarketplaceResource
+
+
+ICON_FILE = 'tests/data/icon.png'
+
+
+@patch('requests.post')
+def test_set_icon_ok(post_mock):
+    post_mock.return_value = Response(True, None, 200)
+    with open(ICON_FILE, 'rb') as f:
+        icon = f.read()
+
+    MarketplaceResource().set_icon('MP-XXX', ICON_FILE)
+
+    post_mock.assert_called_with(
+        url='http://localhost:8080/api/public/v1/marketplaces/MP-XXX/icon',
+        headers={'Accept': 'application/json', 'Authorization': 'ApiKey XXXX:YYYYY'},
+        files={'icon': (ICON_FILE, icon)},
+        timeout=300)
+
+
+def test_set_icon_bad_file():
+    with pytest.raises(UpdateResourceError):
+        MarketplaceResource().set_icon('MP-XXX', 'non_existing_icon.png')
+
+
+@patch('requests.post', MagicMock(side_effect=RequestException()))
+def test_set_icon_request_exception():
+    with pytest.raises(UpdateResourceError):
+        MarketplaceResource().set_icon('MP-XXX', ICON_FILE)
+
+
+@patch('requests.post', MagicMock(side_effect=ServerError(ServerErrorResponse())))
+def test_set_icon_server_error():
+    with pytest.raises(UpdateResourceError):
+        MarketplaceResource().set_icon('MP-XXX', ICON_FILE)
+
+
+@patch('requests.post', MagicMock(return_value=Response(False, '', 500)))
+def test_set_icon_status_500():
+    with pytest.raises(UpdateResourceError):
+        MarketplaceResource().set_icon('MP-XXX', ICON_FILE)
+
+
+@patch('requests.delete')
+def test_delete_ok(delete_mock):
+    delete_mock.return_value = Response(True, None, 204)
+
+    MarketplaceResource().delete('MP-XXX')
+
+    delete_mock.assert_called_with(
+        url='http://localhost:8080/api/public/v1/marketplaces/MP-XXX',
+        headers={'Content-Type': 'application/json', 'Authorization': 'ApiKey XXXX:YYYYY'},
+        timeout=300)
+
+
+@patch('requests.delete', MagicMock(side_effect=RequestException()))
+def test_delete_request_exception():
+    with pytest.raises(DeleteResourceError):
+        MarketplaceResource().delete('MP-XXX')
+
+
+@patch('requests.delete', MagicMock(side_effect=ServerError(ServerErrorResponse())))
+def test_delete_server_error():
+    with pytest.raises(DeleteResourceError):
+        MarketplaceResource().delete('MP-XXX')
+
+
+@patch('requests.delete', MagicMock(return_value=Response(False, '', 500)))
+def test_delete_status_500():
+    with pytest.raises(DeleteResourceError):
+        MarketplaceResource().delete('MP-XXX')