@ -16,7 +16,172 @@
# Build management helpers. These functions help to set, save and load the
# Build management helpers. These functions help to set, save and load the
#
#
GO := go
GO_SUPPORTED_VERSIONS ?= | 1.15| 1.16| 1.17| 1.18| 1.19| 1.20|
GO_LDFLAGS += -X $( VERSION_PACKAGE) .gitVersion= $( GIT_TAG) \
-X $( VERSION_PACKAGE) .gitCommit= $( GIT_COMMIT) \
-X $( VERSION_PACKAGE) .gitTreeState= $( GIT_TREE_STATE) \
-X $( VERSION_PACKAGE) .buildDate= $( BUILD_DATE) \
-s -w # -s -w deletes debugging information and symbol tables
i f e q ( $( DEBUG ) , 1 )
GO_BUILD_FLAGS += -gcflags "all=-N -l"
GO_LDFLAGS =
e n d i f
GO_BUILD_FLAGS += -ldflags " $( GO_LDFLAGS) "
i f e q ( $( GOOS ) , w i n d o w s )
GO_OUT_EXT := .exe
e n d i f
i f e q ( $( ROOT_PACKAGE ) , )
$( error the variable ROOT_PACKAGE must be set prior to including golang.mk, ->/Makefile)
e n d i f
GOPATH ?= $( shell go env GOPATH)
i f e q ( $( origin GOBIN ) , u n d e f i n e d )
GOBIN := $( GOPATH) /bin
e n d i f
# COMMANDS is Specify all files under ${ROOT_DIR}/cmd/ except those ending in.md
COMMANDS ?= $( filter-out %.md, $( wildcard ${ ROOT_DIR } /cmd/*) )
i f e q ( $ { C O M M A N D S } , )
$( error Could not determine COMMANDS, set ROOT_DIR or run in source dir)
e n d i f
# BINS is the name of each file in ${COMMANDS}, excluding the directory path
# If there are no files in ${COMMANDS}, or if all files end in.md, ${BINS} will be empty
BINS ?= $( foreach cmd,${ COMMANDS } ,$( notdir ${ cmd } ) )
i f e q ( $ { B I N S } , )
$( error Could not determine BINS, set ROOT_DIR or run in source dir)
e n d i f
i f e q ( $ { C O M M A N D S } , )
$( error Could not determine COMMANDS, set ROOT_DIR or run in source dir)
e n d i f
i f e q ( $ { B I N S } , )
$( error Could not determine BINS, set ROOT_DIR or run in source dir)
e n d i f
# TODO: EXCLUDE_TESTS variable, which contains the name of the package to be excluded from the test
EXCLUDE_TESTS = github.com/OpenIMSDK/Open-IM-Server/test github.com/OpenIMSDK/Open-IM-Server/pkg/log github.com/OpenIMSDK/Open-IM-Server/db github.com/OpenIMSDK/Open-IM-Server/script github.com/OpenIMSDK/Open-IM-Server/deploy_k8s github.com/OpenIMSDK/Open-IM-Server/deploy github.com/OpenIMSDK/Open-IM-Server/config
# ==============================================================================
# ❯
# cmd
# ├── Open-IM-SDK-Core/ - main.go
# ├── open_im_api
# ├── open_im_cms_api
# ├── open_im_cron_task
# ├── open_im_demo
# ├── open_im_msg_gateway
# ├── open_im_msg_transfer
# ├── open_im_push
# ├── rpc/open_im_admin_cms/ - main.go
# └── test/ - main.go
# COMMAND=openim
# PLATFORM=linux_amd64
# OS=linux
# ARCH=amd64
# BINS=open_im_api open_im_cms_api open_im_cron_task open_im_demo open_im_msg_gateway open_im_msg_transfer open_im_push
# BIN_DIR=/root/workspaces/OpenIM/_output/bin
# ==============================================================================
## go.build: Build binaries
.PHONY : go .build
go.build : go .build .verify $( addprefix go .build ., $ ( addprefix $ ( PLATFORM ) ., $ ( BINS ) ) )
@echo " ===========> Building binary $( BINS) $( VERSION) for $( PLATFORM) "
## go.build.verify: Verify that a suitable version of Go exists
.PHONY : go .build .verify
go.build.verify :
i f n e q ( $( shell $ ( GO ) version | grep -q -E '\bgo ( $ ( GO_SUPPORTED_VERSIONS ) ) \b ' && echo 0 || echo 1) , 0 )
$( error unsupported go version. Please make install one of the following supported version: '$(GO_SUPPORTED_VERSIONS)' )
e n d i f
.PHONY : go .build .%
go.build.% :
$( eval COMMAND := $( word 2,$( subst ., ,$* ) ) )
$( eval PLATFORM := $( word 1,$( subst ., ,$* ) ) )
$( eval OS := $( word 1,$( subst _, ,$( PLATFORM) ) ) )
$( eval ARCH := $( word 2,$( subst _, ,$( PLATFORM) ) ) )
@echo " =====> COMMAND= $( COMMAND) "
@echo " =====> PLATFORM= $( PLATFORM) "
@echo " =====> BIN_DIR= $( BIN_DIR) "
@echo " ===========> Building binary $( COMMAND) $( VERSION) for $( OS) _ $( ARCH) "
@mkdir -p $( OUTPUT_DIR) /platforms/$( OS) /$( ARCH)
@if [ " $( COMMAND) " = = "rpc" ] || [ " $( COMMAND) " = = "Open-IM-SDK-Core" ] ; then \
echo " ===========> Compilation is not yet supported $( COMMAND) " ; \
else \
CGO_ENABLED = 0 GOOS = $( OS) GOARCH = $( ARCH) $( GO) build $( GO_BUILD_FLAGS) -o $( OUTPUT_DIR) /platforms/$( OS) /$( ARCH) /$( COMMAND) $( GO_OUT_EXT) $( ROOT_DIR) /cmd/$( COMMAND) /main.go; \
fi
## go.multiarch: Build multi-arch binaries
.PHONY : go .build .multiarch
go.build.multiarch : go .build .verify $( foreach p ,$ ( PLATFORMS ) ,$ ( addprefix go .build ., $ ( addprefix $ ( p ) ., $ ( BINS ) ) ) )
## go.lint: Run golangci to lint source codes
.PHONY : go .lint
go.lint : tools .verify .golangci -lint
@echo "===========> Run golangci to lint source codes"
@$( TOOLS_DIR) /golangci-lint run -c $( ROOT_DIR) /.golangci.yml $( ROOT_DIR) /...
## go.test: Run unit test
.PHONY : go .test
go.test :
@$( GO) test ./...
# ## go.test.junit-report: Run unit test
# .PHONY: go.test.junit-report
# go.test.junit-report: tools.verify.go-junit-report
# @echo "===========> Run unit test > $(TMP_DIR)/report.xml"
# @$(GO) test -v -coverprofile=$(TMP_DIR)/coverage.out 2>&1 $(GO_BUILD_FLAGS) ./... | $(TOOLS_DIR)/go-junit-report -set-exit-code > $(TMP_DIR)/report.xml
# @sed -i '/mock_.*.go/d' $(TMP_DIR)/coverage.out
# @echo "===========> Test coverage of Go code is reported to $(TMP_DIR)/coverage.html by generating HTML"
# @$(GO) tool cover -html=$(TMP_DIR)/coverage.out -o $(TMP_DIR)/coverage.html
## go.test.junit-report: Run unit test
.PHONY : go .test .junit -report
go.test.junit-report : tools .verify .go -junit -report
@echo " ===========> Run unit test > $( OUTPUT_DIR) /report.xml "
@$( GO) test -v -coverprofile= $( OUTPUT_DIR) /coverage.out 2>& 1 ./... | $( TOOLS_DIR) /go-junit-report -set-exit-code > $( OUTPUT_DIR) /report.xml
@sed -i '/mock_.*.go/d' $( OUTPUT_DIR) /coverage.out
@echo " ===========> Test coverage of Go code is reported to $( OUTPUT_DIR) /coverage.html by generating HTML "
@$( GO) tool cover -html= $( OUTPUT_DIR) /coverage.out -o $( OUTPUT_DIR) /coverage.html
## go.test.cover: Run unit test with coverage
.PHONY : go .test .cover
go.test.cover : go .test .junit -report
@touch $( TMP_DIR) /coverage.out
@$( GO) tool cover -func= $( TMP_DIR) /coverage.out | \
awk -v target = $( COVERAGE) -f $( ROOT_DIR) /scripts/coverage.awk
## go.format: Run unit test and format codes
.PHONY : go .format
go.format : tools .verify .golines tools .verify .goimports
@echo "===========> Formating codes"
@$( FIND) -type f -name '*.go' | $( XARGS) gofmt -s -w
@$( FIND) -type f -name '*.go' | $( XARGS) $( TOOLS_DIR) /goimports -w -local $( ROOT_PACKAGE)
@$( FIND) -type f -name '*.go' | $( XARGS) $( TOOLS_DIR) /golines -w --max-len= 120 --reformat-tags --shorten-comments --ignore-generated .
@$( GO) mod edit -fmt
## imports: task to automatically handle import packages in Go files using goimports tool
.PHONY : go .imports
go.imports : tools .verify .goimports
@$( TOOLS_DIR) /goimports -l -w $( SRC)
## go.updates: Check for updates to go.mod dependencies
.PHONY : go .updates
go.updates : tools .verify .go -mod -outdated
@$( GO) list -u -m -json all | go-mod-outdated -update -direct
## go.clean: Clean all builds directories and files
.PHONY : go .clean
go.clean :
@echo " ===========> Cleaning all builds OUTPUT_DIR( $( OUTPUT_DIR) ) AND BIN_DIR( $( BIN_DIR) ) "
@-rm -vrf $( OUTPUT_DIR) $( BIN_DIR)
@echo "===========> End clean..."
## copyright.help: Show copyright help
## copyright.help: Show copyright help
.PHONY : go .help .PHONY : go .help
Xinwei Xiong
2 years ago
committed by
GitHub