Feature merge: Go SDK #5679

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

Merged

psafont merged 78 commits into master from feature/go_sdk

Jun 14, 2024

Member

minglumlu commented Jun 11, 2024

This is to merge Go SDK feature (including backwards compatibility support) into master branch.
Basically, the changes in feature include:

auto-gen Go SDK through mustache templates;
unit tests against auto-gen OCaml code;
component tests against Go clients using generated Go SDK;
functional tests in github.com/xenserver/xenserver-samples/go.

Most of the changes are under "ocaml/sdk-gen/". One exception is 612b73b, in which the Api.errors (strings) have to be collected in the way.

duobei and others added 30 commits

April 15, 2024 13:40


          CP-48666: initialize a skeleton project for Go SDK

52deb65

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-47347: Add mustache template for Enum Types

526bb8a

CP-47350: Add mustache template for Record/Ref/Class Types
CP-47365: Add mustache template for API messages/errors
CP-47363: Add mustache template for file header

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-47351: generate Record and Ref Type Golang code for all classes

2aa4255

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-47348: generate Golang code of Enum Type for all classes

49a22b0

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-47362: generate file headers

96d045c

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48666: collect api errors

612b73b

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-47364: generate api messages and errors of Golang code

2039c12

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          refactor: create an Alcotest.testable to check structure of generat…

dfc46a7

…ed JSON is wanted

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          refactor: move objects and session_id from Gen_go_helper to `Co…

…mmonFunctions`

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48666: use dune rule to get the destination dir for the generated …

b98a102

…files

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48666: generate all enums to a file

a564280

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          refactor the way of getting enums

3563bf8

Before we got the enums alongside objs,  the readability of code is so poor. We separate to get them now.

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48666: refactor the JSON schema checking

f9cb499

Just check the fields only we need instead of generalized recursive functions

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48666: refactor render_template with an optional newline parameter

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          Merge pull request #5540 from duobei/private/fezhan/CP-48666

25df1a8

Generate Golang codes for SDK


           CP-47361: generate mustache template for deserialize and serialize f…

259b1e0

…unctions

Signed-off-by: xueqingz <xueqing.zhang@citrix.com>
Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-47358: Generate convert functions Go code

e6c911c

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48855: update templates (APIErrors, APIMessages, Record)

c18a5f3

Signed-off-by: xueqingz <xueqing.zhang@citrix.com>
Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48855: adjust generated json for templates changed

12fcb25

changed templates: APIVersions.mustache,APIErrors.mustache, Record.mustache

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48855: add templates for option and APIVersions

2c6b09f

Signed-off-by: xueqingz <xueqing.zhang@citrix.com>
Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48855: render options

925f2de

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-47355, CP-47360: generate mustache template for xapi data module c…

2f01d79

…lass messages

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-47354: Generate messages functions Golang code for all classes

0acbe2a

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-47354: add unit tests for func_name_suffix and `string_of_ty_wit…

644ce45

…h_enums`

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48855: render APIVersion

5aa929b

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48855: fix go lint var-naming warnings

e6c5e65

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          Merge pull request #5606 from duobei/private/fezhan/CP-48855

d4b74fa

CP-48855: fix go lint var-name warnings


          Merge branch 'feature/go_sdk' into private/CP-48667

7f9cd71


          fix StringOfTyWithEnumsTest after merged

8c685e1

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>


          CP-48855: it should be only one empty line at end of Go file

77762f4

Signed-off-by: Luca Zhang <feiya.zhang@cloud.com>

minglumlu and others added 7 commits

May 31, 2024 10:25


          Merge pull request #5663 from minglumlu/private/mingl/merge_master_to…

19ff555

…_feature

