Add support for timing API (fix #58)

Author: vmalloc

backslash/session.py

@@ -9,10 +9,11 @@
 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):

backslash/test.py

@@ -7,9 +7,10 @@
 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):

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':
+            return {'session_id': self.id}
+
+        return {'test_id': self.id, 'session_id': self.session_id}
+
+    def get_timings(self):
+        return self.client.api.call.get_timings(**self._get_identity_kwargs())

docs/changelog.rst

@@ -1,6 +1,7 @@
 Changelog
 =========
 
+* :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