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.

Sign up for GitHub

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

Jump to bottom

tools/generator-go-sdk: generate custom pager for list method #3958

Merged
merged 6 commits into from
Jun 28, 2024
Merged

tools/generator-go-sdk: generate custom pager for list method #3958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
00d0065
generate custom pager
teowa Mar 14, 2024
06b8622
fix unit test
teowa Mar 14, 2024
18da590
fix assignment
teowa Mar 15, 2024
065e715
rename variable
teowa Mar 15, 2024
7e0a011
generate custom pager for lro operation
teowa Mar 18, 2024
3039d8c
Merge branch 'main' of github.com:hashicorp/pandora into generate_cus…
teowa May 30, 2024
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
45 changes: 41 additions & 4 deletions tools/generator-go-sdk/internal/generator/templater_methods.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ func (c methodsPandoraTemplater) immediateOperationTemplate(data ServiceGenerato
if err != nil {
return nil, fmt.Errorf("building arguments for immediate operation: %+v", err)
}
requestOptionStruct := c.requestOptionStruct()
requestOptions, err := c.requestOptions()
if err != nil {
return nil, fmt.Errorf("building request config: %+v", err)
Expand All @@ -158,6 +159,7 @@ func (c methodsPandoraTemplater) immediateOperationTemplate(data ServiceGenerato
templated := fmt.Sprintf(`
%[7]s
%[8]s
%[9]s

// %[2]s ...
func (c %[1]s) %[2]s(ctx context.Context %[3]s) (result %[2]sOperationResponse, err error) {
Expand Down Expand Up @@ -185,7 +187,7 @@ func (c %[1]s) %[2]s(ctx context.Context %[3]s) (result %[2]sOperationResponse,
return
}

`, data.serviceClientName, c.operationName, *methodArguments, *requestOptions, *marshalerCode, *unmarshalerCode, *responseStruct, *optionsStruct)
`, data.serviceClientName, c.operationName, *methodArguments, *requestOptions, *marshalerCode, *unmarshalerCode, *responseStruct, *optionsStruct, requestOptionStruct)
return &templated, nil
}

Expand All @@ -194,6 +196,7 @@ func (c methodsPandoraTemplater) longRunningOperationTemplate(data ServiceGenera
if err != nil {
return nil, fmt.Errorf("building arguments for long running template: %+v", err)
}
requestOptionStruct := c.requestOptionStruct()
requestOptions, err := c.requestOptions()
if err != nil {
return nil, fmt.Errorf("building request config: %+v", err)
Expand All @@ -219,6 +222,7 @@ func (c methodsPandoraTemplater) longRunningOperationTemplate(data ServiceGenera
templated := fmt.Sprintf(`
%[8]s
%[9]s
%[10]s

// %[2]s ...
func (c %[1]s) %[2]s(ctx context.Context %[3]s) (result %[2]sOperationResponse, err error) {
Expand Down Expand Up @@ -264,7 +268,7 @@ func (c %[1]s) %[2]sThenPoll(ctx context.Context %[3]s) error {

return nil
}
`, data.serviceClientName, c.operationName, *methodArguments, *requestOptions, *marshalerCode, *unmarshalerCode, argumentsCode, *responseStruct, *optionsStruct)
`, data.serviceClientName, c.operationName, *methodArguments, *requestOptions, *marshalerCode, *unmarshalerCode, argumentsCode, *responseStruct, *optionsStruct, requestOptionStruct)
return &templated, nil
}

Expand All @@ -273,6 +277,7 @@ func (c methodsPandoraTemplater) listOperationTemplate(data ServiceGeneratorData
if err != nil {
return nil, fmt.Errorf("building arguments for list operation: %+v", err)
}
requestOptionStruct := c.requestOptionStruct()
requestOptions, err := c.requestOptions()
if err != nil {
return nil, fmt.Errorf("building request config: %+v", err)
Expand All @@ -298,6 +303,7 @@ func (c methodsPandoraTemplater) listOperationTemplate(data ServiceGeneratorData
templated := fmt.Sprintf(`
%[6]s
%[7]s
%[8]s

// %[2]s ...
func (c %[1]s) %[2]s(ctx context.Context %[3]s) (result %[2]sOperationResponse, err error) {
Expand All @@ -322,7 +328,7 @@ func (c %[1]s) %[2]s(ctx context.Context %[3]s) (result %[2]sOperationResponse,

return
}
`, data.serviceClientName, c.operationName, *methodArguments, *requestOptions, *unmarshalerCode, *responseStruct, *optionsStruct)
`, data.serviceClientName, c.operationName, *methodArguments, *requestOptions, *unmarshalerCode, *responseStruct, *optionsStruct, requestOptionStruct)

// Only output predicate functions for models and not for base types like string, int etc.
if c.operation.ResponseObject.Type == models.ReferenceSDKObjectDefinitionType || c.operation.ResponseObject.Type == models.ListSDKObjectDefinitionType {
Expand Down Expand Up @@ -476,6 +482,31 @@ func (c methodsPandoraTemplater) argumentsTemplateForMethod(data ServiceGenerato
return &out, nil
}

// define struct used in requestOptions
func (c methodsPandoraTemplater) requestOptionStruct() string {
var output string

if c.operation.FieldContainingPaginationDetails != nil {
jsonTag := fmt.Sprintf("`json:%q`", *c.operation.FieldContainingPaginationDetails)

output = fmt.Sprintf(`
type %[2]sCustomPager struct {
NextLink *odata.Link %[1]s
}

func (p *%[2]sCustomPager) NextPageLink() *odata.Link {
defer func() {
p.NextLink = nil
}()

return p.NextLink
}
`, jsonTag, c.operationName)
}

return output
}

func (c methodsPandoraTemplater) requestOptions() (*string, error) {
method := capitalizeFirstLetter(c.operation.Method)
expectedStatusCodes := make([]string, 0)
Expand All @@ -502,6 +533,11 @@ func (c methodsPandoraTemplater) requestOptions() (*string, error) {
options = "OptionsObject: options,"
}

customPagerOption := ""
if c.operation.FieldContainingPaginationDetails != nil {
customPagerOption = fmt.Sprintf("Pager: &%sCustomPager{},", c.operationName)
}

contentType := c.operation.ContentType

out := fmt.Sprintf(`client.RequestOptions{
Expand All @@ -510,10 +546,11 @@ func (c methodsPandoraTemplater) requestOptions() (*string, error) {
%[2]s,
},
HttpMethod: http.Method%[3]s,
%[6]s
Path: %[4]s,
%[5]s
}
`, contentType, strings.Join(expectedStatusCodes, ",\n\t\t\t"), method, path, options)
`, contentType, strings.Join(expectedStatusCodes, ",\n\t\t\t"), method, path, options, customPagerOption)
return &out, nil
}

Expand Down
34 changes: 28 additions & 6 deletions tools/generator-go-sdk/internal/generator/templater_methods_discriminators_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ func TestTemplateMethods_Discriminator_ResponseObjectIsImplementation_Get(t *tes
},
operationName: "Get",
}.template(input)

if err != nil {
t.Fatalf("err %+v", err)
}
Expand Down Expand Up @@ -157,7 +156,6 @@ func TestTemplateMethods_Discriminator_ResponseObjectIsParent_Get(t *testing.T)
},
operationName: "Get",
}.template(input)

