ghost: support building multi-arch

Author: aitjcize

.github/workflows/build.yml

@@ -16,23 +16,22 @@ jobs:
       - name: install
         run: |
           apk update
-          apk add git python3 make gcc linux-headers libc-dev py-pip node npm
+          apk add git python3 make gcc linux-headers libc-dev py-pip
           python3 -m venv .venv
           source .venv/bin/activate
           pip install -r requirements.txt
       - name: Fix permission
         run: git config --global --add safe.directory $PWD
       - name: test
         run: go test -v ./...
-      - name: build-apps
-        run: make build-apps
       - name: unittest
         run: |
           source .venv/bin/activate
           ./scripts/ovl_unittest.py
       - name: e2e_test
         run: |
           source .venv/bin/activate
+          mkdir -p bin/webroot/apps
           ./test/overlord_e2e_unittest.py
 
   build:

.gitignore

@@ -1,5 +1,5 @@
-bin/ghost
-bin/ghost.py.bin
+bin/ghost.*.linux*
+bin/ghost.py*
 bin/overlordd
 bin/ovl.py.bin
 bin/webroot
@@ -8,3 +8,4 @@ webroot/apps
 webroot/index.html
 node_modules
 .vite
+dist

Dockerfile

@@ -27,12 +27,8 @@ RUN mkdir -p /config /app /app/webroot/upgrade
 WORKDIR /app
 
 COPY --from=gobuilder /src/bin/overlordd /app
-COPY --from=gobuilder /src/bin/ghost /app
 COPY --from=gobuilder /src/scripts/start_overlordd.sh /app
-COPY --from=gobuilder /src/bin/ghost /app/webroot/upgrade/ghost.linux.amd64
-
-RUN sha1sum /app/webroot/upgrade/ghost.linux.amd64 | \
-	awk '{ print $1 }' > /app/webroot/upgrade/ghost.linux.amd64.sha1
+COPY --from=gobuilder /src/bin/ghost.* /app/webroot/upgrade/
 
 COPY --from=nodebuilder /src/webroot /app/webroot
 

Makefile

@@ -12,79 +12,116 @@ WEBROOT_DIR=$(CURDIR)/webroot
 APPS_DIR=$(WEBROOT_DIR)/apps
 GO_DIRS=./overlord/... ./cmd/...
 
+# Supported architectures for ghost binary
+GHOST_ARCHS=amd64 386 arm64 armv7
+GHOST_BINS=$(addprefix $(BIN)/ghost., $(addsuffix .linux,$(GHOST_ARCHS)))
+
+# Output formatting
+cmd_msg = @echo "  $(1)  $(2)"
+
 ifeq ($(STATIC), true)
 	LDFLAGS=-a -tags netgo -installsuffix netgo \
 		-ldflags '-extldflags "-static"'
 endif
 
-.PHONY: all build build-bin build-apps clean clean-apps install go-fmt go-lint
+.PHONY: all \
+	build build-go build-py build-apps \
+	ghost overlordd \
+	go-fmt go-lint \
+	clean clean-apps \
+	install
 
 all: build
 
-build: build-bin build-apps
+build: build-go build-py build-apps
 
 deps:
-	mkdir -p $(BIN)
-	if $(DEPS); then \
+	@mkdir -p $(BIN)
+	@if $(DEPS); then \
+		$(call cmd_msg,GET,dependencies); \
 		cd $(CURDIR); \
 		$(GO) get ./...; \
 	fi
 
 overlordd: deps
-	GOBIN=$(BIN) $(GO) install $(LDFLAGS) $(CURDIR)/cmd/$@
-	rm -f $(BIN)/webroot
-	ln -s $(WEBROOT_DIR) $(BIN)/webroot
+	$(call cmd_msg,GO,cmd/$@)
+	@GOBIN=$(BIN) $(GO) install $(LDFLAGS) $(CURDIR)/cmd/$@
+	@rm -f $(BIN)/webroot
+	@ln -s $(WEBROOT_DIR) $(BIN)/webroot
 
 ghost: deps
-	GOBIN=$(BIN) $(GO) install $(LDFLAGS) $(CURDIR)/cmd/$@
+	@for arch in $(GHOST_ARCHS); do \
+		$(call cmd_msg,GO,ghost.$$arch.linux); \
+		GOARCH_VAL=$$arch; \
+		if [ "$$arch" = "armv7" ]; then \
+			GOARCH_VAL="arm"; \
+			GOARM=7 GOOS=linux GOARCH=$$GOARCH_VAL \
+			$(GO) build $(LDFLAGS) \
+				-o $(BIN)/ghost.$$arch.linux \
+				$(CURDIR)/cmd/ghost; \
+		else \
+			GOOS=linux GOARCH=$$GOARCH_VAL \
+			$(GO) build $(LDFLAGS) \
+				-o $(BIN)/ghost.$$arch.linux \
+				$(CURDIR)/cmd/ghost; \
+		fi; \
+	done
+	@cd $(BIN) && for arch in $(GHOST_ARCHS); do \
+		$(call cmd_msg,SHA1,ghost.$$arch.linux); \
+		sha1sum ghost.$$arch.linux > ghost.$$arch.linux.sha1; \
+	done
 
 build-go: overlordd ghost
 
