feat(core): add support for relative date parsing

Author: remyleone

go.mod

@@ -17,6 +17,7 @@ require (
 	github.com/getsentry/raven-go v0.2.0
 	github.com/gorilla/websocket v1.4.2
 	github.com/hashicorp/go-version v1.2.0
+	github.com/karrick/tparse v2.4.2+incompatible
 	github.com/kr/pretty v0.1.0 // indirect
 	github.com/mattn/go-colorable v0.1.4
 	github.com/mattn/go-isatty v0.0.11

go.sum

@@ -39,6 +39,9 @@ github.com/hashicorp/go-version v1.2.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
 github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
+github.com/karrick/tparse v1.0.0 h1:qVJoscl1sG/UodDmNjjY6cSIun7s541PNNE42dqstfg=
+github.com/karrick/tparse v2.4.2+incompatible h1:+cW306qKAzrASC5XieHkgN7/vPaGKIuK62Q7nI7DIRc=
+github.com/karrick/tparse v2.4.2+incompatible/go.mod h1:ASPA+vrIcN1uEW6BZg8vfWbzm69ODPSYZPU6qJyfdK0=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=

internal/args/errors.go

@@ -187,3 +187,19 @@ func missingIndices(index, length int) string {
 	}
 	return strings.Join(s, ",")
 }
+
+type CannotParseDateError struct {
+	ArgValue               string
+	AbsoluteTimeParseError error
+	RelativeTimeParseError error
+}
+
+func (e *CannotParseDateError) Error() string {
+	return fmt.Sprintf(`date parsing error: could not parse %s as either an absolute time (RFC3339) nor a relative time (now(+/-)RFC3339)
+
+Try using RFC3339 for absolute time '2006-01-02T15:04:05Z07:00'. You can also have relative time with 'now +/- a duration' ex: 'now+1d-3w4mo+7y6h4m'
+
+AbsoluteTimeParseError: %s
+RelativeTimeParseError: %s
+`, e.ArgValue, e.AbsoluteTimeParseError, e.RelativeTimeParseError)
+}

internal/args/unmarshal.go

@@ -14,6 +14,7 @@ import (
 	"time"
 
 	"github.com/dustin/go-humanize"
+	"github.com/karrick/tparse"
 	"github.com/scaleway/scaleway-sdk-go/scw"
 	"github.com/scaleway/scaleway-sdk-go/strcase"
 	"github.com/scaleway/scaleway-sdk-go/validation"
@@ -61,13 +62,24 @@ var unmarshalFuncs = map[reflect.Type]UnmarshalFunc{
 
 	reflect.TypeOf((*time.Time)(nil)).Elem(): func(value string, dest interface{}) error {
 		// Handle absolute time
-		t, err := time.Parse(time.RFC3339, value)
-		if err != nil {
-			return err
+		absoluteTimeParsed, absoluteErr := time.Parse(time.RFC3339, value)
+		// Handle relative time
+		relativeTimeParsed, relativeErr := tparse.ParseNow(time.RFC3339, value)
+
+		if absoluteErr == nil {
+			*(dest.(*time.Time)) = absoluteTimeParsed
+			return nil
+		}
+		if relativeErr == nil {
+			*(dest.(*time.Time)) = relativeTimeParsed
+			return nil
 		}
 
-		*(dest.(*time.Time)) = t
-		return nil
+		return &CannotParseDateError{
+			ArgValue:               value,
+			AbsoluteTimeParseError: absoluteErr,
+			RelativeTimeParseError: relativeErr,
+		}
 	},
 }
 

internal/args/unmarshal_test.go

@@ -247,6 +247,33 @@ func TestUnmarshalStruct(t *testing.T) {
 		},
 	}))
 
