Added dry-run option for setPermissions for preview of changes.

As the append logic inside setPermissions is a little involved, so
users can double-check that they're setting the right permissions.

Author: LTLA

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: gobbler
-Version: 0.3.16
-Date: 2025-06-22
+Version: 0.3.17
+Date: 2025-07-02
 Title: Interface to the gobbler service
 Description:
     Friendly interface to the gobbler service.

R/setPermissions.R

@@ -19,6 +19,7 @@
 #' @param spoof String containing the name of a user on whose behalf this request is being made.
 #' This should only be used if the Gobbler service allows spoofing by the current user. 
 #' If \code{NULL}, no spoofing is performed.
+#' @param dryRun Logical scalar indicating whether to return the new permissions without actually modifying the registry.
 #' @inheritParams createProject
 #'
 #' @author Aaron Lun
@@ -28,7 +29,11 @@
 #'
 #' \code{\link{createProject}}, to set permissions during project creation.
 #'
-#' @return \code{NULL} is invisibly returned upon successful setting of the permissions.
+#' @return If \code{dryRun=FALSE}, \code{NULL} is invisibly returned upon successful setting of the permissions.
+#'
+#' If \code{dryRun=TRUE}, a named list is returned containing the new permissions for the project/asset.
+#' This contains zero, one or more of \code{owners}, \code{uploaders} and \code{global_write} (see \code{\link{fetchPermissions}} for descriptions).
+#' A missing field indicates that it will not be updated in the project/asset permissions. 
 #'
 #' @examples
 #' info <- startGobbler()
@@ -55,7 +60,7 @@
 #' fetchPermissions("test", registry=info$registry)
 #'
 #' @export
-setPermissions <- function(project, registry, staging, url, asset=NULL, owners=NULL, uploaders=NULL, globalWrite=NULL, append=TRUE, spoof=NULL) {
+setPermissions <- function(project, registry, staging, url, asset=NULL, owners=NULL, uploaders=NULL, globalWrite=NULL, append=TRUE, spoof=NULL, dryRun=FALSE) {
     perms <- list()
     names(perms) <- character(0)
 
@@ -87,7 +92,11 @@ setPermissions <- function(project, registry, staging, url, asset=NULL, owners=N
         perms$global_write <- globalWrite
     }
 
+    if (dryRun) {
+        return(perms)
+    }
     payload$permissions <- perms
+
     dump_request(staging, url, "set_permissions", payload, spoof=spoof)
     invisible(NULL)
 }

man/setPermissions.Rd

@@ -45,6 +45,14 @@ test_that("project-level permission setting works as expected", {
     expect_identical(perms$owners, list("LTLA"))
     expect_identical(length(perms$uploaders), 2L)
 
+    # Dry-run has no effect.
+    out <- setPermissions("test-perms", owners="foobar", staging=info$staging, url=info$url, registry=info$registry, dryRun=TRUE)
+    expect_identical(out$owners, list("LTLA", "foobar"))
+    expect_null(out$uploaders)
+    perms <- fetchPermissions("test-perms", registry=info$registry)
+    expect_identical(perms$owners, list("LTLA"))
+    expect_identical(length(perms$uploaders), 2L)
+
     # Now resetting the uploaders. 
     setPermissions("test-perms", uploaders=list(), append=FALSE, staging=info$staging, url=info$url, registry=info$registry)
     perms <- fetchPermissions("test-perms", registry=info$registry)