Implementing ExperimentPermission operations

Author: pebeto

docs/make.jl

@@ -12,6 +12,7 @@ makedocs(;
         "Miscellaneous operations" => "reference/misc.md",
         "Run operations" => "reference/run.md",
         "Registered model operations" => "reference/registered_model.md",
-        "Model version operations" => "reference/model_version.md",]])
+        "Model version operations" => "reference/model_version.md",
+        "User operations" => "reference/user.md",]])
 
 deploydocs(; repo="github.com/JuliaAI/MLFlowClient.jl", devbranch="main")

docs/src/reference/experiment.md

@@ -8,4 +8,8 @@ restoreexperiment
 updateexperiment
 searchexperiments
 setexperimenttag
+createexperimentpermission
+getexperimentpermission
+updateexperimentpermission
+deleteexperimentpermission
 ```

docs/src/reference/user.md

@@ -0,0 +1,8 @@
+# User operations
+```@docs
+createuser
+getuser
+updateuserpassword
+updateuseradmin
+deleteuser
+```

src/MLFlowClient.jl

@@ -54,7 +54,9 @@ include("utils.jl")
 
 include("services/experiment.jl")
 export getexperiment, createexperiment, deleteexperiment, setexperimenttag,
-    updateexperiment, restoreexperiment, searchexperiments, getexperimentbyname
+    updateexperiment, restoreexperiment, searchexperiments, getexperimentbyname,
+    createexperimentpermission, getexperimentpermission, updateexperimentpermission,
+    deleteexperimentpermission
 
 include("services/run.jl")
 export getrun, createrun, deleterun, setruntag, updaterun, restorerun, searchruns,

src/services/experiment.jl

@@ -207,3 +207,115 @@ setexperimenttag(instance::MLFlow, experiment_id::Integer, key::String,
 setexperimenttag(instance::MLFlow, experiment::Experiment, key::String,
     value::String)::Bool =
     setexperimenttag(instance, experiment.experiment_id, key, value)
+
+"""
+    createexperimentpermission(instance::MLFlow, experiment_id::String, username::String,
+        permission::Permission)
+    createexperimentpermission(instance::MLFlow, experiment_id::Integer, username::String,
+        permission::Permission)
+    createexperimentpermission(instance::MLFlow, experiment::Experiment, username::String,
+        permission::Permission)
+
+# Arguments
+- `instance`: [`MLFlow`](@ref) configuration.
+- `experiment_id`: [`Experiment`](@ref) id.
+- `username`: [`User`](@ref) username.
+- `permission`: [`Permission`](@ref) to grant.
+
+# Returns
+An instance of type [`ExperimentPermission`](@ref).
+"""
+function createexperimentpermission(instance::MLFlow, experiment_id::String,
+    username::String, permission::Permission)::ExperimentPermission
+    result = mlfpost(instance, "experiments/permissions/create";
+        experiment_id=experiment_id, username=username, permission=permission)
+    return result["experiment_permission"] |> ExperimentPermission
+end
+createexperimentpermission(instance::MLFlow, experiment_id::Integer,
+    username::String, permission::Permission)::ExperimentPermission =
+    createexperimentpermission(instance, experiment_id |> string, username, permission)
+createexperimentpermission(instance::MLFlow, experiment::Experiment,
+    username::String, permission::Permission)::ExperimentPermission =
+    createexperimentpermission(instance, experiment.experiment_id, username, permission)
+
+"""
+    getexperimentpermission(instance::MLFlow, experiment_id::String, username::String)
+    getexperimentpermission(instance::MLFlow, experiment_id::Integer, username::String)
+    getexperimentpermission(instance::MLFlow, experiment::Experiment, username::String)
+
+# Arguments
+- `instance`: [`MLFlow`](@ref) configuration.
+- `experiment_id`: [`Experiment`](@ref) id.
+- `username`: [`User`](@ref) username.
+
+# Returns
+An instance of type [`ExperimentPermission`](@ref).
+"""
+function getexperimentpermission(instance::MLFlow, experiment_id::String,
+    username::String)::ExperimentPermission
+    result = mlfget(instance, "experiments/permissions/get"; experiment_id=experiment_id,
+        username=username)
+    return result["experiment_permission"] |> ExperimentPermission
+end
+getexperimentpermission(instance::MLFlow, experiment_id::Integer,
+    username::String)::ExperimentPermission =
+    getexperimentpermission(instance, experiment_id |> string, username)
+getexperimentpermission(instance::MLFlow, experiment::Experiment,
+    username::String)::ExperimentPermission =
+    getexperimentpermission(instance, experiment.experiment_id, username)
+
+"""
+    updateexperimentpermission(instance::MLFlow, experiment_id::String, username::String,
+        permission::Permission)
+    updateexperimentpermission(instance::MLFlow, experiment_id::Integer, username::String,
+        permission::Permission)
+    updateexperimentpermission(instance::MLFlow, experiment::Experiment, username::String,
+        permission::Permission)
+
+# Arguments
+- `instance`: [`MLFlow`](@ref) configuration.
+- `experiment_id`: [`Experiment`](@ref) id.
+- `username`: [`User`](@ref) username.
+- `permission`: [`Permission`](@ref) to grant.
+
+# Returns
+`true` if successful. Otherwise, raises exception.
+"""
+function updateexperimentpermission(instance::MLFlow, experiment_id::String,
+    username::String, permission::Permission)::Bool
+    mlfpatch(instance, "experiments/permissions/update"; experiment_id=experiment_id,
+        username=username, permission=permission)
+    return true
+end
+updateexperimentpermission(instance::MLFlow, experiment_id::Integer,
+    username::String, permission::Permission)::Bool =
+    updateexperimentpermission(instance, experiment_id |> string, username, permission)
+updateexperimentpermission(instance::MLFlow, experiment::Experiment,
+    username::String, permission::Permission)::Bool =
+    updateexperimentpermission(instance, experiment.experiment_id, username, permission)
+
+"""
+    deleteexperimentpermission(instance::MLFlow, experiment_id::String, username::String)
+    deleteexperimentpermission(instance::MLFlow, experiment_id::Integer, username::String)
+    deleteexperimentpermission(instance::MLFlow, experiment::Experiment, username::String)
+
+# Arguments
+- `instance`: [`MLFlow`](@ref) configuration.
+- `experiment_id`: [`Experiment`](@ref) id.
+- `username`: [`User`](@ref) username.
+
+# Returns
+`true` if successful. Otherwise, raises exception.
+"""
+function deleteexperimentpermission(instance::MLFlow, experiment_id::String,
+    username::String)::Bool
+    mlfdelete(instance, "experiments/permissions/delete"; experiment_id=experiment_id,
+        username=username)
+    return true
+end
+deleteexperimentpermission(instance::MLFlow, experiment_id::Integer,
+    username::String)::Bool =
+    deleteexperimentpermission(instance, experiment_id |> string, username)
+deleteexperimentpermission(instance::MLFlow, experiment::Experiment,
+    username::String)::Bool =
+    deleteexperimentpermission(instance, experiment.experiment_id, username)

src/services/user.jl

@@ -30,7 +30,7 @@ function getuser(instance::MLFlow, username::String)::User
 end
 
 """
-    deleteuser(instance::MLFlow, username::String, password::String)
+    updateuserpassword(instance::MLFlow, username::String, password::String)
 
 # Arguments
 - `instance`: [`MLFlow`](@ref) configuration.

src/types/enums.jl

@@ -68,3 +68,4 @@ Permission of a user to an experiment or a registered model.
     MANAGE = 3
     NO_PERMISSIONS = 4
 end
+Permission(permission::String) = Dict(value => key for (key, value) in Permission |> Base.Enums.namemap)[permission|>Symbol] |> Permission

src/types/experiment.jl

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

test/services/experiment.jl

@@ -214,3 +214,166 @@ end
         deleteexperiment(mlf, experiment_id)
     end
 end
+
+@testset verbose = true "create experiment permission" begin
+    @ensuremlf
+
+    experiment_id = createexperiment(mlf, UUIDs.uuid4() |> string)
+    permission = Permission("READ")
+
+    @testset "with string experiment id" begin
+        user = createuser(mlf, "missy", "gala")
+        experiment_permission = 
+            createexperimentpermission(mlf, experiment_id, user.username, permission)
+
+        @test experiment_permission isa ExperimentPermission
+        @test experiment_permission.experiment_id == experiment_id
+        @test experiment_permission.user_id == user.id
+        @test experiment_permission.permission == permission
+        deleteexperimentpermission(mlf, experiment_id, user.username)
+        deleteuser(mlf, user.username)
+    end
+
+    @testset "with integer experiment id" begin
+        user = createuser(mlf, "missy", "gala")
+        experiment_permission = 
+            createexperimentpermission(mlf, parse(Int, experiment_id), user.username, permission)
+
+        @test experiment_permission isa ExperimentPermission
+        @test experiment_permission.experiment_id == experiment_id
+        @test experiment_permission.user_id == user.id
+        @test experiment_permission.permission == permission
+        deleteexperimentpermission(mlf, experiment_id, user.username)
+        deleteuser(mlf, user.username)
+    end
+
+    @testset "with Experiment" begin
+        experiment = getexperiment(mlf, experiment_id)
+        user = createuser(mlf, "missy", "gala")
+        experiment_permission = 
+            createexperimentpermission(mlf, experiment, user.username, permission)
+
+        @test experiment_permission isa ExperimentPermission
+        @test experiment_permission.experiment_id == experiment_id
+        @test experiment_permission.user_id == user.id
+        @test experiment_permission.permission == permission
+        deleteexperimentpermission(mlf, experiment_id, user.username)
+        deleteuser(mlf, user.username)
+    end
+
+    deleteexperiment(mlf, experiment_id)
+end
+
+@testset verbose = true "get experiment permission" begin
+    @ensuremlf
+
+    experiment_id = createexperiment(mlf, UUIDs.uuid4() |> string)
+    permission = Permission("READ")
+    user = createuser(mlf, "missy", "gala")
+
+    @testset "with string experiment id" begin
+        createexperimentpermission(mlf, experiment_id, user.username, permission)
+        experiment_permission = getexperimentpermission(mlf, experiment_id, user.username)
+
+        @test experiment_permission isa ExperimentPermission
+        @test experiment_permission.experiment_id == experiment_id
+        @test experiment_permission.user_id == user.id
+        @test experiment_permission.permission == permission
+        deleteexperimentpermission(mlf, experiment_id, user.username)
+    end
+
+    @testset "with integer experiment id" begin
+        createexperimentpermission(mlf, parse(Int, experiment_id), user.username, permission)
+        experiment_permission = getexperimentpermission(mlf, parse(Int, experiment_id), user.username)
+
+        @test experiment_permission isa ExperimentPermission
+        @test experiment_permission.experiment_id == experiment_id
+        @test experiment_permission.user_id == user.id
+        @test experiment_permission.permission == permission
+        deleteexperimentpermission(mlf, experiment_id, user.username)
+    end
+
+    @testset "with Experiment" begin
+        experiment = getexperiment(mlf, experiment_id)
+        createexperimentpermission(mlf, experiment, user.username, permission)
+        experiment_permission = getexperimentpermission(mlf, experiment, user.username)
+
+        @test experiment_permission isa ExperimentPermission
+        @test experiment_permission.experiment_id == experiment_id
+        @test experiment_permission.user_id == user.id
+        @test experiment_permission.permission == permission
+        deleteexperimentpermission(mlf, experiment_id, user.username)
+    end
+
+    deleteuser(mlf, user.username)
+    deleteexperiment(mlf, experiment_id)
+end
+
+@testset verbose = true "update experiment permission" begin
+    @ensuremlf
+
+    experiment_id = createexperiment(mlf, UUIDs.uuid4() |> string)
+    permission = Permission("READ")
+    user = createuser(mlf, "missy", "gala")
+
+    @testset "with string experiment id" begin
+        createexperimentpermission(mlf, experiment_id, user.username, permission)
+        updateexperimentpermission(mlf, experiment_id, user.username, Permission("EDIT"))
+        experiment_permission = getexperimentpermission(mlf, experiment_id, user.username)
+
+        @test experiment_permission.permission == Permission("EDIT")
+        deleteexperimentpermission(mlf, experiment_id, user.username)
+    end
+
+    @testset "with integer experiment id" begin
+        createexperimentpermission(mlf, parse(Int, experiment_id), user.username, permission)
+        updateexperimentpermission(mlf, parse(Int, experiment_id), user.username, Permission("EDIT"))
+        experiment_permission = getexperimentpermission(mlf, parse(Int, experiment_id), user.username)
+
+        @test experiment_permission.permission == Permission("EDIT")
+        deleteexperimentpermission(mlf, experiment_id, user.username)
+    end
+
+    @testset "with Experiment" begin
+        experiment = getexperiment(mlf, experiment_id)
+        createexperimentpermission(mlf, experiment, user.username, permission)
+        updateexperimentpermission(mlf, experiment, user.username, Permission("EDIT"))
+        experiment_permission = getexperimentpermission(mlf, experiment, user.username)
+
+        @test experiment_permission.permission == Permission("EDIT")
+        deleteexperimentpermission(mlf, experiment_id, user.username)
+    end
+
+    deleteuser(mlf, user.username)
+    deleteexperiment(mlf, experiment_id)
+end
+
+@testset verbose = true "delete experiment permission" begin
+    @ensuremlf
+
+    experiment_id = createexperiment(mlf, UUIDs.uuid4() |> string)
+    permission = Permission("READ")
+    user = createuser(mlf, "missy", "gala")
+
+    @testset "with string experiment id" begin
+        createexperimentpermission(mlf, experiment_id, user.username, permission)
+        deleteexperimentpermission(mlf, experiment_id, user.username)
+        @test_throws ErrorException getexperimentpermission(mlf, experiment_id, user.username)
+    end
+
+    @testset "with integer experiment id" begin
+        createexperimentpermission(mlf, parse(Int, experiment_id), user.username, permission)
+        deleteexperimentpermission(mlf, parse(Int, experiment_id), user.username)
+        @test_throws ErrorException getexperimentpermission(mlf, parse(Int, experiment_id), user.username)
+    end
+
+    @testset "with Experiment" begin
+        experiment = getexperiment(mlf, experiment_id)
+        createexperimentpermission(mlf, experiment, user.username, permission)
+        deleteexperimentpermission(mlf, experiment, user.username)
+        @test_throws ErrorException getexperimentpermission(mlf, experiment, user.username)
+    end
+
+    deleteuser(mlf, user.username)
+    deleteexperiment(mlf, experiment_id)
+end