|
| 1 | +/* |
| 2 | +Copyright 2024 The Vitess Authors. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package flagutil |
| 18 | + |
| 19 | +import ( |
| 20 | + "testing" |
| 21 | + "time" |
| 22 | + |
| 23 | + "github.com/spf13/pflag" |
| 24 | + "github.com/stretchr/testify/assert" |
| 25 | +) |
| 26 | + |
| 27 | +// TestFloatOrDuration_ValidFloat64Input verifies that a float64 input |
| 28 | +// (representing seconds) is correctly converted to a time.Duration. |
| 29 | +func TestFloatOrDuration_ValidFloat64Input(t *testing.T) { |
| 30 | + var duration time.Duration |
| 31 | + fs := pflag.NewFlagSet("test", pflag.ContinueOnError) |
| 32 | + |
| 33 | + FloatDuration(fs, &duration, "test_flag", 10*time.Second, "Test flag") |
| 34 | + err := fs.Parse([]string{"--test_flag=2"}) |
| 35 | + assert.NoError(t, err) |
| 36 | + assert.Equal(t, 2*time.Second, duration) |
| 37 | +} |
| 38 | + |
| 39 | +// TestFloatOrDuration_ValidDurationInput verifies that a valid time.Duration |
| 40 | +// input (e.g., "1m30s") is parsed and stored correctly. |
| 41 | +func TestFloatOrDuration_ValidDurationInput(t *testing.T) { |
| 42 | + var duration time.Duration |
| 43 | + fs := pflag.NewFlagSet("test", pflag.ContinueOnError) |
| 44 | + |
| 45 | + FloatDuration(fs, &duration, "test_flag", 10*time.Second, "Test flag") |
| 46 | + err := fs.Parse([]string{"--test_flag=1m30s"}) |
| 47 | + assert.NoError(t, err) |
| 48 | + assert.Equal(t, 90*time.Second, duration) |
| 49 | +} |
| 50 | + |
| 51 | +// TestFloatOrDuration_DefaultValue ensures that the default value is correctly |
| 52 | +// assigned to the duration when the flag is not provided. |
| 53 | +func TestFloatOrDuration_DefaultValue(t *testing.T) { |
| 54 | + var duration time.Duration |
| 55 | + fs := pflag.NewFlagSet("test", pflag.ContinueOnError) |
| 56 | + |
| 57 | + defaultValue := 15 * time.Second |
| 58 | + FloatDuration(fs, &duration, "test_flag", defaultValue, "Test flag") |
| 59 | + err := fs.Parse([]string{}) |
| 60 | + assert.NoError(t, err) |
| 61 | + assert.Equal(t, defaultValue, duration) |
| 62 | +} |
| 63 | + |
| 64 | +// TestFloatOrDuration_InvalidInput verifies that an invalid input string |
| 65 | +// results in an appropriate error. |
| 66 | +func TestFloatOrDuration_InvalidInput(t *testing.T) { |
| 67 | + var duration time.Duration |
| 68 | + fs := pflag.NewFlagSet("test", pflag.ContinueOnError) |
| 69 | + |
| 70 | + FloatDuration(fs, &duration, "test_flag", 10*time.Second, "Test flag") |
| 71 | + err := fs.Parse([]string{"--test_flag=invalid"}) |
| 72 | + assert.Error(t, err) |
| 73 | + assert.Contains(t, err.Error(), "value must be either a float64 (interpreted as seconds) or a valid time.Duration") |
| 74 | +} |
| 75 | + |
| 76 | +// TestFloatOrDuration_MultipleFlags ensures that multiple FloatDuration flags |
| 77 | +// can coexist and maintain independent values. |
| 78 | +func TestFloatOrDuration_MultipleFlags(t *testing.T) { |
| 79 | + var duration1, duration2 time.Duration |
| 80 | + fs := pflag.NewFlagSet("test", pflag.ContinueOnError) |
| 81 | + |
| 82 | + FloatDuration(fs, &duration1, "flag1", 10*time.Second, "First test flag") |
| 83 | + FloatDuration(fs, &duration2, "flag2", 20*time.Second, "Second test flag") |
| 84 | + |
| 85 | + err := fs.Parse([]string{"--flag1=2.5", "--flag2=1m"}) |
| 86 | + assert.NoError(t, err) |
| 87 | + assert.Equal(t, 2500*time.Millisecond, duration1) |
| 88 | + assert.Equal(t, 1*time.Minute, duration2) |
| 89 | +} |
| 90 | + |
| 91 | +// TestFloatOrDuration_HelpMessage verifies that the help message includes |
| 92 | +// the correct flag name, description, and default value. |
| 93 | +func TestFloatOrDuration_HelpMessage(t *testing.T) { |
| 94 | + var duration time.Duration |
| 95 | + fs := pflag.NewFlagSet("test", pflag.ContinueOnError) |
| 96 | + |
| 97 | + defaultValue := 10 * time.Second |
| 98 | + FloatDuration(fs, &duration, "test_flag", defaultValue, "Test flag with default value") |
| 99 | + |
| 100 | + helpOutput := fs.FlagUsages() |
| 101 | + assert.Contains(t, helpOutput, "--test_flag time.Duration") |
| 102 | + assert.Contains(t, helpOutput, "Test flag with default value") |
| 103 | + assert.Contains(t, helpOutput, "(default 10s)") |
| 104 | +} |
0 commit comments