if err != nil {
t.Fatalf("err %+v", err)
}
Expand Down Expand Up @@ -267,7 +265,6 @@ func TestTemplateMethods_Discriminator_ResponseObjectIsImplementation_List(t *te
},
operationName: "List",
}.template(input)

if err != nil {
t.Fatalf("err %+v", err)
}
Expand Down Expand Up @@ -299,6 +296,18 @@ type ListCompleteResult struct {
Items []PandaPop
}

type ListCustomPager struct {
NextLink *odata.Link %[2]s
}

func (p *ListCustomPager) NextPageLink() *odata.Link {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we nil check here like in https://github.com/hashicorp/go-azure-sdk/blob/8ee56b008ba9275ff6c3282052e6b50e83073f9a/sdk/client/client_test.go#L166-L173, and should we introduce log package here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No that's mostly for testing purposes, so this is fine. If NextPageLink returns nil then we assume we're at the end of the dataset, so that's fine/should be logged elsewhere

defer func() {
p.NextLink = nil
}()

return p.NextLink
}

// List ...
func (c pandaClient) List(ctx context.Context ) (result ListOperationResponse, err error) {
opts := client.RequestOptions{
Expand All @@ -307,6 +316,7 @@ func (c pandaClient) List(ctx context.Context ) (result ListOperationResponse, e
http.StatusOK,
},
HttpMethod: http.MethodGet,
Pager: &ListCustomPager{},
Path: "/thing",
}

Expand Down Expand Up @@ -364,7 +374,7 @@ func (c pandaClient) ListCompleteMatchingPredicate(ctx context.Context, predicat
}
return
}
`, "`json:\"value\"`")
`, "`json:\"value\"`", "`json:\"someField\"`")

