v2.0.1

Author: zxdev

env.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"os/user"
 	"path/filepath"
 	"reflect"
 	"runtime"
@@ -45,6 +46,7 @@ type Options struct {
 	Silent bool // silence log configuration output
 	NoHelp bool // silence help output
 	SetENV bool // set KEY=VALUE in environment
+	NoExit bool // return nil instead of os.Exit(0) for version,help
 }
 
 // Configure sets up the basic environment and returns environment paths;
@@ -108,6 +110,9 @@ func Configure(cfg ...interface{}) (path *Path) {
 
 			fmt.Printf("\n %-s\n%s\n version %s\n build   %s\n\n",
 				name, strings.Repeat("-", n+2), Version, Build)
+			if opt.NoExit {
+				return nil
+			}
 			os.Exit(0)
 
 		case "help":
@@ -174,6 +179,9 @@ func Configure(cfg ...interface{}) (path *Path) {
 				}
 			}
 			fmt.Println()
+			if opt.NoExit {
+				return nil
+			}
 			os.Exit(0)
 		}
 	}
@@ -184,12 +192,14 @@ func Configure(cfg ...interface{}) (path *Path) {
 
 	if !opt.Silent {
 
+		usr, _ := user.Current()
+
 		log.Printf("|%s|", strings.Repeat("-", 40))
 		log.Printf("| %s %s event log |", strings.ToUpper(filepath.Base(os.Args[0])), strings.Repeat(":", 27-len(filepath.Base(os.Args[0]))))
 		log.Printf("|-----//o%s|", strings.Repeat("-", 32))
 		log.Printf("%s%s version", strings.Repeat(" ", 31-len(Version)), Version)
 		log.Printf("%s%s build", strings.Repeat(" ", 31-len(Build)), Build)
-		log.Printf("%spid %d", strings.Repeat(" ", 28), os.Getpid())
+		log.Printf(" %s%spid %d", usr.Username, strings.Repeat(" ", 27-len(usr.Username)), os.Getpid())
 		log.Printf("|-----//o%s|", strings.Repeat("-", 32))
 
 		var tag string

env_test.go

@@ -0,0 +1,126 @@
+package env_test
+
+import (
+	"context"
+	"log"
+	"os"
+	"sync"
+	"testing"
+
+	"github.com/zxdev/env"
+)
+
+func TestEnv(t *testing.T) {
+
+	type Action struct {
+		Action string `env:"a,order,require" default:"pull" help:"action chain[@path pull|process|expire|export]"`
+		Secret string `env:"hidden" help:"the shared secret"`
+		Show   bool   `default:"on" help:"show the processing values"`
+
+		Seg  []string  `env:"-"` // args segments
+		Path *env.Path `env:"-"` // path params
+	}
+
+	var a Action
+	a.Path = env.NewEnv(&a)
+
+}
+
+func TestHelp(t *testing.T) {
+
+	type Action struct {
+		Action string `env:"a,order,require" default:"pull" help:"action chain[@path pull|process|expire|export]"`
+		Secret string `env:"hidden" help:"the shared secret"`
+		Show   bool   `default:"on" help:"show the processing values"`
+
+		Seg  []string  `env:"-"` // args segments
+		Path *env.Path `env:"-"` // path params
+	}
+
+	// spoof help request
+	os.Args = []string{"test", "help"}
+
+	// we have to set opt.NoExit so this test will operate
+	var a Action
+	a.Path = env.NewEnv(&env.Options{NoExit: true}, &a)
+
+}
+
+func TestVersion(t *testing.T) {
+
+	type Action struct {
+		Action string `env:"a,order,require" default:"pull" help:"action chain[@path pull|process|expire|export]"`
+		Secret string `env:"hidden" help:"the shared secret"`
+		Show   bool   `default:"on" help:"show the processing values"`
+
+		Seg  []string  `env:"-"` // args segments
+		Path *env.Path `env:"-"` // path params
+	}
+
+	// spoof version request
+	os.Args = []string{"test", "version"}
+	env.Version = "test.0.0.0"
+	env.Build = "abc"
+
+	// we have to set opt.NoExit so this test will operate
+	var a Action
+	a.Path = env.NewEnv(&env.Options{NoExit: true}, &a)
+
+}
+
+type Action struct{}
+
+func (a *Action) Start(ctx context.Context) {
+	log.Println("action: start entry")
+	defer log.Println("action: start exit")
+	<-ctx.Done()
+}
+
+func (a *Action) Init00() {
+	log.Println("action: init00 entry")
+}
+
+func (a *Action) Init01(ctx context.Context, init *sync.WaitGroup) {
+	log.Println("action: init01 entry")
+	defer log.Println("action: init01 exit")
+	defer init.Done()
+	<-ctx.Done()
+}
+
+func (a *Action) Init02(ctx context.Context) func() {
+	log.Println("action: init02 entry")
+	return func() {
+		defer log.Println("action: init92 exit")
+		<-ctx.Done()
+	}
+}
+
+func (a *Action) Init03(ctx context.Context) func() {
+	log.Println("action: init03 entry")
+	return func() {
+		go func() {
+			defer log.Println("action: init03 exit")
+			<-ctx.Done()
+		}()
+	}
+}
+
+func TestGraceInit(t *testing.T) {
+
+	var a Action
+	grace := env.GraceInit(nil, a.Init00)
+	defer grace.Wait()
+
+	grace.Done()
+
+}
+
+func TestGraceInitContext(t *testing.T) {
+
+	var a Action
+	grace := env.GraceInitContext(nil, a.Init01)
+	defer grace.SetExit(-1).Wait()
+
+	grace.Done()
+
+}

example/main.go

@@ -18,35 +18,52 @@ import (
 
 */
 
+type expire struct {
+	Path string
+	TTL  time.Duration
+}
+
 // Expire struct
 type Expire struct {
 	CheckOn time.Duration // frequency of checks (default: hourly)
-	item    []struct {    // directory targets
-		Path string
-		TTL  time.Duration
-	}
-	silent bool
+	item    []expire
+	silent  bool
 }
 
 // Silent flag toggle for env.Expire, writes logs on os.Stderr (default: on)
 func (ex *Expire) Silent() *Expire { ex.silent = !ex.silent; return ex }
 
-// Add will register a directory/path with customized age timeframe (default: 24hr expiration)
-func (ex *Expire) Add(ttl *time.Duration, path ...string) *Expire {
-
-	if ttl == nil || *ttl == 0 {
-		ttl24hr := time.Hour
-		ttl = &ttl24hr // default
+// Add will register a directory/path with customized age timeframe
+// and supports various ttl inputs
+//
+//	nil          default 24h
+//	string       "24h"
+//	int           hour * n
+//	time.Duration
+func (ex *Expire) Add(ttl interface{}, path ...string) *Expire {
+
+	var exp time.Duration
+	switch d := ttl.(type) {
+	case nil:
+		exp = time.Hour * 24
+	case string:
+		exp, _ = time.ParseDuration(d)
+		if exp == 0 {
+			exp = time.Hour * 24
+		}
+	case int:
+		exp = time.Hour * time.Duration(d)
+	case *time.Duration:
+		exp = *d
+	case time.Duration:
+		exp = d
 	}
 
 	for i := range path {
 		if len(path[i]) > 0 {
-			ex.item = append(ex.item, struct {
-				Path string
-				TTL  time.Duration
-			}{path[i], *ttl})
+			ex.item = append(ex.item, expire{path[i], exp})
 			if !ex.silent {
-				log.Printf("expire: add %s ttl[%s]", filepath.Base(path[i]), *ttl)
+				log.Printf("expire: add %s ttl[%s]", filepath.Base(path[i]), exp)
 			}
 		}
 	}

expire.go

@@ -2,4 +2,3 @@ module github.com/zxdev/env
 
 go 1.15
 
-retract [v2.0.0, v2.9.9]