Project

General

Profile

1 783 aaronmk
##### Configuration
2
3 1921 aaronmk
# Command line
4 1190 aaronmk
log ?= $(if $(test),,1)
5 1257 aaronmk
profile ?=
6 1620 aaronmk
reverify ?= 1
7 1921 aaronmk
debug ?=
8
9
# Makefile
10
tablesSort ?= plots organisms stems specimens
11 1386 aaronmk
exts ?= csv tsv txt xml
12 783 aaronmk
test_n ?= 2
13
14
##### Vars/functions
15
16 640 aaronmk
selfDir_uZPPqC := $(dir $(lastword $(MAKEFILE_LIST)))
17 250 aaronmk
18 1821 aaronmk
# Paths
19
datasrc := $(notdir $(realpath .))
20
root := $(selfDir_uZPPqC)..
21
bin := $(root)/bin
22
mappings := $(root)/mappings
23
24 368 aaronmk
# Make
25 640 aaronmk
SHELL := /bin/bash
26 1509 aaronmk
selfMake = $(MAKE) --makefile=../input.Makefile
27 1821 aaronmk
subMake = $(MAKE) $(@:$(root)/%=%) --directory=$(root)
28 404 aaronmk
+_ = $(+:_%=)
29 368 aaronmk
addBeforeExt = $(basename $(2))$(1)$(suffix $(2))
30
31 1742 aaronmk
# OS
32
os := $(shell uname)
33
forOs = $(patsubst %,%-$(filter Linux Darwin,$(os)),$(1))
34
35
# Formatting
36
SED = sed -$(if $(filter Darwin,$(os)),E,r)
37
38 790 aaronmk
# System
39
date = $(shell date +"%Y-%m-%d-%H-%M-%S")
40
41 640 aaronmk
# Terminal
42 1184 aaronmk
termCols := $(shell tput cols)
43 640 aaronmk
esc := '['
44
reset := $(esc)'0m'
45
emph := $(esc)'7m '
46
endEmph := ' '$(reset)
47
48 368 aaronmk
# Commands
49 1245 aaronmk
MKDIR = mkdir -p
50
mkdir = $(MKDIR) $(@D)
51 395 aaronmk
CP = cp -p
52 1184 aaronmk
diff = diff --unified=2
53
diffVerbose = $(if $(verbose),diff --side-by-side --left-column\
54
--width=$(termCols),$(diff))
55 368 aaronmk
56 1918 aaronmk
# BIEN commands
57 1524 aaronmk
selfMap = $(bin)/cols 0 0
58 1081 aaronmk
psqlOpts := --set ON_ERROR_STOP=1 --quiet
59 1289 aaronmk
psqlAsBien := $(bin)/psql_vegbien $(psqlOpts)
60 353 aaronmk
61 1594 aaronmk
# SVN
62
addDir = $(if $(wildcard $(1)/),svn add --depth=empty $(1),svn mkdir $(1))
63 1771 aaronmk
setSvnIgnore = svn propset svn:ignore $(2) $(1)
64 1594 aaronmk
define addDirWithIgnore
65
$(addDir)
66 1771 aaronmk
$(setSvnIgnore)
67 1594 aaronmk
endef
68
69 783 aaronmk
##### General targets
70 250 aaronmk
71 418 aaronmk
all: _always maps ;
72 247 aaronmk
73 1260 aaronmk
.SUFFIXES: # turn off built-in suffix rules
74
.SECONDARY: # don't automatically delete intermediate files
75 1354 aaronmk
.DELETE_ON_ERROR: # delete target if recipe fails
76 247 aaronmk
77 383 aaronmk
_always:
78
.PHONY: _always
79 250 aaronmk
80 383 aaronmk
clean: _always
81 256 aaronmk
	$(RM) $(all)
82
83 1742 aaronmk
remake: _always clean
84
	+$(selfMake)
85
# re-run make so that cache of existing files is reset
86
87 1627 aaronmk
make_script = ./$< >$@
88 368 aaronmk
89 1604 aaronmk
%/: % _always ;
90
91 1627 aaronmk
# Must come before `%: %.make` to override it
92
src/%: src/%.make _always
93 1663 aaronmk
	(set -x; $(make_script)) 2>>$<.log
94 1627 aaronmk
.PRECIOUS: src/% # save partial outputs of aborted src make scripts
95
96
%: %.make _always
97
	$(make_script)
