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 1289 aaronmk
noEmptyMap := $(mappings)/$(via)-VegBIEN.%.no_empty.csv
121 783 aaronmk
122 749 aaronmk
viaMaps := $(wildcard $(tablesSort:%=maps/$(via).%.csv))
123 1139 aaronmk
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard maps/$(via).*.csv))
124 783 aaronmk
125 728 aaronmk
autogenMaps := $(subst $(via).,VegBIEN.,$(viaMaps))
126
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
127
$(wildcard maps/VegBIEN.*.csv))
128 772 aaronmk
tables := $(directMaps:maps/VegBIEN.%.csv=%)
129 728 aaronmk
130 1777 aaronmk
##### Sources
131
132
srcs = $(shell $(bin)/sort_filenames $(wildcard $(exts:%=src/*.$*.%)))
133
isXml = $(filter %.xml,$(firstword $(srcs)))
134
catSrcs = $(bin)/cat$(if $(isXml),,_csv) $(srcs)
135 1779 aaronmk
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
136 1777 aaronmk
137
cat: $(addprefix cat-,$(tables)) _always ;
138
139
cat-%: _always
140
	$(catSrcs)
141
142
##### Maps building
143
144 1789 aaronmk
# Maps to (try to) build are added to one of these
145 1779 aaronmk
maps :=
146 1789 aaronmk
createOnlyMaps :=
147 1779 aaronmk
148 1775 aaronmk
srcMaps := $(wildcard maps/src.*.csv)
149 1289 aaronmk
150 1779 aaronmk
mkSrcMap = env datasrc=$(datasrc) $(withCatSrcs) $(bin)/src_map >$@
151
152
# Autogen src maps with known table names
153
maps/src.%.csv: # no prereqs so only built if doesn't exist
154
	$(if $(srcs),$(if $(isXml),,$(mkSrcMap)))
155
# only build if CSV srcs exist for that table name
156
# Try all table names
157 1789 aaronmk
createOnlyMaps += $(tablesSort:%=maps/src.%.csv)
158 1779 aaronmk
159 1273 aaronmk
# Must come before $(root)/% to override it
160 1524 aaronmk
$(coreSelfMap): _always
161 1273 aaronmk
	-+$(subMake)
162 1524 aaronmk
# ignore errors if $(coreSelfMap) does not exist
163 1273 aaronmk
164 1509 aaronmk
# Via maps cleanup
165
ifneq ($(filter maps/.%.last_cleanup,$(MAKECMDGOALS)),)
166 1787 aaronmk
maps/.$(via).%.csv.last_cleanup: maps/$(via).%.csv $(coreMap)
167 1790 aaronmk
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1
168 1509 aaronmk
	touch $@
169
else
170
$(viaMaps): _always
171
	$(selfMake) $(@:maps/%=maps/.%.last_cleanup)
172
endif
173 1273 aaronmk
174 1526 aaronmk
joinSrcMap = $(if $(wildcard maps/src.$*.csv),$(bin)/in_place $@\
175
$(bin)/intersect maps/src.$*.csv 0)
176
177 1273 aaronmk
makeFullCsv = $(if $(shell test -e $(word 2,$+) && echo t),\
178 1289 aaronmk
env ignore=1 $(bin)/union <$+|$(bin)/sort_map >$@,$(CP) $< $@)
179 1524 aaronmk
# can't use $(wildcard) because it won't recheck file after $(coreSelfMap) runs
180 1273 aaronmk
181 1524 aaronmk
maps/$(via).%.full.csv: maps/$(via).%.csv $(coreSelfMap)
182 1273 aaronmk
	$(makeFullCsv)
183 1526 aaronmk
	$(joinSrcMap)
184 1139 aaronmk
maps += $(patsubst maps/%.csv,maps/%.full.csv,$(viaMaps))
185
186 1530 aaronmk
maps/VegBIEN.%.csv: maps/$(via).%.full.csv $(coreMap)
187
	$(bin)/join <$+|$(bin)/sort_map >$@
188
maps += $(autogenMaps)
189
190 1789 aaronmk
maps: $(createOnlyMaps) $(maps) _always ;
191 1139 aaronmk
192
all += $(maps)
193
194 1742 aaronmk
##### Maps validation
195
196
missing_mappings: _always missing_join_mappings missing_input_mappings ;
197
198
missing_%_mappings: _always # stem is one of join|input
199
	@echo $(emph)"Missing $* mappings:"$(endEmph)
200
	@+$(selfMake) remake 2>&1\
201
|$(SED) -n 's/^.*No $* mapping for ([0-9A-Za-z_-]+).*$$/\1/p'\
202
$(if $(filter join,$*),|$(bin)/ucase_first 0)|sort|uniq
203
204 1509 aaronmk
##### External dependencies
205
206
$(root)/%: _always
207
	+$(subMake)
208 1628 aaronmk
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
209 1509 aaronmk
210 783 aaronmk
##### Mapping
211 368 aaronmk
212 1378 aaronmk
dbExport := $(firstword $(wildcard src/db.*.sql))
213 1385 aaronmk
inputFiles := $(wildcard $(exts:%=src/*.%))
214 728 aaronmk
215 775 aaronmk
+maps = $(filter maps/% $(mappings)/%,$(+_))
216 1451 aaronmk
<in = $(firstword $(filter-out $(+maps),$(+_)))
217
map = $(if $(<in),<$(<in),\
218 1777 aaronmk
$(if $(srcs),$(withCatSrcs),\
219 1451 aaronmk
$(if $(mapEnv),env $(mapEnv),\
220
$(error No input file src/*.$*.{$(exts)}))))\
221
$(root)/map $(+maps)
222 772 aaronmk
map2db = env out_database=vegbien $(map)
223 368 aaronmk
224 783 aaronmk
##### Import to VegBIEN
225 772 aaronmk
226 1378 aaronmk
ifneq ($(dbExport)$(inputFiles),)
227 772 aaronmk
228 1594 aaronmk
log_ = import/$*$(if $(n),.n=$(n),).$(date).log
229 1190 aaronmk
trace = $(log_:.log=.trace)
230 1575 aaronmk
import = -(set -x; "time" env commit=1\
231 1190 aaronmk
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
232
$(if $(n),,>>$(log_))) 2>&1$(if $(log),$(if $(n),|tee -a $(log_)))
233 1088 aaronmk
# don't abort on import errors, which often relate to invalid input data
234 624 aaronmk
235 1193 aaronmk
import: $(addprefix import-,$(tables)) _always ;
236 718 aaronmk
237
import-%: maps/VegBIEN.%.csv _always
238
	$(import)
239 772 aaronmk
# default:
240
import-%: _always ;
241 718 aaronmk
242 772 aaronmk
else
243
import: _always ;
244
endif
245
246 790 aaronmk
##### Log files from import
247
248 1594 aaronmk
logs := $(wildcard import/*.log import/*.trace)
249 339 aaronmk
250 383 aaronmk
rm_logs: _always
251 339 aaronmk
	$(RM) $(logs)
252
253 783 aaronmk
##### Verification of import
254 264 aaronmk
255 1194 aaronmk
verify: $(addprefix verify-,$(tables)) _always ;
256
257 1199 aaronmk
verify-%: verify/%.ref verify/%.out _always
258 1184 aaronmk
	-$(diffVerbose) $(+_)
259 1088 aaronmk
# don't abort on verification errors, which are expected during development
260 1194 aaronmk
# default:
261 1199 aaronmk
verify-%: verify/%.out _always
262 1200 aaronmk
	$(if $(shell test -e $< && echo t),cat $<)
263 1199 aaronmk
# don't run if verify/%.out's default do-nothing action was used
264 1200 aaronmk
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
265 368 aaronmk
266 1620 aaronmk
verify = $(if $(reverify),"time" $(psqlAsBien) --set=datasource="'$(datasrc)'"\
267
--no-align --field-separator=$$'\t' --pset=footer=off --pset=null=NULL <$< >$@)
268 514 aaronmk
269 1199 aaronmk
verify/%.out: $(mappings)/verify.%.sql _always
270 1192 aaronmk
	$(verify)
271 1194 aaronmk
# default:
272 1199 aaronmk
verify/%.out: _always ;
273 369 aaronmk
274 1199 aaronmk
all += $(wildcard verify/*.out)
275 1192 aaronmk
276 1378 aaronmk
ifneq ($(dbExport),)
277 1082 aaronmk
%.ref: %.ref.sql
278
	$(dbAsBien) $(db) <$< >$@
279
endif
280
281 1667 aaronmk
##### Editing import
282
283
import/rotate: _always
284 1668 aaronmk
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
285 1667 aaronmk
WHERE organizationname = '$(db)';"|$(psqlAsBien)
286
287
import/rm: _always
288
	echo "DELETE FROM party WHERE organizationname = '$(db)';"|$(psqlAsBien)
289
290 783 aaronmk
##### Testing
291 368 aaronmk
292 723 aaronmk
hasOwnRef = $(filter-out %.2-step.xml,$@)
293 630 aaronmk
testRef = $(1:.2-step.xml=.xml).ref
294
295 897 aaronmk
define runTest
296 776 aaronmk
@echo "Testing $(abspath $@)..."
297 991 aaronmk
>$@ env test=1 n=$(test_n) $(1)
298 1184 aaronmk
@(set -x; $(diff) $(call testRef,$@) $@) 2>&1 || { e=$$?;\
299 780 aaronmk
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
300 777 aaronmk
$(if $(hasOwnRef),\
301
echo $(emph)"To accept new test output:"$(endEmph);\
302
echo "$(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile";\
303
,\
304
echo $(emph)"Note: The preceding failed test is compared to another test's\
305
output"$(endEmph);\
306
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
307
)\
308 652 aaronmk
exit $$e;}
309 628 aaronmk
endef
310
311 897 aaronmk
test2File = $(call runTest,$(map))
312 775 aaronmk
313 876 aaronmk
tests :=
314
315 1139 aaronmk
test/$(via).%.xml: maps/$(via).%.full.csv _always
316 775 aaronmk
	$(test2File)
317 876 aaronmk
tests += test/$(via).%.xml
318 629 aaronmk
319 876 aaronmk
test/VegBIEN.%.xml: maps/VegBIEN.%.csv _always
320 775 aaronmk
	$(test2File)
321 876 aaronmk
tests += test/VegBIEN.%.xml
322 628 aaronmk
323 884 aaronmk
test/VegBIEN.%.2-step.xml: test/$(via).%.xml $(coreMap) _always
324 775 aaronmk
	-$(test2File)
325 722 aaronmk
# Don't abort tester if only 2-step test fails, as it's often finicky
326 876 aaronmk
tests += test/VegBIEN.%.2-step.xml
327 630 aaronmk
328 876 aaronmk
test/import.%.out: maps/VegBIEN.%.csv _always
329 897 aaronmk
	$(call runTest,$(map2db))
330 876 aaronmk
tests += test/import.%.out
331 627 aaronmk
332 876 aaronmk
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
333 724 aaronmk
334 1361 aaronmk
.PRECIOUS: $(testOutputs) # save outputs of failed tests so they can be accepted
335
336 876 aaronmk
test: _always $(testOutputs) ;
337
338
all += $(testOutputs)
339
340 634 aaronmk
# Accepts a test output: make <test_output_path>-ok
341 626 aaronmk
%-ok: _always
342 630 aaronmk
	$(CP) $* $(call testRef,$*)
343 502 aaronmk
344 783 aaronmk
##### Input-type-specific
345 368 aaronmk
346 624 aaronmk
# Each input type needs var $(mapEnv) and targets install, uninstall
347
348 1379 aaronmk
#### DB export
349
350 1378 aaronmk
ifneq ($(dbExport),)
351 256 aaronmk
352 1378 aaronmk
dbEngineExt := $(subst .,,$(suffix $(basename $(notdir $(dbExport)))))
353 1196 aaronmk
db := $(datasrc)
354 622 aaronmk
355 1379 aaronmk
### Installation
356 256 aaronmk
357 621 aaronmk
install: _always db ;
358 339 aaronmk
359 621 aaronmk
uninstall: _always rm_db ;
360 368 aaronmk
361 1379 aaronmk
### DB-engine-specific
362 621 aaronmk
363 624 aaronmk
# Each DB engine needs vars $(dbEngine), $(dbAsBien) and targets db, rm_db
364 256 aaronmk
365 622 aaronmk
ifeq ($(dbEngineExt),my)
366 621 aaronmk
367 622 aaronmk
dbEngine := MySQL
368
369 621 aaronmk
bienPassword := $(shell cat $(root)/config/bien_password)
370
mysqlAs = mysql --user=$(1) --password='$(bienPassword)'
371
mysqlAsRoot := $(call mysqlAs,root)
372
dbAsBien := $(call mysqlAs,bien)
373
374 1097 aaronmk
dbExists = $(shell echo "SHOW DATABASES LIKE '$(db)';"|$(mysqlAsRoot))
375
376
define createDb
377 1098 aaronmk
echo "CREATE DATABASE $(db) DEFAULT CHARACTER SET latin1;"|$(mysqlAsRoot)
378 1097 aaronmk
-$(mysqlAsRoot) --database=$(db) <$<
379
endef
380
# ignore errors in db import so that GRANT will still be run
381
382 1378 aaronmk
db: $(dbExport) _always
383 1097 aaronmk
	$(if $(dbExists),,$(createDb))
384 368 aaronmk
	echo "GRANT SELECT ON $(db).* TO 'bien'@'localhost';"|$(mysqlAsRoot)
385 250 aaronmk
386 383 aaronmk
rm_db: _always
387 368 aaronmk
	-echo "REVOKE ALL ON $(db).* FROM 'bien'@'localhost';"|$(mysqlAsRoot)
388
	echo "DROP DATABASE IF EXISTS $(db);"|$(mysqlAsRoot)
389 365 aaronmk
# ignore errors if grant not defined
390 250 aaronmk
391 1379 aaronmk
## Unrecognized DB engine
392 368 aaronmk
393
else
394 1378 aaronmk
$(error The DB filename $(dbExport) must be db.my.sql)
395 368 aaronmk
endif
396
397 1379 aaronmk
### Other input types
398 622 aaronmk
399 1379 aaronmk
else
400 624 aaronmk
401
install: _always ;
402
uninstall: _always ;
403 1379 aaronmk
404 256 aaronmk
endif
405 1379 aaronmk
406
#### DB connection info
407
408
ifneq ($(dbEngine),)
409
# Must come after dbEngine is set
410
mapEnv := in_engine=$(dbEngine) in_database=$(db)
411
endif