-
-
Notifications
You must be signed in to change notification settings - Fork 385
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[breaking] Implementation of sketch profiles (#1713)
* cosmetic: renamed import * Simplify function pm.DownloadPlatformRelease * Implementation of the Profiles parser * Added methods to get profiles from sketch * Added gRPC parameters to support profiles * Added function to load packages for profiles * Added support for profiles in compile command * Added progress callback and installMissing flag (stubs) in pm.PrepareLibrariesAndPackageManagersForProfile * Added auto-install procedures for profiles * Handle platform not found errors * Draft implementation of upload with profiles * Made packagemamager.loadToolsFromPackage public * Simplified callbacks in commands.Init * cosmetic: added shortcut variable for library manager * cosmetic: added shortcut variable for package manager; small readability improvement * Wiring profiles into arduino-cli and gRPC implementation * Made gRPC Init return a full Profile structure Makes it more future-proof in case of further expasion * (tech debt) Disable profiles if compiling with --libraries/--library * Fixed some linter warnings * Apply suggestions from code review Co-authored-by: per1234 <accounts@perglass.com> * Added profiles specification docs * Allow both sketch.yaml and .yml (with priority for .yaml) * Correctly handle nil return value * Apply suggestions from code review Co-authored-by: per1234 <accounts@perglass.com> * Apply suggestions from code review * Provide `core install` suggestions only when compiling without profiles * Remove stray comment * Fixed some comments in protoc files * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: per1234 <accounts@perglass.com> * Implemented missing AsYaml methods and added tests * Apply suggestions from code review * run of prettier formatter * Preserve profiles ordering in profiles.yaml * Apply suggestions from code review Co-authored-by: per1234 <accounts@perglass.com> Co-authored-by: per1234 <accounts@perglass.com>
- Loading branch information
Showing
25 changed files
with
1,793 additions
and
750 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| // This file is part of arduino-cli. | ||
| // | ||
| // Copyright 2020-2022 ARDUINO SA (http://www.arduino.cc/) | ||
| // | ||
| // This software is released under the GNU General Public License version 3, | ||
| // which covers the main part of arduino-cli. | ||
| // The terms of this license can be found at: | ||
| // https://www.gnu.org/licenses/gpl-3.0.en.html | ||
| // | ||
| // You can be released from the requirements of the above licenses by purchasing | ||
| // a commercial license. Buying such a license is mandatory if you want to | ||
| // modify or otherwise use the software for commercial activities involving the | ||
| // Arduino software without disclosing the source code of your own applications. | ||
| // To purchase a commercial license, send an email to license@arduino.cc. | ||
|
|
||
| package packagemanager | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/url" | ||
|
|
||
| "github.com/arduino/arduino-cli/arduino" | ||
| "github.com/arduino/arduino-cli/arduino/cores" | ||
| "github.com/arduino/arduino-cli/arduino/resources" | ||
| "github.com/arduino/arduino-cli/arduino/sketch" | ||
| "github.com/arduino/arduino-cli/cli/globals" | ||
| "github.com/arduino/arduino-cli/configuration" | ||
| rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1" | ||
| "github.com/arduino/go-paths-helper" | ||
| "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| // LoadHardwareForProfile load the hardware platforms for the given profile. | ||
| // If installMissing is true then possibly missing tools and platforms will be downloaded and installed. | ||
| func (pm *PackageManager) LoadHardwareForProfile(p *sketch.Profile, installMissing bool, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) []error { | ||
| // Load required platforms | ||
| var merr []error | ||
| var platformReleases []*cores.PlatformRelease | ||
| indexURLs := map[string]*url.URL{} | ||
| for _, platformRef := range p.Platforms { | ||
| if platformRelease, err := pm.loadProfilePlatform(platformRef, installMissing, downloadCB, taskCB); err != nil { | ||
| merr = append(merr, fmt.Errorf("%s: %w", tr("loading required platform %s", platformRef), err)) | ||
| logrus.WithField("platform", platformRef).WithError(err).Debugf("Error loading platform for profile") | ||
| } else { | ||
| platformReleases = append(platformReleases, platformRelease) | ||
| indexURLs[platformRelease.Platform.Name] = platformRef.PlatformIndexURL | ||
| logrus.WithField("platform", platformRef).Debugf("Loaded platform for profile") | ||
| } | ||
| } | ||
|
|
||
| // Load tools dependencies for the platforms | ||
| for _, platformRelease := range platformReleases { | ||
| // TODO: pm.FindPlatformReleaseDependencies(platformRelease) | ||
|
|
||
| for _, toolDep := range platformRelease.ToolDependencies { | ||
| indexURL := indexURLs[toolDep.ToolPackager] | ||
| if err := pm.loadProfileTool(toolDep, indexURL, installMissing, downloadCB, taskCB); err != nil { | ||
| merr = append(merr, fmt.Errorf("%s: %w", tr("loading required tool %s", toolDep), err)) | ||
| logrus.WithField("tool", toolDep).WithField("index_url", indexURL).WithError(err).Debugf("Error loading tool for profile") | ||
| } else { | ||
| logrus.WithField("tool", toolDep).WithField("index_url", indexURL).Debugf("Loaded tool for profile") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return merr | ||
| } | ||
|
|
||
| func (pm *PackageManager) loadProfilePlatform(platformRef *sketch.ProfilePlatformReference, installMissing bool, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) (*cores.PlatformRelease, error) { | ||
| targetPackage := pm.Packages.GetOrCreatePackage(platformRef.Packager) | ||
| platform := targetPackage.GetOrCreatePlatform(platformRef.Architecture) | ||
| release := platform.GetOrCreateRelease(platformRef.Version) | ||
|
|
||
| uid := platformRef.InternalUniqueIdentifier() | ||
| destDir := configuration.ProfilesCacheDir(configuration.Settings).Join(uid) | ||
| if !destDir.IsDir() && installMissing { | ||
| // Try installing the missing platform | ||
| if err := pm.installMissingProfilePlatform(platformRef, destDir, downloadCB, taskCB); err != nil { | ||
| return nil, err | ||
| } | ||
| } | ||
| return release, pm.loadPlatformRelease(release, destDir) | ||
| } | ||
|
|
||
| func (pm *PackageManager) installMissingProfilePlatform(platformRef *sketch.ProfilePlatformReference, destDir *paths.Path, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) error { | ||
| // Instantiate a temporary package manager only for platform installation | ||
| _ = pm.TempDir.MkdirAll() | ||
| tmp, err := paths.MkTempDir(pm.TempDir.String(), "") | ||
| if err != nil { | ||
| return fmt.Errorf("installing missing platform: could not create temp dir %s", err) | ||
| } | ||
| tmpPm := NewPackageManager(tmp, tmp, pm.DownloadDir, tmp, pm.userAgent) | ||
| defer tmp.RemoveAll() | ||
|
|
||
| // Download the main index and parse it | ||
| taskCB(&rpc.TaskProgress{Name: tr("Downloading platform %s", platformRef)}) | ||
| defaultIndexURL, _ := url.Parse(globals.DefaultIndexURL) | ||
| indexesToDownload := []*url.URL{defaultIndexURL} | ||
| if platformRef.PlatformIndexURL != nil { | ||
| indexesToDownload = append(indexesToDownload, platformRef.PlatformIndexURL) | ||
| } | ||
| for _, indexURL := range indexesToDownload { | ||
| if err != nil { | ||
| taskCB(&rpc.TaskProgress{Name: tr("Error downloading %s", indexURL)}) | ||
| return &arduino.FailedDownloadError{Message: tr("Error downloading %s", indexURL), Cause: err} | ||
| } | ||
| indexResource := resources.IndexResource{URL: indexURL} | ||
| if err := indexResource.Download(tmpPm.IndexDir, downloadCB); err != nil { | ||
| taskCB(&rpc.TaskProgress{Name: tr("Error downloading %s", indexURL)}) | ||
| return &arduino.FailedDownloadError{Message: tr("Error downloading %s", indexURL), Cause: err} | ||
| } | ||
| if err := tmpPm.LoadPackageIndex(indexURL); err != nil { | ||
| taskCB(&rpc.TaskProgress{Name: tr("Error loading index %s", indexURL)}) | ||
| return &arduino.FailedInstallError{Message: tr("Error loading index %s", indexURL), Cause: err} | ||
| } | ||
| } | ||
|
|
||
| // Download the platform | ||
| tmpTargetPackage := tmpPm.Packages.GetOrCreatePackage(platformRef.Packager) | ||
| tmpPlatform := tmpTargetPackage.GetOrCreatePlatform(platformRef.Architecture) | ||
| tmpPlatformRelease := tmpPlatform.GetOrCreateRelease(platformRef.Version) | ||
| if err := tmpPm.DownloadPlatformRelease(tmpPlatformRelease, nil, downloadCB); err != nil { | ||
| taskCB(&rpc.TaskProgress{Name: tr("Error downloading platform %s", tmpPlatformRelease)}) | ||
| return &arduino.FailedInstallError{Message: tr("Error downloading platform %s", tmpPlatformRelease), Cause: err} | ||
| } | ||
| taskCB(&rpc.TaskProgress{Completed: true}) | ||
|
|
||
| // Perform install | ||
| taskCB(&rpc.TaskProgress{Name: tr("Installing platform %s", tmpPlatformRelease)}) | ||
| if err := tmpPm.InstallPlatformInDirectory(tmpPlatformRelease, destDir); err != nil { | ||
| taskCB(&rpc.TaskProgress{Name: tr("Error installing platform %s", tmpPlatformRelease)}) | ||
| return &arduino.FailedInstallError{Message: tr("Error installing platform %s", tmpPlatformRelease), Cause: err} | ||
| } | ||
| taskCB(&rpc.TaskProgress{Completed: true}) | ||
| return nil | ||
| } | ||
|
|
||
| func (pm *PackageManager) loadProfileTool(toolRef *cores.ToolDependency, indexURL *url.URL, installMissing bool, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) error { | ||
| targetPackage := pm.Packages.GetOrCreatePackage(toolRef.ToolPackager) | ||
| tool := targetPackage.GetOrCreateTool(toolRef.ToolName) | ||
|
|
||
| uid := toolRef.InternalUniqueIdentifier(indexURL) | ||
| destDir := configuration.ProfilesCacheDir(configuration.Settings).Join(uid) | ||
|
|
||
| if !destDir.IsDir() && installMissing { | ||
| // Try installing the missing tool | ||
| toolRelease := tool.GetOrCreateRelease(toolRef.ToolVersion) | ||
| if toolRelease == nil { | ||
| return &arduino.InvalidVersionError{Cause: fmt.Errorf(tr("version %s not found", toolRef.ToolVersion))} | ||
| } | ||
| if err := pm.installMissingProfileTool(toolRelease, destDir, downloadCB, taskCB); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return pm.loadToolReleaseFromDirectory(tool, toolRef.ToolVersion, destDir) | ||
| } | ||
|
|
||
| func (pm *PackageManager) installMissingProfileTool(toolRelease *cores.ToolRelease, destDir *paths.Path, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) error { | ||
| // Instantiate a temporary package manager only for platform installation | ||
| tmp, err := paths.MkTempDir(destDir.Parent().String(), "") | ||
| if err != nil { | ||
| return fmt.Errorf("installing missing platform: could not create temp dir %s", err) | ||
| } | ||
| defer tmp.RemoveAll() | ||
|
|
||
| // Download the tool | ||
| toolResource := toolRelease.GetCompatibleFlavour() | ||
| if toolResource == nil { | ||
| return &arduino.InvalidVersionError{Cause: fmt.Errorf(tr("version %s not available for this operating system", toolRelease))} | ||
| } | ||
| taskCB(&rpc.TaskProgress{Name: tr("Downloading tool %s", toolRelease)}) | ||
| if err := toolResource.Download(pm.DownloadDir, nil, toolRelease.String(), downloadCB); err != nil { | ||
| taskCB(&rpc.TaskProgress{Name: tr("Error downloading tool %s", toolRelease)}) | ||
| return &arduino.FailedInstallError{Message: tr("Error installing tool %s", toolRelease), Cause: err} | ||
| } | ||
| taskCB(&rpc.TaskProgress{Completed: true}) | ||
|
|
||
| // Install tool | ||
| taskCB(&rpc.TaskProgress{Name: tr("Installing tool %s", toolRelease)}) | ||
| if err := toolResource.Install(pm.DownloadDir, tmp, destDir); err != nil { | ||
| taskCB(&rpc.TaskProgress{Name: tr("Error installing tool %s", toolRelease)}) | ||
| return &arduino.FailedInstallError{Message: tr("Error installing tool %s", toolRelease), Cause: err} | ||
| } | ||
| taskCB(&rpc.TaskProgress{Completed: true}) | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.