+	t.Run("Relative date positive", run(TestCase{
+		args: []string{
+			"time=now+1m1s",
+		},
+		expected: &WellKnownTypes{
+			Time: time.Date(2006, 01, 02, 15, 04, 05, 0, time.UTC),
+		},
+	}))
+
+	t.Run("Relative date negative", run(TestCase{
+		args: []string{
+			"time=now-1m1s",
+		},
+		expected: &WellKnownTypes{
+			Time: time.Date(2006, 01, 02, 15, 04, 05, 0, time.UTC),
+		},
+	}))
+
+	t.Run("Unknown relative date markers", run(TestCase{
+		args: []string{
+			"time=-1R",
+		},
+		expected: &WellKnownTypes{
+			Time: time.Date(2006, 01, 02, 15, 04, 05, 0, time.UTC),
+		},
+	}))
+
 	t.Run("nested-basic", run(TestCase{
 		args: []string{
 			"basic.string=test",

internal/core/bootstrap.go

@@ -144,6 +144,11 @@ func Bootstrap(config *BootstrapConfig) (exitCode int, result interface{}, err e
 		}
 	}
 
+	// We use this map for relative time parsing.
+	// Using a tparse.ParseWithMap instead of tparse.ParseNow allows us to mock it in testing
+	timeMap := make(map[string]time.Time)
+	timeMap["now"] = time.Now()
+
 	// Meta store globally available variables like SDK client.
 	// Meta is injected in a context object that will be passed to all commands.
 	meta := &meta{
@@ -156,6 +161,7 @@ func Bootstrap(config *BootstrapConfig) (exitCode int, result interface{}, err e
 		OverrideExec:   config.OverrideExec,
 		ConfigPathFlag: configPathFlag,
 		Logger:         log,
+		TimeMap:        timeMap,
 
 		stdout:                      config.Stdout,
 		stderr:                      config.Stderr,

internal/core/context.go

@@ -6,6 +6,7 @@ import (
 	"net/http"
 	"os"
 	"path"
+	"time"
 
 	"github.com/scaleway/scaleway-sdk-go/scw"
 )
@@ -31,6 +32,7 @@ type meta struct {
 	result                      interface{}
 	httpClient                  *http.Client
 	isClientFromBootstrapConfig bool
+	TimeMap                     map[string]time.Time
 }
 
 type contextKey int
@@ -166,7 +168,11 @@ func ExtractProfileFlag(ctx context.Context) string {
 	return extractMeta(ctx).ProfileFlag
 }
 
-// GetDocGenContext reuturn a minimal context that can be used by scw-doc-gen
+func ExtractTimeMap(ctx context.Context) map[string]time.Time {
+	return extractMeta(ctx).TimeMap
+}
+
+// GetDocGenContext return a minimal context that can be used by scw-doc-gen
 func GetDocGenContext() context.Context {
 	ctx := context.Background()
 	client, _ := scw.NewClient(

internal/namespaces/help/custom.go

@@ -11,6 +11,7 @@ func GetCommands() *core.Commands {
 	return core.NewCommands(
 		helpRoot(),
 		newHelpCommand("output", shortOutput, longOutput),
+		newHelpCommand("date", shortDate, longDate),
 	)
 }
 

internal/namespaces/help/date.go

@@ -0,0 +1,35 @@
+package help
+
+const (
+	shortDate = "Get help about how date parsing works in the CLI"
+	longDate  = `Date parsing
+
+You have two ways for managing date in the CLI: Absolute and Relative
+
+- Absolute time
+
+  Absolute time refers to a specific and absolute point in time.
+  CLI uses RFC3339 to parse those time and pass a time.Time go structure to the underlying functions.
+
+	Example: "2006-01-02T15:04:05Z07:00"
+
+- Relative time
+
+  Relative time refers to a time calculated from adding a given duration to the time when a command is launched.
+
+	Example: now+1d4m => current time plus 1 day and 4 minutes
+
+- Units of time
+
+	Nanosecond: ns
+	Microsecond: us, µs (U+00B5 = micro symbol), μs (U+03BC = Greek letter mu)
+	Millisecond: ms
+	Second: s, sec, second, seconds
+	Minute: m, min, minute, minutes
+	Hour: h, hr, hour, hours
+	Day: d, day, days
+	Week: w, wk, week, weeks
+	Month: mo, mon, month, months
+	Year: y, yr, year, years
+`
+)