Skip to content

[skip-changelog] Verify installation of builtin tools by checking that their executable is present #2168

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 2 commits into from
May 15, 2023
Merged

[skip-changelog] Verify installation of builtin tools by checking that their executable is present #2168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39ca3ef
Update previously written tests
MatteoPologruto May 3, 2023
402a331
Verify builtin tools are correctly installed
MatteoPologruto May 3, 2023
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
12 changes: 8 additions & 4 deletions arduino/cores/packagemanager/loader_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ arduino_zero_edbg.serial.disableRTS=true

func TestLoadDiscoveries(t *testing.T) {
// Create all the necessary data to load discoveries
fakePath := paths.New("fake-path")
require.NoError(t, fakePath.Join("LICENSE").MkdirAll())
fakePath, err := paths.TempDir().MkTempDir("fake-path")
require.NoError(t, err)
defer fakePath.RemoveAll()

createTestPackageManager := func() *PackageManager {
Expand All @@ -181,6 +181,9 @@ func TestLoadDiscoveries(t *testing.T) {
toolRelease := tool.GetOrCreateRelease(semver.ParseRelaxed("1.0.0"))
// We set this to fake the tool is installed
toolRelease.InstallDir = fakePath
f, err := toolRelease.InstallDir.Join(toolRelease.Tool.Name + ".exe").Create()
require.NoError(t, err)
require.NoError(t, f.Close())
tool.GetOrCreateRelease(semver.ParseRelaxed("0.1.0"))

// serial-discovery tool
Expand All @@ -189,6 +192,9 @@ func TestLoadDiscoveries(t *testing.T) {
toolRelease = tool.GetOrCreateRelease(semver.ParseRelaxed("0.1.0"))
// We set this to fake the tool is installed
toolRelease.InstallDir = fakePath
f, err = toolRelease.InstallDir.Join(toolRelease.Tool.Name + ".exe").Create()
require.NoError(t, err)
require.NoError(t, f.Close())

platform := pack.GetOrCreatePlatform("avr")
release := platform.GetOrCreateRelease(semver.MustParse("1.0.0"))
Expand Down Expand Up @@ -279,8 +285,6 @@ func TestLoadDiscoveries(t *testing.T) {
require.Contains(t, discoveries, "teensy")
pmeRelease()
}

require.NoError(t, fakePath.RemoveAll())
}

func TestConvertUploadToolsToPluggableDiscovery(t *testing.T) {
Expand Down
22 changes: 20 additions & 2 deletions arduino/cores/packagemanager/package_manager_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,8 +617,8 @@ func TestPackageManagerClear(t *testing.T) {

func TestFindToolsRequiredFromPlatformRelease(t *testing.T) {
// Create all the necessary data to load discoveries
fakePath := paths.New("fake-path")
require.NoError(t, fakePath.Join("LICENSE").MkdirAll())
fakePath, err := paths.TempDir().MkTempDir("fake-path")
require.NoError(t, err)
defer fakePath.RemoveAll()

pmb := NewBuilder(fakePath, fakePath, fakePath, fakePath, "test")
Expand All @@ -630,6 +630,9 @@ func TestFindToolsRequiredFromPlatformRelease(t *testing.T) {
toolRelease := tool.GetOrCreateRelease(semver.ParseRelaxed("4.2.0"))
// We set this to fake the tool is installed
toolRelease.InstallDir = fakePath
f, err := toolRelease.InstallDir.Join(toolRelease.Tool.Name + ".exe").Create()
require.NoError(t, err)
require.NoError(t, f.Close())
}

{
Expand All @@ -646,6 +649,9 @@ func TestFindToolsRequiredFromPlatformRelease(t *testing.T) {
toolRelease := tool.GetOrCreateRelease(semver.ParseRelaxed("6.6.6"))
// We set this to fake the tool is installed
toolRelease.InstallDir = fakePath
f, err := toolRelease.InstallDir.Join(toolRelease.Tool.Name + ".exe").Create()
require.NoError(t, err)
require.NoError(t, f.Close())
}

{
Expand All @@ -654,6 +660,9 @@ func TestFindToolsRequiredFromPlatformRelease(t *testing.T) {
toolRelease := tool.GetOrCreateRelease(semver.ParseRelaxed("1.0.0"))
// We set this to fake the tool is installed
toolRelease.InstallDir = fakePath
f, err := toolRelease.InstallDir.Join(toolRelease.Tool.Name + ".exe").Create()
require.NoError(t, err)
require.NoError(t, f.Close())
tool.GetOrCreateRelease(semver.ParseRelaxed("0.1.0"))
}

Expand All @@ -664,6 +673,9 @@ func TestFindToolsRequiredFromPlatformRelease(t *testing.T) {
toolRelease := tool.GetOrCreateRelease(semver.ParseRelaxed("0.1.0"))
// We set this to fake the tool is installed
toolRelease.InstallDir = fakePath
f, err := toolRelease.InstallDir.Join(toolRelease.Tool.Name + ".exe").Create()
require.NoError(t, err)
require.NoError(t, f.Close())
}

{
Expand All @@ -672,6 +684,9 @@ func TestFindToolsRequiredFromPlatformRelease(t *testing.T) {
toolRelease := tool.GetOrCreateRelease(semver.ParseRelaxed("1.0.0"))
// We set this to fake the tool is installed
toolRelease.InstallDir = fakePath
f, err := toolRelease.InstallDir.Join(toolRelease.Tool.Name + ".exe").Create()
require.NoError(t, err)
require.NoError(t, f.Close())
tool.GetOrCreateRelease(semver.ParseRelaxed("0.1.0"))
}

Expand All @@ -682,6 +697,9 @@ func TestFindToolsRequiredFromPlatformRelease(t *testing.T) {
toolRelease := tool.GetOrCreateRelease(semver.ParseRelaxed("0.1.0"))
// We set this to fake the tool is installed
toolRelease.InstallDir = fakePath
f, err := toolRelease.InstallDir.Join(toolRelease.Tool.Name + ".exe").Create()
require.NoError(t, err)
require.NoError(t, f.Close())
}

platform := pack.GetOrCreatePlatform("avr")
Expand Down
7 changes: 3 additions & 4 deletions arduino/cores/tools.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,10 @@ func (tool *Tool) String() string {

// IsInstalled returns true if the ToolRelease is installed
func (tr *ToolRelease) IsInstalled() bool {
if tr.InstallDir == nil {
return false
if tr.Tool.Package.Name == "builtin" && tr.InstallDir != nil {
return tr.InstallDir.Join(tr.Tool.Name+".exe").Exist() || tr.InstallDir.Join(tr.Tool.Name).Exist()
}
dirContent, _ := tr.InstallDir.ReadDir()
return dirContent.Len() != 0
return tr.InstallDir != nil
}

func (tr *ToolRelease) String() string {
Expand Down
1 change: 0 additions & 1 deletion internal/integrationtest/board/board_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,6 @@ func TestBoardListWithFailedBuiltinInstallation(t *testing.T) {
// remove files from serial-discovery directory to simulate a failed installation
serialDiscovery, err := cli.DataDir().Join("packages", "builtin", "tools", "serial-discovery").ReadDir()
require.NoError(t, err)
require.NoError(t, serialDiscovery[0].Join("LICENSE.txt").Remove())
require.NoError(t, serialDiscovery[0].Join("serial-discovery.exe").Remove())

// board list should install serial-discovery again
Expand Down