Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add first set of profile commands #2917

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

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Add first set of profile commands #2917

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
c282cc6
Add `profile init` command
MatteoPologruto May 21, 2025
d3d7a59
Add `profile lib add` command
MatteoPologruto May 22, 2025
f98bf7d
Add `profile lib remove` command
MatteoPologruto May 22, 2025
235005d
Support default profiles
MatteoPologruto May 23, 2025
d47a687
Switch to structured error
MatteoPologruto May 23, 2025
4d167f3
Add more test cases
MatteoPologruto May 23, 2025
a2c86ef
Add `profile set-default` command
MatteoPologruto May 23, 2025
0d295ca
Add `profile dump` command
MatteoPologruto May 27, 2025
c8a3e4e
Add comments to functions
MatteoPologruto May 27, 2025
a99efdd
Fix spacing
MatteoPologruto May 27, 2025
8f009bc
Apply review suggestions
MatteoPologruto May 30, 2025
f5943ab
Generate a correct yaml when properties are empty
MatteoPologruto May 30, 2025
5381938
Refactor preconditions checks
MatteoPologruto May 30, 2025
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
Add more test cases
  • Loading branch information
@MatteoPologruto
MatteoPologruto committed May 23, 2025
commit 4d167f35d0c569ee58161c717f6c430dad2408e2
116 changes: 114 additions & 2 deletions internal/integrationtest/profiles/profiles_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ func TestInitProfile(t *testing.T) {
{"ProfileWrongFQBN", initWithWrongFqbn},
{"ProfileMissingFQBN", initMissingFqbn},
{"ExistingProfile", initExistingProfile},
{"SetDefaultProfile", initSetDefaultProfile},
}.Run(t, env, cli)
}

Expand All @@ -194,7 +195,7 @@ func initWithCorrectFqbn(t *testing.T, env *integrationtest.Environment, cli *in
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\n", string(fileContent))
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))
}

func initWithWrongFqbn(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
Expand All @@ -215,7 +216,16 @@ func initExistingProfile(t *testing.T, env *integrationtest.Environment, cli *in
// Adding a profile with a name that already exists should return an error
_, stderr, err := cli.Run("profile", "init", cli.SketchbookDir().Join("Simple").String(), "-m", "Uno", "-b", "arduino:avr:uno")
require.Error(t, err)
require.Contains(t, string(stderr), "the profile already exists")
require.Contains(t, string(stderr), "Profile 'Uno' already exists")
}

func initSetDefaultProfile(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
// Adding a profile with a name that already exists should return an error
_, _, err := cli.Run("profile", "init", cli.SketchbookDir().Join("Simple").String(), "-m", "new_profile", "-b", "arduino:avr:uno", "--default")
require.NoError(t, err)
fileContent, err := cli.SketchbookDir().Join("Simple", "sketch.yaml").ReadFileAsLines()
require.NoError(t, err)
require.Contains(t, fileContent, "default_profile: new_profile")
}

func TestInitProfileMissingSketchFile(t *testing.T) {
Expand Down Expand Up @@ -253,3 +263,105 @@ func TestInitProfilePlatformNotInstalled(t *testing.T) {
require.Error(t, err)
require.Contains(t, string(stderr), "platform not installed")
}

func TestProfileLib(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()

// Init the environment explicitly
_, _, err := cli.Run("core", "update-index")
require.NoError(t, err)

_, _, err = cli.Run("sketch", "new", cli.SketchbookDir().Join("Simple").String())
require.NoError(t, err)

_, _, err = cli.Run("core", "install", "arduino:avr")
require.NoError(t, err)

_, _, err = cli.Run("profile", "init", cli.SketchbookDir().Join("Simple").String(), "-m", "Uno", "-b", "arduino:avr:uno")
require.NoError(t, err)

integrationtest.CLISubtests{
{"AddLibToDefaultProfile", addLibToDefaultProfile},
{"ChangeLibVersionDefaultProfile", changeLibVersionDefaultProfile},
{"RemoveLibFromDefaultProfile", removeLibFromDefaultProfile},
{"AddInexistentLibToDefaultProfile", addInexistentLibToDefaultProfile},
{"RemoveLibNotInDefaultProfile", removeLibNotInDefaultProfile},
}.Run(t, env, cli)
}

func addLibToDefaultProfile(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
_, _, err := cli.Run("profile", "lib", "add", "[email protected]", "--dest-dir", cli.SketchbookDir().Join("Simple").String())
require.NoError(t, err)
fileContent, err := cli.SketchbookDir().Join("Simple", "sketch.yaml").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 - Modulino (0.5.0)\n\ndefault_profile: Uno\n", string(fileContent))
}

func changeLibVersionDefaultProfile(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
fileContent, err := cli.SketchbookDir().Join("Simple", "sketch.yaml").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 - Modulino (0.5.0)\n\ndefault_profile: Uno\n", string(fileContent))

_, _, err = cli.Run("profile", "lib", "add", "[email protected]", "--dest-dir", cli.SketchbookDir().Join("Simple").String())
require.NoError(t, err)
fileContent, err = cli.SketchbookDir().Join("Simple", "sketch.yaml").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 - Modulino (0.4.0)\n\ndefault_profile: Uno\n", string(fileContent))
}

func removeLibFromDefaultProfile(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
_, _, err := cli.Run("profile", "lib", "remove", "Modulino", "--dest-dir", cli.SketchbookDir().Join("Simple").String())
require.NoError(t, err)
fileContent, err := cli.SketchbookDir().Join("Simple", "sketch.yaml").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))
}

