Changed service template to correctly handle required positional arguments

[andrewnester]

Changes

Change 1

Previously codegen considered that command has positional arguments only if all arguments are primitives.
With this change, we consider command to have positional arguments if all required arguments are primitives.

It helps to solve thew issue when running command like cli secrets create-scope, cli users create with no passed arguments

Change 2

It also makes args optional if there is a prompt for it or JSON can be accepted instead.
All 3 command below will yield the same valid results

cli clusters events --json '{"cluster_id": "1029-xxxx"}'
...
cli clusters events 1029-xxxx
...
cli clusters events
Search: █
? The ID of the cluster to retrieve events about: 
  10.1 
  10.5 
  10xlibs
  12.2 LTS
↓ 13.x 

Change 3

Also now it always allow --json flag and ignore all positional arguments in this case

cli account private-access create --json '{}'
Error: accepts 2 arg(s), received 0

cli account private-access create --json '{}'
Use the arrow keys to navigate: ↓ ↑ → ← 
? ~/.databrickscfg profile: 

Note: these code is generated with code generator containing this fix
databricks/databricks-sdk-go#403

Tests

[DEBUG] Test execution directory:  /Users/andrew.nester/cli
2023/05/26 14:02:25 [INFO] ✅ TestAccApiGet (0.630s)
2023/05/26 14:02:26 [INFO] ✅ TestAccClustersList (0.820s)
2023/05/26 14:02:26 [INFO] ✅ TestAccClustersGet (0.810s)
...

Running cli secrets create-scope, cli users create and etc with no arguments.

No panic, instead CLI correctly prompts potential input or shows correct error message.

Before

andrew.nester@HFW9Y94129 multiples-tasks % cli users create        
panic: runtime error: index out of range [0] with length 0

goroutine 1 [running]:
github.com/databricks/cli/cmd/workspace/users.glob..func1(0x101552a60?, {0x10159c6e0, 0x0, 0x0?})
        /Users/andrew.nester/cli/cmd/workspace/users/users.go:71 +0x1c0
github.com/spf13/cobra.(*Command).execute(0x101552a60, {0x10159c6e0, 0x0, 0x0})
        /Users/andrew.nester/cli/vendor/github.com/spf13/cobra/command.go:940 +0x5c8
github.com/spf13/cobra.(*Command).ExecuteC(0x10151a680)
        /Users/andrew.nester/cli/vendor/github.com/spf13/cobra/command.go:1068 +0x35c
github.com/spf13/cobra.(*Command).ExecuteContextC(...)
        /Users/andrew.nester/cli/vendor/github.com/spf13/cobra/command.go:1001
github.com/databricks/cli/cmd/root.Execute()
        /Users/andrew.nester/cli/cmd/root/root.go:81 +0x6c
main.main()
        /Users/andrew.nester/cli/main.go:18 +0x1c

After

andrew.nester@HFW9Y94129 multiples-tasks % cli users create       
Error: /2.0/preview/scim/v2/Users is only accessible by admins

[pietern]

Thanks -- this LGTM except for the create case. There the prompt is unexpected.

Can you investigate why this happens?

[andrewnester]

@pietern see the fix and explanation why code generator worked that way here: databricks/databricks-sdk-go#403

[pietern]

I spot checked most generated commands and looks good!

Could you see if you can keep Args: cobra.MaximumNArgs(), for commands that have an optional argument? It would we 1 in cases where we can prompt.

[pietern]

Won't these still be able to accept json if the request is only primitive fields?

[andrewnester]

Technically we can allow JSON to be accepted in all cases. Right now if all fields are primitive we don't add --json flag and instead add a specific flag for each of the fields.

We can change it to always accept JSON though

[pietern]

FWIW, you can use {{- to strip preceding whitespace (including newlines).

See https://pkg.go.dev/text/template#hdr-Text_and_spaces

This means you could put the if on the next line for better readability.

[pietern]

This doesn't look fmt'ed.