tests/testthat/test-sharepoint-folder.R

In reside-ic/pointr: Sharepoint upload & download

context("sharepoint_folder")

test_that("list files", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "path")
  expect_is(folder, "sharepoint_folder")

  folder_files_res <- readRDS("mocks/folder_files_response.rds")
  mock_get <- mockery::mock(folder_files_res, cycle = TRUE)
  dat <- with_mock("httr::GET" = mock_get,
                   folder$files())
  expect_is(dat, "tbl_df")
  expect_equal(names(dat), c("name", "size", "created", "modified"))
  expect_equal(dat$name, c("clipboard.txt", "test.txt"))

  expect_identical(with_mock("httr::GET" = mock_get, folder$files("a/b/c")),
                   dat)

  expect_equal(
    mockery::mock_args(mock_get)[[1]][[1]],
    paste0("https://httpbin.org//sites/site/_api/web/",
           "GetFolderByServerRelativeURL('path')/files"))
  expect_equal(
    mockery::mock_args(mock_get)[[2]][[1]],
    paste0("https://httpbin.org//sites/site/_api/web/",
           "GetFolderByServerRelativeURL('path/a/b/c')/files"))
})


test_that("list folders", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "path")
  expect_is(folder, "sharepoint_folder")

  folder_folder_res <- readRDS("mocks/folder_folders_response.rds")
  mock_get <- mockery::mock(folder_folder_res, cycle = TRUE)
  dat <- with_mock("httr::GET" = mock_get,
                   folder$folders())
  expect_is(dat, "tbl_df")
  expect_equal(names(dat), c("name", "items", "created", "modified"))
  expect_equal(dat$name, c("data_offers", "administration_station"))

  expect_identical(with_mock("httr::GET" = mock_get, folder$folders("a/b/c")),
                   dat)

  expect_equal(
    mockery::mock_args(mock_get)[[1]][[1]],
    paste0("https://httpbin.org//sites/site/_api/web/",
           "GetFolderByServerRelativeURL('path')/folders"))
  expect_equal(
    mockery::mock_args(mock_get)[[2]][[1]],
    paste0("https://httpbin.org//sites/site/_api/web/",
           "GetFolderByServerRelativeURL('path/a/b/c')/folders"))
})


test_that("list everything", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "path")
  expect_is(folder, "sharepoint_folder")

  folder_files_res <- readRDS("mocks/folder_files_response.rds")
  folder_folders_res <- readRDS("mocks/folder_folders_response.rds")
  mock_get <- mockery::mock(folder_folders_res, folder_files_res)

  dat <- with_mock("httr::GET" = mock_get, folder$list())
  expect_is(dat, "tbl_df")
  expect_equal(names(dat),
               c("name", "items", "size", "is_folder", "created", "modified"))
  expect_equal(dat$name, c("data_offers", "administration_station",
                           "clipboard.txt", "test.txt"))
})


test_that("get parent directory", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "a/b/c")
  parent <- folder$parent()
  expect_equal(parent$path, "a/b")
  expect_equal(parent$parent()$parent()$path, ".")
})


test_that("get child directory", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "a")
  child <- folder$folder("b")$folder("c")
  expect_is(folder, "sharepoint_folder")
  expect_equal(child$path, "a/b/c")
})


test_that("download from folder", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "a/b/c")

  mock_get <- mockery::mock(mock_response())
  res <- with_mock(
    "httr::GET" = mock_get,
    folder$download("file.txt"))

  expect_match(res, "\\.txt$")
  mockery::expect_called(mock_get, 1)
  expect_equal(
    mockery::mock_args(mock_get)[[1]][[1]],
    paste0("https://httpbin.org//sites/site/_api/web/",
           "GetFolderByServerRelativeURL('a/b/c')/Files('file.txt')/$value"))
})


test_that("download from subdirectory", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "a/b")

  mock_get <- mockery::mock(mock_response())
  res <- with_mock(
    "httr::GET" = mock_get,
    folder$download("c/file.txt"))

  expect_match(res, "\\.txt$")
  mockery::expect_called(mock_get, 1)
  expect_equal(
    mockery::mock_args(mock_get)[[1]][[1]],
    paste0("https://httpbin.org//sites/site/_api/web/",
           "GetFolderByServerRelativeURL('a/b/c')/Files('file.txt')/$value"))
})


test_that("download from folder fails with informative message if missing", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "a/b/c")

  mock_get <- mockery::mock(mock_response(404))
  expect_error(
    with_mock("httr::GET" = mock_get, folder$download("file.txt")),
    "Remote file not found at 'site:a/b/c/file.txt'")

  mockery::expect_called(mock_get, 1)
  expect_equal(
    mockery::mock_args(mock_get)[[1]][[1]],
    paste0("https://httpbin.org//sites/site/_api/web/",
           "GetFolderByServerRelativeURL('a/b/c')/Files('file.txt')/$value"))
})


test_that("upload", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "a/b/c")

  contextinfo_res <- readRDS("mocks/contextinfo_response.rds")
  mock_post <- mockery::mock(contextinfo_res, mock_response(200))
  tmp <- tempfile()
  writeLines("content", tmp)

  res <- with_mock(
    "httr::POST" = mock_post,
    folder$upload(tmp, "file.txt"))
  expect_null(res)

  mockery::expect_called(mock_post, 2)
  expect_equal(
    mockery::mock_args(mock_post)[[1]][[1]],
    "https://httpbin.org//sites/site/_api/contextinfo")

  expect_equal(
    mockery::mock_args(mock_post)[[2]][[1]],
    paste0("https://httpbin.org//sites/site/_api/web/",
           "GetFolderByServerRelativeURL('a/b/c')/Files/",
           "Add(url='file.txt',overwrite=true)"))
})


