-
Notifications
You must be signed in to change notification settings - Fork 426
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[unsupported-object-issue-fix] Add utility for empty directory list i…
…ssue (#2561) * Add utilities to filter unsupported objects * [testing] shorten code in bucket-handle unit tests * s/isUnsupportedObjectName/IsUnsupportedObjectName * Remove unnecessary functions * IsUnsupportedObjectName -> storageutil package * gcs_util* to unsupported_object_util* Addresses a review comment.
- Loading branch information
1 parent
1e60635
commit 0945fae
Showing
3 changed files
with
151 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
// Copyright 2024 Google LLC | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package storageutil | ||
|
||
import ( | ||
"strings" | ||
) | ||
|
||
var ( | ||
unsupportedObjectNameSubstrings = []string{"//"} | ||
unsupportedObjectNamePrefixes = []string{"/"} | ||
unsupportedObjectNames = []string{""} | ||
) | ||
|
||
// IsUnsupportedObjectName returns true if the passed | ||
// string is a valid GCS object name or prefix, | ||
// which is unsupported in GCSFuse. | ||
func IsUnsupportedObjectName(name string) bool { | ||
for _, substring := range unsupportedObjectNameSubstrings { | ||
if strings.Contains(name, substring) { | ||
return true | ||
} | ||
} | ||
for _, prefix := range unsupportedObjectNamePrefixes { | ||
if strings.HasPrefix(name, prefix) { | ||
return true | ||
} | ||
} | ||
for _, unsupportedObjectName := range unsupportedObjectNames { | ||
if name == unsupportedObjectName { | ||
return true | ||
} | ||
} | ||
return false | ||
} |
85 changes: 85 additions & 0 deletions
85
internal/storage/storageutil/unsupported_object_util_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
// Copyright 2024 Google LLC | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package storageutil_test | ||
|
||
import ( | ||
"fmt" | ||
"testing" | ||
|
||
. "github.com/googlecloudplatform/gcsfuse/v2/internal/storage/storageutil" | ||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/suite" | ||
) | ||
|
||
//////////////////////////////////////////////////////////////////////// | ||
// Boilerplate | ||
//////////////////////////////////////////////////////////////////////// | ||
|
||
type GcsUtilTest struct { | ||
suite.Suite | ||
} | ||
|
||
func TestGcsUtil(t *testing.T) { | ||
suite.Run(t, new(GcsUtilTest)) | ||
} | ||
|
||
// ////////////////////////////////////////////////////////////////////// | ||
// Tests | ||
// ////////////////////////////////////////////////////////////////////// | ||
func (ts *GcsUtilTest) TestIsUnsupportedObjectName() { | ||
cases := []struct { | ||
name string | ||
isUnsupported bool | ||
}{ | ||
{ | ||
name: "foo", | ||
isUnsupported: false, | ||
}, | ||
{ | ||
name: "foo/bar", | ||
isUnsupported: false, | ||
}, | ||
{ | ||
name: "foo//bar", | ||
isUnsupported: true, | ||
}, | ||
{ | ||
name: "abc/", | ||
isUnsupported: false, | ||
}, | ||
{ | ||
name: "abc//", | ||
isUnsupported: true, | ||
}, | ||
{ | ||
name: "/foo", | ||
isUnsupported: true, | ||
}, | ||
{ | ||
name: "/", | ||
isUnsupported: true, | ||
}, | ||
{ | ||
name: "", | ||
isUnsupported: true, | ||
}, | ||
} | ||
|
||
for _, tc := range cases { | ||
ts.Run(fmt.Sprintf("name=%s", tc.name), func() { | ||
assert.Equal(ts.T(), tc.isUnsupported, IsUnsupportedObjectName(tc.name)) | ||
}) | ||
} | ||
} |