test-migration.R
In orderly: Lightweight Reproducible Reporting

test_that("Do nothing while migrating up-to-date sources", {
  path <- suppressMessages(orderly_example())
  helper_remove_outpack(path)
  info <- helper_add_git(path)

  res <- evaluate_promise(
    orderly_migrate_source(path, from = "0"))
  n <- length(res$messages)
  expect_match(res$messages[[1]], "Migrating from 1.99.0 to")
  expect_match(res$messages[[n - 1]], "Minimum orderly version already at")
  expect_match(res$messages[[n]], "Nothing to change")
  expect_false(res$result)
})


test_that("Do nothing while trying unneeded migrations", {
  path <- suppressMessages(orderly_example())
  res <- evaluate_promise(orderly_migrate_source(path))
  expect_length(res$messages, 1)
  expect_match(res$messages[[1]], "No migrations to apply")
  expect_false(res$result)
})


test_that("refuse to migrate sources that are not under version control", {
  path <- suppressMessages(orderly_example())
  expect_error(
    orderly_migrate_source(path, from = "1.99.0"),
    "Not migrating")
})


test_that("warn on dry run without version control", {
  path <- suppressMessages(orderly_example())
  res <- evaluate_promise(
    orderly_migrate_source(path, from = "1.99.0", dry_run = TRUE))
  expect_match(res$messages[[1]],
               "does not appear to be under version control")
})


test_that("refuse to migrate unclean repo", {
  path <- suppressMessages(orderly_example())
  helper_remove_outpack(path)
  info <- helper_add_git(path)
  file.create(file.path(path, "some-file"))
  err <- expect_error(
    orderly_migrate_source(path, from = "1.99.0"),
    "Not migrating")
  expect_match(conditionMessage(err), "Try running this in a fresh clone")
})


test_that("allow dry run on unclean repo", {
  path <- suppressMessages(orderly_example())
  helper_remove_outpack(path)
  info <- helper_add_git(path)
  file.create(file.path(path, "some-file"))
  res <- evaluate_promise(
    orderly_migrate_source(path, dry_run = TRUE, from = "0"))
  expect_false(res$result)
})


test_that("don't change up-to json", {
  path <- withr::local_tempfile()
  writeLines(empty_config_contents(), path)
  res <- evaluate_promise(
    update_minimum_orderly_version_json(path, ORDERLY_MINIMUM_VERSION, FALSE))
  expect_false(res$result)
  expect_match(res$messages, "Minimum orderly version already at")
})


test_that("don't change up-to yml", {
  path <- withr::local_tempfile()
  writeLines("minimum_orderly_version: 1.99.88", path)
  res <- evaluate_promise(
    update_minimum_orderly_version_yml(path, "1.99.88", FALSE))
  expect_false(res$result)
  expect_match(res$messages, "Minimum orderly version already at")
})


test_that("can increase version if required", {
  path <- withr::local_tempfile()
  writeLines(empty_config_contents(), path)
  res <- evaluate_promise(
    update_minimum_orderly_version_json(path, "9.9.9", TRUE))
  expect_true(res$result)
  expect_match(res$messages,
               "Would update minimum orderly version from .+ to 9.9.9")

  res <- evaluate_promise(
    update_minimum_orderly_version_json(path, "9.9.9", FALSE))
  expect_true(res$result)
  expect_match(res$messages,
               "Updated minimum orderly version from .+ to 9.9.9")
  expect_equal(jsonlite::read_json(path),
               list("minimum_orderly_version" = "9.9.9"))
})


test_that("can increase version if required (yaml)", {
  path <- withr::local_tempfile()
  writeLines("minimum_orderly_version: 1.99.0", path)
  res <- evaluate_promise(
    update_minimum_orderly_version_yml(path, "9.9.9", FALSE))
  expect_true(res$result)
  expect_match(res$messages,
               "Updated minimum orderly version from .+ to 9.9.9")
  expect_equal(yaml::read_yaml(path),
               list("minimum_orderly_version" = "9.9.9"))
})


test_that("error if no minimum version key found", {
  path <- withr::local_tempfile()
  file.create(path)
  expect_error(
    update_minimum_orderly_version_json(path, "2.0.0", FALSE),
    "Failed to find key 'minimum_orderly_version' in orderly config")
  expect_error(
    update_minimum_orderly_version_yml(path, "2.0.0", FALSE),
    "Failed to find key 'minimum_orderly_version' in orderly config")
})


