tests/testthat/test-versioning.R

In crunch: Crunch.io Data Tools

context("Versions")

with_mock_crunch({
    ds <- cachedLoadDataset("test ds")
    test_that("Version catalog exists", {
        expect_is(versions(ds), "VersionCatalog")
    })

    test_that("Version catalog attributes (and sorting)", {
        expect_length(versions(ds), 2)
        expect_identical(
            names(versions(ds)),
            c("another version", "initial load")
        )
        expect_identical(
            descriptions(versions(ds)),
            c("another version", "initial load")
        )
        expect_identical(
            strftime(timestamps(versions(ds)), "%d %b %Y"),
            c("15 Feb 2015", "12 Feb 2015")
        )
    })

    test_that("Version catalog print method", {
        expect_identical(
            formatVersionCatalog(versions(ds),
                from = strptime("2015-02-17", "%Y-%m-%d", tz = "UTC")
            ),
            data.frame(
                Name = c("another version", "initial load"),
                Timestamp = c("1 day ago", "4 days ago"),
                stringsAsFactors = FALSE
            )
        )
    })

    test_that("saveVersion makes the right request", {
        expect_POST(
            saveVersion(ds, "Today"),
            "https://app.crunch.io/api/datasets/1/savepoints/",
            '{"description":"Today"}'
        )
    })

    test_that("saveVersion with no description supplied", {
        expect_POST(
            saveVersion(ds),
            "https://app.crunch.io/api/datasets/1/savepoints/",
            '{"description":"Version 3"}'
        )
    })

    test_that("saveVersion rejects invalid description", {
        expect_error(
            saveVersion(ds, c("Today", "Tomorrow")),
            paste(dQuote("description"), "must be a length-1 character vector")
        )
        expect_error(
            saveVersion(ds, list()),
            paste(dQuote("description"), "must be a length-1 character vector")
        )
        expect_error(
            saveVersion(ds, character(0)),
            paste(dQuote("description"), "must be a length-1 character vector")
        )
    })

    test_that("restoreVersion makes the right request", {
        expect_POST(
            restoreVersion(ds, "initial load"),
            "https://app.crunch.io/api/datasets/1/savepoints/v2/revert/"
        )
        expect_POST(
            restoreVersion(ds, 2),
            "https://app.crunch.io/api/datasets/1/savepoints/v2/revert/"
        )
        expect_error(
            restoreVersion(ds, "not a version"),
            paste0(
                dQuote("not a version"),
                " does not match any available versions"
            )
        )
    })
})


with_test_authentication({
    ds <- newDataset(df)
    test_that("Dataset imported correctly", {
        expect_valid_df_import(ds)
    })

    test_that("There is an initial version", {
        expect_identical(names(versions(ds)), "initial import")
    })

    ## Make changes:
    # 1. Edit variable metadata
    names(categories(ds$v4))[1:2] <- c("d", "e")
    name(ds$v2) <- "Variable Two"
    description(ds$v3) <- "The third variable in the dataset"

    # 2. Edit dataset metadata
    # No longer supported

    # 3. Reorder variables
    ordering(ds) <- VariableOrder(
        VariableGroup("Even", ds[c(2, 4, 6)]),
        VariableGroup("Odd", ds[c(1, 3, 5)])
    )

    # 4. Derive variable
    ds$v7 <- ds$v3 - 6

    # 5. Add non-derived variable
    ds$v8 <- rep(1:5, 4)

    ## Assert those things
    test_that("The edits are made", {
        expect_identical(names(na.omit(categories(ds$v4))), c("d", "e"))
        expect_identical(name(ds$v2), "Variable Two")
        expect_identical(
            description(ds$v3),
            "The third variable in the dataset"
        )
        expect_identical(as.vector(ds$v7), df$v3 - 6)
        expect_equivalent(as.vector(ds$v8), rep(1:5, 4))
        expect_identical(
            aliases(variables(ds)),
            paste0("v", c(2, 4, 6, 1, 3, 5, 7, 8))
        )
    })

    ## Assert those things again
    test_that("The edits made are still there after releasing", {
        expect_identical(names(na.omit(categories(ds$v4))), c("d", "e"))
        expect_identical(name(ds$v2), "Variable Two")
        expect_identical(
            description(ds$v3),
            "The third variable in the dataset"
        )
        expect_identical(as.vector(ds$v7), df$v3 - 6)
        expect_equivalent(as.vector(ds$v8), rep(1:5, 4))
        expect_identical(
            aliases(variables(ds)),
            paste0("v", c(2, 4, 6, 1, 3, 5, 7, 8))
        )
    })

    ## Save a version
    try(ds <- saveVersion(ds, "My changes"))
    test_that("There are now two versions", {
        expect_length(versions(ds), 2)
        expect_identical(names(versions(ds))[1], "My changes")
    })

    test_that("If I try to save version and there are no changes, no version is made", {
        expect_message(
            ds <- saveVersion(ds, "Another"),
            "No unsaved changes; no new version created."
        )
        expect_length(versions(ds), 2)
    })

    ## Revert to the first version
    ds <- try(restoreVersion(ds, "initial import"))
    test_that("Restoring restored correctly", {
        expect_valid_df_revert(ds)
    })

    test_that("Added variables are really removed by rolling back", {
        ## This was user-reported: Order was reverted but derived
        ## variables persisted, and by assigning an empty order, you can
        ## recover them.
        ordering(ds) <- VariableOrder()
        expect_true(setequal(names(ds), names(df)))
    })

    test_that("And now we can add variables again that we added and reverted", {
        expect_null(ds$v7)
        ## This would error if "v7" were still lurking somewhere
        ds$v7 <- ds$v3 - 7
        expect_identical(as.vector(ds$v7), df$v3 - 7)

        expect_null(ds$v8)
        ds$v8 <- rep(6:10, 4)
        expect_equivalent(as.vector(ds$v8), rep(6:10, 4))
    })

    ds <- try(restoreVersion(ds, "initial import"))
    test_that("And if we revert again, it's all good", {
        expect_valid_df_revert(ds)
    })
})