tests/testthat/test-departures.R

In ptvapi: Access the 'Public Transport Victoria' Timetable API

if (identical(Sys.getenv("NOT_CRAN"), "true")) {
# ---------------------------------------------------------------------------- #
# ---- Define values if they haven't already been defined by another test ---- #
# ---------------------------------------------------------------------------- #
if (!exists("all_routes")) {
  all_routes <- routes()
}

if (!exists("frankston_route_id")) {
  frankston_route_id <- all_routes %>%
    dplyr::filter(route_name == "Frankston") %>%
    pull(route_id)
}

if (!exists("stops_near_flinders_street")) {
  stops_near_flinders_street <- stops_nearby(
    latitude = -37.8183,
    longitude = 144.9671
  )
}

if (!exists("flinders_street_stop_id")) {
  flinders_street_stop_id <- stops_near_flinders_street %>%
    filter(stop_name == "Flinders Street Railway Station") %>%
    pull(stop_id)
}
# ---------------------------------------------------------------------------- #

flinders_departures <- departures(
  stop_id = flinders_street_stop_id,
  route_type = "Train"
)

test_that("departures result has class \"ptvapi\"", {
  expect_s3_class(flinders_departures, "ptvapi")
})

flinders_street_stop_id <- stops_nearby(
    latitude = -37.8183,
    longitude = 144.9671
  ) %>%
  filter(stop_name == "Flinders Street Railway Station") %>%
  pull(stop_id)

test_that("Frankston train departs from Flinders Street Station",
  expect_true(frankston_route_id %in% flinders_departures$route_id)
)

test_that("Departures filtered by platform_number", {
  platform_5_6_departures <- departures(
    stop_id = flinders_street_stop_id,
    route_type = "Train",
    platform_numbers = c("5", "6"), # despite the name, they are characters
  )
  expect_gt(nrow(platform_5_6_departures), 0) # must have some results
  expect_true(
    # disruptions may mean that platform 5 or 6 not active
    all(platform_5_6_departures$platform_number %in% c("5", "6"))
  )
})

test_that("Departures filtered by datetime", {
  flinders_morning_departures <- departures(
    stop_id = flinders_street_stop_id,
    route_type = "Train",
    departs = morning_test_time
  )
  expect_gt(nrow(flinders_morning_departures), 0) # must have some results
  expect_gte(
    min(flinders_morning_departures$scheduled_departure),
    as.POSIXct(morning_test_time, tz = "Australia/Melbourne")
  )
})

test_that("Departures filtered by datetime with max_results = 0", {
  flinders_all_day_departures <- departures(
    stop_id = flinders_street_stop_id,
    route_type = "Train",
    departs = afternoon_test_time,
    max_results = 0
  )
  expect_gt(nrow(flinders_all_day_departures), 0) # must have some results

  # When max_results = 0, all departures after the given datetime for the entire
  # day are returned. Because of how a "day" is considered in public transport,
  # this may include some departures in the early hours of the next morning.
  expect_gte(
    min(flinders_all_day_departures$scheduled_departure),
    as.POSIXct(afternoon_test_time, tz = "Australia/Melbourne")
  )
  departure_dates <- as.Date(
    flinders_all_day_departures$scheduled_departure,
    tz = "Australia/Melbourne"
  )
  expect_true(
    all(departure_dates %in% c(
      as.Date(afternoon_test_time, tz = "Australia/Melbourne"),
      as.Date(afternoon_test_time, tz = "Australia/Melbourne") + 1)
    )
  )
})

test_that("Departures filtered by datetime and max_results", {
  flinders_afternoon_departures <- departures(
    stop_id = flinders_street_stop_id,
    route_type = "Train",
    departs = afternoon_test_time,
    max_results = 3
  )
  expect_gt(nrow(flinders_afternoon_departures), 0) # must have some results
  expect_gte(
    min(flinders_afternoon_departures$scheduled_departure),
    as.POSIXct(afternoon_test_time, tz = "Australia/Melbourne")
  )
  departures_per_route_id <- count(flinders_afternoon_departures, route_id)
  expect_true(all(departures_per_route_id$n == 3))
})

test_that("Departures filtered by route_id", {
  flinders_route_6_departures <- departures(
    stop_id = flinders_street_stop_id,
    route_type = "Train",
    route_id = 6
  )
  expect_equal(
    distinct(flinders_route_6_departures, route_id)$route_id,
    6
  )
})
}