Skip to content

Commit c5159d1

Browse files
committed
Fix code naming issues
1 parent 813f5a7 commit c5159d1

File tree

2 files changed

+25
-25
lines changed

2 files changed

+25
-25
lines changed

commands/upload/upload.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ func SupportedUserFields(ctx context.Context, req *rpc.SupportedUserFieldsReques
5959
return nil, fmt.Errorf("loading board data: %s", err)
6060
}
6161

62-
toolId, err := getToolId(board.Properties, "upload", req.Protocol)
62+
toolID, err := getToolID(board.Properties, "upload", req.Protocol)
6363
if err != nil {
6464
return nil, err
6565
}
6666

67-
userFields, err := getUserFields(toolId, platformRelease)
67+
userFields, err := getUserFields(toolID, platformRelease)
6868
if err != nil {
6969
return nil, err
7070
}
@@ -74,9 +74,9 @@ func SupportedUserFields(ctx context.Context, req *rpc.SupportedUserFieldsReques
7474
}, nil
7575
}
7676

77-
// getToolId returns the ID of the tool that supports the action and protocol combination by searching in props.
77+
// getToolID returns the ID of the tool that supports the action and protocol combination by searching in props.
7878
// Returns error if tool cannot be found.
79-
func getToolId(props *properties.Map, action, protocol string) (string, error) {
79+
func getToolID(props *properties.Map, action, protocol string) (string, error) {
8080
toolProperty := fmt.Sprintf("%s.tool.%s", action, protocol)
8181
defaultToolProperty := fmt.Sprintf("%s.tool.default", action)
8282

@@ -92,9 +92,9 @@ func getToolId(props *properties.Map, action, protocol string) (string, error) {
9292

9393
// getUserFields return all user fields supported by the tools specified.
9494
// Returns error only in case the secret property is not a valid boolean.
95-
func getUserFields(toolId string, platformRelease *cores.PlatformRelease) ([]*rpc.UserField, error) {
95+
func getUserFields(toolID string, platformRelease *cores.PlatformRelease) ([]*rpc.UserField, error) {
9696
userFields := []*rpc.UserField{}
97-
fields := platformRelease.Properties.SubTree(fmt.Sprintf("tools.%s.upload.field", toolId))
97+
fields := platformRelease.Properties.SubTree(fmt.Sprintf("tools.%s.upload.field", toolID))
9898
keys := fields.FirstLevelKeys()
9999

100100
for _, key := range keys {
@@ -106,10 +106,10 @@ func getUserFields(toolId string, platformRelease *cores.PlatformRelease) ([]*rp
106106
}
107107
isSecret, err := strconv.ParseBool(secret)
108108
if err != nil {
109-
return nil, fmt.Errorf(`parsing "tools.%s.upload.field.%s.secret", property is not a boolean`, toolId, key)
109+
return nil, fmt.Errorf(`parsing "tools.%s.upload.field.%s.secret", property is not a boolean`, toolID, key)
110110
}
111111
userFields = append(userFields, &rpc.UserField{
112-
ToolId: toolId,
112+
ToolId: toolID,
113113
Name: key,
114114
Label: value,
115115
Secret: isSecret,
@@ -242,7 +242,7 @@ func runProgramAction(pm *packagemanager.PackageManager,
242242
} else if programmer != nil {
243243
action = "program"
244244
}
245-
uploadToolID, err := getToolId(props, action, port.Protocol)
245+
uploadToolID, err := getToolID(props, action, port.Protocol)
246246
if err != nil {
247247
return err
248248
}

commands/upload/upload_test.go

+16-16
Original file line numberDiff line numberDiff line change
@@ -230,42 +230,42 @@ upload.tool.serial=bossac
230230
upload.tool.network=arduino_ota`))
231231
require.NoError(t, err)
232232

233-
toolId, err := getToolId(props, "upload", "serial")
233+
toolID, err := getToolID(props, "upload", "serial")
234234
require.NoError(t, err)
235-
require.Equal(t, "bossac", toolId)
235+
require.Equal(t, "bossac", toolID)
236236

237-
toolId, err = getToolId(props, "upload", "network")
237+
toolID, err = getToolID(props, "upload", "network")
238238
require.NoError(t, err)
239-
require.Equal(t, "arduino_ota", toolId)
239+
require.Equal(t, "arduino_ota", toolID)
240240

241-
toolId, err = getToolId(props, "bootloader", "serial")
241+
toolID, err = getToolID(props, "bootloader", "serial")
242242
require.NoError(t, err)
243-
require.Equal(t, "avrdude", toolId)
243+
require.Equal(t, "avrdude", toolID)
244244

245-
toolId, err = getToolId(props, "bootloader", "network")
245+
toolID, err = getToolID(props, "bootloader", "network")
246246
require.EqualError(t, err, "cannot find tool: undefined 'bootloader.tool.network' property")
247-
require.Equal(t, "", toolId)
247+
require.Equal(t, "", toolID)
248248

249249
props, err = properties.LoadFromBytes([]byte(`
250250
bootloader.tool.default=avrdude
251251
upload.tool.default=bossac`))
252252
require.NoError(t, err)
253253

254-
toolId, err = getToolId(props, "upload", "serial")
254+
toolID, err = getToolID(props, "upload", "serial")
255255
require.NoError(t, err)
256-
require.Equal(t, "bossac", toolId)
256+
require.Equal(t, "bossac", toolID)
257257

258-
toolId, err = getToolId(props, "upload", "network")
258+
toolID, err = getToolID(props, "upload", "network")
259259
require.NoError(t, err)
260-
require.Equal(t, "bossac", toolId)
260+
require.Equal(t, "bossac", toolID)
261261

262-
toolId, err = getToolId(props, "bootloader", "serial")
262+
toolID, err = getToolID(props, "bootloader", "serial")
263263
require.NoError(t, err)
264-
require.Equal(t, "avrdude", toolId)
264+
require.Equal(t, "avrdude", toolID)
265265

266-
toolId, err = getToolId(props, "bootloader", "network")
266+
toolID, err = getToolID(props, "bootloader", "network")
267267
require.NoError(t, err)
268-
require.Equal(t, "avrdude", toolId)
268+
require.Equal(t, "avrdude", toolID)
269269
}
270270

271271
func TestGetUserFields(t *testing.T) {

0 commit comments

Comments
 (0)