Merge pull request #2938 from GoogleCloudPlatform/streaming-writes-it

Add Symlink/ReadFile tests for streaming writes scenario and run CommonLocalFileTestSuite from Streaming writes package.

tools/integration_tests/local_file/create_file_test.go → tools/integration_tests/local_file/create_file.go

@@ -13,25 +13,16 @@
 // limitations under the License.
 
 // Provides integration tests for create local file.
-package local_file_test
+package local_file
 
 import (
 	"path"
 
 	. "github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/client"
 	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/operations"
 	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/setup"
-	"github.com/stretchr/testify/suite"
 )
 
-// //////////////////////////////////////////////////////////////////////
-// Boilerplate
-// //////////////////////////////////////////////////////////////////////
-
-type CommonLocalFileTestSuite struct {
-	suite.Suite
-}
-
 ////////////////////////////////////////////////////////////////////////
 // Tests
 ////////////////////////////////////////////////////////////////////////

tools/integration_tests/local_file/local_file_helper.go

@@ -0,0 +1,80 @@
+// Copyright 2025 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 local_file
+
+import (
+	"context"
+	"os"
+	"testing"
+
+	"cloud.google.com/go/storage"
+	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/client"
+	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/operations"
+)
+
+const (
+	onlyDirMounted       = "OnlyDirMountLocalFiles"
+	testDirLocalFileTest = "LocalFileTest"
+)
+
+var (
+	testDirName   string
+	testDirPath   string
+	storageClient *storage.Client
+	ctx           context.Context
+)
+
+////////////////////////////////////////////////////////////////////////
+// Helpers
+////////////////////////////////////////////////////////////////////////
+
+func WritingToLocalFileShouldNotWriteToGCS(ctx context.Context, storageClient *storage.Client,
+	fh *os.File, testDirName, fileName string, t *testing.T) {
+	operations.WriteWithoutClose(fh, client.FileContents, t)
+	client.ValidateObjectNotFoundErrOnGCS(ctx, storageClient, testDirName, fileName, t)
+}
+
+func NewFileShouldGetSyncedToGCSAtClose(ctx context.Context, storageClient *storage.Client,
+	testDirPath, fileName string, t *testing.T) {
+	// Create a local file.
+	_, fh := client.CreateLocalFileInTestDir(ctx, storageClient, testDirPath, fileName, t)
+
+	// Writing contents to local file shouldn't create file on GCS.
+	testDirName := client.GetDirName(testDirPath)
+	WritingToLocalFileShouldNotWriteToGCS(ctx, storageClient, fh, testDirName, fileName, t)
+
+	// Close the file and validate if the file is created on GCS.
+	client.CloseFileAndValidateContentFromGCS(ctx, storageClient, fh, testDirName, fileName, client.FileContents, t)
+}
+
+// Following setters are required to setup ctx, storageClient, testDirName for the local file tests
+// getting executed from different package.
+func SetCtx(otherCtx context.Context) {
+	if ctx == nil {
+		ctx = otherCtx
+	}
+}
+
+func SetStorageClient(otherStorageClient *storage.Client) {
+	if storageClient == nil {
+		storageClient = otherStorageClient
+	}
+}
+
+func SetTestDirName(otherTestDirName string) {
+	if testDirName == "" {
+		testDirName = otherTestDirName
+	}
+}

tools/integration_tests/local_file/local_file_test_suite_test.go → tools/integration_tests/local_file/local_file_suite.go

@@ -12,13 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Provides integration tests for create local file.
-
-package local_file_test
+package local_file
 
 import (
-	"testing"
-
+	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/test_suite"
 	"github.com/stretchr/testify/suite"
 )
 
