Skip to content

Commit

Permalink
Do not fail if downloaded file has good checksum but incorrect size. (#…
Browse files Browse the repository at this point in the history
…2739)

* Do not fail download if archive size do not match package_index.json size (checksum is sufficient)

* Added unit tests

* Added integration test
  • Loading branch information
cmaglie authored Oct 28, 2024
1 parent 2dcee40 commit 7ee4cf7
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 9 deletions.
18 changes: 9 additions & 9 deletions internal/arduino/resources/checksums.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import (

"github.com/arduino/arduino-cli/internal/i18n"
paths "github.com/arduino/go-paths-helper"
"github.com/sirupsen/logrus"
)

// TestLocalArchiveChecksum test if the checksum of the local archive match the checksum of the DownloadResource
Expand Down Expand Up @@ -82,20 +83,21 @@ func (r *DownloadResource) TestLocalArchiveChecksum(downloadDir *paths.Path) (bo
}

// TestLocalArchiveSize test if the local archive size match the DownloadResource size
func (r *DownloadResource) TestLocalArchiveSize(downloadDir *paths.Path) (bool, error) {
func (r *DownloadResource) TestLocalArchiveSize(downloadDir *paths.Path) error {
filePath, err := r.ArchivePath(downloadDir)
if err != nil {
return false, errors.New(i18n.Tr("getting archive path: %s", err))
return errors.New(i18n.Tr("getting archive path: %s", err))
}
info, err := filePath.Stat()
if err != nil {
return false, errors.New(i18n.Tr("getting archive info: %s", err))
return errors.New(i18n.Tr("getting archive info: %s", err))
}
// If the size do not match, just report a warning and continue
// (the checksum is sufficient to ensure the integrity of the archive)
if info.Size() != r.Size {
return false, fmt.Errorf("%s: %d != %d", i18n.Tr("fetched archive size differs from size specified in index"), info.Size(), r.Size)
logrus.Warningf("%s: %d != %d", i18n.Tr("fetched archive size differs from size specified in index"), info.Size(), r.Size)
}

return true, nil
return nil
}

// TestLocalArchiveIntegrity checks for integrity of the local archive.
Expand All @@ -106,10 +108,8 @@ func (r *DownloadResource) TestLocalArchiveIntegrity(downloadDir *paths.Path) (b
return false, nil
}

if ok, err := r.TestLocalArchiveSize(downloadDir); err != nil {
if err := r.TestLocalArchiveSize(downloadDir); err != nil {
return false, errors.New(i18n.Tr("testing archive size: %s", err))
} else if !ok {
return false, nil
}

ok, err := r.TestLocalArchiveChecksum(downloadDir)
Expand Down
4 changes: 4 additions & 0 deletions internal/arduino/resources/resources_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ func TestDownloadAndChecksums(t *testing.T) {
require.NoError(t, err)
downloadAndTestChecksum()

require.NoError(t, r.TestLocalArchiveSize(tmp))
r.Size = 500
require.NoError(t, r.TestLocalArchiveSize(tmp))

r.Checksum = ""
_, err = r.TestLocalArchiveChecksum(tmp)
require.Error(t, err)
Expand Down
12 changes: 12 additions & 0 deletions internal/integrationtest/core/core_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1354,3 +1354,15 @@ func TestReferencedCoreBuildAndRuntimeProperties(t *testing.T) {
out.ArrayMustContain(jsonEncode("runtime.platform.path=" + corePlatformPath))
}
}

func TestCoreInstallWithWrongArchiveSize(t *testing.T) {
// See: https://github.com/arduino/arduino-cli/issues/2332
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()

_, _, err := cli.Run("--additional-urls", "https://raw.githubusercontent.com/geolink/opentracker-arduino-board/bf6158ebab0402db217bfb02ea61461ddc6f2940/package_opentracker_index.json", "core", "update-index")
require.NoError(t, err)

_, _, err = cli.Run("--additional-urls", "https://raw.githubusercontent.com/geolink/opentracker-arduino-board/bf6158ebab0402db217bfb02ea61461ddc6f2940/package_opentracker_index.json", "core", "install", "opentracker:[email protected]")
require.NoError(t, err)
}

0 comments on commit 7ee4cf7

Please sign in to comment.