Add ability to pass name to slack channel data source (#148)

Co-authored-by: Wilson E. Husin <14004487+wilsonehusin@users.noreply.github.com>

CHANGELOG.md

@@ -1,3 +1,8 @@
+## Unreleased
+
+ENHANCEMENTS:
+* **Added to Data Source**: `firehydrant_slack_channel`. Now you can pass either the channel id or the channel name to the data source. 
+
 ## 0.6.0
 
 ENHANCEMENTS:

docs/data-sources/slack_channel.md

@@ -11,7 +11,8 @@ Use this data source to pass Slack channel information to other resources.
 Basic usage:
 ```hcl
 data "firehydrant_slack_channel" "team_rocket" {
-  slack_channel_id = "C1234567890"
+  slack_channel_id   = "C1234567890"
+  slack_channel_name = "#team-rocket"
 }
 
 resource "firehydrant_escalation_policy" "team_rocket" {
@@ -30,7 +31,10 @@ resource "firehydrant_escalation_policy" "team_rocket" {
 
 The following arguments are supported:
 
-* `slack_channel_id` - (Required) Slack's channel ID.
+> You must provide one of these options.
+
+* `slack_channel_id` - (Optional) Slack's channel ID.
+* `slack_channel_name` - (Optional) Slack's channel name. We recommend using `slack_channel_id` where possible as Slack channel name may be changed and thus cause surprise state inconsistencies.
 
 ## Attributes Reference
 

firehydrant/slack_channels.go

@@ -3,14 +3,20 @@ package firehydrant
 import (
 	"context"
 	"fmt"
+	"strings"
 
 	"github.com/dghubble/sling"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 )
 
+type SlackChannelParams struct {
+	ID   string
+	Name string
+}
+
 // SlackChannelsClient is an interface for interacting with Slack channels
 type SlackChannelsClient interface {
-	Get(ctx context.Context, slackID string) (*SlackChannelResponse, error)
+	Get(ctx context.Context, params SlackChannelParams) (*SlackChannelResponse, error)
 }
 
 // RESTSlackChannelsClient implements the SlackChannelClient interface
@@ -26,10 +32,17 @@ func (c *RESTSlackChannelsClient) restClient() *sling.Sling {
 
 // Get retrieves a Slack channel from FireHydrant using Slack ID. This is useful for looking up
 // a Slack channel's internal ID.
-func (c *RESTSlackChannelsClient) Get(ctx context.Context, slackID string) (*SlackChannelResponse, error) {
+func (c *RESTSlackChannelsClient) Get(ctx context.Context, params SlackChannelParams) (*SlackChannelResponse, error) {
 	channels := &SlackChannelsResponse{}
 	apiError := &APIError{}
-	response, err := c.restClient().Get("integrations/slack/channels?slack_channel_id="+slackID).Receive(channels, apiError)
+
+	query := ""
+	if params.ID != "" {
+		query = fmt.Sprintf("slack_channel_id=%s", params.ID)
+	} else if params.Name != "" {
+		query = fmt.Sprintf("name=%s", strings.TrimPrefix(params.Name, "#"))
+	}
+	response, err := c.restClient().Get("integrations/slack/channels?"+query).Receive(channels, apiError)
 	if err != nil {
 		return nil, fmt.Errorf("could not get slack channel: %w", err)
 	}
@@ -40,28 +53,31 @@ func (c *RESTSlackChannelsClient) Get(ctx context.Context, slackID string) (*Sla
 	}
 
 	if channels.Channels == nil || len(channels.Channels) == 0 {
-		return nil, fmt.Errorf("no slack channel found with id '%s'", slackID)
+		return nil, fmt.Errorf("no slack channel found with options name '%s' and / or id '%s'", params.Name, params.ID)
 	}
 	if channelCount := len(channels.Channels); channelCount > 1 {
 		// "at least" because it may paginate.
 		tflog.Error(ctx, "found more than one Slack channel", map[string]interface{}{
-			"id":    slackID,
+			"id":    params.ID,
+			"name":  params.Name,
 			"found": channelCount,
 		})
 		for _, channel := range channels.Channels {
 			tflog.Error(ctx, "found Slack channel", map[string]interface{}{
-				"id":               channel.ID,
-				"slack_channel_id": channel.SlackChannelID,
-				"name":             channel.Name,
+				"id":                 params.ID,
+				"name":               params.Name,
+				"slack_channel_id":   channel.SlackChannelID,
+				"slack_channel_name": channel.Name,
 			})
 		}
 		return nil, fmt.Errorf("more than one Slack channel found: see Terraform logs for more information.")
 	}
 
 	tflog.Info(ctx, "found Slack channel", map[string]interface{}{
-		"id":               channels.Channels[0].ID,
-		"slack_channel_id": channels.Channels[0].SlackChannelID,
-		"name":             channels.Channels[0].Name,
+		"id":                 channels.Channels[0].ID,
+		"name":               channels.Channels[0].Name,
+		"slack_channel_id":   channels.Channels[0].SlackChannelID,
+		"slack_channel_name": channels.Channels[0].Name,
 	})
 
 	return channels.Channels[0], nil

firehydrant/slack_channels_test.go

@@ -28,19 +28,23 @@ func slackChannelMockServer(path, query *string) *httptest.Server {
 	h := http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 		*path = req.URL.Path
 		*query = req.URL.Query().Get("slack_channel_id")
-
 		if *query == "C01010101Z" {
 			w.Write([]byte(expectedSlackChannelsResponseJSON()))
 		} else {
-			w.WriteHeader(http.StatusNotFound)
+			*query = req.URL.Query().Get("name")
+			if *query == "team-rocket" {
+				w.Write([]byte(expectedSlackChannelsResponseJSON()))
+			} else {
+				w.WriteHeader(http.StatusNotFound)
+			}
 		}
 	})
 
 	ts := httptest.NewServer(h)
 	return ts
 }
 
-func TestSlackChannelGet(t *testing.T) {
+func TestSlackChannelGet_ID(t *testing.T) {
 	var requestPath, requestQuery string
 	ts := slackChannelMockServer(&requestPath, &requestQuery)
 	defer ts.Close()
@@ -50,7 +54,8 @@ func TestSlackChannelGet(t *testing.T) {
 		t.Fatalf("Received error initializing API client: %s", err.Error())
 		return
 	}
-	res, err := c.SlackChannels().Get(context.Background(), "C01010101Z")
+	params := SlackChannelParams{ID: "C01010101Z"}
+	res, err := c.SlackChannels().Get(context.Background(), params)
 	if err != nil {
 		t.Fatalf("error retrieving slack channel: %s", err.Error())
 	}
@@ -68,6 +73,35 @@ func TestSlackChannelGet(t *testing.T) {
 	}
 }
 
+func TestSlackChannelGet_Name(t *testing.T) {
+	var requestPath, requestQuery string
+	ts := slackChannelMockServer(&requestPath, &requestQuery)
+	defer ts.Close()
+
+	c, err := NewRestClient("test-token-very-authorized", WithBaseURL(ts.URL))
+	if err != nil {
+		t.Fatalf("Received error initializing API client: %s", err.Error())
+		return
+	}
+	params := SlackChannelParams{Name: "#team-rocket"}
+	res, err := c.SlackChannels().Get(context.Background(), params)
+	if err != nil {
+		t.Fatalf("error retrieving slack channel: %s", err.Error())
+	}
+
+	if expected := "/integrations/slack/channels"; expected != requestPath {
+		t.Fatalf("request path mismatch: expected '%s', got: '%s'", expected, requestPath)
+	}
+	if expected := "team-rocket"; expected != requestQuery {
+		t.Fatalf("request query params mismatch: expected '%s', got: '%s'", expected, requestQuery)
+	}
+
+	expectedResponse := expectedSlackChannelResponse()
+	if !reflect.DeepEqual(expectedResponse, res) {
+		t.Fatalf("response mismatch: expected '%+v', got: '%+v'", expectedResponse, res)
+	}
+}
+
 func TestSlackChannelGetNotFound(t *testing.T) {
 	var requestPath, requestQuery string
 	ts := slackChannelMockServer(&requestPath, &requestQuery)
@@ -78,11 +112,29 @@ func TestSlackChannelGetNotFound(t *testing.T) {
 		t.Fatalf("Received error initializing API client: %s", err.Error())
 		return
 	}
-	_, err = c.SlackChannels().Get(context.Background(), "C111111111")
+	params := SlackChannelParams{ID: "C11111111"}
+	_, err = c.SlackChannels().Get(context.Background(), params)
 	if err == nil {
 		t.Fatalf("expected ErrorNotFound in retrieving slack channel, got nil")
 	}
 	if !errors.Is(err, ErrorNotFound) {
 		t.Fatalf("expected ErrorNotFound in retrieving slack channel, got: %s", err)
 	}
 }
+
+func TestSlackChannelGetNotFound_noParams(t *testing.T) {
+	var requestPath, requestQuery string
+	ts := slackChannelMockServer(&requestPath, &requestQuery)
+	defer ts.Close()
+
+	c, err := NewRestClient("test-token-very-authorized", WithBaseURL(ts.URL))
+	if err != nil {
+		t.Fatalf("Received error initializing API client: %s", err.Error())
+		return
+	}
+	params := SlackChannelParams{ID: "", Name: ""}
+	_, err = c.SlackChannels().Get(context.Background(), params)
+	if err == nil {
+		t.Fatalf("expected ErrorNotFound in retrieving slack channel, got nil")
+	}
+}

provider/slack_channel_data.go

@@ -14,9 +14,16 @@ func dataSourceSlackChannel() *schema.Resource {
 		ReadContext: dataFireHydrantSlackChannelRead,
 		Schema: map[string]*schema.Schema{
 			"slack_channel_id": {
-				Description: "ID of the channel, provided by Slack.",
-				Type:        schema.TypeString,
-				Required:    true,
+				Description:   "ID of the channel, provided by Slack.",
+				Type:          schema.TypeString,
+				Optional:      true,
+				ConflictsWith: []string{"slack_channel_name"},
+			},
+			"slack_channel_name": {
+				Description:   "Name of this Slack channel.",
+				Type:          schema.TypeString,
+				Optional:      true,
+				ConflictsWith: []string{"slack_channel_id"},
 			},
 			"id": {
 				Description: "FireHydrant internal ID for the Slack channel.",
@@ -32,8 +39,17 @@ func dataFireHydrantSlackChannelRead(ctx context.Context, d *schema.ResourceData
 	firehydrantAPIClient := m.(firehydrant.Client)
 
 	// Get the Slack channel
-	channelID := d.Get("slack_channel_id").(string)
-	slackChannel, err := firehydrantAPIClient.SlackChannels().Get(ctx, channelID)
+	slack_channel_id := d.Get("slack_channel_id").(string)
+	slack_channel_name := d.Get("slack_channel_name").(string)
+	params := firehydrant.SlackChannelParams{
+		ID:   slack_channel_id,
+		Name: slack_channel_name,
+	}
+
+	if slack_channel_id == "" && slack_channel_name == "" {
+		return diag.Errorf("either `slack_channel_id` or `slack_channel_name` must be set")
+	}
+	slackChannel, err := firehydrantAPIClient.SlackChannels().Get(ctx, params)
 	if err != nil {
 		return diag.FromErr(err)
 	}

provider/slack_channel_data_test.go

@@ -19,7 +19,7 @@ func offlineSlackChannelsMockServer() *httptest.Server {
 	}))
 }
 
-func TestOfflineSlackChannelsReadMemberID(t *testing.T) {
+func TestOfflineSlackChannelsSlackChannelID(t *testing.T) {
 	ts := offlineSlackChannelsMockServer()
 	defer ts.Close()
 
@@ -34,9 +34,46 @@ func TestOfflineSlackChannelsReadMemberID(t *testing.T) {
 
 	d := dataFireHydrantSlackChannelRead(context.Background(), r, c)
 	if d.HasError() {
-		t.Fatalf("error reading on-call schedule: %v", d)
+		t.Fatalf("error reading slack channele: %v", d)
 	}
 	if id := r.Id(); id != "00000000-0000-4000-8000-000000000000" {
 		t.Fatalf("expected ID to be 00000000-0000-4000-8000-000000000000, got %s", id)
 	}
 }
+func TestOfflineSlackChannelsSlackChannelName(t *testing.T) {
+	ts := offlineSlackChannelsMockServer()
+	defer ts.Close()
+
+	c, err := firehydrant.NewRestClient("test-token-very-authorized", firehydrant.WithBaseURL(ts.URL))
+	if err != nil {
+		t.Fatalf("Received error initializing API client: %s", err.Error())
+		return
+	}
+	r := schema.TestResourceDataRaw(t, dataSourceSlackChannel().Schema, map[string]interface{}{
+		"slack_channel_name": "team-rocket",
+	})
+
+	d := dataFireHydrantSlackChannelRead(context.Background(), r, c)
+	if d.HasError() {
+		t.Fatalf("error reading slack channel: %v", d)
+	}
+	if id := r.Id(); id != "00000000-0000-4000-8000-000000000000" {
+		t.Fatalf("expected ID to be 00000000-0000-4000-8000-000000000000, got %s", id)
+	}
+}
+func TestOfflineSlackChannelsSlackChannel_missing(t *testing.T) {
+	ts := offlineSlackChannelsMockServer()
+	defer ts.Close()
+
+	c, err := firehydrant.NewRestClient("test-token-very-authorized", firehydrant.WithBaseURL(ts.URL))
+	if err != nil {
+		t.Fatalf("Received error initializing API client: %s", err.Error())
+		return
+	}
+	r := schema.TestResourceDataRaw(t, dataSourceSlackChannel().Schema, map[string]interface{}{})
+
+	d := dataFireHydrantSlackChannelRead(context.Background(), r, c)
+	if !d.HasError() {
+		t.Fatalf("didnt fail on reading slack channel: %v", d)
+	}
+}