Skip to content
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

Jump to bottom

fix: Check profile existence before adding device/provision watcher #4971

Merged
merged 1 commit into from
Oct 14, 2024
Merged

fix: Check profile existence before adding device/provision watcher #4971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions internal/core/metadata/application/device.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ func AddDevice(d models.Device, ctx context.Context, dic *di.Container, bypassVa
return id, errors.NewCommonEdgeX(errors.KindContractInvalid, fmt.Sprintf("device service '%s' does not exists", d.ServiceName), nil)
}

err := validateAutoEvent(dic, d)
err := validateProfileAndAutoEvent(dic, d)
if err != nil {
return "", errors.NewCommonEdgeXWrapper(err)
}
Expand Down Expand Up @@ -218,7 +218,7 @@ func PatchDevice(dto dtos.UpdateDevice, ctx context.Context, dic *di.Container,

requests.ReplaceDeviceModelFieldsWithDTO(&device, dto)

err = validateAutoEvent(dic, device)
err = validateProfileAndAutoEvent(dic, device)
if err != nil {
return errors.NewCommonEdgeXWrapper(err)
}
Expand Down Expand Up @@ -340,18 +340,18 @@ func DevicesByProfileName(offset int, limit int, profileName string, dic *di.Con

var noMessagingClientError = goErrors.New("MessageBus Client not available. Please update RequireMessageBus and MessageBus configuration to enable sending System Events via the EdgeX MessageBus")

func validateAutoEvent(dic *di.Container, d models.Device) errors.EdgeX {
if len(d.AutoEvents) == 0 {
return nil
}
func validateProfileAndAutoEvent(dic *di.Container, d models.Device) errors.EdgeX {
if d.ProfileName == "" {
// if the profile is not set, skip the validation until we have the profile
return nil
}
dbClient := container.DBClientFrom(dic.Get)
dp, err := dbClient.DeviceProfileByName(d.ProfileName)
if err != nil {
return errors.NewCommonEdgeX(errors.Kind(err), fmt.Sprintf("device profile '%s' not found during validating device '%s' auto event", d.ProfileName, d.Name), err)
return errors.NewCommonEdgeX(errors.Kind(err), fmt.Sprintf("device profile '%s' not found during validating device '%s'", d.ProfileName, d.Name), err)
}
if len(d.AutoEvents) == 0 {
return nil
}
for _, a := range d.AutoEvents {
_, err := time.ParseDuration(a.Interval)
Expand Down
19 changes: 15 additions & 4 deletions internal/core/metadata/application/device_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ import (
"github.com/edgexfoundry/go-mod-core-contracts/v3/models"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
)

func TestValidateAutoEvents(t *testing.T) {
func TestValidateProfileAndAutoEvents(t *testing.T) {
profile := "test-profile"
notFountProfileName := "notFoundProfile"
source1 := "source1"
command1 := "command1"
deviceProfile := models.DeviceProfile{
Expand All @@ -37,7 +37,8 @@ func TestValidateAutoEvents(t *testing.T) {

dic := di.NewContainer(di.ServiceConstructorMap{})
dbClientMock := &mocks.DBClient{}
dbClientMock.On("DeviceProfileByName", mock.Anything).Return(deviceProfile, nil)
dbClientMock.On("DeviceProfileByName", profile).Return(deviceProfile, nil)
dbClientMock.On("DeviceProfileByName", notFountProfileName).Return(models.DeviceProfile{}, errors.NewCommonEdgeX(errors.KindEntityDoesNotExist, "not found", nil))
dic.Update(di.ServiceConstructorMap{
container.DBClientInterfaceName: func(get di.Get) interface{} {
return dbClientMock
Expand All @@ -49,6 +50,16 @@ func TestValidateAutoEvents(t *testing.T) {
device models.Device
errorExpected bool
}{
{"empty profile",
models.Device{},
false,
},
{"not found profile",
models.Device{
ProfileName: notFountProfileName,
},
true,
},
{"no auto events",
models.Device{
ProfileName: profile,
Expand Down Expand Up @@ -99,7 +110,7 @@ func TestValidateAutoEvents(t *testing.T) {
}
for _, testCase := range tests {
t.Run(testCase.name, func(t *testing.T) {
err := validateAutoEvent(dic, testCase.device)
err := validateProfileAndAutoEvent(dic, testCase.device)
if testCase.errorExpected {
assert.Error(t, err)
} else {
Expand Down
10 changes: 10 additions & 0 deletions internal/core/metadata/application/provisionwatcher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,16 @@ func AddProvisionWatcher(pw models.ProvisionWatcher, ctx context.Context, dic *d
lc := bootstrapContainer.LoggingClientFrom(dic.Get)
correlationId := correlation.FromContext(ctx)

// check the associated ProfileName existence
if pw.DiscoveredDevice.ProfileName != "" {
exists, err := dbClient.DeviceProfileNameExists(pw.DiscoveredDevice.ProfileName)
if err != nil {
return "", errors.NewCommonEdgeXWrapper(err)
} else if !exists {
return "", errors.NewCommonEdgeX(errors.KindEntityDoesNotExist, fmt.Sprintf("device profile '%s' does not exists", pw.DiscoveredDevice.ProfileName), err)
}
}

addProvisionWatcher, err := dbClient.AddProvisionWatcher(pw)
if err != nil {
return "", errors.NewCommonEdgeXWrapper(err)
Expand Down
23 changes: 1 addition & 22 deletions internal/core/metadata/controller/http/provisionwatcher_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,6 @@ func TestProvisionWatcherController_AddProvisionWatcher_Created(t *testing.T) {
dic := mockDic()
dbClientMock := &mocks.DBClient{}
dbClientMock.On("AddProvisionWatcher", pwModel).Return(pwModel, nil)
dbClientMock.On("DeviceServiceByName", pwModel.ServiceName).Return(models.DeviceService{}, nil)
dbClientMock.On("DeviceServiceNameExists", pwModel.ServiceName).Return(true, nil)
dbClientMock.On("DeviceProfileNameExists", pwModel.DiscoveredDevice.ProfileName).Return(true, nil)
dic.Update(di.ServiceConstructorMap{
container.DBClientInterfaceName: func(get di.Get) interface{} {
Expand Down Expand Up @@ -171,25 +169,10 @@ func TestProvisionWatcherController_AddProvisionWatcher_BadRequest(t *testing.T)
noName := provisionWatcher
noName.ProvisionWatcher.Name = ""

notFountServiceName := "notFoundService"
notFoundService := provisionWatcher
notFoundService.ProvisionWatcher.ServiceName = notFountServiceName
dbClientMock.On("DeviceServiceNameExists", notFoundService.ProvisionWatcher.ServiceName).Return(false, nil)
notFountProfileName := "notFoundProfile"
notFoundProfile := provisionWatcher
notFoundProfile.ProvisionWatcher.DiscoveredDevice.ProfileName = notFountProfileName
notFoundServiceProvisionWatcherModel := requests.AddProvisionWatcherReqToProvisionWatcherModels(
[]requests.AddProvisionWatcherRequest{notFoundService})[0]
dbClientMock.On("AddProvisionWatcher", notFoundServiceProvisionWatcherModel).Return(
notFoundServiceProvisionWatcherModel,
errors.NewCommonEdgeX(errors.KindEntityDoesNotExist, fmt.Sprintf("device service '%s' does not exists",
notFountServiceName), nil))
notFoundProfileProvisionWatcherModel := requests.AddProvisionWatcherReqToProvisionWatcherModels(
[]requests.AddProvisionWatcherRequest{notFoundProfile})[0]
dbClientMock.On("AddProvisionWatcher", notFoundProfileProvisionWatcherModel).Return(
notFoundProfileProvisionWatcherModel,
errors.NewCommonEdgeX(errors.KindEntityDoesNotExist, fmt.Sprintf("device profile '%s' does not exists",
notFountProfileName), nil))
dbClientMock.On("DeviceProfileNameExists", notFountProfileName).Return(false, nil)

dic.Update(di.ServiceConstructorMap{
container.DBClientInterfaceName: func(get di.Get) interface{} {
Expand All @@ -207,7 +190,6 @@ func TestProvisionWatcherController_AddProvisionWatcher_BadRequest(t *testing.T)
}{
{"Invalid - Bad requestId", []requests.AddProvisionWatcherRequest{badRequestId}, http.StatusBadRequest, http.StatusBadRequest},
{"Invalid - Bad name", []requests.AddProvisionWatcherRequest{noName}, http.StatusBadRequest, http.StatusBadRequest},
{"Invalid - not found service", []requests.AddProvisionWatcherRequest{notFoundService}, http.StatusMultiStatus, http.StatusNotFound},
{"Invalid - not found profile", []requests.AddProvisionWatcherRequest{notFoundProfile}, http.StatusMultiStatus, http.StatusNotFound},
}
for _, testCase := range tests {
Expand Down Expand Up @@ -259,7 +241,6 @@ func TestProvisionWatcherController_AddProvisionWatcher_Duplicated(t *testing.T)
dbClientMock := &mocks.DBClient{}
dbClientMock.On("AddProvisionWatcher", duplicateNameModel).Return(duplicateNameModel, duplicateNameDBError)
dbClientMock.On("AddProvisionWatcher", duplicateIdModel).Return(duplicateIdModel, duplicateIdDBError)
dbClientMock.On("DeviceServiceNameExists", duplicateIdRequest.ProvisionWatcher.ServiceName).Return(true, nil)
dbClientMock.On("DeviceProfileNameExists", duplicateIdRequest.ProvisionWatcher.DiscoveredDevice.ProfileName).Return(true, nil)
dic.Update(di.ServiceConstructorMap{
container.DBClientInterfaceName: func(get di.Get) interface{} {
Expand Down Expand Up @@ -635,7 +616,6 @@ func TestProvisionWatcherController_DeleteProvisionWatcherByName(t *testing.T) {
dbClientMock.On("ProvisionWatcherByName", provisionWatcher.Name).Return(provisionWatcher, nil)
dbClientMock.On("ProvisionWatcherByName", notFoundName).Return(provisionWatcher, errors.NewCommonEdgeX(errors.KindEntityDoesNotExist, "provision watcher doesn't exist in the database", nil))
dbClientMock.On("DeleteProvisionWatcherByName", provisionWatcher.Name).Return(nil)
dbClientMock.On("DeviceServiceByName", provisionWatcher.ServiceName).Return(models.DeviceService{}, nil)
dic.Update(di.ServiceConstructorMap{
container.DBClientInterfaceName: func(get di.Get) interface{} {
return dbClientMock
Expand Down Expand Up @@ -712,7 +692,6 @@ func TestProvisionWatcherController_PatchProvisionWatcher(t *testing.T) {
dbClientMock.On("DeviceProfileNameExists", *valid.ProvisionWatcher.DiscoveredDevice.ProfileName).Return(true, nil)
dbClientMock.On("ProvisionWatcherByName", *valid.ProvisionWatcher.Name).Return(pwModels, nil)
dbClientMock.On("UpdateProvisionWatcher", pwModels).Return(nil)
dbClientMock.On("DeviceServiceByName", *valid.ProvisionWatcher.ServiceName).Return(models.DeviceService{}, nil)
validWithNoReqID := testReq
validWithNoReqID.RequestId = ""
validWithNoId := testReq
Expand Down
Loading