2020-04-08 10:59:16 +00:00
|
|
|
export GO111MODULE=on
|
2020-05-18 06:18:34 +00:00
|
|
|
|
|
|
|
# By default, the target OS is the same as the host OS,
|
|
|
|
# but this can be overridden by setting TARGET_OS to "windows"/"darwin"/"linux".
|
2020-04-08 10:59:16 +00:00
|
|
|
GOOS:=$(shell go env GOOS)
|
2020-05-18 06:18:34 +00:00
|
|
|
TARGET_OS?=${GOOS}
|
2020-04-08 10:59:16 +00:00
|
|
|
|
|
|
|
## Build
|
2020-04-24 08:47:48 +00:00
|
|
|
.PHONY: build build-nogui check-has-go
|
2020-04-08 10:59:16 +00:00
|
|
|
|
2020-07-16 08:53:58 +00:00
|
|
|
BRIDGE_VERSION?=$(shell git describe --abbrev=0 --tags)-git
|
2020-04-08 10:59:16 +00:00
|
|
|
REVISION:=$(shell git rev-parse --short=10 HEAD)
|
|
|
|
BUILD_TIME:=$(shell date +%FT%T%z)
|
|
|
|
|
|
|
|
BUILD_TAGS?=pmapi_prod
|
|
|
|
BUILD_FLAGS:=-tags='${BUILD_TAGS}'
|
|
|
|
BUILD_FLAGS_NOGUI:=-tags='${BUILD_TAGS} nogui'
|
2020-04-23 08:21:59 +00:00
|
|
|
GO_LDFLAGS:=$(addprefix -X github.com/ProtonMail/proton-bridge/pkg/constants.,Version=${BRIDGE_VERSION} Revision=${REVISION} BuildTime=${BUILD_TIME})
|
2020-04-08 10:59:16 +00:00
|
|
|
ifneq "${BUILD_LDFLAGS}" ""
|
|
|
|
GO_LDFLAGS+= ${BUILD_LDFLAGS}
|
|
|
|
endif
|
|
|
|
GO_LDFLAGS:=-ldflags '${GO_LDFLAGS}'
|
|
|
|
BUILD_FLAGS+= ${GO_LDFLAGS}
|
|
|
|
BUILD_FLAGS_NOGUI+= ${GO_LDFLAGS}
|
|
|
|
|
|
|
|
DEPLOY_DIR:=cmd/Desktop-Bridge/deploy
|
|
|
|
ICO_FILES:=
|
|
|
|
EXE:=$(shell basename ${CURDIR})
|
|
|
|
|
2020-05-18 06:18:34 +00:00
|
|
|
ifeq "${TARGET_OS}" "windows"
|
2020-05-21 08:24:23 +00:00
|
|
|
EXE:=${EXE}.exe
|
2020-04-08 10:59:16 +00:00
|
|
|
ICO_FILES:=logo.ico icon.rc icon_windows.syso
|
|
|
|
endif
|
2020-05-18 06:18:34 +00:00
|
|
|
ifeq "${TARGET_OS}" "darwin"
|
2020-04-08 10:59:16 +00:00
|
|
|
DARWINAPP_CONTENTS:=${DEPLOY_DIR}/darwin/${EXE}.app/Contents
|
2020-04-14 12:05:10 +00:00
|
|
|
EXE:=${EXE}.app/Contents/MacOS/${EXE}
|
2020-04-08 10:59:16 +00:00
|
|
|
endif
|
2020-05-18 06:18:34 +00:00
|
|
|
EXE_TARGET:=${DEPLOY_DIR}/${TARGET_OS}/${EXE}
|
|
|
|
TGZ_TARGET:=bridge_${TARGET_OS}_${REVISION}.tgz
|
2020-04-08 10:59:16 +00:00
|
|
|
|
|
|
|
|
2020-05-21 08:24:23 +00:00
|
|
|
build: ${TGZ_TARGET}
|
2020-05-19 14:19:51 +00:00
|
|
|
|
2020-04-24 08:47:48 +00:00
|
|
|
build-nogui:
|
|
|
|
go build ${BUILD_FLAGS_NOGUI} -o Desktop-Bridge cmd/Desktop-Bridge/main.go
|
|
|
|
|
2020-05-18 06:18:34 +00:00
|
|
|
${TGZ_TARGET}: ${DEPLOY_DIR}/${TARGET_OS}
|
2020-04-08 10:59:16 +00:00
|
|
|
rm -f $@
|
2020-05-18 06:18:34 +00:00
|
|
|
cd ${DEPLOY_DIR} && tar czf ../../../$@ ${TARGET_OS}
|
2020-04-08 10:59:16 +00:00
|
|
|
|
|
|
|
${DEPLOY_DIR}/linux: ${EXE_TARGET}
|
|
|
|
cp -pf ./internal/frontend/share/icons/logo.svg ${DEPLOY_DIR}/linux/
|
|
|
|
cp -pf ./LICENSE ${DEPLOY_DIR}/linux/
|
|
|
|
cp -pf ./Changelog.md ${DEPLOY_DIR}/linux/
|
|
|
|
|
|
|
|
${DEPLOY_DIR}/darwin: ${EXE_TARGET}
|
|
|
|
cp ./internal/frontend/share/icons/Bridge.icns ${DARWINAPP_CONTENTS}/Resources/
|
|
|
|
cp LICENSE ${DARWINAPP_CONTENTS}/Resources/
|
|
|
|
rm -rf "${DARWINAPP_CONTENTS}/Frameworks/QtWebEngine.framework"
|
|
|
|
rm -rf "${DARWINAPP_CONTENTS}/Frameworks/QtWebView.framework"
|
|
|
|
rm -rf "${DARWINAPP_CONTENTS}/Frameworks/QtWebEngineCore.framework"
|
2020-04-23 14:27:32 +00:00
|
|
|
./utils/remove_non_relative_links_darwin.sh "${EXE_TARGET}"
|
2020-04-08 10:59:16 +00:00
|
|
|
|
|
|
|
${DEPLOY_DIR}/windows: ${EXE_TARGET}
|
|
|
|
cp ./internal/frontend/share/icons/logo.ico ${DEPLOY_DIR}/windows/
|
2020-04-20 17:10:02 +00:00
|
|
|
cp LICENSE ${DEPLOY_DIR}/windows/
|
2020-04-08 10:59:16 +00:00
|
|
|
|
2020-05-18 06:18:34 +00:00
|
|
|
QT_BUILD_TARGET:=build desktop
|
|
|
|
ifneq "${GOOS}" "${TARGET_OS}"
|
|
|
|
ifeq "${TARGET_OS}" "windows"
|
|
|
|
QT_BUILD_TARGET:=-docker build windows_64_shared
|
|
|
|
endif
|
|
|
|
endif
|
|
|
|
|
2020-04-08 10:59:16 +00:00
|
|
|
${EXE_TARGET}: check-has-go gofiles ${ICO_FILES} update-vendor
|
2020-05-18 06:18:34 +00:00
|
|
|
rm -rf deploy ${TARGET_OS} ${DEPLOY_DIR}
|
2020-04-08 10:59:16 +00:00
|
|
|
cp cmd/Desktop-Bridge/main.go .
|
2020-05-18 06:18:34 +00:00
|
|
|
qtdeploy ${BUILD_FLAGS} ${QT_BUILD_TARGET}
|
2020-04-08 10:59:16 +00:00
|
|
|
mv deploy cmd/Desktop-Bridge
|
2020-05-18 06:18:34 +00:00
|
|
|
rm -rf ${TARGET_OS} main.go
|
2020-04-08 10:59:16 +00:00
|
|
|
|
|
|
|
logo.ico: ./internal/frontend/share/icons/logo.ico
|
|
|
|
cp $^ .
|
|
|
|
icon.rc: ./internal/frontend/share/icon.rc
|
|
|
|
cp $^ .
|
|
|
|
./internal/frontend/qt/icon_windows.syso: ./internal/frontend/share/icon.rc logo.ico
|
2020-05-18 08:30:18 +00:00
|
|
|
windres --target=pe-x86-64 -o $@ $<
|
2020-04-08 10:59:16 +00:00
|
|
|
icon_windows.syso: ./internal/frontend/qt/icon_windows.syso
|
|
|
|
cp $^ .
|
|
|
|
|
|
|
|
|
|
|
|
## Rules for therecipe/qt
|
|
|
|
.PHONY: prepare-vendor update-vendor
|
2020-05-18 06:18:34 +00:00
|
|
|
THERECIPE_ENV:=github.com/therecipe/env_${TARGET_OS}_amd64_513
|
2020-04-08 10:59:16 +00:00
|
|
|
|
|
|
|
# vendor folder will be deleted by gomod hence we cache the big repo
|
|
|
|
# therecipe/env in order to download it only once
|
|
|
|
vendor-cache/${THERECIPE_ENV}:
|
|
|
|
git clone https://${THERECIPE_ENV}.git vendor-cache/${THERECIPE_ENV}
|
|
|
|
|
2020-05-18 06:18:34 +00:00
|
|
|
# The command used to make symlinks is different on windows.
|
|
|
|
# So if the GOOS is windows and we aren't crossbuilding (in which case the host os would still be *nix)
|
|
|
|
# we need to change the LINKCMD to something windowsy.
|
2020-04-08 10:59:16 +00:00
|
|
|
LINKCMD:=ln -sf ${CURDIR}/vendor-cache/${THERECIPE_ENV} vendor/${THERECIPE_ENV}
|
|
|
|
ifeq "${GOOS}" "windows"
|
2020-05-18 06:18:34 +00:00
|
|
|
WINDIR:=$(subst /c/,c:\\,${CURDIR})/vendor-cache/${THERECIPE_ENV}
|
|
|
|
LINKCMD:=cmd //c 'mklink $(subst /,\,vendor\${THERECIPE_ENV} ${WINDIR})'
|
2020-04-08 10:59:16 +00:00
|
|
|
endif
|
|
|
|
|
|
|
|
prepare-vendor:
|
|
|
|
go install -v -tags=no_env github.com/therecipe/qt/cmd/...
|
|
|
|
go mod vendor
|
|
|
|
|
|
|
|
# update-vendor is PHONY because we need to make sure that we always have updated vendor
|
|
|
|
update-vendor: vendor-cache/${THERECIPE_ENV} prepare-vendor
|
|
|
|
${LINKCMD}
|
|
|
|
|
|
|
|
|
|
|
|
## Dev dependencies
|
|
|
|
.PHONY: install-devel-tools install-linter install-go-mod-outdated
|
2020-07-28 07:34:16 +00:00
|
|
|
LINTVER:="v1.29.0"
|
2020-04-08 10:59:16 +00:00
|
|
|
LINTSRC:="https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh"
|
|
|
|
|
|
|
|
install-dev-dependencies: install-devel-tools install-linter install-go-mod-outdated
|
|
|
|
|
|
|
|
install-devel-tools: check-has-go
|
|
|
|
go get -v github.com/golang/mock/gomock
|
|
|
|
go get -v github.com/golang/mock/mockgen
|
|
|
|
go get -v github.com/go-delve/delve
|
|
|
|
|
|
|
|
install-linter: check-has-go
|
|
|
|
curl -sfL $(LINTSRC) | sh -s -- -b $(shell go env GOPATH)/bin $(LINTVER)
|
|
|
|
|
|
|
|
install-go-mod-outdated:
|
|
|
|
which go-mod-outdated || go get -u github.com/psampaz/go-mod-outdated
|
|
|
|
|
|
|
|
|
|
|
|
## Checks, mocks and docs
|
2020-05-28 12:25:00 +00:00
|
|
|
.PHONY: check-has-go add-license change-copyright-year test bench coverage mocks lint-license lint-golang lint updates doc
|
2020-04-08 10:59:16 +00:00
|
|
|
check-has-go:
|
|
|
|
@which go || (echo "Install Go-lang!" && exit 1)
|
|
|
|
|
2020-05-28 12:25:00 +00:00
|
|
|
add-license:
|
|
|
|
./utils/missing_license.sh add
|
|
|
|
|
|
|
|
change-copyright-year:
|
|
|
|
./utils/missing_license.sh change-year
|
2020-04-08 10:59:16 +00:00
|
|
|
|
|
|
|
test: gofiles
|
|
|
|
@# Listing packages manually to not run Qt folder (which needs to run qtsetup first) and integration tests.
|
|
|
|
go test -coverprofile=/tmp/coverage.out -run=${TESTRUN} \
|
|
|
|
./internal/api/... \
|
|
|
|
./internal/bridge/... \
|
|
|
|
./internal/events/... \
|
|
|
|
./internal/frontend/autoconfig/... \
|
|
|
|
./internal/frontend/cli/... \
|
|
|
|
./internal/imap/... \
|
2020-05-21 12:37:15 +00:00
|
|
|
./internal/metrics/... \
|
2020-04-08 10:59:16 +00:00
|
|
|
./internal/preferences/... \
|
|
|
|
./internal/smtp/... \
|
|
|
|
./internal/store/... \
|
2020-05-21 12:37:15 +00:00
|
|
|
./internal/users/... \
|
2020-04-08 10:59:16 +00:00
|
|
|
./pkg/...
|
|
|
|
|
|
|
|
bench:
|
|
|
|
go test -run '^$$' -bench=. -memprofile bench_mem.pprof -cpuprofile bench_cpu.pprof ./internal/store
|
|
|
|
go tool pprof -png -output bench_mem.png bench_mem.pprof
|
|
|
|
go tool pprof -png -output bench_cpu.png bench_cpu.pprof
|
|
|
|
|
|
|
|
coverage: test
|
|
|
|
go tool cover -html=/tmp/coverage.out -o=coverage.html
|
|
|
|
|
|
|
|
mocks:
|
2020-05-25 13:34:18 +00:00
|
|
|
mockgen --package mocks github.com/ProtonMail/proton-bridge/internal/users Configer,PanicHandler,ClientManager,CredentialsStorer,StoreMaker > internal/users/mocks/mocks.go
|
2020-04-07 07:55:28 +00:00
|
|
|
mockgen --package mocks github.com/ProtonMail/proton-bridge/internal/store PanicHandler,ClientManager,BridgeUser > internal/store/mocks/mocks.go
|
2020-04-08 10:59:16 +00:00
|
|
|
mockgen --package mocks github.com/ProtonMail/proton-bridge/pkg/listener Listener > internal/store/mocks/utils_mocks.go
|
2020-04-06 14:02:37 +00:00
|
|
|
mockgen --package mocks github.com/ProtonMail/proton-bridge/pkg/pmapi Client > pkg/pmapi/mocks/mocks.go
|
2020-04-08 10:59:16 +00:00
|
|
|
|
2020-05-28 12:25:00 +00:00
|
|
|
lint: lint-golang lint-license
|
|
|
|
|
|
|
|
lint-license:
|
|
|
|
./utils/missing_license.sh check
|
|
|
|
|
|
|
|
lint-golang:
|
2020-04-08 10:59:16 +00:00
|
|
|
which golangci-lint || $(MAKE) install-linter
|
|
|
|
golangci-lint run ./...
|
|
|
|
|
|
|
|
updates: install-go-mod-outdated
|
|
|
|
# Uncomment the "-ci" to fail the job if something can be updated.
|
|
|
|
go list -u -m -json all | go-mod-outdated -update -direct #-ci
|
|
|
|
|
|
|
|
doc:
|
|
|
|
godoc -http=:6060
|
|
|
|
|
|
|
|
.PHONY: gofiles
|
|
|
|
# Following files are for the whole app so it makes sense to have them in bridge package.
|
|
|
|
# (Options like cmd or internal were considered and bridge package is the best place for them.)
|
|
|
|
gofiles: ./internal/bridge/credits.go ./internal/bridge/release_notes.go
|
|
|
|
./internal/bridge/credits.go: ./utils/credits.sh go.mod
|
|
|
|
cd ./utils/ && ./credits.sh
|
|
|
|
./internal/bridge/release_notes.go: ./utils/release-notes.sh ./release-notes/notes.txt ./release-notes/bugs.txt
|
|
|
|
cd ./utils/ && ./release-notes.sh
|
|
|
|
|
|
|
|
|
|
|
|
## Run and debug
|
|
|
|
.PHONY: run run-qt run-qt-cli run-nogui run-nogui-cli run-debug qmlpreview qt-fronted-clean clean
|
|
|
|
VERBOSITY?=debug-client
|
|
|
|
RUN_FLAGS:=-m -l=${VERBOSITY}
|
|
|
|
|
|
|
|
run: run-nogui-cli
|
|
|
|
|
|
|
|
run-qt: ${EXE_TARGET}
|
|
|
|
PROTONMAIL_ENV=dev ./$< ${RUN_FLAGS} | tee last.log
|
|
|
|
run-qt-cli: ${EXE_TARGET}
|
|
|
|
PROTONMAIL_ENV=dev ./$< ${RUN_FLAGS} -c
|
|
|
|
|
|
|
|
run-nogui: clean-vendor gofiles
|
|
|
|
PROTONMAIL_ENV=dev go run ${BUILD_FLAGS_NOGUI} cmd/Desktop-Bridge/main.go ${RUN_FLAGS} | tee last.log
|
|
|
|
run-nogui-cli: clean-vendor gofiles
|
|
|
|
PROTONMAIL_ENV=dev go run ${BUILD_FLAGS_NOGUI} cmd/Desktop-Bridge/main.go ${RUN_FLAGS} -c
|
|
|
|
|
|
|
|
run-debug:
|
|
|
|
PROTONMAIL_ENV=dev dlv debug --build-flags "${BUILD_FLAGS_NOGUI}" cmd/Desktop-Bridge/main.go -- ${RUN_FLAGS}
|
|
|
|
|
|
|
|
run-qml-preview:
|
|
|
|
make -C internal/frontend/qt -f Makefile.local qmlpreview
|
|
|
|
|
|
|
|
clean-frontend-qt:
|
|
|
|
make -C internal/frontend/qt -f Makefile.local clean
|
|
|
|
|
|
|
|
clean-vendor: clean-frontend-qt
|
|
|
|
rm -rf ./vendor
|
|
|
|
|
|
|
|
clean: clean-frontend-qt
|
|
|
|
rm -rf vendor-cache
|
|
|
|
rm -rf cmd/Desktop-Bridge/deploy
|
|
|
|
rm -f build last.log mem.pprof
|
2020-05-18 06:18:34 +00:00
|
|
|
rm -rf logo.ico icon.rc icon_windows.syso internal/frontend/qt/icon_windows.syso
|