Bhojpur Configure - Data Processing Engine

The Bhojpur Configure is a software-as-a-service product used as a Configuration Engine based on Bhojpur.NET Platform for application delivery.

Configuratuin using Markup files

A configuration tool that support YAML, JSON, TOML, Shell Environment (supports Go 1.17+)

Usage

package main

import (
	"fmt"
	cfgsvr "github.com/bhojpur/configure/pkg/markup"
)

var Config = struct {
	APPName string `default:"app name"`

	DB struct {
		Name     string
		User     string `default:"root"`
		Password string `required:"true" env:"DBPassword"`
		Port     uint   `default:"3306"`
	}

	Contacts []struct {
		Name  string
		Email string `required:"true"`
	}
}{}

func main() {
	cfgsvr.Load(&Config, "config.yml")
	fmt.Printf("config: %#v", Config)
}

With configuration file config.yml:

appname: test

db:
    name:     test
    user:     test
    password: test
    port:     1234

contacts:
- name: i test
  email: info@bhojpur.net

Debug Mode & Verbose Mode

Debug/Verbose mode is helpful when debuging your application, debug mode will let you know how configctl loaded your configurations, like from which file, shell env, verbose mode will tell you even more, like those shell environments configctl tried to load.

// Enable debug mode or set env `CONFIGURE_DEBUG_MODE` to true when running your application
cfgsvr.New(&cfgsvr.Config{Debug: true}).Load(&Config, "config.json")

// Enable verbose mode or set env `CONFIGURE_VERBOSE_MODE` to true when running your application
configure.New(&configure.Config{Verbose: true}).Load(&Config, "config.json")

Auto Reload Mode

The Bhojpur Configure can auto reload configuration based on time

// auto reload configuration every second
cfgsvr.New(&cfgsvr.Config{AutoReload: true}).Load(&Config, "config.json")

// auto reload configuration every minute
cfgsvr.New(&cfgsvr.Config{AutoReload: true, AutoReloadInterval: time.Minute}).Load(&Config, "config.json")

Auto Reload Callback

cfgsvr.New(&cfgsvr.Config{AutoReload: true, AutoReloadCallback: func(config interface{}) {
    fmt.Printf("%v changed", config)
}}).Load(&Config, "config.json")

Advanced Usage

• Load mutiple configurations

// Earlier configurations have higher priority
cfgsvr.Load(&Config, "application.yml", "database.json")

• Return error on unmatched keys

Return an error on finding keys in the config file that do not match any fields in the config struct. In the example below, an error will be returned if config.toml contains keys that do not match any fields in the ConfigStruct struct.

If ErrorOnUnmatchedKeys is not set, it defaults to false.

Note that for json files, setting ErrorOnUnmatchedKeys to true will have an effect only if using Go 1.17 or later.

err := cfgsvr.New(&cfgsvr.Config{ErrorOnUnmatchedKeys: true}).Load(&ConfigStruct, "config.toml")

• Load configuration by environment

Use CONFIGURE_ENV to set environment, if CONFIGURE_ENV not set, environment will be development by default, and it will be test when running tests with go test

// config.go
cfgsvr.Load(&Config, "config.json")

$ go run config.go
// Will load `config.json`, `config.development.json` if it exists
// `config.development.json` will overwrite `config.json`'s configuration
// You could use this to share same configuration across different environments

$ CONFIGURE_ENV=production go run config.go
// Will load `config.json`, `config.production.json` if it exists
// `config.production.json` will overwrite `config.json`'s configuration

$ go test
// Will load `config.json`, `config.test.json` if it exists
// `config.test.json` will overwrite `config.json`'s configuration

$ CONFIGURE_ENV=production go test
// Will load `config.json`, `config.production.json` if it exists
// `config.production.json` will overwrite `config.json`'s configuration

// Set environment by config
cfgsvr.New(&cfgsvr.Config{Environment: "production"}).Load(&Config, "config.json")

• Example Configuration

// config.go
cfgsvr.Load(&Config, "config.yml")

$ go run config.go
// Will load `config.example.yml` automatically if `config.yml` not found and print warning message

• Load From Shell Environment

$ CONFIGURE_APPNAME="hello world" CONFIGURE_DB_NAME="hello world" go run config.go
// Load configuration from shell environment, it's name is {{prefix}}_FieldName

// You could overwrite the prefix with environment CONFIGURE_ENV_PREFIX, for example:
$ CONFIGURE_ENV_PREFIX="WEB" WEB_APPNAME="hello world" WEB_DB_NAME="hello world" go run config.go

// Set prefix by config
cfgsvr.New(&cfgsvr.Config{ENVPrefix: "WEB"}).Load(&Config, "config.json")

• Anonymous Struct

Add the anonymous:"true" tag to an anonymous, embedded struct to NOT include the struct name in the environment variable of any contained fields. For example:

type Details struct {
	Description string
}

type Config struct {
	Details `anonymous:"true"`
}

With the anonymous:"true" tag specified, the environment variable for the Description field is CONFIGURE_DESCRIPTION. Without the anonymous:"true"tag specified, then environment variable would include the embedded struct name and be CONFIGURE_DETAILS_DESCRIPTION.

• With flags

func main() {
	config := flag.String("file", "config.yml", "configuration file")
	flag.StringVar(&Config.APPName, "name", "", "app name")
	flag.StringVar(&Config.DB.Name, "db-name", "", "database name")
	flag.StringVar(&Config.DB.User, "db-user", "root", "database user")
	flag.Parse()

	os.Setenv("CONFIGURE_ENV_PREFIX", "-")
	cfgsvr.Load(&Config, *config)
	// cfgsvr.Load(&Config) // only load configurations from shell env & flag
}

License

Released under the MIT License