Added bindings for validating a version directory.

Also updated the required version of the Gobbler API.

Author: LTLA

NAMESPACE

@@ -29,6 +29,7 @@ export(startGobbler)
 export(stopGobbler)
 export(unpackPath)
 export(uploadDirectory)
+export(validateVersion)
 export(versionPath)
 import(httr2)
 import(methods)

R/startGobbler.R

@@ -36,7 +36,7 @@
 #' 
 #' @export
 #' @importFrom utils download.file
-startGobbler <- function(staging=tempfile(), registry=tempfile(), port = NULL, wait = 1, version = "0.4.3", overwrite = FALSE) {
+startGobbler <- function(staging=tempfile(), registry=tempfile(), port = NULL, wait = 1, version = "0.5.0", overwrite = FALSE) {
     if (!is.null(running$active)) {
         return(list(new=FALSE, staging=running$staging, registry=running$registry, port=running$port, url=assemble_url(running$port)))
     }

R/validateVersion.R

@@ -0,0 +1,37 @@
+#' Validate a versioned asset
+#'
+#' Check the validity of a version of an asset of a project from the registry.
+#' This compares the size, MD5 checksums and link information in the internal \code{..manifest} and \code{..links} files to the contents of the directory in the registry.
+#'
+#' @param project String containing the project to remove.
+#' @param asset String containing the asset to remove.
+#' @param version String containing the version of the asset to remove.
+#' @inheritParams createProject
+#'
+#' @return \code{NULL} is invisibly returned if the version is valid, otherwise an error is thrown.
+#'
+#' @author Aaron Lun
+#'
+#' @examples
+#' info <- startGobbler()
+#' removeProject("test", info$staging, url=info$url) # start with a clean slate.
+#' createProject("test", info$staging, url=info$url)
+#'
+#' # Mocking up a version if it doesn't already exist.
+#' src <- allocateUploadDirectory(info$staging)
+#' write(file=file.path(src, "foo"), "BAR")
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#'
+#' # Validation has no issue.
+#' validateVersion("test", "simple", "v1", staging=info$staging, url=info$url)
+#'
+#' # Let's add a new file directly to the directory and rerun the validation.
+#' write(file=file.path(info$registry, "test", "simple", "v1", "whee"), "stuff")
+#' try(validateVersion("test", "simple", "v1", staging=info$staging, url=info$url))
+#'
+#' @export
+validateVersion <- function(project, asset, version, staging, url) {
+    dump_request(staging, url, "validate_version", list(project=project, asset=asset, version=version))
+    invisible(NULL)
+}
+

man/startGobbler.Rd

@@ -0,0 +1,16 @@
+# library(testthat); library(gobbler); source("test-validateVersion.R")
+
+info <- startGobbler()
+removeProject("test-R-validate", staging=info$staging, url=info$url)
+createProject("test-R-validate", staging=info$staging, url=info$url)
+
+test_that("validation functions work as expected", {
+    src <- allocateUploadDirectory(info$staging)
+    write(file=file.path(src, "foo"), "BAR")
+    uploadDirectory("test-R-validate", "simple", "v1", src, staging=info$staging, url=info$url)
+    expect_error(validateVersion("test-R-validate", "simple", "v1", staging=info$staging, url=info$url), NA)
+
+    # Let's add a new file directly to the directory.
+    write(file=file.path(info$registry, "test-R-validate", "simple", "v1", "whee"), "stuff")
+    expect_error(validateVersion("test-R-validate", "simple", "v1", staging=info$staging, url=info$url), "extra file \"whee\"")
+})