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