Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new datasource: sentry_all_organization_members #496

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/data-sources/all_organization_members.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "sentry_all_organization_members Data Source - terraform-provider-sentry"
subcategory: ""
description: |-
Retrieve all organization members.
---

# sentry_all_organization_members (Data Source)

Retrieve all organization members.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `organization` (String) The slug of the organization.

### Read-Only

- `members` (Attributes Set) The list of members. (see [below for nested schema](#nestedatt--members))

<a id="nestedatt--members"></a>
### Nested Schema for `members`

Read-Only:

- `email` (String) The email of the organization member.
- `id` (String) The ID of of the organization member.
- `role` (String) This is the role of the organization member.
128 changes: 128 additions & 0 deletions internal/provider/data_source_all_organization_members.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
package provider

import (
"context"
"fmt"

"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/jianyuan/go-sentry/v2/sentry"
)

var _ datasource.DataSource = &AllOrganizationMembersDataSource{}
var _ datasource.DataSourceWithConfigure = &OrganizationMemberDataSource{}

func NewAllOrganizationMembersDataSource() datasource.DataSource {
return &AllOrganizationMembersDataSource{}
}

type AllOrganizationMembersDataSource struct {
baseDataSource
}

type AllOrganizationMembersDataSourceMemberModel struct {
Id types.String `tfsdk:"id"`
Email types.String `tfsdk:"email"`
Role types.String `tfsdk:"role"`
}

func (m *AllOrganizationMembersDataSourceMemberModel) Fill(organization string, member sentry.OrganizationMember) error {
m.Id = types.StringValue(member.ID)
m.Email = types.StringValue(member.Email)
m.Role = types.StringValue(member.OrgRole)

return nil
}

type AllOrganizationMembersDataSourceModel struct {
Organization types.String `tfsdk:"organization"`
Members []AllOrganizationMembersDataSourceMemberModel `tfsdk:"members"`
}

func (m *AllOrganizationMembersDataSourceModel) Fill(organization string, members []sentry.OrganizationMember) error {
m.Organization = types.StringValue(organization)

for _, member := range members {
mm := AllOrganizationMembersDataSourceMemberModel{}
if err := mm.Fill(organization, member); err != nil {
return err
}
m.Members = append(m.Members, mm)
}

return nil
}

func (d *AllOrganizationMembersDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_all_organization_members"
}

func (d *AllOrganizationMembersDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: "Retrieve all organization members.",

Attributes: map[string]schema.Attribute{
"organization": schema.StringAttribute{
MarkdownDescription: "The slug of the organization.",
Required: true,
},
"members": schema.SetNestedAttribute{
MarkdownDescription: "The list of members.",
Computed: true,
NestedObject: schema.NestedAttributeObject{
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
MarkdownDescription: "The ID of of the organization member.",
Computed: true,
},
"email": schema.StringAttribute{
MarkdownDescription: "The email of the organization member.",
Computed: true,
},
"role": schema.StringAttribute{
MarkdownDescription: "This is the role of the organization member.",
Computed: true,
},
},
},
},
},
}
}

func (d *AllOrganizationMembersDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
var data AllOrganizationMembersDataSourceModel

resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}

var allMembers []sentry.OrganizationMember
params := &sentry.ListCursorParams{}

for {
members, apiResp, err := d.client.OrganizationMembers.List(ctx, data.Organization.ValueString(), params)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to list organization members, got error: %s", err))
return
}

for _, member := range members {
allMembers = append(allMembers, *member)
}

if apiResp.Cursor == "" {
break
}
params.Cursor = apiResp.Cursor
}

if err := data.Fill(data.Organization.ValueString(), allMembers); err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Fill error: %s", err))
return
}

resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}
55 changes: 55 additions & 0 deletions internal/provider/data_source_all_organization_members_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package provider

import (
"fmt"
"regexp"
"testing"

"github.com/hashicorp/terraform-plugin-testing/helper/resource"
"github.com/hashicorp/terraform-plugin-testing/knownvalue"
"github.com/hashicorp/terraform-plugin-testing/statecheck"
"github.com/hashicorp/terraform-plugin-testing/tfjsonpath"
"github.com/jianyuan/terraform-provider-sentry/internal/acctest"
)

func TestAccAllOrganizationMembersDataSource(t *testing.T) {
rn := "data.sentry_all_organization_members.test"
email := acctest.RandomWithPrefix("tf-member") + "@example.com"
role := "member"

resource.Test(t, resource.TestCase{
PreCheck: func() { acctest.PreCheck(t) },
ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
Steps: []resource.TestStep{
{
Config: testAccAllOrganizationMembersConfig(email, role),
ConfigStateChecks: []statecheck.StateCheck{
statecheck.ExpectKnownValue(rn, tfjsonpath.New("organization"), knownvalue.StringExact(acctest.TestOrganization)),
statecheck.ExpectKnownValue(rn, tfjsonpath.New("members"), knownvalue.SetPartial([]knownvalue.Check{
knownvalue.ObjectExact(map[string]knownvalue.Check{
"id": knownvalue.StringRegexp(regexp.MustCompile(`^\d+$`)),
"email": knownvalue.StringExact(email),
"role": knownvalue.StringExact(role),
}),
})),
},
},
},
})
}

func testAccAllOrganizationMembersConfig(email string, role string) string {
return testAccOrganizationDataSourceConfig + fmt.Sprintf(`
resource "sentry_organization_member" "test" {
organization = data.sentry_organization.test.id
email = "%[1]s"
role = "%[2]s"
}

data "sentry_all_organization_members" "test" {
organization = data.sentry_organization.test.id

depends_on = [sentry_organization_member.test]
}
`, email, role)
}
1 change: 1 addition & 0 deletions internal/provider/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ func (p *SentryProvider) DataSources(ctx context.Context) []func() datasource.Da
return []func() datasource.DataSource{
NewAllClientKeysDataSource,
NewAllProjectsDataSource,
NewAllOrganizationMembersDataSource,
NewClientKeyDataSource,
NewIssueAlertDataSource,
NewOrganizationDataSource,
Expand Down
Loading