tests/testthat/test-utils.R

In conflr: Client for 'Confluence' API

# Copyright (C) 2019 LINE Corporation
#
# conflr is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, version 3.
#
# conflr is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See <http://www.gnu.org/licenses/> for more details.

test_that('%|""|% works', {
  expect_equal("a" %|""|% "b", "a")
  expect_equal("" %|""|% "b", "b")
  expect_equal(NULL %|""|% "b", "b")
  expect_equal("" %|""|% "", "")
})

envvars <- list(
  CONFLUENCE_URL = "",
  CONFLUENCE_USERNAME = "user",
  CONFLUENCE_PASSWORD = "pass"
)

test_that("confl_verb() asks for credentials if it is not set", {
  skip_on_cran()

  # If the request succeeds, the provided credential is stored as an envvar
  res_success <- structure(list(status_code = 200), class = "response")
  mock_success <- mockery::mock(res_success, cycle = TRUE)
  mock_ask <- mockery::mock("foo")

  with_mock(
    "httr::VERB" = mock_success,
    "conflr::ask_confluence_url" = mock_ask,
    "conflr::ask_confluence_username" = mock_ask,
    "conflr::ask_confluence_password" = mock_ask,
    withr::with_envvar(
      envvars,
      {
        confl_verb("GET", "/")
        expect_equal(Sys.getenv("CONFLUENCE_URL"), "foo")
      }
    )
  )

  mockery::expect_called(mock_ask, 1)
  mockery::expect_call(mock_ask, n = 1, ask_confluence_url())


  # If the request fails, the provided credential is discarded

  res_failure <- structure(list(status_code = 500), class = "response")
  mock_failure <- mockery::mock(res_failure, cycle = TRUE)

  mock_ask2 <- mockery::mock("foo")

  with_mock(
    "httr::VERB" = mock_failure,
    "conflr::ask_confluence_url" = mock_ask2,
    "conflr::ask_confluence_username" = mock_ask2,
    "conflr::ask_confluence_password" = mock_ask2,
    withr::with_envvar(
      envvars,
      {
        expect_error(confl_verb("GET", "/"))
        # the url provided should not be stored
        expect_equal(Sys.getenv("CONFLUENCE_URL"), "")
      }
    )
  )

  mockery::expect_called(mock_ask2, 1)
  mockery::expect_call(mock_ask2, n = 1, ask_confluence_url())
})

test_that("try_get_existing_page_id() works", {
  with_mock(
    "conflr::confl_list_pages" = function(...) list(size = 1, results = list(list(id = 1))),
    {
      expect_equal(try_get_existing_page_id("foo", "bar"), 1)
    }
  )

  with_mock(
    "conflr::confl_list_pages" = function(...) list(size = 0, results = list()),
    {
      expect_equal(try_get_existing_page_id("foo", "bar"), NULL)
    }
  )
})

test_that("try_get_personal_space_key() handles personal spaces", {
  with_mock(
    "conflr::confl_get_space" = function(...) list(key = "space"),
    {
      expect_equal(try_get_personal_space_key("username"), "space")
    }
  )

  with_mock(
    "conflr::confl_get_space" = function(...) abort(),
    {
      expect_equal(try_get_personal_space_key("unknown"), NULL)
    }
  )
})

test_that("abort_if_null() works", {
  expect_error(abort_if_null(x = NULL), "Please provide `x`!")
  expect_error(abort_if_null(x = NULL, y = 1), "Please provide `x`!")
  expect_error(abort_if_null(x = NULL, y = 1, z = NULL), "Please provide `x` and `z`!")
  expect_silent(abort_if_null(x = 1, y = "a", z = NA))

  x <- NULL
  y <- 1
  z <- NULL
  expect_error(abort_if_null(x), "Please provide `x`!")
  expect_error(abort_if_null(x, y, z), "Please provide `x` and `z`!")
  expect_error(abort_if_null(x, y = NULL, z), "Please provide `x`, `y` and `z`!")
  expect_silent(abort_if_null(x = 1, y = "a", z = NA))
})