For SG-13320: shared_thumbnail raises a specific error when transient thumbnail detected

Author: daigles

HISTORY.rst

@@ -4,6 +4,10 @@ Shotgun Python API Changelog
 
 Here you can see the full list of changes between each Python API release.
 
+v3.2.1 (TBD)
+=====================
+- Returns a specific error from 'share_thumbnail' when the source thumbnail is a 'transient' thumbnail.
+
 v3.2.0 (2019 Sept 23)
 =====================
 - Adds a new ``project_entity`` parameter to  ``schema_field_update`` that allows to modify field visibility for a given project.

README.md

@@ -100,8 +100,13 @@ Additionally, when testing locally, tests should be run for both python 2 and py
 
 Integration and unit tests are provided.
 
-- All tests require the [nose unit testing tools](http://nose.readthedocs.org), and a `tests/config` file (you can copy an example from `tests/example_config`).
-- Tests can be run individually like this: `nosetest tests/test_client.py`
+- All tests require:
+    - The [nose unit testing tools](http://nose.readthedocs.org),
+    - The [nose-exclude nose plugin](https://pypi.org/project/nose-exclude/)
+    - (Note: Running `pip install -r tests/ci_requirements.txt` will install this package)
+- A `tests/config` file (you can copy an example from `tests/example_config`).
+- Tests can be run individually like this: `nosetests --config="nose.cfg" tests/test_client.py`
+    - Make sure to not forget the `--config="nose.cfg"` option. This option tells nose to use our config file.  This will exclude python 2- and 3-specific files in the `/lib` directory, preventing a failure from being reported by nose for compilation due to incompatible syntax in those files.
 - `test_client` and `tests_unit` use mock server interaction and do not require a Shotgun instance to be available (no modifications to `tests/config` are necessary).
 - `test_api` and `test_api_long` *do* require a Shotgun instance, with a script key available for the tests. The server and script user values must be supplied in the `tests/config` file. The tests will add test data to your server based on information in your config. This data will be manipulated by the tests, and should not be used for other purposes.
 - To run all of the tests, use the shell script `run-tests`.

shotgun_api3/__init__.py

@@ -8,7 +8,8 @@
 # agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Shotgun Software Inc.
 
-from .shotgun import (Shotgun, ShotgunError, ShotgunFileDownloadError, Fault,  # noqa unused imports
+from .shotgun import (Shotgun, ShotgunError, ShotgunFileDownloadError, # noqa unused imports
+                      ShotgunThumbnailNotReady, Fault,
                       AuthenticationFault, MissingTwoFactorAuthenticationFault,
                       UserCredentialsNotAllowedForSSOAuthenticationFault,
                       ProtocolError, ResponseError, Error, __version__)

shotgun_api3/shotgun.py

@@ -117,7 +117,7 @@ def _is_mimetypes_broken():
 
 # ----------------------------------------------------------------------------
 # Version
-__version__ = "3.2.0"
+__version__ = "3.2.1.dev"
 
 # ----------------------------------------------------------------------------
 # Errors
@@ -137,6 +137,13 @@ class ShotgunFileDownloadError(ShotgunError):
     pass
 
 
+class ShotgunThumbnailNotReady(ShotgunError):
+    """
+    Exception for when trying to use a 'pending thumbnail' (aka transient thumbnail) in an operation
+    """
+    pass
+
+
 class Fault(ShotgunError):
     """
     Exception when server-side exception detected.
@@ -2271,14 +2278,16 @@ def share_thumbnail(self, entities, thumbnail_path=None, source_entity=None,
 
         result = self._send_form(url, params)
 
-        if not result.startswith("1"):
-            raise ShotgunError("Unable to share thumbnail: %s" % result)
-        else:
+        if result.startswith("1:"):
             # clearing thumbnail returns no attachment_id
             try:
                 attachment_id = int(result.split(":", 2)[1].split("\n", 1)[0])
             except ValueError:
                 attachment_id = None
+        elif result.startswith("2"):
+            raise ShotgunThumbnailNotReady("Unable to share thumbnail: %s" % result)
+        else:
+            raise ShotgunError("Unable to share thumbnail: %s" % result)
 
         return attachment_id
 

tests/test_api.py

@@ -604,6 +604,28 @@ def share_thumbnail_retry(*args, **kwargs):
         self.assertRaises(shotgun_api3.ShotgunError, self.sg.share_thumbnail,
                           [self.shot, self.asset])
 
+    @patch('shotgun_api3.Shotgun._send_form')
+    def test_share_thumbnail_not_ready(self, mock_send_form):
+        """throw an exception if trying to share a transient thumbnail"""
+
+        mock_send_form.method.assert_called_once()
+        mock_send_form.return_value = ("2"
+                                       "\nsource_entity image is a transient thumbnail that cannot be shared. "
+                                       "Try again later, when the final thumbnail is available\n")
+
+        self.assertRaises(shotgun_api3.ShotgunThumbnailNotReady, self.sg.share_thumbnail,
+                          [self.version, self.shot], source_entity=self.asset)
+
+    @patch('shotgun_api3.Shotgun._send_form')
+    def test_share_thumbnail_returns_error(self, mock_send_form):
+        """throw an exception if server returns an error code"""
+
+        mock_send_form.method.assert_called_once()
+        mock_send_form.return_value = "1\nerror message.\n"
+
+        self.assertRaises(shotgun_api3.ShotgunError, self.sg.share_thumbnail,
+                          [self.version, self.shot], source_entity=self.asset)
+
     def test_deprecated_functions(self):
         """Deprecated functions raise errors"""
         self.assertRaises(shotgun_api3.ShotgunError, self.sg.schema, "foo")