tests/testthat/test-get_consumption.R

In octopusR: Interact with the 'Octopus Energy' API

skip_if_offline(host = "api.octopus.energy")

test_that("Can return consumption data sample", {
  expect_message(
    {
      consumption_data <- get_consumption("electricity")
    },
    "Returning 100 rows only as a date range wasn't provided"
  )

  expect_s3_class(consumption_data, "tbl")
  expect_named(
    consumption_data,
    c("consumption", "interval_start", "interval_end")
  )
  expect_identical(nrow(consumption_data), 100L)
})

test_that("errors properly with incorrect params", {
  expect_error(
    get_consumption(),
    "You must specify \"electricity\" or \"gas\" for `meter_type`"
  )

  expect_error(
    get_consumption("electricity", period_to = Sys.Date()),
    "To use `period_to` you must also provide the `period_from` parameter to create a range"
  )
})

test_that("Returned data is consistent", {
  expect_snapshot(
    get_consumption(
      meter_type = "electricity",
      group_by = "week",
      period_from = "2022-01-01",
      period_to = "2022-01-31"
    )
  )
  expect_snapshot(
    get_consumption(
      meter_type = "electricity",
      group_by = "week",
      period_from = "2022-01-01",
      period_to = "2022-01-31",
      tz = "UTC"
    )
  )
  expect_snapshot(
    get_consumption(
      meter_type = "electricity",
      group_by = "week",
      period_from = "2022-01-01",
      period_to = "2022-01-31",
      tz = "UTC",
      order_by = "period"
    )
  )
})