tests/testthat/test-get_user_details.R

In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

# inputs

# user_id, which can take the following forms:
# user ID
# user name
# email

# workspace
# invalid workspace name
test_that("Error if invalid workspace name", {
    expect_error(
        get_user_details(
            user_id = "cc78158d-e987-4d7e-9cfb-fb4546d2c895",
            workspace = "I am an invalid workspace name"
        )
    )
})
# TODO: re-enable once figure out an API request that can be used to check
# whether the API user has access to a workspace or the workspace exists
# unauthorized or non-existant workspace
# test_that("Error if unauthorized or non-existant workspace", {
#     expect_error(
#         get_user_details(
#             user_id = "cc78158d-e987-4d7e-9cfb-fb4546d2c895",
#             workspace = "fake"
#         )
#     )
# })

# outputs

# message
test_that("Returns success/failure message", {

    vcr::use_cassette("get_user_details_msg", {
        expect_message(get_user_details(user_id = "cc78158d-e987-4d7e-9cfb-fb4546d2c895"))
    })

})

# data frame
test_that("Returns df with expected columns", {

    vcr::use_cassette("get_user_details_df", {
        x <- get_user_details(user_id = "cc78158d-e987-4d7e-9cfb-fb4546d2c895")
    })

    expect_s3_class(x, c("tbl_df","tbl","data.frame"))
    expect_named(x, c("IsArchived", "UserId", "UserName", "Role", "IsLocked", "CreationDate"), ignore.order = TRUE)

})