Feature: Provider level teams configuration (#589)

* Adding support for improved features

* Adding ability to merge provider level teams

* Adding support for mergeing team details

* Add field to provider

* Fixing docs

Author: MovieStoreGuy

docs/index.md

@@ -106,4 +106,5 @@ provider "signalfx" {
 - `retry_wait_max_seconds` (Number) Maximum retry wait for a single HTTP call in seconds. Defaults to 30
 - `retry_wait_min_seconds` (Number) Minimum retry wait for a single HTTP call in seconds. Defaults to 1
 - `tags` (List of String) Allows for Tags to be added by default to resources that allow for tags to be included. If there is already tags configured, the global tags are added in prefix.
+- `teams` (List of String) Allows for teams to be defined at a provider level, and apply to all applicable resources created.
 - `timeout_seconds` (Number) Timeout duration for a single HTTP call in seconds. Defaults to 120

internal/definition/detector/resource.go

@@ -68,7 +68,7 @@ func resourceCreate(ctx context.Context, data *schema.ResourceData, meta any) (i
 			pmeta.LoadProviderTags(ctx, meta),
 			dt.Tags,
 		),
-		Teams:                dt.Teams,
+		Teams:                pmeta.MergeProviderTeams(ctx, meta, dt.Teams),
 		VisualizationOptions: dt.VisualizationOptions,
 		ParentDetectorId:     dt.ParentDetectorId,
 		DetectorOrigin:       dt.DetectorOrigin,
@@ -152,7 +152,7 @@ func resourceUpdate(ctx context.Context, data *schema.ResourceData, meta any) (i
 			pmeta.LoadProviderTags(ctx, meta),
 			dt.Tags,
 		),
-		Teams:                dt.Teams,
+		Teams:                pmeta.MergeProviderTeams(ctx, meta, dt.Teams),
 		VisualizationOptions: dt.VisualizationOptions,
 		ParentDetectorId:     dt.ParentDetectorId,
 		DetectorOrigin:       dt.DetectorOrigin,

internal/definition/provider/provider.go

@@ -108,6 +108,15 @@ func New() *schema.Provider {
 				Optional:    true,
 				Description: "Allows for Tags to be added by default to resources that allow for tags to be included. If there is already tags configured, the global tags are added in prefix.",
 			},
+			"teams": {
+				Type: schema.TypeList,
+				Elem: &schema.Schema{
+					Type:         schema.TypeString,
+					ValidateFunc: validation.StringIsNotEmpty,
+				},
+				Optional:    true,
+				Description: "Allows for teams to be defined at a provider level, and apply to all applicable resources created.",
+			},
 		},
 		ResourcesMap: map[string]*schema.Resource{
 			team.ResourceName:     team.NewResource(),
@@ -126,6 +135,7 @@ func configureProvider(ctx context.Context, data *schema.ResourceData) (any, dia
 		Password:       data.Get("password").(string),
 		OrganizationID: data.Get("organization_id").(string),
 		Tags:           convert.SliceAll(data.Get("tags").([]any), convert.ToString),
+		Teams:          convert.SliceAll(data.Get("teams").([]any), convert.ToString),
 	}
 
 	for _, lookup := range pmeta.NewDefaultProviderLookups() {

internal/definition/provider/provider_test.go

@@ -67,6 +67,7 @@ func TestProviderConfiguration(t *testing.T) {
 				APIURL:       "api.us.signalfx.com",
 				CustomAppURL: "https://app.signalfx.com",
 				Tags:         []string{},
+				Teams:        []string{},
 			},
 			expect: nil,
 		},
@@ -106,6 +107,7 @@ func TestProviderConfiguration(t *testing.T) {
 					"battery",
 					"staple",
 				},
+				Teams: []string{},
 			},
 			expect: nil,
 		},

internal/feature/definitions.go

@@ -0,0 +1,30 @@
+// Copyright Splunk, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package feature
+
+// This file is used to define all the existing feature previews
+// that are currently used within the provider.
+// Having the values defined in one place makes it easier to
+// update and maintain these values.
+// Furthermore, if these are to be used within an autogen script
+// then it does not require loading each individual module
+// which will speed up documentation generation.
+//
+// When defining a new feature preview, it should:
+// - named in terms of scope and and feature
+// 	- ie: `provider.<feature>`, `detectors.<feature>`
+// - Add a description that informs the user of what will happen once enabled.
+// - Set the version added in (this helps sorting oldest previews to newest)
+
+const (
+	PreviewProviderTeams = "provider.teams"
+)
+
+var (
+	_ = GetGlobalRegistry().MustRegister(
+		PreviewProviderTeams,
+		WithPreviewDescription("Allows for team(s) to set at a provider level, and apply to all applicable resources"),
+		WithPreviewAddInVersion("v9.9.1"),
+	)
+)

internal/feature/preview.go

@@ -3,7 +3,12 @@
 
 package feature
 
