Skip to content

Improve error message for malformed third-party platform archives #3217

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
nitishagar wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −4
Open

Improve error message for malformed third-party platform archives #3217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions internal/arduino/resources/install.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,10 @@ func findPackageRoot(parent *paths.Path) (*paths.Path, error) {
files.FilterOutPrefix("__MACOSX")

if len(files) == 0 {
return nil, errors.New(i18n.Tr("files in archive must be placed in a subdirectory"))
return nil, errors.New(i18n.Tr("the platform archive is not structured correctly: all files must be placed within a single root folder. This is likely a problem with the third-party platform; please report it to the platform's maintainer."))
}
if len(files) > 1 {
return nil, errors.New(i18n.Tr("no unique root dir in archive, found '%[1]s' and '%[2]s'", files[0], files[1]))
return nil, errors.New(i18n.Tr("the platform archive is not structured correctly: it must contain a single root folder, but found multiple ('%[1]s', '%[2]s'). This is likely a problem with the third-party platform; please report it to the platform's maintainer.", files[0], files[1]))
}

return files[0], nil
Expand Down
4 changes: 2 additions & 2 deletions internal/arduino/resources/install_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func TestInstallPlatform(t *testing.T) {
Checksum: "SHA-256:8b3fc6253c5ac2f3ba684eba0d62bb8a4ee93469fa822f81e2cd7d1b959c4044",
Size: 148,
},
error: "no unique root dir in archive",
error: "must contain a single root folder",
},
{
testName: "root folder not present",
Expand All @@ -68,7 +68,7 @@ func TestInstallPlatform(t *testing.T) {
Checksum: "SHA-256:bc00db9784e20f50d7a5fceccb6bd95ebff4a3e847aac88365b95a6851a24963",
Size: 177,
},
error: "files in archive must be placed in a subdirectory",
error: "must be placed within a single root folder",
},
}
for _, test := range tests {
Expand Down
Loading