rcrunch: Crunch.io Data Tools

context("Retrieving dataset list and single datasets")

with_mock_crunch({
    test_that("listDatasets lists datasets in your personal project (and warns once)", {
        options(crunch.list.personal.msg = NULL)
        expect_warning(
            expect_identical(listDatasets(), c(
                "test ds",
                "streaming no messages"
            )),
            paste(
                "As of crunch 1.26.0, listDatasets() with no project specified",
                "only lists your 'personal' datasets (those that you created)",
                "and not those that were shared with you."
            ),
            fixed = TRUE
        )
        # Also test that this only warns the first time
        expect_warning(
            expect_identical(
                listDatasets("archived"),
                "an archived dataset"
            ),
            NA
        )
        expect_identical(listDatasets("all"), c(
            "an archived dataset",
            "test ds",
            "streaming no messages"
        ))
    })
    test_that("listDatasets in project", {
        expect_identical(
            listDatasets(project = "Project One"),
            c(
                "test ds",
                "streaming no messages"
            )
        )
        expect_identical(
            listDatasets("all", project = "Project One"),
            c(
                "an archived dataset",
                "test ds",
                "streaming no messages"
            )
        )
        expect_identical(
            listDatasets(project = "Project One/Project Two"),
            c(
                "ECON.sav",
                "streaming test ds"
            )
        )
    })
    test_that("listDatasets(refresh=TRUE) drops caches", {
        with(temp.option(httpcache.log = ""), {
            logs <- capture.output({
                listDatasets(refresh = TRUE)
            })
        })
        in_logs <- function(str, loglines) {
            any(grepl(str, loglines, fixed = TRUE))
        }
        expect_true(in_logs("CACHE DROP ^https://app[.]crunch[.]io/api/datasets/by_name/", logs))
    })

    test_that("listDatasets error handling", {
        expect_error(
            listDatasets(project = 42),
            "Project 42 is not valid"
        )
    })

    test_that("loadDataset loads", {
        ds <- loadDataset("test ds")
        expect_true(is.dataset(ds))
        expect_identical(name(ds), "test ds")
    })

    test_that("loadDataset by index is deprecated", {
        expect_deprecated(ds <- loadDataset(1))
        expect_true(is.dataset(ds))
        expect_identical(name(ds), "test ds")
        expect_error(
            expect_deprecated(
                loadDataset(666)
            ),
            "subscript out of bounds"
        )
    })

    test_that("loadDataset loads with DatasetTuple", {
        # Is this a use case we need to support?
        cr <- session()
        ds <- loadDataset(cr$datasets[["test ds"]])
        expect_true(is.dataset(ds))
        expect_identical(name(ds), "test ds")
        expect_true(is.dataset(loadDataset(cr$datasets$`test ds`)))
    })

    test_that("loadDataset by URL when in main catalog", {
        ds <- loadDataset("test ds")
        ds_by_url <- loadDataset(self(ds))
        expect_is(ds_by_url, "CrunchDataset")
        expect_identical(name(ds), name(ds_by_url))
        expect_identical(self(ds), self(ds_by_url))
    })
    test_that("loadDataset by URL when not in main catalog", {
        ds2 <- loadDataset("https://app.crunch.io/api/datasets/four/")
        expect_is(ds2, "CrunchDataset")
        expect_identical(
            self(ds2),
            "https://app.crunch.io/api/datasets/four/"
        )
        expect_identical(name(ds2), "mtcars from R")
    })

    test_that("loadDataset by web app URL", {
        ds3 <- loadDataset("https://app.crunch.io/dataset/3/browse")
        expect_is(ds3, "CrunchDataset")
        expect_identical(name(ds3), "ECON.sav")
    })

    test_that("loadDataset by path", {
        ds3 <- loadDataset("Project One/Project Two/ECON.sav")
        expect_is(ds3, "CrunchDataset")
        expect_identical(name(ds3), "ECON.sav")
        ds1 <- loadDataset("~/test ds") # nolint
        expect_is(ds1, "CrunchDataset")
        expect_identical(name(ds1), "test ds")
    })

    test_that("loadDataset(refresh=TRUE) drops caches", {
        with(temp.option(httpcache.log = ""), {
            logs <- capture.output({
                loadDataset("test ds", refresh = TRUE)
            })
        })
        in_logs <- function(str, loglines) {
            any(grepl(str, loglines, fixed = TRUE))
        }
        expect_true(in_logs("CACHE DROP ^https://app[.]crunch[.]io/api/datasets/by_name/", logs))
    })

    test_that("loadDataset error handling", {
        expect_error(
            loadDataset("not a dataset"),
            paste(dQuote("not a dataset"), "not found")
        )
        expect_error(
            loadDataset("not a dataset", project = 42),
            "Project 42 is not valid"
        )
        expect_error(
            loadDataset(c("test ds", "ECON.sav")),
            # Not the clearest error message, but does signal something wrong with input
            '"test ds" is not a folder'
        )
        expect_error(
            loadDataset(NULL),
            paste0(
                "'dataset' should be a character dataset name, path, or URL, ",
                "not an object of class NULL"
            )
        )
        expect_error(
            loadDataset(list(5)),
            paste0(
                "'dataset' should be a character dataset name, path, or URL, ",
                "not an object of class list"
            )
        )
    })
})

with_test_authentication({
    personal <- cd(projects(), "~")
    ds <- createDataset(name = now())
    dsname <- name(ds)
    test_that("When a dataset is created, it goes to the personal project", {
        skip_on_jenkins("#163665209")
        expect_equal(length(cd(projects(), "~")), length(personal) + 1)
    })

    test_that("Dataset list can be retrieved if authenticated", {
        expect_true(is.character(listDatasets()))
        skip_on_jenkins("#163665209")
        expect_true(length(listDatasets()) > 0)
        expect_true(is.character(dsname))
        expect_true(nchar(dsname) > 0)
        expect_true(dsname %in% listDatasets())
    })

    test_that("A dataset object can be retrieved, if it exists", {
        expect_true(is.dataset(loadDataset(dsname)))
    })

    newname <- paste0("New name ", now())
    test_that("renaming a dataset refreshes the dataset list", {
        name(ds) <- newname
        expect_false(dsname %in% listDatasets())
        skip_on_jenkins("#163665209")
        expect_true(newname %in% listDatasets())
    })

    test_that("deleting a dataset refreshes the dataset list", {
        with_consent(delete(ds))
        expect_false(dsname %in% listDatasets())
        expect_false(newname %in% listDatasets())
    })
})