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