Add first set of `profile` commands #2917

MatteoPologruto · 2025-05-21T15:39:24Z

Please check if the PR fulfills these requirements

See how to contribute

The PR has no duplicates (please search among the Pull Requests
before creating one)
The PR follows
our contributing guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
UPGRADING.md has been updated with a migration guide (for breaking changes)
configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Code enhancement

What is the current behavior?

Operations on the sketch.yaml project file must be done manually.

What is the new behavior?

First set of profile commands:

profile init [<PATH>] [-m <PROFILE_NAME -b <FQBN>] [--default] creates a sketch.yaml file at the provided path. By default it creates the file in the current directory. A new profile can be added to the file by providing a profile name and FQBN (mandatory). The platform is detected automatically. If there is only one profile, it is automatically set as the default profile, otherwise the flag --default must be used. The command fails in the following cases:
- the path does not exist or the main sketch file is missing
- the FQBN is wrong or the platform related to it is not installed locally
profile lib add <LIB_NAME@LIB_VERSION> [-m <PROFILE_NAME] [--dest-dir <PATH>] adds a library to the provided profile or to the default one. By default it checks for the sketch.yaml file in the current directory.
profile lib remove <LIB_NAME> [-m <PROFILE_NAME] [--dest-dir <PATH>] removes a library from the provided profile or from the default one. By default it checks for the sketch.yaml file in the current directory.
profile set-default <PROFILE_NAME> [--dest-dir <PATH>] sets the default profile to an existing profile. By default it checks for the sketch.yaml file in the current directory.
profile dump [<PATH>] dumps the content of the sketch.yaml file. It supports the yaml and json formats.

Does this PR introduce a breaking change, and is titled accordingly?

Other information

codecov · 2025-05-21T15:53:30Z

Codecov Report

Attention: Patch coverage is 66.50485% with 138 lines in your changes missing coverage. Please review.

Project coverage is 67.82%. Comparing base (dd621ee) to head (a99efdd).

Files with missing lines	Patch %	Lines
internal/cli/profile/dump.go	20.93%	33 Missing and 1 partial ⚠️
commands/service_profile_lib_add.go	54.34%	14 Missing and 7 partials ⚠️
commands/service_profile_dump.go	0.00%	16 Missing ⚠️
commands/service_profile_init.go	74.60%	11 Missing and 5 partials ⚠️
internal/cli/profile/lib.go	84.31%	14 Missing and 2 partials ⚠️
commands/service_profile_lib_remove.go	50.00%	10 Missing and 5 partials ⚠️
commands/service_profile_set_default.go	45.45%	8 Missing and 4 partials ⚠️
commands/cmderrors/cmderrors.go	25.00%	6 Missing ⚠️
internal/cli/profile/init.go	94.44%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2917      +/-   ##
==========================================
- Coverage   67.83%   67.82%   -0.02%     
==========================================
  Files         238      248      +10     
  Lines       22442    22854     +412     
==========================================
+ Hits        15223    15500     +277     
- Misses       6016     6128     +112     
- Partials     1203     1226      +23

