Merge pull request edgexfoundry#3056 from weichou1229/issue-2988

fix(meta): Check the associated object existence when delete Profile
jim-wang-intel · Jan 21, 2021 · 4ca1de5 · 4ca1de5
2 parents abd2591 + 0e0a70a
commit 4ca1de5
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 7 deletions.
diff --git a/internal/core/metadata/v2/application/deviceprofile.go b/internal/core/metadata/v2/application/deviceprofile.go
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020 IOTech Ltd
+// Copyright (C) 2020-2021 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -79,7 +79,24 @@ func DeleteDeviceProfileByName(name string, ctx context.Context, dic *di.Contain
 		return errors.NewCommonEdgeX(errors.KindContractInvalid, "name is empty", nil)
 	}
 	dbClient := v2MetadataContainer.DBClientFrom(dic.Get)
-	err := dbClient.DeleteDeviceProfileByName(name)
+
+	// Check the associated Device and ProvisionWatcher existence
+	devices, err := dbClient.DevicesByProfileName(0, 1, name)
+	if err != nil {
+		return errors.NewCommonEdgeXWrapper(err)
+	}
+	if len(devices) > 0 {
+		return errors.NewCommonEdgeX(errors.KindContractInvalid, "fail to delete the device profile when associated device exists", nil)
+	}
+	provisionWatchers, err := dbClient.ProvisionWatchersByProfileName(0, 1, name)
+	if err != nil {
+		return errors.NewCommonEdgeXWrapper(err)
+	}
+	if len(provisionWatchers) > 0 {
+		return errors.NewCommonEdgeX(errors.KindContractInvalid, "fail to delete the device profile when associated provisionWatcher exists", nil)
+	}
+
+	err = dbClient.DeleteDeviceProfileByName(name)
 	if err != nil {
 		return errors.NewCommonEdgeXWrapper(err)
 	}

diff --git a/internal/core/metadata/v2/application/deviceservice.go b/internal/core/metadata/v2/application/deviceservice.go
@@ -104,14 +104,22 @@ func DeleteDeviceServiceByName(name string, ctx context.Context, dic *di.Contain
 	}
 	dbClient := v2MetadataContainer.DBClientFrom(dic.Get)
 
-	// Check the associated Device existence
+	// Check the associated Device and ProvisionWatcher existence
 	devices, err := dbClient.DevicesByServiceName(0, 1, name)
 	if err != nil {
 		return errors.NewCommonEdgeXWrapper(err)
 	}
 	if len(devices) > 0 {
 		return errors.NewCommonEdgeX(errors.KindContractInvalid, "fail to delete the device service when associated device exists", nil)
 	}
