project relationship (#806)

added the project relationship and the post/delete support

removed include

changelog

read with options

generate mocks

readWithOptions test

Update CHANGELOG.md

rename

Co-authored-by: Netra Mali <[email protected]>

Author: Netra2104

CHANGELOG.md

@@ -16,6 +16,10 @@
 ## Bug Fixes
 * Fixes an issue where the request body is not preserved during certain retry scenarios by @sebasslash [#813](https://github.com/hashicorp/go-tfe/pull/813)
 
+## Enhancements
+* Added BETA support for including `projects` relationship to oauth_client on create by @Netra2104 [#806](https://github.com/hashicorp/go-tfe/pull/806)
+* Added BETA method `AddProjects` and `RemoveProjects` for attaching/detaching oauth_client to projects by Netra2104 [#806](https://github.com/hashicorp/go-tfe/pull/806)
+
 # v1.39.0
 
 ## Features

helper_test.go

@@ -892,7 +892,7 @@ func createUploadedPolicyWithOptions(t *testing.T, client *Client, pass bool, or
 	}
 }
 
-func createOAuthClient(t *testing.T, client *Client, org *Organization) (*OAuthClient, func()) {
+func createOAuthClient(t *testing.T, client *Client, org *Organization, projects []*Project) (*OAuthClient, func()) {
 	var orgCleanup func()
 
 	if org == nil {
@@ -909,6 +909,7 @@ func createOAuthClient(t *testing.T, client *Client, org *Organization) (*OAuthC
 		HTTPURL:         String("https://github.com"),
 		OAuthToken:      String(githubToken),
 		ServiceProvider: ServiceProvider(ServiceProviderGithub),
+		Projects:        projects,
 	}
 
 	ctx := context.Background()
@@ -934,7 +935,7 @@ func createOAuthClient(t *testing.T, client *Client, org *Organization) (*OAuthC
 }
 
 func createOAuthToken(t *testing.T, client *Client, org *Organization) (*OAuthToken, func()) {
-	ocTest, ocTestCleanup := createOAuthClient(t, client, org)
+	ocTest, ocTestCleanup := createOAuthClient(t, client, org, nil)
 	return ocTest.OAuthTokens[0], ocTestCleanup
 }
 

mocks/oauth_client_mocks.go

@@ -28,11 +28,20 @@ type OAuthClients interface {
 	// Read an OAuth client by its ID.
 	Read(ctx context.Context, oAuthClientID string) (*OAuthClient, error)
 
+	// ReadWithOptions reads an oauth client by its ID using the options supplied.
+	ReadWithOptions(ctx context.Context, oAuthClientID string, options *OAuthClientReadOptions) (*OAuthClient, error)
+
 	// Update an existing OAuth client by its ID.
 	Update(ctx context.Context, oAuthClientID string, options OAuthClientUpdateOptions) (*OAuthClient, error)
 
 	// Delete an OAuth client by its ID.
 	Delete(ctx context.Context, oAuthClientID string) error
+
+	// AddProjects add projects to an oauth client.
+	AddProjects(ctx context.Context, oAuthClientID string, options OAuthClientAddProjectsOptions) error
+
+	// RemoveProjects remove projects from an oauth client.
+	RemoveProjects(ctx context.Context, oAuthClientID string, options OAuthClientRemoveProjectsOptions) error
 }
 
 // oAuthClients implements OAuthClients.
@@ -86,12 +95,18 @@ type OAuthClient struct {
 	// Relations
 	Organization *Organization `jsonapi:"relation,organization"`
 	OAuthTokens  []*OAuthToken `jsonapi:"relation,oauth-tokens"`
+	// **Note: This field is still in BETA and subject to change.**
+	// The projects to which the oauth client applies.
+	Projects []*Project `jsonapi:"relation,projects"`
 }
 
 // A list of relations to include
 type OAuthClientIncludeOpt string
 
-const OauthClientOauthTokens OAuthClientIncludeOpt = "oauth_tokens"
+const (
+	OauthClientOauthTokens OAuthClientIncludeOpt = "oauth_tokens"
+	OauthClientProjects    OAuthClientIncludeOpt = "projects"
+)
 
 // OAuthClientListOptions represents the options for listing
 // OAuth clients.
@@ -101,6 +116,15 @@ type OAuthClientListOptions struct {
 	Include []OAuthClientIncludeOpt `url:"include,omitempty"`
 }
 
+// OAuthClientReadOptions are read options.
+// For a full list of relations, please see:
+// https://developer.hashicorp.com/terraform/cloud-docs/api-docs/oauth-clients#relationships
+type OAuthClientReadOptions struct {
+	// Optional: A list of relations to include. See available resources
+	// https://developer.hashicorp.com/terraform/cloud-docs/api-docs/oauth-clients#available-related-resources
+	Include []OAuthClientIncludeOpt `url:"include,omitempty"`
+}
+
 // OAuthClientCreateOptions represents the options for creating an OAuth client.
 type OAuthClientCreateOptions struct {
 	// Type is a public field utilized by JSON:API to
@@ -124,6 +148,10 @@ type OAuthClientCreateOptions struct {
 	// Optional: The token string you were given by your VCS provider.
 	OAuthToken *string `jsonapi:"attr,oauth-token-string,omitempty"`
 
+	// **Note: This field is still in BETA and subject to change.**
+	// Optional: The initial list of projects for which the oauth client should be associated with.
+	Projects []*Project `jsonapi:"relation,projects,omitempty"`
+
 	// Optional: Private key associated with this vcs provider - only available for ado_server
 	PrivateKey *string `jsonapi:"attr,private-key,omitempty"`
 
@@ -173,6 +201,20 @@ type OAuthClientUpdateOptions struct {
 	OrganizationScoped *bool `jsonapi:"attr,organization-scoped,omitempty"`
 }
 
+// OAuthClientAddProjectsOptions represents the options for adding projects
+// to an oauth client.
+type OAuthClientAddProjectsOptions struct {
+	// The projects to add to an oauth client.
+	Projects []*Project
+}
+
+// OAuthClientRemoveProjectsOptions represents the options for removing
+// projects from an oauth client.
+type OAuthClientRemoveProjectsOptions struct {
+	// The projects to remove from an oauth client.
+	Projects []*Project
+}
+
 // List all the OAuth clients for a given organization.
 func (s *oAuthClients) List(ctx context.Context, organization string, options *OAuthClientListOptions) (*OAuthClientList, error) {
 	if !validStringID(&organization) {
@@ -223,12 +265,19 @@ func (s *oAuthClients) Create(ctx context.Context, organization string, options
 
 // Read an OAuth client by its ID.
 func (s *oAuthClients) Read(ctx context.Context, oAuthClientID string) (*OAuthClient, error) {
+	return s.ReadWithOptions(ctx, oAuthClientID, nil)
+}
+
+func (s *oAuthClients) ReadWithOptions(ctx context.Context, oAuthClientID string, options *OAuthClientReadOptions) (*OAuthClient, error) {
 	if !validStringID(&oAuthClientID) {
 		return nil, ErrInvalidOauthClientID
 	}
+	if err := options.valid(); err != nil {
+		return nil, err
+	}
 
 	u := fmt.Sprintf("oauth-clients/%s", url.QueryEscape(oAuthClientID))
-	req, err := s.client.NewRequest("GET", u, nil)
+	req, err := s.client.NewRequest("GET", u, options)
 	if err != nil {
 		return nil, err
 	}
@@ -300,3 +349,63 @@ func (o OAuthClientCreateOptions) valid() error {
 func (o *OAuthClientListOptions) valid() error {
 	return nil
 }
+
+// AddProjects adds projects to a given oauth client.
+func (s *oAuthClients) AddProjects(ctx context.Context, oAuthClientID string, options OAuthClientAddProjectsOptions) error {
+	if !validStringID(&oAuthClientID) {
+		return ErrInvalidOauthClientID
+	}
+	if err := options.valid(); err != nil {
+		return err
+	}
+
+	u := fmt.Sprintf("oauth-clients/%s/relationships/projects", url.QueryEscape(oAuthClientID))
+	req, err := s.client.NewRequest("POST", u, options.Projects)
+	if err != nil {
+		return err
+	}
+
+	return req.Do(ctx, nil)
+}
+
+// RemoveProjects removes projects from an oauth client.
+func (s *oAuthClients) RemoveProjects(ctx context.Context, oAuthClientID string, options OAuthClientRemoveProjectsOptions) error {
+	if !validStringID(&oAuthClientID) {
+		return ErrInvalidOauthClientID
+	}
+	if err := options.valid(); err != nil {
+		return err
+	}
+
+	u := fmt.Sprintf("oauth-clients/%s/relationships/projects", url.QueryEscape(oAuthClientID))
+	req, err := s.client.NewRequest("DELETE", u, options.Projects)
+	if err != nil {
+		return err
+	}
+
+	return req.Do(ctx, nil)
+}
+
+func (o OAuthClientAddProjectsOptions) valid() error {
+	if o.Projects == nil {
+		return ErrRequiredProject
+	}
+	if len(o.Projects) == 0 {
+		return ErrProjectMinLimit
+	}
+	return nil
+}
+
+func (o OAuthClientRemoveProjectsOptions) valid() error {
+	if o.Projects == nil {
+		return ErrRequiredProject
+	}
+	if len(o.Projects) == 0 {
+		return ErrProjectMinLimit
+	}
+	return nil
+}
+
+func (o *OAuthClientReadOptions) valid() error {
+	return nil
+}