test_that("upload to subdirectory", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "a/b")

  contextinfo_res <- readRDS("mocks/contextinfo_response.rds")
  mock_post <- mockery::mock(contextinfo_res, mock_response(200))
  tmp <- tempfile()
  writeLines("content", tmp)

  res <- with_mock(
    "httr::POST" = mock_post,
    folder$upload(tmp, "c/file.txt"))
  expect_null(res)

  mockery::expect_called(mock_post, 2)
  expect_equal(
    mockery::mock_args(mock_post)[[1]][[1]],
    "https://httpbin.org//sites/site/_api/contextinfo")

  expect_equal(
    mockery::mock_args(mock_post)[[2]][[1]],
    paste0("https://httpbin.org//sites/site/_api/web/",
           "GetFolderByServerRelativeURL('a/b/c')/Files/",
           "Add(url='file.txt',overwrite=true)"))
})


test_that("verify folder exists", {
  p <- mock_sharepoint()
  mock_get <- mockery::mock(mock_response(200), mock_response(404))

  expect_is(
    with_mock("httr::GET" = mock_get,
              p$folder("site", "a/b/c", verify = TRUE)),
    "sharepoint_folder")
  expect_error(
    with_mock("httr::GET" = mock_get,
              p$folder("site", "a/b/c", verify = TRUE)),
    "Path 'a/b/c' was not found on site 'site'")

  mockery::expect_called(mock_get, 2)
  expect_equal(
    mockery::mock_args(mock_get)[[1]][[1]],
    paste0("https://httpbin.org//sites/site/_api/web/",
           "GetFolderByServerRelativeURL('a/b/c')"))
  expect_equal(
    mockery::mock_args(mock_get)[[2]][[1]],
    mockery::mock_args(mock_get)[[1]][[1]])
})


test_that("create folder", {
  p <- mock_sharepoint()

  contextinfo_res <- readRDS("mocks/contextinfo_response.rds")
  mock_post <- mockery::mock(contextinfo_res, mock_response(200))
  tmp <- tempfile()
  writeLines("content", tmp)

  f1 <- p$folder("site", "a/b/c")
  res <- with_mock(
    "httr::POST" = mock_post,
    withVisible(f1$create("d/e/f")))

  expect_is(res$value, "sharepoint_folder")
  expect_false(res$visible)

  mockery::expect_called(mock_post, 2)
  expect_equal(
    mockery::mock_args(mock_post)[[1]][[1]],
    "https://httpbin.org//sites/site/_api/contextinfo")

  args <- mockery::mock_args(mock_post)[[2]]
  expect_equal(args[[1]], "https://httpbin.org/sites/site/_api/web/folders")
  expect_equal(
    args[[2]],
    '{"__metadata":{"type":"SP.Folder"},"ServerRelativeUrl":"a/b/c/d/e/f"}')
  headers <- httr::add_headers(
    "Content-Type" = "application/json;odata=verbose",
    "Accept" = "application/json;odata=verbose")
  expect_equal(args[[3]], headers)
  expect_equal(
    args[[4]], "raw")
})


test_that("delete folder", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "a/b/c")

  folder_files_res <- readRDS("mocks/folder_files_response.rds")
  contextinfo_res <- readRDS("mocks/contextinfo_response.rds")

  ## It would be better here rather than mocking out the GET, to be
  ## able to mock out the $files() call that we do, but that requires
  ## replacing the method, and I can't get this to work. Really that
  ## might be nice to do across much of the package.

  mock_get <- mockery::mock(folder_files_res)
  mock_post <- mockery::mock(contextinfo_res)
  mock_delete <- mockery::mock(mock_response(200))

  with_mock(
    "httr::GET" = mock_get,
    "httr::POST" = mock_post,
    "httr::DELETE" = mock_delete,
    folder$delete("d/e", "test.txt"))

  mockery::expect_called(mock_get, 1)
  expect_match(
    mockery::mock_args(mock_get)[[1]][[1]],
    "_api/web/GetFolderByServerRelativeURL\\('a/b/c/d/e'\\)/files$")
  mockery::expect_called(mock_post, 1) # this is the digest call
  mockery::expect_called(mock_delete, 1)

  args <- mockery::mock_args(mock_delete)[[1]]
  expect_match(
    args[[1]],
    "_api/web/GetFolderByServerRelativeURL\\('a/b/c/d/e'\\)/recycle()")
  expect_equal(
    args[[2]],
    httr::add_headers("If-Match" = "{etag or *}"))
})


test_that("delete folder errors if check fails", {
  p <- mock_sharepoint()
  folder <- p$folder("site", "a/b/c")

  folder_files_res <- readRDS("mocks/folder_files_response.rds")
  contextinfo_res <- readRDS("mocks/contextinfo_response.rds")

  mock_get <- mockery::mock(folder_files_res)
  mock_post <- mockery::mock(contextinfo_res)
  mock_delete <- mockery::mock(mock_response(200))

  with_mock(
    "httr::GET" = mock_get,
    "httr::POST" = mock_post,
    "httr::DELETE" = mock_delete,
    expect_error(
      folder$delete("d/e", "not-here"),
      "The file 'not-here' was not found in the folder to delete 'd/e'"))

  mockery::expect_called(mock_get, 1)
  expect_match(
    mockery::mock_args(mock_get)[[1]][[1]],
    "_api/web/GetFolderByServerRelativeURL\\('a/b/c/d/e'\\)/files$")
  mockery::expect_called(mock_post, 0) # this is the digest call
  mockery::expect_called(mock_delete, 0)
})