-import "sync/atomic"
+import (
+	"errors"
+	"sync/atomic"
+
+	tfext "github.com/splunk-terraform/terraform-provider-signalfx/internal/tfextension"
+)
 
 // Preview allows for features to be guarded
 // to allow users to opt in for the new functionality.
@@ -39,6 +44,18 @@ func NewPreview(opts ...PreviewOption) (*Preview, error) {
 	return p, nil
 }
 
+func NewPreviewLogFields(name string, p *Preview) tfext.LogFields {
+	lf := tfext.NewLogFields().Field("feature.name", name)
+	if p != nil {
+		lf = lf.
+			Field("feature.enabled", p.Enabled()).
+			Field("feature.ga", p.GlobalAvailable())
+	} else {
+		lf = lf.Error(errors.New("feature preview is unset"))
+	}
+	return lf
+}
+
 func (p Preview) Enabled() bool {
 	return p.enabled.Load()
 }

internal/feature/preview_test.go

@@ -8,6 +8,8 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	tfext "github.com/splunk-terraform/terraform-provider-signalfx/internal/tfextension"
 )
 
 func TestNewDefaultPreview(t *testing.T) {
@@ -24,3 +26,46 @@ func TestNewDefaultPreview(t *testing.T) {
 	p.SetEnabled(true)
 	assert.True(t, p.Enabled(), "Must be enabled once set")
 }
+
+func TestPreviewLogFields(t *testing.T) {
+	t.Parallel()
+
+	for _, tc := range []struct {
+		name    string
+		preview *Preview
+		expect  tfext.LogFields
+	}{
+		{
+			name:    "no preview set",
+			preview: nil,
+			expect: tfext.LogFields{
+				"feature.name": "feature.example-01",
+				"error":        "feature preview is unset",
+			},
+		},
+		{
+			name: "preview set",
+			preview: func(tb testing.TB) *Preview {
+				p, err := NewPreview()
+				assert.NoError(tb, err, "Must not error creating preview")
+				return p
+			}(t),
+			expect: tfext.LogFields{
+				"feature.name":    "feature.example-01",
+				"feature.ga":      false,
+				"feature.enabled": false,
+			},
+		},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			t.Parallel()
+
+			assert.Equal(
+				t,
+				tc.expect,
+				NewPreviewLogFields("feature.example-01", tc.preview),
+				"Must match the expected values",
+			)
+		})
+	}
+}

internal/providermeta/meta.go

@@ -8,13 +8,15 @@ import (
 	"errors"
 	"net/url"
 	"path"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/signalfx/signalfx-go"
 	"github.com/signalfx/signalfx-go/sessiontoken"
 	"go.uber.org/multierr"
 
+	"github.com/splunk-terraform/terraform-provider-signalfx/internal/common"
 	"github.com/splunk-terraform/terraform-provider-signalfx/internal/feature"
 	tfext "github.com/splunk-terraform/terraform-provider-signalfx/internal/tfextension"
 )
@@ -45,6 +47,7 @@ type Meta struct {
 	Password       string   `json:"password"`
 	OrganizationID string   `json:"org_id"`
 	Tags           []string `json:"tags"`
+	Teams          []string `json:"teams"`
 }
 
 // LoadClient returns the configured [signalfx.Client] ready to use.
