From 1118d46dfe34c2d77aee04d819315a21942aa444 Mon Sep 17 00:00:00 2001 From: Hu Jun Date: Fri, 27 Dec 2024 12:06:14 -0800 Subject: add support equivalent to golang flag.TextVar(), also fixes the test failure as described in #368 --- text_test.go | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 text_test.go (limited to 'text_test.go') diff --git a/text_test.go b/text_test.go new file mode 100644 index 0000000..2a667ab --- /dev/null +++ b/text_test.go @@ -0,0 +1,53 @@ +package pflag + +import ( + "fmt" + "os" + "testing" + "time" +) + +func setUpTime(t *time.Time) *FlagSet { + f := NewFlagSet("test", ContinueOnError) + f.TextVar(t, "time", time.Now(), "time stamp") + return f +} + +func TestText(t *testing.T) { + testCases := []struct { + input string + success bool + expected time.Time + }{ + {"2003-01-02T15:04:05Z", true, time.Date(2003, 1, 2, 15, 04, 05, 0, time.UTC)}, + {"2003-01-02 15:05:01", false, time.Date(2002, 1, 2, 15, 05, 05, 07, time.UTC)}, + {"2024-11-22T03:01:02Z", true, time.Date(2024, 11, 22, 3, 1, 02, 0, time.UTC)}, + {"2006-01-02T15:04:05+07:00", true, time.Date(2006, 1, 2, 15, 4, 5, 0, time.FixedZone("UTC+7", 7*60*60))}, + } + + devnull, _ := os.Open(os.DevNull) + os.Stderr = devnull + for i := range testCases { + var ts time.Time + f := setUpTime(&ts) + tc := &testCases[i] + arg := fmt.Sprintf("--time=%s", tc.input) + err := f.Parse([]string{arg}) + if err != nil && tc.success == true { + t.Errorf("expected success, got %q", err) + continue + } else if err == nil && tc.success == false { + t.Errorf("expected failure, but succeeded") + continue + } else if tc.success { + parsedT := new(time.Time) + err := f.GetText("time", parsedT) + if err != nil { + t.Errorf("Got error trying to fetch the time flag: %v", err) + } + if !parsedT.Equal(tc.expected) { + t.Errorf("expected %q, got %q", tc.expected, parsedT) + } + } + } +} -- cgit v1.2.3 From 011db0c1163722ac2fa4452be8be8123768dc912 Mon Sep 17 00:00:00 2001 From: Hu Jun Date: Sat, 10 May 2025 16:26:11 -0700 Subject: - update text_test.go based on PR review comments - return is missing in one error path of GetText(), fixed --- text.go | 2 +- text_test.go | 31 +++++++++++++++++-------------- 2 files changed, 18 insertions(+), 15 deletions(-) (limited to 'text_test.go') diff --git a/text.go b/text.go index 3726606..886d5a3 100644 --- a/text.go +++ b/text.go @@ -55,7 +55,7 @@ func (f *FlagSet) GetText(name string, out encoding.TextUnmarshaler) error { return fmt.Errorf("flag accessed but not defined: %s", name) } if flag.Value.Type() != reflect.TypeOf(out).Name() { - fmt.Errorf("trying to get %s value of flag of type %s", reflect.TypeOf(out).Name(), flag.Value.Type()) + return fmt.Errorf("trying to get %s value of flag of type %s", reflect.TypeOf(out).Name(), flag.Value.Type()) } return out.UnmarshalText([]byte(flag.Value.String())) } diff --git a/text_test.go b/text_test.go index 2a667ab..e60c136 100644 --- a/text_test.go +++ b/text_test.go @@ -20,7 +20,7 @@ func TestText(t *testing.T) { expected time.Time }{ {"2003-01-02T15:04:05Z", true, time.Date(2003, 1, 2, 15, 04, 05, 0, time.UTC)}, - {"2003-01-02 15:05:01", false, time.Date(2002, 1, 2, 15, 05, 05, 07, time.UTC)}, + {"2003-01-02 15:05:01", false, time.Time{}}, //negative case, invalid layout {"2024-11-22T03:01:02Z", true, time.Date(2024, 11, 22, 3, 1, 02, 0, time.UTC)}, {"2006-01-02T15:04:05+07:00", true, time.Date(2006, 1, 2, 15, 4, 5, 0, time.FixedZone("UTC+7", 7*60*60))}, } @@ -33,21 +33,24 @@ func TestText(t *testing.T) { tc := &testCases[i] arg := fmt.Sprintf("--time=%s", tc.input) err := f.Parse([]string{arg}) - if err != nil && tc.success == true { - t.Errorf("expected success, got %q", err) + if err != nil { + if tc.success { + t.Errorf("expected parsing to succeed, but got %q", err) + } continue - } else if err == nil && tc.success == false { - t.Errorf("expected failure, but succeeded") + } + if !tc.success { + t.Errorf("expected parsing failure, but parsing succeeded") continue - } else if tc.success { - parsedT := new(time.Time) - err := f.GetText("time", parsedT) - if err != nil { - t.Errorf("Got error trying to fetch the time flag: %v", err) - } - if !parsedT.Equal(tc.expected) { - t.Errorf("expected %q, got %q", tc.expected, parsedT) - } } + parsedT := new(time.Time) + err = f.GetText("time", parsedT) + if err != nil { + t.Errorf("Got error trying to fetch the time flag: %v", err) + } + if !parsedT.Equal(tc.expected) { + t.Errorf("expected %q, got %q", tc.expected, parsedT) + } + } } -- cgit v1.2.3