test_that("cope with malformed yaml", {
  path <- withr::local_tempfile()
  writeLines(rep("minimum_orderly_version: 1.99.0", 2), path)
  expect_error(
    update_minimum_orderly_version_yml(path, ORDERLY_MINIMUM_VERSION, FALSE),
    "Found more than one key 'minimum_orderly_version' in orderly config")
})


test_that("leave other yaml alone when updating", {
  path <- withr::local_tempfile()
  txt <- '# a comment\nminimum_orderly_version: "0.0.1"'
  writeLines(txt, path)
  res <- evaluate_promise(
    update_minimum_orderly_version_yml(path, "9.9.9", FALSE))
  expect_equal(readLines(path),
               c("# a comment", 'minimum_orderly_version: "9.9.9"'))
})


test_that("can migrate source file", {
  path <- withr::local_tempdir()
  file <- "foo.R"
  filename <- file.path(path, file)
  txt <- c("# some comment", "orderly2::orderly_parameter(a = 1)")
  writeLines(txt, filename)

  res <- evaluate_promise(migrate_1_99_82_file(path, file, TRUE))
  expect_true(res$result)
  expect_match(res$messages, "Would update 1 line in foo.R")
  expect_equal(readLines(filename), txt)

  res <- evaluate_promise(migrate_1_99_82_file(path, file, FALSE))
  expect_true(res$result)
  expect_match(res$messages, "Updated 1 line in foo.R")
  expect_equal(readLines(filename), sub("orderly2", "orderly", txt))
})


test_that("can migrate old sources", {
  path <- suppressMessages(orderly_example())
  unlink(file.path(path, "orderly_config.json"))
  writeLines(
    'minimum_orderly_version: "1.99.0"',
    file.path(path, "orderly_config.yml"))

  filename <- file.path(path, "src", "data", "data.R")
  txt <- readLines(filename)
  writeLines(sub("^orderly_", "orderly2::orderly_", txt),
             filename)

  helper_remove_outpack(path)
  info <- helper_add_git(path)

  res <- evaluate_promise(
    orderly_migrate_source(path, to = "1.99.82", dry_run = TRUE))
  expect_length(res$messages, 5)
  expect_match(res$messages[[1]], "Migrating from 1.99.0 to 1.99.82")
  expect_match(res$messages[[2]], "Checking \\d+ files in")
  expect_match(res$messages[[3]], "Would update 2 lines in src/data/data.R")
  expect_match(res$messages[[4]], "Would update minimum orderly version")
  expect_match(res$messages[[5]], "Would change 2 files")
  expect_true(res$result)

  expect_equal(nrow(gert::git_status(repo = path)), 0)

  res <- evaluate_promise(
    orderly_migrate_source(path, to = "1.99.82"))
  expect_length(res$messages, 6)
  expect_match(res$messages[[1]], "Migrating from 1.99.0 to 1.99.82")
  expect_match(res$messages[[2]], "Checking \\d+ files in")
  expect_match(res$messages[[3]], "Updated 2 lines in src/data/data.R")
  expect_match(res$messages[[4]], "Updated minimum orderly version")
  expect_match(res$messages[[5]], "Changed 2 files")
  expect_match(res$messages[[6]],
               "Please review, then add and commit these to git")
  expect_true(res$result)

  expect_equal(nrow(gert::git_status(repo = path)), 2)
})


## TODO: this needs work too
test_that("can read version from config", {
  path <- withr::local_tempdir()
  filename <- file.path(path, "orderly_config.yml")
  file.create(filename)
  expect_error(
    orderly_migrate_read_version(path),
    "Invalid orderly configuration does not have key")
  writeLines("minimum_orderly_version: 1.99.99", filename)
  expect_equal(orderly_migrate_read_version(path),
               numeric_version("1.99.99"))
})



test_that("can migrate orderly.R files", {
  path <- suppressMessages(orderly_example())
  write_old_version_marker(path, "1.99.82")

  nms <- orderly_list_src(path)
  fs::file_move(file.path(path, "src", nms, paste0(nms, ".R")),
                file.path(path, "src", nms, "orderly.R"))
  helper_remove_outpack(path)
  info <- helper_add_git(path)

  expect_length(dir(path, "orderly\\.R$", recursive = TRUE), length(nms))

  res <- evaluate_promise(
    orderly_migrate_source(path, to = "1.99.88", dry_run = TRUE))
  expect_length(res$messages, length(nms) + 3)
  n <- length(res$messages)
  expect_match(res$messages[[1]], "Migrating from 1.99.82 to 1.99.88")
  expect_match(res$messages[2:(n - 2)],
               "Would rename '.+/orderly\\.R' to '.+/.+\\.R'")
  expect_match(res$messages[[n - 1]], "Would update minimum orderly version")
  expect_match(res$messages[[n]],
               sprintf("Would change %d files", length(nms) + 1))
  expect_true(res$result)

  expect_equal(nrow(gert::git_status(repo = path)), 0)

  res <- evaluate_promise(
    orderly_migrate_source(path, to = "1.99.88"))
  expect_length(res$messages, length(nms) + 4)
  expect_true(res$result)

  expect_equal(nrow(gert::git_status(repo = path)), length(nms) * 2 + 1)
  expect_length(dir(path, "orderly\\.R$", recursive = TRUE), 0)
})


