tests/testthat/test-params.R

In tanaylab/tgconfig: Infrastructure for managing package parameters

context("params")

test_that("registering a param works", {
	register_param('param0', 'tgconfig')
	expect_equal(has_param('param0', 'tgconfig'), TRUE)  
})

test_that("basic set and get works", {
	register_param('param1', 'tgconfig')
	set_param('param1', 'value1', 'tgconfig')
	expect_equal(get_param_strict('param1', 'tgconfig'), 'value1')  
})

test_that("set and get from package works", {
	register_param('param2')
	expect_equal(get_param_strict('param2'), NULL)
	set_param('param2', 'value2')
	expect_equal(get_param_strict('param2'), 'value2')  
})

test_that("set and get NULL works", {
	register_param('param_null')
	expect_equal(get_param_strict('param_null'), NULL)
	set_param('param_null', NULL)
	expect_equal(get_param_strict('param_null'), NULL)
})

test_that("set without register fails", {	
	expect_error(set_param('param', 'value'))
	expect_error(set_param('param', 'value'))
})

test_that("get of non existing parameter", {	
	expect_error(get_param_strict('param', 'value'))
	expect_null(get_param('param', 'value'))
})

test_that("register twice does not override", {	
	register_param('param_override', default_value='defval')
	expect_equal(get_param_strict('param_override'), 'defval')
	register_param('param_override', default_value='another')
	expect_equal(get_param_strict('param_override'), 'defval')	
})

test_that("register from file works", {		
	register_params(example_config_file())
	expect_equal(get_param_strict('char_param'), 'value')
	expect_equal(get_param_strict('expr_param'), seq(1:5))
	expect_equal(get_param_strict('numeric_param'), 500)
	expect_equal(get_param_strict('boolean_param'), TRUE)
})

test_that("override from file works", {		
	register_params(example_config_file())
	override_params(system.file('config/override_example.yaml', package='tgconfig'))
	expect_equal(get_param_strict('char_param'), 'user_char')
	expect_equal(get_param_strict('expr_param'), 'user_exp')
	expect_equal(get_param_strict('numeric_param'), 700)
	expect_equal(get_param_strict('boolean_param'), FALSE)
})

test_that("override from file with unknown params fails", {		
	register_params(example_config_file())
	expect_error(override_params(system.file('config/override_fail_example.yaml', package='tgconfig')))	
})

test_that('load_params_to_env loads parameters to env', {
	register_params(example_config_file())
	load_params_to_env(c('expr_param', 'boolean_param', 'numeric_param', 'char_param'))
	expect_equal(char_param, 'user_char')
	expect_equal(expr_param, 'user_exp')
	expect_equal(numeric_param, 700)
	expect_equal(boolean_param, FALSE)
})

test_that('a parameter can be removed', {
	register_param('param1', 'tgconfig')
	rm_param('param1', 'tgconfig')
	expect_false(has_param('param1', 'tgconfig'))
})

test_that('all parameters can be removed', {
	config_file <- example_config_file()
	register_params(config_file, 'tgconfig')	
	rm_package_params('tgconfig')
	expect_null(get_package_params('tgconfig'))
})

test_that('guess package correctly', {
	register_params(example_config_file())
	temp_func <- function(){
		return(get_param_strict('char_param'))
	}
	param <- temp_func()
	expect_equal(param, 'value')
})

test_that('guess package correctly from param list', {
	register_params(example_config_file())
	temp_func <- function(param = get_param_strict('char_param')){
		return(param)
	}
	param <- temp_func()
	expect_equal(param, 'value')
})