tests/testthat/test-list.R

In fs: Cross-Platform File System Operations Based on 'libuv'

describe("dir_ls", {
  it("Does not include '.' or double '/' in results", {
    with_dir_tree(list("foo" = "test"), {
      expect_equal(dir_ls(), new_fs_path(c(foo = "foo")))
      expect_equal(dir_ls("."), new_fs_path(c(foo = "foo")))
    })

    with_dir_tree(list("foo/bar" = "test"), {
      expect_equal(dir_ls(recurse = TRUE), named_fs_path(c("foo", "foo/bar")))
      expect_equal(dir_ls(recurse = TRUE, type = "file"), named_fs_path("foo/bar"))
      expect_equal(dir_ls("./", recurse = TRUE), named_fs_path(c("foo", "foo/bar")))
      expect_equal(dir_ls("foo"), named_fs_path("foo/bar"))
      expect_equal(dir_ls("foo/"), named_fs_path("foo/bar"))
    })
  })

  it("Does not follow symbolic links", {
    with_dir_tree(list("foo/bar/baz" = "test"), {
      link_create(path_abs("foo"), named_fs_path("foo/bar/qux"))
      expect_equal(
        dir_ls(recurse = TRUE),
        named_fs_path(c("foo", "foo/bar", "foo/bar/baz", "foo/bar/qux"))
      )
      expect_equal(
        dir_ls(recurse = TRUE, type = "symlink"),
        named_fs_path("foo/bar/qux")
      )
    })
  })

  it("Uses grep to filter output", {
    with_dir_tree(list(
        "foo/bar/baz" = "test",
        "foo/bar/test2" = "",
        "foo/bar/test3" = ""), {
      expect_equal(
        dir_ls(recurse = TRUE, glob = "*baz"),
        named_fs_path("foo/bar/baz")
      )
      expect_equal(
        dir_ls(recurse = TRUE, regexp = "baz"),
        named_fs_path("foo/bar/baz")
      )
      expect_equal(
        dir_ls(recurse = TRUE, regexp = "[23]"),
        named_fs_path(c("foo/bar/test2", "foo/bar/test3"))
      )
      expect_equal(
        dir_ls(recurse = TRUE, regexp = "(?<=a)z", perl = TRUE),
        named_fs_path("foo/bar/baz")
      )
    })
  })

  it("Does not print hidden files by default", {
    with_dir_tree(list(
        ".foo" = "foo",
        "bar" = "bar"), {
      expect_equal(dir_ls(), named_fs_path("bar"))
      expect_equal(dir_ls(all = TRUE), named_fs_path(c(".foo", "bar")))
    })
  })

  it("can find multiple types", {
    with_dir_tree(list(
        "file" = "foo",
        "dir"), {
      link_create(path_abs("dir"), "link")
      expect_equal(dir_ls(type = "file"), named_fs_path("file"))
      expect_equal(dir_ls(type = "directory"), named_fs_path("dir"))
      expect_equal(dir_ls(type = "symlink"), named_fs_path("link"))
      expect_equal(
        dir_ls(type = c("directory", "symlink")),
        named_fs_path(c("dir", "link"))
      )
      expect_equal(
        dir_ls(type = c("file", "directory", "symlink")),
        named_fs_path(c("dir", "file", "link"))
      )
    })
  })
  it("works with UTF-8 encoded filenames", {
    skip_if_not_utf8()
    skip_on_os("solaris")
    with_dir_tree("\U7684\U6D4B\U8BD5\U6587\U4EF6", {
      file_create("fs\U7684\U6D4B\U8BD5\U6587\U4EF6.docx")
      link_create(path_abs("\U7684\U6D4B\U8BD5\U6587\U4EF6"), "\U7684\U6D4B")

      expect_equal(
        dir_ls(type = "file"),
        named_fs_path("fs\U7684\U6D4B\U8BD5\U6587\U4EF6.docx")
      )
      expect_equal(
        dir_ls(type = "directory"),
        named_fs_path("\U7684\U6D4B\U8BD5\U6587\U4EF6")
      )
      expect_equal(
        dir_ls(type = "symlink"),
        named_fs_path("\U7684\U6D4B")
      )
      expect_equal(path_file(link_path("\U7684\U6D4B")), "\U7684\U6D4B\U8BD5\U6587\U4EF6")
    })
  })
  it("errors on missing input", {
    expect_error(dir_ls(NA), class = "invalid_argument")
  })
  it("warns if fail == FALSE", {
    skip_on_os("windows")
    if (Sys.info()[["effective_user"]] == "root") skip("root user")
    with_dir_tree(list(
        "foo",
        "foo2/bar/baz"), {

      file_chmod("foo", "a-r")
      expect_error(dir_ls(".", recurse = TRUE), class = "EACCES")
      expect_warning(dir_ls(fail = FALSE, recurse = TRUE), class = "EACCES")
      file_chmod("foo", "a+r")

      file_chmod("foo2/bar", "a-r")
      expect_warning(dir_ls("foo2", fail = FALSE, recurse = TRUE), class = "EACCES")
      file_chmod("foo2/bar", "a+r")
    })
  })
})

