Clean up UI URL generation, added Backslash.get_ui_url helper method (fix #60)

Author: vmalloc

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

backslash/session.py

@@ -17,7 +17,7 @@ class Session(APIObject, MetadataHolder, ErrorContainer, WarningContainer, Archi
 
     @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

@@ -14,7 +14,7 @@ class Test(APIObject, MetadataHolder, ErrorContainer, WarningContainer, Commenta
 
     @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})

docs/changelog.rst

@@ -1,6 +1,7 @@
 Changelog
 =========
 
+* :feature:`60` Clean up UI URL generation, added ``Backslash.get_ui_url`` helper method
 * :feature:`58` Support reporting timing metrics
 * :feature:`57` Support reporting test status description
 * :release:`2.31.2 <14-9-2017>`

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

tests/test_urls.py

@@ -0,0 +1,7 @@
+from backslash import Backslash
+
+
+def test_client_get_ui_url():
+    assert Backslash('http://bla.com', None).get_ui_url() == 'http://bla.com/#/'
+    assert Backslash('http://bla.com', None).get_ui_url('/sessions') == 'http://bla.com/#/sessions'
+    assert Backslash('http://bla.com', None).get_ui_url('sessions') == 'http://bla.com/#/sessions'