98
99 783 aaronmk
##### SVN
100 250 aaronmk
101 1594 aaronmk
add: _always
102 1771 aaronmk
	$(call setSvnIgnore,.,$$'')
103 1594 aaronmk
	$(call addDirWithIgnore,src,$$'*')
104
	$(call addDirWithIgnore,maps,$$'.~*')
105
	$(call addDirWithIgnore,import,$$'*')
106
	$(call addDirWithIgnore,test,$$'*.out\n*.xml')
107
	$(call addDirWithIgnore,verify,$$'*.out')
108 766 aaronmk
109 1777 aaronmk
##### Existing maps discovery
110 1776 aaronmk
111 1289 aaronmk
srcMap := maps/src.%.csv
112 1139 aaronmk
fullViaMap := maps/%.full.csv
113 1289 aaronmk
directMap := maps/VegBIEN.%.csv
114
allViaMaps := $(filter-out $(srcMap) $(fullViaMap) $(directMap),\
115 1139 aaronmk
$(wildcard maps/*.csv))
116 728 aaronmk
via := $(firstword $(sort $(basename $(basename $(notdir $(allViaMaps))))))
117 783 aaronmk
118 775 aaronmk
coreMap := $(mappings)/$(via)-VegBIEN.%.csv
119 1524 aaronmk
coreSelfMap := $(mappings)/$(via).self.%.csv
120 783 aaronmk
121 749 aaronmk
viaMaps := $(wildcard $(tablesSort:%=maps/$(via).%.csv))
122 1139 aaronmk
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard maps/$(via).*.csv))
123 783 aaronmk
124 728 aaronmk
autogenMaps := $(subst $(via).,VegBIEN.,$(viaMaps))
125
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
126
$(wildcard maps/VegBIEN.*.csv))
127 772 aaronmk
tables := $(directMaps:maps/VegBIEN.%.csv=%)
128 728 aaronmk
129 1921 aaronmk
##### Installation
130
131
install: _always src/install import/install ;
132
133
uninstall: _always import/uninstall src/uninstall ;
134
135
reinstall: _always uninstall install ;
136
137
##### Staging tables
138
139
import/install: _always import/schema $(addprefix import/install-,$(tables)) ;
140
141
import/uninstall: _always import/rm_schema ;
142
# rm_schema will also drop all staging tables
143
144
import/schema: _always
145
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
146
# ignore errors if schema exists
147
148
import/rm_schema: _always
149
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
150
151
import/install-%: _always
152 1954 aaronmk
	$(import_install_table)
153
import_install_table = (prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc)\
154
table=$* $(bin)/csv2db $(catSrcs)$(if $(log), &>import/install.log))
155 1921 aaronmk
156 1777 aaronmk
##### Sources
157
158
srcs = $(shell $(bin)/sort_filenames $(wildcard $(exts:%=src/*.$*.%)))
159
isXml = $(filter %.xml,$(firstword $(srcs)))
160
catSrcs = $(bin)/cat$(if $(isXml),,_csv) $(srcs)
161 1779 aaronmk
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
162 1777 aaronmk
163 1896 aaronmk
# Usage: `make {--silent|-s} cat` (removes echoed make commands)
164 1777 aaronmk
cat: $(addprefix cat-,$(tables)) _always ;
165
166
cat-%: _always
167
	$(catSrcs)
168
169
##### Maps building
170
171 1789 aaronmk
# Maps to (try to) build are added to one of these
172 1779 aaronmk
maps :=
173 1789 aaronmk
createOnlyMaps :=
174 1779 aaronmk
175 1775 aaronmk
srcMaps := $(wildcard maps/src.*.csv)
176 1289 aaronmk
177 1931 aaronmk
mkSrcMap = $(catSrcs)|env datasrc=$(datasrc) $(bin)/src_map >$@
178 1779 aaronmk
179
# Autogen src maps with known table names
180
maps/src.%.csv: # no prereqs so only built if doesn't exist
181
	$(if $(srcs),$(if $(isXml),,$(mkSrcMap)))
182
# only build if CSV srcs exist for that table name
183
# Try all table names
184 1789 aaronmk
createOnlyMaps += $(tablesSort:%=maps/src.%.csv)
185 1779 aaronmk
186 1273 aaronmk
# Must come before $(root)/% to override it
187 1524 aaronmk
$(coreSelfMap): _always
188 1273 aaronmk
	-+$(subMake)
189 1524 aaronmk
# ignore errors if $(coreSelfMap) does not exist
190 1273 aaronmk
191 1509 aaronmk
# Via maps cleanup
192
ifneq ($(filter maps/.%.last_cleanup,$(MAKECMDGOALS)),)
193 1787 aaronmk
maps/.$(via).%.csv.last_cleanup: maps/$(via).%.csv $(coreMap)
194 1790 aaronmk
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1
195 1509 aaronmk
	touch $@
196
else
197
$(viaMaps): _always
198
	$(selfMake) $(@:maps/%=maps/.%.last_cleanup)
199
endif
200 1273 aaronmk
201 1526 aaronmk
joinSrcMap = $(if $(wildcard maps/src.$*.csv),$(bin)/in_place $@\
202
$(bin)/intersect maps/src.$*.csv 0)
203
204 1273 aaronmk
makeFullCsv = $(if $(shell test -e $(word 2,$+) && echo t),\
205 1817 aaronmk
env ignore=1 $(bin)/union <$+|,<$< )$(bin)/sort_map >$@
206 1524 aaronmk
# can't use $(wildcard) because it won't recheck file after $(coreSelfMap) runs
207 1273 aaronmk
208 1524 aaronmk
maps/$(via).%.full.csv: maps/$(via).%.csv $(coreSelfMap)
209 1273 aaronmk
	$(makeFullCsv)
210 1526 aaronmk
	$(joinSrcMap)
211 1139 aaronmk
maps += $(patsubst maps/%.csv,maps/%.full.csv,$(viaMaps))
212
213 1530 aaronmk
maps/VegBIEN.%.csv: maps/$(via).%.full.csv $(coreMap)
214
	$(bin)/join <$+|$(bin)/sort_map >$@
215
maps += $(autogenMaps)
216
217 1789 aaronmk
maps: $(createOnlyMaps) $(maps) _always ;
218 1139 aaronmk
219
all += $(maps)
220
221 1742 aaronmk
##### Maps validation
222
223
missing_mappings: _always missing_join_mappings missing_input_mappings ;
224
225
missing_%_mappings: _always # stem is one of join|input
226
	@echo $(emph)"Missing $* mappings:"$(endEmph)
227
	@+$(selfMake) remake 2>&1\
228 1800 aaronmk
|$(SED) -n 's/^.*No.* $* mapping for ([0-9A-Za-z_-]+).*$$/\1/p'\
229 1742 aaronmk
$(if $(filter join,$*),|$(bin)/ucase_first 0)|sort|uniq
230
231 1509 aaronmk
##### External dependencies
232
233
$(root)/%: _always
234
	+$(subMake)
235 1628 aaronmk
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
236 1509 aaronmk
237 783 aaronmk
##### Mapping
238 368 aaronmk
239 1924 aaronmk
inputFiles := $(wildcard $(exts:%=src/*.%))
240
ifeq ($(inputFiles),)
241 1378 aaronmk
dbExport := $(firstword $(wildcard src/db.*.sql))
242 1924 aaronmk
endif
243 728 aaronmk
244 775 aaronmk
+maps = $(filter maps/% $(mappings)/%,$(+_))
245 1451 aaronmk
<in = $(firstword $(filter-out $(+maps),$(+_)))
246
map = $(if $(<in),<$(<in),\
247 1777 aaronmk
$(if $(srcs),$(withCatSrcs),\
248 1451 aaronmk
$(if $(mapEnv),env $(mapEnv),\
249
$(error No input file src/*.$*.{$(exts)}))))\
250
$(root)/map $(+maps)
251 772 aaronmk
map2db = env out_database=vegbien $(map)
252 368 aaronmk
253 783 aaronmk
##### Import to VegBIEN
254 772 aaronmk
255 1378 aaronmk
ifneq ($(dbExport)$(inputFiles),)
256 772 aaronmk
257 1853 aaronmk
profileTest = $(if $(profile),$(if $(test),1))
258
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
259
$(bin)/profile_stats /dev/fd/0
260
261 1594 aaronmk
log_ = import/$*$(if $(n),.n=$(n),).$(date).log
262 1190 aaronmk
trace = $(log_:.log=.trace)
263 1853 aaronmk
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
264 1190 aaronmk
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
265 1853 aaronmk
$(if $(n),,>>$(log_))) 2>&1$(if $(log),$(if $(n),|tee -a $(log_))))
266 1088 aaronmk
# don't abort on import errors, which often relate to invalid input data
267 624 aaronmk
268 1193 aaronmk
import: $(addprefix import-,$(tables)) _always ;
269 718 aaronmk
270
import-%: maps/VegBIEN.%.csv _always
271
	$(import)
272 772 aaronmk
# default:
273
import-%: _always ;
274 718 aaronmk
275 772 aaronmk
else
276
import: _always ;
277
endif
278
279 790 aaronmk
##### Log files from import
280
281 1594 aaronmk
logs := $(wildcard import/*.log import/*.trace)
282 339 aaronmk
283 383 aaronmk
rm_logs: _always
284 339 aaronmk
	$(RM) $(logs)
285
286 783 aaronmk
##### Verification of import
287 264 aaronmk
288 1194 aaronmk
verify: $(addprefix verify-,$(tables)) _always ;
289
290 1199 aaronmk
verify-%: verify/%.ref verify/%.out _always
291 1184 aaronmk
	-$(diffVerbose) $(+_)
292 1088 aaronmk
# don't abort on verification errors, which are expected during development
293 1194 aaronmk
# default:
294 1199 aaronmk
verify-%: verify/%.out _always
295 1200 aaronmk
	$(if $(shell test -e $< && echo t),cat $<)
296 1199 aaronmk
# don't run if verify/%.out's default do-nothing action was used
297 1200 aaronmk
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
298 368 aaronmk
299 1620 aaronmk
verify = $(if $(reverify),"time" $(psqlAsBien) --set=datasource="'$(datasrc)'"\
300
--no-align --field-separator=$$'\t' --pset=footer=off --pset=null=NULL <$< >$@)
301 514 aaronmk
302 1199 aaronmk
verify/%.out: $(mappings)/verify.%.sql _always
303 1192 aaronmk
	$(verify)
304 1194 aaronmk
# default:
305 1199 aaronmk
verify/%.out: _always ;
306 369 aaronmk
307 1199 aaronmk
all += $(wildcard verify/*.out)
308 1192 aaronmk
309 1378 aaronmk
ifneq ($(dbExport),)
310 1082 aaronmk
%.ref: %.ref.sql
311
	$(dbAsBien) $(db) <$< >$@
312
endif
313
314 1667 aaronmk
##### Editing import
315
316
import/rotate: _always
317 1668 aaronmk
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
318 1854 aaronmk
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
319 1667 aaronmk
320
import/rm: _always
321 1854 aaronmk
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
322
$(psqlAsBien)
323 1667 aaronmk
324 783 aaronmk
##### Testing
325 368 aaronmk
326 723 aaronmk
hasOwnRef = $(filter-out %.2-step.xml,$@)
327 630 aaronmk
testRef = $(1:.2-step.xml=.xml).ref
328
329 897 aaronmk
define runTest
330 776 aaronmk
@echo "Testing $(abspath $@)..."
331 991 aaronmk
>$@ env test=1 n=$(test_n) $(1)
332 1184 aaronmk
@(set -x; $(diff) $(call testRef,$@) $@) 2>&1 || { e=$$?;\
333 780 aaronmk
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
334 777 aaronmk
$(if $(hasOwnRef),\
335
echo $(emph)"To accept new test output:"$(endEmph);\
336
echo "$(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile";\
337
,\
338
echo $(emph)"Note: The preceding failed test is compared to another test's\
339
output"$(endEmph);\
340
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
341
)\
342 652 aaronmk
exit $$e;}
343 628 aaronmk
endef
344
345 897 aaronmk
test2File = $(call runTest,$(map))
346 775 aaronmk
347 876 aaronmk
tests :=
348
349 1139 aaronmk
test/$(via).%.xml: maps/$(via).%.full.csv _always
350 775 aaronmk
	$(test2File)
351 876 aaronmk
tests += test/$(via).%.xml
352 629 aaronmk
353 876 aaronmk
test/VegBIEN.%.xml: maps/VegBIEN.%.csv _always
354 775 aaronmk
	$(test2File)
355 876 aaronmk
tests += test/VegBIEN.%.xml
356 628 aaronmk
357 884 aaronmk
test/VegBIEN.%.2-step.xml: test/$(via).%.xml $(coreMap) _always
358 775 aaronmk
	-$(test2File)
359 722 aaronmk
# Don't abort tester if only 2-step test fails, as it's often finicky
360 876 aaronmk
tests += test/VegBIEN.%.2-step.xml
361 630 aaronmk
362 876 aaronmk
test/import.%.out: maps/VegBIEN.%.csv _always
363 897 aaronmk
	$(call runTest,$(map2db))
364 876 aaronmk
tests += test/import.%.out
365 627 aaronmk
366 876 aaronmk
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
367 724 aaronmk
368 1361 aaronmk
.PRECIOUS: $(testOutputs) # save outputs of failed tests so they can be accepted
369
370 876 aaronmk
test: _always $(testOutputs) ;
371
372
all += $(testOutputs)
373
374 634 aaronmk
# Accepts a test output: make <test_output_path>-ok
375 626 aaronmk
%-ok: _always
376 630 aaronmk
	$(CP) $* $(call testRef,$*)
377 502 aaronmk
378 783 aaronmk
##### Input-type-specific
379 368 aaronmk
380 1917 aaronmk
# Each input type needs var $(mapEnv) and targets src/install, src/uninstall
381 624 aaronmk
382 1379 aaronmk
#### DB export
383
384 1378 aaronmk
ifneq ($(dbExport),)
385 256 aaronmk
386 1378 aaronmk
dbEngineExt := $(subst .,,$(suffix $(basename $(notdir $(dbExport)))))
387 1196 aaronmk
db := $(datasrc)
388 622 aaronmk
389 1379 aaronmk
### Installation
390 256 aaronmk
391 1917 aaronmk
src/install: _always db ;
392 339 aaronmk
393 1917 aaronmk
src/uninstall: _always rm_db ;
394 368 aaronmk
395 1379 aaronmk
### DB-engine-specific
396 621 aaronmk
397 624 aaronmk
# Each DB engine needs vars $(dbEngine), $(dbAsBien) and targets db, rm_db
398 256 aaronmk
399 622 aaronmk
ifeq ($(dbEngineExt),my)
400 621 aaronmk
401 622 aaronmk
dbEngine := MySQL
402
403 621 aaronmk
bienPassword := $(shell cat $(root)/config/bien_password)
404
mysqlAs = mysql --user=$(1) --password='$(bienPassword)'
405
mysqlAsRoot := $(call mysqlAs,root)
406
dbAsBien := $(call mysqlAs,bien)
407
408 1097 aaronmk
dbExists = $(shell echo "SHOW DATABASES LIKE '$(db)';"|$(mysqlAsRoot))
409
410
define createDb
411 1098 aaronmk
echo "CREATE DATABASE $(db) DEFAULT CHARACTER SET latin1;"|$(mysqlAsRoot)
412 1097 aaronmk
-$(mysqlAsRoot) --database=$(db) <$<
413
endef
414
# ignore errors in db import so that GRANT will still be run
415
416 1378 aaronmk
db: $(dbExport) _always
417 1097 aaronmk
	$(if $(dbExists),,$(createDb))
418 368 aaronmk
	echo "GRANT SELECT ON $(db).* TO 'bien'@'localhost';"|$(mysqlAsRoot)
419 250 aaronmk
420 383 aaronmk
rm_db: _always
421 368 aaronmk
	-echo "REVOKE ALL ON $(db).* FROM 'bien'@'localhost';"|$(mysqlAsRoot)
422
	echo "DROP DATABASE IF EXISTS $(db);"|$(mysqlAsRoot)
423 365 aaronmk
# ignore errors if grant not defined
424 250 aaronmk
425 1379 aaronmk
## Unrecognized DB engine
426 368 aaronmk
427
else
428 1378 aaronmk
$(error The DB filename $(dbExport) must be db.my.sql)
429 368 aaronmk
endif
430
431 1379 aaronmk
### Other input types
432 622 aaronmk
433 1379 aaronmk
else
434 624 aaronmk
435 1917 aaronmk
src/install: _always ;
436
src/uninstall: _always ;
437 1379 aaronmk
438 256 aaronmk
endif
439 1379 aaronmk
440
#### DB connection info
441
442
ifneq ($(dbEngine),)
443
# Must come after dbEngine is set
444
mapEnv := in_engine=$(dbEngine) in_database=$(db)
445
endif