tests/testthat/test-nml.R

In USGS-R/glmtools: Tools for working with the General Lake Model (GLM)

context("testing read_nml")

test_that("reading nml file from template", {
    nml <<- read_nml()
    expect_is(nml, 'nml')
})

context("testing set_nml")
test_that("set_nml() with different datatypes", {
    # check logicals
    expect_error(set_nml(nml, arg_name = 'met_sw', arg_val = 'yes'))
    expect_error(set_nml(nml, arg_name = 'met_sw', arg_val = 1))
    expect_error(set_nml(nml, arg_name = 'met_sw', arg_val = c(1,2,3)))
    
})

context("can use vectors for logicals")
test_that("set_nml() can use a vector for logicals", {
  nml <- set_nml(nml, 'subm_flag', c(T, F))
  expect_true(get_nml_value(nml, 'subm_flag')[1])
  expect_false(get_nml_value(nml, 'subm_flag')[2])
  expect_error(set_nml(nml, 'subm_flag', c(T, F, '.false.')))
})

test_that("can read in nml with vector for logicals", {
  nml <- read_nml(system.file(package='glmtools','extdata','multiple_booleans.nml'))
  expect_true(length(get_nml_value(nml, 'flt_off_sw')) > 1)
  expect_is(get_nml_value(nml, 'flt_off_sw'), 'logical')
})

test_that("can read and write nml with vectors", {
  # read character vectors
  glm_nml <- read_nml()
  glm_nml <- set_nml(glm_nml, arg_list = list(
    'inflow_fl' = c("yahara.csv", "yahara2.csv")))
  expect_equal(
    length(get_nml_value(glm_nml, arg_name = "inflow_fl")), 
    1)
  
  # writing character vectors is backwards compatible
  glm_nml <- read_nml()
  glm_nml <- set_nml(glm_nml, arg_name = "inflow_fl", 
                     arg_val = c("yahara.csv", "yahara2.csv"))
  expect_equal(
    length(get_nml_value(glm_nml, arg_name = "inflow_fl")), 
    1)
  
  # read numeric vectors
  glm_nml <- read_nml()
  glm_nml <- set_nml(glm_nml, arg_list = list(
    'A' = c(1, 2, 3)))
  expect_true(
    length(get_nml_value(glm_nml, arg_name = "A")) > 1)
  
  # write character vectors
  write_path <- paste0(tempdir(), 'glm3.nml')
  write_nml(glm_nml, file = write_path)
  expect_equal(
    length(get_nml_value(read_nml(write_path), arg_name = "inflow_fl")), 
    1)
  
  # write numeric vectors
  write_path <- paste0(tempdir(), 'glm3.nml')
  write_nml(glm_nml, file = write_path)
  expect_true(
    length(get_nml_value(read_nml(write_path), arg_name = "A")) > 1)
})

test_that("can read values from an nml file", {
  nml <- read_nml()
  nml <- set_nml(nml, "sim_name", "test")
  temp_nml <- tempfile(fileext = ".nml")
  write_nml(nml, temp_nml)
  
  expect_true(get_nml_value(arg_name = "sim_name") == "GLMSimulation")
  expect_true(
    get_nml_value(arg_name = "sim_name", nml_file = temp_nml) == "test")
  
  nml <- read_nml()
  expect_error(
    get_nml_value(nml, arg_name = "sim_name", nml_file = temp_nml))
})

context("reading a bad nml file")
test_that("file errors out",{
  expect_error(read_nml(system.file('extdata','bad_glm2.nml',package='glmtools')))
})

context("set_nml() and get_nml_value() with lists and arguments")
test_that("reading and setting nml works as expected", {
    # set string to a string
    nml <- set_nml(nml, arg_name = 'start', arg_val = 'yes')

    expect_match(get_nml_value(nml, 'start'), 'yes')
    
    # use arg_list
    t_val <- 'no'
    nml <- set_nml(nml, arg_list = list('start'= t_val, 'stop'='2000-08-01 00:00:00'))
    expect_match(get_nml_value(nml, 'start'), t_val)

    expect_error(set_nml(nml, arg_list = list('start','yes',TRUE)))
    
    # use arg_list and arg_name (conflict)
    expect_error(set_nml(nml, arg_name = 'start',arg_name = 'yes', arg_list = list('start'='no')))
    # pass list to arg_name (should be char)
    expect_error(set_nml(nml, arg_name = list('start'='no')))
})