Merge master to Go SDK feature branch


          Go SDK: Misc fixes for on-going component tests (#5661)

5042fd9

* CP-49707: Go SDK: Add JSON tag for structs

This aims to allow a Go SDK client to unmarshal JSON to Go structs with
the function in Go json pacakge instead of using Go SDK.

The unmarshalling in Go SDK contains two steps: JSON -> map -> struct.
This is because some special cases need to be handled explicitly.
But for sake of safety, this unmarshalling is not exposed to clients.

Signed-off-by: Ming Lu <ming.lu@cloud.com>

* CP-49349: Go SDK: Append UTC timezone to unix timestamp

The date time in Go requires a date time with timezone info. But XAPI
may return a UNIX timestamp to clients.

This commit blindly adds a UTC timezone for UNIX timestamps returned
from XAPI server.

Signed-off-by: Ming Lu <ming.lu@cloud.com>

* CP-49349: Go SDK: Allow spaces in special value of float type

Some special values of float standing in JSON are handled specifically.
This commit allows the special values contain spaces.

Signed-off-by: Ming Lu <ming.lu@cloud.com>

* Go SDK: Disable golangci tagliatelle

This check complains the struct json tag naming style. It expects the
Caml style, but Go SDK has to use Snake.

Signed-off-by: Ming Lu <ming.lu@cloud.com>

---------

Signed-off-by: Ming Lu <ming.lu@cloud.com>


          CP-47928: Add component test for Go SDK

beaaf1c

Signed-off-by: Xihuan Yang <xihuan.yang@cloud.com>


          Merge pull request #5648 from xihuan-citrix/private/xihuany/component…

ad3c5d1

…_test

CP-47928: Add component test for Go SDK


          CP-49768: Update GO SDK README file (#5671)

18d17c4

Signed-off-by: xueqingz <xueqing.zhang@citrix.com>


          Merge branch 'master' into private/mingl/merge_master_to_feature

b816e00


          Merge pull request #5678 from minglumlu/private/mingl/merge_master_to…

cda63f2

…_feature

Merge master branch to go_sdk feature branch

xueqingz requested review from gangj and xueqingz

June 11, 2024 03:23

xueqingz approved these changes

View reviewed changes

Contributor

xueqingz left a comment

Test result on page https://info.citrite.net/display/xenserver/Quality+Status+Report+for+XenServer+Go+SDK

xueqingz requested review from danilo-delbusso and kc284

June 11, 2024 03:27

psafont reviewed

View reviewed changes

ocaml/sdk-gen/common/CommonFunctions.ml Show resolved Hide resolved

kc284 reviewed

View reviewed changes

ocaml/sdk-gen/go/README.md Outdated

    
              A. Navigate to the extracted `XenServer-SDK\XenServerGo\src` directory and copy the whole folder `src` into your Go project directory.

              B. To use XenServer Go SDK as a local Go module, update one line into the `go.mod` file under your Go project:

kc284 Jun 11, 2024

"update one line into" => Shouldn't this be "include the following line into"?

kc284 Jun 11, 2024

"To use XenServer Go SDK as a local Go module" => "To use the XenServer SDK for Go as a local Go module"

kc284 reviewed

View reviewed changes

ocaml/sdk-gen/go/README.md Outdated

    
              ```

              replace xenapi => ./src

              ```

              You can then import this XenServer SDK Go module with the following command:

kc284 Jun 11, 2024 •

edited

Loading

"this XenServer SDK Go module" => "the XenServer SDK for Go" or "the XenServer module for Go"

kc284 commented Jun 11, 2024

I've just noticed that the mustache templates do not have the BSD 2-clause licence disclaimer at the top. All the autogenerated source files for all the SDK languages should include this. Is it added somehow by the generation code? If not, the simplest is to just hardcode it at the top of the mustache file (see other mustache files for the other langauges).

contificate reviewed

View reviewed changes

ocaml/sdk-gen/common/CommonFunctions.ml Show resolved Hide resolved

Member Author

minglumlu commented Jun 11, 2024

I've just noticed that the mustache templates do not have the BSD 2-clause licence disclaimer at the top. All the autogenerated source files for all the SDK languages should include this. Is it added somehow by the generation code? If not, the simplest is to just hardcode it at the top of the mustache file (see other mustache files for the other langauges).

I think this should be included in the FQP and test report.

minglumlu mentioned this pull request

Several fixes for XenServer SDK for Go #5687

Merged

Member Author

minglumlu commented Jun 13, 2024

All fixes are in #5687
This PR can be continued when the fixup PR merged.

minglumlu added 5 commits

June 14, 2024 10:30


          CP-49858: Fix phrasing in readme

0bc1a12

Signed-off-by: Ming Lu <ming.lu@cloud.com>


          CP-49858: Add licence text on top of Go source files

5eb7889

Signed-off-by: Ming Lu <ming.lu@cloud.com>


          CP-49858: Unit test: licence template variable

50cbe0f

Signed-off-by: Ming Lu <ming.lu@cloud.com>


          CP-49858: Remove template variables 'first' and 'is_session_id'

7ac6afa

Prior to this change, the function parameter list is generated by
Mustache template. As a result, a template boolean variable 'first' has
to be used to determine if a leading comma is presented or not. E.g.
when the 'first' is true, a parameter would be rendered as "a string',
and then the next parameter with the 'first' being false would be
rendered as ", b string". Putting them together would result in
"a string, b string".

This could work but is difficult to be understood.

In this commit, it is changed to construct the whole function parameter
list as a string in OCaml code and bind it to the template variable
'func_params'.

Similar changes apply to the template variable 'is_session_id'. It is
removed in this commit and the expected values are generated by OCaml
code.

Signed-off-by: Ming Lu <ming.lu@cloud.com>


          CP-49858: Unit test: Update for changes on template variables

cca5a6e

Signed-off-by: Ming Lu <ming.lu@cloud.com>

Member

psafont commented Jun 14, 2024

Looks fine to me, waiting on tina to review this. This is because she didn't approve the fixup PR

Contributor

xueqingz commented Jun 14, 2024

Koji build base on branch feature/go_sdk latest commit "cca5a6e250b56a98294987a95b7ee53870188c41" https://koji.eng.citrite.net/koji/buildinfo?buildID=20734.
Build new SDK and re-run FQP. Quality status report updated: https://info.citrite.net/display/xenserver/Quality+Status+Report+for+XenServer+Go+SDK

xueqingz requested a review from kc284

June 14, 2024 09:14

kc284 approved these changes

View reviewed changes

psafont merged commit 94b24f5 into master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

psafont psafont left review comments

contificate contificate left review comments

kc284 kc284 approved these changes

xueqingz xueqingz approved these changes

gangj Awaiting requested review from gangj

danilo-delbusso Awaiting requested review from danilo-delbusso

Labels

None yet