New datasource: tfe_oauth_client #212

koikonom · 2020-09-03T13:59:38Z

Description

This is a new datasource that allows users to extract information from
existing oauth clients.

Output from acceptance tests

❯ TESTARGS='-run TestAccTFEOAuthClientDataSource_basic' make testacc
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test $(go list ./... |grep -v 'vendor') -v -run TestAccTFEOAuthClientDataSource_basic -timeout 15m
?       github.com/terraform-providers/terraform-provider-tfe   [no test files]
=== RUN   TestAccTFEOAuthClientDataSource_basic
--- PASS: TestAccTFEOAuthClientDataSource_basic (29.90s)
PASS
ok      github.com/terraform-providers/terraform-provider-tfe/tfe       30.846s
?       github.com/terraform-providers/terraform-provider-tfe/version   [no test files]

This is a new datasource that allows users to extract information from existing oauth clients.

koikonom · 2020-09-03T14:55:37Z

Closes #10

lafentres

i'm working on getting a local build of this set up but wanted to get you my code review part sooner rather than later :]
everything looks good! just some minor comments on style/naming and some typo fixes

lafentres · 2020-09-08T15:48:51Z

tfe/data_source_oauth_client.go

+		return fmt.Errorf("Error retrieving OAuth client: %v", err)
+	}
+
+	tokenID := oc.OAuthTokens[0].ID


do you think it is worth handling this case the way we do in the resource? in case the oauth client doesn't have an oauth token yet?

like this: https://github.com/terraform-providers/terraform-provider-tfe/blob/master/tfe/resource_tfe_oauth_client.go#L130

can confirm that we need to handle this similar to how we handle it in the resource. this panics if you give it the oauth client id of an unfinished client (so a client that doesn't have an oauth token yet)

Thanks for the hint!

tfe/data_source_oauth_client.go

website/docs/d/oauth_client.html.markdown

website/tfe.erb

tfe/provider.go

tfe/data_source_oauth_client_test.go

lafentres · 2020-09-08T16:12:20Z

tfe/data_source_oauth_client.go

+}
+
+func dataSourceTFEOAuthClientRead(d *schema.ResourceData, meta interface{}) error {
+	ctx := context.TODO()


just a question for my own learning: i've never seen this before. i read about it in the docs and it makes sense. is this something we should be doing in all of our resources/data sources that have a blank/empty context?

I created an empty context because I needed one to pass to the tfe client.

Perhaps in the long run we could (should?) revisit the codebase and set a context with a timeout (https://godoc.org/context#WithTimeout).

Co-authored-by: Krista LaFentres <[email protected]>

lafentres · 2020-09-10T14:02:56Z

tfe/data_source_oauth_client.go

+			"ssh_key": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},


i totally missed this when i was looking at this before but this is always going to be blank unless the oauth client is bitbucket server. it would be fine to leave it in but i think we should rename it to match go-tfe and the api response which is rsa public key.
if you end up leaving this in, it would be good to note that this is only available on bitbucket server oauth clients.

Suggested change

"ssh_key": {

Type: schema.TypeString,

Computed: true,

},

"rsa_public_key": {

Type: schema.TypeString,

Computed: true,

},

i've confirmed that the rsa_public_key is only every populated for bitbucket server connections and isn't something that would be useful so it can just be removed.

lafentres · 2020-09-10T14:06:14Z

website/tfe.erb

@@ -13,6 +13,9 @@
                <li<%= sidebar_current("docs-tfe-datasource") %>>
                    <a href="#">Data Sources</a>
                    <ul class="nav nav-visible">
+                        <li<%= sidebar_current("docs-datasource-tfe-oauth-client") %>>


i think this might need the -x at the end to match the sidebar_current value in the website/docs/d/oauth_client.html.markdown file. i think this might not work as expected otherwise.
you could also just remove the -x from the sidebar_current value in the website/docs/d/oauth_client.html.markdown file i think.

lafentres

this looks good to me! once the ssh_key/rsa_public_key is removed and the docs sidebar typo is fixed this should be good to go.

SSH key is only used for Bitbucket VCS connection and we don't really need it exposed. ... also minor doc fix.

New datasource: tfe_oauth_client

acedff3

This is a new datasource that allows users to extract information from existing oauth clients.

koikonom requested review from caseylang and lafentres September 3, 2020 13:59

ghost added the size/M label Sep 3, 2020

Updating Changelog and adding docs

fc76018

ghost added the documentation label Sep 3, 2020

lafentres reviewed Sep 8, 2020

View reviewed changes

koikonom and others added 7 commits September 9, 2020 19:12

Rename field and reorder

a2fdaa8

Co-authored-by: Krista LaFentres <[email protected]>

rename field

a02447a

Co-authored-by: Krista LaFentres <[email protected]>

Fix typo in docs.

24ff6e9

Co-authored-by: Krista LaFentres <[email protected]>

rename field

e035714

Co-authored-by: Krista LaFentres <[email protected]>

Handle clients without tokens

c8ee172

sort datasource names alphabetically

9cc8edb

rearrange doc sections alphabetically

8918339

ghost added size/L and removed size/M labels Sep 9, 2020

koikonom requested a review from lafentres September 9, 2020 18:24

Add http_client attribute to schema

175f552

lafentres reviewed Sep 10, 2020

View reviewed changes

lafentres approved these changes Sep 10, 2020

View reviewed changes

Remove unnecessary datasource attribute

a77037d

SSH key is only used for Bitbucket VCS connection and we don't really need it exposed. ... also minor doc fix.

koikonom merged commit e0824ae into master Sep 23, 2020

chrisarcand mentioned this pull request Dec 5, 2020

Oauth Token Data Source would be very helpful #10

Closed

annawinkler deleted the oauth_client_datasource branch August 10, 2022 16:27

annawinkler mentioned this pull request Oct 5, 2022

[Feature Request] tfe_oauth_client: import resource and data source #203

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New datasource: tfe_oauth_client #212

New datasource: tfe_oauth_client #212

koikonom commented Sep 3, 2020

koikonom commented Sep 3, 2020

lafentres left a comment •

edited

Loading

lafentres Sep 8, 2020

lafentres Sep 8, 2020

koikonom Sep 9, 2020

lafentres Sep 8, 2020

koikonom Sep 9, 2020

lafentres Sep 10, 2020

lafentres Sep 10, 2020

lafentres Sep 10, 2020 •

edited

Loading

lafentres left a comment

New datasource: tfe_oauth_client #212

New datasource: tfe_oauth_client #212

Conversation

koikonom commented Sep 3, 2020

Description

Output from acceptance tests

koikonom commented Sep 3, 2020

lafentres left a comment • edited Loading

Choose a reason for hiding this comment

lafentres Sep 8, 2020

Choose a reason for hiding this comment

lafentres Sep 8, 2020

Choose a reason for hiding this comment

koikonom Sep 9, 2020

Choose a reason for hiding this comment

lafentres Sep 8, 2020

Choose a reason for hiding this comment

koikonom Sep 9, 2020

Choose a reason for hiding this comment

lafentres Sep 10, 2020

Choose a reason for hiding this comment

lafentres Sep 10, 2020

Choose a reason for hiding this comment

lafentres Sep 10, 2020 • edited Loading

Choose a reason for hiding this comment

lafentres left a comment

Choose a reason for hiding this comment

lafentres left a comment •

edited

Loading

lafentres Sep 10, 2020 •

edited

Loading