Project

General

Profile

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