test_that("delete old orderly.R files", {
  path <- suppressMessages(orderly_example())
  write_old_version_marker(path, "1.99.82")
  file.create(file.path(path, "src", "data", "orderly.R"))
  helper_remove_outpack(path)
  info <- helper_add_git(path)

  res <- evaluate_promise(
    orderly_migrate_source(path, to = "1.99.88", dry_run = TRUE))
  expect_match(res$messages[[2]], "Would delete 'src/data/orderly.R'")
  expect_true(res$result)
  expect_equal(nrow(gert::git_status(repo = path)), 0)

  res <- evaluate_promise(
    orderly_migrate_source(path, to = "1.99.88"))
  expect_match(res$messages[[2]], "Deleting 'src/data/orderly.R'")
  expect_true(res$result)
  expect_equal(nrow(gert::git_status(repo = path)), 2)
  expect_false(file.exists(file.path(path, "src", "data", "orderly.R")))
})


test_that("can migrate old configuration", {
  path <- suppressMessages(orderly_example())
  write_old_version_marker(path, "1.99.88")
  helper_remove_outpack(path)
  info <- helper_add_git(path)

  res <- evaluate_promise(
    orderly_migrate_source(path, to = "1.99.90", dry_run = TRUE))
  expect_true(res$result)
  expect_length(res$messages, 4)
  expect_match(res$messages[[2]],
               "Would translate 'orderly_config.yml' to 'orderly_config.json'")

  res <- evaluate_promise(
    orderly_migrate_source(path, to = "1.99.90"))
  expect_true(res$result)
  expect_equal(nrow(gert::git_status(repo = path)), 2)
  expect_false(file.exists(file.path(path, "orderly_config.yml")))
  expect_true(file.exists(file.path(path, "orderly_config.json")))
  expect_equal(jsonlite::read_json(file.path(path, "orderly_config.json")),
               list("minimum_orderly_version" = "1.99.90"))
})


test_that("can't migrate complex old configuration", {
  path <- suppressMessages(orderly_example())
  fs::file_delete(file.path(path, "orderly_config.json"))
  writeLines("minimum_orderly_version: 1.99.88\nother: true",
             file.path(path, "orderly_config.yml"))
  helper_remove_outpack(path)
  info <- helper_add_git(path)

  expect_error(suppressMessages(
    orderly_migrate_source(path, to = "1.99.90", dry_run = TRUE)),
    "Can't migrate nontrivial orderly configuration")
  expect_error(suppressMessages(
    orderly_migrate_source(path, to = "1.99.90", dry_run = FALSE)),
    "Can't migrate nontrivial orderly configuration")

  expect_true(file.exists(file.path(path, "orderly_config.yml")))
  expect_false(file.exists(file.path(path, "orderly_config.json")))
})


test_that("leave archive files alone", {
  path <- suppressMessages(orderly_example())
  write_old_version_marker(path, "1.99.0")

  filename <- file.path(path, "src", "data", "data.R")
  txt <- readLines(filename)
  writeLines(sub("^orderly_", "orderly2::orderly_", txt),
             filename)

  env <- new.env()
  id <- withr::with_dir(path, orderly_run_quietly("data", envir = env))

  info <- helper_add_git(path)

  res <- evaluate_promise(
    orderly_migrate_source(path, to = "1.99.82", dry_run = TRUE))
  expect_length(res$messages, 7)
  expect_match(res$messages[[1]], "fresh clone")
  expect_match(res$messages[[2]], "Found directories")
  expect_match(res$messages[[3]], "Migrating from 1.99.0 to 1.99.82")
  expect_match(res$messages[[4]], "Checking \\d+ files in")
  expect_match(res$messages[[5]], "Would update 2 lines in src/data/data.R")
  expect_match(res$messages[[6]], "Would update minimum orderly version")
  expect_match(res$messages[[7]], "Would change 2 files")
  expect_true(res$result)

  expect_equal(nrow(gert::git_status(repo = path)), 0)

  expect_error(
    orderly_migrate_source(path, to = "1.99.82"),
    "Not migrating")
})