glances/Makefile

207 lines
9.4 KiB
Makefile
Raw Normal View History

2018-12-27 12:10:26 +03:00
PORT?=8008
2021-06-12 10:42:02 +03:00
LASTTAG = $(shell git describe --tags --abbrev=0)
2018-12-27 12:10:26 +03:00
2022-07-06 00:34:58 +03:00
# if the command is only `make`, the default tasks will be the printing of the help.
.DEFAULT_GOAL := help
.PHONY: help
help: ## List all make commands available
@grep -E '^[\.a-zA-Z_%-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk -F ":" '{print $1}' | grep -v % | sed 's/\\//g' | sort | awk 'BEGIN {FS = ":[^:]*?##"}; {printf "\033[1;34mmake %-50s\033[0m %s\n", $$1, $$2}'
2022-07-09 10:03:39 +03:00
install: ## Open a Web Browser to the installation procedure
2018-12-27 12:10:26 +03:00
sensible-browser "https://github.com/nicolargo/glances#installation"
2022-07-09 10:03:39 +03:00
venv-python: ## Install Python 3 venv
2021-05-29 19:48:27 +03:00
virtualenv -p /usr/bin/python3 venv
2018-12-27 12:10:26 +03:00
2022-08-20 10:00:19 +03:00
venv-dev: venv-python ## Install Python 3 dev dependencies
2021-05-29 19:48:27 +03:00
./venv/bin/pip install -r dev-requirements.txt
./venv/bin/pip install -r doc-requirements.txt
2018-12-27 12:10:26 +03:00
2022-09-09 11:20:38 +03:00
venv-dev-upgrade: ## Upgrade Python 3 dev dependencies
./venv/bin/pip install --upgrade pip
2021-05-29 19:48:27 +03:00
./venv/bin/pip install --upgrade -r dev-requirements.txt
./venv/bin/pip install --upgrade -r doc-requirements.txt
2021-04-11 11:39:30 +03:00
2022-08-20 10:00:19 +03:00
venv: venv-python ## Install Python 3 run-time dependencies
./venv/bin/pip install -r requirements.txt
./venv/bin/pip install -r optional-requirements.txt
2022-09-09 11:20:38 +03:00
venv-upgrade: ## Upgrade Python 3 run-time dependencies
./venv/bin/pip install --upgrade -r requirements.txt
./venv/bin/pip install --upgrade -r optional-requirements.txt
# ===================================================================
# Tests
# ===================================================================
2022-09-09 11:20:38 +03:00
test: ## Run unit tests
./venv/bin/python ./unitest.py
./venv/bin/python ./unitest-restful.py
./venv/bin/python ./unitest-xmlrpc.py
./venv/bin/python -m black ./glances --check --exclude outputs/static
./venv/bin/pyright glances
test-with-upgrade: venv-upgrade venv-dev-upgrade ## Run unit tests
2021-06-12 10:42:02 +03:00
./venv/bin/python ./unitest.py
./venv/bin/python ./unitest-restful.py
./venv/bin/python ./unitest-xmlrpc.py
2022-03-20 11:13:02 +03:00
./venv/bin/python -m black ./glances --check --exclude outputs/static
./venv/bin/pyright glances
# ===================================================================
# Linters and profilers
# ===================================================================
2022-08-20 10:00:19 +03:00
format: venv-dev-upgrade ## Format the code
@git ls-files '*.py' | xargs ./venv/bin/python -m autopep8 --in-place --jobs 0 --global-config=.flake8
@git ls-files '*.py' | xargs ./venv/bin/python -m autoflake --in-place --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys --exclude="compat.py,globals.py"
2022-03-20 11:13:02 +03:00
./venv/bin/python -m black ./glances --exclude outputs/static
2021-05-29 19:48:27 +03:00
flake8: venv-dev-upgrade ## Run flake8 linter.
@git ls-files '*.py' | xargs ./venv/bin/python -m flake8 --config=.flake8
2023-05-01 11:12:09 +03:00
ruff: venv-dev-upgrade ## Run Ruff (fastest) linter.
./venv/bin/python -m ruff check . --config=./pyproject.toml
2022-10-16 11:43:11 +03:00
codespell: venv-dev-upgrade ## Run codespell to fix common misspellings in text files
./venv/bin/codespell -S .git,./docs/_build,./Glances.egg-info,./venv,./glances/outputs,*.svg -L hart,bu,te,statics
2023-02-04 18:08:22 +03:00
semgrep: venv-dev-upgrade ## Run semgrep to find bugs and enforce code standards
./venv/bin/semgrep --config=auto --lang python --use-git-ignore ./glances
profiling: ## How to start the profiling of the Glances software
@echo "Please complete and run: sudo ./venv/bin/py-spy record -o ./docs/_static/glances-flame.svg -d 60 -s --pid <GLANCES PID>"
trace-malloc: ## Trace the malloc() calls
@echo "Malloc test is running, please wait ~30 secondes..."
./venv/bin/python -m glances -C ./conf/glances.conf --trace-malloc --stop-after 15 --quiet
memory-leak: ## Profile memory leaks
./venv/bin/python -m glances -C ./conf/glances.conf --memory-leak
2022-11-12 19:15:44 +03:00
memory-profiling: ## Profile memory usage
@echo "It's a very long test (~4 hours)..."
rm -f mprofile_*.dat
@echo "1/2 - Start memory profiling with the history option enable"
./venv/bin/mprof run -T 1 -C run.py -C ./conf/glances.conf --stop-after 2400 --quiet
./venv/bin/mprof plot --output ./docs/_static/glances-memory-profiling-with-history.png
rm -f mprofile_*.dat
@echo "2/2 - Start memory profiling with the history option disable"
./venv/bin/mprof run -T 1 -C run.py -C ./conf/glances.conf --disable-history --stop-after 2400 --quiet
./venv/bin/mprof plot --output ./docs/_static/glances-memory-profiling-without-history.png
rm -f mprofile_*.dat
# ===================================================================
# Docs
# ===================================================================
2022-08-20 10:00:19 +03:00
docs: venv-dev-upgrade ## Create the documentation
2021-07-17 10:31:07 +03:00
./venv/bin/python -m glances -C ./conf/glances.conf --api-doc > ./docs/api.rst
cd docs && ./build.sh && cd ..
2021-05-29 19:48:27 +03:00
2022-07-09 10:03:39 +03:00
docs-server: docs ## Start a Web server to serve the documentation
2021-05-29 19:48:27 +03:00
(sleep 2 && sensible-browser "http://localhost:$(PORT)") &
cd docs/_build/html/ && ../../../venv/bin/python -m http.server $(PORT)
2021-05-29 19:48:27 +03:00
release-note: ## Generate release note
git --no-pager log $(LASTTAG)..HEAD --first-parent --pretty=format:"* %s"
@echo "\n"
git --no-pager shortlog -s -n $(LASTTAG)..HEAD
# ===================================================================
# WebUI
# ===================================================================
2022-08-20 10:00:19 +03:00
webui: venv-dev-upgrade ## Build the Web UI
2021-11-11 12:46:29 +03:00
cd glances/outputs/static/ && npm ci && npm run build
2021-05-29 19:48:27 +03:00
2022-08-20 10:00:19 +03:00
webui-audit: venv-dev-upgrade ## Audit the Web UI
2022-07-29 14:17:03 +03:00
cd glances/outputs/static/ && npm audit
2022-10-22 10:46:11 +03:00
webui-audit-fix: venv-dev-upgrade ## Fix audit the Web UI
cd glances/outputs/static/ && npm audit fix && npm ci && npm run build
# ===================================================================
# Packaging
# ===================================================================
flatpak: venv-dev-upgrade ## Generate FlatPack JSON file
git clone https://github.com/flatpak/flatpak-builder-tools.git
./venv/bin/python ./flatpak-builder-tools/pip/flatpak-pip-generator glances
rm -rf ./flatpak-builder-tools
@echo "Now follow: https://github.com/flathub/flathub/wiki/App-Submission"
2022-09-15 12:02:11 +03:00
# ===================================================================
# Docker
# ===================================================================
docker: docker-alpine docker-ubuntu## Generate local docker images
2022-10-29 11:55:59 +03:00
2022-11-19 17:51:20 +03:00
docker-alpine: ## Generate local docker images (Alpine)
2022-09-15 12:02:11 +03:00
docker build --target full -f ./docker-files/alpine.Dockerfile -t glances:local-alpine-full .
docker build --target minimal -f ./docker-files/alpine.Dockerfile -t glances:local-alpine-minimal .
docker build --target dev -f ./docker-files/alpine.Dockerfile -t glances:local-alpine-dev .
2023-01-05 08:19:42 +03:00
docker-ubuntu: ## Generate local docker images (Ubuntu)
docker build --target full -f ./docker-files/ubuntu.Dockerfile -t glances:local-ubuntu-full .
docker build --target minimal -f ./docker-files/ubuntu.Dockerfile -t glances:local-ubuntu-minimal .
docker build --target dev -f ./docker-files/ubuntu.Dockerfile -t glances:local-ubuntu-dev .
# ===================================================================
# Run
# ===================================================================
2022-07-09 10:03:39 +03:00
run: ## Start Glances in console mode (also called standalone)
./venv/bin/python -m glances -C ./conf/glances.conf
2022-07-09 10:03:39 +03:00
run-debug: ## Start Glances in debug console mode (also called standalone)
./venv/bin/python -m glances -C ./conf/glances.conf -d
run-local-conf: ## Start Glances in console mode with the system conf file
./venv/bin/python -m glances
2022-09-15 12:02:11 +03:00
run-docker-alpine-minimal: ## Start Glances Alpine Docker minimal in console mode
docker run --rm -e TZ="${TZ}" -e GLANCES_OPT="" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it glances:local-alpine-minimal
2022-09-15 12:02:11 +03:00
run-docker-alpine-full: ## Start Glances Alpine Docker full in console mode
docker run --rm -e TZ="${TZ}" -e GLANCES_OPT="" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it glances:local-alpine-full
2022-09-15 12:02:11 +03:00
run-docker-alpine-dev: ## Start Glances Alpine Docker dev in console mode
docker run --rm -e TZ="${TZ}" -e GLANCES_OPT="" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it glances:local-alpine-dev
2022-09-15 12:02:11 +03:00
2023-01-14 11:15:36 +03:00
run-docker-ubuntu-minimal: ## Start Glances Ubuntu Docker minimal in console mode
docker run --rm -e TZ="${TZ}" -e GLANCES_OPT="" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it glances:local-ubuntu-minimal
2023-01-14 11:15:36 +03:00
run-docker-ubuntu-full: ## Start Glances Ubuntu Docker full in console mode
docker run --rm -e TZ="${TZ}" -e GLANCES_OPT="" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it glances:local-ubuntu-full
2023-01-14 11:15:36 +03:00
run-docker-ubuntu-dev: ## Start Glances Ubuntu Docker dev in console mode
docker run --rm -e TZ="${TZ}" -e GLANCES_OPT="" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it glances:local-ubuntu-dev
2023-01-14 11:15:36 +03:00
2022-07-09 10:03:39 +03:00
run-webserver: ## Start Glances in Web server mode
./venv/bin/python -m glances -C ./conf/glances.conf -w
2022-07-09 10:03:39 +03:00
run-restapiserver: ## Start Glances in REST API server mode
2021-07-16 16:39:24 +03:00
./venv/bin/python -m glances -C ./conf/glances.conf -w --disable-webui
2022-07-09 10:03:39 +03:00
run-server: ## Start Glances in server mode (RPC)
./venv/bin/python -m glances -C ./conf/glances.conf -s
2022-07-09 10:03:39 +03:00
run-client: ## Start Glances in client mode (RPC)
./venv/bin/python -m glances -C ./conf/glances.conf -c localhost
2022-07-09 10:03:39 +03:00
run-browser: ## Start Glances in browser mode (RPC)
2021-06-13 11:49:01 +03:00
./venv/bin/python -m glances -C ./conf/glances.conf --browser
2023-04-29 11:01:44 +03:00
run-issue: ## Start Glances in issue mode
./venv/bin/python -m glances -C ./conf/glances.conf --issue
2022-07-09 10:03:39 +03:00
show-version: ## Show Glances version number
2021-06-13 11:49:01 +03:00
./venv/bin/python -m glances -C ./conf/glances.conf -V
2022-07-09 10:03:39 +03:00
show-issue: ## Generate output for a new issue
2021-06-13 11:49:01 +03:00
./venv/bin/python -m glances -C ./conf/glances.conf --issue
2022-05-03 09:22:43 +03:00
.PHONY: test docs docs-server venv