Merge pull request #1 from teeaa/support_gcp_aws_secrets

Support gcp aws secrets

Author: teeaa

README.md

@@ -4,13 +4,13 @@
 
 Minimalistic configuration reader
 
-[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go) 
-[![GoDoc](https://godoc.org/github.com/ilyakaznacheev/cleanenv?status.svg)](https://godoc.org/github.com/ilyakaznacheev/cleanenv)
-[![Go Report Card](https://goreportcard.com/badge/github.com/ilyakaznacheev/cleanenv)](https://goreportcard.com/report/github.com/ilyakaznacheev/cleanenv)
-[![Coverage Status](https://codecov.io/github/ilyakaznacheev/cleanenv/coverage.svg?branch=master)](https://codecov.io/gh/ilyakaznacheev/cleanenv)
-[![Build Status](https://img.shields.io/github/actions/workflow/status/ilyakaznacheev/cleanenv/test.yml)](https://github.com/ilyakaznacheev/cleanenv/actions)
-[![Release](https://img.shields.io/github/release/ilyakaznacheev/cleanenv.svg)](https://github.com/ilyakaznacheev/cleanenv/releases/)
-[![License](https://img.shields.io/github/license/ilyakaznacheev/cleanenv.svg)](https://github.com/ilyakaznacheev/cleanenv/blob/master/LICENSE)
+[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)
+[![GoDoc](https://godoc.org/github.com/teeaa/cleanenv?status.svg)](https://godoc.org/github.com/teeaa/cleanenv)
+[![Go Report Card](https://goreportcard.com/badge/github.com/teeaa/cleanenv)](https://goreportcard.com/report/github.com/teeaa/cleanenv)
+[![Coverage Status](https://codecov.io/github/teeaa/cleanenv/coverage.svg?branch=master)](https://codecov.io/gh/teeaa/cleanenv)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/teeaa/cleanenv/test.yml)](https://github.com/teeaa/cleanenv/actions)
+[![Release](https://img.shields.io/github/release/teeaa/cleanenv.svg)](https://github.com/teeaa/cleanenv/releases/)
+[![License](https://img.shields.io/github/license/teeaa/cleanenv.svg)](https://github.com/teeaa/cleanenv/blob/master/LICENSE)
 
 ## Overview
 
@@ -22,30 +22,35 @@ This is a simple configuration reading tool. It just does the following:
 
 ## Content
 
-- [Installation](#installation)
-- [Usage](#usage)
+- [Clean Env](#clean-env)
+  - [Overview](#overview)
+  - [Content](#content)
+  - [Installation](#installation)
+  - [Usage](#usage)
     - [Read Configuration](#read-configuration)
     - [Read Environment Variables Only](#read-environment-variables-only)
     - [Update Environment Variables](#update-environment-variables)
     - [Description](#description)
-- [Model Format](#model-format)
-- [Supported types](#supported-types)
-- [Custom Functions](#custom-functions)
+  - [Model Format](#model-format)
+  - [Supported types](#supported-types)
+  - [Custom Functions](#custom-functions)
     - [Custom Value Setter](#custom-value-setter)
     - [Custom Value Update](#custom-value-update)
-- [Supported File Formats](#supported-file-formats)
-- [Integration](#integration)
+  - [Supported File Formats](#supported-file-formats)
+  - [Integration](#integration)
     - [Flag](#flag)
-- [Examples](#examples)
-- [Contribution](#contribution)
-- [Thanks](#thanks)
+  - [Examples](#examples)
+  - [Version Support Policy](#version-support-policy)
+  - [Contribution](#contribution)
+  - [Thanks](#thanks)
+  - [Blog Posts](#blog-posts)
 
 ## Installation
 
 To install the package run
 
 ```bash
-go get -u github.com/ilyakaznacheev/cleanenv
+go get -u github.com/teeaa/cleanenv
 ```
 
 ## Usage
@@ -65,7 +70,7 @@ There are just several actions you can do with this tool and probably only thing
 You can read a configuration file and environment variables in a single function call.
 
 ```go
-import "github.com/ilyakaznacheev/cleanenv"
+import "github.com/teeaa/cleanenv"
 
 type ConfigDatabase struct {
     Port     string `yaml:"port" env:"PORT" env-default:"5432"`
@@ -93,8 +98,8 @@ This will do the following:
 
 Sometimes you don't want to use configuration files at all, or you may want to use `.env` file format instead. Thus, you can limit yourself with only reading environment variables:
 
-```go 
-import "github.com/ilyakaznacheev/cleanenv"
+```go
+import "github.com/teeaa/cleanenv"
 
 type ConfigDatabase struct {
     Port     string `env:"PORT" env-default:"5432"`
@@ -117,7 +122,7 @@ if err != nil {
 Some environment variables may change during the application run. To get the new values you need to mark these variables as updatable with the tag `env-upd` and then run the update function:
 
 ```go
-import "github.com/ilyakaznacheev/cleanenv"
+import "github.com/teeaa/cleanenv"
 
 type ConfigRemote struct {
     Port     string `env:"PORT" env-upd`
@@ -144,7 +149,7 @@ Here remote host and port may change in a distributed system architecture. Field
 You can get descriptions of all environment variables to use them in the help documentation.
 
 ```go
-import "github.com/ilyakaznacheev/cleanenv"
+import "github.com/teeaa/cleanenv"
 
 type ConfigServer struct {
     Port     string `env:"PORT" env-description:"server port"`
@@ -179,6 +184,8 @@ Library uses tags to configure the model of configuration structure. There are t
 - `env-description="<value>"` - environment variable description;
 - `env-layout="<value>"` - parsing layout (for types like `time.Time`);
 - `env-prefix="<value>"` - prefix for all fields of nested structure (only for nested structures);
+- `gcp_secret="projects/<project_id>/secrets/<secret_id>/versions/<version_id>"` - flag for GCP secrets, this tag will hold the full resource name of the secret version. You can use latest for the `version_id` to always get the newest version;
+- `aws_secret-"<secret_name_or_arn>"` - flag for AWS secrets, this tag will hold the name or ARN of the secret;
 
 ## Supported types
 
@@ -265,7 +272,7 @@ You can use the cleanenv help together with Golang `flag` package.
 
 ```go
 // create some config structure
-var cfg config 
+var cfg config
 
 // create flag set using `flag` package
 fset := flag.NewFlagSet("Example", flag.ContinueOnError)
@@ -320,4 +327,4 @@ The logo was made by [alexchoffy](https://www.instagram.com/alexchoffy/).
 
 ## Blog Posts
 
-[Clean Configuration Management in Golang](https://dev.to/ilyakaznacheev/clean-configuration-management-in-golang-1c89).
+[Clean Configuration Management in Golang](https://dev.to/teeaa/clean-configuration-management-in-golang-1c89).

cleanenv.go

@@ -51,6 +51,12 @@ const (
 
 	// TagEnvPrefix flag to specify prefix for structure fields
 	TagEnvPrefix = "env-prefix"
+
+	// TagGcpSecret flag to specify secret in GCP Secret Manager
+	TagGcpSecret = "gcp_secret"
+
+	// TagAwsSecret flag to specify secret in AWS Secrets Manager
+	TagAwsSecret = "aws_secret"
 )
 
 // Setter is an interface for a custom value setter.
@@ -262,7 +268,6 @@ type parseFunc func(*reflect.Value, string, *string) error
 
 // Any specific supported struct can be added here
 var validStructs = map[reflect.Type]parseFunc{
-
 	reflect.TypeOf(time.Time{}): func(field *reflect.Value, value string, layout *string) error {
 		var l string
 		if layout != nil {
@@ -337,7 +342,7 @@ func readStructMetadata(cfgRoot interface{}) ([]structMeta, error) {
 
 			// process nested structure (except of supported ones)
 			if fld := s.Field(idx); fld.Kind() == reflect.Struct {
-				//skip unexported
+				// skip unexported
 				if !fld.CanInterface() {
 					continue
 				}

cleanenv_test.go

@@ -515,6 +515,7 @@ func TestReadEnvVarsTime(t *testing.T) {
 		})
 	}
 }
+
 func TestReadEnvVarsWithPrefix(t *testing.T) {
 	type Logging struct {
 		Debug bool `env:"DEBUG"`
@@ -532,7 +533,7 @@ func TestReadEnvVarsWithPrefix(t *testing.T) {
 		Extra    DBConfig `env-prefix:"EXTRA_"`
 	}
 
-	var env = map[string]string{
+	env := map[string]string{
 		"DB_HOST":           "db1.host",
 		"DB_PORT":           "10000",
 		"DB_DEBUG":          "true",
@@ -552,7 +553,7 @@ func TestReadEnvVarsWithPrefix(t *testing.T) {
 		t.Fatal("failed to read env vars", err)
 	}
 
-	var expected = Config{
+	expected := Config{
 		Default: DBConfig{
 			Host:    "db1.host",
 			Port:    10000,
@@ -595,7 +596,6 @@ type testConfigUpdateNoFunction struct {
 }
 
 func TestReadUpdateFunctions(t *testing.T) {
-
 	tests := []struct {
 		name    string
 		cfg     interface{}
@@ -1511,7 +1511,8 @@ func TestParseJSON(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			var cfg config
 			var err error
-			if err := ParseJSON(tt.r, &cfg); (err != nil) != tt.wantErr {
+			err = ParseJSON(tt.r, &cfg)
+			if err != nil && tt.wantErr {
 				t.Errorf("ParseJSON() error = %v, wantErr %v", err, tt.wantErr)
 			}
 			if err == nil && !reflect.DeepEqual(&cfg, tt.want) {
@@ -1569,7 +1570,8 @@ two = 2`),
 		t.Run(tt.name, func(t *testing.T) {
 			var cfg config
 			var err error
-			if err := ParseTOML(tt.r, &cfg); (err != nil) != tt.wantErr {
+			err = ParseTOML(tt.r, &cfg)
+			if err != nil && tt.wantErr {
 				t.Errorf("ParseTOML() error = %v, wantErr %v", err, tt.wantErr)
 			}
 			if err == nil && !reflect.DeepEqual(&cfg, tt.want) {

example/custom_setter/main.go

@@ -6,7 +6,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/ilyakaznacheev/cleanenv"
+	"github.com/teeaa/cleanenv"
 )
 
 type config struct {

example/env_config/main.go

@@ -7,7 +7,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/ilyakaznacheev/cleanenv"
+	"github.com/teeaa/cleanenv"
 )
 
 type config struct {

example/parse_multiple_files/main.go

@@ -3,7 +3,7 @@ package main
 import (
 	"log"
 
-	"github.com/ilyakaznacheev/cleanenv"
+	"github.com/teeaa/cleanenv"
 )
 
 type config struct {

example/simple_config/example.go

@@ -7,7 +7,7 @@ import (
 	"net/http"
 	"os"
 
-	"github.com/ilyakaznacheev/cleanenv"
+	"github.com/teeaa/cleanenv"
 )
 
 // Config is a application configuration structure

example_test.go

@@ -6,7 +6,7 @@ import (
 	"net/url"
 	"os"
 
-	"github.com/ilyakaznacheev/cleanenv"
+	"github.com/teeaa/cleanenv"
 )
 
 // ExampleGetDescription builds a description text from structure tags
@@ -25,7 +25,7 @@ func ExampleGetDescription() {
 	}
 
 	fmt.Println(text)
-	//Output: Environment variables:
+	// Output: Environment variables:
 	//   ONE int64
 	//     	first parameter
 	//   THREE string
@@ -50,7 +50,7 @@ func ExampleGetDescription_defaults() {
 	}
 
 	fmt.Println(text)
-	//Output: Environment variables:
+	// Output: Environment variables:
 	//   ONE int64
 	//     	first parameter (default "1")
 	//   THREE string
@@ -73,7 +73,7 @@ func ExampleGetDescription_variableList() {
 	}
 
 	fmt.Println(text)
-	//Output: Environment variables:
+	// Output: Environment variables:
 	//   ONE int64
 	//     	first found parameter
 	//   THREE int64 (alternative to ONE)
@@ -100,7 +100,7 @@ func ExampleGetDescription_customHeaderText() {
 	}
 
 	fmt.Println(text)
-	//Output: Custom header text:
+	// Output: Custom header text:
 	//   ONE int64
 	//     	first parameter
 	//   THREE string
@@ -135,19 +135,19 @@ func ExampleUpdateEnv() {
 	cleanenv.UpdateEnv(&cfg)
 	fmt.Printf("%+v\n", cfg)
 
-	//Output: {One:1 Two:2}
+	// Output: {One:1 Two:2}
 	// {One:1 Two:22}
-
 }
 
 // ExampleReadEnv reads environment variables or default values into the structure
 func ExampleReadEnv() {
 	type config struct {
-		Port     string `env:"PORT" env-default:"5432"`
-		Host     string `env:"HOST" env-default:"localhost"`
-		Name     string `env:"NAME" env-default:"postgres"`
-		User     string `env:"USER" env-default:"user"`
-		Password string `env:"PASSWORD"`
+		Port     string  `env:"PORT" env-default:"5432"`
+		Host     string  `env:"HOST" env-default:"localhost"`
+		Name     string  `env:"NAME" env-default:"postgres"`
+		User     string  `env:"USER" env-default:"user"`
+		Password string  `env:"PASSWORD"`
+		ImageCDN url.URL `env:"IMAGE_CDN"`
 	}
 
 	var cfg config
@@ -156,27 +156,12 @@ func ExampleReadEnv() {
 	os.Setenv("NAME", "redis")
 	os.Setenv("USER", "tester")
 	os.Setenv("PASSWORD", "*****")
-
-	cleanenv.ReadEnv(&cfg)
-	fmt.Printf("%+v\n", cfg)
-
-	//Output: {Port:5050 Host:localhost Name:redis User:tester Password:*****}
-}
-
-// ExampleReadEnv reads environment variables or default values into the structure
-func ExampleReadEnvWithURL() {
-	type config struct {
-		ImageCDN url.URL `env:"IMAGE_CDN"`
-	}
-
-	var cfg config
-
 	os.Setenv("IMAGE_CDN", "https://images.cdn/")
 
 	cleanenv.ReadEnv(&cfg)
-	fmt.Printf("%+v\n", cfg.ImageCDN.String())
+	fmt.Printf("%+v\n", cfg)
 
-	//Output: https://images.cdn/
+	// Output: {Port:5050 Host:localhost Name:redis User:tester Password:***** ImageCDN:{Scheme:https Opaque: User: Host:images.cdn Path:/ RawPath: OmitHost:false ForceQuery:false RawQuery: Fragment: RawFragment:}}
 }
 
 // MyField1 is an example type with a custom setter
@@ -221,7 +206,7 @@ func Example_setter() {
 
 	cleanenv.ReadEnv(&cfg)
 	fmt.Printf("%+v\n", cfg)
-	//Output: {Default:test1 Custom1:my field is: test2 Custom2:my field is: test3}
+	// Output: {Default:test1 Custom1:my field is: test2 Custom2:my field is: test3}
 }
 
 // ConfigUpdate is a type with a custom updater
@@ -243,11 +228,11 @@ func Example_updater() {
 
 	cleanenv.ReadEnv(&cfg)
 	fmt.Printf("%+v\n", cfg)
-	//Output: {Default:default Custom:custom}
+	// Output: {Default:default Custom:custom}
 }
 
 func ExampleUsage() {
-	os.Stderr = os.Stdout //replace STDERR with STDOUT for test
+	os.Stderr = os.Stdout // replace STDERR with STDOUT for test
 
 	type config struct {
 		One   int64   `env:"ONE" env-description:"first parameter"`