Merge pull request #962 from jinlinGuan/edgex-go-issue-5007

feat: Add MQTT and ZeroMQ channels support to support-notification

Author: cloudxxx8

common/constants.go

@@ -89,6 +89,7 @@ const (
 	ApiNotificationByCategoryRoute         = ApiNotificationRoute + "/" + Category + "/:" + Category
 	ApiNotificationByLabelRoute            = ApiNotificationRoute + "/" + Label + "/:" + Label
 	ApiNotificationByIdRoute               = ApiNotificationRoute + "/" + Id + "/:" + Id
+	ApiNotificationByIdsRoute              = ApiNotificationRoute + "/" + Ids + "/:" + Ids
 	ApiNotificationByStatusRoute           = ApiNotificationRoute + "/" + Status + "/:" + Status
 	ApiNotificationBySubscriptionNameRoute = ApiNotificationRoute + "/" + Subscription + "/" + Name + "/:" + Name
 	ApiNotificationAcknowledgeByIdsRoute   = ApiNotificationRoute + "/" + Acknowledge + "/" + Ids + "/:" + Ids

dtos/address.go

@@ -144,9 +144,11 @@ type Security struct {
 type ZeroMQAddress struct {
 }
 
-func NewZeroMQAddress(topic string) Address {
+func NewZeroMQAddress(host string, port int, topic string) Address {
 	return Address{
 		Type:       common.ZeroMQ,
+		Host:       host,
+		Port:       port,
 		MessageBus: MessageBus{Topic: topic},
 	}
 }

dtos/requests/subscription.go

@@ -1,12 +1,13 @@
 //
-// Copyright (C) 2020-2021 IOTech Ltd
+// Copyright (C) 2020-2024 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
 package requests
 
 import (
 	"encoding/json"
+	"fmt"
 
 	"github.com/edgexfoundry/go-mod-core-contracts/v4/common"
 	"github.com/edgexfoundry/go-mod-core-contracts/v4/dtos"
@@ -15,7 +16,7 @@ import (
 	"github.com/edgexfoundry/go-mod-core-contracts/v4/models"
 )
 
-var supportedChannelTypes = []string{common.EMAIL, common.REST}
+var supportedChannelTypes = []string{common.EMAIL, common.REST, common.MQTT, common.ZeroMQ}
 
 // AddSubscriptionRequest defines the Request Content for POST Subscription DTO.
 type AddSubscriptionRequest struct {
@@ -34,7 +35,7 @@ func (request AddSubscriptionRequest) Validate() error {
 		if err != nil {
 			return errors.NewCommonEdgeXWrapper(err)
 		} else if !contains(supportedChannelTypes, c.Type) {
-			return errors.NewCommonEdgeX(errors.KindContractInvalid, "MQTT is not valid type for Channel", nil)
+			return errors.NewCommonEdgeX(errors.KindContractInvalid, fmt.Sprintf("%s is not valid type for Channel", c.Type), nil)
 		}
 	}
 	return nil
@@ -85,7 +86,7 @@ func (request UpdateSubscriptionRequest) Validate() error {
 		if err != nil {
 			return errors.NewCommonEdgeXWrapper(err)
 		} else if !contains(supportedChannelTypes, c.Type) {
-			return errors.NewCommonEdgeX(errors.KindContractInvalid, "MQTT is not valid type for Channel", nil)
+			return errors.NewCommonEdgeX(errors.KindContractInvalid, fmt.Sprintf("%s is not valid type for Channel", c.Type), nil)
 		}
 	}
 	if request.Subscription.Categories != nil && request.Subscription.Labels != nil &&

dtos/requests/subscription_test.go

@@ -1,12 +1,13 @@
 //
-// Copyright (C) 2020-2021 IOTech Ltd
+// Copyright (C) 2020-2024 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
 package requests
 
 import (
 	"encoding/json"
+	"net/http"
 	"testing"
 
 	"github.com/edgexfoundry/go-mod-core-contracts/v4/dtos"
@@ -20,8 +21,13 @@ var (
 	testSubscriptionName       = "subscriptionName"
 	testSubscriptionCategories = []string{"category1", "category2"}
 	testSubscriptionLabels     = []string{"label"}
+	testHost                   = "host"
+	testPort                   = 123
 	testSubscriptionChannels   = []dtos.Address{
+		dtos.NewRESTAddress(testHost, testPort, http.MethodGet),
 		dtos.NewEmailAddress([]string{"[email protected]"}),
+		dtos.NewMQTTAddress(testHost, testPort, "publisher", "topic"),
+		dtos.NewZeroMQAddress(testHost, testPort, "topic"),
 	}
 	testSubscriptionDescription    = "description"
 	testSubscriptionReceiver       = "receiver"
@@ -87,7 +93,7 @@ func TestAddSubscriptionRequest_Validate(t *testing.T) {
 	}
 	unsupportedChannelType := addSubscriptionRequestData()
 	unsupportedChannelType.Subscription.Channels = []dtos.Address{
-		dtos.NewMQTTAddress("host", 123, "publisher", "topic"),
+		{Type: "unknown"},
 	}
 
 	noCategories := addSubscriptionRequestData()
@@ -212,7 +218,7 @@ func TestUpdateSubscriptionRequest_Validate(t *testing.T) {
 	}
 	unsupportedChannelType := NewUpdateSubscriptionRequest(updateSubscriptionData())
 	unsupportedChannelType.Subscription.Channels = []dtos.Address{
-		dtos.NewMQTTAddress("host", 123, "publisher", "topic"),
+		{Type: "unknown"},
 	}
 	validWithoutChannels := NewUpdateSubscriptionRequest(updateSubscriptionData())
 	validWithoutChannels.Subscription.Channels = nil