chiark / gitweb /
jstest: Introduce Rust helper code
[otter.git] / Makefile
1 # Copyright 2020-2021 Ian Jackson and contributors to Otter
2 # SPDX-License-Identifier: AGPL-3.0-or-later
3 # There is NO WARRANTY.
4
5 # make -j8
6 # make -j8 release
7 # make -j8 shapelib
8
9 SHELL=/bin/bash
10 src=.
11
12 default: all check
13 all: debug
14 full-check: all check cargo-syntaxcheck-release shapelib doc-sphinx
15 full-check: for-deploy release
16 everything: debug doc release check bundled-sources
17
18 shapelib: templates/shapelib.html docs/html/index.html
19         @echo 'Shape library preview and docs can now be found here:'
20         @for f in $^; do echo '  file://$(PWD)/'$$f; done
21
22 MAKEFILE_DEP ?= Makefile
23 MAKEFILE_FIND_X ?=
24 # ^ set this to "x" to debug the $rsrcs rune
25
26 #---------- funky macros etc. ----------
27
28 cr = $(addprefix --,$(filter-out debug,$1))
29 rsrcs = $(shell $(foreach x,$(MAKEFILE_FIND_X),set -$x;)\
30     find -H $1 \( -name Cargo.toml -o -name Cargo.lock -o -name Cargo.lock.example -o -name \*.rs \) \! -path '*/build/*' )
31 stamp=@mkdir -p stamp; touch $@
32
33 BUNDLED_SOURCES_LIT = README.md LICENCE
34 BUNDLED_SOURCES_FILES = index.html $(BUNDLED_SOURCES_LIT)
35 BUNDLED_SOURCES_LINKS += $(BUNDLED_SOURCES_LIT) otter/
36 BUNDLED_SOURCES += $(BUNDLED_SOURCES_FILES)
37
38 #---------- programs and config variables ----------
39
40 CARGO ?= cargo
41 TARGET_DIR ?= target
42
43 USVG_OPTIONS = "--sans-serif-family=DejaVu Sans"
44
45 WASM_BINDGEN = $(TARGET_DIR)/debug/wasm-bindgen
46 WASM_BINDGEN_OPTIONS =                                          \
47         --remove-name-section --remove-producers-section        \
48         --typescript
49
50 BUNDLE_SOURCES ?= bundle-rust-sources
51
52 SPHINXBUILD   = sphinx-build
53
54 ifndef INKSCAPE_EXTENSIONS
55 INKSCAPE ?= inkscape
56 INKSCAPE_SDD_QUIETEN ?= 2>/dev/null
57 # inkscape 0.92.4: --extension-directory works, no --system-data-directory
58 # inkscape 1.0.2: --system-data-directory, no --extension-directory
59 INKSCAPE_EXTENSIONS := $(shell set -e; { sdd=$$( $(INKSCAPE) --system-data-directory $(INKSCAPE_SDD_QUIETEN) ) && echo "$$sdd/extensions"; } || $(INKSCAPE) --extension-directory )
60 endif
61 RECOLOUR_SVG ?= ./run-inkscape-extension $(INKSCAPE_EXTENSIONS)/color_replace.py
62
63 DEPLOY_ARCH=x86_64-unknown-linux-musl
64 DEPLOY_RELEASE=debug
65 DEPLOY_TARGET_DIR=$(TARGET_DIR)/$(addsuffix /,$(DEPLOY_ARCH))$(DEPLOY_RELEASE)
66 DEPLOYED_BRANCH=deployed
67 PUBLISHED_BRANCH=published
68
69 #---------- nailing-cargo ----------
70
71 ifneq (,$(wildcard ../Cargo.nail))
72
73 NAILING_CARGO = nailing-cargo
74 CARGO = $(NAILING_CARGO)
75 BUILD_SUBDIR ?= ../Build
76 TARGET_DIR = $(BUILD_SUBDIR)/$(notdir $(PWD))/target
77
78 NAILING_CARGO_JUST_RUN ?= $(NAILING_CARGO) --just-run -q ---
79 BUNDLE_SOURCES_CMD ?= $(NAILING_CARGO) --- $(BUNDLE_SOURCES)
80 USVG_CMD ?= $(NAILING_CARGO_JUST_RUN) $(USVG)
81 WASM_BINDGEN_CLI_CARGO_OPTS ?= --subcommand-props=!manifest-path
82
83 clean-nailing:
84         $(NAILING_CARGO_JUST_RUN) \
85  sh -c 'cd "$1"; find -mindepth 1 -maxdepth 1 -print0 | xargs -0r rm -rf --' \
86                 $(abspath $(BUILD_SUBDIR)/$(notdir $(PWD)))
87
88 else
89 clean-nailing:
90 endif # Cargo.nail
91
92 BUILD_SUBDIR ?= ../Build
93 BUNDLE_SOURCES_CMD ?= $(BUNDLE_SOURCES)
94 USVG_CMD ?= $(USVG)
95
96 WASM_PACKED=$(TARGET_DIR)/packed-wasm
97
98 #---------- local programs ----------
99
100 define lp
101 stamp/cargo.$2: $(call rsrcs, ! -name \*.rs)
102         $$(CARGO) build $(call cr,$3) -p $2
103         $$(stamp)
104 $1 := $(abspath $(TARGET_DIR)/$3/$4)
105 endef
106
107 $(eval $(call lp,BUNDLE_SOURCES,bundle-sources,debug,bundle-rust-sources))
108 $(eval $(call lp,USVG,usvg,release,usvg))
109
110 #---------- variables defining bits of source etc. ----------
111
112 PROGRAMS=daemon-otter otter
113
114 WASM_ASSETS := $(addprefix otter_wasm,.js _bg.wasm)
115 WASM_OUTPUTS := $(addprefix otter_wasm,.d.ts)
116
117 TS_SRCS= script
118 TS_SRC_FILES= \
119         $(addprefix templates/,$(addsuffix .ts,$(TS_SRCS))) \
120         webassembly-types/webassembly.d.ts \
121         $(WASM_PACKED)/otter_wasm.d.ts
122
123 LITFILES= LICENCE AGPLv3
124 TXTFILES= CC-BY-SA-3.0 CC-BY-SA-4.0
125
126 FILEASSETS = $(addprefix templates/, libre shapelib.html script.js \
127                         $(LITFILES) $(TXTFILES)) \
128                 $(wildcard templates/*.tera)
129
130 WASM := wasm32-unknown-unknown
131 # ^ todo: Is this still right after
132 #     Use correct ABI for wasm32 by default
133 #     https://github.com/rust-lang/rust/pull/79998
134 # ?  But maybe it doesn't matter since we're very conservative and
135 # only pass JsValue and a few strings across the WASM ABI.
136
137 #---------- toplevel aggregate targets ----------
138
139 check: stamp/cargo.debug-check at wdt jstest
140         @echo 'Tests passed.'
141
142 full-check: stamp/cargo.release-check
143 full-check: stamp/cargo.release-miri stamp/cargo.debug-miri
144
145 full-check:
146         @echo 'Full tests passed.'
147
148 doc: cargo-doc doc-sphinx examples
149
150 debug release:: %: stamp/cargo.% assets libraries extra-%
151
152 cargo: cargo-debug cargo-wasm-release
153
154 cargo-debug cargo-release cargo-check cargo-doc \
155 cargo-wasm-debug cargo-wasm-release:: \
156 cargo-%: stamp/cargo.%
157
158 EXAMPLE_BUNDLES = test-bundle big-bundle
159 EXAMPLE_BUNDLE_FILES = $(foreach f, $(EXAMPLE_BUNDLES), examples/$f.zip)
160
161 examples: $(EXAMPLE_BUNDLE_FILES)
162 .PHONY: examples
163
164 cargo-wasm: cargo-wasm-release
165
166 wasm: stamp/wasm-bindgen
167
168 assets: js stamp/wasm-bindgen $(FILEASSETS)
169
170 js: templates/script.js
171
172 extra-debug:
173 extra-release: bundled-sources
174
175 cargo-syntaxcheck: cargo-syntaxcheck-host cargo-syntaxcheck-wasm
176 cargo-syntaxcheck-host:
177         $(CARGO) check --workspace
178 cargo-syntaxcheck-wasm:
179         $(CARGO) check --target $(WASM) -p otter-wasm --release
180 cargo-syntaxcheck-release:
181         $(CARGO) check --workspace --release
182
183 #---------- cargo ----------
184
185 DR=debug release
186 CARGOES=$(foreach t, wasm-,$(addprefix $t,check $(DR)))
187
188 $(addprefix stamp/cargo.,$(DR)):: \
189 stamp/cargo.%: $(call rsrcs,. ! -path './wasm/*')
190         $(CARGO) build --workspace $(call cr,$*) -p otter -p otter-daemon -p otter-cli
191         $(NAILING_CARGO_JUST_RUN) \
192         ln -sf otter $(abspath $(TARGET_DIR))/$*/otter-ssh-proxy
193         $(stamp)
194
195 $(TARGET_DIR)/debug/%: $(call rsrcs, ! -path './wasm/*')
196         $(CARGO) build --workspace -p otter-cli
197         $(NAILING_CARGO_JUST_RUN) touch $(abspath $@)
198
199 stamp/cargo.wasm-bindgen: $(call rsrcs, ! -name \*.rs)
200         $(CARGO) $(WASM_BINDGEN_CLI_CARGO_OPTS) build --target-dir=target \
201                 --manifest-path=$(abspath wasm/Cargo.toml) -p wasm-bindgen-cli
202         $(stamp)
203
204 stamp/cargo.%-check: $(call rsrcs,.)
205         $(CARGO) test --workspace $(call cr,$*)
206         $(stamp)
207
208 stamp/cargo.%-miri: $(call rsrcs,.)
209         $(CARGO) miri test --workspace $(call cr,$*)
210         $(stamp)
211
212 stamp/cargo-at.debug: $(call rsrcs,.)
213         $(CARGO) build --workspace $(call cr,$*) -p otter-api-tests
214         $(stamp)
215
216 stamp/cargo-wdt.debug: $(call rsrcs,.)
217         $(CARGO) build --workspace $(call cr,$*) -p otter-webdriver-tests
218         $(stamp)
219
220 stamp/cargo-jstest.debug: $(call rsrcs,.)
221         $(CARGO) build --workspace $(call cr,$*) -p otter-nodejs-tests
222         $(stamp)
223
224 stamp/cargo.doc: $(call rsrcs,.)
225         set -o pipefail -e; \
226         $(CARGO) doc $(CARGO_DOC_OPTS) --workspace 2>&1 |egrep -vf .cargo-doc-suppress-errors
227         $(stamp)
228
229 $(addprefix stamp/cargo.wasm-,$(DR)):: \
230 stamp/cargo.wasm-%: $(call rsrcs, base wasm Cargo.*)
231         $(CARGO) build --target $(WASM) -p otter-wasm $(call cr,$*)
232         $(stamp)
233
234 stamp/cargo.deploy-build: $(call rsrcs,.)
235         $(CARGO) build --target $(DEPLOY_ARCH) $(call cr,$(DEPLOY_RELEASE)) -p otter -p otter-cli -p otter-daemon
236         $(NAILING_CARGO_JUST_RUN) \
237         ln -sf otter $(abspath $(TARGET_DIR)/$(DEPLOY_ARCH))/$(DEPLOY_RELEASE)/otter-ssh-proxy
238         $(stamp)
239
240 #---------- sphnix ----------
241
242 doc-sphinx:     docs/html/index.html \
243         $(foreach f, $(EXAMPLE_BUNDLES), docs/html/examples/$f.zip) \
244         $(addprefix docs/html/examples/, $(notdir $(wildcard specs/*.toml)))
245         @echo 'Documentation can now be found here:'
246         @echo '  file://$(PWD)/$<'
247
248 docs/html/index.html: docs/conf.py $(wildcard docs/*.md docs/*.rst docs/*.png)
249         $(SPHINXBUILD) -M html docs docs $(SPHINXOPTS)
250
251 docs/html/examples/%.zip: examples/%.zip
252         mkdir -p docs/html/examples
253         rm -f $@ && ln $< $@
254
255 docs/html/examples/%.toml: specs/%.toml
256         mkdir -p docs/html/examples
257         rm -f $@ && ln $< $@
258
259 #---------- jstest ----------
260
261 JSTESTS= basic lower
262
263 .PHONY: jstest
264 jstest jstests: $(foreach t,$(JSTESTS),stamp/$t.jstest)
265
266 stamp/%.jstest: jstest/run1 jstest/%.nodejs templates/script.js \
267                 stamp/wasm-bindgen-jstest stamp/cargo-jstest.debug
268         $(NAILING_CARGO_JUST_RUN) $(abspath $(filter-out stamp/%,$^))
269         $(stamp)
270
271 #---------- wasm ----------
272
273 $(addprefix $(WASM_PACKED)/,$(WASM_ASSETS) $(WASM_OUTPUTS)): stamp/wasm-bindgen
274 stamp/wasm-bindgen: stamp/cargo.wasm-bindgen stamp/cargo.wasm-release
275         $(NAILING_CARGO_JUST_RUN) $(abspath $(WASM_BINDGEN)) \
276                 $(WASM_BINDGEN_OPTIONS) --no-modules \
277                 --out-dir target/packed-wasm \
278                 target/$(WASM)/release/otter_wasm.wasm
279         $(stamp)
280
281 stamp/wasm-bindgen-jstest: stamp/cargo.wasm-bindgen stamp/cargo.wasm-release
282         $(NAILING_CARGO_JUST_RUN) $(abspath $(WASM_BINDGEN)) \
283                 $(WASM_BINDGEN_OPTIONS) --nodejs \
284                 --out-dir target/jstest \
285                 target/$(WASM)/release/otter_wasm.wasm
286         $(stamp)
287
288 #---------- bundle-sources ----------
289
290 BUNDLED_SOURCES_DIRS += otter
291
292 bundled-sources:: $(addprefix bundled-sources/, $(BUNDLED_SOURCES_DIRS))
293
294 TARGET_BUNDLED=$(TARGET_DIR)/bundled-sources
295
296 $(TARGET_BUNDLED):
297         $(NAILING_CARGO_JUST_RUN) mkdir -p $(abspath $@)
298
299 $(addprefix bundled-sources/, $(BUNDLED_SOURCES_DIRS)): \
300 bundled-sources/%: stamp/cargo.bundle-sources $(TARGET_BUNDLED)
301         set -e; d=$(abspath $(TARGET_BUNDLED)); \
302         $(if $(filter-out otter,$*), cd ../$*;) \
303         $(BUNDLE_SOURCES_CMD) --output $$d/$*
304
305 bundled-sources:: $(addprefix $(TARGET_BUNDLED)/, $(BUNDLED_SOURCES_FILES))
306
307 $(addprefix $(TARGET_BUNDLED)/, $(BUNDLED_SOURCES_LIT)): \
308 $(TARGET_BUNDLED)/%: % $(TARGET_BUNDLED)
309         $(NAILING_CARGO_JUST_RUN) cp $(abspath $(src))/$< $(abspath $@)
310
311 $(TARGET_BUNDLED)/index.html: bundled-sources-make-index \
312                 $(MAKEFILE_DEP) $(TARGET_BUNDLED)
313         $(NAILING_CARGO_JUST_RUN) sh -ec '                      \
314                 cd $(abspath $(src)); mkdir -p $(dir $@);       \
315                 ./$< >$@.tmp $(BUNDLED_SOURCES_LINKS);          \
316                 mv -f $@.tmp $@;                                \
317         '
318
319 bundled-sources::
320         @echo Bundled sources.
321
322 #---------- svg processing ----------
323
324 LIBRARIES ?= $(basename $(wildcard library/*.toml))
325 USVG_DEP = stamp/cargo.usvg
326
327 include $(addsuffix /files.make, $(LIBRARIES))
328
329 USVG_PROCESSOR = usvg-processor
330 LIBRARY_PROCESS_SVG = ./$(USVG_PROCESSOR) $@ $(wordlist 1,2,$^) '$(USVG_CMD) $(USVG_OPTIONS)'
331 $(LIBRARY_FILES): $(USVG_PROCESSOR) $(USVG_DEP) $(MAKEFILE_DEP)
332
333 # actual command for each of $(LIBRARY_FILES) is in one of the files.make
334
335 library/%/files.make: media-scraper library/%.toml
336         ./$< --offline library/$*.toml
337
338 #---------- typescript ----------
339
340 templates/%.js: tsc-wrap tsconfig.json
341         ./tsc-wrap $@ tsconfig.json $(filter %.ts,$^)
342
343 templates/script.js: $(TS_SRC_FILES) stamp/wasm-bindgen
344
345 #---------- other templates ----------
346
347 $(addprefix templates/,$(LITFILES)): templates/%: %
348         cp $< $@.new && mv -f $@.new $@
349
350 $(addprefix templates/,$(TXTFILES)): templates/%: %.txt
351         cp $< $@.new && mv -f $@.new $@
352
353 libraries: $(LIBRARY_FILES)
354
355 templates/shapelib.html: $(TARGET_DIR)/debug/otterlib $(LIBRARY_FILES)
356         $(NAILING_CARGO_JUST_RUN) $(abspath $<) \
357         --libs '$(addprefix $(PWD)/, $(addsuffix .toml, $(LIBRARIES)))' \
358                 preview >$@.tmp && mv -f $@.tmp $@
359
360 #---------- examples ----------
361
362 EXAMPLE_BUNDLE_INPUT_DEPS := $(shell                                    \
363         cd examples/test-bundle/ && find \! \( -name '*~' -o -name '.*' \) \
364 )
365
366 examples/%.zip: $(MAKEFILE_DEP)
367         set -e; rm -f $@.tmp; cd examples/$*/; \
368         zip $(ZIPFLAGS) -DX ../$(notdir $@).tmp $(ZIP_INPUTS)
369         mv -f $@.tmp $@
370
371 examples/test-bundle.zip: ZIP_INPUTS=$(EXAMPLE_BUNDLE_INPUT_DEPS)
372 examples/test-bundle.zip: \
373  $(addprefix examples/test-bundle/, $(EXAMPLE_BUNDLE_INPUT_DEPS))
374
375 examples/big-bundle.zip: examples/big-bundle/otter.toml
376 examples/big-bundle.zip: ZIPFLAGS+= -0 -r -q
377 examples/big-bundle.zip: ZIP_INPUTS=.
378 examples/big-bundle/otter.toml: $(LIBRARY_FILES) $(MAKEFILE_DEP)
379         rm -rf examples/big-bundle
380         mkdir examples/big-bundle examples/big-bundle/library
381         @set -e; echo 'MKDIR for $@'; \
382         for l in $(LIBRARIES); do \
383                 mkdir examples/big-bundle/$$l; \
384                 perl -p \
385  -e 'BEGIN { print "# -- AUTOGENERATED FROM COPY IN OTTER SOURCE --\n" }' \
386  -e 'if (m/^\[scraper]/..0) { unless (m/^\[(?!scraper)/..0) { s/^/\#/ } }' \
387  -e 's/(?<=\s)\w\S*(?=\s)/-/ if m/^files = """/..m/^"""/;' \
388                         <$$l.toml >examples/big-bundle/$$l.toml; done
389         @set -e; echo 'LN for $@'; \
390         for e in $(LIBRARY_FILE_INPUTS); do \
391                 ln $${e#*:} examples/big-bundle/$${e%%.usvg:*}.svg; done;
392         @set -e; echo 'MV for $@'; \
393         cd examples/big-bundle/library/; for x in '' .toml; do \
394                 mv wikimedia$$x duped-example$$x; done
395         @set -e; mkdir examples/big-bundle/specs/; \
396         perl -pe <specs/demo.game.toml \
397                 >examples/big-bundle/specs/Modded-spec.game.toml \
398                 's/chess-b-/chess-purple-/; s/chess-w-/chess-yellow-/'
399         @set -e; echo 'ECHO for $@'; \
400         echo 'title = "Autogenerated test bundle - do not distribute"' \
401                 >$@.tmp
402         mv -f $@.tmp $@
403
404 #---------- webdriver tests (wdt) ----------
405
406 AT_TESTS := $(basename $(notdir $(wildcard apitest/at-*.rs)))
407 WDT_TESTS := $(basename $(notdir $(wildcard wdriver/wdt-*.rs)))
408
409 WDT_LANDSCAPE_TESTS = wdt-altergame
410
411 at:     $(foreach f, $(AT_TESTS), stamp/$f.check)
412
413 wdt:    $(foreach f, $(WDT_TESTS), stamp/$f.check) \
414         $(foreach f, $(WDT_LANDSCAPE_TESTS), stamp/$f.lcheck) \
415
416 RUNTEST_DEPS =  apitest/run1 stamp/cargo.debug $(FILEASSETS) \
417                 $(wildcard specs/*.toml) examples/test-bundle.zip \
418                 $(wildcard libraries/*.toml) $(LIBRARY_FILES)
419
420 AT_DEPS =       $(filter-out templates/script.js, $(RUNTEST_DEPS)) \
421                 examples/big-bundle.zip \
422                 stamp/cargo-at.debug
423
424 WDT_DEPS =      $(RUNTEST_DEPS) \
425                 stamp/cargo-wdt.debug
426
427 AT_WDT_RUN = $(NAILING_CARGO_JUST_RUN) $(abspath $<)
428
429 AT_RUN = $(AT_WDT_RUN) apitest --test=$(basename $(notdir $@))
430 WDT_RUN = $(AT_WDT_RUN) wdriver --test=$(basename $(notdir $@))
431
432 for-at:                 $(AT_DEPS)
433 stamp/at-%.check:       $(AT_DEPS)
434         $(AT_RUN)
435         $(stamp)
436
437 for-wdt:                $(WDT_DEPS)
438 stamp/wdt-%.check:      $(WDT_DEPS)
439         $(WDT_RUN)
440         $(stamp)
441
442 stamp/wdt-%.lcheck:     $(WDT_DEPS)
443         $(WDT_RUN) --as-if=lwdt-$* --layout=Landscape
444         $(stamp)
445
446 #---------- docs publication ----------
447
448 PUBLISH_USER=ianmdlvl@login.chiark.greenend.org.uk
449 PUBLISH_DOC_SPHINX=$(PUBLISH_USER):public-html/otter/docs
450
451 publish: doc-sphinx
452         rsync -r --delete-delay docs/html/. $(PUBLISH_DOC_SPHINX)/.
453         git branch -f $(PUBLISHED_BRANCH)
454
455 #---------- deployment ----------
456
457 DEPLOY_USER=ian@login.chiark.greenend.org.uk
458 DEPLOY_BASE=$(DEPLOY_USER):/volatile/Otter
459 DEPLOY_FINISH=/home/Otter/etc/deploy-finish
460
461 for-deploy: stamp/cargo.deploy-build
462 deploy: for-deploy bundled-sources assets libraries
463         rsync -zvl --progress $(addprefix $(DEPLOY_TARGET_DIR)/,$(PROGRAMS) otter-ssh-proxy) $(DEPLOY_BASE)/bin/
464         rsync -zv --progress $(TARGET_DIR)/release/usvg $(DEPLOY_BASE)/libexec/
465         rsync -rv --progress $(TARGET_DIR)/bundled-sources/. $(DEPLOY_BASE)/bundled-sources
466         rsync -r README.md $(DEPLOY_BASE)/.
467         rsync -r --delete --exclude=\*~ library specs $(DEPLOY_BASE)/.
468         rsync -r $(FILEASSETS) $(addprefix $(WASM_PACKED)/, $(WASM_ASSETS)) \
469                 $(DEPLOY_BASE)/assets/
470         rsync -r nwtemplates/*.tera $(DEPLOY_BASE)/nwtemplates/
471         ssh -o BatchMode=true $(DEPLOY_USER) $(DEPLOY_FINISH)
472         git branch -f $(DEPLOYED_BRANCH)
473         -git push origin main
474         -git push chiark main
475
476 #$(DEPLOY_BASE)/bundled-sources
477
478 #---------- clean ----------
479
480 clean-for-retest:
481         rm -f templates/script.js library/*/*.usvg stamp/*
482         rm -rf $(LIBRARY_CLEAN)
483         rm -rf examples/big-bundle examples/big-bundle.zip
484         rm -f examples/test-bundle.zip
485         find * \( -name '*~' -o -name '*.tmp' \) -print0 | xargs -0r rm --
486
487 clean: clean-nailing clean-for-retest
488         rm -rf target
489         $(NAILING_CARGO_JUST_RUN) rm -rf target