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