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
	$(make_script)
79
.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
165 783 aaronmk
##### Mapping
166 368 aaronmk
167 1378 aaronmk
dbExport := $(firstword $(wildcard src/db.*.sql))
168 1385 aaronmk
inputFiles := $(wildcard $(exts:%=src/*.%))
169 728 aaronmk
170 775 aaronmk
+maps = $(filter maps/% $(mappings)/%,$(+_))
171 1451 aaronmk
<in = $(firstword $(filter-out $(+maps),$(+_)))
172
srcs = $(sort $(wildcard $(exts:%=src/*.$*.%)))
173
map = $(if $(<in),<$(<in),\
174
$(if $(srcs),$(bin)/with_cat_csv $(srcs) --,\
175
$(if $(mapEnv),env $(mapEnv),\
176
$(error No input file src/*.$*.{$(exts)}))))\
177
$(root)/map $(+maps)
178 772 aaronmk
map2db = env out_database=vegbien $(map)
179 368 aaronmk
180 783 aaronmk
##### Import to VegBIEN
181 772 aaronmk
182 1378 aaronmk
ifneq ($(dbExport)$(inputFiles),)
183 772 aaronmk
184 1594 aaronmk
log_ = import/$*$(if $(n),.n=$(n),).$(date).log
185 1190 aaronmk
trace = $(log_:.log=.trace)
186 1575 aaronmk
import = -(set -x; "time" env commit=1\
187 1190 aaronmk
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
188
$(if $(n),,>>$(log_))) 2>&1$(if $(log),$(if $(n),|tee -a $(log_)))
189 1088 aaronmk
# don't abort on import errors, which often relate to invalid input data
190 624 aaronmk
191 1193 aaronmk
import: $(addprefix import-,$(tables)) _always ;
192 718 aaronmk
193
import-%: maps/VegBIEN.%.csv _always
194
	$(import)
195 772 aaronmk
# default:
196
import-%: _always ;
197 718 aaronmk
198 772 aaronmk
else
199
import: _always ;
200
endif
201
202 790 aaronmk
##### Log files from import
203
204 1594 aaronmk
logs := $(wildcard import/*.log import/*.trace)
205 339 aaronmk
206 383 aaronmk
rm_logs: _always
207 339 aaronmk
	$(RM) $(logs)
208
209 783 aaronmk
##### Verification of import
210 264 aaronmk
211 1194 aaronmk
verify: $(addprefix verify-,$(tables)) _always ;
212
213 1199 aaronmk
verify-%: verify/%.ref verify/%.out _always
214 1184 aaronmk
	-$(diffVerbose) $(+_)
215 1088 aaronmk
# don't abort on verification errors, which are expected during development
216 1194 aaronmk
# default:
217 1199 aaronmk
verify-%: verify/%.out _always
218 1200 aaronmk
	$(if $(shell test -e $< && echo t),cat $<)
219 1199 aaronmk
# don't run if verify/%.out's default do-nothing action was used
220 1200 aaronmk
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
221 368 aaronmk
222 1620 aaronmk
verify = $(if $(reverify),"time" $(psqlAsBien) --set=datasource="'$(datasrc)'"\
223
--no-align --field-separator=$$'\t' --pset=footer=off --pset=null=NULL <$< >$@)
224 514 aaronmk
225 1199 aaronmk
verify/%.out: $(mappings)/verify.%.sql _always
226 1192 aaronmk
	$(verify)
227 1194 aaronmk
# default:
228 1199 aaronmk
verify/%.out: _always ;
229 369 aaronmk
230 1199 aaronmk
all += $(wildcard verify/*.out)
231 1192 aaronmk
232 1378 aaronmk
ifneq ($(dbExport),)
233 1082 aaronmk
%.ref: %.ref.sql
234
	$(dbAsBien) $(db) <$< >$@
235
endif
236
237 783 aaronmk
##### Testing
238 368 aaronmk
239 624 aaronmk
ifneq ($(wildcard test/),)
240
241 723 aaronmk
hasOwnRef = $(filter-out %.2-step.xml,$@)
242 630 aaronmk
testRef = $(1:.2-step.xml=.xml).ref
243
244 897 aaronmk
define runTest
245 776 aaronmk
@echo "Testing $(abspath $@)..."
246 991 aaronmk
>$@ env test=1 n=$(test_n) $(1)
247 1184 aaronmk
@(set -x; $(diff) $(call testRef,$@) $@) 2>&1 || { e=$$?;\
248 780 aaronmk
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
249 777 aaronmk
$(if $(hasOwnRef),\
250
echo $(emph)"To accept new test output:"$(endEmph);\
251
echo "$(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile";\
252
,\
253
echo $(emph)"Note: The preceding failed test is compared to another test's\
254
output"$(endEmph);\
255
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
256
)\
257 652 aaronmk
exit $$e;}
258 628 aaronmk
endef
259
260 897 aaronmk
test2File = $(call runTest,$(map))
261 775 aaronmk
262 876 aaronmk
tests :=
263
264 1139 aaronmk
test/$(via).%.xml: maps/$(via).%.full.csv _always
265 775 aaronmk
	$(test2File)
266 876 aaronmk
tests += test/$(via).%.xml
267 629 aaronmk
268 876 aaronmk
test/VegBIEN.%.xml: maps/VegBIEN.%.csv _always
269 775 aaronmk
	$(test2File)
270 876 aaronmk
tests += test/VegBIEN.%.xml
271 628 aaronmk
272 884 aaronmk
test/VegBIEN.%.2-step.xml: test/$(via).%.xml $(coreMap) _always
273 775 aaronmk
	-$(test2File)
274 722 aaronmk
# Don't abort tester if only 2-step test fails, as it's often finicky
275 876 aaronmk
tests += test/VegBIEN.%.2-step.xml
276 630 aaronmk
277 876 aaronmk
test/import.%.out: maps/VegBIEN.%.csv _always
278 897 aaronmk
	$(call runTest,$(map2db))
279 876 aaronmk
tests += test/import.%.out
280 627 aaronmk
281 876 aaronmk
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
282 724 aaronmk
283 1361 aaronmk
.PRECIOUS: $(testOutputs) # save outputs of failed tests so they can be accepted
284
285 876 aaronmk
test: _always $(testOutputs) ;
286
287
all += $(testOutputs)
288
289 634 aaronmk
# Accepts a test output: make <test_output_path>-ok
290 626 aaronmk
%-ok: _always
291 630 aaronmk
	$(CP) $* $(call testRef,$*)
292 502 aaronmk
293 624 aaronmk
else
294
test: _always ;
295
endif
296
297 783 aaronmk
##### Input-type-specific
298 368 aaronmk
299 624 aaronmk
# Each input type needs var $(mapEnv) and targets install, uninstall
300
301 1379 aaronmk
#### DB export
302
303 1378 aaronmk
ifneq ($(dbExport),)
304 256 aaronmk
305 1378 aaronmk
dbEngineExt := $(subst .,,$(suffix $(basename $(notdir $(dbExport)))))
306 1196 aaronmk
db := $(datasrc)
307 622 aaronmk
308 1379 aaronmk
### Installation
309 256 aaronmk
310 621 aaronmk
install: _always db ;
311 339 aaronmk
312 621 aaronmk
uninstall: _always rm_db ;
313 368 aaronmk
314 1379 aaronmk
### DB-engine-specific
315 621 aaronmk
316 624 aaronmk
# Each DB engine needs vars $(dbEngine), $(dbAsBien) and targets db, rm_db
317 256 aaronmk
318 622 aaronmk
ifeq ($(dbEngineExt),my)
319 621 aaronmk
320 622 aaronmk
dbEngine := MySQL
321
322 621 aaronmk
bienPassword := $(shell cat $(root)/config/bien_password)
323
mysqlAs = mysql --user=$(1) --password='$(bienPassword)'
324
mysqlAsRoot := $(call mysqlAs,root)
325
dbAsBien := $(call mysqlAs,bien)
326
327 1097 aaronmk
dbExists = $(shell echo "SHOW DATABASES LIKE '$(db)';"|$(mysqlAsRoot))
328
329
define createDb
330 1098 aaronmk
echo "CREATE DATABASE $(db) DEFAULT CHARACTER SET latin1;"|$(mysqlAsRoot)
331 1097 aaronmk
-$(mysqlAsRoot) --database=$(db) <$<
332
endef
333
# ignore errors in db import so that GRANT will still be run
334
335 1378 aaronmk
db: $(dbExport) _always
336 1097 aaronmk
	$(if $(dbExists),,$(createDb))
337 368 aaronmk
	echo "GRANT SELECT ON $(db).* TO 'bien'@'localhost';"|$(mysqlAsRoot)
338 250 aaronmk
339 383 aaronmk
rm_db: _always
340 368 aaronmk
	-echo "REVOKE ALL ON $(db).* FROM 'bien'@'localhost';"|$(mysqlAsRoot)
341
	echo "DROP DATABASE IF EXISTS $(db);"|$(mysqlAsRoot)
342 365 aaronmk
# ignore errors if grant not defined
343 250 aaronmk
344 1379 aaronmk
## Unrecognized DB engine
345 368 aaronmk
346
else
347 1378 aaronmk
$(error The DB filename $(dbExport) must be db.my.sql)
348 368 aaronmk
endif
349
350 1379 aaronmk
### Other input types
351 622 aaronmk
352 1379 aaronmk
else
353 624 aaronmk
354
install: _always ;
355
uninstall: _always ;
356 1379 aaronmk
357 256 aaronmk
endif
358 1379 aaronmk
359
#### DB connection info
360
361
ifneq ($(dbEngine),)
362
# Must come after dbEngine is set
363
mapEnv := in_engine=$(dbEngine) in_database=$(db)
364
endif