-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add
workspace_role datasource (#68)
* workspace_role api interfaces * add http client methods§ * add workspace role datasource * add tf-plugin-testing and related deps * fix filter paramter * acceptance tests for the datasource * linting
- Loading branch information
1 parent
b86c496
commit 40eb98b
Showing
9 changed files
with
648 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/google/uuid" | ||
| ) | ||
|
|
||
| type WorkspaceRolesClient interface { | ||
| Create(ctx context.Context, data WorkspaceRoleUpsert) (*WorkspaceRole, error) | ||
| Update(ctx context.Context, id uuid.UUID, data WorkspaceRoleUpsert) error | ||
| Delete(ctx context.Context, id uuid.UUID) error | ||
| List(ctx context.Context, roleNames []string) ([]*WorkspaceRole, error) | ||
| Get(ctx context.Context, id uuid.UUID) (*WorkspaceRole, error) | ||
| } | ||
|
|
||
| // WorkspaceRole is a representation of a workspace role. | ||
| type WorkspaceRole struct { | ||
| BaseModel | ||
| Name string `json:"name"` | ||
| Description *string `json:"description"` | ||
| Permissions []string `json:"permissions"` | ||
| Scopes []string `json:"scopes"` | ||
| AccountID *uuid.UUID `json:"account_id"` // this is null for the default roles | ||
| InheritedRoleID *uuid.UUID `json:"inherited_role_id"` | ||
| } | ||
|
|
||
| // WorkspaceRoleUpsert defines the request payload | ||
| // when creating or updating a workspace role. | ||
| type WorkspaceRoleUpsert struct { | ||
| Name string `json:"name"` | ||
| Description *string `json:"description"` | ||
| Scopes []string `json:"scopes"` | ||
| InheritedRoleID *uuid.UUID `json:"inherited_role_id"` | ||
| } | ||
|
|
||
| // WorkspaceRoleFilter defines the search filter payload | ||
| // when searching for workspace roles by name. | ||
| // example request payload: | ||
| // {"workspace_roles": {"name": {"any_": ["test"]}}}. | ||
| type WorkspaceRoleFilter struct { | ||
| WorkspaceRoles struct { | ||
| Name struct { | ||
| Any []string `json:"any_"` | ||
| } `json:"name"` | ||
| } `json:"workspace_roles"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| package client | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "net/http" | ||
|
|
||
| "github.com/google/uuid" | ||
| "github.com/prefecthq/terraform-provider-prefect/internal/api" | ||
| ) | ||
|
|
||
| // type assertion ensures that this client implements the interface. | ||
| var _ = api.WorkspaceRolesClient(&WorkspaceRolesClient{}) | ||
|
|
||
| type WorkspaceRolesClient struct { | ||
| hc *http.Client | ||
| apiKey string | ||
| routePrefix string | ||
| } | ||
|
|
||
| // WorkspaceRoles is a factory that initializes and returns a WorkspaceRolesClient. | ||
| // | ||
| //nolint:ireturn // required to support PrefectClient mocking | ||
| func (c *Client) WorkspaceRoles(accountID uuid.UUID) (api.WorkspaceRolesClient, error) { | ||
| if accountID == uuid.Nil { | ||
| accountID = c.defaultAccountID | ||
| } | ||
|
|
||
| return &WorkspaceRolesClient{ | ||
| hc: c.hc, | ||
| apiKey: c.apiKey, | ||
| routePrefix: fmt.Sprintf("%s/api/accounts/%s/workspace_roles", c.endpoint, accountID.String()), | ||
| }, nil | ||
| } | ||
|
|
||
| // Create creates a new workspace role. | ||
| func (c *WorkspaceRolesClient) Create(ctx context.Context, data api.WorkspaceRoleUpsert) (*api.WorkspaceRole, error) { | ||
| var buf bytes.Buffer | ||
| if err := json.NewEncoder(&buf).Encode(&data); err != nil { | ||
| return nil, fmt.Errorf("failed to encode create payload data: %w", err) | ||
| } | ||
|
|
||
| req, err := http.NewRequestWithContext(ctx, http.MethodPost, fmt.Sprintf("%s/", c.routePrefix), &buf) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error creating request: %w", err) | ||
| } | ||
|
|
||
| setDefaultHeaders(req, c.apiKey) | ||
|
|
||
| resp, err := c.hc.Do(req) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("http error: %w", err) | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| if resp.StatusCode != http.StatusCreated { | ||
| return nil, fmt.Errorf("status code %s", resp.Status) | ||
| } | ||
|
|
||
| var workspaceRole api.WorkspaceRole | ||
| if err := json.NewDecoder(resp.Body).Decode(&workspaceRole); err != nil { | ||
| return nil, fmt.Errorf("failed to decode response: %w", err) | ||
| } | ||
|
|
||
| return &workspaceRole, nil | ||
| } | ||
|
|
||
| // Update modifies an existing workspace role by ID. | ||
| func (c *WorkspaceRolesClient) Update(ctx context.Context, workspaceRoleID uuid.UUID, data api.WorkspaceRoleUpsert) error { | ||
| var buf bytes.Buffer | ||
| if err := json.NewEncoder(&buf).Encode(&data); err != nil { | ||
| return fmt.Errorf("failed to encode update payload data: %w", err) | ||
| } | ||
|
|
||
| req, err := http.NewRequestWithContext(ctx, http.MethodPatch, fmt.Sprintf("%s/%s", c.routePrefix, workspaceRoleID.String()), &buf) | ||
| if err != nil { | ||
| return fmt.Errorf("error creating request: %w", err) | ||
| } | ||
|
|
||
| setDefaultHeaders(req, c.apiKey) | ||
|
|
||
| resp, err := c.hc.Do(req) | ||
| if err != nil { | ||
| return fmt.Errorf("http error: %w", err) | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| if resp.StatusCode != http.StatusNoContent { | ||
| return fmt.Errorf("status code %s", resp.Status) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // Delete removes a workspace role by ID. | ||
| func (c *WorkspaceRolesClient) Delete(ctx context.Context, id uuid.UUID) error { | ||
| req, err := http.NewRequestWithContext(ctx, http.MethodDelete, fmt.Sprintf("%s/%s", c.routePrefix, id.String()), http.NoBody) | ||
| if err != nil { | ||
| return fmt.Errorf("error creating request: %w", err) | ||
| } | ||
|
|
||
| setDefaultHeaders(req, c.apiKey) | ||
|
|
||
| resp, err := c.hc.Do(req) | ||
| if err != nil { | ||
| return fmt.Errorf("http error: %w", err) | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| if resp.StatusCode != http.StatusNoContent { | ||
| return fmt.Errorf("status code %s", resp.Status) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // List returns a list of workspace roles, based on the provided filter. | ||
| func (c *WorkspaceRolesClient) List(ctx context.Context, roleNames []string) ([]*api.WorkspaceRole, error) { | ||
| var buf bytes.Buffer | ||
| filterQuery := api.WorkspaceRoleFilter{} | ||
| filterQuery.WorkspaceRoles.Name.Any = roleNames | ||
|
|
||
| if err := json.NewEncoder(&buf).Encode(&filterQuery); err != nil { | ||
| return nil, fmt.Errorf("failed to encode filter payload data: %w", err) | ||
| } | ||
|
|
||
| req, err := http.NewRequestWithContext(ctx, http.MethodPost, fmt.Sprintf("%s/filter", c.routePrefix), &buf) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error creating request: %w", err) | ||
| } | ||
|
|
||
| setDefaultHeaders(req, c.apiKey) | ||
|
|
||
| resp, err := c.hc.Do(req) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("http error: %w", err) | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| if resp.StatusCode != http.StatusOK { | ||
| return nil, fmt.Errorf("status code %s", resp.Status) | ||
| } | ||
|
|
||
| var workspaceRoles []*api.WorkspaceRole | ||
| if err := json.NewDecoder(resp.Body).Decode(&workspaceRoles); err != nil { | ||
| return nil, fmt.Errorf("failed to decode response: %w", err) | ||
| } | ||
|
|
||
| return workspaceRoles, nil | ||
| } | ||
|
|
||
| // Get returns a workspace role by ID. | ||
| func (c *WorkspaceRolesClient) Get(ctx context.Context, id uuid.UUID) (*api.WorkspaceRole, error) { | ||
| req, err := http.NewRequestWithContext(ctx, http.MethodGet, fmt.Sprintf("%s/%s", c.routePrefix, id.String()), http.NoBody) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error creating request: %w", err) | ||
| } | ||
|
|
||
| setDefaultHeaders(req, c.apiKey) | ||
|
|
||
| resp, err := c.hc.Do(req) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("http error: %w", err) | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| if resp.StatusCode != http.StatusOK { | ||
| return nil, fmt.Errorf("status code %s", resp.Status) | ||
| } | ||
|
|
||
| var workspaceRole api.WorkspaceRole | ||
| if err := json.NewDecoder(resp.Body).Decode(&workspaceRole); err != nil { | ||
| return nil, fmt.Errorf("failed to decode response: %w", err) | ||
| } | ||
|
|
||
| return &workspaceRole, nil | ||
| } |
Oops, something went wrong.