Merge pull request #117 from setlog/feature-reduce-binary-size

Feature reduce binary size

Author: MMulthaupt

.github/workflows/test.yml

@@ -24,6 +24,12 @@ jobs:
         run: |
           sudo apt-get update -y
           sudo apt-get install -y libgtk-3-dev
+      - name: Install UPX (Linux)
+        if: matrix.platform == 'ubuntu-18.04'
+        run: sudo apt-get update && sudo apt-get install upx-ucl
+      - name: Install UPX (Windows)
+        if: matrix.platform == 'windows-2019'
+        run: choco install upx -y
       - name: Install goversioninfo
         shell: bash
         run: |

CHANGES.md

@@ -2,6 +2,8 @@
 
 ## TBD (TBD)
 ### Changes
+* DWARF symbols are now stripped from the trivrost binary to reduce file size. This can save a few bytes on some platforms.
+* The binary is now compressed with UPX when using `make compress`. Reduces the final filesystem to under 50%.
 * Shorter log-output for proxy detection. Reduces average size of the log output by 5–15%.
 * Shorter log-output for HTTP errors, reduces size of log output by a few percent.
 * Update dependencies to recent versions: gopsutils, testify, gojsonschema, logrus, prometheus/client_golang, go_ieproxy, fatih/color, golang/x/sys, golang/x/net

Makefile

@@ -23,7 +23,7 @@ GITDESC                 := $(shell git describe --tags 2> /dev/null || echo unav
 LAUNCHER_VERSION        := $(shell git describe --tags --abbrev=0 --match "v[0-9]*.[0-9]*.[0-9]*" 2> /dev/null || echo unavailable)
 GITBRANCH               := $(shell git symbolic-ref -q --short HEAD || echo unknown)
 GITHASH                 := $(shell git rev-parse --short=8 --verify HEAD || echo unknown)
-LDFLAGS                 := -s -X main.gitDescription=${GITDESC} -X main.gitBranch=${GITBRANCH} -X main.gitHash=${GITHASH} -X "github.com/setlog/trivrost/cmd/launcher/launcher.buildTime=$(shell date -u "+%Y-%m-%d %H:%M:%S UTC")"
+LDFLAGS                 := -s -w -X main.gitDescription=${GITDESC} -X main.gitBranch=${GITBRANCH} -X main.gitHash=${GITHASH} -X "github.com/setlog/trivrost/cmd/launcher/launcher.buildTime=$(shell date -u "+%Y-%m-%d %H:%M:%S UTC")"
 
 # Assume version is part of the tag. If not, default to v0.0.0
 VERSIONOK := $(shell echo -n "${LAUNCHER_VERSION}" | grep -E ^v[0-9]+\.[0-9]+\.[0-9]+$$ && echo ok)
@@ -68,13 +68,21 @@ export LAUNCHER_PROGRAM_EXT
 .PHONY: build bundle bundle-msi test copy-test-files generate clean sign dist help
 
 # Default target
-build: generate  ## Build (default)
+build: compile package
+
+compile: generate  ## Compile with go build. Run after make generate.
 ifeq (${OS},windows)
 	# Removing unneeded PNG from Windows binary
 	rm cmd/launcher/resources/icon.png.gen.go
 endif
 	# See https://github.com/golang/go/issues/18400#issuecomment-270414574 for why -installsuffix is needed.
 	go build -o "${UPDATE_FILES_DIR}/${OS}/${LAUNCHER_PROGRAM_NAME}${LAUNCHER_PROGRAM_EXT}" -v -installsuffix _separate -ldflags '${LDFLAGS}' ${MODULE_PATH_LAUNCHER}
+	$(info # compile finished)
+
+compress:  ## Compress compiled binary with UPX. Needs to run after make compile, but before make sign.
+	upx "${UPDATE_FILES_DIR}/${OS}/${LAUNCHER_PROGRAM_NAME}${LAUNCHER_PROGRAM_EXT}"
+
+package:
 ifeq (${OS},darwin)
 	# Mac bundle is special
 	mkdir -p "${UPDATE_FILES_DIR}/${OS}/${LAUNCHER_PROGRAM_NAME}.app/Contents/MacOS"
@@ -83,7 +91,6 @@ ifeq (${OS},darwin)
 	mkdir -p "${UPDATE_FILES_DIR}/${OS}/${LAUNCHER_PROGRAM_NAME}.app/Contents/Resources"
 	if [ -f cmd/launcher/resources/icon.icns ]; then cp cmd/launcher/resources/icon.icns "${UPDATE_FILES_DIR}/${OS}/${LAUNCHER_PROGRAM_NAME}.app/Contents/Resources/icon.icns"; fi
 endif
-	$(info # make build finished)
 
 bundle:          ## Bundle OS-specific files. Call after signing
 	mkdir -p "${RELEASE_FILES_DIR}/${OS}"

docs/building.md

@@ -11,6 +11,7 @@ In this document, we will focus on how to get the project to build, i.e. success
 - [`go`](https://golang.org/) >= v1.13
 - [`goversioninfo`](https://github.com/josephspurrier/goversioninfo) (Make sure to add `$GOPATH/bin` to your `$PATH`)
 - [`make`](https://superuser.com/questions/352000/whats-a-good-way-to-install-build-essentials-all-common-useful-commands-on)
+- [`upx`](https://upx.github.io/)
 - `libgtk-3-dev`
 
 ## Building
@@ -26,6 +27,7 @@ In this document, we will focus on how to get the project to build, i.e. success
 - [`git`](https://git-scm.com/)
 - [`go`](https://golang.org/) >= v1.13
 - [`goversioninfo`](https://github.com/josephspurrier/goversioninfo) (Make sure to add `%GOPATH%\bin` to your `%PATH%`)
+- [`upx`](https://upx.github.io/)
 
 ## Further instructions
 1. Install [mingw-w64](https://mingw-w64.org) (specifically the [Mingw-builds](https://mingw-w64.org/doku.php/download/mingw-builds) package) as a recent GCC-compatible compiler.