@@ -95,7 +98,12 @@ func LoadPreviewRegistry(ctx context.Context, meta any) *feature.Registry {
 //
 // Requires preview to be enabled in order to return values.
 func LoadProviderTags(ctx context.Context, meta any) []string {
-	if g, ok := LoadPreviewRegistry(ctx, meta).Get(previewGlobalTagsKey); ok && !g.Enabled() {
+	if g, ok := LoadPreviewRegistry(ctx, meta).Get(previewGlobalTagsKey); !ok || !g.Enabled() {
+		tflog.Debug(
+			ctx,
+			"Feature Preview is not enabled, using default value",
+			feature.NewPreviewLogFields(feature.PreviewProviderTeams, g),
+		)
 		return nil
 	}
 
@@ -134,6 +142,28 @@ func (m *Meta) LoadSessionToken(ctx context.Context) (string, error) {
 	return resp.AccessToken, nil
 }
 
+// MergeProviderTeams will prepend the provider set teams to the resource level teams.
+//
+// Note: This currently requires the feature preview `feature.PreviewProviderTeam` to be enabled.
+func MergeProviderTeams(ctx context.Context, meta any, teams []string) []string {
+	if g, ok := LoadPreviewRegistry(ctx, meta).Get(feature.PreviewProviderTeams); !ok || !g.Enabled() {
+		tflog.Debug(
+			ctx,
+			"Feature Preview is not enabled, using default value",
+			feature.NewPreviewLogFields(feature.PreviewProviderTeams, g),
+		)
+		return teams
+	}
+
+	os := common.NewOrderedSet[string]()
+	if m, ok := meta.(*Meta); ok {
+		os.Append(m.Teams...)
+	}
+
+	os.Append(teams...)
+	return slices.Collect(os.All())
+}
+
 func (m *Meta) Validate() (errs error) {
 	if m.AuthToken == "" && (m.Email == "" || m.Password == "") {
 		errs = multierr.Append(errs, errors.New("missing auth token or email and password"))

internal/providermeta/meta_test.go

@@ -325,3 +325,58 @@ func TestLoadProviderTags(t *testing.T) {
 		})
 	}
 }
+
+func TestMergeProviderTeams(t *testing.T) {
+	t.Parallel()
+
+	for _, tc := range []struct {
+		name   string
+		meta   any
+		teams  []string
+		expect []string
+	}{
+		{
+			name:   "no details provided",
+			meta:   nil,
+			teams:  nil,
+			expect: nil,
+		},
+		{
+			name: "provide has details, preview not enabled",
+			meta: &Meta{
+				reg: func() *feature.Registry {
+					r := feature.NewRegistry()
+					_ = r.MustRegister(feature.PreviewProviderTeams)
+					return r
+				}(),
+				Teams: []string{"team-00", "team-02", "team-03"},
+			},
+			teams:  []string{"team-01", "team-02"},
+			expect: []string{"team-01", "team-02"},
+		},
+		{
+			name: "provider has details, preview enabled",
+			meta: &Meta{
+				reg: func() *feature.Registry {
+					r := feature.NewRegistry()
+					_ = r.MustRegister(feature.PreviewProviderTeams, feature.WithPreviewGlobalAvailable())
+					return r
+				}(),
+				Teams: []string{"team-00", "team-02", "team-03"},
+			},
+			teams:  []string{"team-01", "team-02"},
+			expect: []string{"team-00", "team-02", "team-03", "team-01"},
+		},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			t.Parallel()
+
+			assert.Equal(
+				t,
+				tc.expect,
+				MergeProviderTeams(t.Context(), tc.meta, tc.teams),
+				"Must match the expected details",
+			)
+		})
+	}
+}

signalfx/provider.go

@@ -122,6 +122,15 @@ func Provider() *schema.Provider {
 				Optional:    true,
 				Description: "Allows for Tags to be added by default to resources that allow for tags to be included. If there is already tags configured, the global tags are added in prefix.",
 			},
+			"teams": {
+				Type: schema.TypeList,
+				Elem: &schema.Schema{
+					Type:         schema.TypeString,
+					ValidateFunc: validation.StringIsNotEmpty,
+				},
+				Optional:    true,
+				Description: "Allows for teams to be defined at a provider level, and apply to all applicable resources created.",
+			},
 		},
 		DataSourcesMap: map[string]*schema.Resource{
 			"signalfx_dimension_values":      dataSourceDimensionValues(),
@@ -172,6 +181,7 @@ func signalfxConfigure(data *schema.ResourceData) (interface{}, error) {
 		Password:       data.Get("password").(string),
 		OrganizationID: data.Get("organization_id").(string),
 		Tags:           convert.SliceAll(data.Get("tags").([]any), convert.ToString),
+		Teams:          convert.SliceAll(data.Get("teams").([]any), convert.ToString),
 	}
 
 	// /etc/signalfx.conf has the lowest priority

signalfx/resource_signalfx_dashboard_group.go

@@ -13,6 +13,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 	dashboard_group "github.com/signalfx/signalfx-go/dashboard_group"
 	"github.com/splunk-terraform/terraform-provider-signalfx/internal/convert"
+	pmeta "github.com/splunk-terraform/terraform-provider-signalfx/internal/providermeta"
 )
 
 func dashboardGroupResource() *schema.Resource {
@@ -408,6 +409,7 @@ func dashboardgroupCreate(d *schema.ResourceData, meta interface{}) error {
 	config := meta.(*signalfxConfig)
 	payload := getPayloadDashboardGroup(d)
 
+	payload.Teams = pmeta.MergeProviderTeams(context.TODO(), meta, payload.Teams)
 	debugOutput, _ := json.Marshal(payload)
 	log.Printf("[DEBUG] SignalFx: Dashboard Group Create Payload: %s", debugOutput)
 
@@ -574,6 +576,7 @@ func dashboardgroupUpdate(d *schema.ResourceData, meta interface{}) error {
 	if err != nil {
 		return fmt.Errorf("failed to get current dashboard list for %s: %v", d.Id(), err)
 	}
+	payload.Teams = pmeta.MergeProviderTeams(context.TODO(), meta, payload.Teams)
 
 	payload.DashboardConfigs = append(payload.DashboardConfigs, nonMirroredDashes...)
 	debugOutput, _ := json.Marshal(payload)

signalfx/resource_signalfx_detector.go

@@ -502,6 +502,12 @@ func detectorCreate(d *schema.ResourceData, meta interface{}) error {
 		payload.Tags,
 	)
 
+	payload.Teams = pmeta.MergeProviderTeams(
+		context.TODO(),
+		meta,
+		payload.Tags,
+	)
+
 	debugOutput, _ := json.Marshal(payload)
 	log.Printf("[DEBUG] SignalFx: Create Detector Payload: %s", string(debugOutput))