tests/testthat/test-update-news.R

In cynkra/fledge: Smoother Change Tracking and Versioning for R Packages

test_that("update_news() works when news file absent", {
  local_fledge_quiet()
  local_demo_project(news = FALSE, quiet = TRUE)
  expect_no_error(
    update_news(which = "patch")
  )
})

test_that("update_news() works when news file still empty", {
  local_fledge_quiet()
  withr::local_envvar("FLEDGE_DATE" = "2023-01-23")

  local_demo_project(news = FALSE, quiet = TRUE)
  file.create("NEWS.md")
  expect_no_error(update_news(which = "patch"))

  local_options(pillar.width = 240)
  expect_fledge_snapshot(read_fledgling())
})

test_that("normalize_news() works", {
  withr::local_options("usethis.quiet" = TRUE)

  repo <- withr::local_tempdir()
  withr::local_dir(repo)
  usethis::with_project(
    repo,
    usethis::use_description(fields = list(Package = "fledge")),
    force = TRUE
  )

  df <- tibble::tribble(
    ~description,
    "fledge has better support.",
    "fledge's interface was improved!",
    "fledged bird?",
    "`update_news()` capitalize items",
    "2 new functions for bla",
    "harvest PR title"
  )
  expect_snapshot_tibble(normalize_news(df))
})

test_that("regroup_news() works", {
  news_list1 <- list(
    Uncategorized = c("- blop", "", "- etc"),
    Documentation = c("- stuff", "", "- other")
  )

  news_list2 <- list(
    Features = c("- feat1", "", "- feat2"),
    `Custom type` = "cool right",
    Uncategorized = c("- pof", "", "- ok"),
    Documentation = "- again"
  )

  combined <- c(news_list1, news_list2)

  expect_snapshot({
    regroup_news(combined)
  })
})

test_that("Can update dev version news item", {
  local_fledge_quiet()
  skip_if_offline()

  repo <- withr::local_tempdir(pattern = "devpkg")

  usethis::local_project(repo, force = TRUE, setwd = TRUE)
  create_cc_repo(commit_messages = "feat: new stuff")

  usethis::use_description(
    fields = list(Package = "fledge", Version = "0.1.0")
  )
  withr::with_options(
    list(repos = c("CRAN" = "https://cloud.r-project.org")),
    {
      usethis::use_news_md()
    }
  )

  usethis::use_dev_version()

  expect_snapshot_file("NEWS.md", "samedev-base.md")

  update_news()
  expect_snapshot_file("NEWS.md", name = "samedev.md")

  ## regrouping! ----
  sort_of_commit("fix: horrible bug")
  sort_of_commit("feat: neat helper")
  update_news()
  expect_snapshot_file("NEWS.md", "samedev-updated.md")
})

test_that("Can convert dev version news item to running news item", {
  local_fledge_quiet()
  skip_if_offline()

  repo <- withr::local_tempdir(pattern = "devpkg")

  usethis::local_project(repo, force = TRUE, setwd = TRUE)
  create_cc_repo(commit_messages = "feat: new stuff")

  usethis::use_description(
    fields = list(Package = "fledge", Version = "0.1.0")
  )
  withr::with_options(
    list(repos = c("CRAN" = "https://cloud.r-project.org")),
    {
      usethis::use_news_md()
    }
  )

  usethis::use_dev_version()

  update_news()

  use_r("bla")
  fast_git_add("R/bla.R")
  gert::git_commit("* Add cool bla.")

  update_news(which = "dev")
  expect_snapshot_file("NEWS.md", name = "samedev-running.md")
})

test_that("Message when creating the news file", {
  local_fledge_quiet()
  withr::local_envvar("FLEDGE_DATE" = "2023-03-20")
  local_demo_project(news = FALSE, quiet = TRUE)

  update_news()

  expect_snapshot_file("NEWS.md", "newchangelog.md")
})