Skip to content

refactor: readdirplus test package migration [GKE-GCSFuse Test migration] #3891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
+202 −88
Open

refactor: readdirplus test package migration [GKE-GCSFuse Test migration] #3891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
017949d
test-migration of readdirplus
PranjalC100 Oct 14, 2025
a4a4910
small correction of tests
PranjalC100 Oct 23, 2025
6e3bea6
nit
PranjalC100 Oct 23, 2025
741ec92
Merge branch 'master' into test-migration-readdirplus
PranjalC100 Oct 23, 2025
9d2c92c
eliminating race condtion using 2 diff tests
PranjalC100 Oct 23, 2025
1c983a4
testing with only readdirplus
PranjalC100 Oct 23, 2025
f3e36b1
Update improved_run_e2e_tests.sh
PranjalC100 Oct 23, 2025
67bdffc
Merge branch 'master' into test-migration-readdirplus
PranjalC100 Oct 23, 2025
225ee3e
readdirplus comments resolve
PranjalC100 Nov 3, 2025
8d34fc5
log file path updates
PranjalC100 Nov 5, 2025
8430577
Merge branch 'master' into test-migration-readdirplus
PranjalC100 Nov 6, 2025
30c0332
gke mounted existing tests compatible
PranjalC100 Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 42 additions & 27 deletions tools/integration_tests/readdirplus/readdirplus_with_dentry_cache_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// 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
// 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,
Expand All @@ -15,12 +15,15 @@
package readdirplus

