Commit 1ce4abe

authored

[skip-changelog] Recover from interrupted builtin tool installation (#2107)

* Recover from failed builtin tools installation * Add tests for the changes

1 parent 5f03cb9 commit 1ce4abeCopy full SHA for 1ce4abe

File tree

+35

-1

lines changed

arduino/cores
- packagemanager
  - loader_test.go
  - package_manager_test.go
- tools.go
internal/integrationtest/board
- board_test.go

+35

-1

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -170,6 +170,8 @@ arduino_zero_edbg.serial.disableRTS=true`
`170`	`170`	`func TestLoadDiscoveries(t *testing.T) {`
`171`	`171`	`// Create all the necessary data to load discoveries`
`172`	`172`	`fakePath := paths.New("fake-path")`
	`173`	`+ require.NoError(t, fakePath.Join("LICENSE").MkdirAll())`
	`174`	`+ defer fakePath.RemoveAll()`
`173`	`175`
`174`	`176`	`createTestPackageManager := func() *PackageManager {`
`175`	`177`	`pmb := NewBuilder(fakePath, fakePath, fakePath, fakePath, "test")`
`@@ -277,6 +279,8 @@ func TestLoadDiscoveries(t *testing.T) {`
`277`	`279`	`require.Contains(t, discoveries, "teensy")`
`278`	`280`	`pmeRelease()`
`279`	`281`	`}`
	`282`	`+`
	`283`	`+ require.NoError(t, fakePath.RemoveAll())`
`280`	`284`	`}`
`281`	`285`
`282`	`286`	`func TestConvertUploadToolsToPluggableDiscovery(t *testing.T) {`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -457,6 +457,8 @@ func TestPackageManagerClear(t *testing.T) {`
`457`	`457`	`func TestFindToolsRequiredFromPlatformRelease(t *testing.T) {`
`458`	`458`	`// Create all the necessary data to load discoveries`
`459`	`459`	`fakePath := paths.New("fake-path")`
	`460`	`+ require.NoError(t, fakePath.Join("LICENSE").MkdirAll())`
	`461`	`+ defer fakePath.RemoveAll()`
`460`	`462`
`461`	`463`	`pmb := NewBuilder(fakePath, fakePath, fakePath, fakePath, "test")`
`462`	`464`	`pack := pmb.GetOrCreatePackage("arduino")`

Lines changed: 5 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,11 @@ func (tool *Tool) String() string {`
`106`	`106`
`107`	`107`	`// IsInstalled returns true if the ToolRelease is installed`
`108`	`108`	`func (tr *ToolRelease) IsInstalled() bool {`
`109`		`- return tr.InstallDir != nil`
	`109`	`+ if tr.InstallDir == nil {`
	`110`	`+ return false`
	`111`	`+ }`
	`112`	`+ dirContent, _ := tr.InstallDir.ReadDir()`
	`113`	`+ return dirContent.Len() != 0`
`110`	`114`	`}`
`111`	`115`
`112`	`116`	`func (tr *ToolRelease) String() string {`

Lines changed: 24 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -558,3 +558,27 @@ func TestBoardSearchWithOutdatedCore(t *testing.T) {`
`558`	`558`	`// Installed version must be older than latest`
`559`	`559`	`require.True(t, installedVersion.LessThan(latestVersion))`
`560`	`560`	`}`
	`561`	`+`
	`562`	`+func TestBoardListWithFailedBuiltinInstallation(t *testing.T) {`
	`563`	`+ env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)`
	`564`	`+ defer env.CleanUp()`
	`565`	`+`
	`566`	`+ _, _, err := cli.Run("core", "update-index")`
	`567`	`+ require.NoError(t, err)`
	`568`	`+`
	`569`	`+ // board list to install builtin tools`
	`570`	`+ _, _, err = cli.Run("board", "list")`
	`571`	`+ require.NoError(t, err)`
	`572`	`+`
	`573`	`+ // remove files from serial-discovery directory to simulate a failed installation`
	`574`	`+ serialDiscovery, err := cli.DataDir().Join("packages", "builtin", "tools", "serial-discovery").ReadDir()`
	`575`	`+ require.NoError(t, err)`
	`576`	`+ require.NoError(t, serialDiscovery[0].Join("LICENSE.txt").Remove())`
	`577`	`+ require.NoError(t, serialDiscovery[0].Join("serial-discovery.exe").Remove())`
	`578`	`+`
	`579`	`+ // board list should install serial-discovery again`
	`580`	`+ stdout, stderr, err := cli.Run("board", "list")`
	`581`	`+ require.NoError(t, err)`
	`582`	`+ require.Empty(t, stderr)`
	`583`	`+ require.Contains(t, string(stdout), "Downloading missing tool builtin:serial-discovery")`
	`584`	`+}`

Comments

(0)