Add support for Platform TLS #154

shreddedbacon · 2020-04-15T07:34:36Z

Looking to add support for Platform TLS

For the test process described here, I wasn't sure how to actually do this with Platform TLS.
I don't appear have the ability to create new TLS configuration IDs to have one to use as a dummy, and I am unsure if doing anything here will have any cost implications.

supress lint, fix some names format the fixtures body properly according to a real test request minor fix

fastly/platform_tls.go

Co-Authored-By: Geoff Schorkopf <[email protected]>

phamann

Hi @shreddedbacon, thank you for contributing this we really appreciate it.

Apologies for the large amount of requested changes, however you'll see that they all relate to the JSONAPI response format of this API and not problems with your code and should be easy to tweak.

I've only done a partial review of the PrivateKey endpoints and have left the bulk cert methods, as most of my comments apply to both implementations. Let me know once you've had a chance to refactor or have any questions.

Thanks!

fastly/platform_tls.go

shreddedbacon · 2020-04-22T12:50:38Z

Brilliant, thanks. I will work through this and let you know when ready.

shreddedbacon · 2020-04-23T03:18:43Z

Hi @phamann. I've adjusted my code to use the jsonapi style format as requested.
Hopefully I've got everything correct.
Thanks!

scheying · 2020-04-23T07:20:10Z

Hey guys! Great to see progress on the TLS API. I have been working on the "Non-Platform" TLS part and from what I see the Private Keys API is the same for "Regular TLS" and "Platform TLS". Would it make sense to give the key-related functions neutral names like GetPrivateKey instead of GetPlatformPrivateKey and move all the key related functionality to a separate file?

If you like I could throw in my implementation of exactly that and a bit of JSONAPI paging and filtering on top. But I also don't want to get in the way of what you already did @shreddedbacon .

shreddedbacon · 2020-04-23T07:32:09Z

Hey guys! Great to see progress on the TLS API. I have been working on the "Non-Platform" TLS part and from what I see the Private Keys API is the same for "Regular TLS" and "Platform TLS". Would it make sense to give the key-related functions neutral names like GetPrivateKey instead of GetPlatformPrivateKey and move all the key related functionality to a separate file?

If you like I could throw in my implementation of exactly that and a bit of JSONAPI paging and filtering on top. But I also don't want to get in the way of what you already did @shreddedbacon .

I didn't know they were different. In that case it makes sense to name them a neutral name, in their own file. I'm happy to adjust my PR as I'm also currently using my branch to build out an operator for our platform.

How far along is your work on "Regular TLS" @scheying ?

phamann

Thanks for the speedy changes to this, @shreddedbacon, I appreciate your patience here. It's looking much better! Most of my comments are minor comment style changes, some small copy/pasta errors and a question around using pointers for the pagination input structs.

My last major change request would be to update the tests to be more inline with the style we use in the package. Which would be: one TestClient_PlatformPrivateKey function which creates a key (defers its deletion) then uses that to perform the other operations (list, update, delete), with each operation assert the properties or length returned are valid. We also have seperate functions to test the validations. An example of this style can be found in some of the recent PRs, such as users: https://github.com/fastly/go-fastly/blob/master/fastly/user_test.go#L19-L133

Hope that helps. After this last change set, we should be good to merge!

fastly/platform_tls.go

phamann · 2020-04-23T08:06:54Z

Would it make sense to give the key-related functions neutral names like GetPrivateKey instead of GetPlatformPrivateKey and move all the key related functionality to a separate file?

@scheying This is a great question and in theory makes sense to me. I'm afraid that I'm not an internal SME (subject-matter-expert) on our TLS APIs, so will get someone on that team to have a look and share their thoughts here.

shreddedbacon · 2020-04-23T08:07:42Z

Thanks for the speedy changes to this, @shreddedbacon, I appreciate your patience here. It's looking much better! Most of my comments are minor comment style changes, some small copy/pasta errors and a question around using pointers for the pagination input structs.

My last major change request would be to update the tests to be more inline with the style we use in the package. Which would be: one TestClient_PlatformPrivateKey function which creates a key (defers its deletion) then uses that to perform the other operations (list, update, delete), with each operation assert the properties or length returned are valid. We also have seperate functions to test the validations. An example of this style can be found in some of the recent PRs, such as users: https://github.com/fastly/go-fastly/blob/master/fastly/user_test.go#L19-L133

Hope that helps. After this last change set, we should be good to merge!

No problem at all. Thanks for your patience.
I was mainly using existing code to try and find how things were styled, but I guess it has changed over time.

Will adjust again!

…atform-tls, added additional tests to suit test styling and additional description updates

…lter actually work

phamann

👍 LGTM

Thank you for all of your work and promptness on this PR @shreddedbacon really appreciated. I'll double check that the TLS team are happy, but should get it merged and released ASAP.

shreddedbacon · 2020-04-23T12:30:47Z

Hi again @phamann
I've made adjustments but just want to check with you on something as I couldn't see it on any other Get requests.

For the filters to actually work, I had to add the header

Headers: map[string]string{
  "Accept": "application/vnd.api+json",
}

As described in the API documentation https://docs.fastly.com/api/platform-tls#tls_bulk_certificates_81cc5acbf847f71ecd4068ed58bfc5c5

