R/checkmate.R

In botor: 'AWS Python SDK' ('boto3') for R

#' Check if an argument looks like an S3 bucket
#' @param x string, URI of an S3 object, should start with \code{s3://}, then bucket name and object key
#' @export
#' @importFrom checkmate makeAssertionFunction makeTestFunction makeExpectationFunction makeAssertion makeExpectation check_string vname
#' @examples
#' check_s3_uri('s3://foo/bar')
#' check_s3_uri('https://foo/bar')
#' \dontrun{
#' assert_s3_uri('https://foo/bar')
#' }
#' @aliases check_s3_uri assert_s3_uri test_s3_uri expect_s3_uri
check_s3_uri <- function(x) {
    regex <- '^s3://[a-z0-9][a-z0-9\\.-]+[a-z0-9](/(.*)?)?$'
    check <- check_string(x, pattern = regex)
    if (isTRUE(check)) {
        return(TRUE)
    }
    paste('Does not seem to be an S3 URI as per regular expression:', shQuote(regex))
}
#' @export
assert_s3_uri <- makeAssertionFunction(check_s3_uri)
#' @export
test_s3_uri   <- makeTestFunction(check_s3_uri)
#' @export
expect_s3_uri <- makeExpectationFunction(check_s3_uri)