bake: add rfc3339parse function

Signed-off-by: CrazyMax <[email protected]>

Author: crazy-max

bake/hclparser/stdlib.go

@@ -95,6 +95,7 @@ var stdlibFunctions = []funcDef{
 	{name: "replace", fn: stdlib.ReplaceFunc},
 	{name: "reverse", fn: stdlib.ReverseFunc},
 	{name: "reverselist", fn: stdlib.ReverseListFunc},
+	{name: "rfc3339parse", factory: rfc3339ParseFunc},
 	{name: "rsadecrypt", fn: crypto.RsaDecryptFunc, descriptionAlt: `Decrypts an RSA-encrypted ciphertext.`},
 	{name: "sanitize", factory: sanitizeFunc},
 	{name: "sethaselement", fn: stdlib.SetHasElementFunc},
@@ -242,7 +243,7 @@ func sanitizeFunc() function.Function {
 
 // timestampFunc constructs a function that returns a string representation of the current date and time.
 //
-// This function was imported from terraform's datetime utilities.
+// This function was imported from Terraform's datetime utilities.
 func timestampFunc() function.Function {
 	return function.New(&function.Spec{
 		Description: `Returns a string representation of the current date and time.`,
@@ -254,6 +255,62 @@ func timestampFunc() function.Function {
 	})
 }
 
+// rfc3339ParseFunc, given an RFC3339 timestamp string, will parse and return an
+// object representation of that date and time.
+//
+// This function is similar to the `rfc3339_parse` function in Terraform:
+// https://registry.terraform.io/providers/hashicorp/time/latest/docs/functions/rfc3339_parse
+func rfc3339ParseFunc() function.Function {
+	return function.New(&function.Spec{
+		Description: `Given an RFC3339 timestamp string, will parse and return an object representation of that date and time.`,
+		Params: []function.Parameter{
+			{
+				Name:        "timestamp",
+				Description: "RFC3339 timestamp string to parse",
+				Type:        cty.String,
+			},
+		},
+		Type: function.StaticReturnType(cty.Object(map[string]cty.Type{
+			"year":         cty.Number,
+			"year_day":     cty.Number,
+			"day":          cty.Number,
+			"month":        cty.Number,
+			"month_name":   cty.String,
+			"weekday":      cty.Number,
+			"weekday_name": cty.String,
+			"hour":         cty.Number,
+			"minute":       cty.Number,
+			"second":       cty.Number,
+			"unix":         cty.Number,
+			"iso_year":     cty.Number,
+			"iso_week":     cty.Number,
+		})),
+		Impl: func(args []cty.Value, retType cty.Type) (cty.Value, error) {
+			ts := args[0].AsString()
+			rfc3339, err := time.Parse(time.RFC3339, ts)
+			if err != nil {
+				return cty.NilVal, err
+			}
+			isoYear, isoWeek := rfc3339.ISOWeek()
+			return cty.ObjectVal(map[string]cty.Value{
+				"year":         cty.NumberIntVal(int64(rfc3339.Year())),
+				"year_day":     cty.NumberIntVal(int64(rfc3339.YearDay())),
+				"day":          cty.NumberIntVal(int64(rfc3339.Day())),
+				"month":        cty.NumberIntVal(int64(rfc3339.Month())),
+				"month_name":   cty.StringVal(rfc3339.Month().String()),
+				"weekday":      cty.NumberIntVal(int64(rfc3339.Weekday())),
+				"weekday_name": cty.StringVal(rfc3339.Weekday().String()),
+				"hour":         cty.NumberIntVal(int64(rfc3339.Hour())),
+				"minute":       cty.NumberIntVal(int64(rfc3339.Minute())),
+				"second":       cty.NumberIntVal(int64(rfc3339.Second())),
+				"unix":         cty.NumberIntVal(int64(rfc3339.Unix())),
+				"iso_year":     cty.NumberIntVal(int64(isoYear)),
+				"iso_week":     cty.NumberIntVal(int64(isoWeek)),
+			}), nil
+		},
+	})
+}
+
 func Stdlib() map[string]function.Function {
 	funcs := make(map[string]function.Function, len(stdlibFunctions))
 	for _, v := range stdlibFunctions {

bake/hclparser/stdlib_test.go

@@ -197,3 +197,32 @@ func TestSanitize(t *testing.T) {
 		})
 	}
 }
+
+func TestRfc3339ParseFunc(t *testing.T) {
+	fn := rfc3339ParseFunc()
+	input := cty.StringVal("2024-06-01T15:04:05Z")
+	got, err := fn.Call([]cty.Value{input})
+	require.NoError(t, err)
+
+	expected := map[string]cty.Value{
+		"year":         cty.NumberIntVal(2024),
+		"year_day":     cty.NumberIntVal(153),
+		"day":          cty.NumberIntVal(1),
+		"month":        cty.NumberIntVal(6),
+		"month_name":   cty.StringVal("June"),
+		"weekday":      cty.NumberIntVal(6),
+		"weekday_name": cty.StringVal("Saturday"),
+		"hour":         cty.NumberIntVal(15),
+		"minute":       cty.NumberIntVal(4),
+		"second":       cty.NumberIntVal(5),
+		"unix":         cty.NumberIntVal(1717254245),
+		"iso_year":     cty.NumberIntVal(2024),
+		"iso_week":     cty.NumberIntVal(22),
+	}
+	for k, v := range expected {
+		require.True(t, got.GetAttr(k).RawEquals(v), "field %s: got %v, want %v", k, got.GetAttr(k), v)
+	}
+
+	_, err = fn.Call([]cty.Value{cty.StringVal("not-a-date")})
+	require.Error(t, err)
+}

docs/bake-stdlib.md

@@ -76,6 +76,7 @@ title: Bake standard library functions
 | `replace`                | Replaces all instances of the given substring in the given string with the given replacement string.                                                                                                         |
 | `reverse`                | Returns the given string with all of its Unicode characters in reverse order.                                                                                                                                |
 | `reverselist`            | Returns the given list with its elements in reverse order.                                                                                                                                                   |
+| `rfc3339parse`           | Given an RFC3339 timestamp string, will parse and return an object representation of that date and time.                                                                                                     |
 | `rsadecrypt`             | Decrypts an RSA-encrypted ciphertext.                                                                                                                                                                        |
 | `sanitize`               | Replaces all non-alphanumeric characters with a underscore, leaving only characters that are valid for a Bake target name.                                                                                   |
 | `sethaselement`          | Returns true if the given set contains the given element, or false otherwise.                                                                                                                                |