-build-bin:
-	mkdir -p $(BUILD)
-	# Create virtualenv environment
-	rm -rf $(BUILD)/.venv
-	python -m venv $(BUILD)/.venv
-	# Build ovl binary with pyinstaller
-	cd $(BUILD); \
+build-py:
+	@ln -sf ../scripts/ghost.py bin
+	@mkdir -p $(BUILD)
+	$(call cmd_msg,VENV,creating virtualenv)
+	@rm -rf $(BUILD)/.venv
+	@python -m venv $(BUILD)/.venv
+	$(call cmd_msg,PIP,installing requirements)
+	@cd $(BUILD); \
 	. $(BUILD)/.venv/bin/activate; \
-	pip install -r $(CURDIR)/requirements.txt; \
-	pip install pyinstaller; \
-	pyinstaller --onefile $(CURDIR)/scripts/ovl.py; \
-	pyinstaller --onefile $(CURDIR)/scripts/ghost.py
-	# Move built binary to bin
-	mv $(BUILD)/dist/ovl $(BIN)/ovl.py.bin
-	mv $(BUILD)/dist/ghost $(BIN)/ghost.py.bin
-
+	pip install -q -r $(CURDIR)/requirements.txt; \
+	pip install -q pyinstaller; \
+	$(call cmd_msg,GEN,ovl.py.bin); \
+	pyinstaller --onefile $(CURDIR)/scripts/ovl.py > /dev/null; \
+	$(call cmd_msg,GEN,ghost.py.bin); \
+	pyinstaller --onefile $(CURDIR)/scripts/ghost.py > /dev/null
+	$(call cmd_msg,MV,binaries to $(BIN))
+	@mv $(BUILD)/dist/ovl $(BIN)/ovl.py.bin
+	@mv $(BUILD)/dist/ghost $(BIN)/ghost.py.bin
 
 go-fmt:
-	$(GO) fmt $(GO_DIRS)
+	$(call cmd_msg,FMT,$(GO_DIRS))
+	@$(GO) fmt $(GO_DIRS)
 
 go-lint:
-	$(GO) vet $(GO_DIRS)
+	$(call cmd_msg,VET,$(GO_DIRS))
+	@$(GO) vet $(GO_DIRS)
 	@if ! command -v golint > /dev/null; then \
-		echo "Installing golint..."; \
+		$(call cmd_msg,GO,installing golint); \
 		$(GO) install golang.org/x/lint/golint@latest; \
 	fi
-	golint -set_exit_status $(GO_DIRS)
+	$(call cmd_msg,LINT,$(GO_DIRS))
+	@golint -set_exit_status $(GO_DIRS)
 
 # Build all apps that have a package.json
 build-apps:
-	@echo "Building apps ..."
 	@mkdir -p $(APPS_DIR)
 	@cd apps && \
 	for dir in */; do \
 		if [ ! -f "$$dir/package.json" ]; then \
 			continue; \
 		fi; \
-		echo "Building $$dir ..."; \
-		(cd "$$dir" && npm install && npm run build); \
+		$(call cmd_msg,NPM,$$dir); \
+		(cd "$$dir" && npm install --silent && npm run build --silent); \
 		if [ -d "$$dir/dist" ]; then \
-			echo "Copying $$dir dist to apps directory ..."; \
+			$(call cmd_msg,CP,$$dir to apps); \
 			mkdir -p $(APPS_DIR)/"$${dir%/}"; \
 			cp -r "$$dir/dist/"* $(APPS_DIR)/"$${dir%/}"/; \
 			if [ "$$dir" = "dashboard/" ]; then \
-				echo "Copying dashboard to webroot ..."; \
+				$(call cmd_msg,CP,dashboard to webroot); \
 				cp $(APPS_DIR)/dashboard/index.html \
 					$(CURDIR)/webroot/index.html; \
 			fi; \
@@ -96,16 +133,17 @@ build-apps:
 
 # Install the built apps to the system directory
 install: build
-	@echo "Installing apps..."
-	mkdir -p /usr/local/share/overlord/apps
-	cp -r $(APPS_DIR)/* /usr/local/share/overlord/apps/
-	@echo "Installation complete"
+	$(call cmd_msg,CP,apps to system)
+	@mkdir -p /usr/local/share/overlord/apps
+	@cp -r $(APPS_DIR)/* /usr/local/share/overlord/apps/
 
 clean-apps:
-	rm -rf $(APPS_DIR)
-	rm -rf $(WEBROOT_DIR)/index.html
+	$(call cmd_msg,RM,apps)
+	@rm -rf $(APPS_DIR)
+	@rm -rf $(WEBROOT_DIR)/index.html
 
 clean: clean-apps
-	rm -rf $(BIN)/ghost $(BIN)/overlordd $(BUILD) \
+	$(call cmd_msg,RM,build artifacts)
+	@rm -rf $(BIN)/ghost* $(BIN)/overlordd $(BUILD) \
 		$(BIN)/ghost.py.bin $(BIN)/ovl.py.bin \
 		$(APPS_DIR)

bin/ghost.py

@@ -73,3 +73,17 @@ func GetenvInt(key string, defaultValue int) int {
 	}
 	return value
 }
+
+// Ttyname returns the TTY name of a given file descriptor.
+func Ttyname(fd uintptr) (string, error) {
+	// Get the process ID
+	pid := os.Getpid()
+
+	// Try to read the symlink for the file descriptor
+	ttyPath, err := os.Readlink(fmt.Sprintf("/proc/%d/fd/%d", pid, fd))
+	if err != nil {
+		return "", fmt.Errorf("failed to get tty name: %v", err)
+	}
+
+	return ttyPath, nil
+}