Merge branch 'master' into discoveries_fix

Author: Bikappa

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,6 +9,7 @@ See [how to contribute](https://arduino.github.io/arduino-cli/latest/CONTRIBUTIN
 - [ ] Tests for the changes have been added (for bug fixes / features)
 - [ ] Docs have been added / updated (for bug fixes / features)
 - [ ] `UPGRADING.md` has been updated with a migration guide (for breaking changes)
+- [ ] `configuration.schema.json` updated if new parameters are added.
 
 ## What kind of change does this PR introduce?
 

.github/workflows/publish-go-nightly-task.yml

@@ -36,6 +36,7 @@ jobs:
           - Linux_ARM64
           - macOS_64bit
           - macOS_ARM64
+          - jsonschema
 
     steps:
       - name: Checkout repository

.github/workflows/publish-go-tester-task.yml

@@ -111,6 +111,9 @@ jobs:
           - task: protoc:collect
             path: "*_proto.zip"
             name: rpc-protocol-files
+          - task: dist:jsonschema
+            path: "*configuration.schema.json"
+            name: configuration-schema
 
     steps:
       - name: Checkout repository
@@ -146,7 +149,6 @@ jobs:
     steps:
       - name: Download build artifacts
         uses: actions/download-artifact@v3
-
       - name: Output checksum
         run: |
           TAG="${{ needs.package-name-prefix.outputs.prefix }}git-snapshot"

.github/workflows/release-go-task.yml

@@ -253,8 +253,11 @@ jobs:
       - name: Collect proto files
         run: task protoc:collect
 
+      - name: Add configuration JSON schema
+        run: task dist:jsonschema
+
       - name: Create checksum file
-        working-directory: ${{ env.DIST_DIR}}
+        working-directory: ${{ env.DIST_DIR }}
         run: |
           TAG=${{ needs.create-release-artifacts.outputs.version }}
           sha256sum ${{ env.PROJECT_NAME }}_${TAG}* > ${TAG}-checksums.txt

.gitignore

@@ -28,6 +28,7 @@ venv
 /docsgen/arduino-cli.exe
 /docs/rpc/*.md
 /docs/commands/*.md
+/docs/configuration.schema.json
 
 # Delve debugger binary file
 __debug_bin

DistTasks.yml

@@ -251,3 +251,9 @@ tasks:
       CONTAINER_TAG: "{{.GO_VERSION}}-darwin-arm64-debian10"
       PACKAGE_PLATFORM: "macOS_ARM64"
       PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.tar.gz"
+
+  jsonschema:
+    desc: Copy the JSON schema to dist folder
+    cmds:
+      - mkdir --parents {{.DIST_DIR}}
+      - cp ./configuration/configuration.schema.json {{.DIST_DIR}}/{{.PROJECT_NAME}}_{{.VERSION}}_configuration.schema.json

Taskfile.yml

@@ -9,6 +9,7 @@ tasks:
     deps:
       - task: go:cli-docs
       - task: protoc:docs
+      - task: docs:include-configuration-json-schema
     cmds:
       - task: general:format-prettier
 
@@ -218,6 +219,11 @@ tasks:
       - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,settings.md --proto_path=rpc ./rpc/cc/arduino/cli/settings/v1/*.proto'
       - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,debug.md --proto_path=rpc ./rpc/cc/arduino/cli/debug/v1/*.proto'
 
+  docs:include-configuration-json-schema:
+    desc: Copy configuration JSON schema to make it available in documentation
+    cmds:
+      - cp ./configuration/configuration.schema.json ./docs/configuration.schema.json
+
   protoc:check:
     desc: Perform linting of the protobuf definitions
     cmds:

arduino/cores/packagemanager/install_uninstall.go

@@ -102,7 +102,7 @@ func (pme *Explorer) DownloadAndInstallPlatformAndTools(
 
 	// Install tools first
 	for _, tool := range toolsToInstall {
-		if err := pme.InstallTool(tool, taskCB); err != nil {
+		if err := pme.InstallTool(tool, taskCB, skipPostInstall); err != nil {
 			return err
 		}
 	}
@@ -171,7 +171,10 @@ func (pme *Explorer) DownloadAndInstallPlatformAndTools(
 	if !skipPostInstall {
 		log.Info("Running post_install script")
 		taskCB(&rpc.TaskProgress{Message: tr("Configuring platform.")})
-		if err := pme.RunPostInstallScript(platformRelease); err != nil {
+		if !platformRelease.IsInstalled() {
+			return errors.New(tr("platform not installed"))
+		}
+		if err := pme.RunPostInstallScript(platformRelease.InstallDir); err != nil {
 			taskCB(&rpc.TaskProgress{Message: tr("WARNING cannot configure platform: %s", err)})
 		}
 	} else {
@@ -222,22 +225,19 @@ func (pme *Explorer) cacheInstalledJSON(platformRelease *cores.PlatformRelease)
 }
 
 // RunPostInstallScript runs the post_install.sh (or post_install.bat) script for the
-// specified platformRelease.
-func (pme *Explorer) RunPostInstallScript(platformRelease *cores.PlatformRelease) error {
-	if !platformRelease.IsInstalled() {
-		return errors.New(tr("platform not installed"))
-	}
+// specified platformRelease or toolRelease.
+func (pme *Explorer) RunPostInstallScript(installDir *paths.Path) error {
 	postInstallFilename := "post_install.sh"
 	if runtime.GOOS == "windows" {
 		postInstallFilename = "post_install.bat"
 	}
-	postInstall := platformRelease.InstallDir.Join(postInstallFilename)
+	postInstall := installDir.Join(postInstallFilename)
 	if postInstall.Exist() && postInstall.IsNotDir() {
 		cmd, err := executils.NewProcessFromPath(pme.GetEnvVarsForSpawnedProcess(), postInstall)
 		if err != nil {
 			return err
 		}
-		cmd.SetDirFromPath(platformRelease.InstallDir)
+		cmd.SetDirFromPath(installDir)
 		if err := cmd.Run(); err != nil {
 			return err
 		}
@@ -299,7 +299,7 @@ func (pme *Explorer) UninstallPlatform(platformRelease *cores.PlatformRelease, t
 }
 
 // InstallTool installs a specific release of a tool.
-func (pme *Explorer) InstallTool(toolRelease *cores.ToolRelease, taskCB rpc.TaskProgressCB) error {
+func (pme *Explorer) InstallTool(toolRelease *cores.ToolRelease, taskCB rpc.TaskProgressCB, skipPostInstall bool) error {
 	log := pme.log.WithField("Tool", toolRelease)
 
 	if toolRelease.IsInstalled() {
@@ -325,6 +325,22 @@ func (pme *Explorer) InstallTool(toolRelease *cores.ToolRelease, taskCB rpc.Task
 		log.WithError(err).Warn("Cannot install tool")
 		return &arduino.FailedInstallError{Message: tr("Cannot install tool %s", toolRelease), Cause: err}
 	}
+	if d, err := destDir.Abs(); err == nil {
+		toolRelease.InstallDir = d
+	} else {
+		return err
+	}
+	// Perform post install
+	if !skipPostInstall {
+		log.Info("Running tool post_install script")
+		taskCB(&rpc.TaskProgress{Message: tr("Configuring tool.")})
+		if err := pme.RunPostInstallScript(toolRelease.InstallDir); err != nil {
+			taskCB(&rpc.TaskProgress{Message: tr("WARNING cannot configure tool: %s", err)})
+		}
+	} else {
+		log.Info("Skipping tool configuration.")
+		taskCB(&rpc.TaskProgress{Message: tr("Skipping tool configuration.")})
+	}
 	log.Info("Tool installed")
 	taskCB(&rpc.TaskProgress{Message: tr("%s installed", toolRelease), Completed: true})
 

arduino/errors.go

@@ -293,7 +293,7 @@ func (e *MissingProgrammerError) ToRPCStatus() *status.Status {
 	return status.New(codes.InvalidArgument, e.Error())
 }
 
-// ProgrammerRequiredForUploadError is returned then the upload can be done only using a programmer
+// ProgrammerRequiredForUploadError is returned when the upload can be done only using a programmer
 type ProgrammerRequiredForUploadError struct{}
 
 func (e *ProgrammerRequiredForUploadError) Error() string {
@@ -308,6 +308,28 @@ func (e *ProgrammerRequiredForUploadError) ToRPCStatus() *status.Status {
 	return st
 }
 
+// InitFailedError is returned when the instance initialization fails
+type InitFailedError struct {
+	Code   codes.Code
+	Cause  error
+	Reason rpc.FailedInstanceInitReason
+}
+
+func (ife *InitFailedError) Error() string {
+	return ife.Cause.Error()
+}
+
+// ToRPCStatus converts the error into a *status.Status
+func (ife *InitFailedError) ToRPCStatus() *status.Status {
+	st, _ := status.
+		New(ife.Code, ife.Cause.Error()).
+		WithDetails(&rpc.FailedInstanceInitError{
+			Reason:  ife.Reason,
+			Message: ife.Cause.Error(),
+		})
+	return st
+}
+
 // ProgrammerNotFoundError is returned when the programmer is not found
 type ProgrammerNotFoundError struct {
 	Programmer string
@@ -405,7 +427,9 @@ func (e *PlatformLoadingError) Error() string {
 
 // ToRPCStatus converts the error into a *status.Status
 func (e *PlatformLoadingError) ToRPCStatus() *status.Status {
-	return status.New(codes.FailedPrecondition, e.Error())
+	s, _ := status.New(codes.FailedPrecondition, e.Error()).
+		WithDetails(&rpc.PlatformLoadingError{})
+	return s
 }
 
 func (e *PlatformLoadingError) Unwrap() error {

commands/instances.go

@@ -138,7 +138,7 @@ func installTool(pm *packagemanager.PackageManager, tool *cores.ToolRelease, dow
 		return fmt.Errorf(tr("downloading %[1]s tool: %[2]s"), tool, err)
 	}
 	taskCB(&rpc.TaskProgress{Completed: true})
-	if err := pme.InstallTool(tool, taskCB); err != nil {
+	if err := pme.InstallTool(tool, taskCB, true); err != nil {
 		return fmt.Errorf(tr("installing %[1]s tool: %[2]s"), tool, err)
 	}
 	return nil
@@ -307,23 +307,35 @@ func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) erro
 		for _, u := range urls {
 			URL, err := utils.URLParse(u)
 			if err != nil {
-				s := status.Newf(codes.InvalidArgument, tr("Invalid additional URL: %v"), err)
-				responseError(s)
+				e := &arduino.InitFailedError{
+					Code:   codes.InvalidArgument,
+					Cause:  fmt.Errorf(tr("Invalid additional URL: %v", err)),
+					Reason: rpc.FailedInstanceInitReason_FAILED_INSTANCE_INIT_REASON_INVALID_INDEX_URL,
+				}
+				responseError(e.ToRPCStatus())
 				continue
 			}
 
 			if URL.Scheme == "file" {
 				_, err := pmb.LoadPackageIndexFromFile(paths.New(URL.Path))
 				if err != nil {
-					s := status.Newf(codes.FailedPrecondition, tr("Loading index file: %v"), err)
-					responseError(s)
+					e := &arduino.InitFailedError{
+						Code:   codes.FailedPrecondition,
+						Cause:  fmt.Errorf(tr("Loading index file: %v", err)),
+						Reason: rpc.FailedInstanceInitReason_FAILED_INSTANCE_INIT_REASON_INDEX_LOAD_ERROR,
+					}
+					responseError(e.ToRPCStatus())
 				}
 				continue
 			}
 
 			if err := pmb.LoadPackageIndex(URL); err != nil {
-				s := status.Newf(codes.FailedPrecondition, tr("Loading index file: %v"), err)
-				responseError(s)
+				e := &arduino.InitFailedError{
+					Code:   codes.FailedPrecondition,
+					Cause:  fmt.Errorf(tr("Loading index file: %v", err)),
+					Reason: rpc.FailedInstanceInitReason_FAILED_INSTANCE_INIT_REASON_INDEX_LOAD_ERROR,
+				}
+				responseError(e.ToRPCStatus())
 			}
 		}
 
@@ -335,8 +347,12 @@ func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) erro
 		for name, tool := range pmb.GetOrCreatePackage("builtin").Tools {
 			latest := tool.LatestRelease()
 			if latest == nil {
-				s := status.Newf(codes.Internal, tr("can't find latest release of tool %s", name))
-				responseError(s)
+				e := &arduino.InitFailedError{
+					Code:   codes.Internal,
+					Cause:  fmt.Errorf(tr("can't find latest release of tool %s", name)),
+					Reason: rpc.FailedInstanceInitReason_FAILED_INSTANCE_INIT_REASON_TOOL_LOAD_ERROR,
+				}
+				responseError(e.ToRPCStatus())
 			} else if !latest.IsInstalled() {
 				builtinToolsToInstall = append(builtinToolsToInstall, latest)
 			}
@@ -346,8 +362,12 @@ func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) erro
 		if len(builtinToolsToInstall) > 0 {
 			for _, toolRelease := range builtinToolsToInstall {
 				if err := installTool(pmb.Build(), toolRelease, downloadCallback, taskCallback); err != nil {
-					s := status.Newf(codes.Internal, err.Error())
-					responseError(s)
+					e := &arduino.InitFailedError{
+						Code:   codes.Internal,
+						Cause:  err,
+						Reason: rpc.FailedInstanceInitReason_FAILED_INSTANCE_INIT_REASON_TOOL_LOAD_ERROR,
+					}
+					responseError(e.ToRPCStatus())
 				}
 			}