GCNV SAN cleanup follow-up: review nits, NAS/SAN parity, and gcp_common

Author: onkarganjewar

storage_drivers/gcp/gcp_common.go

@@ -0,0 +1,69 @@
+// Copyright 2026 NetApp, Inc. All Rights Reserved.
+
+package gcp
+
+import (
+	"fmt"
+	"regexp"
+	"strings"
+	"time"
+	"unicode"
+	"unicode/utf8"
+
+	tridentconfig "github.com/netapp/trident/config"
+	"github.com/netapp/trident/pkg/convert"
+	"github.com/netapp/trident/storage_drivers/gcp/api"
+)
+
+var (
+	// gcpLabelRegex matches characters that are not allowed in GCP label keys or values.
+	// Allowed: lowercase letters, digits, hyphens, underscores, and Unicode letters (\p{L}).
+	gcpLabelRegex = regexp.MustCompile(`[^-_a-z0-9\p{L}]`)
+)
+
+// DefaultCreateTimeout returns the volume create/delete timeout for the given driver context.
+// Docker gets more time since it has no retry mechanism; CSI uses the API default.
+func DefaultCreateTimeout(driverContext tridentconfig.DriverContext) time.Duration {
+	switch driverContext {
+	case tridentconfig.ContextDocker:
+		return tridentconfig.DockerCreateTimeout
+	default:
+		return api.VolumeCreateTimeout
+	}
+}
+
+// FixGCPLabelKey accepts a label key and modifies it to satisfy GCP label key rules, or returns
+// false if not possible.
+func FixGCPLabelKey(s string) (string, bool) {
+	if s == "" {
+		return "", false
+	}
+	s = strings.ToLower(s)
+	s = gcpLabelRegex.ReplaceAllStringFunc(s, func(m string) string {
+		return strings.Repeat("_", len(m))
+	})
+	first, _ := utf8.DecodeRuneInString(s)
+	if first == utf8.RuneError || !unicode.IsLower(first) {
+		return "", false
+	}
+	s = convert.TruncateString(s, api.MaxLabelLength)
+	return s, true
+}
+
+// FixGCPLabelValue accepts a label value and modifies it to satisfy GCP label value rules.
+func FixGCPLabelValue(s string) string {
+	if s == "" {
+		return ""
+	}
+	s = strings.ToLower(s)
+	s = gcpLabelRegex.ReplaceAllStringFunc(s, func(m string) string {
+		return strings.Repeat("_", len(m))
+	})
+	s = convert.TruncateString(s, api.MaxLabelLength)
+	return s
+}
+
+// ErrRefreshGCNVResourceCache returns a standard error when refreshing the GCNV resource cache fails.
+func ErrRefreshGCNVResourceCache(err error) error {
+	return fmt.Errorf("could not update GCNV resource cache; %w", err)
+}

storage_drivers/gcp/gcp_common_test.go

@@ -0,0 +1,103 @@
+// Copyright 2026 NetApp, Inc. All Rights Reserved.
+
+package gcp
+
+import (
+	"errors"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+
+	tridentconfig "github.com/netapp/trident/config"
+	"github.com/netapp/trident/storage_drivers/gcp/api"
+)
+
+func TestGCPCommon_DefaultCreateTimeout(t *testing.T) {
+	tests := []struct {
+		name     string
+		ctx      tridentconfig.DriverContext
+		expected time.Duration
+	}{
+		{"Docker", tridentconfig.ContextDocker, tridentconfig.DockerCreateTimeout},
+		{"CSI", tridentconfig.ContextCSI, api.VolumeCreateTimeout},
+		{"Empty", tridentconfig.DriverContext(""), api.VolumeCreateTimeout},
+		{"Unknown", tridentconfig.DriverContext("k8s"), api.VolumeCreateTimeout},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := DefaultCreateTimeout(tt.ctx)
+			assert.Equal(t, tt.expected, got)
+		})
+	}
+}
+
+func TestGCPCommon_FixGCPLabelKey(t *testing.T) {
+	tests := []struct {
+		name    string
+		in      string
+		wantOut string
+		wantOK  bool
+	}{
+		{"Empty", "", "", false},
+		{"Valid lowercase", "valid_key", "valid_key", true},
+		{"Uppercase normalized", "ValidKey", "validkey", true},
+		{"Starts with digit", "1key", "", false},
+		{"Starts with hyphen", "-key", "", false},
+		{"Disallowed chars replaced", "key.with.dots", "key_with_dots", true},
+		{"Spaces to underscores", "key with spaces", "key_with_spaces", true},
+		{"Unicode letter allowed", "këy", "këy", true},
+		{"Multibyte lowercase first rune", "émoji", "émoji", true},
+		{"Too long truncated", string(make([]byte, 70)), "", false}, // all zeros, first rune not lower
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			gotOut, gotOK := FixGCPLabelKey(tt.in)
+			assert.Equal(t, tt.wantOK, gotOK, "ok")
+			if tt.wantOK {
+				assert.Equal(t, tt.wantOut, gotOut)
+				assert.True(t, len(gotOut) <= api.MaxLabelLength, "length <= MaxLabelLength")
+			}
+		})
+	}
+	// Key that is long but valid (starts with letter) gets truncated to 63
+	longKey := "a" + string(make([]byte, api.MaxLabelLength+10))
+	out, ok := FixGCPLabelKey(longKey)
+	assert.True(t, ok)
+	assert.Equal(t, api.MaxLabelLength, len(out))
+}
+
+func TestGCPCommon_FixGCPLabelValue(t *testing.T) {
+	tests := []struct {
+		name    string
+		in      string
+		wantOut string
+	}{
+		{"Empty", "", ""},
+		{"Valid", "value-123", "value-123"},
+		{"Uppercase normalized", "Value", "value"},
+		{"Dots replaced", "v.a.l", "v_a_l"},
+		{"Spaces replaced", "a b c", "a_b_c"},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := FixGCPLabelValue(tt.in)
+			assert.Equal(t, tt.wantOut, got)
+			if len(got) > 0 {
+				assert.True(t, len(got) <= api.MaxLabelLength, "length <= MaxLabelLength")
+			}
+		})
+	}
+	// Long value truncated
+	longVal := "v" + string(make([]byte, api.MaxLabelLength+5))
+	got := FixGCPLabelValue(longVal)
+	assert.Equal(t, api.MaxLabelLength, len(got))
+}
+
+func TestGCPCommon_ErrRefreshGCNVResourceCache(t *testing.T) {
+	err := errors.New("connection refused")
+	wrapped := ErrRefreshGCNVResourceCache(err)
+	assert.Error(t, wrapped)
+	assert.Contains(t, wrapped.Error(), "could not update GCNV resource cache")
+	assert.Contains(t, wrapped.Error(), "connection refused")
+}