Merge pull request #903 from weichou1229/issue-4814

feat: Add multiple profile basic info DTO
edgexfoundry · Jul 4, 2024 · 28ac3a9 · 28ac3a9
2 parents efd5619 + 2133f19
commit 28ac3a9
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 4 deletions.
diff --git a/common/constants.go b/common/constants.go
@@ -35,6 +35,7 @@ const (
 
 	ApiDeviceProfileRoute                       = ApiBase + "/deviceprofile"
 	ApiDeviceProfileBasicInfoRoute              = ApiDeviceProfileRoute + "/basicinfo"
+	ApiAllDeviceProfileBasicInfoRoute           = ApiDeviceProfileBasicInfoRoute + "/" + All
 	ApiDeviceProfileDeviceCommandRoute          = ApiDeviceProfileRoute + "/" + DeviceCommand
 	ApiDeviceProfileResourceRoute               = ApiDeviceProfileRoute + "/" + Resource
 	ApiDeviceProfileUploadFileRoute             = ApiDeviceProfileRoute + "/uploadfile"

diff --git a/dtos/deviceprofile.go b/dtos/deviceprofile.go
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020-2021 IOTech Ltd
+// Copyright (C) 2020-2024 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -94,6 +94,18 @@ func FromDeviceProfileModelToDTO(deviceProfile models.DeviceProfile) DeviceProfi
 	}
 }
 
+// FromDeviceProfileModelToBasicInfoDTO transforms the DeviceProfile Model to the DeviceProfileBasicInfo DTO
+func FromDeviceProfileModelToBasicInfoDTO(deviceProfile models.DeviceProfile) DeviceProfileBasicInfo {
+	return DeviceProfileBasicInfo{
+		Id:           deviceProfile.Id,
+		Name:         deviceProfile.Name,
+		Description:  deviceProfile.Description,
+		Manufacturer: deviceProfile.Manufacturer,
+		Model:        deviceProfile.Model,
+		Labels:       deviceProfile.Labels,
+	}
+}
+
 func ValidateDeviceProfileDTO(profile DeviceProfile) error {
 	// deviceResources validation
 	dupCheck := make(map[string]bool)

diff --git a/dtos/deviceprofile_test.go b/dtos/deviceprofile_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2021-2023 IOTech Ltd
+// Copyright (C) 2021-2024 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -90,6 +90,11 @@ func TestFromDeviceProfileModelToDTO(t *testing.T) {
 	assert.Equal(t, profileData(), result, "FromDeviceProfileModelToDTO did not result in expected device profile DTO.")
 }
 
+func TestFromDeviceProfileModelToBasicInfoDTO(t *testing.T) {
+	result := FromDeviceProfileModelToBasicInfoDTO(testDeviceProfile)
+	assert.Equal(t, profileData().DeviceProfileBasicInfo, result, "FromDeviceProfileModelToBasicInfoDTO did not result in expected device profile basic info DTO.")
+}
+
 func TestDeviceProfileDTOValidation(t *testing.T) {
 	valid := profileData()
 	duplicatedDeviceResource := profileData()

diff --git a/dtos/responses/deviceprofile.go b/dtos/responses/deviceprofile.go
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020 IOTech Ltd
+// Copyright (C) 2020-2024 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -35,3 +35,16 @@ func NewMultiDeviceProfilesResponse(requestId string, message string, statusCode
 		Profiles:                   deviceProfiles,
 	}
 }
+
+// MultiDeviceProfileBasicInfoResponse defines the Response Content for GET multiple DeviceProfileBasicInfo DTOs.
+type MultiDeviceProfileBasicInfoResponse struct {
+	common.BaseWithTotalCountResponse `json:",inline"`
+	Profiles                          []dtos.DeviceProfileBasicInfo `json:"profiles"`
+}
+
+func NewMultiDeviceProfileBasicInfosResponse(requestId string, message string, statusCode int, totalCount uint32, deviceProfileBasicInfos []dtos.DeviceProfileBasicInfo) MultiDeviceProfileBasicInfoResponse {
+	return MultiDeviceProfileBasicInfoResponse{
+		BaseWithTotalCountResponse: common.NewBaseWithTotalCountResponse(requestId, message, statusCode, totalCount),
+		Profiles:                   deviceProfileBasicInfos,
+	}
+}
diff --git a/dtos/responses/deviceprofile_test.go b/dtos/responses/deviceprofile_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020 IOTech Ltd
+// Copyright (C) 2020-2024 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -43,3 +43,21 @@ func TestNewMultiDeviceProfilesResponse(t *testing.T) {
 	assert.Equal(t, expectedTotalCount, actual.TotalCount)
 	assert.Equal(t, expectedDeviceProfiles, actual.Profiles)
 }
+
+func TestNewMultiDeviceProfileBasicInfosResponse(t *testing.T) {
+	expectedRequestId := "123456"
+	expectedStatusCode := 200
+	expectedMessage := "unit test message"
+	expectedDeviceProfileBasicInfos := []dtos.DeviceProfileBasicInfo{
+		{Name: "test device profile1"},
+		{Name: "test device profile2"},
+	}
+	expectedTotalCount := uint32(2)
+	actual := NewMultiDeviceProfileBasicInfosResponse(expectedRequestId, expectedMessage, expectedStatusCode, expectedTotalCount, expectedDeviceProfileBasicInfos)
+
+	assert.Equal(t, expectedRequestId, actual.RequestId)
+	assert.Equal(t, expectedStatusCode, actual.StatusCode)
+	assert.Equal(t, expectedMessage, actual.Message)
+	assert.Equal(t, expectedTotalCount, actual.TotalCount)
+	assert.Equal(t, expectedDeviceProfileBasicInfos, actual.Profiles)
+}