8000 add "config get" command to print settings values by ardnew · Pull Request #2307 · arduino/arduino-cli · GitHub
[go: up one dir, main page]
Skip to content

add "config get" command to print settings values #2307

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

Merged
merged 10 commits into from
Feb 14, 2024
Merged

add "config get" command to print settings values #2307

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f3bf168
add "config get" command to print settings values
ardnew Sep 10, 2023
76eca4d
use RPC for "config get" and add test cases
ardnew Sep 10, 2023
e5f0881
update imports for changed internal layout
ardnew Jan 25, 2024
926d850
config/get: do not wrap JSON output in YAML
ardnew Jan 25, 2024
6efcca6
fix formatting with gofmt
ardnew Jan 25, 2024
d67f3d7
config/get: unmarshal JSON RPC response
ardnew Jan 25, 2024
ba04e61
Apply suggestions from code review
ardnew Feb 8, 2024
c069ece
use same default format as "config dump"
ardnew Feb 8, 2024
6e5be88
fix import missing after merging review changes remotely
ardnew Feb 8, 2024
2942031
test (config): fix expected error message with "get <unknown-key>"
ardnew Feb 13, 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
Prev Previous commit
Next Next commit
config/get: unmarshal JSON RPC response
  • Loading branch information
@ardnew
ardnew committed Feb 8, 2024
commit d67f3d7689737dd10dc184ebdc8e3e90d5893108
27 changes: 14 additions & 13 deletions internal/cli/config/get.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
package config

import (
"encoding/json"
"fmt"
"os"

"github.com/arduino/arduino-cli/commands/daemon"
Expand All @@ -29,11 +31,11 @@ import (
func initGetCommand() *cobra.Command {
getCommand := &cobra.Command{
Use: "get",
Short: tr("Gets settings key values."),
Long: tr("Gets settings key values."),
Short: tr("Gets a settings key value."),
Long: tr("Gets a settings key value."),
Example: "" +
" " + os.Args[0] + " config get logging\n" +
" " + os.Args[0] + " config get logging.level logging.file\n" +
" " + os.Args[0] + " config get daemon.port\n" +
" " + os.Args[0] + " config get board_manager.additional_urls",
Args: cobra.MinimumNArgs(1),
Run: runGetCommand,
Expand All @@ -53,27 +55,26 @@ func runGetCommand(cmd *cobra.Command, args []string) {
if err != nil {
feedback.Fatal(tr("Cannot get the key %[1]s: %[2]v", toGet, err), feedback.ErrGeneric)
}
feedback.PrintResult(getResult{key: toGet, data: resp.GetJsonData()})
var result getResult
err = json.Unmarshal([]byte(resp.GetJsonData()), &result.resp)
if err != nil {
feedback.Fatal(tr("Cannot parse JSON for key %[1]s: %[2]v", toGet, err), feedback.ErrGeneric)
}
feedback.PrintResult(result)
}
}

// output from this command may require special formatting.
// create a dedicated feedback.Result implementation to safely handle
// any changes to the configuration.Settings struct.
type getResult struct {
key string
data interface{}
resp interface{}
}

func (gr getResult) Data() interface{} {
return gr.data
return gr.resp
}

func (gr getResult) String() string {
gs, ok := gr.data.(string)
if !ok {
// Should never happen
panic(tr("Cannot get key %s value as string: %v", gr.key, gr.data))
}
return gs
return fmt.Sprintf("%v", gr.resp)
}
24 changes: 5 additions & 19 deletions internal/integrationtest/config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -834,31 +834,17 @@ func TestGet(t *testing.T) {
// Get simple key value
stdout, _, err = cli.Run("config", "get", "daemon.port", "--format", "json", "--config-file", "arduino-cli.yaml")
require.NoError(t, err)
require.Equal(t, `"50051"`, stdout)
requirejson.Contains(t, stdout, `"50051"`)

// Get structured key value
stdout, _, err = cli.Run("config", "get", "daemon", "--format", "json", "--config-file", "arduino-cli.yaml")
require.NoError(t, err)
require.Equal(t, `{"port":"50051"}`, stdout)

// Get multiple key values
stdout, _, err = cli.Run("config", "get", "logging.format", "logging.level", "--format", "json", "--config-file", "arduino-cli.yaml")
require.NoError(t, err)
require.Equal(t, `"text"`+"\n"+`"info"`, stdout)
requirejson.Contains(t, stdout, `{"port":"50051"}`)

// Get undefined key
stdout, _, err = cli.Run("config", "get", "foo", "--format", "json", "--config-file", "arduino-cli.yaml")
require.Empty(t, stdout)
require.Contains(t, err, "Cannot get key foo")

// Set undefined key
_, _, err = cli.Run("config", "set", "foo", "bar", "--config-file", "arduino-cli.yaml")
require.NoError(t, err)

// Get previously-undefined key
stdout, _, err = cli.Run("config", "get", "foo", "--format", "json", "--config-file", "arduino-cli.yaml")
require.NoError(t, err)
require.Equal(t, `"bar"`, stdout)
_, stderr, err := cli.Run("config", "get", "foo", "--format", "json", "--config-file", "arduino-cli.yaml")
require.Error(t, err)
requirejson.Contains(t, stderr, `{"error":"Cannot get the key foo: key not found in settings"}`)
}

func TestInitializationOrderOfConfigThroughFlagAndEnv(t *testing.T) {
Expand Down
0