template-esp32/Makefile at master · cachuperia/template-esp32 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
SHELL := /bin/bash
# https://www.gushiciku.cn/pl/p6TH
.SHELLFLAGS := -eu -o pipefail -c
.ONESHELL:
MAKEFLAGS += --warn-undefined-variables
MAKEFLAGS += --no-builtin-rules

VERSION := 0.1.0
ROOT := $(shell pwd)
PACKAGE_PATH := ${ROOT}/src/freenove_esp32
PYTHON_VERSION := $(shell cat .python-version)

.DEFAULT_GOAL := help
##@ Bootstrap
.PHONY: init-repo init-env bootstrap init

init-repo:  ## Configure git repository
	pre-commit install -t pre-commit -t commit-msg

init-env: clean  ## Initialize local environment
	poetry env use ${PYTHON_VERSION}
	cat .test.env > .env
	echo "dotenv" > .envrc
	cat src/cfg_template.py > src/freenove_esp32/chip/helpers/cfg.py
	@echo "Path to configuration file - src/freenove_esp32/chip/cfg.py"

bootstrap:  ## Install/update locally required modules and tools
	poetry install
	git add poetry.lock

init: init-repo init-env bootstrap  ## All repo init steps at once

##@ ESP32
.PHONY: connect download erase write-python esp-init

download:  ## Download MicroPython
	mkdir -p "downloads"
	wget -c ${MICROPYTHON_BINARY} -O downloads/${MICROPYTHON_VERSION}.bin

erase:  ## Erase flash
	esptool.py --chip esp32 --port "${ESP32_PORT}" erase_flash

find-ports:  ## Search for serial ports
	lsusb | grep -w USB-Serial
	poetry run python -m serial.tools.list_ports -v

write-python:  ## Write MicroPython to the chip
	esptool.py --chip esp32 --port "${ESP32_PORT}" --baud 460800 write_flash -z 0x1000 downloads/${MICROPYTHON_VERSION}.bin
	sleep 5  # wait for hard reset

write-code:  ## Write src/freenove_esp32/chip content to the chip
	cd src/freenove_esp32/chip && poetry run mpremote cp -r . :

get-logs:  ## Copy logfile to the local fs
	mpremote cp :logging.log ./logging.log

esp32-init: download erase write-python write-code  ## All init steps for ESP32 at once

##@ Checks
.PHONY: check

check:  ## Run pre-commit against all files
	pre-commit run --all-files

##@ Tests
.PHONY: test

test:  ## Run tests
	PYTHONPATH=${PACKAGE_PATH} poetry run pytest --cov-config=.coveragerc --cov=src 2>&1 | tee pytest-coverage.txt

test-integration: ## Run integration tests
	PYTHONPATH=${PACKAGE_PATH} poetry run pytest --runintegration

##@ Miscellaneous
.PHONY: secrets-baseline-create secrets-baseline-audit secrets-update

secrets-baseline-create:  ## Create/update .secrets.baseline file
	poetry run detect-secrets scan --baseline .secrets.baseline

secrets-baseline-audit:  ## Check updated .secrets.baseline file
	poetry run detect-secrets audit .secrets.baseline
	git commit .secrets.baseline --no-verify -m "build(security): update secrets.baseline"

secrets-update: secrets-baseline-create secrets-baseline-audit  ## Update secrets

refresh-lock:  ## Refresh the poetry.lock file without packages updates
	poetry lock --no-update

clean:  ## Clean local environment
	rm -rf .coverage .mypy_cache .pytest_cache .venv poetry.lock

##@ Helpers
.PHONY: help

help:  ## Display this help
	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-24s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)