Merge pull request #2651 from norio-nomura/improve-debugging-with-dlv-dap

Improve debugging with `dlv dap` (in VSCode, for example)

Author: AkihiroSuda

hack/toolexec-for-codesign.sh

@@ -0,0 +1,54 @@
+#!/bin/sh
+
+# This script is used to wrap the compiler and linker commands in the build
+# process. It captures the output of the command and logs it to a file.
+# The script's primary purpose is codesigning the output of the linker command
+# with the entitlements file if it exists.
+# If the OS is macOS, the result of the command is 0, the entitlements file
+# exists, and codesign is available, sign the output of the linker command with
+# the entitlements file.
+#
+# Usage:
+#   go build -toolexec hack/toolexec-to-codesign.sh
+
+repository_root="$(dirname "$(dirname "$0")")"
+logfile="${repository_root}/.toolexec-to-codesign.log"
+
+echo $$: cmd: "$@" >>"${logfile}"
+
+output="$("$@")"
+result=$?
+
+echo $$: output: "${output}" >>"${logfile}"
+
+entitlements="${repository_root}/vz.entitlements"
+
+# If the OS is macOS, the result of the command is 0, the entitlements file
+# exists, and codesign is available, sign the output of the linker command.
+if OS=$(uname -s) && [ "${OS}" = "Darwin" ] && [ "${result}" -eq 0 ] && [ -f "${entitlements}" ] && command -v codesign >/dev/null 2>&1; then
+	# Check if the command is a linker command.
+	case "$1" in
+	*link)
+		shift
+		# Find a parameter that is a output file.
+		while [ $# -gt 1 ]; do
+			case "$1" in
+			-o)
+				# If the output file is a executable, sign it with the entitlements file.
+				if [ -x "$2" ]; then
+					codesign_output="$(codesign -v --entitlements "${entitlements}" -s - "$2" 2>&1)"
+					echo "$$: ${codesign_output}" >>"${logfile}"
+				fi
+				break
+				;;
+			*) shift ;;
+			esac
+		done
+		;;
+	*) ;;
+	esac
+fi
+
+# Print the output of the command and exit with the result of the command.
+echo "${output}"
+exit "${result}"

pkg/usrlocalsharelima/usrlocalsharelima.go

@@ -9,6 +9,7 @@ import (
 	"runtime"
 
 	"github.com/lima-vm/lima/pkg/limayaml"
+	"github.com/sirupsen/logrus"
 )
 
 func Dir() (string, error) {
@@ -49,6 +50,15 @@ func Dir() (string, error) {
 		filepath.Join(selfDirDir, "share/lima/lima-guestagent."+ostype+"-"+arch),
 		// TODO: support custom path
 	}
+	if logrus.GetLevel() == logrus.DebugLevel {
+		// candidate 2: lauched by `~/go/bin/dlv dap`
+		// - self: ${workspaceFolder}/cmd/limactl/__debug_bin_XXXXXX
+		// - agent: ${workspaceFolder}/_output/share/lima/lima-guestagent.Linux-x86_64
+		// - dir:  ${workspaceFolder}/_output/share/lima
+		candidateForDebugBuild := filepath.Join(filepath.Dir(selfDirDir), "_output/share/lima/lima-guestagent."+ostype+"-"+arch)
+		gaCandidates = append(gaCandidates, candidateForDebugBuild)
+		logrus.Infof("debug build detected, adding more guest agent candidates: %v", candidateForDebugBuild)
+	}
 	for _, gaCandidate := range gaCandidates {
 		if _, err := os.Stat(gaCandidate); err == nil {
 			return filepath.Dir(gaCandidate), nil