tests/testthat/test-get_interviews.R

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

# inputs

test_that("issues error if invalid workspace name", {

    expect_error(
        get_interviews(workspace = "I_am_fake")
    )

})

# nodes
# ... invalid values
test_that("Error if invalid name in `nodes`", {

    expect_error(
        get_interviews(nodes = c("id", "fakeNode"))
    )

})
# ... `id` missing
test_that("Error if invalid name in `nodes`", {

    expect_error(
        get_interviews(nodes = c("key", "assignmentId"))
    )

})

# outputs
test_that("returns data frame with expected columns", {

    vcr::use_cassette("get_interviews_df", {
        # implicitly, return all nodes, since this is the default for the `nodes` param
        x <- get_interviews()
    })

    # is a data frame
    expect_s3_class(x, c("tbl_df","tbl","data.frame"))

    # has expected columns
    # names found in data frame, which include interview-specific identifying variables
    col_names <- names(x)
    # expected core values, drawn from GraphQL query
    expected_names <- c(
        "id", "key", "assignmentId", 
        "questionnaireId", "questionnaireVersion", "questionnaireVariable",
        "responsibleName", "responsibleId", "responsibleRole", "supervisorName",
        "status", "actionFlags", "wasCompleted", "notAnsweredCount", "errorsCount",
        "createdDate", "updateDateUtc", "receivedByInterviewerAtUtc", "interviewMode"
    )
    expect_true(all(expected_names %in% col_names))

})