assertTemplatedCodeMatches(t, expected, *actual)
}
Expand Down Expand Up @@ -410,7 +420,6 @@ func TestTemplateMethods_Discriminator_ResponseObjectIsParent_List(t *testing.T)
},
operationName: "List",
}.template(input)

if err != nil {
t.Fatalf("err %+v", err)
}
Expand Down Expand Up @@ -442,6 +451,18 @@ type ListCompleteResult struct {
Items []FizzyDrink
}

type ListCustomPager struct {
NextLink *odata.Link %[2]s
}

func (p *ListCustomPager) NextPageLink() *odata.Link {
defer func() {
p.NextLink = nil
}()

return p.NextLink
}

// List ...
func (c pandaClient) List(ctx context.Context ) (result ListOperationResponse, err error) {
opts := client.RequestOptions{
Expand All @@ -450,6 +471,7 @@ func (c pandaClient) List(ctx context.Context ) (result ListOperationResponse, e
http.StatusOK,
},
HttpMethod: http.MethodGet,
Pager: &ListCustomPager{},
Path: "/thing",
}

Expand Down Expand Up @@ -516,7 +538,7 @@ func (c pandaClient) ListCompleteMatchingPredicate(ctx context.Context, predicat
}
return
}
`, "`json:\"value\"`")
`, "`json:\"value\"`", "`json:\"SomeField\"`")

assertTemplatedCodeMatches(t, expected, *actual)
}
51 changes: 42 additions & 9 deletions tools/generator-go-sdk/internal/generator/templater_methods_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ func TestTemplateMethodsGet(t *testing.T) {
},
operationName: "Get",
}.immediateOperationTemplate(input)

if err != nil {
t.Fatalf("err %+v", err)
}
Expand Down Expand Up @@ -111,7 +110,6 @@ func TestTemplateMethodsGetAsTextPowerShell(t *testing.T) {
},
operationName: "Get",
}.immediateOperationTemplate(input)

if err != nil {
t.Fatalf("err %+v", err)
}
Expand Down Expand Up @@ -221,7 +219,6 @@ func TestTemplateMethodsListWithDiscriminatedType(t *testing.T) {
},
operationName: "List",
}.listOperationTemplate(input)

if err != nil {
t.Fatalf("err %+v", err)
}
Expand All @@ -238,6 +235,18 @@ type ListCompleteResult struct {
Items []Bottle
}

type ListCustomPager struct {
NextLink *odata.Link %[2]s
}

