From 9c9199e2f484e9fb6c4e7cecfaadb5abdee4bf91 Mon Sep 17 00:00:00 2001
From: Manuel Huber <mahuber@microsoft.com>
Date: Tue, 11 Jun 2024 20:51:26 +0000
Subject: [PATCH] build: allow rootfs builds w/o git or VERSION file deps

We set the VERSION variable consistently across Makefiles to
'unknown'  if the file is empty or not present.
We also use git commands consistently for calculating the COMMIT,
COMMIT_NO variables, not erroring out when building outside of
a git repository.
In create_summary_file we also account for a missing/empty VERSION
file.
This makes e.g. the UVM build process in an environment where we
build outside of git with a minimal/reduced set of files smoother.

Signed-off-by: Manuel Huber <mahuber@microsoft.com>
---
 src/agent/Makefile             | 2 +-
 src/runtime-rs/Makefile        | 2 +-
 src/tools/kata-ctl/Makefile    | 2 +-
 src/tools/log-parser/Makefile  | 7 ++++---
 tools/osbuilder/Makefile       | 6 +++---
 tools/osbuilder/scripts/lib.sh | 3 ++-
 6 files changed, 12 insertions(+), 10 deletions(-)

diff --git a/src/agent/Makefile b/src/agent/Makefile
index 5b118beb9c9c..169c2ab421ba 100644
--- a/src/agent/Makefile
+++ b/src/agent/Makefile
@@ -15,7 +15,7 @@ PROJECT_COMPONENT = kata-agent
 TARGET = $(PROJECT_COMPONENT)
 
 VERSION_FILE := ./VERSION
-VERSION := $(shell grep -v ^\# $(VERSION_FILE))
+VERSION := $(shell grep -v ^\# $(VERSION_FILE) 2>/dev/null || echo "unknown")
 COMMIT_NO := $(shell git rev-parse HEAD 2>/dev/null || true)
 COMMIT := $(if $(shell git status --porcelain --untracked-files=no 2>/dev/null || true),${COMMIT_NO}-dirty,${COMMIT_NO})
 COMMIT_MSG = $(if $(COMMIT),$(COMMIT),unknown)
diff --git a/src/runtime-rs/Makefile b/src/runtime-rs/Makefile
index f492d1d33485..cdb72ebafea7 100644
--- a/src/runtime-rs/Makefile
+++ b/src/runtime-rs/Makefile
@@ -355,7 +355,7 @@ SOURCES := \
   Cargo.toml
 
 VERSION_FILE := ./VERSION
-VERSION := $(shell grep -v ^\# $(VERSION_FILE))
+VERSION := $(shell grep -v ^\# $(VERSION_FILE) 2>/dev/null || echo "unknown")
 COMMIT_NO := $(shell git rev-parse HEAD 2>/dev/null || true)
 COMMIT := $(if $(shell git status --porcelain --untracked-files=no 2>/dev/null || true),${COMMIT_NO}-dirty,${COMMIT_NO})
 COMMIT_MSG = $(if $(COMMIT),$(COMMIT),unknown)
diff --git a/src/tools/kata-ctl/Makefile b/src/tools/kata-ctl/Makefile
index 546f0783adfd..c14d72a92a4a 100644
--- a/src/tools/kata-ctl/Makefile
+++ b/src/tools/kata-ctl/Makefile
@@ -13,7 +13,7 @@ TARGET = $(PROJECT_COMPONENT)
 INSTALL_PATH = $(HOME)/.cargo
 
 VERSION_FILE := ./VERSION
-export VERSION := $(shell grep -v ^\# $(VERSION_FILE))
+export VERSION := $(shell grep -v ^\# $(VERSION_FILE) 2>/dev/null || echo "unknown")
 COMMIT_NO := $(shell git rev-parse HEAD 2>/dev/null || true)
 COMMIT_NO_SHORT := $(shell git rev-parse --short HEAD 2>/dev/null || true)
 export COMMIT := $(if $(shell git status --porcelain --untracked-files=no 2>/dev/null || true),${COMMIT_NO}-dirty,${COMMIT_NO})
diff --git a/src/tools/log-parser/Makefile b/src/tools/log-parser/Makefile
index 0a680059b3a9..91b75652d0a5 100644
--- a/src/tools/log-parser/Makefile
+++ b/src/tools/log-parser/Makefile
@@ -7,9 +7,10 @@
 TARGET = kata-log-parser
 SOURCES = $(shell find . 2>&1 | grep -E '.*\.go$$')
 
-VERSION := ${shell cat ./VERSION}
-COMMIT_NO := $(shell git rev-parse HEAD 2> /dev/null || true)
-COMMIT := $(if $(shell git status --porcelain --untracked-files=no),"${COMMIT_NO}-dirty","${COMMIT_NO}")
+VERSION_FILE := ./VERSION
+VERSION := $(shell grep -v ^\# $(VERSION_FILE) 2>/dev/null || echo "unknown")
+COMMIT_NO := $(shell git rev-parse HEAD 2>/dev/null || true)
+COMMIT := $(if $(shell git status --porcelain --untracked-files=no 2>/dev/null || true),"${COMMIT_NO}-dirty","${COMMIT_NO}")
 
 BINDIR := $(GOPATH)/bin
 DESTTARGET := $(abspath $(BINDIR)/$(TARGET))
diff --git a/tools/osbuilder/Makefile b/tools/osbuilder/Makefile
index 81e48907c9a0..f7924a7c3497 100644
--- a/tools/osbuilder/Makefile
+++ b/tools/osbuilder/Makefile
@@ -31,9 +31,9 @@ TARGET_IGVM_DEBUG_MSMT:= $(IGVM_BUILD_DEST)/igvm-debug-measurement.cose
 TARGET_IGVM_LOG       := $(IGVM_BUILD_DEST)/igvm.log
 
 VERSION_FILE   := ./VERSION
-VERSION        := $(shell grep -v ^\# $(VERSION_FILE))
-COMMIT_NO      := $(shell git rev-parse HEAD 2> /dev/null || true)
-COMMIT         := $(if $(shell git status --porcelain --untracked-files=no),${COMMIT_NO}-dirty,${COMMIT_NO})
+VERSION        := $(shell grep -v ^\# $(VERSION_FILE) 2>/dev/null || echo "unknown")
+COMMIT_NO      := $(shell git rev-parse HEAD 2>/dev/null || true)
+COMMIT         := $(if $(shell git status --porcelain --untracked-files=no 2>/dev/null || true),${COMMIT_NO}-dirty,${COMMIT_NO})
 VERSION_COMMIT := $(if $(COMMIT),$(VERSION)-$(COMMIT),$(VERSION))
 
 ifeq ($(filter $(BUILD_METHOD),$(BUILD_METHOD_LIST)),)
diff --git a/tools/osbuilder/scripts/lib.sh b/tools/osbuilder/scripts/lib.sh
index 56c4199f7cfd..5e3687595953 100644
--- a/tools/osbuilder/scripts/lib.sh
+++ b/tools/osbuilder/scripts/lib.sh
@@ -181,7 +181,8 @@ create_summary_file()
 	[ "$AGENT_INIT" = yes ] && agent="${init}"
 
 	local -r agentdir="${script_dir}/../../../"
-	local -r agent_version=$(cat ${agentdir}/VERSION)
+	local agent_version=$(cat ${agentdir}/VERSION 2> /dev/null)
+	[ -z "$agent_version" ] && agent_version="unknown"
 
 	cat >"$file"<<-EOF
 	---