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

[teowa]

resolves hashicorp/terraform-provider-azurerm#24948

handle x-ms-pageable.nextLinkName, so the custom nextlink can be processed.

[tombuildsstuff]

hey @teowa

Thanks for this PR - I've taken a look through and left some comments inline, but if we can fix those up then this should otherwise be good to go. Out of interest have you run the unit tests on the generated SDK to validate the output too?

Thanks!

[teowa]

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?

[tombuildsstuff]

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

[tombuildsstuff]

@teowa to pull the comment out from the last PR review - out of interest have you run the unit tests on the generated SDK to validate the output too?

[manicminer]

Thanks @teowa, this LGTM pending test results 👍

[teowa]

Hi, I just find some test failures, because customPager struct for long-running operation was not generated but pager option in request was generated, which causes go build failure. Some POST APIs are long-running opertion with pageable response, e.g., AppServiceEnvironments_ChangeVnet.

I have added these struct to pass the unit test but it won't take effect since long-running operation does not use ExecutePaged method like in normal list operation. And we may need to change the poll logic.

Or I should not generate customPager and pager option for long-running operation?

The list of 59 POST operations with `x-ms-pageable` and `x-ms-long-running-operation`:

containerapps/2023-05-01/jobs/method_stopmultipleexecutions.go
mysql/2021-05-01/configurations/method_batchupdate.go
mysql/2021-12-01-preview/configurations/method_batchupdate.go
mysql/2022-01-01/configurations/method_batchupdate.go
network/2023-04-01/bastionhosts/method_getactivesessions.go
network/2023-04-01/bastionhosts/method_putbastionshareablelink.go
network/2023-04-01/bastionshareablelink/method_putbastionshareablelink.go
network/2023-04-01/expressroutecircuitarptable/method_expressroutecircuitslistarptable.go
network/2023-04-01/expressroutecircuitroutestable/method_expressroutecircuitslistroutestable.go
network/2023-04-01/expressroutecircuitroutestablesummary/method_expressroutecircuitslistroutestablesummary.go
network/2023-04-01/expressroutecrossconnectionarptable/method_expressroutecrossconnectionslistarptable.go
network/2023-04-01/expressroutecrossconnectionroutetable/method_expressroutecrossconnectionslistroutestable.go
network/2023-04-01/expressroutecrossconnectionroutetablesummary/method_expressroutecrossconnectionslistroutestablesummary.go
network/2023-04-01/networkinterfaces/method_geteffectiveroutetable.go
network/2023-04-01/networkinterfaces/method_listeffectivenetworksecuritygroups.go
network/2023-04-01/virtualnetworks/method_virtualnetworkslistddosprotectionstatus.go
network/2023-05-01/bastionshareablelink/method_putbastionshareablelink.go
network/2023-05-01/bastionhosts/method_getactivesessions.go
network/2023-05-01/bastionhosts/method_putbastionshareablelink.go
network/2023-05-01/expressroutecircuitarptable/method_expressroutecircuitslistarptable.go
network/2023-05-01/expressroutecircuitroutestable/method_expressroutecircuitslistroutestable.go
network/2023-05-01/expressroutecircuitroutestablesummary/method_expressroutecircuitslistroutestablesummary.go
network/2023-05-01/expressroutecrossconnectionarptable/method_expressroutecrossconnectionslistarptable.go
network/2023-05-01/expressroutecrossconnectionroutetable/method_expressroutecrossconnectionslistroutestable.go
network/2023-05-01/expressroutecrossconnectionroutetablesummary/method_expressroutecrossconnectionslistroutestablesummary.go
network/2023-05-01/networkinterfaces/method_geteffectiveroutetable.go
network/2023-05-01/networkinterfaces/method_listeffectivenetworksecuritygroups.go
network/2023-05-01/virtualnetworks/method_virtualnetworkslistddosprotectionstatus.go
network/2023-06-01/bastionshareablelink/method_putbastionshareablelink.go
network/2023-06-01/bastionhosts/method_getactivesessions.go
network/2023-06-01/bastionhosts/method_putbastionshareablelink.go
network/2023-06-01/expressroutecircuitarptable/method_expressroutecircuitslistarptable.go
network/2023-06-01/expressroutecircuitroutestable/method_expressroutecircuitslistroutestable.go
network/2023-06-01/expressroutecircuitroutestablesummary/method_expressroutecircuitslistroutestablesummary.go
network/2023-06-01/expressroutecrossconnectionarptable/method_expressroutecrossconnectionslistarptable.go
network/2023-06-01/expressroutecrossconnectionroutetable/method_expressroutecrossconnectionslistroutestable.go
network/2023-06-01/expressroutecrossconnectionroutetablesummary/method_expressroutecrossconnectionslistroutestablesummary.go
network/2023-06-01/networkinterfaces/method_geteffectiveroutetable.go
network/2023-06-01/networkinterfaces/method_listeffectivenetworksecuritygroups.go
network/2023-06-01/virtualnetworks/method_virtualnetworkslistddosprotectionstatus.go
network/2023-09-01/bastionshareablelink/method_putbastionshareablelink.go
network/2023-09-01/bastionhosts/method_getactivesessions.go
network/2023-09-01/bastionhosts/method_putbastionshareablelink.go
network/2023-09-01/expressroutecircuitarptable/method_expressroutecircuitslistarptable.go
network/2023-09-01/expressroutecircuitroutestable/method_expressroutecircuitslistroutestable.go
network/2023-09-01/expressroutecircuitroutestablesummary/method_expressroutecircuitslistroutestablesummary.go
network/2023-09-01/expressroutecrossconnectionarptable/method_expressroutecrossconnectionslistarptable.go
network/2023-09-01/expressroutecrossconnectionroutetablesummary/method_expressroutecrossconnectionslistroutestablesummary.go
network/2023-09-01/expressroutecrossconnectionroutetable/method_expressroutecrossconnectionslistroutestable.go
network/2023-09-01/networkinterfaces/method_geteffectiveroutetable.go
network/2023-09-01/networkinterfaces/method_listeffectivenetworksecuritygroups.go
network/2023-09-01/virtualnetworks/method_virtualnetworkslistddosprotectionstatus.go
orbital/2022-11-01/contact/method_spacecraftslistavailablecontacts.go
web/2022-09-01/appserviceenvironments/method_changevnet.go
web/2022-09-01/appserviceenvironments/method_resume.go
web/2022-09-01/appserviceenvironments/method_suspend.go
web/2023-01-01/appserviceenvironments/method_changevnet.go
web/2023-01-01/appserviceenvironments/method_resume.go
web/2023-01-01/appserviceenvironments/method_suspend.go

[jschoombee]

any update?

[teowa]

I have added logic to generate customPager for immediateOperationTemplate and longRunningOperationTemplate additional to listOperationTemplate, the test can pass now. But as mentioned above, custom pager does not work in long-running operation since it does not use ExecutePaged method like in normal list operation.