tests/testthat/test_boxes.R

In opensensmapr: Client for the Data API of 'openSenseMap.org'

source('testhelpers.R')
context('boxes')

try({
  boxes = osem_boxes()
})

test_that('a list of all boxes can be retrieved and returns a sensebox data.frame', {
  check_api()

  expect_true(is.data.frame(boxes))
  expect_true(is.factor(boxes$model))
  expect_true(is.character(boxes$name))
  expect_length(names(boxes), 18) 
  expect_true(any('sensebox' %in% class(boxes)))
})

test_that('both from and to are required when requesting boxes, error otherwise', {
  expect_error(osem_boxes(from = as.POSIXct('2017-01-01')), 'must be used together')
  expect_error(osem_boxes(to   = as.POSIXct('2017-01-01')), 'must be used together')
})

test_that('a list of boxes with phenomenon filter returns only the requested phenomenon', {
  check_api()

  boxes_phen = osem_boxes(phenomenon = 'Temperatur', date = Sys.time())
  expect_true(all(grep('Temperatur', boxes_phen$phenomena)))
})

test_that('a list of boxes with exposure filter returns only the requested exposure', {
  check_api()

  boxes_exp = osem_boxes(exposure = 'mobile')
  expect_true(all(boxes_exp$exposure == 'mobile'))
})

test_that('a list of boxes with model filter returns only the requested model', {
  check_api()

  boxes_mod = osem_boxes(model = 'homeWifi')
  expect_true(all(boxes_mod$model == 'homeWifi'))
})

test_that('box query can combine exposure and model filter', {
  check_api()

  boxes_com = osem_boxes(exposure = 'mobile', model = 'homeWifi')
  expect_true(all(boxes_com$model == 'homeWifi'))
  expect_true(all(boxes_com$exposure == 'mobile'))
})

test_that('a list of boxes with grouptype returns only boxes of that group', {
  check_api()

  boxes_gro = osem_boxes(grouptag = 'codeformuenster')
  expect_true(all(boxes_gro$grouptag == 'codeformuenster'))
})

test_that('a list of boxes within a bbox only returns boxes within that bbox', {
  check_api()

  boxes_box = osem_boxes(bbox = c(7.8, 51.8, 8.0, 52.0))
  expect_true(all(boxes_box$lon > 7.8 & boxes_box$lon < 8.0 & boxes_box$lat > 51.8 & boxes_box$lat < 52.0))
})

test_that('endpoint can be (mis)configured', {
  check_api()

  expect_error(osem_boxes(endpoint = 'http://not.the.opensensemap.org'), 'The API at http://not.the.opensensemap.org is currently not available.')
})

test_that('a response with no matches returns empty sensebox data.frame', {
  check_api()

  suppressWarnings({
    boxes_gro = osem_boxes(grouptag = 'does_not_exist')
  })
  expect_true(is.data.frame(boxes_gro))
  expect_true(any('sensebox' %in% class(boxes_gro)))
})

test_that('a response with no matches gives a warning', {
  check_api()

  expect_warning(osem_boxes(grouptag = 'does_not_exist'), 'no senseBoxes found')
})

test_that('data.frame can be converted to sensebox data.frame', {
  df = osem_as_sensebox(data.frame(c(1, 2), c('a', 'b')))
  expect_equal(class(df), c('sensebox', 'data.frame'))
})

test_that('boxes can be converted to sf object', {
  check_api()

  # boxes = osem_boxes()
  boxes_sf = sf::st_as_sf(boxes)

  expect_true(all(sf::st_is_simple(boxes_sf)))
  expect_true('sf' %in% class(boxes_sf))
})

test_that('boxes converted to sf object keep all attributes', {
  check_api()

  # boxes = osem_boxes()
  boxes_sf = sf::st_as_sf(boxes)

  # coord columns get removed!
  cols = names(boxes)[!names(boxes) %in% c('lon', 'lat')]
  expect_true(all(cols %in% names(boxes_sf)))

  expect_true('sensebox' %in% class(boxes_sf))
})

test_that('box retrieval does not give progress information in non-interactive mode', {
  check_api()

  if (!opensensmapr:::is_non_interactive()) skip('interactive session')

  out = capture.output({
    b = osem_boxes()
  })
  expect_length(out, 0)
})

test_that('print.sensebox filters important attributes for a set of boxes', {
  check_api()

  # boxes = osem_boxes()
  msg = capture.output({
    print(boxes)
  })
  expect_false(any(grepl('description', msg)), 'should filter attribute "description"')
})

test_that('summary.sensebox outputs all metrics for a set of boxes', {
  check_api()

  # boxes = osem_boxes()
  msg = capture.output({
    summary(boxes)
  })
  expect_true(any(grepl('sensors per box:', msg)))
  expect_true(any(grepl('oldest box:', msg)))
  expect_true(any(grepl('newest box:', msg)))
  expect_true(any(grepl('\\$last_measurement_within', msg)))
  expect_true(any(grepl('boxes by model:', msg)))
  expect_true(any(grepl('boxes by exposure:', msg)))
  expect_true(any(grepl('boxes total:', msg)))
})

test_that('requests can be cached', {
  check_api()

  osem_clear_cache()
  expect_length(list.files(tempdir(), pattern = 'osemcache\\..*\\.rds'), 0)
  b = osem_boxes(cache = tempdir())

  cacheFile = paste(
    tempdir(),
    opensensmapr:::osem_cache_filename('/boxes'),
    sep = '/'
  )
  expect_true(file.exists(cacheFile))
  expect_length(list.files(tempdir(), pattern = 'osemcache\\..*\\.rds'), 1)

  # no download output (works only in interactive mode..)
  out = capture.output({
    b = osem_boxes(cache = tempdir())
  })
  expect_length(out, 0)
  expect_length(list.files(tempdir(), pattern = 'osemcache\\..*\\.rds'), 1)

  osem_clear_cache()
  expect_length(list.files(tempdir(), pattern = 'osemcache\\..*\\.rds'), 0)
})

context('single box from boxes')
test_that('a single box can be retrieved by ID', {
  check_api()
  
  box = osem_box(boxes$X_id[[1]])
  
  expect_true('sensebox' %in% class(box))
  expect_true('data.frame' %in% class(box))
  expect_true(nrow(box) == 1)
  expect_true(box$X_id == boxes$X_id[[1]])
  expect_silent(osem_box(boxes$X_id[[1]]))
})

test_that('[.sensebox maintains attributes', {
  check_api()
  
  expect_true(all(attributes(boxes[1:nrow(boxes), ]) %in% attributes(boxes)))
})

context('measurements boxes')
test_that('measurements of specific boxes can be retrieved for one phenomenon and returns a measurements data.frame', {
  check_api()
  
  # fix for subsetting
  class(boxes) = c('data.frame')
  three_boxes = boxes[1:3, ]
  class(boxes) = c('sensebox', 'data.frame')
  three_boxes = osem_as_sensebox(three_boxes)
  phens = names(osem_phenomena(three_boxes))
  
  measurements = osem_measurements(x = three_boxes, phenomenon = phens[[1]])
  expect_true(is.data.frame(measurements))
  expect_true('osem_measurements' %in% class(measurements))
})

test_that('phenomenon is required when requesting measurements, error otherwise', {
  check_api()
  
  expect_error(osem_measurements(boxes), 'Parameter "phenomenon" is required')
})