tests/testthat/test-share.R

In crunch: Crunch.io Data Tools

context("Sharing")

me <- "fake.user@example.com"

with_mock_crunch({
    ds <- cachedLoadDataset("test ds")
    ds2 <- cachedLoadDataset("ECON.sav")
    test_that("Dataset has permissions catalog", {
        expect_is(permissions(ds), "PermissionCatalog")
        expect_identical(
            urls(permissions(ds)),
            c("https://app.crunch.io/api/users/user1/", "https://app.crunch.io/api/users/user2/")
        )
        expect_identical(
            emails(permissions(ds)),
            c("fake.user@example.com", "nobody@crunch.io")
        )
    })
    test_that("Editing attributes", {
        expect_identical(
            is.editor(permissions(ds)),
            structure(c(TRUE, FALSE),
                .Names = c("fake.user@example.com", "nobody@crunch.io")
            )
        )
        expect_true(is.editor(permissions(ds)[me]))
        expect_true(is.editor(permissions(ds)[[me]]))
        expect_false(is.editor(permissions(ds)["nobody@crunch.io"]))
    })
    test_that("Permissions with dataset shared with team", {
        expect_identical(
            emails(permissions(ds2)),
            c(NA_character_, "dos@example.io", "tres@example.com")
        )
        expect_identical(
            is.editor(permissions(ds2)),
            structure(c(TRUE, TRUE, TRUE),
                .Names = c(NA_character_, "dos@example.io", "tres@example.com")
            )
        )
    })

    with(temp.options(crunch = list(crunch.api = "https://fake.crunch.io/api/v2/")), {
        test_that("Share payload shape", {
            expect_identical(
                passwordSetURLTemplate(),
                "https://fake.crunch.io/password/change/${token}/"
            )
            expect_PATCH(
                share(ds, "lauren.ipsum@crunch.io",
                    edit = TRUE,
                    notify = FALSE
                ),
                "https://app.crunch.io/api/datasets/1/permissions/",
                '{"lauren.ipsum@crunch.io":{"dataset_permissions":',
                '{"edit":true,"view":true}},"send_notification":false}'
            )
            expect_PATCH(
                share(ds, "lauren.ipsum@crunch.io",
                    edit = TRUE,
                    notify = TRUE
                ),
                "https://app.crunch.io/api/datasets/1/permissions/",
                '{"lauren.ipsum@crunch.io":{"dataset_permissions":',
                '{"edit":true,"view":true}},"send_notification":true,',
                '"url_base":"https://fake.crunch.io/password/change/${token}/",',
                '"dataset_url":"https://fake.crunch.io/dataset/1"}'
            )
            expect_PATCH(
                share(ds, "lauren.ipsum@crunch.io",
                    edit = TRUE,
                    notify = TRUE, message = "testing"
                ),
                "https://app.crunch.io/api/datasets/1/permissions/",
                '{"lauren.ipsum@crunch.io":{"dataset_permissions":',
                '{"edit":true,"view":true}},"send_notification":true,"message":"testing",',
                '"url_base":"https://fake.crunch.io/password/change/${token}/",',
                '"dataset_url":"https://fake.crunch.io/dataset/1"}'
            )
            expect_error(share(ds, "lauren.ipsum@crunch.io",
                edit = TRUE,
                notify = FALSE, message = "testing"
            ),
            "Cannot send message if not notifying",
            fixed = TRUE
            )
        })
    })

    with_mock(
        `crunch::PermissionCatalog` = function(...) {
            out <- new("PermissionCatalog", ...)
            out@index <- list()
            return(out)
        },
        test_that(
            paste0(
                "Sharing works even if the PermissionCatalog is empty (as with ",
                "a project-owned dataset)"
            ), {
                expect_length(permissions(ds), 0)
                expect_PATCH(
                    share(ds, "lauren.ipsum@crunch.io",
                        notify = FALSE
                    ),
                    "https://app.crunch.io/api/datasets/1/permissions/",
                    '{"lauren.ipsum@crunch.io":{"dataset_permissions":',
                    '{"edit":false,"view":true}},"send_notification":false}'
                )
            }
        )
    )
})

with_test_authentication({
    # Because this is a dataset in the personal proejct, the user does not get added
    # to the dataset permissions
    # TODO: test permissions in a non-personal project (also?). Would require giving
    # the test user access to other projects
    ds <- createDataset(name = now())
    test_that("share and unshare methods for dataset", {
        ds <- share(ds, "foo@crunch.io", notify = FALSE)
        expect_true(
            c("foo@crunch.io") %in% emails(permissions(ds))
        )
        ds <- unshare(ds, "foo@crunch.io")
        expect_true(
            !(c("foo@crunch.io") %in% emails(permissions(ds)))
        )
    })

    test_that("re-sharing doesn't change the state", {
        share(ds, "foo@crunch.io", notify = FALSE)
        expect_true(
            c("foo@crunch.io") %in% emails(permissions(ds))
        )
    })

    others <- c("foo@crunch.io", "a@crunch.io", "b@crunch.io")
    test_that("can share dataset with multiple at same time", {
        share(ds, c("a@crunch.io", "b@crunch.io"), notify = FALSE)
        expect_true(all(others %in% emails(permissions(ds))))
        for (user in others) {
            expect_false(is.editor(permissions(ds)[[user]]), info = user)
        }
    })

    test_that("Can make multiple people editors", {
        skip("TODO invite a and b as advanced users")
        ds <- share(ds, c("a@crunch.io", "b@crunch.io"),
            notify = FALSE, edit = TRUE
        )
        expect_true(is.editor(permissions(ds)[["a@crunch.io"]]))
        expect_true(is.editor(permissions(ds)[["b@crunch.io"]]))
    })
})