For #28441: FIXED version checks, better API flag tests

Author: nemoDreamer

shotgun_api3/shotgun.py

@@ -137,7 +137,7 @@ def __init__(self, host, meta):
         self.ensure_json_supported()
 
 
-    def _ensure_support(self, feature):
+    def _ensure_support(self, feature, raise_hell=True):
         """Checks the server version supports a given feature, raises an
         exception if it does not.
 
@@ -147,10 +147,11 @@ def _ensure_support(self, feature):
         """
 
         if not self.version or self.version < feature['version']:
-            raise ShotgunError(
-                "%s requires server version %s or higher, "\
-                "server is %s" % (feature['label'], _version_str(feature['version']), _version_str(self.version))
-            )
+            if raise_hell:
+                raise ShotgunError(
+                    "%s requires server version %s or higher, "\
+                    "server is %s" % (feature['label'], _version_str(feature['version']), _version_str(self.version))
+                )
             return False
         else:
             return True
@@ -163,19 +164,23 @@ def ensure_json_supported(self):
             'label': 'JSON API'
         })
 
-    def ensure_include_archived_projects(self):
+    def ensure_include_archived_projects(self, value=True):
         """Wrapper for ensure_support"""
+        # This defaults to True on the server
+        # So we only need to raise a version error if it's False
         return self._ensure_support({
             'version': (5, 3, 14),
             'label': 'include_archived_projects parameter'
-        })
+        }, (value == False))
 
-    def ensure_include_template_projects(self):
+    def ensure_include_template_projects(self, value=False):
         """Wrapper for ensure_support"""
+        # This defaults to False on the server
+        # So we only need to raise a version error if it's True
         return self._ensure_support({
             'version': (6, 0, 0),
             'label': 'include_template_projects parameter'
-        })
+        }, (value == True))
 
 
     def __str__(self):
@@ -665,19 +670,11 @@ def _construct_flag_parameters(self,
                                    include_archived_projects,
                                    include_template_projects):
 
-        if not include_archived_projects:
-            # This defaults to True on the server (no argument is sent)
-            # So we only need to check the server version if it's False
-            self.server_caps.ensure_include_archived_projects()
-            # Only pass it if it's False
-            params["include_archived_projects"] = False
+        if self.server_caps.ensure_include_archived_projects(include_archived_projects):
+            params["include_archived_projects"] = include_archived_projects
 
-        if include_template_projects:
-            # This defaults to False on the server (no argument is sent)
-            # So we only need to check the server version if it's True
-            self.server_caps.ensure_include_template_projects()
-            # Only pass it if it's True
-            params["include_template_projects"] = True
+        if self.server_caps.ensure_include_template_projects(include_template_projects):
+            params["include_template_projects"] = include_template_projects
 
         return params
 
@@ -1644,6 +1641,7 @@ def _call_rpc(self, method, params, include_auth_params=True, first=False):
 
         """
 
+        log_time = datetime.datetime.now()
         LOG.debug("Starting rpc call to %s with params %s" % (
             method, params))
 
@@ -1658,7 +1656,10 @@ def _call_rpc(self, method, params, include_auth_params=True, first=False):
         }
         http_status, resp_headers, body = self._make_call("POST",
             self.config.api_path, encoded_payload, req_headers)
-        LOG.debug("Completed rpc call to %s" % (method))
+
+        log_time = datetime.datetime.now() - log_time
+        LOG.debug("Completed rpc call to %s in %s" % (method, str(log_time)))
+
         try:
             self._parse_http_status(http_status)
         except ProtocolError, e:

tests/base.py

@@ -3,13 +3,14 @@
 import unittest
 from ConfigParser import ConfigParser
 
-
 import mock
 
 import shotgun_api3 as api
 from shotgun_api3.shotgun import json
 from shotgun_api3.shotgun import ServerCapabilities
 
+import logging
+
 CONFIG_PATH = 'tests/config'
 
 class TestBase(unittest.TestCase):
@@ -35,6 +36,10 @@ def __init__(self, *args, **kws):
 
 
     def setUp(self, auth_mode='ApiUser'):
+
+        self.LOG = logging.getLogger("shotgun_api3")
+        self.LOG.setLevel(logging.WARN)
+
         self.config = SgTestConfig()
         self.config.read_config(CONFIG_PATH)
         self.human_login    = self.config.human_login
@@ -185,10 +190,14 @@ def _setup_mock_data(self):
 
 class LiveTestBase(TestBase):
     '''Test base for tests relying on connection to server.'''
+
     def setUp(self, auth_mode='ApiUser'):
         super(LiveTestBase, self).setUp(auth_mode)
+
         self.sg_version = self.sg.info()['version'][:3]
+
         self._setup_db(self.config)
+
         if self.sg.server_caps.version and \
            self.sg.server_caps.version >= (3, 3, 0) and \
            (self.sg.server_caps.host.startswith('0.0.0.0') or \
@@ -197,17 +206,22 @@ def setUp(self, auth_mode='ApiUser'):
         else:
             self.server_address = self.sg.server_caps.host
 
+
     def _setup_db(self, config):
         data = {'name':self.config.project_name}
         self.project = _find_or_create_entity(self.sg, 'Project', data)
 
+        self.template_project = _find_or_create_entity(self.sg, 'Project', {
+            'name': 'Template Project',
+            'is_template': True
+        })
+
         data = {'name':self.config.human_name,
                 'login':self.config.human_login,
                 'password_proxy':self.config.human_password}
         if self.sg_version >= (3, 0, 0):
             data['locked_until'] = None
 
-
         self.human_user = _find_or_create_entity(self.sg, 'HumanUser', data)
 
         data = {'code':self.config.asset_code,
@@ -256,6 +270,12 @@ def _setup_db(self, config):
         keys = ['title','project', 'sg_priority']
         self.ticket = _find_or_create_entity(self.sg, 'Ticket', data, keys)
 
+        data = {'project': self.template_project,
+                'title': self.config.ticket_title,
+                'sg_priority': '1'}
+        keys = ['title', 'project', 'sg_priority']
+        self.template_ticket = _find_or_create_entity(self.sg, 'Ticket', data, keys)
+
         keys = ['code']
         data = {'code':'api wrapper test storage',
                 'mac_path':'nowhere',