NSOF-5772 metaports: add notification channel support for metaport and metaport failover

hod-alpert · hod-alpert · commit 8e5243e32e6d · 2021-12-15T14:54:26.000+02:00
diff --git a/docs/data-sources/metaport.md b/docs/data-sources/metaport.md
@@ -37,5 +37,6 @@ output "metaport" {
 - **enabled** (Boolean)
 - **mapped_elements** (Set of String) List of mapped element IDs
 - **name** (String)
+- **notification_channels** (List of String) List of notification channel IDs
 
 
diff --git a/docs/data-sources/metaport_failover.md b/docs/data-sources/metaport_failover.md
@@ -39,6 +39,7 @@ output "metaport_failover" {
 - **failover** (List of Object) Secondary to primary cluster switchover. (see [below for nested schema](#nestedatt--failover))
 - **mapped_elements** (Set of String) List of mapped element IDs
 - **name** (String)
+- **notification_channels** (List of String) List of notification channel IDs
 
 <a id="nestedatt--failback"></a>
 ### Nested Schema for `failback`
diff --git a/docs/resources/metaport.md b/docs/resources/metaport.md
@@ -18,11 +18,20 @@ resource "pfptmeta_network_element" "mapped-subnet" {
   mapped_subnets = ["0.0.0.0/0"]
 }
 
+resource "pfptmeta_notification_channel" "mail" {
+  name        = "mail-channel"
+  description = "mail channel description"
+  email_config {
+    recipients = ["user1@example.com", "user2@example.com"]
+  }
+}
+
 resource "pfptmeta_metaport" "metaport1" {
-  name            = "metaport name1"
-  description     = "some details about the metaport"
-  mapped_elements = [pfptmeta_network_element.mapped-subnet.id]
-  allow_support   = false
+  name                  = "metaport name1"
+  description           = "some details about the metaport"
+  mapped_elements       = [pfptmeta_network_element.mapped-subnet.id]
+  allow_support         = false
+  notification_channels = [pfptmeta_notification_channel.mail.id]
 }
 ```
 
@@ -39,6 +48,7 @@ resource "pfptmeta_metaport" "metaport1" {
 - **description** (String)
 - **enabled** (Boolean)
 - **mapped_elements** (Set of String) List of mapped element IDs
+- **notification_channels** (List of String) List of notification channel IDs
 
 ### Read-Only
 
diff --git a/docs/resources/metaport_failover.md b/docs/resources/metaport_failover.md
@@ -36,12 +36,21 @@ resource "pfptmeta_metaport_cluster" "metaport_cluster2" {
   metaports = [pfptmeta_metaport.metaport2.id]
 }
 
+resource "pfptmeta_notification_channel" "mail" {
+  name        = "mail-channel"
+  description = "mail channel description"
+  email_config {
+    recipients = ["user1@example.com", "user2@example.com"]
+  }
+}
+
 resource "pfptmeta_metaport_failover" "failover" {
-  name            = "metaport failover name"
-  description     = "metaport failover description"
-  mapped_elements = [pfptmeta_network_element.mapped-subnet.id]
-  cluster_1       = pfptmeta_metaport_cluster.metaport_cluster1
-  cluster_2       = pfptmeta_metaport_cluster.metaport_cluster2
+  name                  = "metaport failover name"
+  description           = "metaport failover description"
+  mapped_elements       = [pfptmeta_network_element.mapped-subnet.id]
+  cluster_1             = pfptmeta_metaport_cluster.metaport_cluster1
+  cluster_2             = pfptmeta_metaport_cluster.metaport_cluster2
+  notification_channels = [pfptmeta_notification_channel.mail.id]
   failback {
     trigger = "auto"
   }
@@ -68,6 +77,7 @@ resource "pfptmeta_metaport_failover" "failover" {
 - **failback** (Block List, Max: 1) Primary to secondary cluster switchover. (see [below for nested schema](#nestedblock--failback))
 - **failover** (Block List, Max: 1) Secondary to primary cluster switchover. (see [below for nested schema](#nestedblock--failover))
 - **mapped_elements** (Set of String) List of mapped element IDs
+- **notification_channels** (List of String) List of notification channel IDs
 
 ### Read-Only
 
diff --git a/examples/resources/pfptmeta_metaport/resource.tf b/examples/resources/pfptmeta_metaport/resource.tf
@@ -3,9 +3,18 @@ resource "pfptmeta_network_element" "mapped-subnet" {
   mapped_subnets = ["0.0.0.0/0"]
 }
 
+resource "pfptmeta_notification_channel" "mail" {
+  name        = "mail-channel"
+  description = "mail channel description"
+  email_config {
+    recipients = ["user1@example.com", "user2@example.com"]
+  }
+}
+
 resource "pfptmeta_metaport" "metaport1" {
-  name            = "metaport name1"
-  description     = "some details about the metaport"
-  mapped_elements = [pfptmeta_network_element.mapped-subnet.id]
-  allow_support   = false
+  name                  = "metaport name1"
+  description           = "some details about the metaport"
+  mapped_elements       = [pfptmeta_network_element.mapped-subnet.id]
+  allow_support         = false
+  notification_channels = [pfptmeta_notification_channel.mail.id]
 }
diff --git a/examples/resources/pfptmeta_metaport_failover/resource.tf b/examples/resources/pfptmeta_metaport_failover/resource.tf
@@ -21,12 +21,21 @@ resource "pfptmeta_metaport_cluster" "metaport_cluster2" {
   metaports = [pfptmeta_metaport.metaport2.id]
 }
 
+resource "pfptmeta_notification_channel" "mail" {
+  name        = "mail-channel"
+  description = "mail channel description"
+  email_config {
+    recipients = ["user1@example.com", "user2@example.com"]
+  }
+}
+
 resource "pfptmeta_metaport_failover" "failover" {
-  name            = "metaport failover name"
-  description     = "metaport failover description"
-  mapped_elements = [pfptmeta_network_element.mapped-subnet.id]
-  cluster_1       = pfptmeta_metaport_cluster.metaport_cluster1
-  cluster_2       = pfptmeta_metaport_cluster.metaport_cluster2
+  name                  = "metaport failover name"
+  description           = "metaport failover description"
+  mapped_elements       = [pfptmeta_network_element.mapped-subnet.id]
+  cluster_1             = pfptmeta_metaport_cluster.metaport_cluster1
+  cluster_2             = pfptmeta_metaport_cluster.metaport_cluster2
+  notification_channels = [pfptmeta_notification_channel.mail.id]
   failback {
     trigger = "auto"
   }
diff --git a/internal/client/metaport.go b/internal/client/metaport.go
@@ -15,12 +15,13 @@ const (
 )
 
 type Metaport struct {
-	ID             string   `json:"id,omitempty"`
-	Name           string   `json:"name,omitempty"`
-	Description    string   `json:"description,omitempty"`
-	Enabled        *bool    `json:"enabled,omitempty"`
-	AllowSupport   *bool    `json:"allow_support,omitempty"`
-	MappedElements []string `json:"mapped_elements"`
+	ID                   string   `json:"id,omitempty"`
+	Name                 string   `json:"name,omitempty"`
+	Description          string   `json:"description,omitempty"`
+	Enabled              *bool    `json:"enabled,omitempty"`
+	AllowSupport         *bool    `json:"allow_support,omitempty"`
+	MappedElements       []string `json:"mapped_elements"`
+	NotificationChannels []string `json:"notification_channels"`
 }
 
 func NewMetaport(d *schema.ResourceData) *Metaport {
@@ -40,6 +41,12 @@ func NewMetaport(d *schema.ResourceData) *Metaport {
 
 	mes := d.Get("mapped_elements")
 	res.MappedElements = ResourceTypeSetToStringSlice(mes.(*schema.Set))
+	nc := d.Get("notification_channels").([]interface{})
+	nChannel := make([]string, len(nc))
+	for i, org := range nc {
+		nChannel[i] = org.(string)
+	}
+	res.NotificationChannels = nChannel
 
 	return res
 }
diff --git a/internal/client/metaport_failover.go b/internal/client/metaport_failover.go
@@ -24,15 +24,16 @@ type FailOver struct {
 }
 
 type MetaportFailover struct {
-	ID             string    `json:"id,omitempty"`
-	Name           string    `json:"name,omitempty"`
-	Description    string    `json:"description,omitempty"`
-	MappedElements []string  `json:"mapped_elements"`
-	Cluster1       *string   `json:"cluster_1"`
-	Cluster2       *string   `json:"cluster_2"`
-	ActiveCluster  *string   `json:"active_cluster,omitempty"`
-	FailBack       *FailBack `json:"failback,omitempty"`
-	FailOver       *FailOver `json:"failover,omitempty"`
+	ID                   string    `json:"id,omitempty"`
+	Name                 string    `json:"name,omitempty"`
+	Description          string    `json:"description,omitempty"`
+	MappedElements       []string  `json:"mapped_elements"`
+	Cluster1             *string   `json:"cluster_1"`
+	Cluster2             *string   `json:"cluster_2"`
+	ActiveCluster        *string   `json:"active_cluster,omitempty"`
+	FailBack             *FailBack `json:"failback,omitempty"`
+	FailOver             *FailOver `json:"failover,omitempty"`
+	NotificationChannels []string  `json:"notification_channels"`
 }
 
 func (mf *MetaportFailover) ReqBody() ([]byte, error) {
@@ -80,6 +81,12 @@ func NewMetaportFailover(d *schema.ResourceData) *MetaportFailover {
 			res.FailOver = &FailOver{Delay: uint8(delay), Threshold: uint8(threshold), Trigger: trigger}
 		}
 	}
+	nc := d.Get("notification_channels").([]interface{})
+	nChannel := make([]string, len(nc))
+	for i, org := range nc {
+		nChannel[i] = org.(string)
+	}
+	res.NotificationChannels = nChannel
 	return res
 }
 
diff --git a/internal/provider/acc_tests/metaport_failover_test.go b/internal/provider/acc_tests/metaport_failover_test.go
@@ -37,6 +37,9 @@ func TestAccResourceMetaportFailover(t *testing.T) {
 					resource.TestCheckResourceAttr(
 						"pfptmeta_metaport_failover.failover", "failover.0.trigger", "auto",
 					),
+					resource.TestMatchResourceAttr(
+						"pfptmeta_metaport_failover.failover", "notification_channels.0", regexp.MustCompile("^nch-.+$"),
+					),
 				),
 			},
 			{
@@ -58,6 +61,9 @@ func TestAccResourceMetaportFailover(t *testing.T) {
 					resource.TestCheckResourceAttr(
 						"pfptmeta_metaport_failover.failover", "failover.0.trigger", "auto",
 					),
+					resource.TestCheckNoResourceAttr(
+						"pfptmeta_metaport_failover.failover", "notification_channels.0",
+					),
 				),
 			},
 			{
@@ -133,9 +139,18 @@ func TestAccDataSourceMetaportFailover(t *testing.T) {
 }
 
 const testAccMetaportFailoverStep1 = `
+resource "pfptmeta_notification_channel" "mail" {
+  name        = "mail-channel"
+  description = "mail channel description"
+  email_config {
+    recipients = ["user1@example.com", "user2@example.com"]
+  }
+}
+
 resource "pfptmeta_metaport_failover" "failover" {
   name               = "mf-name"
   description        = "mf-description"
+  notification_channels = [pfptmeta_notification_channel.mail.id]
   failback {
 	trigger   = "manual"
   }
diff --git a/internal/provider/acc_tests/metaport_test.go b/internal/provider/acc_tests/metaport_test.go
@@ -31,6 +31,9 @@ func TestAccResourceMetaport(t *testing.T) {
 					resource.TestCheckResourceAttr(
 						"pfptmeta_metaport.metaport", "allow_support", "true",
 					),
+					resource.TestMatchResourceAttr(
+						"pfptmeta_metaport.metaport", "notification_channels.0", regexp.MustCompile("^nch-.+$"),
+					),
 				),
 			},
 			{
@@ -43,6 +46,7 @@ func TestAccResourceMetaport(t *testing.T) {
 						"pfptmeta_metaport.metaport", "description", "metaport description1",
 					),
 					resource.TestCheckNoResourceAttr("pfptmeta_metaport.metaport", "mapped_elements"),
+					resource.TestCheckNoResourceAttr("pfptmeta_metaport.metaport", "notification_channels.0"),
 					resource.TestCheckResourceAttr("pfptmeta_metaport.metaport", "allow_support", "false"),
 				),
 			},
@@ -86,10 +90,19 @@ resource "pfptmeta_network_element" "mapped-subnet" {
   mapped_subnets = ["0.0.0.0/0"]
 }
 
+resource "pfptmeta_notification_channel" "mail" {
+  name        = "mail-channel"
+  description = "mail channel description"
+  email_config {
+    recipients = ["user1@example.com", "user2@example.com"]
+  }
+}
+
 resource "pfptmeta_metaport" "metaport" {
   name                  = "metaport name"
   description           = "metaport description"
   mapped_elements       = [pfptmeta_network_element.mapped-subnet.id]
+  notification_channels = [pfptmeta_notification_channel.mail.id]
 }
 `
 
diff --git a/internal/provider/metaport/common.go b/internal/provider/metaport/common.go
@@ -14,7 +14,8 @@ const (
 	description = "MetaPort is a lightweight virtual appliance that enables the secure authenticated interface " +
 		"interact between existing servers and the Proofpoint NaaS cloud. " +
 		"Once configured, metaports enable users to access your applications via the Proofpoint cloud."
-	mappedElementsDesc = "List of mapped element IDs"
+	mappedElementsDesc       = "List of mapped element IDs"
+	notificationChannelsDesc = "List of notification channel IDs"
 )
 
 func metaportRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
diff --git a/internal/provider/metaport/data_source.go b/internal/provider/metaport/data_source.go
@@ -43,6 +43,12 @@ func DataSource() *schema.Resource {
 				Type:     schema.TypeString,
 				Computed: true,
 			},
+			"notification_channels": {
+				Description: notificationChannelsDesc,
+				Type:        schema.TypeList,
+				Computed:    true,
+				Elem:        &schema.Schema{Type: schema.TypeString},
+			},
 		},
 	}
 }
diff --git a/internal/provider/metaport/resource.go b/internal/provider/metaport/resource.go
@@ -48,6 +48,14 @@ func Resource() *schema.Resource {
 				Optional: true,
 				Default:  true,
 			},
+			"notification_channels": {
+				Description: notificationChannelsDesc,
+				Type:        schema.TypeList,
+				Optional:    true,
+				Elem: &schema.Schema{
+					Type:             schema.TypeString,
+					ValidateDiagFunc: common.ValidateID(false, "nch")},
+			},
 		},
 	}
 }
diff --git a/internal/provider/metaport_failover/common.go b/internal/provider/metaport_failover/common.go
@@ -13,12 +13,13 @@ const (
 	mappedElementsDesc = "List of mapped element IDs"
 	cluster1Desc       = "Priority #1 MetaPort cluster ID. This cluster is active by default. " +
 		"When failover condition is met for this cluster, the higher priority cluster becomes active."
-	cluster2Desc          = "Priority #2 MetaPort cluster ID. This cluster becomes active, when failover condition is met for a lower priority cluster."
-	failbackDesc          = "Primary to secondary cluster switchover."
-	failoverDesc          = "Secondary to primary cluster switchover."
-	failoverDelayDesc     = "Number of minutes to wait before execution of failover, defaults to 1."
-	failoverThresholdDesc = "Minimum number of healthy MetaPorts to keep a cluster active. Zero (0) denotes all MetaPorts in a cluster."
-	triggerDesc           = "ENUM: [auto, manual], defaults to auto."
+	cluster2Desc             = "Priority #2 MetaPort cluster ID. This cluster becomes active, when failover condition is met for a lower priority cluster."
+	failbackDesc             = "Primary to secondary cluster switchover."
+	failoverDesc             = "Secondary to primary cluster switchover."
+	failoverDelayDesc        = "Number of minutes to wait before execution of failover, defaults to 1."
+	failoverThresholdDesc    = "Minimum number of healthy MetaPorts to keep a cluster active. Zero (0) denotes all MetaPorts in a cluster."
+	triggerDesc              = "ENUM: [auto, manual], defaults to auto."
+	notificationChannelsDesc = "List of notification channel IDs"
 )
 
 var excludedKeys = []string{"id", "failback", "failover"}
diff --git a/internal/provider/metaport_failover/data_source.go b/internal/provider/metaport_failover/data_source.go
@@ -81,6 +81,12 @@ func DataSource() *schema.Resource {
 				},
 				Computed: true,
 			},
+			"notification_channels": {
+				Description: notificationChannelsDesc,
+				Type:        schema.TypeList,
+				Computed:    true,
+				Elem:        &schema.Schema{Type: schema.TypeString},
+			},
 		},
 	}
 }
diff --git a/internal/provider/metaport_failover/resource.go b/internal/provider/metaport_failover/resource.go
@@ -93,6 +93,14 @@ func Resource() *schema.Resource {
 				Optional: true,
 				MaxItems: 1,
 			},
+			"notification_channels": {
+				Description: notificationChannelsDesc,
+				Type:        schema.TypeList,
+				Optional:    true,
+				Elem: &schema.Schema{
+					Type:             schema.TypeString,
+					ValidateDiagFunc: common.ValidateID(false, "nch")},
+			},
 		},
 	}
 }
