feat(metadata): add UoM validation to POST deviceresource API (#4140)

* feat(metadata): add UoM validation to POST deviceresource API fix #4138 Signed-off-by: Chris Hung <[email protected]> * fix(metadata): update UoM validation status code Signed-off-by: Chris Hung <[email protected]>
edgexfoundry · Sep 20, 2022 · f87a0e7 · f87a0e7
1 parent 726ff50
commit f87a0e7
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 9 deletions.
diff --git a/internal/core/metadata/application/deviceprofile.go b/internal/core/metadata/application/deviceprofile.go
@@ -245,7 +245,7 @@ func deviceProfileUoMValidation(p models.DeviceProfile, dic *di.Container) error
 		uom := container.UnitsOfMeasureFrom(dic.Get)
 		for _, dr := range p.DeviceResources {
 			if ok := uom.Validate(dr.Properties.Units); !ok {
-				return errors.NewCommonEdgeX(errors.KindServerError, fmt.Sprintf("DeviceResource %s units %s is invalid", dr.Name, dr.Properties.Units), nil)
+				return errors.NewCommonEdgeX(errors.KindContractInvalid, fmt.Sprintf("DeviceResource %s units %s is invalid", dr.Name, dr.Properties.Units), nil)
 			}
 		}
 	}

diff --git a/internal/core/metadata/application/deviceresource.go b/internal/core/metadata/application/deviceresource.go
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2021 IOTech Ltd
+// Copyright (C) 2021-2022 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -60,6 +60,11 @@ func AddDeviceProfileResource(profileName string, resource models.DeviceResource
 		return errors.NewCommonEdgeXWrapper(err)
 	}
 
+	err = deviceResourceUoMValidation(resource, dic)
+	if err != nil {
+		return errors.NewCommonEdgeXWrapper(err)
+	}
+
 	profile.DeviceResources = append(profile.DeviceResources, resource)
 
 	profileDTO := dtos.FromDeviceProfileModelToDTO(profile)
@@ -163,3 +168,14 @@ func DeleteDeviceResourceByName(profileName string, resourceName string, dic *di
 
 	return nil
 }
