319 lines
11 KiB
Makefile
319 lines
11 KiB
Makefile
export GO111MODULE=on
|
|
|
|
# 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".
|
|
GOOS:=$(shell go env GOOS)
|
|
TARGET_CMD?=Desktop-Bridge
|
|
TARGET_OS?=${GOOS}
|
|
|
|
## Build
|
|
.PHONY: build build-nogui build-launcher versioner hasher
|
|
|
|
# Keep version hardcoded so app build works also without Git repository.
|
|
BRIDGE_APP_VERSION?=1.8.12+git
|
|
APP_VERSION:=${BRIDGE_APP_VERSION}
|
|
SRC_ICO:=logo.ico
|
|
SRC_ICNS:=Bridge.icns
|
|
SRC_SVG:=logo.svg
|
|
EXE_NAME:=proton-bridge
|
|
CONFIGNAME:=bridge
|
|
REVISION:=$(shell git rev-parse --short=10 HEAD)
|
|
BUILD_TIME:=$(shell date +%FT%T%z)
|
|
|
|
BUILD_FLAGS:=-tags='${BUILD_TAGS}'
|
|
BUILD_FLAGS_LAUNCHER:=${BUILD_FLAGS}
|
|
BUILD_FLAGS_GUI:=-tags='${BUILD_TAGS} build_qt'
|
|
GO_LDFLAGS:=$(addprefix -X github.com/ProtonMail/proton-bridge/internal/constants.,Version=${APP_VERSION} Revision=${REVISION} BuildTime=${BUILD_TIME})
|
|
ifneq "${BUILD_LDFLAGS}" ""
|
|
GO_LDFLAGS+=${BUILD_LDFLAGS}
|
|
endif
|
|
GO_LDFLAGS_LAUNCHER:=${GO_LDFLAGS}
|
|
ifeq "${TARGET_OS}" "windows"
|
|
GO_LDFLAGS_LAUNCHER+=-H=windowsgui
|
|
endif
|
|
|
|
BUILD_FLAGS+=-ldflags '${GO_LDFLAGS}'
|
|
BUILD_FLAGS_GUI+=-ldflags '${GO_LDFLAGS}'
|
|
BUILD_FLAGS_LAUNCHER+=-ldflags '${GO_LDFLAGS_LAUNCHER}'
|
|
|
|
DEPLOY_DIR:=cmd/${TARGET_CMD}/deploy
|
|
ICO_FILES:=
|
|
DIRNAME:=$(shell basename ${CURDIR})
|
|
EXE:=${EXE_NAME}
|
|
EXE_QT:=${DIRNAME}
|
|
ifeq "${TARGET_OS}" "windows"
|
|
EXE:=${EXE}.exe
|
|
EXE_QT:=${EXE_QT}.exe
|
|
RESOURCE_FILE:=resource.syso
|
|
endif
|
|
ifeq "${TARGET_OS}" "darwin"
|
|
DARWINAPP_CONTENTS:=${DEPLOY_DIR}/darwin/${EXE}.app/Contents
|
|
EXE:=${EXE}.app
|
|
EXE_QT:=${EXE_QT}.app
|
|
EXE_BINARY_DARWIN:=/Contents/MacOS/${EXE_NAME}
|
|
endif
|
|
EXE_TARGET:=${DEPLOY_DIR}/${TARGET_OS}/${EXE}
|
|
EXE_QT_TARGET:=${DEPLOY_DIR}/${TARGET_OS}/${EXE_QT}
|
|
|
|
TGZ_TARGET:=bridge_${TARGET_OS}_${REVISION}.tgz
|
|
|
|
ifdef QT_API
|
|
VENDOR_TARGET:=prepare-vendor update-qt-docs
|
|
else
|
|
VENDOR_TARGET=update-vendor
|
|
endif
|
|
|
|
build: ${TGZ_TARGET}
|
|
|
|
build-nogui: gofiles
|
|
go build ${BUILD_FLAGS} -o ${EXE_NAME} cmd/${TARGET_CMD}/main.go
|
|
|
|
ifeq "${GOOS}" "windows"
|
|
PRERESOURCECMD:=cp ./resource.syso ./cmd/launcher/resource.syso
|
|
POSTRESOURCECMD:=rm -f ./cmd/launcher/resource.syso
|
|
endif
|
|
build-launcher: ${RESOURCE_FILE}
|
|
${PRERESOURCECMD}
|
|
go build ${BUILD_FLAGS_LAUNCHER} -o launcher-${EXE} ./cmd/launcher/
|
|
${POSTRESOURCECMD}
|
|
|
|
versioner:
|
|
go build ${BUILD_FLAGS} -o versioner utils/versioner/main.go
|
|
|
|
hasher:
|
|
go build -o hasher utils/hasher/main.go
|
|
|
|
${TGZ_TARGET}: ${DEPLOY_DIR}/${TARGET_OS}
|
|
rm -f $@
|
|
cd ${DEPLOY_DIR}/${TARGET_OS} && tar czf ../../../../$@ .
|
|
|
|
${DEPLOY_DIR}/linux: ${EXE_TARGET}
|
|
cp -pf ./internal/frontend/share/icons/${SRC_SVG} ${DEPLOY_DIR}/linux/logo.svg
|
|
cp -pf ./LICENSE ${DEPLOY_DIR}/linux/
|
|
cp -pf ./Changelog.md ${DEPLOY_DIR}/linux/
|
|
cp -pf ./dist/${EXE_NAME}.desktop ${DEPLOY_DIR}/linux/
|
|
|
|
${DEPLOY_DIR}/darwin: ${EXE_TARGET}
|
|
if [ "${DIRNAME}" != "${EXE_NAME}" ]; then \
|
|
mv ${EXE_TARGET}/Contents/MacOS/{${DIRNAME},${EXE_NAME}}; \
|
|
perl -i -pe"s/>${DIRNAME}/>${EXE_NAME}/g" ${EXE_TARGET}/Contents/Info.plist; \
|
|
fi
|
|
cp ./internal/frontend/share/icons/${SRC_ICNS} ${DARWINAPP_CONTENTS}/Resources/${SRC_ICNS}
|
|
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"
|
|
./utils/remove_non_relative_links_darwin.sh "${EXE_TARGET}${EXE_BINARY_DARWIN}"
|
|
|
|
${DEPLOY_DIR}/windows: ${EXE_TARGET}
|
|
cp ./internal/frontend/share/icons/${SRC_ICO} ${DEPLOY_DIR}/windows/logo.ico
|
|
cp LICENSE ${DEPLOY_DIR}/windows/
|
|
|
|
QT_BUILD_TARGET:=build desktop
|
|
ifneq "${GOOS}" "${TARGET_OS}"
|
|
ifeq "${TARGET_OS}" "windows"
|
|
QT_BUILD_TARGET:=-docker build windows_64_shared
|
|
endif
|
|
endif
|
|
|
|
${EXE_TARGET}: check-has-go gofiles ${RESOURCE_FILE} ${VENDOR_TARGET}
|
|
rm -rf deploy ${TARGET_OS} ${DEPLOY_DIR}
|
|
cp cmd/${TARGET_CMD}/main.go .
|
|
qtdeploy ${BUILD_FLAGS_GUI} ${QT_BUILD_TARGET}
|
|
mv deploy cmd/${TARGET_CMD}
|
|
if [ "${EXE_QT_TARGET}" != "${EXE_TARGET}" ]; then mv ${EXE_QT_TARGET} ${EXE_TARGET}; fi
|
|
rm -rf ${TARGET_OS} main.go
|
|
|
|
|
|
WINDRES_YEAR:=$(shell date +%Y)
|
|
APP_VERSION_COMMA:=$(shell echo "${APP_VERSION}" | sed -e 's/[^0-9,.]*//g' -e 's/\./,/g')
|
|
resource.syso: ./internal/frontend/share/info.rc ./internal/frontend/share/icons/${SRC_ICO} .FORCE
|
|
rm -f ./*.syso
|
|
windres --target=pe-x86-64 -I ./internal/frontend/share/icons/ -D ICO_FILE=${SRC_ICO} -D EXE_NAME="${EXE_NAME}" -D FILE_VERSION="${APP_VERSION}" -D ORIGINAL_FILE_NAME="${EXE}" -D PRODUCT_VERSION="${APP_VERSION}" -D FILE_VERSION_COMMA=${APP_VERSION_COMMA} -D YEAR=${WINDRES_YEAR} -o $@ $<
|
|
|
|
## Rules for therecipe/qt
|
|
.PHONY: prepare-vendor update-vendor update-qt-docs
|
|
THERECIPE_ENV:=github.com/therecipe/env_${TARGET_OS}_amd64_513
|
|
|
|
# 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}
|
|
if [ "${TARGET_OS}" == "darwin" ]; then cp -f "./utils/QTBUG-88600/libqcocoa.dylib" "./vendor-cache/${THERECIPE_ENV}/5.13.0/clang_64/plugins/platforms/"; fi;
|
|
|
|
# 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.
|
|
LINKCMD:=ln -sf ${CURDIR}/vendor-cache/${THERECIPE_ENV} vendor/${THERECIPE_ENV}
|
|
ifeq "${GOOS}" "windows"
|
|
WINDIR:=$(subst /c/,c:\\,${CURDIR})/vendor-cache/${THERECIPE_ENV}
|
|
LINKCMD:=cmd //c 'mklink $(subst /,\,vendor\${THERECIPE_ENV} ${WINDIR})'
|
|
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}
|
|
|
|
update-qt-docs:
|
|
go get github.com/therecipe/qt/internal/binding/files/docs/$(QT_API)
|
|
|
|
## Dev dependencies
|
|
.PHONY: install-devel-tools install-linter install-go-mod-outdated install-git-hooks
|
|
LINTVER:="v1.39.0"
|
|
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
|
|
|
|
install-git-hooks:
|
|
cp utils/githooks/* .git/hooks/
|
|
chmod +x .git/hooks/*
|
|
|
|
## Checks, mocks and docs
|
|
.PHONY: check-has-go add-license change-copyright-year test bench coverage mocks lint-license lint-golang lint updates doc release-notes
|
|
check-has-go:
|
|
@which go || (echo "Install Go-lang!" && exit 1)
|
|
|
|
add-license:
|
|
./utils/missing_license.sh add
|
|
|
|
change-copyright-year:
|
|
./utils/missing_license.sh change-year
|
|
|
|
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/config/... \
|
|
./internal/constants/... \
|
|
./internal/cookies/... \
|
|
./internal/crash/... \
|
|
./internal/events/... \
|
|
./internal/frontend/cli/... \
|
|
./internal/imap/... \
|
|
./internal/locations/... \
|
|
./internal/logging/... \
|
|
./internal/metrics/... \
|
|
./internal/smtp/... \
|
|
./internal/store/... \
|
|
./internal/updater/... \
|
|
./internal/users/... \
|
|
./internal/versioner/... \
|
|
./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
|
|
|
|
integration-test-bridge:
|
|
${MAKE} -C test test-bridge
|
|
|
|
mocks:
|
|
mockgen --package mocks github.com/ProtonMail/proton-bridge/internal/users Locator,PanicHandler,CredentialsStorer,StoreMaker > internal/users/mocks/mocks.go
|
|
mockgen --package mocks github.com/ProtonMail/proton-bridge/pkg/listener Listener > internal/users/mocks/listener_mocks.go
|
|
mockgen --package mocks github.com/ProtonMail/proton-bridge/internal/store PanicHandler,BridgeUser,ChangeNotifier > internal/store/mocks/mocks.go
|
|
mockgen --package mocks github.com/ProtonMail/proton-bridge/pkg/listener Listener > internal/store/mocks/utils_mocks.go
|
|
mockgen --package mocks github.com/ProtonMail/proton-bridge/pkg/pmapi Client,Manager > pkg/pmapi/mocks/mocks.go
|
|
mockgen --package mocks github.com/ProtonMail/proton-bridge/pkg/message Fetcher > pkg/message/mocks/mocks.go
|
|
|
|
lint: gofiles lint-golang lint-license lint-changelog
|
|
|
|
lint-license:
|
|
./utils/missing_license.sh check
|
|
|
|
lint-changelog:
|
|
./utils/changelog_linter.sh Changelog.md
|
|
|
|
lint-golang:
|
|
which golangci-lint || $(MAKE) install-linter
|
|
$(info linting with GOMAXPROCS=${GOMAXPROCS})
|
|
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
|
|
|
|
release-notes: release-notes/bridge_stable.html release-notes/bridge_early.html
|
|
|
|
release-notes/%.html: release-notes/%.md
|
|
./utils/release_notes.sh $^
|
|
|
|
.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/credits.go: ./utils/credits.sh go.mod
|
|
cd ./utils/ && ./credits.sh bridge
|
|
|
|
## Run and debug
|
|
.PHONY: run run-qt run-qt-cli run-nogui run-nogui-cli run-debug run-qml-preview clean-vendor clean-frontend-qt clean-frontend-qt-common clean
|
|
|
|
LOG?=debug
|
|
LOG_IMAP?=client # client/server/all, or empty to turn it off
|
|
LOG_SMTP?=--log-smtp # empty to turn it off
|
|
RUN_FLAGS?=-m -l=${LOG} --log-imap=${LOG_IMAP} ${LOG_SMTP}
|
|
|
|
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} cmd/${TARGET_CMD}/main.go ${RUN_FLAGS} | tee last.log
|
|
run-nogui-cli: clean-vendor gofiles
|
|
PROTONMAIL_ENV=dev go run ${BUILD_FLAGS} cmd/${TARGET_CMD}/main.go ${RUN_FLAGS} -c
|
|
|
|
run-debug:
|
|
PROTONMAIL_ENV=dev dlv debug --build-flags "${BUILD_FLAGS}" cmd/${TARGET_CMD}/main.go -- ${RUN_FLAGS}
|
|
|
|
run-qml-preview:
|
|
$(MAKE) -C internal/frontend/qt -f Makefile.local qmlpreview
|
|
|
|
clean-frontend-qt:
|
|
# TODO: $(MAKE) -C internal/frontend/qt -f Makefile.local clean
|
|
clean-frontend-qt-common:
|
|
# TODO: $(MAKE) -C internal/frontend/qt-common -f Makefile.local clean
|
|
|
|
clean-vendor: clean-frontend-qt clean-frontend-qt-common
|
|
rm -rf ./vendor
|
|
|
|
clean: clean-vendor
|
|
rm -rf vendor-cache
|
|
rm -rf cmd/Desktop-Bridge/deploy
|
|
rm -rf cmd/Import-Export/deploy
|
|
rm -f build last.log mem.pprof main.go
|
|
rm -f resource.syso
|
|
rm -f release-notes/bridge.html
|
|
rm -f release-notes/import-export.html
|
|
|
|
.PHONY: generate
|
|
generate:
|
|
go generate ./...
|
|
$(MAKE) add-license
|
|
|
|
.FORCE:
|