Implementing RegisteredModel operations

Author: pebeto

docs/src/reference/registered_model.md

@@ -10,4 +10,8 @@ setregisteredmodeltag
 deleteregisteredmodeltag
 deleteregisteredmodelalias
 setregisteredmodelalias
+createregisteredmodelpermission
+getregisteredmodelpermission
+updateregisteredmodelpermission
+deleteregisteredmodelpermission
 ```

src/MLFlowClient.jl

@@ -75,7 +75,8 @@ include("services/registered_model.jl")
 export getregisteredmodel, createregisteredmodel, deleteregisteredmodel,
     renameregisteredmodel, updateregisteredmodel, searchregisteredmodels,
     setregisteredmodeltag, deleteregisteredmodeltag, deleteregisteredmodelalias,
-    setregisteredmodelalias
+    setregisteredmodelalias, createregisteredmodelpermission, getregisteredmodelpermission,
+    updateregisteredmodelpermission, deleteregisteredmodelpermission
 
 include("services/model_version.jl")
 export getlatestmodelversions, getmodelversion, createmodelversion, deletemodelversion,

src/services/registered_model.jl

@@ -190,3 +190,79 @@ function setregisteredmodelalias(instance::MLFlow, name::String, alias::String,
     mlfpost(instance, "registered-models/alias"; name=name, alias=alias, version=version)
     return true
 end
+
+"""
+    createregisteredmodelpermission(instance::MLFlow, name::String, username::String,
+        permission::Permission)
+
+# Arguments
+- `instance:` [`MLFlow`](@ref) configuration.
+- `name:` [`RegisteredModel`](@ref) name.
+- `username:` [`User`](@ref) username.
+- `permission:` [`Permission`](@ref) to grant.
+
+# Returns
+An instance of type [`RegisteredModelPermission`](@ref).
+"""
+function createregisteredmodelpermission(instance::MLFlow, name::String, username::String,
+    permission::Permission)::RegisteredModelPermission
+    result = mlfpost(instance, "registered-models/permissions/create"; name=name,
+        username=username, permission=permission)
+    return result["registered_model_permission"] |> RegisteredModelPermission
+end
+
+"""
+    getregisteredmodelpermission(instance::MLFlow, name::String, username::String)
+
+# Arguments
+- `instance:` [`MLFlow`](@ref) configuration.
+- `name:` [`RegisteredModel`](@ref) name.
+- `username:` [`User`](@ref) username.
+
+# Returns
+An instance of type [`RegisteredModelPermission`](@ref).
+"""
+function getregisteredmodelpermission(instance::MLFlow, name::String,
+    username::String)::RegisteredModelPermission
+    result = mlfget(instance, "registered-models/permissions/get"; name=name,
+        username=username)
+    return result["registered_model_permission"] |> RegisteredModelPermission
+end
+
+"""
+    updateregisteredmodelpermission(instance::MLFlow, name::String, username::String,
+        permission::Permission)
+
+# Arguments
+- `instance:` [`MLFlow`](@ref) configuration.
+- `name:` [`RegisteredModel`](@ref) name.
+- `username:` [`User`](@ref) username.
+- `permission:` New [`Permission`](@ref) to grant.
+
+# Returns
+`true` if successful. Otherwise, raises exception.
+"""
+function updateregisteredmodelpermission(instance::MLFlow, name::String, username::String,
+    permission::Permission)::Bool
+    mlfpatch(instance, "registered-models/permissions/update"; name=name, username=username,
+        permission=permission)
+    return true
+end
+
+"""
+    deleteregisteredmodelpermission(instance::MLFlow, name::String, username::String)
+
+# Arguments
+- `instance:` [`MLFlow`](@ref) configuration.
+- `name:` [`RegisteredModel`](@ref) name.
+- `username:` [`User`](@ref) username.
+
+# Returns
+`true` if successful. Otherwise, raises exception.
+"""
+function deleteregisteredmodelpermission(instance::MLFlow, name::String,
+    username::String)::Bool
+    mlfdelete(instance, "registered-models/permissions/delete"; name=name,
+        username=username)
+    return true
+end

src/types/registered_model.jl

@@ -63,5 +63,5 @@ struct RegisteredModelPermission
     permission::Permission
 end
 RegisteredModelPermission(data::Dict{String,Any}) = RegisteredModelPermission(data["name"],
-    data["user_id"], Permission(data["permission"]))
+    data["user_id"] |> string, Permission(data["permission"]))
 Base.show(io::IO, t::RegisteredModelPermission) = show(io, ShowCase(t, new_lines=true))

test/services/registered_model.jl

@@ -176,3 +176,70 @@ end
     deleteregisteredmodel(mlf, "missy")
     deleteexperiment(mlf, experiment)
 end
+
+@testset verbose = true "create registered model permission" begin
+    @ensuremlf
+
+    registered_model = createregisteredmodel(mlf, "missy"; description="gala")
+    user = createuser(mlf, "missy", "gala")
+    permission = createregisteredmodelpermission(mlf, registered_model.name, user.username, Permission("READ"))
+
+    @test permission isa RegisteredModelPermission
+    @test permission.name == registered_model.name
+    @test permission.user_id == user.id
+    @test permission.permission == Permission("READ")
+
+    deleteregisteredmodelpermission(mlf, registered_model.name, user.username)
+    deleteuser(mlf, user.username)
+    deleteregisteredmodel(mlf, "missy")
+end
+
+@testset verbose = true "get registered model permission" begin
+    @ensuremlf
+
+    registered_model = createregisteredmodel(mlf, "missy"; description="gala")
+    user = createuser(mlf, "missy", "gala")
+    permission = createregisteredmodelpermission(mlf, registered_model.name, user.username, Permission("READ"))
+    retrieved_permission = getregisteredmodelpermission(mlf, registered_model.name, user.username)
+
+    @test retrieved_permission isa RegisteredModelPermission
+    @test retrieved_permission.name == registered_model.name
+    @test retrieved_permission.user_id == user.id
+    @test retrieved_permission.permission == Permission("READ")
+
+    deleteregisteredmodelpermission(mlf, registered_model.name, user.username)
+    deleteuser(mlf, user.username)
+    deleteregisteredmodel(mlf, "missy")
+end
+
+@testset verbose = true "update registered model permission" begin
+    @ensuremlf
+
+    registered_model = createregisteredmodel(mlf, "missy"; description="gala")
+    user = createuser(mlf, "missy", "gala")
+    permission = createregisteredmodelpermission(mlf, registered_model.name, user.username, Permission("READ"))
+    updateregisteredmodelpermission(mlf, registered_model.name, user.username, Permission("MANAGE"))
+    retrieved_permission = getregisteredmodelpermission(mlf, registered_model.name, user.username)
+
+    @test retrieved_permission isa RegisteredModelPermission
+    @test retrieved_permission.name == registered_model.name
+    @test retrieved_permission.user_id == user.id
+    @test retrieved_permission.permission == Permission("MANAGE")
+
+    deleteregisteredmodelpermission(mlf, registered_model.name, user.username)
+    deleteuser(mlf, user.username)
+    deleteregisteredmodel(mlf, "missy")
+end
+#
+@testset verbose = true "delete registered model permission" begin
+    @ensuremlf
+
+    registered_model = createregisteredmodel(mlf, "missy"; description="gala")
+    user = createuser(mlf, "missy", "gala")
+    permission = createregisteredmodelpermission(mlf, registered_model.name, user.username, Permission("READ"))
+    deleteregisteredmodelpermission(mlf, registered_model.name, user.username)
+
+    @test_throws ErrorException getregisteredmodelpermission(mlf, registered_model.name, user.username)
+    deleteuser(mlf, user.username)
+    deleteregisteredmodel(mlf, "missy")
+end