func (p *ListCustomPager) NextPageLink() *odata.Link {
defer func() {
p.NextLink = nil
}()

return p.NextLink
}

// List ...
func (c pandaClient) List(ctx context.Context , id PandaPop) (result ListOperationResponse, err error) {
opts := client.RequestOptions{
Expand All @@ -246,6 +255,7 @@ func (c pandaClient) List(ctx context.Context , id PandaPop) (result ListOperati
http.StatusOK,
},
HttpMethod: http.MethodGet,
Pager: &ListCustomPager{},
Path: fmt.Sprintf("%%s/pandas", id.ID()),
}

Expand Down Expand Up @@ -317,13 +327,12 @@ func (c pandaClient) ListCompleteMatchingPredicate(ctx context.Context, id Panda
}
return
}
`, "`json:\"value\"`")
`, "`json:\"value\"`", "`json:\"nextLink\"`")

assertTemplatedCodeMatches(t, expected, *actual)
}

func TestTemplateMethodsListWithSimpleType(t *testing.T) {

input := ServiceGeneratorData{
packageName: "chubbyPandas",
serviceClientName: "pandaClient",
Expand All @@ -349,7 +358,6 @@ func TestTemplateMethodsListWithSimpleType(t *testing.T) {
},
operationName: "List",
}.listOperationTemplate(input)

if err != nil {
t.Fatalf("err %+v", err)
}
Expand All @@ -366,6 +374,18 @@ type ListCompleteResult struct {
Items []string
}

type ListCustomPager struct {
NextLink *odata.Link %[2]s
}

func (p *ListCustomPager) NextPageLink() *odata.Link {
defer func() {
p.NextLink = nil
}()

return p.NextLink
}

// List ...
func (c pandaClient) List(ctx context.Context , id PandaPop) (result ListOperationResponse, err error) {
opts := client.RequestOptions{
Expand All @@ -374,6 +394,7 @@ func (c pandaClient) List(ctx context.Context , id PandaPop) (result ListOperati
http.StatusOK,
},
HttpMethod: http.MethodGet,
Pager: &ListCustomPager{},
Path: fmt.Sprintf("%%s/pandas", id.ID()),
}

Expand Down Expand Up @@ -427,7 +448,7 @@ func (c pandaClient) ListComplete(ctx context.Context, id PandaPop) (result List
}
return
}
`, "`json:\"value\"`")
`, "`json:\"value\"`", "`json:\"nextLink\"`")

assertTemplatedCodeMatches(t, expected, *actual)
}
Expand Down Expand Up @@ -459,7 +480,6 @@ func TestTemplateMethodsListWithObject(t *testing.T) {
},
operationName: "List",
}.listOperationTemplate(input)

if err != nil {
t.Fatalf("err %+v", err)
}
Expand All @@ -476,6 +496,18 @@ type ListCompleteResult struct {
Items []LingLing
}

type ListCustomPager struct {
NextLink *odata.Link %[2]s
}

func (p *ListCustomPager) NextPageLink() *odata.Link {
defer func() {
p.NextLink = nil
}()

return p.NextLink
}

// List ...
func (c pandaClient) List(ctx context.Context , id PandaPop) (result ListOperationResponse, err error) {
opts := client.RequestOptions{
Expand All @@ -484,6 +516,7 @@ func (c pandaClient) List(ctx context.Context , id PandaPop) (result ListOperati
http.StatusOK,
},
HttpMethod: http.MethodGet,
Pager: &ListCustomPager{},
Path: fmt.Sprintf("%%s/pandas", id.ID()),
}

Expand Down Expand Up @@ -544,7 +577,7 @@ func (c pandaClient) ListCompleteMatchingPredicate(ctx context.Context, id Panda
}
return
}
`, "`json:\"value\"`")
`, "`json:\"value\"`", "`json:\"nextLink\"`")

assertTemplatedCodeMatches(t, expected, *actual)
}
Loading