When I remove this header, the filter no longer works. Is there something I'm missing here? I noticed a few other functions use filters and have the same Accept heading requirement in the API, but yet they haven't had to define the header for this.

phamann · 2020-04-23T12:37:51Z

For the filters to actually work, I had to add the header. When I remove this header, the filter no longer works. Is there something I'm missing here?

@shreddedbacon You're not missing anything here. This is another nuance of our JSONAPI API requests and not your implementation. For those requests you are using the client.Get() helper which is intended for plain HTTP requests and has no knowledge about JSONAPI. It would be better if we had a GetJSONAPI() helper as per the other methods PutJSONAPI etc (which I've just realised we don't have...) and that would internally call RequestJSONAPI which sets the correct Accept and Content-Type JSONAPI header values.

shreddedbacon · 2020-04-23T12:39:41Z

Awesome. Thanks for smashing through this with me, appreciate it!

thommahoney

This is really great; thank you so much for your contribution to this library!

thommahoney · 2020-04-23T15:29:38Z

fastly/platform_tls.go

+	// `tls_domains.id` filter seems to work where `tls_domain.id` does not, documentation wrong?
+	// https://docs.fastly.com/api/platform-tls#tls_bulk_certificates_81cc5acbf847f71ecd4068ed58bfc5c5


Both filtering parameters should be supported, with a preference for the plural. I'll follow up with the appropriate teams.

fastly/platform_tls.go

…ficates

shreddedbacon · 2020-04-23T23:28:52Z

Hi @thommahoney.
Adjustments made 🤞

phamann · 2020-04-24T10:39:17Z

Looking good! Once again thank you for your contribution 👍

I'll let you know once released.

phamann · 2020-04-24T13:47:37Z

This was released in v1.10.0 🎉

shreddedbacon added 2 commits April 15, 2020 15:42

add initial platform_tls

009225d

add remaining initial tests

9def21a

supress lint, fix some names format the fixtures body properly according to a real test request minor fix

gschorkopf reviewed Apr 15, 2020

View reviewed changes

fastly/platform_tls.go Outdated Show resolved Hide resolved

shreddedbacon and others added 2 commits April 16, 2020 08:04

typo

eae35c3

Co-Authored-By: Geoff Schorkopf <[email protected]>

use mapstructure instead of json

3e701d0

shreddedbacon force-pushed the platform-tls branch from e385251 to 3e701d0 Compare April 22, 2020 05:06

phamann reviewed Apr 22, 2020

View reviewed changes

use jsonapi format

c3d8ade

phamann requested changes Apr 23, 2020

View reviewed changes

shreddedbacon added 2 commits April 23, 2020 20:12

renamed PlatformPrivateKey to PrivateKey since it isnt specific to pl…

95eeaa2

…atform-tls, added additional tests to suit test styling and additional description updates

use pointers in filters, and add the accept header for requests so fi…

ecbdafc

…lter actually work

phamann approved these changes Apr 23, 2020

View reviewed changes

thommahoney reviewed Apr 23, 2020

View reviewed changes

move privatekey functions into tls and fix up filtering for bulkcerti…

745bc1e

…ficates

shreddedbacon force-pushed the platform-tls branch from e5c57cd to 745bc1e Compare April 23, 2020 23:26

phamann merged commit 2f76148 into fastly:master Apr 24, 2020

phamann mentioned this pull request Apr 24, 2020

Release v1.10.0 #159

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Platform TLS #154

Add support for Platform TLS #154

shreddedbacon commented Apr 15, 2020

phamann left a comment

shreddedbacon commented Apr 22, 2020

shreddedbacon commented Apr 23, 2020

scheying commented Apr 23, 2020

shreddedbacon commented Apr 23, 2020

phamann left a comment

phamann commented Apr 23, 2020

shreddedbacon commented Apr 23, 2020

phamann left a comment

shreddedbacon commented Apr 23, 2020

phamann commented Apr 23, 2020

shreddedbacon commented Apr 23, 2020

thommahoney left a comment

thommahoney Apr 23, 2020

shreddedbacon commented Apr 23, 2020

phamann commented Apr 24, 2020

phamann commented Apr 24, 2020

		// `tls_domains.id` filter seems to work where `tls_domain.id` does not, documentation wrong?
		// https://docs.fastly.com/api/platform-tls#tls_bulk_certificates_81cc5acbf847f71ecd4068ed58bfc5c5

Add support for Platform TLS #154

Add support for Platform TLS #154

Conversation

shreddedbacon commented Apr 15, 2020

phamann left a comment

Choose a reason for hiding this comment

shreddedbacon commented Apr 22, 2020

shreddedbacon commented Apr 23, 2020

scheying commented Apr 23, 2020

shreddedbacon commented Apr 23, 2020

phamann left a comment

Choose a reason for hiding this comment

phamann commented Apr 23, 2020

shreddedbacon commented Apr 23, 2020

phamann left a comment

Choose a reason for hiding this comment

shreddedbacon commented Apr 23, 2020

phamann commented Apr 23, 2020

shreddedbacon commented Apr 23, 2020

thommahoney left a comment

Choose a reason for hiding this comment

thommahoney Apr 23, 2020

Choose a reason for hiding this comment

shreddedbacon commented Apr 23, 2020

phamann commented Apr 24, 2020

phamann commented Apr 24, 2020