tests/testthat/test-search.R

In ropenscilabs/deposits: A universal client for depositing and accessing research data anywhere

test_all <- (identical (Sys.getenv ("MPADGE_LOCAL"), "true") |
    identical (Sys.getenv ("GITHUB_WORKFLOW"), "test-coverage"))

testthat::skip_if (!test_all)

# This envvar is used to convert the contents of the uploaded json file to a
# standardised form (uniform timestamps and article id values).
Sys.setenv ("DEPOSITS_TEST_ENV" = "true")

test_that ("figshare search", {

    cli <- with_mock_dir ("fs_create", {
        depositsClient$new (service = "figshare")
    })

    x <- with_mock_dir ("search_fs", {
        cli$deposits_search (search_string = "random", page_size = 5L)
    })

    expect_s3_class (x, "data.frame")
    expect_equal (nrow (x), 5L)
    expect_true (any (grepl ("random", x$title)))

    expect_error (
        cli$deposits_search (search_string = "this", search_for = "this"),
        "Please specify only one of 'search_for' or 'search_string'."
    )
})

test_that ("zenodo search", {

    cli <- with_mock_dir ("zen_create", {
        depositsClient$new (service = "zenodo", sandbox = TRUE)
    })

    x <- with_mock_dir ("search_zen", {
        cli$deposits_search (search_string = "random", page_size = 5L)
    })

    expect_type (x, "list")
    expect_equal (length (x), 3L)
    expect_equal (names (x), c ("aggregations", "hits", "links"))

    meta <- x$hits$hits$metadata
    expect_true (any (grepl ("random", meta$description)))
})

test_that ("general search errors", {

    cli <- with_mock_dir ("fs_create", {
        depositsClient$new (service = "figshare") # service doesn't matter here
    })

    expect_error (
        cli$deposits_search (search_string = 1L),
        "Assertion on 'search_string' failed: Must be of type 'character'"
    )

    expect_error (
        cli$deposits_search (page_size = "a"),
        "Assertion on 'page_size' failed: Must be of type 'single integerish value'"
    )

    expect_error (
        cli$deposits_search (page_number = "a"),
        "Assertion on 'page_number' failed: Must be of type 'single integerish value'"
    )
})

test_that ("figshare search errors", {

    cli <- with_mock_dir ("fs_create", {
        depositsClient$new (service = "figshare") # service doesn't matter here
    })

    expect_error (
        cli$deposits_search (search_string = "search string", not_an_arg = TRUE),
        "The parameters \\[not_an_arg\\] are not figshare search parameters"
    )

    expect_error (
        cli$deposits_search (search_string = "search string", item_type = "this"),
        "Assertion on '\"this\"' failed: Must be of type 'single integerish value'"
    )

    expect_error (
        cli$deposits_search (search_string = "search string", item_type = 30),
        "The 'item_type' parameter must be an integer between 1 and 29"
    )

    expect_error (
        cli$deposits_search (search_string = "search string", order = "not in vocab"),
        "The 'order' parameter must be in the specified vocabulary;"
    )

    expect_error (
        cli$deposits_search (search_string = "search string", published_since = "invalid"),
        "The 'published_since' parameter must be in format YYYY-MM-DD"
    )

    expect_error (
        cli$deposits_search (search_string = "search string", modified_since = "invalid"),
        "The 'modified_since' parameter must be in format YYYY-MM-DD"
    )
})

test_that ("zenodo search errors", {

    cli <- with_mock_dir ("zen_create", {
        depositsClient$new (service = "zenodo", sandbox = TRUE)
    })


    expect_error (
        cli$deposits_search (search_string = "search string", not_an_arg = TRUE),
        "The parameters \\[not_an_arg\\] are not zenodo search parameters"
    )

    expect_error (
        cli$deposits_search (search_string = "search string", type = 1L),
        "Assertion on '1L' failed: Must be of type 'character'"
    )

    expect_error (
        cli$deposits_search (search_string = "search string", all_versions = "invalid"),
        "The 'all_versions' parameter must be either 'false' or 'true'"
    )

    expect_error (
        cli$deposits_search (search_string = "search string", bounds = "invalid"),
        "The 'bounds' parameter must be in format 'bounds=x1,y1,x2,y2'"
    )
})