admin/utils.go: add helper methods for parsing and pointer handling (#269)

Co-authored-by: Sergiusz Urbaniak <[email protected]>

Author: wtrocki

admin/utils.go

@@ -49,6 +49,14 @@ func IsNil(i interface{}) bool {
 	return false
 }
 
+// SetOrNil returns the address of the given value or nil if it equals defaultValue
+func SetOrNil[T comparable](val T, defaultValue T) *T {
+	if val == defaultValue {
+		return nil
+	}
+	return &val
+}
+
 // GetOrDefault returns the value of a pointer or a default value
 func GetOrDefault[T any](ptr *T, defaultValue T) T {
 	if ptr != nil {
@@ -74,6 +82,13 @@ func TimeToString(t time.Time) string {
 	return t.UTC().Format(time.RFC3339Nano)
 }
 
+// StringToTime parses the given string and returns the resulting time.
+// The expected format is identical to the format returned by Atlas API, documented as ISO 8601 timestamp format in UTC.
+// Example formats: "2023-07-18T16:12:23Z", "2023-07-18T16:12:23.456Z"
+func StringToTime(val string) (time.Time, error) {
+	return time.Parse(time.RFC3339Nano, val)
+}
+
 // Int64PtrToIntPtr convert int64 to int pointer.
 func Int64PtrToIntPtr(i64 *int64) *int {
 	if i64 == nil {

internal/core/version.go

@@ -5,7 +5,7 @@ package core
 // For more information please see: https://github.com/mongodb/atlas-sdk-go/blob/main/docs/doc_1_concepts.md
 const (
 	// SDK release tag version.
-	Version = "v20231115005.0.0"
+	Version = "v20231115005.1.0"
 	// Resource Version.
 	Resource = "20231115"
 )

test/utils_test.go

@@ -0,0 +1,104 @@
+package test
+
+import (
+	"testing"
+	"time"
+
+	"go.mongodb.org/atlas-sdk/v20231115005/admin"
+)
+
+type testCase[T comparable] struct {
+	name         string
+	val          T
+	defaultValue T
+	wantNil      bool
+}
+
+//nolint:thelper // used to minimize duplication in test
+func assertSetOrNil[T comparable](t *testing.T, tc testCase[T]) {
+	t.Run(tc.name, func(t *testing.T) {
+		ptr := admin.SetOrNil(tc.val, tc.defaultValue)
+		if gotNil := ptr == nil; gotNil != tc.wantNil {
+			t.Errorf("got nil %t, want %t", gotNil, tc.wantNil)
+		}
+	})
+}
+
+func TestSetOrNil(t *testing.T) {
+	assertSetOrNil(t, testCase[int]{
+		name:         "non default int",
+		val:          1,
+		defaultValue: 0,
+		wantNil:      false,
+	})
+
+	assertSetOrNil(t, testCase[int]{
+		name:         "default int",
+		val:          0,
+		defaultValue: 0,
+		wantNil:      true,
+	})
+
+	assertSetOrNil(t, testCase[string]{
+		name:         "non default string",
+		val:          "hello",
+		defaultValue: "",
+		wantNil:      false,
+	})
+
+	assertSetOrNil(t, testCase[string]{
+		name:         "default string",
+		val:          "",
+		defaultValue: "",
+		wantNil:      true,
+	})
+}
+
+func TestStringToTime(t *testing.T) {
+	for _, tc := range []struct {
+		name  string
+		input string
+
+		want    time.Time
+		wantErr string
+	}{
+		{
+			name:  "valid time",
+			input: "2023-07-18T16:12:23Z",
+			want: time.Date(
+				2023, 7, 18,
+				16, 12, 23, 0,
+				time.UTC,
+			),
+		},
+		{
+			name:  "valid time with millis",
+			input: "2023-07-18T16:12:23.456Z",
+			want: time.Date(
+				2023, 7, 18,
+				16, 12, 23, 456_000_000,
+				time.UTC,
+			),
+		},
+		{
+			name:    "invalid time",
+			input:   "invalid",
+			wantErr: `parsing time "invalid" as "2006-01-02T15:04:05.999999999Z07:00": cannot parse "invalid" as "2006"`,
+		},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			gotErr := ""
+			got, err := admin.StringToTime(tc.input)
+			if err != nil {
+				gotErr = err.Error()
+			}
+
+			if gotErr != tc.wantErr {
+				t.Errorf("want error %q, got %q", tc.wantErr, gotErr)
+			}
+			if got != tc.want {
+				t.Errorf("want %v, got %v", tc.want, got)
+			}
+		})
+	}
+}

tools/config/go-templates/utils.mustache

@@ -30,7 +30,6 @@ func PtrString(v string) *string { return &v }
 // PtrTime is helper routine that returns a pointer to given Time value.
 func PtrTime(v time.Time) *time.Time { return &v }
 
-
 type modelWithMap interface {
 	ToMap() (map[string]interface{}, error)
 }
@@ -49,6 +48,14 @@ func IsNil(i interface{}) bool {
 	return false
 }
 
+// SetOrNil returns the address of the given value or nil if it equals defaultValue
+func SetOrNil[T comparable](val T, defaultValue T) *T {
+	if val == defaultValue {
+		return nil
+	}
+	return &val
+}
+
 // GetOrDefault returns the value of a pointer or a default value
 func GetOrDefault[T any](ptr *T, defaultValue T) T {
 	if ptr != nil {
@@ -74,6 +81,13 @@ func TimeToString(t time.Time) string {
 	return t.UTC().Format(time.RFC3339Nano)
 }
 
+// StringToTime parses the given string and returns the resulting time.
+// The expected format is identical to the format returned by Atlas API, documented as ISO 8601 timestamp format in UTC.
+// Example formats: "2023-07-18T16:12:23Z", "2023-07-18T16:12:23.456Z"
+func StringToTime(val string) (time.Time, error) {
+	return time.Parse(time.RFC3339Nano, val)
+}
+
 // Int64PtrToIntPtr convert int64 to int pointer.
 func Int64PtrToIntPtr(i64 *int64) *int {
 	if i64 == nil {