Checkpoint - updating RCV2 for user errors

Author: jscalev

internal/cmds/cmds.go

@@ -133,7 +133,7 @@ func install(ctx *log.Context, h types.HandlerEnvironment, report *types.RunComm
 	if err := os.MkdirAll(DataDir, 0755); err != nil {
 		errMessage := fmt.Sprintf("Failed to create data dir: %v due to: %v", DataDir, err)
 		extensionEvents.LogErrorEvent("install", errMessage)
-		return "", "", errors.Wrap(err, errMessage), constants.ExitCode_CreateDataDirectoryFailed
+		return "", "", errors.Wrap(err, errMessage), constants.FileSystem_CreateDataDirectoryFailed
 	}
 
 	ctx.Log("event", "created data dir", "path", DataDir)
@@ -155,7 +155,7 @@ func uninstall(ctx *log.Context, h types.HandlerEnvironment, report *types.RunCo
 		if err := os.RemoveAll(DataDir); err != nil {
 			errMessage := fmt.Sprintf("Failed to delete data directory: %v due to: %v", DataDir, err)
 			extensionEvents.LogErrorEvent("uninstall", errMessage)
-			return "", "", errors.Wrap(err, errMessage), constants.ExitCode_RemoveDataDirectoryFailed
+			return "", "", errors.Wrap(err, errMessage), constants.FileSystem_RemoveDataDirectoryFailed
 		}
 		ctx.Log("event", "removed data dir")
 		extensionEvents.LogInformationalEvent("uninstall", fmt.Sprintf("removed data dir %v", DataDir))
@@ -190,7 +190,7 @@ func enable(ctx *log.Context, h types.HandlerEnvironment, report *types.RunComma
 	if err1 != nil {
 		errMessage := fmt.Sprintf("Failed to get configuration: %v", err1)
 		extensionEvents.LogErrorEvent("enable", errMessage)
-		return "", "", errors.Wrap(err1, "failed to get configuration"), constants.ExitCode_GetHandlerSettingsFailed
+		return "", "", err1, constants.CommandExecution_BadConfig
 	}
 
 	exitCode, err := immediatecmds.Enable(ctx, h, metadata.ExtName, metadata.SeqNum, cfg, extensionEvents)
@@ -208,7 +208,7 @@ func enable(ctx *log.Context, h types.HandlerEnvironment, report *types.RunComma
 		return "",
 			"",
 			errors.Wrap(err, fmt.Sprintf("File downloads failed. Use either a public script URI that points to .sh file, Azure storage blob SAS URI or storage blob accessible by a managed identity and retry. If managed identity is used, make sure it has been given access to container of storage blob '%s' with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info, refer https://aka.ms/RunCommandManagedLinux", download.GetUriForLogging(cfg.ScriptURI()))),
-			constants.ExitCode_ScriptBlobDownloadFailed
+			constants.FileDownload_GenericError
 	}
 
 	err = downloadArtifacts(ctx, dir, &cfg)
@@ -217,7 +217,7 @@ func enable(ctx *log.Context, h types.HandlerEnvironment, report *types.RunComma
 		extensionEvents.LogErrorEvent("enable", errMessage)
 		return "", "",
 			errors.Wrap(err, "Artifact downloads failed. Use either a public artifact URI that points to .sh file, Azure storage blob SAS URI, or storage blob accessible by a managed identity and retry."),
-			constants.ExitCode_DownloadArtifactFailed
+			constants.ArtifactDownload_GenericError
 	}
 
 	blobCreateOrReplaceError := "Error creating AppendBlob '%s' using SAS token or Managed identity. Please use a valid blob SAS URI with [read, append, create, write] permissions OR managed identity. If managed identity is used, make sure Azure blob and identity exist, and identity has been given access to storage blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity and provide outputBlobUri / errorBlobUri and corresponding clientId in outputBlobManagedIdentity / errorBlobManagedIdentity parameter(s). In case of system-assigned identity, do not use outputBlobManagedIdentity / errorBlobManagedIdentity parameter(s). For more info, refer https://aka.ms/RunCommandManagedLinux"
@@ -236,7 +236,7 @@ func enable(ctx *log.Context, h types.HandlerEnvironment, report *types.RunComma
 			return "",
 				"",
 				errors.Wrap(outputBlobAppendCreateOrReplaceError, fmt.Sprintf(blobCreateOrReplaceError, cfg.OutputBlobURI)),
-				constants.ExitCode_BlobCreateOrReplaceFailed
+				constants.AppendBlobCreation_Other
 		}
 	}
 
@@ -254,7 +254,7 @@ func enable(ctx *log.Context, h types.HandlerEnvironment, report *types.RunComma
 			return "",
 				"",
 				errors.Wrap(errorBlobAppendCreateOrReplaceError, fmt.Sprintf(blobCreateOrReplaceError, cfg.ErrorBlobURI)),
-				constants.ExitCode_BlobCreateOrReplaceFailed
+				constants.AppendBlobCreation_Other
 		}
 	}
 
@@ -849,7 +849,7 @@ func runCmd(ctx *log.Context, dir string, scriptFilePath string, cfg *handlerset
 		err := files.SaveScriptFile(scriptFilePath, cfg.Script())
 		if err != nil {
 			ctx.Log("event", "failed to save script to file", "error", err, "file", scriptFilePath)
-			return errors.Wrap(err, "failed to save script to file"), constants.ExitCode_SaveScriptFailed
+			return errors.Wrap(err, "failed to save script to file"), constants.FileDownload_UnableToWriteFile
 		}
 	} else if cfg.ScriptURI() != "" {
 		// If scriptUri is specified then cmd should start it

internal/constants/errorclarification.go

@@ -1,15 +1,32 @@
 package constants
 
 const (
-	FileDownload_BadRequest     = -41
-	FileDownload_UnknownError   = -40
-	FileDownload_StorageError   = -42
-	FileDownload_UnhandledError = -43
+	FileDownload_BadRequest                  = -41
+	FileDownload_UnknownError                = -40
+	FileDownload_StorageError                = -42
+	FileDownload_UnhandledError              = -43
+	FileDownload_StorageClientInitialization = -44
 
-	Internal_CouldNotFindCertificate = -20
-	Internal_CouldNotDecrypt         = -22
-	Internal_ArtifactCountMismatch   = -23
-	Internal_ArtifactDoesNotExist    = -24
+	Internal_CouldNotFindCertificate                      = -20
+	Internal_CouldNotDecrypt                              = -22
+	Internal_ArtifactCountMismatch                        = -23
+	Internal_ArtifactDoesNotExist                         = -24
+	Internal_IncorrectRunAsScriptPath                     = -25
+	Internal_RunAsOpenSourceScriptFileFailed              = -26
+	Internal_RunAsCreateRunAsScriptFileFailed             = -27
+	Internal_RunAsCopySourceScriptToRunAsScriptFileFailed = -28
+	Internal_RunAsLookupUserUidFailed                     = -29
+	Internal_RunAsScriptFileChangeOwnerFailed             = -30
+	Internal_RunAsScriptFileChangePermissionsFailed       = -31
+
+	Internal_CouldNotParseSettings             = -32
+	Internal_InvalidHandlerSettingsJson        = -33
+	Internal_InvalidHandlerSettingsCount       = -34
+	Internal_NoHandlerSettingsThumbprint       = -35
+	Internal_HandlerSettingsFailedToDecode     = -36
+	Internal_DecryptingProtectedSettingsFailed = -37
+	Internal_UnmarshalProtectedSettingsFailed  = -38
+	Internal_UnmarshalSettingsFailed           = -39
 
 	SystemError = -1 // CRP will interpret anything > 0 as a user error
 
@@ -23,12 +40,21 @@ const (
 	CustomerInput_StorageCredsAndMIBothSpecified = 26
 	CustomerInput_ClientIdObjectIdBothSpecified  = 27
 	CustomerInput_ErrorAndOutputBlobsSame        = 28
+	CustomerInput_NoScriptSpecified              = 29
 
-	FileDownload_AccessDenied      = 52
-	FileDownload_DoesNotExist      = 53
-	FileDownload_NetworkingError   = 54
-	FileDownload_GenericError      = 55
-	FileDownload_UnableToWriteFile = 57
+	FileDownload_AccessDenied                 = 52
+	FileDownload_DoesNotExist                 = 53
+	FileDownload_NetworkingError              = 54
+	FileDownload_GenericError                 = 55
+	FileDownload_UnableToWriteFile            = 57
+	ArtifactDownload_GenericError             = 58
+	FileDownload_UnableToParseFileName        = 59
+	FileDownload_CannotExtractFileNameFromUrl = 60
+	FileDownload_InvalidFileName              = 61
+	FileDownload_FailedStatusCode             = 62
+	FileDownload_CannotParseUrl               = 63
+	FileDownload_CannotGenerateSasKey         = 64
+	FileDownload_Empty                        = 65
 
 	Msi_NotFound                    = 70
 	Msi_DoesNotHaveRightPermissions = 71
@@ -45,89 +71,10 @@ const (
 	ImmediateRC_TaskTimeout             = 102
 	ImmediateRC_UnknownFailure          = 103
 	ImmediateRC_UnhandledException      = 104
-)
-
-func TranslateExitCodeToErrorClarification(exitCode int) int {
-	switch exitCode {
-	case ExitCode_Okay:
-		return 0 // Success, no error clarification needed
+	ImmediateRC_CommandSkipped          = 105
 
-	// User errors (-100s) -> map to positive user error codes
-	case ExitCode_ScriptBlobDownloadFailed:
-		return FileDownload_GenericError
-	case ExitCode_BlobCreateOrReplaceFailed:
-		return AppendBlobCreation_Other
-	case ExitCode_RunAsLookupUserFailed:
-		return CommandExecution_RunAsUserLogonFailed
-
-	// Service errors (-200s) -> map based on specific failure type
-	case ExitCode_CreateDataDirectoryFailed, ExitCode_RemoveDataDirectoryFailed:
-		return SystemError // File system operation failures
-	case ExitCode_GetHandlerSettingsFailed:
-		return CommandExecution_BadConfig
-	case ExitCode_SaveScriptFailed:
-		return FileDownload_UnableToWriteFile
-	case ExitCode_CommandExecutionFailed:
-		return CommandExecution_FailureExitCode
-	case ExitCode_OpenStdOutFileFailed, ExitCode_OpenStdErrFileFailed:
-		return SystemError // I/O failures
-	case ExitCode_IncorrectRunAsScriptPath, ExitCode_RunAsIncorrectScriptPath:
-		return CommandExecution_BadConfig
-	case ExitCode_RunAsOpenSourceScriptFileFailed:
-		return FileDownload_DoesNotExist
-	case ExitCode_RunAsCreateRunAsScriptFileFailed, ExitCode_RunAsCopySourceScriptToRunAsScriptFileFailed:
-		return FileDownload_UnableToWriteFile
-	case ExitCode_RunAsLookupUserUidFailed:
-		return CommandExecution_RunAsUserLogonFailed
-	case ExitCode_RunAsScriptFileChangeOwnerFailed, ExitCode_RunAsScriptFileChangePermissionsFailed:
-		return SystemError // Permission/ownership failures
-	case ExitCode_DownloadArtifactFailed:
-		return FileDownload_GenericError
-	case ExitCode_UpgradeInstalledServiceFailed, ExitCode_InstallServiceFailed,
-		ExitCode_UninstallInstalledServiceFailed, ExitCode_DisableInstalledServiceFailed:
-		return SystemError // Service management failures
-	case ExitCode_CopyStateForUpdateFailed:
-		return FileDownload_UnableToWriteFile
-	case ExitCode_SkippedImmediateGoalState:
-		return ImmediateRC_TaskCanceled
-	case ExitCode_ImmediateTaskTimeout:
-		return ImmediateRC_TaskTimeout
-	case ExitCode_ImmediateTaskFailed:
-		return ImmediateRC_UnknownFailure
-
-	// Handle standard Linux exit codes
-	default:
-		switch {
-		case exitCode == 0:
-			return 0 // Success
-		case exitCode > 0 && exitCode < 128:
-			// Standard program exit codes (1-127)
-			if exitCode == 1 {
-				return CommandExecution_FailureExitCode
-			} else if exitCode == 126 {
-				return CommandExecution_RunAsCreateProcessFailed // Command not executable
-			} else if exitCode == 127 {
-				return FileDownload_DoesNotExist // Command not found
-			} else {
-				return CommandExecution_FailureExitCode
-			}
-		case exitCode >= 128 && exitCode <= 255:
-			// Signal-terminated processes (128 + signal number)
-			if exitCode == 130 { // SIGINT (Ctrl+C)
-				return ImmediateRC_TaskCanceled
-			} else if exitCode == 137 { // SIGKILL
-				return ImmediateRC_TaskTimeout
-			} else if exitCode == 143 { // SIGTERM
-				return ImmediateRC_TaskCanceled
-			} else {
-				return ImmediateRC_UnhandledException
-			}
-		case exitCode < 0:
-			// Negative exit codes - internal errors
-			return SystemError
-		default:
-			// Unknown exit codes
-			return ImmediateRC_UnknownFailure
-		}
-	}
-}
+	FileSystem_CreateDataDirectoryFailed = 110
+	FileSystem_RemoveDataDirectoryFailed = 121
+	FileSystem_OpenStandardOutFailed     = 122
+	FileSystem_OpenStandardErrorFailed   = 123
+)