forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[pkg/stanza] Move core time parsing capabilities to coreinternal (ope…
…n-telemetry#23232) * Move core time parsing capabilities to coreinternal * Add clarifying comment * Apply suggestions from code review Co-authored-by: Curtis Robert <[email protected]> * Replace StrptimeToGo with ParseStrptime * remove changelog --------- Co-authored-by: Faith Chikwekwe <[email protected]> Co-authored-by: Curtis Robert <[email protected]>
- Loading branch information
3 people
authored
Jun 9, 2023
1 parent
cab5ab9
commit c67489a
Showing
14 changed files
with
203 additions
and
128 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package timeutils // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal/timeutils" | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
| "time" | ||
|
|
||
| strptime "github.com/observiq/ctimefmt" | ||
| ) | ||
|
|
||
| func ParseStrptime(layout string, value any, location *time.Location) (time.Time, error) { | ||
| goLayout, err := strptime.ToNative(layout) | ||
| if err != nil { | ||
| return time.Time{}, err | ||
| } | ||
| return ParseGotime(goLayout, value, location) | ||
| } | ||
|
|
||
| func GetLocation(location *string, layout *string) (*time.Location, error) { | ||
| if location != nil && *location != "" { | ||
| // If location is specified, it must be in the local timezone database | ||
| loc, err := time.LoadLocation(*location) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to load location %s: %w", *location, err) | ||
| } | ||
| return loc, nil | ||
| } | ||
|
|
||
| if layout != nil && strings.HasSuffix(*layout, "Z") { | ||
| // If a timestamp ends with 'Z', it should be interpreted at Zulu (UTC) time | ||
| return time.UTC, nil | ||
| } | ||
|
|
||
| return time.Local, nil | ||
| } | ||
|
|
||
| func ParseGotime(layout string, value any, location *time.Location) (time.Time, error) { | ||
| timeValue, err := parseGotime(layout, value, location) | ||
| if err != nil { | ||
| return time.Time{}, err | ||
| } | ||
| return SetTimestampYear(timeValue), nil | ||
| } | ||
|
|
||
| func parseGotime(layout string, value interface{}, location *time.Location) (time.Time, error) { | ||
| var str string | ||
| switch v := value.(type) { | ||
| case string: | ||
| str = v | ||
| case []byte: | ||
| str = string(v) | ||
| default: | ||
| return time.Time{}, fmt.Errorf("type %T cannot be parsed as a time", value) | ||
| } | ||
|
|
||
| result, err := time.ParseInLocation(layout, str, location) | ||
|
|
||
| // Depending on the timezone database, we may get a pseudo-matching timezone | ||
| // This is apparent when the zone is not "UTC", but the offset is still 0 | ||
| zone, offset := result.Zone() | ||
| if offset != 0 || zone == "UTC" { | ||
| return result, err | ||
| } | ||
|
|
||
| // Manually look up the location based on the zone | ||
| loc, locErr := time.LoadLocation(zone) | ||
| if locErr != nil { | ||
| // can't correct offset, just return what we have | ||
| return result, fmt.Errorf("failed to load location %s: %w", zone, locErr) | ||
| } | ||
|
|
||
| // Reparse the timestamp, with the location | ||
| resultLoc, locErr := time.ParseInLocation(layout, str, loc) | ||
| if locErr != nil { | ||
| // can't correct offset, just return original result | ||
| return result, err | ||
| } | ||
|
|
||
| return resultLoc, locErr | ||
| } | ||
|
|
||
| // SetTimestampYear sets the year of a timestamp to the current year. | ||
| // This is needed because year is missing from some time formats, such as rfc3164. | ||
| func SetTimestampYear(t time.Time) time.Time { | ||
| if t.Year() > 0 { | ||
| return t | ||
| } | ||
| n := Now() | ||
| d := time.Date(n.Year(), t.Month(), t.Day(), t.Hour(), t.Minute(), t.Second(), t.Nanosecond(), t.Location()) | ||
| // Assume the timestamp is from last year if its month and day are | ||
| // more than 7 days past the current date. | ||
| // i.e. If today is January 1, but the timestamp is February 1, it's safe | ||
| // to assume the timestamp is from last year. | ||
| if d.After(n.AddDate(0, 0, 7)) { | ||
| d = d.AddDate(-1, 0, 0) | ||
| } | ||
| return d | ||
| } | ||
|
|
||
| // Allows tests to override with deterministic value | ||
| var Now = time.Now |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package timeutils | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestParseGoTimeBadLocation(t *testing.T) { | ||
| _, err := ParseGotime(time.RFC822, "02 Jan 06 15:04 BST", time.UTC) | ||
| require.Error(t, err) | ||
| require.Contains(t, err.Error(), "failed to load location BST") | ||
| } | ||
|
|
||
| func Test_setTimestampYear(t *testing.T) { | ||
| t.Run("Normal", func(t *testing.T) { | ||
| Now = func() time.Time { | ||
| return time.Date(2020, 06, 16, 3, 31, 34, 525, time.UTC) | ||
| } | ||
|
|
||
| noYear := time.Date(0, 06, 16, 3, 31, 34, 525, time.UTC) | ||
| yearAdded := SetTimestampYear(noYear) | ||
| expected := time.Date(2020, 06, 16, 3, 31, 34, 525, time.UTC) | ||
| require.Equal(t, expected, yearAdded) | ||
| }) | ||
|
|
||
| t.Run("FutureOneDay", func(t *testing.T) { | ||
| Now = func() time.Time { | ||
| return time.Date(2020, 01, 16, 3, 31, 34, 525, time.UTC) | ||
| } | ||
|
|
||
| noYear := time.Date(0, 01, 17, 3, 31, 34, 525, time.UTC) | ||
| yearAdded := SetTimestampYear(noYear) | ||
| expected := time.Date(2020, 01, 17, 3, 31, 34, 525, time.UTC) | ||
| require.Equal(t, expected, yearAdded) | ||
| }) | ||
|
|
||
| t.Run("FutureEightDays", func(t *testing.T) { | ||
| Now = func() time.Time { | ||
| return time.Date(2020, 01, 16, 3, 31, 34, 525, time.UTC) | ||
| } | ||
|
|
||
| noYear := time.Date(0, 01, 24, 3, 31, 34, 525, time.UTC) | ||
| yearAdded := SetTimestampYear(noYear) | ||
| expected := time.Date(2019, 01, 24, 3, 31, 34, 525, time.UTC) | ||
| require.Equal(t, expected, yearAdded) | ||
| }) | ||
|
|
||
| t.Run("RolloverYear", func(t *testing.T) { | ||
| Now = func() time.Time { | ||
| return time.Date(2020, 01, 01, 3, 31, 34, 525, time.UTC) | ||
| } | ||
|
|
||
| noYear := time.Date(0, 12, 31, 3, 31, 34, 525, time.UTC) | ||
| yearAdded := SetTimestampYear(noYear) | ||
| expected := time.Date(2019, 12, 31, 3, 31, 34, 525, time.UTC) | ||
| require.Equal(t, expected, yearAdded) | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.