fix(storage): add object validation case and test (#9521)

tritone · BrennaEpp · web-flow · commit 386bef319b46 · 2024-03-07T17:00:14.000-08:00
* fix(storage): add object validation case and test

Per GCS docs, . and .. are invalid object names.

* fix error msg

* use quote in error

---------

Co-authored-by: Brenna N Epp &lt;brennae@google.com&gt;
diff --git a/storage/storage.go b/storage/storage.go
@@ -1096,6 +1096,10 @@ func (o *ObjectHandle) validate() error {
 	if !utf8.ValidString(o.object) {
 		return fmt.Errorf("storage: object name %q is not valid UTF-8", o.object)
 	}
+	// Names . and .. are not valid; see https://cloud.google.com/storage/docs/objects#naming
+	if o.object == "." || o.object == ".." {
+		return fmt.Errorf("storage: object name %q is not valid", o.object)
+	}
 	return nil
 }
 
diff --git a/storage/storage_test.go b/storage/storage_test.go
@@ -2424,6 +2424,57 @@ func TestParseProjectNumber(t *testing.T) {
 	}
 }
 
+func TestObjectValidate(t *testing.T) {
+	for _, c := range []struct {
+		name        string
+		bucket      string
+		object      string
+		wantSuccess bool
+	}{
+		{
+			name:        "valid object",
+			bucket:      "my-bucket",
+			object:      "my-object",
+			wantSuccess: true,
+		},
+		{
+			name:        "empty bucket name",
+			bucket:      "",
+			object:      "my-object",
+			wantSuccess: false,
+		},
+		{
+			name:        "empty object name",
+			bucket:      "my-bucket",
+			object:      "",
+			wantSuccess: false,
+		},
+		{
+			name:        "invalid utf-8",
+			bucket:      "my-bucket",
+			object:      "\xc3\x28",
+			wantSuccess: false,
+		},
+		{
+			name:        "object name .",
+			bucket:      "my-bucket",
+			object:      ".",
+			wantSuccess: false,
+		},
+	} {
+		t.Run(c.name, func(r *testing.T) {
+			b := &BucketHandle{name: c.bucket}
+			err := b.Object(c.object).validate()
+			if c.wantSuccess && err != nil {
+				r.Errorf("want success, got error %v", err)
+			}
+			if !c.wantSuccess && err == nil {
+				r.Errorf("want error, got nil")
+			}
+		})
+	}
+}
+
 // isZeroValue reports whether v is the zero value for its type
 // It errors if the argument is unknown
 func isZeroValue(v reflect.Value) (bool, error) {

Original file line number	Diff line number	Diff line change
`@@ -1096,6 +1096,10 @@ func (o *ObjectHandle) validate() error {`
`1096`	`1096`	`if !utf8.ValidString(o.object) {`
`1097`	`1097`	`return fmt.Errorf("storage: object name %q is not valid UTF-8", o.object)`
`1098`	`1098`	`}`
	`1099`	`+ // Names . and .. are not valid; see https://cloud.google.com/storage/docs/objects#naming`
	`1100`	`+ if o.object == "." \|\| o.object == ".." {`
	`1101`	`+ return fmt.Errorf("storage: object name %q is not valid", o.object)`
	`1102`	`+ }`
`1099`	`1103`	`return nil`
`1100`	`1104`	`}`
`1101`	`1105`