describe("dir_map", {
  it("can find multiple types", {
    with_dir_tree(list(
        "file" = "foo",
        "dir"), {
      nc <- function(x) nchar(x, keepNA = FALSE)
      expect_equal(dir_map(type = "file", fun = nc), list(4))
      expect_equal(dir_map(type = "directory", fun = nc), list(3))
      expect_equal(dir_map(type = c("file", "directory"), fun = nc), list(3, 4))
    })
  })
  it("errors on missing input", {
    expect_error(dir_map(NA, fun = identity), class = "invalid_argument")
  })

  it("warns if fail == FALSE", {
    skip_on_os("windows")
    if (Sys.info()[["effective_user"]] == "root") skip("root user")
    with_dir_tree(list(
        "foo",
        "foo2/bar/baz"), {

      file_chmod("foo", "a-r")
      expect_error(dir_map(".", fun = identity, recurse = TRUE), class = "EACCES")
      expect_warning(dir_map(fail = FALSE, fun = identity, recurse = TRUE), class = "EACCES")
      file_chmod("foo", "a+r")

      file_chmod("foo2/bar", "a-r")
      expect_warning(dir_map("foo2", fail = FALSE, fun = identity, recurse = TRUE), class = "EACCES")
      file_chmod("foo2/bar", "a+r")
    })
  })
})

describe("dir_walk", {
  it("can find multiple types", {
    x <- character()
    f <- function(p) x <<- p

    with_dir_tree(list(
        "file" = "foo",
        "dir"), {
      link_create(path_abs("dir"), "link")

      dir_walk(type = "file", fun = f)
      expect_equal(x, "file")

      dir_walk(type = "directory", fun = f)
      expect_equal(x, "dir")

      dir_walk(type = "symlink", fun = f)
      expect_equal(x, "link")

      x <- character()
      dir_walk(type = c("directory", "symlink"), fun = function(p) x <<- c(x, p))
      expect_equal(x, c("dir", "link"))

      x <- character()
      dir_walk(type = c("file", "directory", "symlink"), fun = function(p) x <<- c(x, p))
      expect_equal(x, c("dir", "file", "link"))
    })
  })
  it("errors on missing input", {
    expect_error(dir_walk(NA, fun = identity), class = "invalid_argument")
  })

  it("warns if fail == FALSE", {
    skip_on_os("windows")
    if (Sys.info()[["effective_user"]] == "root") skip("root user")
    with_dir_tree(list(
        "foo",
        "foo2/bar/baz"), {

      file_chmod("foo", "a-r")
      expect_error(dir_walk(".", fun = identity, recurse = TRUE), class = "EACCES")
      expect_warning(dir_walk(fail = FALSE, fun = identity, recurse = TRUE), class = "EACCES")
      file_chmod("foo", "a+r")

      file_chmod("foo2/bar", "a-r")
      expect_warning(dir_walk("foo2", fail = FALSE, fun = identity, recurse = TRUE), class = "EACCES")
      file_chmod("foo2/bar", "a+r")
    })
  })
})

describe("dir_info", {
  it("is identical to file_info(dir_ls())", {
    with_dir_tree(list(
        "file" = "foo",
        "dir"), {
      link_create(path_abs("dir"), "link")
      expect_identical(dir_info(), file_info(dir_ls()))
    })
  })
  it("errors on missing input", {
    expect_error(dir_info(NA), class = "invalid_argument")
  })

  it("warns if fail == FALSE", {
    skip_on_os("windows")
    if (Sys.info()[["effective_user"]] == "root") skip("root user")
    with_dir_tree(list(
        "foo",
        "foo2/bar/baz"), {

      file_chmod("foo", "a-r")
      expect_error(dir_info(".", fun = identity, recurse = TRUE), class = "EACCES")
      expect_warning(dir_info(fail = FALSE, fun = identity, recurse = TRUE), class = "EACCES")
      file_chmod("foo", "a+r")

      file_chmod("foo2/bar", "a-r")
      expect_warning(dir_info("foo2", fail = FALSE, fun = identity, recurse = TRUE), class = "EACCES")
      file_chmod("foo2/bar", "a+r")
    })
  })
})