func addInexistentLibToDefaultProfile(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
_, stderr, err := cli.Run("profile", "lib", "add", "foobar", "--dest-dir", cli.SketchbookDir().Join("Simple").String())
require.Error(t, err)
require.Equal(t, "Error adding foobar to the profile : Library 'foobar@latest' not found\n", string(stderr))
}

func removeLibNotInDefaultProfile(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
_, stderr, err := cli.Run("profile", "lib", "remove", "Arduino_JSON", "--dest-dir", cli.SketchbookDir().Join("Simple").String())
require.Error(t, err)
require.Equal(t, "Error removing Arduino_JSON from the profile : Library 'Arduino_JSON' not found\n", string(stderr))
}

func TestProfileLibSpecificProfile(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()

// Init the environment explicitly
_, _, err := cli.Run("core", "update-index")
require.NoError(t, err)

_, _, err = cli.Run("sketch", "new", cli.SketchbookDir().Join("Simple").String())
require.NoError(t, err)

_, _, err = cli.Run("core", "install", "arduino:avr")
require.NoError(t, err)

_, _, err = cli.Run("profile", "init", cli.SketchbookDir().Join("Simple").String(), "-m", "Uno", "-b", "arduino:avr:uno")
require.NoError(t, err)

// Add a second profile
_, _, err = cli.Run("profile", "init", cli.SketchbookDir().Join("Simple").String(), "-m", "my_profile", "-b", "arduino:avr:uno")
require.NoError(t, err)

// Add library to a specific profile
_, _, err = cli.Run("profile", "lib", "add", "[email protected]", "-m", "my_profile", "--dest-dir", cli.SketchbookDir().Join("Simple").String())
require.NoError(t, err)
fileContent, err := cli.SketchbookDir().Join("Simple", "sketch.yaml").ReadFile()
require.NoError(t, err)
require.Contains(t, string(fileContent), " my_profile:\n fqbn: arduino:avr:uno\n platforms:\n - platform: arduino:avr (1.8.6)\n libraries:\n - Modulino (0.5.0)\n")

// Remove library from a specific profile
_, _, err = cli.Run("profile", "lib", "remove", "Modulino", "-m", "my_profile", "--dest-dir", cli.SketchbookDir().Join("Simple").String())
require.NoError(t, err)
fileContent, err = cli.SketchbookDir().Join("Simple", "sketch.yaml").ReadFile()
require.NoError(t, err)
require.NotContains(t, string(fileContent), "- Modulino (0.5.0)")
}
Loading