Open Governance Utils

Introduction

Share utilities between OpenGovernance go projects and microservices. These modules are provided under the /pkg and as follows:

/pkg/fp

This package contains functional programming style of things.

Optional

when you want to accept optional string parameter you can define it as *string and then using the fp package pass the value into it:

fp.Optional("I am an optional string")

Includes

fp.Includes(1373, []int{1378, 1373})
fp.Includes(1372, []int{1378, 1373})

/pkg/koanf

Load configuration from environment variables, file and default based on koanf. Following code loads configuration for a service named testing based on its Config type.

cfg := koanf.Provide("testing", Config{
    RabbitMQ: koanf.RabbitMQ{
        Service:  "rabbitmq.io",
        Username: "admin",
        Password: "admin",
    },
})

You can pass the default values by passing an instance of the Config and fill it with default values. Environment variables should be prefixed by service name to be considered. For example for the testing service you need to use TESTING_RABBITMQ__SERVICE to reference Config.RabbitMQ.Service.

Please note that to use koanf you need to tag your structure by koanf and set the name for configuration as follows:

type Config struct {
 RabbitMQ koanf.RabbitMQ `koanf:"rabbitmq"`
}