forked from opensearch-project/opensearch-benchmark
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
126 lines (102 loc) · 4.81 KB
/
Makefile
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
SHELL = /bin/bash
# We assume an active virtualenv for development
PYENV_REGEX = .pyenv/shims
PY_BIN = python3
# https://github.com/pypa/pip/issues/5599
PIP_WRAPPER = $(PY_BIN) -m pip
export PY38 = $(shell jq -r '.python_versions.PY38' .ci/variables.json)
export PY39 = $(shell jq -r '.python_versions.PY39' .ci/variables.json)
VENV_NAME ?= .venv
VENV_ACTIVATE_FILE = $(VENV_NAME)/bin/activate
VENV_ACTIVATE = . $(VENV_ACTIVATE_FILE)
VEPYTHON = $(VENV_NAME)/bin/$(PY_BIN)
VEPYLINT = $(VENV_NAME)/bin/pylint
PYENV_ERROR = "\033[0;31mIMPORTANT\033[0m: Please install pyenv.\n"
PYENV_PREREQ_HELP = "\033[0;31mIMPORTANT\033[0m: If you haven't already, please add \033[0;31meval \"\$$(pyenv init -)\"\033[0m to your bash profile and restart your terminal before proceeding any further.\n"
VE_MISSING_HELP = "\033[0;31mIMPORTANT\033[0m: Couldn't find $(PWD)/$(VENV_NAME); have you executed make venv-create?\033[0m\n"
prereq:
pyenv install --skip-existing $(PY38)
pyenv install --skip-existing $(PY39)
pyenv local $(PY38)
@# Ensure all Python versions are registered for this project
@ jq -r '.python_versions | [.[] | tostring] | join("\n")' .ci/variables.json > .python-version
-@ printf $(PYENV_PREREQ_HELP)
venv-create:
@if [[ ! -x $$(command -v pyenv) ]]; then \
printf $(PYENV_ERROR); \
exit 1; \
fi;
@if [[ ! -f $(VENV_ACTIVATE_FILE) ]]; then \
eval "$$(pyenv init -)" && eval "$$(pyenv init --path)" && $(PY_BIN) -mvenv $(VENV_NAME); \
printf "Created python3 venv under $(PWD)/$(VENV_NAME).\n"; \
fi;
check-venv:
@if [[ ! -f $(VENV_ACTIVATE_FILE) ]]; then \
printf $(VE_MISSING_HELP); \
fi
install-user: venv-create
. $(VENV_ACTIVATE_FILE); $(PIP_WRAPPER) install --upgrade pip setuptools wheel
. $(VENV_ACTIVATE_FILE); $(PIP_WRAPPER) install -e .
install: install-user
# Also install development dependencies
. $(VENV_ACTIVATE_FILE); $(PIP_WRAPPER) install -e .[develop]
clean: nondocs-clean docs-clean
nondocs-clean:
rm -rf .benchmarks .eggs .tox .benchmark_it .cache build dist osbenchmark.egg-info logs junit-py*.xml NOTICE.txt
docs-clean:
cd docs && $(MAKE) clean
# Avoid conflicts between .pyc/pycache related files created by local Python interpreters and other interpreters in Docker
python-caches-clean:
-@find . -name "__pycache__" -exec rm -rf -- \{\} \;
-@find . -name ".pyc" -exec rm -rf -- \{\} \;
# Force recreation of the virtual environment used by tox.
#
# See https://github.com/opensearch-project/OpenSearch-Benchmark/blob/main/DEVELOPER_GUIDE.md:
#
# > Note pip will not update project dependencies (specified either in the install_requires or the extras
# > section of the setup.py) if any version already exists in the virtual environment; therefore we recommend
# > to recreate your environments whenever your project dependencies change.
tox-env-clean:
rm -rf .tox
lint: check-venv
@find osbenchmark benchmarks scripts tests it -name "*.py" -exec $(VEPYLINT) -j0 -rn --load-plugins pylint_quotes --rcfile=$(CURDIR)/.pylintrc \{\} +
docs: check-venv
@. $(VENV_ACTIVATE_FILE); cd docs && $(MAKE) html
serve-docs: check-venv
@. $(VENV_ACTIVATE_FILE); cd docs && $(MAKE) serve
test: check-venv
. $(VENV_ACTIVATE_FILE); pytest tests/
precommit: lint
it: check-venv python-caches-clean tox-env-clean
. $(VENV_ACTIVATE_FILE); tox
it38: check-venv python-caches-clean tox-env-clean
. $(VENV_ACTIVATE_FILE); tox -e py38
it39: check-venv python-caches-clean tox-env-clean
. $(VENV_ACTIVATE_FILE); tox -e py39
benchmark: check-venv
. $(VENV_ACTIVATE_FILE); pytest benchmarks/
coverage: check-venv
. $(VENV_ACTIVATE_FILE); coverage run setup.py test
. $(VENV_ACTIVATE_FILE); coverage html
release-checks: check-venv
. $(VENV_ACTIVATE_FILE); ./release-checks.sh $(release_version) $(next_version)
# usage: e.g. make release release_version=0.9.2 next_version=0.9.3
release: check-venv release-checks clean docs it
. $(VENV_ACTIVATE_FILE); ./release.sh $(release_version) $(next_version)
.PHONY: install clean nondocs-clean docs-clean python-caches-clean tox-env-clean docs serve-docs test it it38 benchmark coverage release release-checks prereq venv-create check-env