tests/testthat/test-osrm_extract.R

In osrm.backend: Bindings for 'Open Source Routing Machine'

test_that("osrm_extract runs osrm-extract with expected arguments", {
  skip_if_no_osrm()
  skip_if_not_installed("processx")

  tmp_dir <- tempdir()
  input_osm <- file.path(
    tmp_dir,
    paste0("osrm-test-", Sys.getpid(), ".osm.pbf")
  )
  generated_prefix <- sub("\\.osm\\.pbf$", "", input_osm)
  on.exit(
    {
      artifacts <- list.files(
        tmp_dir,
        pattern = paste0("^", basename(generated_prefix), ""),
        full.names = TRUE
      )
      unlink(artifacts, recursive = TRUE)
    },
    add = TRUE
  )

  file.create(input_osm)
  normalized_input <- normalizePath(input_osm)
  expected_timestamp <- paste0(
    sub("\\.osm\\.pbf$", "", normalized_input, ignore.case = TRUE),
    ".osrm.timestamp"
  )

  captured <- list()
  mock_run <- function(command, args, echo, spinner, echo_cmd, ...) {
    captured <<- list(
      command = command,
      args = args,
      echo = echo,
      spinner = spinner,
      echo_cmd = echo_cmd
    )
    file.create(expected_timestamp)
    list(status = 0, stdout = "", stderr = "")
  }

  result <- with_mocked_bindings(
    osrm_extract(
      input_osm = input_osm,
      profile = "car.lua",
      threads = 2L,
      data_version = "2024-01",
      dump_nbg_graph = TRUE,
      quiet = FALSE,
      spinner = FALSE,
      echo_cmd = FALSE
    ),
    run = mock_run,
    .package = "processx"
  )

  expect_equal(tools::file_path_sans_ext(basename(captured$command)), "osrm-extract")
  expect_true(all(c("-p", "car.lua") %in% captured$args))
  expect_true("--dump-nbg-graph" %in% captured$args)
  expect_true("-d" %in% captured$args && "2024-01" %in% captured$args)
  expect_equal(result$osrm_job_artifact, expected_timestamp)
  expect_true(file.exists(expected_timestamp))
})

test_that("osrm_extract enforces overwrite flag for existing outputs", {
  skip_if_no_osrm()
  skip_if_not_installed("processx")

  tmp_dir <- tempdir()
  input_osm <- file.path(
    tmp_dir,
    paste0("osrm-overwrite-", Sys.getpid(), ".osm.pbf")
  )
  generated_prefix <- sub("\\.osm\\.pbf$", "", input_osm)
  on.exit(
    {
      artifacts <- list.files(
        tmp_dir,
        pattern = paste0("^", basename(generated_prefix), ""),
        full.names = TRUE
      )
      unlink(artifacts, recursive = TRUE)
    },
    add = TRUE
  )

  file.create(input_osm)
  existing_artifact <- paste0(generated_prefix, ".osrm.hsgr")
  file.create(existing_artifact)

  expect_error(
    with_mocked_bindings(
      osrm_extract(
        input_osm = input_osm,
        profile = "car.lua"
      ),
      run = function(...) stop("processx::run should not be called"),
      .package = "processx"
    ),
    "Found existing OSRM files"
  )

  normalized_input <- normalizePath(input_osm)
  expected_timestamp <- paste0(
    sub("\\.osm\\.pbf$", "", normalized_input, ignore.case = TRUE),
    ".osrm.timestamp"
  )

  result <- with_mocked_bindings(
    osrm_extract(
      input_osm = input_osm,
      profile = "car.lua",
      overwrite = TRUE,
      quiet = FALSE,
      spinner = FALSE
    ),
    run = function(...) {
      file.create(expected_timestamp)
      list(status = 0, stdout = "", stderr = "")
    },
    .package = "processx"
  )

  expect_equal(result$osrm_job_artifact, expected_timestamp)
  expect_true(file.exists(expected_timestamp))
})

test_that("osrm_extract accepts a directory with one OSM file", {
  skip_if_no_osrm()
  skip_if_not_installed("processx")

  tmp_dir <- file.path(tempdir(), paste0("osrm-dir-test-", Sys.getpid()))
  dir.create(tmp_dir, showWarnings = FALSE)
  on.exit(unlink(tmp_dir, recursive = TRUE), add = TRUE)

  input_osm <- file.path(tmp_dir, "test.osm.pbf")
  file.create(input_osm)

  normalized_input <- normalizePath(input_osm)
  expected_timestamp <- paste0(
    sub("\\.osm\\.pbf$", "", normalized_input, ignore.case = TRUE),
    ".osrm.timestamp"
  )

  mock_run <- function(command, args, echo, spinner, echo_cmd, ...) {
    file.create(expected_timestamp)
    list(status = 0, stdout = "", stderr = "")
  }

  result <- with_mocked_bindings(
    osrm_extract(
      input_osm = tmp_dir,
      profile = "car.lua",
      quiet = TRUE
    ),
    run = mock_run,
    .package = "processx"
  )

  expect_equal(result$osrm_job_artifact, expected_timestamp)
})

test_that("osrm_extract errors when directory has no OSM files", {
  skip_if_no_osrm()
  skip_if_not_installed("processx")

  tmp_dir <- file.path(tempdir(), paste0("osrm-empty-dir-", Sys.getpid()))
  dir.create(tmp_dir, showWarnings = FALSE)
  on.exit(unlink(tmp_dir, recursive = TRUE), add = TRUE)

  expect_error(
    osrm_extract(
      input_osm = tmp_dir,
      profile = "car.lua"
    ),
    "No OSM files.*found in directory"
  )
})

test_that("osrm_extract errors when directory has multiple OSM files", {
  skip_if_no_osrm()
  skip_if_not_installed("processx")

  tmp_dir <- file.path(tempdir(), paste0("osrm-multi-dir-", Sys.getpid()))
  dir.create(tmp_dir, showWarnings = FALSE)
  on.exit(unlink(tmp_dir, recursive = TRUE), add = TRUE)

  file.create(file.path(tmp_dir, "test1.osm.pbf"))
  file.create(file.path(tmp_dir, "test2.osm.pbf"))

  expect_error(
    osrm_extract(
      input_osm = tmp_dir,
      profile = "car.lua"
    ),
    "Multiple.*found"
  )
})