mirror of
https://github.com/chmouel/liseur.git
synced 2026-10-19 01:11:15 +00:00
73fe94f55b
Trying a change from a clean slate meant clearing the development app's storage by hand, and the usual way of doing that is refused on some phones, which withhold the permission from the debugging shell. The new command removes the app and installs it again, which empties its storage for the same reason a fresh install starts empty, then opens it. A copy that is not there is simply installed; one that is there and cannot be removed stops the command, since installing over it would keep exactly the data the command is meant to drop. Signed-off-by: Chmouel Boudjnah <chmouel@chmouel.com>
230 lines
8.7 KiB
Makefile
230 lines
8.7 KiB
Makefile
SHELL := /bin/bash
|
|
|
|
GRADLE := ./gradlew
|
|
SDK_DIR := $(or $(ANDROID_SDK_ROOT),$(ANDROID_HOME),$(shell sed -n 's/^sdk\.dir=//p' local.properties))
|
|
ADB ?= $(if $(wildcard $(SDK_DIR)/platform-tools/adb),$(SDK_DIR)/platform-tools/adb,adb)
|
|
EMULATOR ?= $(if $(wildcard $(SDK_DIR)/emulator/emulator),$(SDK_DIR)/emulator/emulator,emulator)
|
|
SCRCPY ?= scrcpy
|
|
AVD ?= liseur_phone_api36
|
|
SERIAL ?= emulator-5554
|
|
PHONE ?= $(SERIAL)
|
|
LOCALE ?=
|
|
ADB_TARGET := -s $(SERIAL)
|
|
ADB_PHONE_TARGET := -s $(PHONE)
|
|
PACKAGE := com.chmouel.liseur
|
|
ACTIVITY := $(PACKAGE)/.MainActivity
|
|
DEBUG_APK := app/build/outputs/apk/debug/app-debug.apk
|
|
|
|
# The side-by-side build, for trying a change on a phone that already has
|
|
# the real app on it. The component name is spelled out rather than
|
|
# abbreviated to `.MainActivity`, because that shorthand is relative to
|
|
# the application id and the dev build's no longer matches the namespace
|
|
# the class lives in.
|
|
DEV_PACKAGE := $(PACKAGE).dev
|
|
DEV_ACTIVITY := $(DEV_PACKAGE)/$(PACKAGE).MainActivity
|
|
DEV_APK := app/build/outputs/apk/dev/app-dev.apk
|
|
|
|
.PHONY: help build debug release bundle test lint check verify-release-tools verify-fdroid-tags e2e clean emulator stop shutdown install run run-bg reset locale screenshots icon feature-graphic store-status dev dev-install dev-run dev-reset dev-uninstall dev-logcat dev-locale
|
|
|
|
help:
|
|
@printf '%s\n' \
|
|
'make build Build the debug APK' \
|
|
'make release Build the release APK' \
|
|
'make bundle Build the release AAB for Google Play' \
|
|
'make test Run JVM unit tests' \
|
|
'make lint Run Android Lint' \
|
|
'make check Run tests, lint, and debug build' \
|
|
'make verify-release-tools Check release tag and retention policies' \
|
|
'make verify-fdroid-tags Check the F-Droid release-tag policy' \
|
|
'make e2e Run the device scenarios in tests/' \
|
|
'make emulator Start the configured Android emulator' \
|
|
'make stop Stop the configured Android emulator' \
|
|
'make shutdown Shut down the configured Android emulator' \
|
|
'make install Build and install the debug APK' \
|
|
'make run Start the emulator, install, launch, and show it with scrcpy' \
|
|
'make run-bg Start the emulator, install, and launch without scrcpy' \
|
|
'make reset Reinstall the app, wipe its storage, and reseed a demo library' \
|
|
'make locale Show or set app locale with LOCALE=xx (e.g. fr, de, es, it, ru)' \
|
|
'make clean Remove build outputs' \
|
|
'make dev Build the side-by-side APK ($(DEV_PACKAGE))' \
|
|
'make dev-install Build and install it beside the real app' \
|
|
'make dev-run Install it and launch it' \
|
|
'make dev-reset Reinstall it from scratch, wiping its storage' \
|
|
'make dev-uninstall Remove it' \
|
|
'make dev-logcat Tail its logs' \
|
|
'make dev-locale Show or set dev app locale with LOCALE=xx' \
|
|
'make screenshots Capture the UI screenshots' \
|
|
'make icon Generate the store icon' \
|
|
'make feature-graphic Generate the store feature graphic' \
|
|
'make store-status Show what each store is publishing' \
|
|
'' \
|
|
'Variables: AVD=liseur_phone_api36 SERIAL=... LOCALE=...'
|
|
|
|
build debug:
|
|
$(GRADLE) assembleDebug
|
|
|
|
release:
|
|
$(GRADLE) assembleRelease
|
|
|
|
# Google Play only. F-Droid and the GitHub release both build the APK
|
|
# above, so this target is additive and nothing else depends on it.
|
|
bundle:
|
|
$(GRADLE) bundleRelease
|
|
|
|
test:
|
|
$(GRADLE) testDebugUnitTest
|
|
|
|
lint:
|
|
$(GRADLE) lintDebug
|
|
|
|
check: test lint build verify-release-tools
|
|
|
|
verify-release-tools: verify-fdroid-tags
|
|
hack/test-prune-prereleases
|
|
|
|
verify-fdroid-tags:
|
|
hack/test-fdroid-tags
|
|
|
|
# The device scenarios in tests/. Deliberately not part of check: they
|
|
# need a device with a debug build and a seeded library, which a CI
|
|
# checkout does not have.
|
|
e2e:
|
|
tests/run-all $(if $(SERIAL),-s $(SERIAL))
|
|
|
|
clean:
|
|
$(GRADLE) clean
|
|
|
|
emulator:
|
|
@command -v $(EMULATOR) >/dev/null || { printf 'error: emulator is not installed\n' >&2; exit 1; }
|
|
@$(EMULATOR) -list-avds | grep -Fxq '$(AVD)' || { printf 'error: AVD not found: $(AVD)\n' >&2; exit 1; }
|
|
@if $(ADB) $(ADB_TARGET) get-state >/dev/null 2>&1; then \
|
|
printf 'An emulator is already connected%s.\n' "$(if $(SERIAL), as $(SERIAL),)"; \
|
|
else \
|
|
printf 'Starting AVD %s.\n' '$(AVD)'; \
|
|
$(EMULATOR) @$(AVD) -no-window >/tmp/liseur-emulator.log 2>&1 & \
|
|
fi
|
|
|
|
stop:
|
|
@$(ADB) $(ADB_TARGET) emu kill 2>/dev/null || true
|
|
|
|
shutdown: stop
|
|
|
|
install: build
|
|
$(ADB) $(ADB_TARGET) install -r '$(DEBUG_APK)'
|
|
|
|
run-bg: emulator build
|
|
@$(ADB) $(ADB_TARGET) wait-for-device
|
|
@printf 'Waiting for Android to finish booting.\n'
|
|
@until [ "$$($(ADB) $(ADB_TARGET) shell getprop sys.boot_completed 2>/dev/null | tr -d '\r')" = 1 ]; do sleep 1; done
|
|
$(ADB) $(ADB_TARGET) install -r '$(DEBUG_APK)'
|
|
@if [ -n "$(LOCALE)" ]; then \
|
|
$(ADB) $(ADB_TARGET) shell cmd locale set-app-locales '$(PACKAGE)' --locales '$(LOCALE)'; \
|
|
fi
|
|
$(ADB) $(ADB_TARGET) shell am start -n '$(ACTIVITY)'
|
|
|
|
run: run-bg
|
|
@command -v $(SCRCPY) >/dev/null || { printf 'error: scrcpy is not installed\n' >&2; exit 1; }
|
|
$(SCRCPY) -s '$(SERIAL)'
|
|
|
|
reset: run-bg
|
|
./hack/reset-books -s $(SERIAL)
|
|
|
|
locale:
|
|
@loc='$(LOCALE)'; \
|
|
code=''; \
|
|
if [ -z "$$loc" ] && command -v gum >/dev/null 2>&1 && [ -t 0 ] && [ -t 1 ]; then \
|
|
choice=$$(gum choose --header="Choose locale for $(PACKAGE):" \
|
|
"de (Deutsch)" \
|
|
"en (English)" \
|
|
"es (Español)" \
|
|
"fr (Français)" \
|
|
"it (Italiano)" \
|
|
"ru (Русский)" \
|
|
"reset (System default)"); \
|
|
[ -n "$$choice" ] || exit 0; \
|
|
code=$$(printf '%s' "$$choice" | awk '{print $$1}'); \
|
|
if [ "$$code" = "reset" ]; then loc=""; else loc="$$code"; fi; \
|
|
fi; \
|
|
if [ -n "$$loc" ] || [ "$$code" = "reset" ]; then \
|
|
$(ADB) $(ADB_TARGET) shell cmd locale set-app-locales '$(PACKAGE)' --locales "$$loc"; \
|
|
printf 'Locale for %s set to: %s\n' '$(PACKAGE)' "$${loc:-(system default)}"; \
|
|
else \
|
|
$(ADB) $(ADB_TARGET) shell cmd locale get-app-locales '$(PACKAGE)'; \
|
|
fi
|
|
|
|
# The side-by-side build. Everything above installs over whatever carries
|
|
# the production package name, which on a phone is somebody's library; the
|
|
# targets below carry their own package name and cannot reach it. The
|
|
# device is chosen with PHONE=, which falls back to SERIAL= like
|
|
# everywhere else, and so defaults to the emulator.
|
|
dev:
|
|
$(GRADLE) assembleDev
|
|
|
|
dev-install: dev
|
|
$(ADB) $(ADB_PHONE_TARGET) install -r '$(DEV_APK)'
|
|
|
|
dev-run: dev-install
|
|
@if [ -n "$(LOCALE)" ]; then \
|
|
$(ADB) $(ADB_PHONE_TARGET) shell cmd locale set-app-locales '$(DEV_PACKAGE)' --locales '$(LOCALE)'; \
|
|
fi
|
|
$(ADB) $(ADB_PHONE_TARGET) shell am start -n '$(DEV_ACTIVITY)'
|
|
|
|
dev-uninstall:
|
|
$(ADB) $(ADB_PHONE_TARGET) uninstall '$(DEV_PACKAGE)'
|
|
|
|
dev-locale:
|
|
@loc='$(LOCALE)'; \
|
|
code=''; \
|
|
if [ -z "$$loc" ] && command -v gum >/dev/null 2>&1 && [ -t 0 ] && [ -t 1 ]; then \
|
|
choice=$$(gum choose --header="Choose locale for $(DEV_PACKAGE):" \
|
|
"de (Deutsch)" \
|
|
"en (English)" \
|
|
"es (Español)" \
|
|
"fr (Français)" \
|
|
"it (Italiano)" \
|
|
"ru (Русский)" \
|
|
"reset (System default)"); \
|
|
[ -n "$$choice" ] || exit 0; \
|
|
code=$$(printf '%s' "$$choice" | awk '{print $$1}'); \
|
|
if [ "$$code" = "reset" ]; then loc=""; else loc="$$code"; fi; \
|
|
fi; \
|
|
if [ -n "$$loc" ] || [ "$$code" = "reset" ]; then \
|
|
$(ADB) $(ADB_PHONE_TARGET) shell cmd locale set-app-locales '$(DEV_PACKAGE)' --locales "$$loc"; \
|
|
printf 'Locale for %s set to: %s\n' '$(DEV_PACKAGE)' "$${loc:-(system default)}"; \
|
|
else \
|
|
$(ADB) $(ADB_PHONE_TARGET) shell cmd locale get-app-locales '$(DEV_PACKAGE)'; \
|
|
fi
|
|
|
|
# Uninstalling is how the storage is wiped: `pm clear` needs a permission
|
|
# the adb shell does not have on every build. A package that is not there
|
|
# is nothing to remove; one that is there and refuses to go is a failure,
|
|
# since reinstalling over it would keep the data this target exists to drop.
|
|
dev-reset:
|
|
@if $(ADB) $(ADB_PHONE_TARGET) shell pm list packages '$(DEV_PACKAGE)' \
|
|
| tr -d '\r' | grep -qx 'package:$(DEV_PACKAGE)'; then \
|
|
$(ADB) $(ADB_PHONE_TARGET) uninstall '$(DEV_PACKAGE)'; \
|
|
fi
|
|
$(MAKE) dev-install
|
|
$(ADB) $(ADB_PHONE_TARGET) shell am start -n '$(DEV_ACTIVITY)'
|
|
|
|
# Filtered by pid rather than by tag: the app logs under a dozen of them,
|
|
# and the pid is the one thing that says "this build and not the other".
|
|
dev-logcat:
|
|
@pid=$$($(ADB) $(ADB_PHONE_TARGET) shell pidof '$(DEV_PACKAGE)' 2>/dev/null | tr -d '\r' | awk '{print $$1}'); \
|
|
if [ -z "$$pid" ]; then \
|
|
printf 'error: %s is not running; start it with make dev-run\n' '$(DEV_PACKAGE)' >&2; \
|
|
exit 1; \
|
|
fi; \
|
|
$(ADB) $(ADB_PHONE_TARGET) logcat --pid="$$pid"
|
|
|
|
screenshots:
|
|
./hack/screenshots
|
|
|
|
icon:
|
|
./hack/icon
|
|
|
|
feature-graphic:
|
|
./hack/feature-graphic
|
|
|
|
store-status:
|
|
./hack/store-status
|