Merge pull request #689 from ovh/dev/aamstutz/dbaas_logs_graylog_output_stream-add-write-token

feat: add write_token field in resource/datasource ovh_dbaas_logs_output_graylog_stream

Author: amstuta

ovh/data_dbaas_logs_output_graylog_stream.go

@@ -1,19 +1,19 @@
 package ovh
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"net/url"
 	"strings"
 
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
 func dataSourceDbaasLogsOutputGraylogStream() *schema.Resource {
 	return &schema.Resource{
-		Read: func(d *schema.ResourceData, meta interface{}) error {
-			return dataSourceDbaasLogsOutputGraylogStreamRead(d, meta)
-		},
+		ReadContext: dataSourceDbaasLogsOutputGraylogStreamRead,
 		Schema: map[string]*schema.Schema{
 			"service_name": {
 				Type:        schema.TypeString,
@@ -137,11 +137,17 @@ func dataSourceDbaasLogsOutputGraylogStream() *schema.Resource {
 				Description: "Enable Websocket",
 				Computed:    true,
 			},
+			"write_token": {
+				Type:        schema.TypeString,
+				Description: "Write token of the stream",
+				Computed:    true,
+				Sensitive:   true,
+			},
 		},
 	}
 }
 
-func dataSourceDbaasLogsOutputGraylogStreamRead(d *schema.ResourceData, meta interface{}) error {
+func dataSourceDbaasLogsOutputGraylogStreamRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	config := meta.(*Config)
 
 	serviceName := d.Get("service_name").(string)
@@ -154,7 +160,7 @@ func dataSourceDbaasLogsOutputGraylogStreamRead(d *schema.ResourceData, meta int
 		url.PathEscape(serviceName),
 	)
 	if err := config.OVHClient.Get(endpoint, &res); err != nil {
-		return fmt.Errorf("Error calling Get %s:\n\t %q", endpoint, err)
+		return diag.Errorf("Error calling Get %s:\n\t %q", endpoint, err)
 	}
 	streams := []*DbaasLogsOutputGraylogStream{}
 
@@ -169,7 +175,7 @@ func dataSourceDbaasLogsOutputGraylogStreamRead(d *schema.ResourceData, meta int
 
 		stream := &DbaasLogsOutputGraylogStream{}
 		if err := config.OVHClient.Get(endpoint, &stream); err != nil {
-			return fmt.Errorf("Error calling Get %s:\n\t %q", endpoint, err)
+			return diag.Errorf("Error calling Get %s:\n\t %q", endpoint, err)
 		}
 
 		log.Printf("[INFO]Comparing : %s ? %s",
@@ -183,12 +189,10 @@ func dataSourceDbaasLogsOutputGraylogStreamRead(d *schema.ResourceData, meta int
 	}
 
 	if len(streams) == 0 {
-		return fmt.Errorf("Your query returned no results. " +
-			"Please change your search criteria and try again.")
+		return diag.Errorf("Your query returned no results. Please change your search criteria and try again.")
 	}
 	if len(streams) > 1 {
-		return fmt.Errorf("Your query returned more than one result. " +
-			"Please change your search criteria and try again.")
+		return diag.Errorf("Your query returned more than one result. Please change your search criteria and try again.")
 	}
 
 	for k, v := range streams[0].ToMap() {
@@ -200,5 +204,12 @@ func dataSourceDbaasLogsOutputGraylogStreamRead(d *schema.ResourceData, meta int
 		}
 	}
 
+	// Get stream write token, if available
+	writeToken, err := resourceDbaasLogsOutputGraylogStreamGetWriteToken(ctx, config, serviceName, streams[0].StreamId)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	d.Set("write_token", writeToken)
+
 	return nil
 }

ovh/data_dbaas_logs_output_graylog_stream_test.go

@@ -52,6 +52,10 @@ func TestAccDataSourceDbaasLogsOutputGraylogStream_basic(t *testing.T) {
 						"title",
 						title,
 					),
+					resource.TestCheckResourceAttrSet(
+						"data.ovh_dbaas_logs_output_graylog_stream.stream",
+						"write_token",
+					),
 				),
 			},
 		},

