Make it possible to mutate Package props when loading indexes from differente places

Author: alessio-perugini

arduino/cores/packageindex/index.go

@@ -142,9 +142,9 @@ var tr = i18n.Tr
 
 // MergeIntoPackages converts the Index data into a cores.Packages and merge them
 // with the existing contents of the cores.Packages passed as parameter.
-func (index Index) MergeIntoPackages(outPackages cores.Packages) {
+func (index Index) MergeIntoPackages(outPackages cores.Packages, mutators ...cores.PackageMutator) {
 	for _, inPackage := range index.Packages {
-		inPackage.extractPackageIn(outPackages, index.IsTrusted)
+		inPackage.extractPackageIn(outPackages, index.IsTrusted, mutators...)
 	}
 }
 
@@ -243,7 +243,7 @@ func IndexFromPlatformRelease(pr *cores.PlatformRelease) Index {
 	}
 }
 
-func (inPackage indexPackage) extractPackageIn(outPackages cores.Packages, trusted bool) {
+func (inPackage indexPackage) extractPackageIn(outPackages cores.Packages, trusted bool, mutators ...cores.PackageMutator) {
 	outPackage := outPackages.GetOrCreatePackage(inPackage.Name)
 	outPackage.Maintainer = inPackage.Maintainer
 	outPackage.WebsiteURL = inPackage.WebsiteURL
@@ -258,6 +258,12 @@ func (inPackage indexPackage) extractPackageIn(outPackages cores.Packages, trust
 	for _, inPlatform := range inPackage.Platforms {
 		inPlatform.extractPlatformIn(outPackage, trusted)
 	}
+
+	// Apply mutations in case we need to override the above behaviour. For example this is used to change the `indexed`
+	// property when the `LoadPackageIndexFromFile` or `LoadPackageIndex` func is loading the global index files.
+	for _, mutator := range mutators {
+		mutator(outPackage)
+	}
 }
 
 func (inPlatformRelease indexPlatformRelease) extractPlatformIn(outPackage *cores.Package, trusted bool) error {

arduino/cores/packagemanager/install_uninstall.go

@@ -52,6 +52,9 @@ func (pme *Explorer) DownloadAndInstallPlatformUpgrades(
 	if installed == nil {
 		return &arduino.PlatformNotFoundError{Platform: platformRef.String()}
 	}
+	if !installed.Platform.Package.IsIndexed() {
+		taskCB(&rpc.TaskProgress{Name: tr("WARNING missing package index for %s, future updates cannot be guaranteed", platform.String())})
+	}
 	latest := platform.GetLatestRelease()
 	if !latest.Version.GreaterThan(installed.Version) {
 		return &arduino.PlatformAlreadyAtTheLatestVersionError{}

arduino/cores/packagemanager/package_manager.go

@@ -451,7 +451,7 @@ func (pmb *Builder) LoadPackageIndex(URL *url.URL) error {
 		p.URL = URL.String()
 	}
 
-	index.MergeIntoPackages(pmb.packages)
+	index.MergeIntoPackages(pmb.packages, cores.WithIndexedStatus(true))
 	return nil
 }
 
@@ -462,7 +462,15 @@ func (pmb *Builder) LoadPackageIndexFromFile(indexPath *paths.Path) (*packageind
 		return nil, fmt.Errorf(tr("loading json index file %[1]s: %[2]s"), indexPath, err)
 	}
 
-	index.MergeIntoPackages(pmb.packages)
+	// When the global indexes are loading packages, we're setting the `indexed` property at true. Other indexing
+	// coming from installed.json must not alter the status of that property.
+	switch indexPath.Base() {
+	case "installed.json":
+		index.MergeIntoPackages(pmb.packages)
+	default:
+		index.MergeIntoPackages(pmb.packages, cores.WithIndexedStatus(true))
+	}
+
 	return index, nil
 }
 

arduino/cores/status.go

@@ -47,6 +47,15 @@ type Package struct {
 	Tools      map[string]*Tool     // The tools in the system.
 	Help       PackageHelp          `json:"-"`
 	Packages   Packages             `json:"-"`
+	indexed    bool
+}
+
+// PackageMutator is a func used to modify the property of the given *Package
+type PackageMutator func(p *Package)
+
+// WithIndexedStatus used to modify the indexed propriety of the *Package
+func WithIndexedStatus(indexed bool) PackageMutator {
+	return func(p *Package) { p.indexed = indexed }
 }
 
 // GetOrCreatePackage returns the specified Package or creates an empty one
@@ -185,6 +194,16 @@ func (targetPackage *Package) GetOrCreateTool(name string) *Tool {
 	return tool
 }
 
+// SetIndexed sets a boolean to determine if the package is loaded from the package_index.json
+func (targetPackage *Package) SetIndexed(v bool) {
+	targetPackage.indexed = v
+}
+
+// IsIndexed returns true if the package is loaded from package_index.json
+func (targetPackage *Package) IsIndexed() bool {
+	return targetPackage.indexed
+}
+
 func (targetPackage *Package) String() string {
 	return targetPackage.Name
 }

internal/integrationtest/core/core_test.go

@@ -1026,3 +1026,19 @@ func TestCoreBrokenDependency(t *testing.T) {
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "try contacting test@example.com")
 }
+
+func TestCoreUpgradeWarningWithPackageInstalledButNotIndexed(t *testing.T) {
+	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
+	defer env.CleanUp()
+
+	// update index
+	url := "https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json"
+	_, _, err := cli.Run("core", "update-index", "--additional-urls="+url)
+	require.NoError(t, err)
+	// install 3rd-party core outdated version
+	_, _, err = cli.Run("core", "install", "esp32:esp32@2.0.0", "--additional-urls="+url)
+	require.NoError(t, err)
+	// upgrade without index fires a warning
+	stdout, _, _ := cli.Run("core", "upgrade", "esp32:esp32")
+	require.Contains(t, string(stdout), "WARNING missing package index for esp32:esp32, future updates cannot be guaranteed")
+}