Merge pull request #102 from NathanPruyne/visibility_specification

Add visibility specification based on group and user URNs

dlhub_sdk/models/__init__.py

@@ -204,15 +204,26 @@ def set_domains(self, domains):
         self._output["dlhub"]["domains"] = domains
         return self
 
-    def set_visibility(self, visible_to):
-        """Define the list of people and groups who have permissions to see and use this model.
+    def set_visibility(self, users=None, groups=None):
+        """Set the list of people this artifact should be visible to.
 
         By default, it will be visible to anyone (["public"]).
 
         Args:
-            visible_to ([string]): List of allowed users and groups, listed by GlobusAuth UUID
+            users ([string]): List of GlobusAuth UUIDs of allowed users
+            groups ([string]): List of GlobusAuth UUIDs of allowed Globus groups
         """
-        self._output["dlhub"]["visible_to"] = visible_to
+        visibilities = []
+        if not (users or groups):
+            visibilities.append('public')
+        else:
+            if users:
+                for user in users:
+                    visibilities.append('urn:globus:auth:identity:' + user)
+            if groups:
+                for group in groups:
+                    visibilities.append('urn:globus:groups:id:' + group)
+        self._output["dlhub"]["visible_to"] = visibilities
         return self
 
     def set_doi(self, doi):

dlhub_sdk/tests/test_dlhub_client.py

@@ -4,6 +4,8 @@
 from dlhub_sdk.models.servables.python import PythonStaticMethodModel
 from dlhub_sdk.utils.futures import DLHubFuture
 from dlhub_sdk.client import DLHubClient
+from dlhub_sdk.utils.schemas import validate_against_dlhub_schema
+from jsonschema.exceptions import ValidationError
 
 
 # Check if we are on travis
@@ -205,3 +207,28 @@ def test_status(self):
         future = self.dl.run('zhuozhao_uchicago/noop', 'test', asynchronous=True)
         # Need spec for Fx status returns
         self.assertIsInstance(self.dl.get_task_status(future.task_id), dict)
+
+    def test_visibility(self):
+        model = PythonStaticMethodModel.create_model('numpy.linalg', 'norm')
+        model.set_name('1d_norm')
+        model.set_title('Norm of a 1D Array')
+        model.set_inputs('ndarray', 'Array to be normed', shape=[None])
+        model.set_outputs('number', 'Norm of the array')
+
+        model.set_visibility(users=['bec215bc-9169-4be9-af49-4872b5e11ef8']) #Setting visibility to a user
+        validate_against_dlhub_schema(model.to_dict(), 'servable')
+        self.assertTrue(model['dlhub']['visible_to'][0].startswith('urn:globus:auth:identity:'))
+
+        model.set_visibility(groups=['fdb38a24-03c1-11e3-86f7-12313809f035']) #Setting visibility to a group
+        validate_against_dlhub_schema(model.to_dict(), 'servable')
+        self.assertEqual(len(model['dlhub']['visible_to']), 1) #Ensure was replaced, not appended
+        self.assertTrue(model['dlhub']['visible_to'][0].startswith('urn:globus:groups:id:'))
+
+        model.set_visibility(users=['foo']) #Test using a non-UUID for user
+        with self.assertRaises(ValidationError):
+            validate_against_dlhub_schema(model.to_dict(), 'servable')
+
+        model.set_visibility() #Default visibility is "public"
+        validate_against_dlhub_schema(model.to_dict(), 'servable')
+        self.assertEqual(model['dlhub']['visible_to'], ['public'])
+