Project

General

Profile

1
##### Configuration
2

    
3
log ?= $(if $(test),,1)
4
profile ?=
5
reverify ?= 1
6
exts ?= csv tsv txt xml
7
test_n ?= 2
8
tablesSort ?= plots organisms stems
9

    
10
##### Vars/functions
11

    
12
selfDir_uZPPqC := $(dir $(lastword $(MAKEFILE_LIST)))
13

    
14
# Make
15
SHELL := /bin/bash
16
selfMake = $(MAKE) --makefile=../input.Makefile
17
subMake = $(MAKE) $(@F) --directory=$(@D)
18
+_ = $(+:_%=)
19
addBeforeExt = $(basename $(2))$(1)$(suffix $(2))
20

    
21
# System
22
date = $(shell date +"%Y-%m-%d-%H-%M-%S")
23

    
24
# Terminal
25
termCols := $(shell tput cols)
26
esc := '['
27
reset := $(esc)'0m'
28
emph := $(esc)'7m '
29
endEmph := ' '$(reset)
30

    
31
# Commands
32
MKDIR = mkdir -p
33
mkdir = $(MKDIR) $(@D)
34
CP = cp -p
35
diff = diff --unified=2
36
diffVerbose = $(if $(verbose),diff --side-by-side --left-column\
37
--width=$(termCols),$(diff))
38

    
39
# Paths
40
datasrc := $(notdir $(realpath .))
41
root := $(selfDir_uZPPqC)..
42
bin := $(root)/bin
43
mappings := $(root)/mappings
44

    
45
# Commands
46
selfMap = $(bin)/cols 0 0
47
psqlOpts := --set ON_ERROR_STOP=1 --quiet
48
psqlAsBien := $(bin)/psql_vegbien $(psqlOpts)
49

    
50
# 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
##### General targets
59

    
60
all: _always maps ;
61

    
62
.SUFFIXES: # turn off built-in suffix rules
63
.SECONDARY: # don't automatically delete intermediate files
64
.DELETE_ON_ERROR: # delete target if recipe fails
65

    
66
_always:
67
.PHONY: _always
68

    
69
clean: _always
70
	$(RM) $(all)