ovh/resource_dbaas_logs_output_graylog_stream.go

@@ -196,6 +196,12 @@ func resourceDbaasLogsOutputGraylogStream() *schema.Resource {
 				Description: "Stream last update",
 				Computed:    true,
 			},
+			"write_token": {
+				Type:        schema.TypeString,
+				Description: "Write token of the stream",
+				Computed:    true,
+				Sensitive:   true,
+			},
 		},
 	}
 }
@@ -302,9 +308,42 @@ func resourceDbaasLogsOutputGraylogStreamRead(ctx context.Context, d *schema.Res
 		}
 	}
 
+	// Get stream write token, if available
+	writeToken, err := resourceDbaasLogsOutputGraylogStreamGetWriteToken(ctx, config, serviceName, id)
+	if err != nil {
+		return diag.FromErr(helpers.CheckDeleted(d, err, endpoint))
+	}
+	d.Set("write_token", writeToken)
+
 	return nil
 }
 
+func resourceDbaasLogsOutputGraylogStreamGetWriteToken(ctx context.Context, config *Config, serviceName, streamId string) (string, error) {
+	var (
+		ruleIds  []string
+		endpoint = fmt.Sprintf("/dbaas/logs/%s/output/graylog/stream/%s/rule", url.PathEscape(serviceName), url.PathEscape(streamId))
+	)
+
+	if err := config.OVHClient.GetWithContext(ctx, endpoint, &ruleIds); err != nil {
+		return "", fmt.Errorf("failed to list stream rules: %w", err)
+	}
+
+	for _, ruleId := range ruleIds {
+		rule := DbaasLogsOutputGraylogStreamRule{}
+		ruleEndpoint := endpoint + "/" + url.PathEscape(ruleId)
+
+		if err := config.OVHClient.GetWithContext(ctx, ruleEndpoint, &rule); err != nil {
+			return "", fmt.Errorf("failed to get stream rule %q: %w", ruleId, err)
+		}
+
+		if rule.Field == "X-OVH-TOKEN" {
+			return rule.Value, nil
+		}
+	}
+
+	return "", nil
+}
+
 func resourceDbaasLogsOutputGraylogStreamDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	config := meta.(*Config)
 

ovh/resource_dbaas_logs_output_graylog_stream_test.go

@@ -127,6 +127,10 @@ func TestAccResourceDbaasLogsOutputGraylogStream_basic(t *testing.T) {
 						"title",
 						title,
 					),
+					resource.TestCheckResourceAttrSet(
+						"ovh_dbaas_logs_output_graylog_stream.stream",
+						"write_token",
+					),
 				),
 			},
 		},

ovh/types_dbaas_logs_output_graylog_stream.go

@@ -155,3 +155,8 @@ func (opts *DbaasLogsOutputGraylogStreamUpdateOpts) FromResource(d *schema.Resou
 
 	return opts
 }
+
+type DbaasLogsOutputGraylogStreamRule struct {
+	Field string `json:"field"`
+	Value string `json:"value"`
+}

website/docs/d/dbaas_logs_output_graylog_stream.html.markdown

@@ -46,3 +46,4 @@ data "ovh_dbaas_logs_output_graylog_stream" "stream" {
 * `stream_id` - Stream ID
 * `updated_at` - Stream last update
 * `web_socket_enabled` - Enable Websocket
+* `write_token` - Write token of the stream (empty if the caller is not the owner of the stream)

website/docs/r/dbaas_logs_graylog_output_stream.html.markdown

@@ -48,3 +48,4 @@ Id is set to the output stream Id. In addition, the following attributes are exp
 * `nb_archive` - Number of coldstored archivesr
 * `stream_id` - Stream ID
 * `updated_at` - Stream last updater
+* `write_token` - Write token of the stream (empty if the caller is not the owner of the stream)