feat(cli): Show GitHash for manager-api in branch v2.3 (backport #1162) (#1181)

* fix: correct Version and GitHash output for manager-api command (#1162)

* bug: fix Version and add GitHash for manager-api command

Signed-off-by: imjoey <majunjiev@gmail.com>

* feat: git hash support generating .githash for apache release

Signed-off-by: imjoey <majunjiev@gmail.com>

* feat: Add testcase for the new githash info

Signed-off-by: imjoey <majunjiev@gmail.com>

* feat: add test case for .githash content validation

Signed-off-by: imjoey <majunjiev@gmail.com>

* feat: Remove git command dependency for getting git hash

Signed-off-by: imjoey <majunjiev@gmail.com>

* feat: set VERSION to 2.3 in branch v2.3

Signed-off-by: imjoey <majunjiev@gmail.com>

Author: imjoey

.gitignore

@@ -45,3 +45,4 @@ output
 default.etcd
 api/build-tools/apisix
 /*.zip
+.githash

Makefile

@@ -95,6 +95,7 @@ endif
 .PHONY: release-src
 release-src:
 	git clean -Xdf
+	rm -f ./.githash && git log --pretty=format:"%h" -1 > ./.githash
 	tar -zcvf $(RELEASE_SRC).tgz \
 	--exclude .github \
 	--exclude .git \

api/VERSION

@@ -1 +1 @@
-2.2
+2.3

api/build.sh

@@ -20,6 +20,7 @@ export ENV=local
 pwd=`pwd`
 
 VERSION=$(cat ./api/VERSION)
+GITHASH=$(cat ./.githash 2> /dev/null || HASH="ref: HEAD"; while [[ $HASH == ref\:* ]]; do HASH="$(cat ".git/$(echo $HASH | cut -d \  -f 2)")"; done; echo ${HASH:0:7})
 
 rm -rf output && mkdir -p output/conf && mkdir -p output/dag-to-lua
 
@@ -31,7 +32,7 @@ if [[ ! -f "dag-to-lua-1.1/lib/dag-to-lua.lua" ]]; then
 fi
 
 # build
-cd ./api && go build -o ../output/manager-api -ldflags "-X github.com/apisix/manager-api/cmd.Version=${VERSION}" ./cmd/manager && cd ..
+cd ./api && go build -o ../output/manager-api -ldflags "-X github.com/apisix/manager-api/cmd.Version=${VERSION} -X github.com/apisix/manager-api/cmd.GitHash=${GITHASH}" ./cmd/manager && cd ..
 
 cp ./api/conf/schema.json ./output/conf/schema.json
 cp ./api/conf/conf.yaml ./output/conf/conf.yaml

api/cmd/managerapi.go

@@ -36,11 +36,15 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var Version string
+var (
+	Version string
+	GitHash string
+)
 
 func printInfo() {
 	fmt.Fprint(os.Stdout, "The manager-api is running successfully!\n\n")
 	fmt.Fprintf(os.Stdout, "%-8s: %s\n", "Version", Version)
+	fmt.Fprintf(os.Stdout, "%-8s: %s\n", "GitHash", GitHash)
 	fmt.Fprintf(os.Stdout, "%-8s: %s:%d\n", "Listen", conf.ServerHost, conf.ServerPort)
 	fmt.Fprintf(os.Stdout, "%-8s: %s\n", "Loglevel", conf.ErrorLogLevel)
 	fmt.Fprintf(os.Stdout, "%-8s: %s\n\n", "Logfile", conf.ErrorLogPath)

api/test/shell/cli_test.sh

@@ -20,6 +20,17 @@
 set -ex
 VERSION=$(cat ./VERSION)
 
+# test content in .githash
+if [[ -f ../.githash ]]; then
+    GITHASH=$(cat ../.githash)
+    if [[ ! $GITHASH =~ ^[a-z0-9]{7}$ ]]; then
+        echo "failed: verify .githash content failed"
+        exit 1
+    fi
+else
+    GITHASH=$(HASH="ref: HEAD"; while [[ $HASH == ref\:* ]]; do HASH="$(cat "../.git/$(echo $HASH | cut -d \  -f 2)")"; done; echo ${HASH:0:7})
+fi
+
 clean_up() {
     git checkout conf/conf.yaml
 }
@@ -40,7 +51,7 @@ clean_logfile() {
 trap clean_up EXIT
 
 export GO111MODULE=on
-go build -o ./manager-api -ldflags "-X github.com/apisix/manager-api/cmd.Version=${VERSION}" ./cmd/manager
+go build -o ./manager-api -ldflags "-X github.com/apisix/manager-api/cmd.Version=${VERSION} -X github.com/apisix/manager-api/cmd.GitHash=${GITHASH}" ./cmd/manager
 
 # default level: warn, path: logs/error.log
 
@@ -134,6 +145,11 @@ if [[ `grep -c "${VERSION}" ${STDOUT}` -ne '1' ]]; then
     exit 1
 fi
 
+if [[ `grep -c "${GITHASH}" ${STDOUT}` -ne '1' ]]; then
+    echo "failed: the manager server didn't show started info"
+    exit 1
+fi
+
 if [[ `grep -c "${LOGLEVEL}" ${STDOUT}` -ne '1' ]]; then
     echo "failed: the manager server didn't show started info"
     exit 1