DSLoginBuilder validations

Author: ymarcon

datashield/__init__.py

@@ -0,0 +1 @@
+from datashield.utils import DSLoginBuilder

datashield/utils.py

@@ -10,16 +10,44 @@ class DSLoginBuilder:
     def __init__(self):
         self.items = list()
 
-    def add(self, name: str, url: str, user: str = None, password: str = None, token: str = None, profile: str = 'default'):
+    def add(self, name: str, url: str, user: str = None, password: str = None, token: str = None, profile: str = 'default', driver: str = 'datashield_opal.OpalDriver'):
+        """
+        Add DataSHIELD login information.
+
+        :param name: The name of the server, must be unique
+        :param url: The URL of the server
+        :param user: The user name (required if token is None)
+        :param password: The user password
+        :param token: The access token (required if user is None)
+        :param profile: The DataSHIELD profile name to be used
+        :param driver: The DataSHIELD connection driver class full name 
+        """
+        if name is None:
+            raise ValueError('Server name is missing')
+        if url is None:
+            raise ValueError('Server URL is missing')
+        found = [x for x in self.items if x['name'] == name]
+        if len(found) > 0:
+            raise ValueError('Server name must be unique: %s' % name)
+        if user is None and token is None:
+            raise ValueError('Either user or token must be provided')
         self.items.append({
             'name': name,
             'url': url,
             'user': user,
             'password': password,
             'token': token,
-            'profile': profile
+            'profile': profile if profile is not None else 'default',
+            'driver': driver if driver is not None else 'datashield_opal.OpalDriver'
         })
         return self
 
+    def remove(self, name: str):
+        """
+        Remove the DataSHIELD login information by its name, if it exists.
+        """
+        self.items = [x for x in self.items if x['name'] != name]
+        return self
+    
     def build(self):
         return self.items

tests/test_utils.py

@@ -1,4 +1,4 @@
-from datashield.utils import DSLoginBuilder
+from datashield import DSLoginBuilder
 
 def test_logins():
     builder = DSLoginBuilder().add('server1', 'https://opal-demo.obba.org', 'dsuser', 'P@ssw0rd').add('server2', 'https://demo.datashield.org', token = '1234abcd', profile = 'omics')
@@ -9,8 +9,39 @@ def test_logins():
     assert logins[0]['password'] is not None
     assert logins[0]['token'] is None
     assert logins[0]['profile'] == 'default'
+    assert logins[0]['driver'] == 'datashield_opal.OpalDriver'
     assert logins[1]['name'] == 'server2'
     assert logins[1]['user'] is None
     assert logins[1]['password'] is None
     assert logins[1]['token'] is not None
-    assert logins[1]['profile'] == 'omics'
+    assert logins[1]['profile'] == 'omics'
+    builder.remove('server1')
+    logins = builder.build()
+    assert len(logins) == 1
+    assert logins[0]['name'] == 'server2'
+  
+def test_login_validations():
+    # name not missing
+    try:
+      DSLoginBuilder().add(None, 'https://opal-demo.obba.org', 'dsuser', 'P@ssw0rd')
+      assert False
+    except ValueError as e:
+       assert True
+    # url not missing
+    try:
+      DSLoginBuilder().add('server1', None, 'dsuser', 'P@ssw0rd')
+      assert False
+    except ValueError as e:
+       assert True
+    # name is unique
+    try:
+      DSLoginBuilder().add('server1', 'https://opal-demo.obba.org', 'dsuser', 'P@ssw0rd').add('server1', 'https://demo.datashield.org', token = '1234abcd')
+      assert False
+    except ValueError as e:
+       assert True
+    # either user and token is missing 
+    try:
+      DSLoginBuilder().add('server1', 'https://opal-demo.obba.org').add('server2', 'https://demo.datashield.org')
+      assert False
+    except ValueError as e:
+       assert True