71

    
72
make_script = ./$< >$@
73

    
74
%/: % _always ;
75

    
76
# 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
##### SVN
85

    
86
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

    
94
##### Installation
95

    
96
reinstall: _always uninstall install ;
97

    
98
##### Maps
99

    
100
srcMap := maps/src.%.csv
101
fullViaMap := maps/%.full.csv
102
directMap := maps/VegBIEN.%.csv
103
allViaMaps := $(filter-out $(srcMap) $(fullViaMap) $(directMap),\
104
$(wildcard maps/*.csv))
105
via := $(firstword $(sort $(basename $(basename $(notdir $(allViaMaps))))))
106

    
107
coreMap := $(mappings)/$(via)-VegBIEN.%.csv
108
coreSelfMap := $(mappings)/$(via).self.%.csv
109
noEmptyMap := $(mappings)/$(via)-VegBIEN.%.no_empty.csv
110

    
111
viaMaps := $(wildcard $(tablesSort:%=maps/$(via).%.csv))
112
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard maps/$(via).*.csv))
113

    
114
autogenMaps := $(subst $(via).,VegBIEN.,$(viaMaps))
115
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
116
$(wildcard maps/VegBIEN.*.csv))
117
tables := $(directMaps:maps/VegBIEN.%.csv=%)
118

    
119
srcMaps := $(filter-out maps/src.join.%.csv,$(wildcard maps/src.*.csv))
120

    
121
# Must come before $(root)/% to override it
122
$(coreSelfMap): _always
123
	-+$(subMake)
124
# ignore errors if $(coreSelfMap) does not exist
125

    
126
# Via maps cleanup
127
ifneq ($(filter maps/.%.last_cleanup,$(MAKECMDGOALS)),)
128
maps/.$(via).%.csv.last_cleanup: maps/$(via).%.csv $(coreSelfMap)
129
	$(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

    
138
maps :=
139

    
140
joinSrcMap = $(if $(wildcard maps/src.$*.csv),$(bin)/in_place $@\
141
$(bin)/intersect maps/src.$*.csv 0)
142

    
143
makeFullCsv = $(if $(shell test -e $(word 2,$+) && echo t),\
144
env ignore=1 $(bin)/union <$+|$(bin)/sort_map >$@,$(CP) $< $@)
145
# can't use $(wildcard) because it won't recheck file after $(coreSelfMap) runs
146

    
147
maps/$(via).%.full.csv: maps/$(via).%.csv $(coreSelfMap)
148
	$(makeFullCsv)
149
	$(joinSrcMap)
150
maps += $(patsubst maps/%.csv,maps/%.full.csv,$(viaMaps))
151

    
152
maps/VegBIEN.%.csv: maps/$(via).%.full.csv $(coreMap)
153
	$(bin)/join <$+|$(bin)/sort_map >$@
154
maps += $(autogenMaps)
155

    
156
maps: $(maps) _always ;
157

    
158
all += $(maps)
159

    
160
##### External dependencies
161

    
162
$(root)/%: _always
163
	+$(subMake)
164

    
165
##### Mapping
166

    
167
dbExport := $(firstword $(wildcard src/db.*.sql))
168
inputFiles := $(wildcard $(exts:%=src/*.%))
169

    
170
+maps = $(filter maps/% $(mappings)/%,$(+_))
171
<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
map2db = env out_database=vegbien $(map)
179

    
180
##### Import to VegBIEN
181

    
182
ifneq ($(dbExport)$(inputFiles),)
183

    
184
log_ = import/$*$(if $(n),.n=$(n),).$(date).log
185
trace = $(log_:.log=.trace)
186
import = -(set -x; "time" env commit=1\
187
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
188
$(if $(n),,>>$(log_))) 2>&1$(if $(log),$(if $(n),|tee -a $(log_)))
189
# don't abort on import errors, which often relate to invalid input data
190

    
191
import: $(addprefix import-,$(tables)) _always ;
192

    
193
import-%: maps/VegBIEN.%.csv _always
194
	$(import)
195
# default:
196
import-%: _always ;
197

    
198
else
199
import: _always ;
200
endif
201

    
202
##### Log files from import
203

    
204
logs := $(wildcard import/*.log import/*.trace)
205

    
206
rm_logs: _always
207
	$(RM) $(logs)
208

    
209
##### Verification of import
210

    
211
verify: $(addprefix verify-,$(tables)) _always ;
212

    
213
verify-%: verify/%.ref verify/%.out _always
214
	-$(diffVerbose) $(+_)
215
# don't abort on verification errors, which are expected during development
216
# default:
217
verify-%: verify/%.out _always
218
	$(if $(shell test -e $< && echo t),cat $<)
219
# don't run if verify/%.out's default do-nothing action was used
220
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
221

    
222
verify = $(if $(reverify),"time" $(psqlAsBien) --set=datasource="'$(datasrc)'"\
223
--no-align --field-separator=$$'\t' --pset=footer=off --pset=null=NULL <$< >$@)
224

    
225
verify/%.out: $(mappings)/verify.%.sql _always
226
	$(verify)
227
# default:
228
verify/%.out: _always ;
229

    
230
all += $(wildcard verify/*.out)
231

    
232
ifneq ($(dbExport),)
233
%.ref: %.ref.sql
234
	$(dbAsBien) $(db) <$< >$@
235
endif
236

    
237
##### Testing
238

    
239
ifneq ($(wildcard test/),)
240

    
241
hasOwnRef = $(filter-out %.2-step.xml,$@)
242
testRef = $(1:.2-step.xml=.xml).ref
243

    
244
define runTest
245
@echo "Testing $(abspath $@)..."
246
>$@ env test=1 n=$(test_n) $(1)
247
@(set -x; $(diff) $(call testRef,$@) $@) 2>&1 || { e=$$?;\
248
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
249
$(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
exit $$e;}
258
endef
259

    
260
test2File = $(call runTest,$(map))
261

    
262
tests :=
263

    
264
test/$(via).%.xml: maps/$(via).%.full.csv _always
265
	$(test2File)
266
tests += test/$(via).%.xml
267

    
268
test/VegBIEN.%.xml: maps/VegBIEN.%.csv _always
269
	$(test2File)
270
tests += test/VegBIEN.%.xml
271

    
272
test/VegBIEN.%.2-step.xml: test/$(via).%.xml $(coreMap) _always
273
	-$(test2File)
274
# Don't abort tester if only 2-step test fails, as it's often finicky
275
tests += test/VegBIEN.%.2-step.xml
276

    
277
test/import.%.out: maps/VegBIEN.%.csv _always
278
	$(call runTest,$(map2db))
279
tests += test/import.%.out
280

    
281
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
282

    
283
.PRECIOUS: $(testOutputs) # save outputs of failed tests so they can be accepted
284

    
285
test: _always $(testOutputs) ;
286

    
287
all += $(testOutputs)
288

    
289
# Accepts a test output: make <test_output_path>-ok
290
%-ok: _always
291
	$(CP) $* $(call testRef,$*)
292

    
293
else
294
test: _always ;
295
endif
296

    
297
##### Input-type-specific
298

    
299
# Each input type needs var $(mapEnv) and targets install, uninstall
300

    
301
#### DB export
302

    
303
ifneq ($(dbExport),)
304

    
305
dbEngineExt := $(subst .,,$(suffix $(basename $(notdir $(dbExport)))))
306
db := $(datasrc)
307

    
308
### Installation
309

    
310
install: _always db ;
311

    
312
uninstall: _always rm_db ;
313

    
314
### DB-engine-specific
315

    
316
# Each DB engine needs vars $(dbEngine), $(dbAsBien) and targets db, rm_db
317

    
318
ifeq ($(dbEngineExt),my)
319

    
320
dbEngine := MySQL
321

    
322
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
dbExists = $(shell echo "SHOW DATABASES LIKE '$(db)';"|$(mysqlAsRoot))
328

    
329
define createDb
330
echo "CREATE DATABASE $(db) DEFAULT CHARACTER SET latin1;"|$(mysqlAsRoot)
331
-$(mysqlAsRoot) --database=$(db) <$<
332
endef
333
# ignore errors in db import so that GRANT will still be run
334

    
335
db: $(dbExport) _always
336
	$(if $(dbExists),,$(createDb))
337
	echo "GRANT SELECT ON $(db).* TO 'bien'@'localhost';"|$(mysqlAsRoot)
338

    
339
rm_db: _always
340
	-echo "REVOKE ALL ON $(db).* FROM 'bien'@'localhost';"|$(mysqlAsRoot)
341
	echo "DROP DATABASE IF EXISTS $(db);"|$(mysqlAsRoot)
342
# ignore errors if grant not defined
343

    
344
## Unrecognized DB engine
345

    
346
else
347
$(error The DB filename $(dbExport) must be db.my.sql)
348
endif
349

    
350
### Other input types
351

    
352
else
353

    
354
install: _always ;
355
uninstall: _always ;
356

    
357
endif
358

    
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
(2-2/2)