Repository navigation
Expand file tree
/
Copy pathMakefile
More file actions
294 lines (241 loc) · 11.1 KB
/
Copy pathMakefile
File metadata and controls
294 lines (241 loc) · 11.1 KB
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
VERSION := $(shell cargo metadata --no-deps --format-version 1 | jq -r '.packages[0].version')
###
### Development targets
###
all build:
cargo build
# watch for changes and rebuild
watch:
watchexec -w src -w Cargo.toml -- cargo build
build-debug-with-setuid: build
sudo cp target/debug/devlayer target/debug/devlayer-setuid
sudo chown root:root target/debug/devlayer-setuid
sudo chmod u+s target/debug/devlayer-setuid
build-coverage-binary:
CARGO_INCREMENTAL=0 RUSTFLAGS='-Cinstrument-coverage' LLVM_PROFILE_FILE="$(CURDIR)/coverage/profraw/cargo-test-%p-%m.profraw" cargo build --profile coverage --features coverage
rm -f target/coverage/devlayer-setuid
cp target/coverage/devlayer target/coverage/devlayer-setuid
sudo chown root:root target/coverage/devlayer-setuid
sudo chmod u+s target/coverage/devlayer-setuid
audit:
cargo audit
clippy lint:
cargo clippy
clippy-fix:
cargo clippy --fix --allow-dirty --allow-staged
cargo fmt
install-pre-commit-hooks:
@echo "### Installing pre-commit hooks..."
echo "make ready-for-commit-tests" > .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit
ready-for-commit-tests:
@echo "### Formatting code"
cargo fmt
@echo "### Running pre-commit checks"
cargo clippy
@echo "### Checking for debug mode in tests"
@DEBUG_MODE_COUNT=$$(grep "set_debug_mode(true)" tests/*.rs | wc -l); \
if [ $$DEBUG_MODE_COUNT -gt 0 ]; then \
echo "ERROR: Found $$DEBUG_MODE_COUNT instance(s) of set_debug_mode(true) in test files."; \
echo "Debug mode should not be enabled in committed tests."; \
grep "set_debug_mode(true)" tests/*.rs; \
exit 1; \
fi
@if [ -f /usr/bin/npx ]; then \
echo "### Checking spelling"; \
npx cspell-cli --gitignore . \
else \
echo "### npx not found, skipping spelling check"; \
fi
clean-bad-mounts:
devlayer stop --all
mount | grep 'overlay on ' | grep 'devlayer' | awk '{print $$3}' | xargs -I{} sudo umount {}
clean:
sudo chown -R $(USER) .
cargo clean
rm -Rf --one-file-system coverage dist build generated-test-data
sudo rm -f default*.profraw
clean-coverage-layers:
devlayer stop 'devlayer-coverage-test-*'
sudo rm --one-file-system -Rf ~/.devlayer/devlayer-coverage-test-*
###
### Testing
###
test: build-coverage-binary
# Note: This excludes tests marked with #[ignore] (like stop --all tests)
sudo rm --one-file-system -Rf coverage
mkdir -p coverage/profraw
sudo mkdir -p /run/media/devlayer-coverage-testing
RUST_BACKTRACE=1 CARGO_INCREMENTAL=0 RUSTFLAGS='-Cinstrument-coverage' LLVM_PROFILE_FILE="$(CURDIR)/coverage/profraw/cargo-test-%p-%m.profraw" cargo test --profile coverage --features coverage -- --test-threads=1
coverage coverage-report: test update-coverage-report-and-show-json
update-coverage-report-and-show-json:
make update-coverage-report
cat coverage/html/coverage.json | jq
# We usually ignore the tests that conflict with external layers, namely `stop --all`. However
test-with-stop-all: build-coverage-binary
@echo "### Running all tests including --ignored tests"
sudo rm --one-file-system -Rf coverage
mkdir -p coverage/profraw
RUST_BACKTRACE=1 CARGO_INCREMENTAL=0 RUSTFLAGS='-Cinstrument-coverage' LLVM_PROFILE_FILE="$(CURDIR)/coverage/profraw/cargo-test-%p-%m.profraw" cargo test --profile coverage --features coverage -- --test-threads=1
RUST_BACKTRACE=1 CARGO_INCREMENTAL=0 RUSTFLAGS='-Cinstrument-coverage' LLVM_PROFILE_FILE="$(CURDIR)/coverage/profraw/cargo-test-%p-%m.profraw" cargo test --profile coverage --features coverage -- --test-threads=1 --ignored
coverage-with-stop-all: test-with-stop-all update-coverage-report-and-show-json
# NOTE: The full tests do their own coverage report generation in the vm-testing/80-generate-coverage-reports.sh script
update-coverage-report:
@BULMA_VERSION=1.0.2 grcov . --binary-path ./target/coverage/ -s . --llvm -t html --branch --ignore-not-existing --ignore "vendor/*" --ignore "tests/*" --ignore "src/config/structs.rs" --ignore "src/config/cli.rs" --ignore "target/*" -o coverage/
@find coverage/html -type f -name "*.html" -exec sed -i 's/bulma@0.9.1/bulma@1.0.3/g' {} \;
@find coverage/html -type f -name "*.html" -exec sed -i 's/<\/head>/<style> :root { --bulma-text: #c6c6c6; --bulma-white-l: 20%; --bulma-success-l: 23%; --bulma-success-90-l: 33%; --bulma-danger-l: 23%; --bulma-danger-s: 50%; --bulma-danger-90-l: 33%; } <\/style><\/head>/g' {} \;
@echo "Coverage report generated at file://`pwd`/coverage/html/index.html"
@echo "Coverage percentage: `jq '.message' coverage/html/coverage.json`"
# Perform only some named tests by doing something like `TEST=test_twisted make quick-test`
TEST ?= test_accept
quick-test: build-coverage-binary
# test_accept
RUST_BACKTRACE=1 CARGO_INCREMENTAL=0 RUSTFLAGS='-Cinstrument-coverage' LLVM_PROFILE_FILE="$(CURDIR)/coverage/profraw/cargo-test-%p-%m.profraw" cargo test --profile coverage --features coverage -- --test-threads=1 \
$(TEST)
make update-coverage-report
coverage/html/coverage.json: update-coverage-report
coverage-check: coverage/html/coverage.json
if jq -e '.message' coverage/html/coverage.json | grep -q 100; then \
echo "Coverage is 100%"; \
else \
echo "Coverage is less than 100%"; \
exit 1; \
fi
# Full test requires that the host has been setup for vm testing. This can be
# done with the vm-testing/01-setup-host-for-vm-testing.sh script
full-test: prepared-coverage-vm
cd vm-testing \
&& ./30-build-image-and-start.sh \
&& ./42-test-different-relative-paths.sh \
&& ./45-test-different-filesystems.sh \
&& ./50-start-package-testing-vms.sh \
&& ./51-run-package-testing.sh \
&& ./80-generate-coverage-reports.sh \
&& ./99-cleanup.sh
prepared-coverage-vm: vm-testing/images/coverage-prepared.qcow2
vm-testing/images/coverage-prepared.qcow2: vm-testing/20-prepare-vm-images.sh
cd vm-testing \
&& ./20-prepare-vm-images.sh
install-cov-tools:
#cargo install cargo-llvm-cov
cargo install grcov
###
### Release targets
###
# Build all release binaries
build-release:
cargo build --release
cargo build --release --target x86_64-unknown-linux-musl
cargo build --release --target aarch64-unknown-linux-musl
cargo build --release --target x86_64-unknown-linux-gnu
cargo build --release --target aarch64-unknown-linux-gnu
sudo bash -c ' \
chown root:root target/release/devlayer && \
chmod u+s target/release/devlayer && \
chown root:root target/aarch64-unknown-linux-musl/release/devlayer && \
chmod u+s target/aarch64-unknown-linux-musl/release/devlayer && \
chown root:root target/x86_64-unknown-linux-musl/release/devlayer && \
chmod u+s target/x86_64-unknown-linux-musl/release/devlayer && \
chown root:root target/aarch64-unknown-linux-gnu/release/devlayer && \
chmod u+s target/aarch64-unknown-linux-gnu/release/devlayer && \
chown root:root target/x86_64-unknown-linux-gnu/release/devlayer && \
chmod u+s target/x86_64-unknown-linux-gnu/release/devlayer'
build-for-profiling:
cargo build --profile profiler
# Man page
build/devlayer.1: README.adoc Cargo.toml
mkdir -p build
cat README.adoc \
| sed "s/:mansource:.*/:mansource: $(VERSION)/" \
| asciidoctor -b manpage - -o build/devlayer.1
man build/devlayer.1.gz: build/devlayer.1
gzip -9 < $< > build/devlayer.1.gz
# Shell completion scripts
completion-scripts: build
mkdir -p build
COMPLETE=bash ./target/debug/devlayer | sed 's|/.*/devlayer|devlayer|g' > build/devlayer-bash-completion
COMPLETE=zsh ./target/debug/devlayer | sed 's|/.*/devlayer|devlayer|g' > build/devlayer-zsh-completion
COMPLETE=fish ./target/debug/devlayer | sed 's|/.*/devlayer|devlayer|g' > build/devlayer-fish-completion
# Packaging
COMMON_FPM_FILES=\
build/devlayer.1.gz=/usr/share/man/man1/devlayer.1.gz \
build/devlayer-bash-completion=/usr/share/bash-completion/completions/devlayer \
build/devlayer-fish-completion=/usr/share/fish/vendor_completions.d/devlayer.fish
package: build/devlayer.1.gz build-release completion-scripts
rm -Rf dist
mkdir -p dist
@echo "### Copying raw files to dist"
tar -czvf dist/devlayer-static-$(VERSION)-x86_64.tar.gz target/x86_64-unknown-linux-musl/release/devlayer
tar -czvf dist/devlayer-static-$(VERSION)-arm64.tar.gz target/aarch64-unknown-linux-musl/release/devlayer
@echo "### Building static x86_64 targets"
fpm \
-t deb \
--fpm-options-file packaging/common-fpm-options \
--version $(VERSION) \
--architecture x86_64 \
--package dist/devlayer_$(VERSION)_amd64.deb \
target/x86_64-unknown-linux-musl/release/devlayer=/usr/bin/devlayer \
build/devlayer-zsh-completion=/usr/share/zsh/vendor-completions/_devlayer \
$(COMMON_FPM_FILES)
fpm \
-t rpm \
--fpm-options-file packaging/common-fpm-options \
--version $(VERSION) \
--architecture x86_64 \
--package dist/devlayer.$(VERSION)-1.x86_64.rpm \
target/x86_64-unknown-linux-musl/release/devlayer=/usr/bin/devlayer \
build/devlayer-zsh-completion=/usr/share/zsh/site-functions/_devlayer \
$(COMMON_FPM_FILES)
@echo "### Building static arm64 targets"
fpm \
-t deb \
--fpm-options-file packaging/common-fpm-options \
--version $(VERSION) \
--architecture arm64 \
--package dist/devlayer_$(VERSION)_arm64.deb \
target/aarch64-unknown-linux-musl/release/devlayer=/usr/bin/devlayer \
build/devlayer-zsh-completion=/usr/share/zsh/vendor-completions/_devlayer \
$(COMMON_FPM_FILES)
fpm \
-t rpm \
--fpm-options-file packaging/common-fpm-options \
--version $(VERSION) \
--architecture arm64 \
--package dist/devlayer.$(VERSION)-1.arm64.rpm \
target/aarch64-unknown-linux-musl/release/devlayer=/usr/bin/devlayer \
build/devlayer-zsh-completion=/usr/share/zsh/site-functions/_devlayer \
$(COMMON_FPM_FILES)
###
### Manual install / uninstall targets
###
install: build/devlayer.1.gz completion-scripts
cargo build --release
# Determine the installation directory based on the PATH
@INSTALL_DIR=$$(if echo "$$PATH" | tr ':' '\n' | grep -q "^/usr/bin$$"; then \
echo "/usr/bin"; \
elif echo "$$PATH" | tr ':' '\n' | grep -q "^/bin$$"; then \
echo "/bin"; \
else \
echo "/usr/bin"; \
fi); \
echo "Installing to $$INSTALL_DIR/devlayer"; \
sudo cp target/release/devlayer "$$INSTALL_DIR/devlayer.new"; \
sudo mv "$$INSTALL_DIR/devlayer.new" "$$INSTALL_DIR/devlayer"; \
sudo chown root:root "$$INSTALL_DIR/devlayer"; \
sudo chmod u+s "$$INSTALL_DIR/devlayer"
sudo cp build/devlayer.1.gz /usr/share/man/man1/devlayer.1.gz
sudo cp build/devlayer-bash-completion /usr/share/bash-completion/completions/devlayer
sudo cp build/devlayer-zsh-completion /usr/share/zsh/site-functions/_devlayer
sudo cp build/devlayer-fish-completion /usr/share/fish/vendor_completions.d/devlayer.fish
uninstall:
sudo rm -f /usr/bin/devlayer \
/usr/share/man/man1/devlayer.1.gz \
/usr/share/bash-completion/completions/devlayer \
/usr/share/zsh/site-functions/_devlayer \
/usr/share/fish/vendor_completions.d/devlayer.fish
.PHONY: all build watch build-coverage-binary clippy lint clippy-fix \
install-pre-commit-hooks ready-for-commit-tests clean clean-coverage-layers \
test test-ignored quick-test coverage coverage-report update-coverage-report \
full-coverage full-test update-coverage-report-and-show-json \
full-test prepared-coverage-vm install install-cov-tools uninstall \
build-release completion-scripts package man build-for-profiling