Flag	Coverage Δ
unit	`67.82% <66.50%> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

It creates a `sketch.yaml` file at the provided path. A new profile can be added to the file by providing a profile name and FQBN.

It adds one or multiple libraries to the specified profile.

It removes a library from the specified profile.

If the project file contains only one profile, it is automatically set as default, otherwise the `--default` flag can be used. Library operations are automatically executed on the default profile.

Sets the default profile to the provided existing profile.

It dumps the content of the project file.

kittaakos · 2025-05-27T14:40:25Z

Hello, this is great 🔥 Maybe you want to consider adding and removing multiple libs (later cores) with a single request. I do not know how it performs, but when a user interface wants to initialize a profile from a set of libraries and cores, one request would be better than multiple ones.

Update: I checked the changes only from the point of the proto API as a client.

alessio-perugini

Great job! 🚀

We have a bug in the long standing:

arduino-cli/internal/arduino/sketch/profiles.go

Lines 166 to 167 in 55f86b5

    
           res += p.Platforms.AsYaml() 
        
           res += p.Libraries.AsYaml()

arduino-cli profile init --profile Uno_profile -b arduino:avr:uno /tmp/sk

cat /tmp/sk/sketch.yaml

profiles:
  Uno_profile:
    fqbn: arduino:avr:uno
    platforms:
      - platform: arduino:avr (1.8.6)
    libraries:

default_profile: c

You can see here that it produces libraries: without [], this is an invalid yaml.

Basically we have to check if the items == 0, then we either skip that property or we set libraries: [].
I'm afraid it could also happen for the platforms so I'd put that check there too.

alessio-perugini · 2025-05-28T12:47:18Z

commands/cmderrors/cmderrors.go

+
+// GRPCStatus converts the error into a *status.Status
+func (e *DuplicateProfileError) GRPCStatus() *status.Status {
+	return status.New(codes.NotFound, e.Error())


Suggested change

return status.New(codes.NotFound, e.Error())

return status.New(codes.AlreadyExists, e.Error())

alessio-perugini · 2025-05-28T12:56:10Z

rpc/cc/arduino/cli/commands/v1/commands.proto

+message ProfileDumpRequest {
+  // Absolute path to Sketch folder.
+  string sketch_path = 1;
+  // The format of the dump.


Suggested change

// The format of the dump.

// The format of the dump (default is "json", allowed values are "json", and "yaml").

To be consistent with also the Configuation operation, I'd set a default value to json

alessio-perugini · 2025-05-28T12:58:02Z

commands/service_profile_dump.go

+	switch req.GetDumpFormat() {
+	case "yaml":
+		return &rpc.ProfileDumpResponse{EncodedProfile: sk.Project.AsYaml()}, nil
+	case "json":


Suggested change

case "json":

case "", "json":

Let's allow a default value if the DumpFormat is not specified to be json. This is consistent with what we're doing with Settings api

alessio-perugini · 2025-05-28T14:00:49Z

commands/service_profile_init.go

+		}
+
+		newProfile := &sketch.Profile{Name: req.GetProfileName(), FQBN: req.GetFqbn()}
+		// TODO: what to do with the PlatformIndexURL?


Do we have some kind of internal API that we can use to retrieve platform <-> index URL?

cc: @cmaglie

alessio-perugini · 2025-05-28T14:26:18Z

internal/cli/profile/init.go

+		Example: "" +
+			"  # " + i18n.Tr("Creates or updates the sketch project file in the current directory.") + "\n" +
+			"  " + os.Args[0] + " profile init\n" +
+			"  " + os.Args[0] + " config init --profile Uno_profile -b arduino:avr:uno",


Suggested change

" " + os.Args[0] + " config init --profile Uno_profile -b arduino:avr:uno",

" " + os.Args[0] + " profile init --profile uno_profile -b arduino:avr:uno",

alessio-perugini · 2025-05-28T14:30:07Z

internal/cli/profile/set_default.go

+	if err != nil {
+		feedback.Fatal(i18n.Tr("Cannot set %s as default profile: %v", profileName, err), feedback.ErrGeneric)
+	}
+}


Suggested change

}

feedback.Print(i18n.Tr("Default profile set to: %s", profileName))

}

alessio-perugini · 2025-05-28T14:47:02Z

commands/service_profile_init.go

+	sketchPath := paths.New(req.GetSketchPath())
+	projectFilePath, err := sketchPath.Join("sketch.yaml").Abs()
+	if err != nil {
+		return nil, err
+	}
+
+	// Returns an error if the main file is missing from the sketch so there is no need to check if the path exists
+	sk, err := sketch.New(sketchPath)
+	if err != nil {
+		return nil, err
+	}


Suggested change

sketchPath := paths.New(req.GetSketchPath())

projectFilePath, err := sketchPath.Join("sketch.yaml").Abs()

if err != nil {

return nil, err

}

// Returns an error if the main file is missing from the sketch so there is no need to check if the path exists

sk, err := sketch.New(sketchPath)

if err != nil {

return nil, err

}

sketchPath := paths.New(req.GetSketchPath())

projectFilePath, err := sketchPath.Join("sketch.yaml").Abs()

if err != nil {

return nil, err

}

// Returns an error if the main file is missing from the sketch so there is no need to check if the path exists

sk, err := sketch.New(sketchPath)

if err != nil {

return nil, err

}

Can you please move this snippet of code under a private function? Something like checkProfilePreconditions.
And call that in all the new function you have created under commands. I've noticed that you do this same check for al of them

alessio-perugini · 2025-05-28T15:38:54Z

commands/service_profile_init.go

+	if !projectFilePath.Exist() {
+		err := projectFilePath.WriteFile([]byte("profiles:\n"))
+		if err != nil {
+			return nil, err
+		}
+	}


In the GRPC api, is possible to endup with a project file containing an invalid yaml:

profiles:

This can happen if: the path doesn't exists and the ProfileName is empty

Suggested change

if !projectFilePath.Exist() {

err := projectFilePath.WriteFile([]byte("profiles:\n"))

if err != nil {

return nil, err

}

}

if !projectFilePath.Exist() && req.GetProfileName() == ""{

// return error

return nil, error

}

if !projectFilePath.Exist() {

err := projectFilePath.WriteFile([]byte("profiles:\n"))

if err != nil {

return nil, err

}

}

alessio-perugini · 2025-05-28T15:44:04Z

internal/integrationtest/profiles/profiles_test.go

+	require.FileExists(t, projectFile.String())
+	fileContent, err := projectFile.ReadFile()
+	require.NoError(t, err)
+	require.Equal(t, "profiles:\n  Uno:\n    fqbn: arduino:avr:uno\n    platforms:\n      - platform: arduino:avr (1.8.6)\n    libraries:\n\ndefault_profile: Uno\n", string(fileContent))


libraries:\n
this is not a valid yaml it should be libraries:[]\n

In the Review comment you can find where to fix it

per1234

I feel that the design of the profile dump command is inappropriate. This command is actually printing the data of the entire sketch project file, not the build profile data alone. Although the primary usage of the sketch project file is currently for defining build profiles, it is not limited to this purpose and there is a good chance that it will be used for additional things unrelated to build profiles as time goes on.

The profile dump command should be a tool for printing the data from a build profile.

If you want a tool for printing the sketch project file, that should go somewhere else, such as under the sketch command (e.g., sketch project dump), not under the profile command.

If the user doesn't specify a profile ID, it should print the default build profile from the sketch project file. An --all flag could be added to cause it to print all build profiles present in the sketch project file.

per1234 · 2025-05-29T03:58:24Z

internal/cli/profile/dump.go

+		Short: i18n.Tr("Dumps the project file."),
+		Long:  i18n.Tr("Dumps the project file."),


Suggested change

Short: i18n.Tr("Dumps the project file."),

Long: i18n.Tr("Dumps the project file."),

Short: i18n.Tr("Print the sketch project file."),

Long: i18n.Tr("Print the data from the sketch project file."),

Use "print" instead of "dump"

I think the term "dump" is ambiguous (the user might interpret it as meaning "delete")

The use of the term "dump" doesn't add anything of documentary value since this is already in the command name.

This aligns with the documentation for config dump.

Use the established convention of the "imperative mood" (i.e., "print" instead of "prints")

Use the full standard term "sketch project file"

"Project file" is ambiguous as this could be interpreted as meaning the sketch code file.

Be a bit more informative in the "long" description.

per1234 · 2025-05-29T03:59:50Z

internal/cli/profile/init.go

+		Short: i18n.Tr("Creates or updates the sketch project file."),
+		Long:  i18n.Tr("Creates or updates the sketch project file."),


Suggested change

Short: i18n.Tr("Creates or updates the sketch project file."),

Long: i18n.Tr("Creates or updates the sketch project file."),

Short: i18n.Tr("Create or update the sketch project file."),

Long: i18n.Tr("Create or update the sketch project file."),

Use the established convention of the "imperative mood".

per1234 · 2025-05-29T04:04:48Z

internal/cli/profile/lib.go

+		Short: i18n.Tr("Profile commands about libraries."),
+		Long:  i18n.Tr("Profile commands about libraries."),


Suggested change

Short: i18n.Tr("Profile commands about libraries."),

Long: i18n.Tr("Profile commands about libraries."),

Short: i18n.Tr("Commands related to build profile libraries."),

Long: i18n.Tr("Commands related to the library dependencies of build profiles."),

Make the descriptions more informative.

Use full standard term "build profile".

per1234 · 2025-05-29T04:06:15Z

internal/cli/profile/profile.go

+		Short:   i18n.Tr("Arduino profile operations."),
+		Long:    i18n.Tr("Arduino profile operations."),


Suggested change

Short: i18n.Tr("Arduino profile operations."),

Long: i18n.Tr("Arduino profile operations."),

Short: i18n.Tr("Build profile operations."),

Long: i18n.Tr("Build profile operations."),

Remove the superfluous "Arduino"

Use the full standard term "build profile"

per1234 · 2025-05-29T04:07:58Z

internal/cli/profile/set_default.go

+		Short: i18n.Tr("Sets the default profile."),
+		Long:  i18n.Tr("Sets the default profile."),


Suggested change

Short: i18n.Tr("Sets the default profile."),

Long: i18n.Tr("Sets the default profile."),

Short: i18n.Tr("Set the default build profile."),

Long: i18n.Tr("Set the default build profile."),

Use the full standard term "build profile"

Use the established convention of the "imperative mood".

per1234 · 2025-05-29T04:10:09Z

internal/cli/profile/set_default.go

+		},
+	}
+
+	setDefaultCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))


Suggested change

setDefaultCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))

setDefaultCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the sketch project file."))

Use the full standard term "sketch project file"

per1234 · 2025-05-29T04:11:47Z

rpc/cc/arduino/cli/commands/v1/commands.proto

+  // Create the project file and add a profile to it.
+  rpc InitProfile(InitProfileRequest) returns (InitProfileResponse) {}
+
+  // Add a library to the profile.
+  rpc ProfileLibAdd(ProfileLibAddRequest) returns (ProfileLibAddResponse) {}
+
+  // Remove a library from the profile.
+  rpc ProfileLibRemove(ProfileLibRemoveRequest) returns (ProfileLibRemoveResponse) {}
+
+  // Set the default profile.
+  rpc ProfileSetDefault(ProfileSetDefaultRequest) returns (ProfileSetDefaultResponse) {}
+
+  // Dump the project file.
+  rpc ProfileDump(ProfileDumpRequest) returns (ProfileDumpResponse) {}


Suggested change

// Create the project file and add a profile to it.

rpc InitProfile(InitProfileRequest) returns (InitProfileResponse) {}

// Add a library to the profile.

rpc ProfileLibAdd(ProfileLibAddRequest) returns (ProfileLibAddResponse) {}

// Remove a library from the profile.

rpc ProfileLibRemove(ProfileLibRemoveRequest) returns (ProfileLibRemoveResponse) {}

// Set the default profile.

rpc ProfileSetDefault(ProfileSetDefaultRequest) returns (ProfileSetDefaultResponse) {}

// Dump the project file.

rpc ProfileDump(ProfileDumpRequest) returns (ProfileDumpResponse) {}

// Create the sketch project file and add a build profile to it.

rpc InitProfile(InitProfileRequest) returns (InitProfileResponse) {}

// Add a library to the build profile.

rpc ProfileLibAdd(ProfileLibAddRequest) returns (ProfileLibAddResponse) {}

// Remove a library from the build profile.

rpc ProfileLibRemove(ProfileLibRemoveRequest) returns (ProfileLibRemoveResponse) {}

// Set the default build profile.

rpc ProfileSetDefault(ProfileSetDefaultRequest) returns (ProfileSetDefaultResponse) {}

// Dump the sketch project file.

rpc ProfileDump(ProfileDumpRequest) returns (ProfileDumpResponse) {}

per1234 · 2025-05-29T04:12:54Z

internal/cli/profile/lib.go

+		},
+	}
+
+	addCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))


Suggested change

addCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))

addCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the sketch project file."))

per1234 · 2025-05-29T04:13:12Z

internal/cli/profile/lib.go

+		},
+	}
+
+	removeCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))


Suggested change

removeCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))

removeCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the sketch project file."))

MatteoPologruto self-assigned this May 21, 2025

MatteoPologruto added type: enhancement Proposed improvement topic: code Related to content of the project itself labels May 21, 2025

MatteoPologruto linked an issue May 21, 2025 that may be closed by this pull request

Add first set of profile commands #2916

Open

3 tasks

MatteoPologruto changed the title ~~Add first set of profile command~~ Add first set of profile commands May 21, 2025

Add profile init command

c282cc6

It creates a `sketch.yaml` file at the provided path. A new profile can be added to the file by providing a profile name and FQBN.

MatteoPologruto force-pushed the add-profiles-command-support branch 2 times, most recently from ab96ed6 to 8a41c13 Compare May 22, 2025 12:25

Add profile lib add command

d3d7a59

It adds one or multiple libraries to the specified profile.

MatteoPologruto force-pushed the add-profiles-command-support branch from 8a41c13 to d3d7a59 Compare May 22, 2025 13:32

Add profile lib remove command

f98bf7d

It removes a library from the specified profile.

MatteoPologruto force-pushed the add-profiles-command-support branch from 67c9a2c to f98bf7d Compare May 22, 2025 14:46

MatteoPologruto added 4 commits May 23, 2025 15:26

Support default profiles

235005d

If the project file contains only one profile, it is automatically set as default, otherwise the `--default` flag can be used. Library operations are automatically executed on the default profile.

Switch to structured error

d47a687

Add more test cases

4d167f3

Add profile set-default command

a2c86ef

Sets the default profile to the provided existing profile.

MatteoPologruto force-pushed the add-profiles-command-support branch from 896841b to a2c86ef Compare May 23, 2025 15:21

MatteoPologruto added 3 commits May 27, 2025 15:53

Add profile dump command

0d295ca

It dumps the content of the project file.

Add comments to functions

c8a3e4e

Fix spacing

a99efdd

MatteoPologruto marked this pull request as ready for review May 27, 2025 14:08

MatteoPologruto requested review from cmaglie and a team May 27, 2025 14:08

alessio-perugini requested changes May 28, 2025

View reviewed changes

per1234 requested changes May 29, 2025

View reviewed changes

	return status.New(codes.NotFound, e.Error())
	return status.New(codes.AlreadyExists, e.Error())

	// The format of the dump.
	// The format of the dump (default is "json", allowed values are "json", and "yaml").

	" " + os.Args[0] + " config init --profile Uno_profile -b arduino:avr:uno",
	" " + os.Args[0] + " profile init --profile uno_profile -b arduino:avr:uno",

	}
	feedback.Print(i18n.Tr("Default profile set to: %s", profileName))
	}

		Short: i18n.Tr("Dumps the project file."),
		Long: i18n.Tr("Dumps the project file."),

		Short: i18n.Tr("Creates or updates the sketch project file."),
		Long: i18n.Tr("Creates or updates the sketch project file."),

		Short: i18n.Tr("Profile commands about libraries."),
		Long: i18n.Tr("Profile commands about libraries."),

		Short: i18n.Tr("Arduino profile operations."),
		Long: i18n.Tr("Arduino profile operations."),

		Short: i18n.Tr("Sets the default profile."),
		Long: i18n.Tr("Sets the default profile."),

	setDefaultCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))
	setDefaultCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the sketch project file."))

	addCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))
	addCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the sketch project file."))

	removeCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))
	removeCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the sketch project file."))

Uh oh!

Add first set of profile commands #2917

Are you sure you want to change the base?

Add first set of profile commands #2917

Conversation

MatteoPologruto commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Please check if the PR fulfills these requirements

What kind of change does this PR introduce?

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change, and is titled accordingly?

Other information

Uh oh!

codecov bot commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kittaakos commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alessio-perugini left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

per1234 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Add first set of `profile` commands #2917

Add first set of `profile` commands #2917

MatteoPologruto commented May 21, 2025 •

edited

Loading

codecov bot commented May 21, 2025 •

edited

Loading

kittaakos commented May 27, 2025 •

edited

Loading

alessio-perugini left a comment •

edited

Loading

per1234 left a comment •

edited

Loading