Compare commits
2 Commits
921a9de90a
...
997e9611eb
Author | SHA1 | Date |
---|---|---|
Jef Roosens | 997e9611eb | |
Jef Roosens | 44aa7c9dc9 |
59
conf.v
59
conf.v
|
@ -2,17 +2,27 @@ module conf
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import toml
|
import toml
|
||||||
|
import datatypes { Set }
|
||||||
|
|
||||||
|
[params]
|
||||||
|
pub struct LoadConfig {
|
||||||
|
prefix string
|
||||||
|
file_suffix string = '_FILE'
|
||||||
|
default_path string
|
||||||
|
// Allows overwriting
|
||||||
|
env map[string]string = os.environ()
|
||||||
|
}
|
||||||
|
|
||||||
// get_env_var tries to read the contents of the given environment variable. It
|
// get_env_var tries to read the contents of the given environment variable. It
|
||||||
// looks for either `${env.prefix}${field_name.to_upper()}` or
|
// looks for either `${env.prefix}${field_name.to_upper()}` or
|
||||||
// `${env.prefix}${field_name.to_upper()}${env.file_suffix}`, returning the
|
// `${env.prefix}${field_name.to_upper()}${env.file_suffix}`, returning the
|
||||||
// contents of the file instead if the latter. If both or neither exist, the
|
// contents of the file instead if the latter. If both or neither exist, the
|
||||||
// function returns an error.
|
// function returns an error.
|
||||||
fn get_env_var(prefix string, field_name string, file_suffix string) !string {
|
fn (ld LoadConfig) get_env_var(field_name string) !string {
|
||||||
env_var_name := '$prefix$field_name.to_upper()'
|
env_var_name := '$ld.prefix$field_name.to_upper()'
|
||||||
env_file_name := '$prefix$field_name.to_upper()$file_suffix'
|
env_file_name := '$ld.prefix$field_name.to_upper()$ld.file_suffix'
|
||||||
env_var := os.getenv(env_var_name)
|
env_var := ld.env[env_var_name] or { '' }
|
||||||
env_file := os.getenv(env_file_name)
|
env_file := ld.env[env_file_name] or { '' }
|
||||||
|
|
||||||
// If both are missing, we return an empty string
|
// If both are missing, we return an empty string
|
||||||
if env_var == '' && env_file == '' {
|
if env_var == '' && env_file == '' {
|
||||||
|
@ -38,26 +48,19 @@ fn get_env_var(prefix string, field_name string, file_suffix string) !string {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
[params]
|
|
||||||
pub struct LoadConfig {
|
|
||||||
prefix string
|
|
||||||
file_suffix string = '_FILE'
|
|
||||||
default_path string
|
|
||||||
}
|
|
||||||
|
|
||||||
// load<T> attempts to create an object of type T from the given path to a toml
|
// load<T> attempts to create an object of type T from the given path to a toml
|
||||||
// file & environment variables. For each field, it will select either a value
|
// file & environment variables. For each field, it will select either a value
|
||||||
// given from an environment variable, a value defined in the config file or a
|
// given from an environment variable, a value defined in the config file or a
|
||||||
// configured default if present, in that order.
|
// configured default if present, in that order.
|
||||||
pub fn load<T>(conf LoadConfig) !T {
|
pub fn load<T>(ld LoadConfig) !T {
|
||||||
mut res := T{}
|
mut res := T{}
|
||||||
|
|
||||||
// This array allows us to determine later whether the variable is actually
|
// This array allows us to determine later whether the variable is actually
|
||||||
// zero or just a null'ed struct field
|
// zero or just a null'ed struct field
|
||||||
mut has_value := map[string]bool{}
|
mut has_value := Set<string>{}
|
||||||
|
|
||||||
// Later, this could be read from an env var as well.
|
// Later, this could be read from an env var as well.
|
||||||
path := conf.default_path
|
path := ld.default_path
|
||||||
|
|
||||||
if os.exists(path) {
|
if os.exists(path) {
|
||||||
// We don't use reflect here because reflect also sets any fields not
|
// We don't use reflect here because reflect also sets any fields not
|
||||||
|
@ -77,13 +80,13 @@ pub fn load<T>(conf LoadConfig) !T {
|
||||||
// $compile_error('Unsupported config struct field type detected.')
|
// $compile_error('Unsupported config struct field type detected.')
|
||||||
}
|
}
|
||||||
|
|
||||||
has_value[field.name] = true
|
has_value.add(field.name)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
$for field in T.fields {
|
$for field in T.fields {
|
||||||
env_value := get_env_var(conf.prefix, field.name, conf.file_suffix)!
|
env_value := ld.get_env_var(field.name)!
|
||||||
|
|
||||||
// The value of an env var will always take precedence over the toml
|
// The value of an env var will always take precedence over the toml
|
||||||
// file.
|
// file.
|
||||||
|
@ -97,10 +100,28 @@ pub fn load<T>(conf LoadConfig) !T {
|
||||||
// $compile_error('Unsupported config struct field type detected.')
|
// $compile_error('Unsupported config struct field type detected.')
|
||||||
}
|
}
|
||||||
|
|
||||||
has_value[field.name] = true
|
has_value.add(field.name)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !(has_value[field.name] or { false }) {
|
// Finally, if there's no env var present either, we check whether the
|
||||||
|
// variable has a default value
|
||||||
|
if !has_value.exists(field.name) {
|
||||||
|
mut has_default := false
|
||||||
|
|
||||||
|
$if field.typ is string {
|
||||||
|
has_default = res.$(field.name) != ''
|
||||||
|
} $else $if field.typ is int {
|
||||||
|
has_default = res.$(field.name) != 0
|
||||||
|
}
|
||||||
|
|
||||||
|
if has_default {
|
||||||
|
has_value.add(field.name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// If there's no value provided in any way, we notify the user with an
|
||||||
|
// error.
|
||||||
|
if !has_value.exists(field.name) {
|
||||||
return error("Missing config variable '$field.name' with no provided default. Either add it to the config file or provide it using an environment variable.")
|
return error("Missing config variable '$field.name' with no provided default. Either add it to the config file or provide it using an environment variable.")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,99 @@
|
||||||
|
module conf
|
||||||
|
|
||||||
|
struct SingleConf {
|
||||||
|
some_string string
|
||||||
|
}
|
||||||
|
|
||||||
|
struct SingleConfDefault {
|
||||||
|
some_string string = 'default'
|
||||||
|
}
|
||||||
|
|
||||||
|
const env = {
|
||||||
|
'SOME_STRING': 'env'
|
||||||
|
}
|
||||||
|
|
||||||
|
const prefix_env = {
|
||||||
|
'TEST_SOME_STRING': 'env'
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_string_present_no_default() {
|
||||||
|
conf := load<SingleConf>(default_path: 'test/string.toml')!
|
||||||
|
assert conf == SingleConf{
|
||||||
|
some_string: 'hi'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_string_present_no_default_env() {
|
||||||
|
conf := load<SingleConf>(default_path: 'test/string.toml', env: .env)!
|
||||||
|
assert conf == SingleConf{
|
||||||
|
some_string: 'env'
|
||||||
|
}
|
||||||
|
|
||||||
|
conf2 := load<SingleConf>(default_path: 'test/string.toml', env: .prefix_env, prefix: 'TEST_')!
|
||||||
|
assert conf2 == SingleConf{
|
||||||
|
some_string: 'env'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_string_absent_no_default() {
|
||||||
|
conf := load<SingleConf>(default_path: 'test/empty.toml') or { return }
|
||||||
|
assert false
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_string_absent_no_default_env() {
|
||||||
|
conf := load<SingleConf>(default_path: 'test/string.toml', env: .env)!
|
||||||
|
assert conf == SingleConf{
|
||||||
|
some_string: 'env'
|
||||||
|
}
|
||||||
|
|
||||||
|
conf2 := load<SingleConf>(default_path: 'test/string.toml', env: .prefix_env, prefix: 'TEST_')!
|
||||||
|
assert conf2 == SingleConf{
|
||||||
|
some_string: 'env'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_string_present_default() {
|
||||||
|
conf := load<SingleConfDefault>(default_path: 'test/string.toml')!
|
||||||
|
assert conf == SingleConfDefault{
|
||||||
|
some_string: 'hi'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_string_present_default_env() {
|
||||||
|
conf := load<SingleConfDefault>(default_path: 'test/string.toml', env: .env)!
|
||||||
|
assert conf == SingleConfDefault{
|
||||||
|
some_string: 'env'
|
||||||
|
}
|
||||||
|
|
||||||
|
conf2 := load<SingleConfDefault>(
|
||||||
|
default_path: 'test/string.toml'
|
||||||
|
env: .prefix_env
|
||||||
|
prefix: 'TEST_'
|
||||||
|
)!
|
||||||
|
assert conf2 == SingleConfDefault{
|
||||||
|
some_string: 'env'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_string_absent_default() {
|
||||||
|
conf := load<SingleConfDefault>(default_path: 'test/empty.toml')!
|
||||||
|
assert conf == SingleConfDefault{
|
||||||
|
some_string: 'default'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_string_absent_default_env() {
|
||||||
|
conf := load<SingleConfDefault>(default_path: 'test/empty.toml', env: .env)!
|
||||||
|
assert conf == SingleConfDefault{
|
||||||
|
some_string: 'env'
|
||||||
|
}
|
||||||
|
|
||||||
|
conf2 := load<SingleConfDefault>(
|
||||||
|
default_path: 'test/empty.toml'
|
||||||
|
env: .prefix_env
|
||||||
|
prefix: 'TEST_'
|
||||||
|
)!
|
||||||
|
assert conf2 == SingleConfDefault{
|
||||||
|
some_string: 'env'
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1 @@
|
||||||
|
some_string = "hi"
|
Loading…
Reference in New Issue