config easegress-server with env

pkg/option/env.go

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2017, MegaEase
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http:https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package option
+
+import (
+ "fmt"
+ "os"
+ "strings"
+
+ "github.com/spf13/pflag"
+)
+
+// SetFlagsFromEnv sets flags from environment variables.
+func SetFlagsFromEnv(prefix string, fs *pflag.FlagSet) error {
+ var err error
+ fs.VisitAll(func(f *pflag.Flag) {
+ if err2 := setFlagFromEnv(fs, prefix, f.Name); err2 != nil {
+ err = err2
+ }
+ })
+ return err
+}
+
+func flagToEnv(prefix, name string) string {
+ return prefix + "_" + strings.ToUpper(strings.ReplaceAll(name, "-", "_"))
+}
+
+func setFlagFromEnv(fs *pflag.FlagSet, prefix, flagName string) error {
+ key := flagToEnv(prefix, flagName)
+ val := os.Getenv(key)
+ if val != "" {
+ if err := fs.Set(flagName, val); err != nil {
+ return fmt.Errorf("invalid value %q for %s: %v", val, key, err)
+ }
+ }
+ return nil
+}

pkg/option/env_test.go

@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2017, MegaEase
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http:https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package option
+
+import (
+ "os"
+ "testing"
+
+ "github.com/spf13/pflag"
+ "github.com/stretchr/testify/assert"
+)
+
+func TestSetFlagsFromEnv(t *testing.T) {
+ assert := assert.New(t)
+
+ os.Setenv("EASEGRESS_TEST_STRING", "test")
+ os.Setenv("EASEGRESS_TEST_BOOL", "true")
+ os.Setenv("EASEGRESS_TEST_ARRAY", "a,b,c")
+ os.Setenv("EASEGRESS_TEST_INT", "1")
+
+ var stringFlag string
+ var boolFlag bool
+ var arrayFlag []string
+ var intFlag int
+ flags := pflag.NewFlagSet("test", pflag.ContinueOnError)
+ flags.StringVar(&stringFlag, "test-string", "", "test string flag")
+ flags.BoolVar(&boolFlag, "test-bool", false, "test bool flag")
+ flags.StringSliceVar(&arrayFlag, "test-array", []string{}, "test array flag")
+ flags.IntVar(&intFlag, "test-int", 0, "test int flag")
+
+ err := SetFlagsFromEnv("EASEGRESS", flags)
+ assert.NoError(err)
+ assert.Equal("test", stringFlag)
+ assert.Equal(true, boolFlag)
+ assert.Equal([]string{"a", "b", "c"}, arrayFlag)
+ assert.Equal(1, intFlag)
+}
+
+func TestOptionFromEnv(t *testing.T) {
+ assert := assert.New(t)
+
+ os.Setenv("EASEGRESS_NAME", "test-option-from-env")
+ os.Setenv("EASEGRESS_HOME_DIR", "./test-home-dir")
+ os.Setenv("EASEGRESS_LOG_DIR", "./test-log-dir")
+ os.Setenv("EASEGRESS_NAME", "test-option-from-env")
+ os.Setenv("EASEGRESS_LISTEN_CLIENT_URLS", "http:https://localhost:2379,http:https://localhost:10080")
+
+ {
+ // options from env
+ opt := New()
+ err := opt.Parse()
+ assert.NoError(err)
+ assert.Equal("test-option-from-env", opt.Name)
+ assert.Equal("./test-home-dir", opt.HomeDir)
+ assert.Equal("./test-log-dir", opt.LogDir)
+ assert.Equal([]string{"http:https://localhost:2379", "http:https://localhost:10080"}, opt.Cluster.ListenClientURLs)
+ }
+
+ {
+ args := os.Args
+ defer func() {
+ os.Args = args
+ }()
+ os.Args = []string{"easegress-server", "--name=test-option-from-args", "--home-dir=./test-home-dir-from-args", "--log-dir=./test-log-dir-from-args"}
+ // options from env and args
+ opt := New()
+ err := opt.Parse()
+ assert.NoError(err)
+ assert.Equal("test-option-from-args", opt.Name)
+ assert.Equal("./test-home-dir-from-args", opt.HomeDir)
+ assert.Equal("./test-log-dir-from-args", opt.LogDir)
+ assert.Equal([]string{"http:https://localhost:2379", "http:https://localhost:10080"}, opt.Cluster.ListenClientURLs)
+ }
+}

pkg/option/option.go

@@ -194,7 +194,11 @@ func (opt *Options) renameLegacyClusterRoles() {
 // Parse parses all arguments, when the user wants to display version information or view help,
 // we do not execute subsequent logic and return directly.
 func (opt *Options) Parse() error {
- err := opt.flags.Parse(os.Args[1:])
+ err := SetFlagsFromEnv("EASEGRESS", opt.flags)
+ if err != nil {
+ return err
+ }
+ err = opt.flags.Parse(os.Args[1:])
  if err != nil {
  return err
  }