tests: refactor object-handler tests. (#2656)

- Move the initialization to a common executor for object Layer API
  tests.d

cmd/object-handlers_test.go

@@ -27,34 +27,12 @@ import (
 
 // Wrapper for calling GetObject API handler tests for both XL multiple disks and FS single drive setup.
 func TestAPIGetOjectHandler(t *testing.T) {
-	ExecObjectLayerTest(t, testAPIGetOjectHandler)
+	ExecObjectLayerAPITest(t, testAPIGetOjectHandler, []string{"GetObject"})
 }
 
-func testAPIGetOjectHandler(obj ObjectLayer, instanceType string, t TestErrHandler) {
+func testAPIGetOjectHandler(obj ObjectLayer, instanceType, bucketName string, apiRouter http.Handler,
-
+	credentials credential, t TestErrHandler) {
-	// get random bucket name.
-	bucketName := getRandomBucketName()
 	objectName := "test-object"
-	// Create bucket.
-	err := obj.MakeBucket(bucketName)
-	if err != nil {
-		// failed to create newbucket, abort.
-		t.Fatalf("%s : %s", instanceType, err)
-	}
-	// Register the API end points with XL/FS object layer.
-	// Registering only the GetObject handler.
-	apiRouter := initTestAPIEndPoints(obj, []string{"GetObject"})
-	// initialize the server and obtain the credentials and root.
-	// credentials are necessary to sign the HTTP request.
-	rootPath, err := newTestConfig("us-east-1")
-	if err != nil {
-		t.Fatalf("Init Test config failed")
-	}
-	// remove the root folder after the test ends.
-	defer removeAll(rootPath)
-
-	credentials := serverConfig.GetCredential()
-
 	// set of byte data for PutObject.
 	// object has to be inserted before running tests for GetObject.
 	// this is required even to assert the GetObject data,
@@ -78,7 +56,7 @@ func testAPIGetOjectHandler(obj ObjectLayer, instanceType string, t TestErrHandl
 	// iterate through the above set of inputs and upload the object.
 	for i, input := range putObjectInputs {
 		// uploading the object.
-		_, err = obj.PutObject(input.bucketName, input.objectName, input.contentLength, bytes.NewBuffer(input.textData), input.metaData)
+		_, err := obj.PutObject(input.bucketName, input.objectName, input.contentLength, bytes.NewBuffer(input.textData), input.metaData)
 		// if object upload fails stop the test.
 		if err != nil {
 			t.Fatalf("Put Object case %d:  Error uploading object: <ERROR> %v", i+1, err)
@@ -176,33 +154,13 @@ func testAPIGetOjectHandler(obj ObjectLayer, instanceType string, t TestErrHandl
 
 // Wrapper for calling PutObject API handler tests using streaming signature v4 for both XL multiple disks and FS single drive setup.
 func TestAPIPutObjectStreamSigV4Handler(t *testing.T) {
-	ExecObjectLayerTest(t, testAPIPutObjectStreamSigV4Handler)
+	ExecObjectLayerAPITest(t, testAPIPutObjectStreamSigV4Handler, []string{"PutObject"})
 }
 
-func testAPIPutObjectStreamSigV4Handler(obj ObjectLayer, instanceType string, t TestErrHandler) {
+func testAPIPutObjectStreamSigV4Handler(obj ObjectLayer, instanceType, bucketName string, apiRouter http.Handler,
-	// get random bucket name.
+	credentials credential, t TestErrHandler) {
-	bucketName := getRandomBucketName()
-	objectName := "test-object"
-	// Create bucket.
-	err := obj.MakeBucket(bucketName)
-	if err != nil {
-		// failed to create newbucket, abort.
-		t.Fatalf("%s : %s", instanceType, err)
-	}
-	// Register the API end points with XL/FS object layer.
-	// Registering only the GetObject handler.
-	apiRouter := initTestAPIEndPoints(obj, []string{"PutObject"})
-	// initialize the server and obtain the credentials and root.
-	// credentials are necessary to sign the HTTP request.
-	rootPath, err := newTestConfig("us-east-1")
-	if err != nil {
-		t.Fatalf("Init Test config failed")
-	}
-	// remove the root folder after the test ends.
-	defer removeAll(rootPath)
-
-	credentials := serverConfig.GetCredential()
 
+	objectName := "test-object"
 	bytesDataLen := 65 * 1024
 	bytesData := bytes.Repeat([]byte{'a'}, bytesDataLen)
 
@@ -271,33 +229,13 @@ func testAPIPutObjectStreamSigV4Handler(obj ObjectLayer, instanceType string, t
 
 // Wrapper for calling PutObject API handler tests for both XL multiple disks and FS single drive setup.
 func TestAPIPutObjectHandler(t *testing.T) {
-	ExecObjectLayerTest(t, testAPIPutObjectHandler)
+	ExecObjectLayerAPITest(t, testAPIPutObjectHandler, []string{"PutObject"})
 }
 
-func testAPIPutObjectHandler(obj ObjectLayer, instanceType string, t TestErrHandler) {
+func testAPIPutObjectHandler(obj ObjectLayer, instanceType, bucketName string, apiRouter http.Handler,
-	// get random bucket name.
+	credentials credential, t TestErrHandler) {
-	bucketName := getRandomBucketName()
-	objectName := "test-object"
-	// Create bucket.
-	err := obj.MakeBucket(bucketName)
-	if err != nil {
-		// failed to create newbucket, abort.
-		t.Fatalf("%s : %s", instanceType, err)
-	}
-	// Register the API end points with XL/FS object layer.
-	// Registering only the GetObject handler.
-	apiRouter := initTestAPIEndPoints(obj, []string{"PutObject"})
-	// initialize the server and obtain the credentials and root.
-	// credentials are necessary to sign the HTTP request.
-	rootPath, err := newTestConfig("us-east-1")
-	if err != nil {
-		t.Fatalf("Init Test config failed")
-	}
-	// remove the root folder after the test ends.
-	defer removeAll(rootPath)
-
-	credentials := serverConfig.GetCredential()
 
+	objectName := "test-object"
 	// byte data for PutObject.
 	bytesData := generateBytesData(6 * 1024 * 1024)
 
@@ -363,38 +301,19 @@ func testAPIPutObjectHandler(obj ObjectLayer, instanceType string, t TestErrHand
 
 // Wrapper for calling Copy Object API handler tests for both XL multiple disks and single node setup.
 func TestAPICopyObjectHandler(t *testing.T) {
-	ExecObjectLayerTest(t, testAPICopyObjectHandler)
+	ExecObjectLayerAPITest(t, testAPICopyObjectHandler, []string{"CopyObject"})
 }
 
-func testAPICopyObjectHandler(obj ObjectLayer, instanceType string, t TestErrHandler) {
+func testAPICopyObjectHandler(obj ObjectLayer, instanceType, bucketName string, apiRouter http.Handler,
-	// get random bucket name.
+	credentials credential, t TestErrHandler) {
-	bucketName := getRandomBucketName()
-	objectName := "test-object"
-	// Create bucket.
-	err := obj.MakeBucket(bucketName)
-	if err != nil {
-		// failed to create newbucket, abort.
-		t.Fatalf("%s : %s", instanceType, err)
-	}
-	// Register the API end points with XL/FS object layer.
-	// Registering only the Copy Object handler.
-	apiRouter := initTestAPIEndPoints(obj, []string{"CopyObject"})
-	// initialize the server and obtain the credentials and root.
-	// credentials are necessary to sign the HTTP request.
-	rootPath, err := newTestConfig("us-east-1")
-	if err != nil {
-		t.Fatalf("Init Test config failed")
-	}
-	// remove the root folder after the test ends.
-	defer removeAll(rootPath)
 
-	err = initEventNotifier(obj)
+	objectName := "test-object"
+	// register event notifier.
+	err := initEventNotifier(obj)
 	if err != nil {
 		t.Fatalf("Initializing event notifiers failed")
 	}
 
-	credentials := serverConfig.GetCredential()
-
 	// set of byte data for PutObject.
 	// object has to be inserted before running tests for Copy Object.
 	// this is required even to assert the copied object,

cmd/test-utils_test.go

@@ -1135,6 +1135,66 @@ func removeDiskN(disks []string, n int) {
 	}
 }
 
+// creates a bucket for the tests and returns the bucket name.
+// initializes the specified API endpoints for the tests.
+// initialies the root and returns its path.
+// return credentials.
+func initAPIHandlerTest(obj ObjectLayer, endPoints []string) (bucketName, rootPath string, apiRouter http.Handler, err error) {
+	// get random bucket name.
+	bucketName = getRandomBucketName()
+
+	// Create bucket.
+	err = obj.MakeBucket(bucketName)
+	if err != nil {
+		// failed to create newbucket, return err.
+		return "", "", nil, err
+	}
+	// Register the API end points with XL/FS object layer.
+	// Registering only the GetObject handler.
+	apiRouter = initTestAPIEndPoints(obj, endPoints)
+	// initialize the server and obtain the credentials and root.
+	// credentials are necessary to sign the HTTP request.
+	rootPath, err = newTestConfig("us-east-1")
+	if err != nil {
+		return "", "", nil, err
+	}
+
+	return bucketName, rootPath, apiRouter, nil
+}
+
+// ExecObjectLayerAPITest - executes object layer API tests.
+// Creates single node and XL ObjectLayer instance, registers the specified API end points and runs test for both the layers.
+func ExecObjectLayerAPITest(t TestErrHandler, objAPITest objAPITestType, endPoints []string) {
+	objLayer, fsDir, err := prepareFS()
+	if err != nil {
+		t.Fatalf("Initialization of object layer failed for single node setup: %s", err)
+	}
+	bucketFS, fsRoot, fsAPIRouter, err := initAPIHandlerTest(objLayer, endPoints)
+	if err != nil {
+		t.Fatalf("Initialzation of API handler tests failed: <ERROR> %s", err)
+	}
+	credentials := serverConfig.GetCredential()
+	// Executing the object layer tests for single node setup.
+	objAPITest(objLayer, singleNodeTestStr, bucketFS, fsAPIRouter, credentials, t)
+
+	objLayer, xlDisks, err := prepareXL()
+	if err != nil {
+		t.Fatalf("Initialization of object layer failed for XL setup: %s", err)
+	}
+	bucketXL, xlRoot, xlAPIRouter, err := initAPIHandlerTest(objLayer, endPoints)
+	if err != nil {
+		t.Fatalf("Initialzation of API handler tests failed: <ERROR> %s", err)
+	}
+	credentials = serverConfig.GetCredential()
+	// Executing the object layer tests for XL.
+	objAPITest(objLayer, xLTestStr, bucketXL, xlAPIRouter, credentials, t)
+	defer removeRoots(append(xlDisks, fsDir, fsRoot, xlRoot))
+}
+
+// function to be passed to ExecObjectLayerAPITest, for executing object layr API handler tests.
+type objAPITestType func(obj ObjectLayer, instanceType string, bucketName string,
+	apiRouter http.Handler, credentials credential, t TestErrHandler)
+
 // Regular object test type.
 type objTestType func(obj ObjectLayer, instanceType string, t TestErrHandler)