+
+func deviceResourceUoMValidation(r models.DeviceResource, dic *di.Container) errors.EdgeX {
+	if container.ConfigurationFrom(dic.Get).Writable.UoM.Validation {
+		uom := container.UnitsOfMeasureFrom(dic.Get)
+		if ok := uom.Validate(r.Properties.Units); !ok {
+			return errors.NewCommonEdgeX(errors.KindContractInvalid, fmt.Sprintf("DeviceResource %s units %s is invalid", r.Name, r.Properties.Units), nil)
+		}
+	}
+
+	return nil
+}
diff --git a/internal/core/metadata/controller/http/deviceprofile_test.go b/internal/core/metadata/controller/http/deviceprofile_test.go
@@ -404,7 +404,7 @@ func TestAddDeviceProfile_UnitsOfMeasure_Validation(t *testing.T) {
 	}{
 		{"valid - expected units", []requests.DeviceProfileRequest{validReq}, http.StatusCreated},
 		{"valid - units not provided", []requests.DeviceProfileRequest{emptyUnitsReq}, http.StatusCreated},
-		{"invalid - unexpected units", []requests.DeviceProfileRequest{invalidUnitsReq}, http.StatusInternalServerError},
+		{"invalid - unexpected units", []requests.DeviceProfileRequest{invalidUnitsReq}, http.StatusBadRequest},
 	}
 	for _, testCase := range tests {
 		t.Run(testCase.name, func(t *testing.T) {

diff --git a/internal/core/metadata/controller/http/deviceresource_test.go b/internal/core/metadata/controller/http/deviceresource_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2021 IOTech Ltd
+// Copyright (C) 2021-2022 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -14,7 +14,7 @@ import (
 	"testing"
 
 	"github.com/edgexfoundry/edgex-go/internal/core/metadata/container"
-	dbMock "github.com/edgexfoundry/edgex-go/internal/core/metadata/infrastructure/interfaces/mocks"
+	"github.com/edgexfoundry/edgex-go/internal/core/metadata/infrastructure/interfaces/mocks"
 
 	"github.com/edgexfoundry/go-mod-bootstrap/v2/di"
 	"github.com/edgexfoundry/go-mod-core-contracts/v2/common"
@@ -75,7 +75,7 @@ func TestDeviceResourceByProfileNameAndResourceName(t *testing.T) {
 	resourceNotFoundName := "resourceNotFoundName"
 
 	dic := mockDic()
-	dbClientMock := &dbMock.DBClient{}
+	dbClientMock := &mocks.DBClient{}
 	dbClientMock.On("DeviceProfileByName", deviceProfile.Name).Return(deviceProfile, nil)
 	dbClientMock.On("DeviceProfileByName", profileNotFoundName).Return(models.DeviceProfile{}, errors.NewCommonEdgeX(errors.KindEntityDoesNotExist, "device profile doesn't exist in the database", nil))
 	dic.Update(di.ServiceConstructorMap{
@@ -152,7 +152,7 @@ func TestAddDeviceProfileResource(t *testing.T) {
 	notFoundDBError := errors.NewCommonEdgeX(errors.KindEntityDoesNotExist, fmt.Sprintf("device profile %s does not exists", notFoundProfileName.ProfileName), nil)
 
 	dic := mockDic()
-	dbClientMock := &dbMock.DBClient{}
+	dbClientMock := &mocks.DBClient{}
 	dbClientMock.On("DeviceProfileByName", valid.ProfileName).Return(deviceProfile, nil)
 	dbClientMock.On("DeviceProfileByName", notFoundProfileName.ProfileName).Return(deviceProfile, notFoundDBError)
 	dbClientMock.On("UpdateDeviceProfile", mock.Anything).Return(nil)
@@ -246,6 +246,74 @@ func TestAddDeviceProfileResource_BadRequest(t *testing.T) {
 	}
 }
 
+func TestAddDeviceProfileResource_UnitsOfMeasure_Validation(t *testing.T) {
+	deviceProfile := dtos.ToDeviceProfileModel(buildTestDeviceProfileRequest().Profile)
+	expectedRequestId := ExampleUUID
+
+	emptyUnitsReq := testDeviceResourceRequest
+	validReq := emptyUnitsReq
+	validReq.Resource.Properties.Units = TestUnits
+	invalidUnitsReq := emptyUnitsReq
+	invalidUnitsReq.Resource.Properties.Units = "invalid"
+
+	dic := mockDic()
+	container.ConfigurationFrom(dic.Get).Writable.UoM.Validation = true
+	dbClientMock := &mocks.DBClient{}
+	dbClientMock.On("DeviceProfileByName", validReq.ProfileName).Return(deviceProfile, nil)
+	dbClientMock.On("UpdateDeviceProfile", mock.Anything).Return(nil)
+	uomMock := &mocks.UnitsOfMeasure{}
+	uomMock.On("Validate", TestUnits).Return(true)
+	uomMock.On("Validate", "").Return(true)
+	uomMock.On("Validate", "invalid").Return(false)
+	dic.Update(di.ServiceConstructorMap{
+		container.DBClientInterfaceName: func(get di.Get) interface{} {
+			return dbClientMock
+		},
+		container.UnitsOfMeasureInterfaceName: func(get di.Get) interface{} {
+			return uomMock
+		},
+	})
+
+	controller := NewDeviceResourceController(dic)
+	assert.NotNil(t, controller)
+
+	tests := []struct {
+		name               string
+		Request            []requests.AddDeviceResourceRequest
+		expectedStatusCode int
+	}{
+		{"valid - units not provided", []requests.AddDeviceResourceRequest{emptyUnitsReq}, http.StatusCreated},
+		{"valid - expected units", []requests.AddDeviceResourceRequest{validReq}, http.StatusCreated},
+		{"invalid - unexpected units", []requests.AddDeviceResourceRequest{invalidUnitsReq}, http.StatusBadRequest},
+	}
+	for _, testCase := range tests {
+		t.Run(testCase.name, func(t *testing.T) {
+			jsonData, err := json.Marshal(testCase.Request)
+			require.NoError(t, err)
+
+			reader := strings.NewReader(string(jsonData))
+			req, err := http.NewRequest(http.MethodPost, common.ApiDeviceProfileResourceRoute, reader)
+			require.NoError(t, err)
+
+			// Act
+			recorder := httptest.NewRecorder()
+			handler := http.HandlerFunc(controller.AddDeviceProfileResource)
+			handler.ServeHTTP(recorder, req)
+
+			var res []commonDTO.BaseResponse
+			err = json.Unmarshal(recorder.Body.Bytes(), &res)
+			require.NoError(t, err)
+			// Assert
+			assert.Equal(t, http.StatusMultiStatus, recorder.Result().StatusCode, "HTTP status code not as expected")
+			assert.Equal(t, common.ApiVersion, res[0].ApiVersion, "API Version not as expected")
+			if res[0].RequestId != "" {
+				assert.Equal(t, expectedRequestId, res[0].RequestId, "RequestID not as expected")
+			}
+			assert.Equal(t, testCase.expectedStatusCode, res[0].StatusCode, "BaseResponse status code not as expected")
+			assert.NotEmpty(t, recorder.Body.String(), "Message is empty")
+		})
+	}
+}
 func TestPatchDeviceProfileResource(t *testing.T) {
 	deviceProfile := dtos.ToDeviceProfileModel(buildTestDeviceProfileRequest().Profile)
 	testReq := buildTestUpdateDeviceResourceRequest()
@@ -271,7 +339,7 @@ func TestPatchDeviceProfileResource(t *testing.T) {
 	noProfileName.ProfileName = emptyString
 
 	dic := mockDic()
-	dbClientMock := &dbMock.DBClient{}
+	dbClientMock := &mocks.DBClient{}
 	dbClientMock.On("DeviceProfileByName", valid.ProfileName).Return(deviceProfile, nil)
 	dbClientMock.On("DevicesByProfileName", 0, 1, valid.ProfileName).Return([]models.Device{}, nil)
 	dbClientMock.On("UpdateDeviceProfile", mock.Anything).Return(nil)
@@ -354,7 +422,7 @@ func TestDeleteDeviceResourceByName(t *testing.T) {
 	deviceExists := "deviceExists"
 
 	dic := mockDic()
-	dbClientMock := &dbMock.DBClient{}
+	dbClientMock := &mocks.DBClient{}
 	dbClientMock.On("DevicesByProfileName", 0, 1, TestDeviceProfileName).Return([]models.Device{}, nil)
 	dbClientMock.On("DeviceProfileByName", TestDeviceProfileName).Return(dpModel, nil)
 	dbClientMock.On("UpdateDeviceProfile", mock.Anything).Return(nil)