+	provisionWatchers, err := dbClient.ProvisionWatchersByServiceName(0, 1, name)
+	if err != nil {
+		return errors.NewCommonEdgeXWrapper(err)
+	}
+	if len(provisionWatchers) > 0 {
+		return errors.NewCommonEdgeX(errors.KindContractInvalid, "fail to delete the device service when associated provisionWatcher exists", nil)
+	}
+
 	err = dbClient.DeleteDeviceServiceByName(name)
 	if err != nil {
 		return errors.NewCommonEdgeXWrapper(err)

diff --git a/internal/core/metadata/v2/controller/http/deviceprofile_test.go b/internal/core/metadata/v2/controller/http/deviceprofile_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020 IOTech Ltd
+// Copyright (C) 2020-2021 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -805,11 +805,20 @@ func TestDeleteDeviceProfileByName(t *testing.T) {
 	deviceProfile := dtos.ToDeviceProfileModel(buildTestDeviceProfileRequest().Profile)
 	noName := ""
 	notFoundName := "notFoundName"
+	deviceExists := "deviceExists"
+	provisionWatcherExists := "provisionWatcherExists"
 
 	dic := mockDic()
 	dbClientMock := &dbMock.DBClient{}
+	dbClientMock.On("DevicesByProfileName", 0, 1, deviceProfile.Name).Return([]models.Device{}, nil)
+	dbClientMock.On("ProvisionWatchersByProfileName", 0, 1, deviceProfile.Name).Return([]models.ProvisionWatcher{}, nil)
 	dbClientMock.On("DeleteDeviceProfileByName", deviceProfile.Name).Return(nil)
+	dbClientMock.On("DevicesByProfileName", 0, 1, notFoundName).Return([]models.Device{}, nil)
+	dbClientMock.On("ProvisionWatchersByProfileName", 0, 1, notFoundName).Return([]models.ProvisionWatcher{}, nil)
 	dbClientMock.On("DeleteDeviceProfileByName", notFoundName).Return(errors.NewCommonEdgeX(errors.KindEntityDoesNotExist, "device profile doesn't exist in the database", nil))
+	dbClientMock.On("DevicesByProfileName", 0, 1, deviceExists).Return([]models.Device{models.Device{}}, nil)
+	dbClientMock.On("DevicesByProfileName", 0, 1, provisionWatcherExists).Return([]models.Device{}, nil)
+	dbClientMock.On("ProvisionWatchersByProfileName", 0, 1, provisionWatcherExists).Return([]models.ProvisionWatcher{models.ProvisionWatcher{}}, nil)
 	dic.Update(di.ServiceConstructorMap{
 		v2MetadataContainer.DBClientInterfaceName: func(get di.Get) interface{} {
 			return dbClientMock
@@ -828,6 +837,8 @@ func TestDeleteDeviceProfileByName(t *testing.T) {
 		{"Valid - delete device profile by name", deviceProfile.Name, false, http.StatusOK},
 		{"Invalid - name parameter is empty", noName, true, http.StatusBadRequest},
 		{"Invalid - device profile not found by name", notFoundName, true, http.StatusNotFound},
+		{"Invalid - associated device exists", deviceExists, true, http.StatusBadRequest},
+		{"Invalid - associated provisionWatcher Exists", provisionWatcherExists, true, http.StatusBadRequest},
 	}
 	for _, testCase := range tests {
 		t.Run(testCase.name, func(t *testing.T) {

diff --git a/internal/core/metadata/v2/controller/http/deviceservice_test.go b/internal/core/metadata/v2/controller/http/deviceservice_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020 IOTech Ltd
+// Copyright (C) 2020-2021 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -467,14 +467,19 @@ func TestDeleteDeviceServiceByName(t *testing.T) {
 	noName := ""
 	notFoundName := "notFoundName"
 	deviceExists := "deviceExists"
+	provisionWatcherExists := "provisionWatcherExists"
 
 	dic := mockDic()
 	dbClientMock := &dbMock.DBClient{}
-	dbClientMock.On("DeleteDeviceServiceByName", deviceService.Name).Return(nil)
 	dbClientMock.On("DevicesByServiceName", 0, 1, deviceService.Name).Return([]models.Device{}, nil)
-	dbClientMock.On("DeleteDeviceServiceByName", notFoundName).Return(errors.NewCommonEdgeX(errors.KindEntityDoesNotExist, "device service doesn't exist in the database", nil))
+	dbClientMock.On("ProvisionWatchersByServiceName", 0, 1, deviceService.Name).Return([]models.ProvisionWatcher{}, nil)
+	dbClientMock.On("DeleteDeviceServiceByName", deviceService.Name).Return(nil)
 	dbClientMock.On("DevicesByServiceName", 0, 1, notFoundName).Return([]models.Device{}, nil)
+	dbClientMock.On("ProvisionWatchersByServiceName", 0, 1, notFoundName).Return([]models.ProvisionWatcher{}, nil)
+	dbClientMock.On("DeleteDeviceServiceByName", notFoundName).Return(errors.NewCommonEdgeX(errors.KindEntityDoesNotExist, "device service doesn't exist in the database", nil))
 	dbClientMock.On("DevicesByServiceName", 0, 1, deviceExists).Return([]models.Device{models.Device{}}, nil)
+	dbClientMock.On("DevicesByServiceName", 0, 1, provisionWatcherExists).Return([]models.Device{}, nil)
+	dbClientMock.On("ProvisionWatchersByServiceName", 0, 1, provisionWatcherExists).Return([]models.ProvisionWatcher{models.ProvisionWatcher{}}, nil)
 	dic.Update(di.ServiceConstructorMap{
 		v2MetadataContainer.DBClientInterfaceName: func(get di.Get) interface{} {
 			return dbClientMock
@@ -494,6 +499,7 @@ func TestDeleteDeviceServiceByName(t *testing.T) {
 		{"Invalid - name parameter is empty", noName, true, http.StatusBadRequest},
 		{"Invalid - device service not found by name", notFoundName, true, http.StatusNotFound},
 		{"Invalid - associated device exists", deviceExists, true, http.StatusBadRequest},
+		{"Invalid - associated provisionWatcher Exists", provisionWatcherExists, true, http.StatusBadRequest},
 	}
 	for _, testCase := range tests {
 		t.Run(testCase.name, func(t *testing.T) {