Merge branch 'release/2.32.0'

Author: vmalloc

Makefile

@@ -9,11 +9,8 @@ doc: env
 env: .env/.up-to-date
 
 
-.env/.up-to-date: setup.py Makefile test_requirements.txt
+.env/.up-to-date: setup.py Makefile setup.cfg
 	virtualenv --no-site-packages .env
-	.env/bin/pip install -e .
-	.env/bin/pip install -r ./*.egg-info/requires.txt || true
-	.env/bin/pip install -r ./docs/requirements.txt
-	.env/bin/pip install -r test_requirements.txt
+	.env/bin/pip install -e .[testing]
 	touch $@
 

backslash/client.py

@@ -25,6 +25,18 @@ def __init__(self, url, runtoken):
     def url(self):
         return self._url
 
+    def get_ui_url(self, fragment=None):
+        returned = str(self.url)
+        if not returned.endswith('/'):
+            returned += '/'
+        if not fragment:
+            fragment = '/'
+        elif not fragment.startswith('/'):
+            fragment = '/' + fragment
+        returned += '#{}'.format(fragment)
+        return returned
+
+
     def toggle_user_role(self, user_id, role):
         return self.api.call_function('toggle_user_role', {'user_id': user_id, 'role': role})
 

backslash/contrib/slash_plugin.py

@@ -60,7 +60,7 @@ def new_func(self, *args, **kwargs):
 
 class BackslashPlugin(PluginInterface):
 
-    current_test = session = None
+    client = current_test = session = None
 
     def __init__(self, url=None, keepalive_interval=None, runtoken=None, propagate_exceptions=False):
         super(BackslashPlugin, self).__init__()
@@ -75,27 +75,22 @@ def __init__(self, url=None, keepalive_interval=None, runtoken=None, propagate_e
 
     @property
     def rest_url(self):
-        return URL(self._get_backslash_url()).add_path('rest')
+        if self.client is None:
+            return None
+        return self.client.url.add_path('rest')
 
     @property
     def webapp_url(self):
-        return self._url_with_fragment('/')
+        if self.client is None:
+            return None
+        return self.client.get_ui_url()
 
     @property
     def session_webapp_url(self):
         session = slash.context.session
-        if session is None:
+        if session is None or self.client is None:
             return None
-        return self._url_with_fragment('sessions/{}'.format(session.id))
-
-    def _url_with_fragment(self, fragment):
-        returned = str(self._get_backslash_url())
-        if not returned.endswith('/'):
-            returned += '/'
-        if not fragment.startswith('/'):
-            fragment = '/' + fragment
-        returned += '#{}'.format(fragment)
-        return returned
+        return self.client.get_ui_url('sessions/{}'.format(session.id))
 
     def _handle_exception(self, exc_info):
         pass
@@ -199,6 +194,7 @@ def test_avoided(self, reason):
         self.test_skip(reason=reason)
         self.test_end()
 
+
     @handle_exceptions
     def test_interrupt(self):
         if self.current_test is not None:
@@ -411,6 +407,20 @@ def session_end(self):
 
     @handle_exceptions
     def error_added(self, result, error):
+        self._add_exception(result=result, exception=error)
+
+    @slash.plugins.register_if(hasattr(slash.hooks, 'interruption_added'))
+    @handle_exceptions
+    def interruption_added(self, result, exception):
+        self._add_exception(result=result, exception=exception, is_interruption=True)
+
+
+    def _add_exception(self, result, exception, is_interruption=False):
+        has_interruptions = self.client.api.info().endpoints.add_error.version >= 4
+        if is_interruption and not has_interruptions:
+            _logger.debug('Server does not support recording is_interruption exceptions. Skipping reporting')
+            return
+
         if result is slash.session.results.global_result:
             error_container = self.session
         else:
@@ -420,16 +430,21 @@ def error_added(self, result, error):
             _logger.debug('Could not determine error container to report on for {}', result)
             return
 
-        kwargs = {'exception_type': error.exception_type.__name__ if error.exception_type is not None else None,
-                  'traceback': distill_slash_traceback(error), 'exception_attrs': getattr(error, 'exception_attributes', NOTHING)}
-        if error.message:
-            message = error.message
-        elif hasattr(error, 'exception_str'):
-            message = error.exception_str
+        kwargs = {'exception_type': exception.exception_type.__name__ if exception.exception_type is not None else None,
+                  'traceback': distill_slash_traceback(exception), 'exception_attrs': getattr(exception, 'exception_attributes', NOTHING)}
+        if exception.message:
+            message = exception.message
+        elif hasattr(exception, 'exception_str'):
+            message = exception.exception_str
         else:
-            message = str(error.exception)
+            message = str(exception.exception)
+
+
         kwargs['message'] = message
 
+        if has_interruptions:
+            kwargs['is_interruption'] = is_interruption
+
         for compact_variables in [False, True]:
             if compact_variables:
                 for frame in kwargs['traceback']:

backslash/error_container.py

@@ -13,13 +13,15 @@
 
 class ErrorContainer(object):
 
-    def add_error(self, message, exception_type=NOTHING, traceback=NOTHING, timestamp=NOTHING, is_failure=NOTHING, exception_attrs=NOTHING):
+    def add_error(self, message, exception_type=NOTHING, traceback=NOTHING,
+                  timestamp=NOTHING, is_failure=NOTHING, exception_attrs=NOTHING, is_interruption=NOTHING):
 
         kwargs = {self._get_id_key(): self.id,  # pylint: disable=no-member
                   'message': message,
                   'exception_type': exception_type,
                   'is_failure': is_failure,
-                  'timestamp': timestamp
+                  'timestamp': timestamp,
+                  'is_interruption': is_interruption,
                   }
 
         add_error_version = self.client.api.info().endpoints.add_error.version # pylint: disable=no-member

backslash/session.py

@@ -9,14 +9,15 @@
 from .warning_container import WarningContainer
 from .lazy_query import LazyQuery
 from .metadata_holder import MetadataHolder
+from .timing_container import TimingContainer
 
 APPEND_UPCOMING_TESTS_STR = 'append_upcoming_tests'
 
-class Session(APIObject, MetadataHolder, ErrorContainer, WarningContainer, Archiveable, Commentable, RelatedEntityContainer):
+class Session(APIObject, MetadataHolder, ErrorContainer, WarningContainer, Archiveable, Commentable, RelatedEntityContainer, TimingContainer):
 
     @property
     def ui_url(self):
-        return self.client.url + '#/sessions/{}'.format(self.logical_id or self.id)
+        return self.client.get_ui_url('/sessions/{}'.format(self.logical_id or self.id))
 
     def report_end(self, duration=NOTHING, has_fatal_errors=NOTHING):
 

backslash/test.py

@@ -7,13 +7,14 @@
 from .warning_container import WarningContainer
 from .lazy_query import LazyQuery
 from .metadata_holder import MetadataHolder
+from .timing_container import TimingContainer
 
 
-class Test(APIObject, MetadataHolder, ErrorContainer, WarningContainer, Commentable, RelatedEntityContainer):
+class Test(APIObject, MetadataHolder, ErrorContainer, WarningContainer, Commentable, RelatedEntityContainer, TimingContainer):
 
     @property
     def ui_url(self):
-        return self.client.url + '#/sessions/{}/tests/{}'.format(self.session_display_id, self.logical_id or self.id)
+        return self.client.get_ui_url('sessions/{}/tests/{}'.format(self.session_display_id, self.logical_id or self.id))
 
     def report_end(self, duration=NOTHING):
         self.client.api.call_function('report_test_end', {'id': self.id, 'duration': duration})
@@ -24,9 +25,6 @@ def mark_skipped(self, reason=None):
     def report_interrupted(self):
         self.client.api.call_function('report_test_interrupted', {'id': self.id})
 
-    def edit_status(self, status):
-        return self.client.api.call_function('edit_test_status', {'id': self.id, 'status': status})
-
     def query_errors(self):
         """Queries tests of the current session
 
@@ -39,3 +37,6 @@ def get_session(self):
 
     def get_parent(self):
         return self.get_session()
+
+    def update_status_description(self, description):
+        return self.client.api.call_function('update_status_description', {'test_id': self.id, 'description': description})

backslash/timing_container.py

@@ -0,0 +1,21 @@
+class TimingContainer(object):
+
+    def report_timing_start(self, name):
+        self._report('start', name)
+
+    def report_timing_end(self, name):
+        self._report('end', name)
+
+    def _report(self, start_stop, name):
+        kwargs = {'name': name}
+        kwargs.update(self._get_identity_kwargs())
+        self.client.api.call_function('report_timing_{}'.format(start_stop), kwargs) # pylint: disable=no-member
+
+    def _get_identity_kwargs(self):
+        if self.type.lower() == 'session': # pylint: disable=no-member
+            return {'session_id': self.id} # pylint: disable=no-member
+
+        return {'test_id': self.id, 'session_id': self.session_id} # pylint: disable=no-member
+
+    def get_timings(self):
+        return self.client.api.call.get_timings(**self._get_identity_kwargs()) # pylint: disable=no-member

docs/changelog.rst

@@ -1,12 +1,17 @@
 Changelog
 =========
 
+* :release:`2.32.0 <30-10-2017>`
+* :feature:`60` Clean up UI URL generation, added ``Backslash.get_ui_url`` helper method
+* :feature:`59` Support reporting interruption exceptions to Backslash
+* :feature:`58` Support reporting timing metrics
+* :feature:`57` Support reporting test status description
 * :release:`2.31.2 <14-9-2017>`
 * :bug:`54` Handle cases of detached head correctly when deducing local branch
 * :release:`2.31.1 <11-9-2017>`
 * :bug:`53` Use api session when constructing lazy queries
 * :release:`2.31.0 <10-9-2017>`
-* :feature:`52` Support reporting sessions with a specific TTL, marking them for future deletion on the server
+* :feature:`52` Support reporting sessions with a specific TTL, marking them for future deletion on the server. This can be also specified in the command-line, by passing ``--session-ttl-days=X``
 * :feature:`51` Report local and remote SCM branches if supported
 * :release:`2.30.0 <8-8-2017>`
 * :feature:`50` Added session_webapp_url property to the Slash plugin

tests/test_api_object.py

@@ -49,9 +49,9 @@ def test_ui_url(client, object_type, logical_id, use_logical):
     url = obj.ui_url
     display_id = logical_id if use_logical else id
     if object_type is test.Test:
-        assert url == client.url + '#/sessions/{}/tests/{}'.format(data['session_display_id'], display_id)
+        assert url == client.url + '/#/sessions/{}/tests/{}'.format(data['session_display_id'], display_id)
     else:
-        assert url == client.url + '#/{}s/{}'.format(object_type.__name__.lower(), display_id)
+        assert url == client.url + '/#/{}s/{}'.format(object_type.__name__.lower(), display_id)
 
 
 @pytest.fixture

tests/test_slash_plugin.py

@@ -31,27 +31,28 @@ def test_exception_distilling_surrounding_code(traceback):
 
 
 def test_rest_url(installed_plugin, server_url):
+    installed_plugin.activate()
     assert installed_plugin.rest_url == server_url.add_path('rest')
 
 def test_webapp_url(installed_plugin, server_url):
+    installed_plugin.activate()
     expected = server_url
     if not expected.endswith('/'):
         expected += '/'
     expected += '#/'
     assert installed_plugin.webapp_url == expected
 
+
 def test_session_webapp_url_no_session(installed_plugin):
     assert installed_plugin.session_webapp_url is None
 
 def test_session_webapp_url_with_session(installed_plugin, server_url):
+    installed_plugin.activate()
     with slash.Session() as s:
         url = installed_plugin.session_webapp_url
     assert url == '{}/#/sessions/{}'.format(server_url, s.id)
 
 
-
-
-
 @pytest.fixture
 def traceback(error_result):
     [e] = error_result.get_errors()
@@ -75,7 +76,7 @@ def test_failing():
 @pytest.fixture
 def installed_plugin(request, server_url):
     from backslash.contrib import slash_plugin
-    plugin = slash_plugin.BackslashPlugin(url=str(server_url))
+    plugin = slash_plugin.BackslashPlugin(url=str(server_url), runtoken='blap')
 
     @request.addfinalizer
     def cleanup():              # pylint: disable=unused-variable