@@ -28,12 +25,9 @@ import (
 
 type localFileTestSuite struct {
 	CommonLocalFileTestSuite
+	suite.Suite
 }
 
-////////////////////////////////////////////////////////////////////////
-// Tests
-////////////////////////////////////////////////////////////////////////
-
-func TestLocalFileTestSuite(t *testing.T) {
-	suite.Run(t, new(localFileTestSuite))
+type CommonLocalFileTestSuite struct {
+	test_suite.TestifySuite
 }

tools/integration_tests/local_file/read_dir_test.go → tools/integration_tests/local_file/read_dir.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 // Provides integration tests for readDir call containing local files.
-package local_file_test
+package local_file
 
 import (
 	"io/fs"

tools/integration_tests/local_file/read_file_test.go → tools/integration_tests/local_file/read_file.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 // Provides integration tests for read operation on local files.
-package local_file_test
+package local_file
 
 import (
 	. "github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/client"

tools/integration_tests/local_file/remove_dir_test.go → tools/integration_tests/local_file/remove_dir.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 //
 // Provides integration tests for removeDir operation on directories containing local files.
-package local_file_test
+package local_file
 
 import (
 	"path"

tools/integration_tests/local_file/rename_test.go → tools/integration_tests/local_file/rename.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 // Provides integration tests for rename operation on local files.
-package local_file_test
+package local_file
 
 import (
 	"os"

tools/integration_tests/local_file/local_file_test.go → tools/integration_tests/local_file/setup_test.go

@@ -14,7 +14,7 @@
 
 // Provides integration tests for file and directory operations.
 
-package local_file_test
+package local_file
 
 import (
 	"context"
@@ -23,49 +23,14 @@ import (
 	"path"
 	"testing"
 
-	"cloud.google.com/go/storage"
 	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/client"
 	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/mounting/dynamic_mounting"
 	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/mounting/only_dir_mounting"
 	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/mounting/static_mounting"
-	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/operations"
 	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/setup"
+	"github.com/stretchr/testify/suite"
 )
 
-const (
-	testDirName    = "LocalFileTest"
-	onlyDirMounted = "OnlyDirMountLocalFiles"
-)
-
-var (
-	testDirPath   string
-	storageClient *storage.Client
-	ctx           context.Context
-)
-
-////////////////////////////////////////////////////////////////////////
-// Helpers
-////////////////////////////////////////////////////////////////////////
-
-func WritingToLocalFileShouldNotWriteToGCS(ctx context.Context, storageClient *storage.Client,
-	fh *os.File, testDirName, fileName string, t *testing.T) {
-	operations.WriteWithoutClose(fh, client.FileContents, t)
-	client.ValidateObjectNotFoundErrOnGCS(ctx, storageClient, testDirName, fileName, t)
-}
-
-func NewFileShouldGetSyncedToGCSAtClose(ctx context.Context, storageClient *storage.Client,
-	testDirPath, fileName string, t *testing.T) {
-	// Create a local file.
-	_, fh := client.CreateLocalFileInTestDir(ctx, storageClient, testDirPath, fileName, t)
-
-	// Writing contents to local file shouldn't create file on GCS.
-	testDirName := client.GetDirName(testDirPath)
-	WritingToLocalFileShouldNotWriteToGCS(ctx, storageClient, fh, testDirName, fileName, t)
-
-	// Close the file and validate if the file is created on GCS.
-	client.CloseFileAndValidateContentFromGCS(ctx, storageClient, fh, testDirName, fileName, client.FileContents, t)
-}
-
 ////////////////////////////////////////////////////////////////////////
 // TestMain
 ////////////////////////////////////////////////////////////////////////
@@ -75,6 +40,9 @@ func TestMain(m *testing.M) {
 
 	setup.ExitWithFailureIfBothTestBucketAndMountedDirectoryFlagsAreNotSet()
 
+	// set the test dir to local file test
+	testDirName = testDirLocalFileTest
+
 	// Create storage client before running tests.
 	ctx = context.Background()
 	closeStorageClient := client.CreateStorageClientWithCancel(&ctx, &storageClient)
@@ -125,3 +93,9 @@ func TestMain(m *testing.M) {
 	setup.CleanupDirectoryOnGCS(ctx, storageClient, path.Join(setup.TestBucket(), testDirName))
 	os.Exit(successCode)
 }
+
+func TestLocalFileTestSuite(t *testing.T) {
+	s := new(localFileTestSuite)
+	s.CommonLocalFileTestSuite.TestifySuite = &s.Suite
+	suite.Run(t, s)
+}

tools/integration_tests/local_file/stat_file_test.go → tools/integration_tests/local_file/stat_file.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 // Provides integration tests for stat operation on local files.
-package local_file_test
+package local_file
 
 import (
 	"os"

tools/integration_tests/local_file/sym_link_test.go → tools/integration_tests/local_file/sym_link.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 //
 // Provides integration tests for symlink operation on local files.
-package local_file_test
+package local_file
 
 import (
 	"os"

tools/integration_tests/local_file/unlinked_file_test.go → tools/integration_tests/local_file/unlinked_file.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 // Provides integration tests for operation on unlinked local files.
-package local_file_test
+package local_file
 
 import (
 	"path"

tools/integration_tests/local_file/write_file_test.go → tools/integration_tests/local_file/write_file.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 // Provides integration tests for write on local files.
-package local_file_test
+package local_file
 
 import (
 	. "github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/client"

tools/integration_tests/streaming_writes/default_mount_empty_gcs_file_test.go

@@ -26,6 +26,7 @@ import (
 
 type defaultMountEmptyGCSFile struct {
 	defaultMountCommonTest
+	suite.Suite
 }
 
 func (t *defaultMountEmptyGCSFile) SetupTest() {
@@ -47,5 +48,7 @@ func (t *defaultMountEmptyGCSFile) createEmptyGCSFile() {
 
 // Executes all tests that run with single streamingWrites configuration for empty GCS Files.
 func TestDefaultMountEmptyGCSFileTest(t *testing.T) {
-	suite.Run(t, new(defaultMountEmptyGCSFile))
+	s := new(defaultMountEmptyGCSFile)
+	s.defaultMountCommonTest.TestifySuite = &s.Suite
+	suite.Run(t, s)
 }

tools/integration_tests/streaming_writes/default_mount_local_file_test.go

@@ -15,16 +15,18 @@
 package streaming_writes
 
 import (
-	"path"
 	"testing"
 
+	. "github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/local_file"
 	. "github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/client"
 	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/setup"
 	"github.com/stretchr/testify/suite"
 )
 
 type defaultMountLocalFile struct {
 	defaultMountCommonTest
+	CommonLocalFileTestSuite
+	suite.Suite
 }
 
 func (t *defaultMountLocalFile) SetupTest() {
@@ -38,11 +40,13 @@ func (t *defaultMountLocalFile) SetupSubTest() {
 func (t *defaultMountLocalFile) createLocalFile() {
 	t.fileName = FileName1 + setup.GenerateRandomString(5)
 	// Create a local file.
-	_, t.f1 = CreateLocalFileInTestDir(ctx, storageClient, testDirPath, t.fileName, t.T())
-	t.filePath = path.Join(testDirPath, t.fileName)
+	t.filePath, t.f1 = CreateLocalFileInTestDir(ctx, storageClient, testDirPath, t.fileName, t.T())
 }
 
 // Executes all tests that run with single streamingWrites configuration for localFiles.
 func TestDefaultMountLocalFileTest(t *testing.T) {
-	suite.Run(t, new(defaultMountLocalFile))
+	s := new(defaultMountLocalFile)
+	s.CommonLocalFileTestSuite.TestifySuite = &s.Suite
+	s.defaultMountCommonTest.TestifySuite = &s.Suite
+	suite.Run(t, s)
 }

tools/integration_tests/streaming_writes/default_mount_test.go

@@ -17,20 +17,26 @@ package streaming_writes
 import (
 	"os"
 
+	. "github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/local_file"
 	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/setup"
-	"github.com/stretchr/testify/suite"
+	"github.com/googlecloudplatform/gcsfuse/v2/tools/integration_tests/util/test_suite"
 )
 
 type defaultMountCommonTest struct {
 	f1       *os.File
 	fileName string
 	// filePath of the above file in the mounted directory.
 	filePath string
-	suite.Suite
+	test_suite.TestifySuite
 }
 
 func (t *defaultMountCommonTest) SetupSuite() {
-	flags := []string{"--enable-streaming-writes=true", "--write-block-size-mb=1", "--write-max-blocks-per-file=2"}
+	// TODO(mohitkyadav): Make these part of test suite after refactoring.
+	SetCtx(ctx)
+	SetStorageClient(storageClient)
+	SetTestDirName(testDirName)
+
+	flags := []string{"--rename-dir-limit=3", "--enable-streaming-writes=true", "--write-block-size-mb=1", "--write-max-blocks-per-file=2"}
 	setup.MountGCSFuseWithGivenMountFunc(flags, mountFunc)
 	testDirPath = setup.SetupTestDirectory(testDirName)
 }