Files
Suraj Nathandzeekay f13aa343a8 tempo-cli: support relative time strings for start/end args (#6458)
* tempo-cli: support relative time strings (now, now-1h) for start/end args

Add support for relative time strings across all CLI commands that
accept start/end arguments, matching Grafana's time string format.

example: now-1h, now, now-30m, etc.

Affected commands:
- query api search
- query api search-tags
- query api search-tag-values
- query api metrics query-range
- query search

Help text previously said "ISO8601 format" or showed a ISO 8601 format but the code was parsing with
`time.RFC3339` (2006-01-02T15:04:05Z07:00). ISO 8601 is a broad standard that allows many representations
including timestamps without timezone offsets.

RFC 3339 is a strict profile of ISO 8601 that always requires a timezone offset (Z or +HH:MM).

Help text is update to say RFC3339 with an example.

We now accept a uniform time format across all commands: either RFC3339 absolute timestamps or relative time strings.

query search: previously accepted timestamps without timezone (2024-03-15T10:30:00) using the layout "2006-01-02T15:04:05".
This is valid ISO 8601 but not valid RFC 3339. These timestamps are now rejected.
Users must include a timezone offset (e.g. 2024-03-15T10:30:00Z) or use relative time (e.g. now-1h).

* update docs

* Add CHANGELOG.md

* trim spaces before parsing and add tests
2026-02-22 00:55:24 -08:00

118 lines
2.3 KiB
Go

package main
import (
"testing"
"time"
"github.com/stretchr/testify/require"
)
func TestParseTime(t *testing.T) {
now := time.Now()
tests := []struct {
name string
input string
expected time.Time
wantErr bool
}{
{
name: "RFC3339 in UTC",
input: "2024-03-15T10:30:00Z",
expected: time.Date(2024, 3, 15, 10, 30, 0, 0, time.UTC),
},
{
name: "RFC3339 with timezone offset",
input: "2024-03-15T10:30:00+05:30",
expected: time.Date(2024, 3, 15, 10, 30, 0, 0, time.FixedZone("", 5*3600+30*60)),
},
{
name: "now",
input: "now",
expected: now,
},
{
name: "now-1h",
input: "now-1h",
expected: now.Add(-1 * time.Hour),
},
{
name: "now-30m",
input: "now-30m",
expected: now.Add(-30 * time.Minute),
},
{
name: "now-3h30m",
input: "now-3h30m",
expected: now.Add(-3*time.Hour - 30*time.Minute),
},
{
name: "now-7d",
input: "now-7d",
expected: now.Add(-7 * 24 * time.Hour),
},
{
name: "now-1y",
input: "now-1y",
expected: now.Add(-365 * 24 * time.Hour),
},
{
name: "format without timezone is rejected",
input: "2024-03-15T10:30:00",
wantErr: true,
},
{
name: "invalid format",
input: "yesterday",
wantErr: true,
},
{
name: "invalid relative",
input: "now+1h",
wantErr: true,
},
{
name: "invalid duration",
input: "now-abc",
wantErr: true,
},
{
name: "leading spaces are trimmed",
input: " now-1h",
expected: now.Add(-1 * time.Hour),
},
{
name: "trailing spaces are trimmed",
input: "now-1h ",
expected: now.Add(-1 * time.Hour),
},
{
name: "now with leading space",
input: " now",
expected: now,
},
{
name: "now with trailing spaces",
input: "now ",
expected: now,
},
{
name: "RFC3339 with surrounding spaces",
input: " 2024-03-15T10:30:00Z ",
expected: time.Date(2024, 3, 15, 10, 30, 0, 0, time.UTC),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result, err := parseTime(tt.input)
if tt.wantErr {
require.Error(t, err)
return
}
require.NoError(t, err)
require.WithinDuration(t, tt.expected, result, 2*time.Second)
})
}
}