Skip to content

Simplified getUserFields method #1412

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 1 commit into from
Aug 24, 2021
Merged

Simplified getUserFields method #1412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 4 additions & 18 deletions commands/upload/upload.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import (
"fmt"
"io"
"path/filepath"
"strconv"
"strings"

"github.com/arduino/arduino-cli/arduino/cores"
Expand Down Expand Up @@ -67,13 +66,8 @@ func SupportedUserFields(ctx context.Context, req *rpc.SupportedUserFieldsReques
return nil, err
}

userFields, err := getUserFields(toolID, platformRelease)
if err != nil {
return nil, err
}

return &rpc.SupportedUserFieldsResponse{
UserFields: userFields,
UserFields: getUserFields(toolID, platformRelease),
}, nil
}

Expand All @@ -95,7 +89,7 @@ func getToolID(props *properties.Map, action, protocol string) (string, error) {

// getUserFields return all user fields supported by the tools specified.
// Returns error only in case the secret property is not a valid boolean.
func getUserFields(toolID string, platformRelease *cores.PlatformRelease) ([]*rpc.UserField, error) {
func getUserFields(toolID string, platformRelease *cores.PlatformRelease) []*rpc.UserField {
userFields := []*rpc.UserField{}
fields := platformRelease.Properties.SubTree(fmt.Sprintf("tools.%s.upload.field", toolID))
keys := fields.FirstLevelKeys()
Expand All @@ -105,15 +99,7 @@ func getUserFields(toolID string, platformRelease *cores.PlatformRelease) ([]*rp
if len(value) > 50 {
value = fmt.Sprintf("%s…", value[:49])
}
secretProp := fmt.Sprintf("%s.secret", key)
secret, ok := fields.GetOk(secretProp)
if !ok {
secret = "false"
}
isSecret, err := strconv.ParseBool(secret)
if err != nil {
return nil, fmt.Errorf(tr("parsing %s, property is not a boolean"), fmt.Sprintf(`"tools.%s.upload.field.%s.secret"`, toolID, key))
}
isSecret := fields.GetBoolean(fmt.Sprintf("%s.secret", key))
userFields = append(userFields, &rpc.UserField{
ToolId: toolID,
Name: key,
Expand All @@ -122,7 +108,7 @@ func getUserFields(toolID string, platformRelease *cores.PlatformRelease) ([]*rp
})
}

return userFields, nil
return userFields
}

// Upload FIXMEDOC
Expand Down
10 changes: 2 additions & 8 deletions commands/upload/upload_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,8 +282,7 @@ tools.arduino_ota.upload.field.password.secret=true`))

platformRelease.Properties = props

userFields, err := getUserFields("avrdude", platformRelease)
require.NoError(t, err)
userFields := getUserFields("avrdude", platformRelease)
require.Len(t, userFields, 2)
require.Equal(t, userFields[0].ToolId, "avrdude")
require.Equal(t, userFields[0].Name, "username")
Expand All @@ -300,17 +299,12 @@ tools.arduino_ota.upload.field.password.secret=THIS_IS_NOT_A_BOOLEAN`))
require.NoError(t, err)
platformRelease.Properties = props

userFields, err = getUserFields("arduino_ota", platformRelease)
require.Nil(t, userFields)
require.EqualError(t, err, `parsing "tools.arduino_ota.upload.field.password.secret", property is not a boolean`)

props, err = properties.LoadFromBytes([]byte(`
tools.arduino_ota.upload.field.some_field=This is a really long label that ideally must never be set by any platform
`))
require.NoError(t, err)
platformRelease.Properties = props
userFields, err = getUserFields("arduino_ota", platformRelease)
require.NoError(t, err)
userFields = getUserFields("arduino_ota", platformRelease)
require.Len(t, userFields, 1)
require.Equal(t, userFields[0].ToolId, "arduino_ota")
require.Equal(t, userFields[0].Name, "some_field")
Expand Down
Loading