import (
"context"
"log"
"os"
"path"
"testing"
"time"

"cloud.google.com/go/storage"
"github.com/googlecloudplatform/gcsfuse/v3/tools/integration_tests/util/client"
"github.com/googlecloudplatform/gcsfuse/v3/tools/integration_tests/util/operations"
"github.com/googlecloudplatform/gcsfuse/v3/tools/integration_tests/util/setup"
"github.com/jacobsa/fuse/fusetesting"
Expand All @@ -29,30 +32,39 @@ import (
"github.com/stretchr/testify/suite"
)

type readdirplusWithDentryCacheTest struct {
flags []string
type ReaddirplusWithDentryCacheTest struct {
flags []string
storageClient *storage.Client
ctx context.Context
baseTestName string
suite.Suite
}

func (s *readdirplusWithDentryCacheTest) SetupTest() {
mountGCSFuseAndSetupTestDir(s.flags, testDirName)
func (s *ReaddirplusWithDentryCacheTest) SetupTest() {
testEnv.testDirPath = client.SetupTestDirectory(s.ctx, s.storageClient, path.Join(testDirName, s.T().Name()))
}

func (s *readdirplusWithDentryCacheTest) TearDownTest() {
if setup.MountedDirectory() == "" { // Only unmount if not using a pre-mounted directory
setup.CleanupDirectoryOnGCS(ctx, storageClient, path.Join(setup.TestBucket(), testDirName))
setup.UnmountGCSFuseAndDeleteLogFile(rootDir)
}
func (s *ReaddirplusWithDentryCacheTest) TearDownTest() {
setup.SaveGCSFuseLogFileInCaseOfFailure(s.T())
}

func (s *ReaddirplusWithDentryCacheTest) TearDownSuite() {
setup.UnmountGCSFuseWithConfig(testEnv.cfg)
}

func (s *ReaddirplusWithDentryCacheTest) SetupSuite() {
setupLogFilePath(s.baseTestName)
mountGCSFuseAndSetupTestDir(s.flags, s.ctx, s.storageClient)
}

func (s *readdirplusWithDentryCacheTest) TestReaddirplusWithDentryCache() {
// Create directory structure
// testBucket/target_dir/ -- Dir
// testBucket/target_dir/file -- File
// testBucket/target_dir/emptySubDirectory -- Dir
// testBucket/target_dir/subDirectory -- Dir
// testBucket/target_dir/subDirectory/file1 -- File
targetDir := path.Join(testDirPath, targetDirName)
func (s *ReaddirplusWithDentryCacheTest) TestReaddirplusWithDentryCache() {
// Create directory structure:
// testBucket/dirForReaddirplusTest/target_dir/
// testBucket/dirForReaddirplusTest/target_dir/file
// testBucket/dirForReaddirplusTest/target_dir/emptySubDirectory/
// testBucket/dirForReaddirplusTest/target_dir/subDirectory/
// testBucket/dirForReaddirplusTest/target_dir/subDirectory/file1
targetDir := path.Join(testEnv.testDirPath, targetDirName)
operations.CreateDirectory(targetDir, s.T())
// Create a file in the target directory.
f1 := operations.CreateFile(path.Join(targetDir, "file"), setup.FilePermission_0600, s.T())
Expand All @@ -68,6 +80,7 @@ func (s *readdirplusWithDentryCacheTest) TestReaddirplusWithDentryCache() {
endTime := time.Now()

require.NoError(s.T(), err, "ReadDirPlusPicky failed")
// Verify the entries.
expectedEntries := []struct {
name string
isDir bool
Expand All @@ -77,31 +90,33 @@ func (s *readdirplusWithDentryCacheTest) TestReaddirplusWithDentryCache() {
{name: "file", isDir: false, mode: 0644},
{name: "subDirectory", isDir: true, mode: os.ModeDir | 0755},
}
// Verify the entries.
assert.Equal(s.T(), len(expectedEntries), len(entries), "Number of entries mismatch")
for i, expected := range expectedEntries {
entry := entries[i]
assert.Equal(s.T(), expected.name, entry.Name(), "Name mismatch for entry %d", i)
assert.Equal(s.T(), expected.isDir, entry.IsDir(), "IsDir mismatch for entry %s", entry.Name())
assert.Equal(s.T(), expected.mode, entry.Mode(), "Mode mismatch for entry %s", entry.Name())
}

// Dentry cache is enabled, so LookUpInode should also not be called.
// This applies even to the parent directory, as its inode is cached during
// the test setup phase when the directory structure is created.
validateLogsForReaddirplus(s.T(), setup.LogFile(), true, startTime, endTime)
validateLogsForReaddirplus(s.T(), testEnv.cfg.LogFile, true, startTime, endTime)
}

func TestReaddirplusWithDentryCacheTest(t *testing.T) {
ts := &readdirplusWithDentryCacheTest{}
ts := &ReaddirplusWithDentryCacheTest{ctx: context.Background(), storageClient: testEnv.storageClient, baseTestName: t.Name()}

// Run tests for mounted directory if the flag is set.
if setup.AreBothMountedDirectoryAndTestBucketFlagsSet() {
// Run tests for mounted directory if the flag is set. This assumes that run flag is properly passed by GKE team as per the config.
if testEnv.cfg.GKEMountedDirectory != "" && testEnv.cfg.TestBucket != "" {
suite.Run(t, ts)
return
}

// Setup flags and run tests.
ts.flags = []string{"--implicit-dirs", "--experimental-enable-readdirplus", "--experimental-enable-dentry-cache"}
log.Printf("Running tests with flags: %s", ts.flags)
suite.Run(t, ts)
// Run tests for GCE environment otherwise.
flagsSet := setup.BuildFlagSets(*testEnv.cfg, testEnv.bucketType, t.Name())
for _, ts.flags = range flagsSet {
log.Printf("Running tests with flags: %s", ts.flags)
suite.Run(t, ts)
}
}
70 changes: 42 additions & 28 deletions tools/integration_tests/readdirplus/readdirplus_without_dentry_cache_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// 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
// 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,
Expand All @@ -15,12 +15,15 @@
package readdirplus

import (
"context"
"log"
"os"
"path"
"testing"
"time"

"cloud.google.com/go/storage"
"github.com/googlecloudplatform/gcsfuse/v3/tools/integration_tests/util/client"
"github.com/googlecloudplatform/gcsfuse/v3/tools/integration_tests/util/operations"
"github.com/googlecloudplatform/gcsfuse/v3/tools/integration_tests/util/setup"
"github.com/jacobsa/fuse/fusetesting"
Expand All @@ -29,30 +32,39 @@ import (
"github.com/stretchr/testify/suite"
)

type readdirplusWithoutDentryCacheTest struct {
flags []string
type ReaddirplusWithoutDentryCacheTest struct {
flags []string
storageClient *storage.Client
ctx context.Context
baseTestName string
suite.Suite
}

func (s *readdirplusWithoutDentryCacheTest) SetupTest() {
mountGCSFuseAndSetupTestDir(s.flags, testDirName)
func (s *ReaddirplusWithoutDentryCacheTest) SetupTest() {
testEnv.testDirPath = client.SetupTestDirectory(s.ctx, s.storageClient, path.Join(testDirName, s.T().Name()))
}

func (s *readdirplusWithoutDentryCacheTest) TearDownTest() {
if setup.MountedDirectory() == "" { // Only unmount if not using a pre-mounted directory
setup.CleanupDirectoryOnGCS(ctx, storageClient, path.Join(setup.TestBucket(), testDirName))
setup.UnmountGCSFuseAndDeleteLogFile(rootDir)
}
func (s *ReaddirplusWithoutDentryCacheTest) TearDownTest() {
setup.SaveGCSFuseLogFileInCaseOfFailure(s.T())
}

func (s *ReaddirplusWithoutDentryCacheTest) TearDownSuite() {
setup.UnmountGCSFuseWithConfig(testEnv.cfg)
}

func (s *readdirplusWithoutDentryCacheTest) TestReaddirplusWithoutDentryCache() {
// Create directory structure
// testBucket/target_dir/ -- Dir
// testBucket/target_dir/file -- File
// testBucket/target_dir/emptySubDirectory -- Dir
// testBucket/target_dir/subDirectory -- Dir
// testBucket/target_dir/subDirectory/file1 -- File
targetDir := path.Join(testDirPath, targetDirName)
func (s *ReaddirplusWithoutDentryCacheTest) SetupSuite() {
setupLogFilePath(s.baseTestName)
mountGCSFuseAndSetupTestDir(s.flags, s.ctx, s.storageClient)
}

func (s *ReaddirplusWithoutDentryCacheTest) TestReaddirplusWithoutDentryCache() {
// Create directory structure:
// testBucket/dirForReaddirplusTest/target_dir/
// testBucket/dirForReaddirplusTest/target_dir/file
// testBucket/dirForReaddirplusTest/target_dir/emptySubDirectory/
// testBucket/dirForReaddirplusTest/target_dir/subDirectory/
// testBucket/dirForReaddirplusTest/target_dir/subDirectory/file1
targetDir := path.Join(testEnv.testDirPath, targetDirName)
operations.CreateDirectory(targetDir, s.T())
// Create a file in the target directory.
f1 := operations.CreateFile(path.Join(targetDir, "file"), setup.FilePermission_0600, s.T())
Expand All @@ -68,6 +80,7 @@ func (s *readdirplusWithoutDentryCacheTest) TestReaddirplusWithoutDentryCache()
endTime := time.Now()

require.NoError(s.T(), err, "ReadDirPlusPicky failed")
// Verify the entries.
expectedEntries := []struct {
name string
isDir bool
Expand All @@ -77,31 +90,32 @@ func (s *readdirplusWithoutDentryCacheTest) TestReaddirplusWithoutDentryCache()
{name: "file", isDir: false, mode: 0644},
{name: "subDirectory", isDir: true, mode: os.ModeDir | 0755},
}
// Verify the entries.
assert.Equal(s.T(), len(expectedEntries), len(entries), "Number of entries mismatch")
for i, expected := range expectedEntries {
entry := entries[i]
assert.Equal(s.T(), expected.name, entry.Name(), "Name mismatch for entry %d", i)
assert.Equal(s.T(), expected.isDir, entry.IsDir(), "IsDir mismatch for entry %s", entry.Name())
assert.Equal(s.T(), expected.mode, entry.Mode(), "Mode mismatch for entry %s", entry.Name())
}

// Validate logs to check that ReadDirPlus was called and ReadDir was not.
// Dentry cache is not enabled, so LookUpInode should be called for
// parent directory as well as for all the entries.
validateLogsForReaddirplus(s.T(), setup.LogFile(), false, startTime, endTime)
validateLogsForReaddirplus(s.T(), testEnv.cfg.LogFile, false, startTime, endTime)
}

func TestReaddirplusWithoutDentryCacheTest(t *testing.T) {
ts := &readdirplusWithoutDentryCacheTest{}
ts := &ReaddirplusWithoutDentryCacheTest{ctx: context.Background(), storageClient: testEnv.storageClient, baseTestName: t.Name()}

// Run tests for mounted directory if the flag is set.
if setup.AreBothMountedDirectoryAndTestBucketFlagsSet() {
// Run tests for mounted directory if the flag is set. This assumes that run flag is properly passed by GKE team as per the config.
if testEnv.cfg.GKEMountedDirectory != "" && testEnv.cfg.TestBucket != "" {
suite.Run(t, ts)
return
}

// Run tests.
ts.flags = []string{"--implicit-dirs", "--experimental-enable-readdirplus"}
log.Printf("Running tests with flags: %s", ts.flags)
suite.Run(t, ts)
// Run tests for GCE environment otherwise.
flagsSet := setup.BuildFlagSets(*testEnv.cfg, testEnv.bucketType, t.Name())
for _, ts.flags = range flagsSet {
log.Printf("Running tests with flags: %s", ts.flags)
suite.Run(t, ts)
}
}
Loading
Loading