CP-47354, CP-47355: add mustache template for messages and generate GO methods code

[duobei]

1. Add mustache template for xapi data module class messages
2. Generate messages functions Golang code for all classes

[lindig]

Has the OCaml code gone trough ocamlformat and the Go code through gofmt?

[duobei]

Has the OCaml code gone trough ocamlformat and the Go code through gofmt?

Both have gone through.

[minglumlu]

I would suggest a basic structure like:

module Convert = struct
  type params = {func_name_suffix: string; value_ty: string}

  type params_of_enum_item =
    { value: string
    ; name: string
    }

  type parms_of_enum =
    { func_name_suffix: string
    ; value_ty: string
    ; items: params_of_enum_item
    }

  type params_of_map =
    { func_name_suffix: string
    ; value_ty: string
    ; key_ty: string
    ; val_ty: string
    }

  ...

  type convert_params =
    | Simple of params
    | Int of params
    | Enum of params_of_enum
    | Map of param_of_map

  let template_of_convert = function
    | Default of _ ->
        "ConvertSimpleType.mustache"
    | Int of _ ->
        "ConvertInt.mustache"
    | Float of _ ->
        "ConvertFloat.mustache"
    | ...


  let to_json =function
    | Simple params ->
    | Int params ->
        json_of_params params
    | ...

  let of_ty = function
    match ty with
    | SecretString | String ->
        Simple {func_name_suffix: "String"; value_ty: "string"}
    | Int ->
        Int {func_name_suffix: "Int"; value_ty: "int"}
    | Bool ->
        Default {func_name_suffix: "Bool"; value_ty: "bool"}
    | DateTime ->
        ...
    | Enum (name, kv) as ty ->
        ...
    | ...

end

all_types
|> List.map Convert.of_ty
|> List.fold_left (fun acc params ->
    let template = Convert.template_of_convert params in
    (* merge by template*)
)
|> List.iter(fun template, params_list ->
    render_template template params_list
)

[minglumlu]

This PR is too big. Hopefully it could be split into at least 3 smaller PRs.

1. The go code should be in one PR separately.
2. render messages
3. render converts
4. others?

[duobei]

This PR is too big. Hopefully it could be split into at least 3 smaller PRs.

1. The go code should be in one PR separately.
2. render messages
3. render converts
4. others?

Sorry, I should make the PR reviewed easily. I'll split it to 3 smaller PRs today.

[minglumlu]

A general comment on the template is if we consider a template as a function, then its input (and its output) should be defined exactly. This would be useful to make sure the template variables are not missing and the unnecessary ones can be cleaned up.
It's also possible to use ppx to auto-gen the mustache JSON from records. This would be helpful to ensure the correctness of the template rendering.
The above could be an improvement in the future.

[xueqingz]

For separate method template, raise a new commit here. https://code.citrite.net/users/fezhan/repos/xen-api/browse/ocaml/sdk-gen/go/templates?at=refs%2Fheads%2Fprivate%2FCP-48667-2-1

[xueqingz]

Checked the generated Go source files' methods based on new commit, looks good to me. Thanks.

[psafont]

Ming had done an in-depth review, so I believe this looks OK from a toolstack perspective, it needs a review from the maintainers of the SDK, interfaces

[xueqingz]

Checking the generated Go source files with golangci-lint:

root@3eea0d3e0e5d:/app/go/goSDK# golangci-lint run --config=/app/.golangci.yml
WARN The linter 'execinquery' is deprecated (since v1.58.0) due to: The repository of the linter has been archived by the owner.  
WARN The linter 'gomnd' is deprecated (since v1.58.0) due to: The linter has been renamed. Replaced by mnd. 
0 issues.

Test with current xenserver-samples test. No special issues.

[github-actions]

pytype_reporter extracted 50 problem reports from pytype output

.

You can check the results of the job here