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 specimens
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
# 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
# System
29
date = $(shell date +"%Y-%m-%d-%H-%M-%S")
30

    
31
# Terminal
32
termCols := $(shell tput cols)
33
esc := '['
34
reset := $(esc)'0m'
35
emph := $(esc)'7m '
36
endEmph := ' '$(reset)
37

    
38
# Commands
39
MKDIR = mkdir -p
40
mkdir = $(MKDIR) $(@D)
41
CP = cp -p
42
diff = diff --unified=2
43
diffVerbose = $(if $(verbose),diff --side-by-side --left-column\
44
--width=$(termCols),$(diff))
45

    
46
# Paths
47
datasrc := $(notdir $(realpath .))
48
root := $(selfDir_uZPPqC)..
49
bin := $(root)/bin
50
mappings := $(root)/mappings
51

    
52
# Commands
53
selfMap = $(bin)/cols 0 0
54
psqlOpts := --set ON_ERROR_STOP=1 --quiet
55
psqlAsBien := $(bin)/psql_vegbien $(psqlOpts)
56

    
57
# SVN
58
addDir = $(if $(wildcard $(1)/),svn add --depth=empty $(1),svn mkdir $(1))
59
setSvnIgnore = svn propset svn:ignore $(2) $(1)
60
define addDirWithIgnore
61
$(addDir)
62
$(setSvnIgnore)
63
endef
64

    
65
##### General targets
66

    
67
all: _always maps ;
68

    
69
.SUFFIXES: # turn off built-in suffix rules
70
.SECONDARY: # don't automatically delete intermediate files
71
.DELETE_ON_ERROR: # delete target if recipe fails
72

    
73
_always:
74
.PHONY: _always
75

    
76
clean: _always
77
	$(RM) $(all)
78

    
79
remake: _always clean
80
	+$(selfMake)
81
# re-run make so that cache of existing files is reset
82

    
83
make_script = ./$< >$@
84

    
85
%/: % _always ;
86

    
87
# Must come before `%: %.make` to override it
88
src/%: src/%.make _always
89
	(set -x; $(make_script)) 2>>$<.log
90
.PRECIOUS: src/% # save partial outputs of aborted src make scripts
91

    
92
%: %.make _always
93
	$(make_script)
94

    
95
##### SVN
96

    
97
add: _always
98
	$(call setSvnIgnore,.,$$'')
99
	$(call addDirWithIgnore,src,$$'*')
100
	$(call addDirWithIgnore,maps,$$'.~*')
101
	$(call addDirWithIgnore,import,$$'*')
102
	$(call addDirWithIgnore,test,$$'*.out\n*.xml')
103
	$(call addDirWithIgnore,verify,$$'*.out')
104

    
105
##### Installation
106

    
107
reinstall: _always uninstall install ;
108

    
109
##### Existing maps discovery
110

    
111
srcMap := maps/src.%.csv
112
fullViaMap := maps/%.full.csv
113
directMap := maps/VegBIEN.%.csv
114
allViaMaps := $(filter-out $(srcMap) $(fullViaMap) $(directMap),\
115
$(wildcard maps/*.csv))
116
via := $(firstword $(sort $(basename $(basename $(notdir $(allViaMaps))))))
117

    
118
coreMap := $(mappings)/$(via)-VegBIEN.%.csv
119
coreSelfMap := $(mappings)/$(via).self.%.csv
120
noEmptyMap := $(mappings)/$(via)-VegBIEN.%.no_empty.csv
121

    
122
viaMaps := $(wildcard $(tablesSort:%=maps/$(via).%.csv))
123
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard maps/$(via).*.csv))
124

    
125
autogenMaps := $(subst $(via).,VegBIEN.,$(viaMaps))
126
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
127
$(wildcard maps/VegBIEN.*.csv))
128
tables := $(directMaps:maps/VegBIEN.%.csv=%)
129

    
130
##### 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
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
136

    
137
cat: $(addprefix cat-,$(tables)) _always ;
138

    
139
cat-%: _always
140
	$(catSrcs)
141

    
142
##### Maps building
143

    
144
# Maps to (try to) build are added to one of these
145
maps :=
146
createOnlyMaps :=
147

    
148
srcMaps := $(wildcard maps/src.*.csv)
149

    
150
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
createOnlyMaps += $(tablesSort:%=maps/src.%.csv)
158

    
159
# Must come before $(root)/% to override it
160
$(coreSelfMap): _always
161
	-+$(subMake)
162
# ignore errors if $(coreSelfMap) does not exist
163

    
164
# Via maps cleanup
165
ifneq ($(filter maps/.%.last_cleanup,$(MAKECMDGOALS)),)
166
maps/.$(via).%.csv.last_cleanup: maps/$(via).%.csv $(coreMap)
167
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1
168
	touch $@
169
# default:
170
maps/.$(via).%.csv.last_cleanup: ;
171
else
172
$(viaMaps): _always
173
	$(selfMake) $(@:maps/%=maps/.%.last_cleanup)
174
endif
175

    
176
joinSrcMap = $(if $(wildcard maps/src.$*.csv),$(bin)/in_place $@\
177
$(bin)/intersect maps/src.$*.csv 0)
178

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

    
183
maps/$(via).%.full.csv: maps/$(via).%.csv $(coreSelfMap)
184
	$(makeFullCsv)
185
	$(joinSrcMap)
186
maps += $(patsubst maps/%.csv,maps/%.full.csv,$(viaMaps))
187

    
188
maps/VegBIEN.%.csv: maps/$(via).%.full.csv $(coreMap)
189
	$(bin)/join <$+|$(bin)/sort_map >$@
190
maps += $(autogenMaps)
191

    
192
maps: $(createOnlyMaps) $(maps) _always ;
193

    
194
all += $(maps)
195

    
196
##### Maps validation
197

    
198
missing_mappings: _always missing_join_mappings missing_input_mappings ;
199

    
200
missing_%_mappings: _always # stem is one of join|input
201
	@echo $(emph)"Missing $* mappings:"$(endEmph)
202
	@+$(selfMake) remake 2>&1\
203
|$(SED) -n 's/^.*No $* mapping for ([0-9A-Za-z_-]+).*$$/\1/p'\
204
$(if $(filter join,$*),|$(bin)/ucase_first 0)|sort|uniq
205

    
206
##### External dependencies
207

    
208
$(root)/%: _always
209
	+$(subMake)
210
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
211

    
212
##### Mapping
213

    
214
dbExport := $(firstword $(wildcard src/db.*.sql))
215
inputFiles := $(wildcard $(exts:%=src/*.%))
216

    
217
+maps = $(filter maps/% $(mappings)/%,$(+_))
218
<in = $(firstword $(filter-out $(+maps),$(+_)))
219
map = $(if $(<in),<$(<in),\
220
$(if $(srcs),$(withCatSrcs),\
221
$(if $(mapEnv),env $(mapEnv),\
222
$(error No input file src/*.$*.{$(exts)}))))\
223
$(root)/map $(+maps)
224
map2db = env out_database=vegbien $(map)
225

    
226
##### Import to VegBIEN
227

    
228
ifneq ($(dbExport)$(inputFiles),)
229

    
230
log_ = import/$*$(if $(n),.n=$(n),).$(date).log
231
trace = $(log_:.log=.trace)
232
import = -(set -x; "time" env commit=1\
233
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
234
$(if $(n),,>>$(log_))) 2>&1$(if $(log),$(if $(n),|tee -a $(log_)))
235
# don't abort on import errors, which often relate to invalid input data
236

    
237
import: $(addprefix import-,$(tables)) _always ;
238

    
239
import-%: maps/VegBIEN.%.csv _always
240
	$(import)
241
# default:
242
import-%: _always ;
243

    
244
else
245
import: _always ;
246
endif
247

    
248
##### Log files from import
249

    
250
logs := $(wildcard import/*.log import/*.trace)
251

    
252
rm_logs: _always
253
	$(RM) $(logs)
254

    
255
##### Verification of import
256

    
257
verify: $(addprefix verify-,$(tables)) _always ;
258

    
259
verify-%: verify/%.ref verify/%.out _always
260
	-$(diffVerbose) $(+_)
261
# don't abort on verification errors, which are expected during development
262
# default:
263
verify-%: verify/%.out _always
264
	$(if $(shell test -e $< && echo t),cat $<)
265
# don't run if verify/%.out's default do-nothing action was used
266
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
267

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

    
271
verify/%.out: $(mappings)/verify.%.sql _always
272
	$(verify)
273
# default:
274
verify/%.out: _always ;
275

    
276
all += $(wildcard verify/*.out)
277

    
278
ifneq ($(dbExport),)
279
%.ref: %.ref.sql
280
	$(dbAsBien) $(db) <$< >$@
281
endif
282

    
283
##### Editing import
284

    
285
import/rotate: _always
286
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
287
WHERE organizationname = '$(db)';"|$(psqlAsBien)
288

    
289
import/rm: _always
290
	echo "DELETE FROM party WHERE organizationname = '$(db)';"|$(psqlAsBien)
291

    
292
##### Testing
293

    
294
hasOwnRef = $(filter-out %.2-step.xml,$@)
295
testRef = $(1:.2-step.xml=.xml).ref
296

    
297
define runTest
298
@echo "Testing $(abspath $@)..."
299
>$@ env test=1 n=$(test_n) $(1)
300
@(set -x; $(diff) $(call testRef,$@) $@) 2>&1 || { e=$$?;\
301
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
302
$(if $(hasOwnRef),\
303
echo $(emph)"To accept new test output:"$(endEmph);\
304
echo "$(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile";\
305
,\
306
echo $(emph)"Note: The preceding failed test is compared to another test's\
307
output"$(endEmph);\
308
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
309
)\
310
exit $$e;}
311
endef
312

    
313
test2File = $(call runTest,$(map))
314

    
315
tests :=
316

    
317
test/$(via).%.xml: maps/$(via).%.full.csv _always
318
	$(test2File)
319
tests += test/$(via).%.xml
320

    
321
test/VegBIEN.%.xml: maps/VegBIEN.%.csv _always
322
	$(test2File)
323
tests += test/VegBIEN.%.xml
324

    
325
test/VegBIEN.%.2-step.xml: test/$(via).%.xml $(coreMap) _always
326
	-$(test2File)
327
# Don't abort tester if only 2-step test fails, as it's often finicky
328
tests += test/VegBIEN.%.2-step.xml
329

    
330
test/import.%.out: maps/VegBIEN.%.csv _always
331
	$(call runTest,$(map2db))
332
tests += test/import.%.out
333

    
334
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
335

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

    
338
test: _always $(testOutputs) ;
339

    
340
all += $(testOutputs)
341

    
342
# Accepts a test output: make <test_output_path>-ok
343
%-ok: _always
344
	$(CP) $* $(call testRef,$*)
345

    
346
##### Input-type-specific
347

    
348
# Each input type needs var $(mapEnv) and targets install, uninstall
349

    
350
#### DB export
351

    
352
ifneq ($(dbExport),)
353

    
354
dbEngineExt := $(subst .,,$(suffix $(basename $(notdir $(dbExport)))))
355
db := $(datasrc)
356

    
357
### Installation
358

    
359
install: _always db ;
360

    
361
uninstall: _always rm_db ;
362

    
363
### DB-engine-specific
364

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

    
367
ifeq ($(dbEngineExt),my)
368

    
369
dbEngine := MySQL
370

    
371
bienPassword := $(shell cat $(root)/config/bien_password)
372
mysqlAs = mysql --user=$(1) --password='$(bienPassword)'
373
mysqlAsRoot := $(call mysqlAs,root)
374
dbAsBien := $(call mysqlAs,bien)
375

    
376
dbExists = $(shell echo "SHOW DATABASES LIKE '$(db)';"|$(mysqlAsRoot))
377

    
378
define createDb
379
echo "CREATE DATABASE $(db) DEFAULT CHARACTER SET latin1;"|$(mysqlAsRoot)
380
-$(mysqlAsRoot) --database=$(db) <$<
381
endef
382
# ignore errors in db import so that GRANT will still be run
383

    
384
db: $(dbExport) _always
385
	$(if $(dbExists),,$(createDb))
386
	echo "GRANT SELECT ON $(db).* TO 'bien'@'localhost';"|$(mysqlAsRoot)
387

    
388
rm_db: _always
389
	-echo "REVOKE ALL ON $(db).* FROM 'bien'@'localhost';"|$(mysqlAsRoot)
390
	echo "DROP DATABASE IF EXISTS $(db);"|$(mysqlAsRoot)
391
# ignore errors if grant not defined
392

    
393
## Unrecognized DB engine
394

    
395
else
396
$(error The DB filename $(dbExport) must be db.my.sql)
397
endif
398

    
399
### Other input types
400

    
401
else
402

    
403
install: _always ;
404
uninstall: _always ;
405

    
406
endif
407

    
408
#### DB connection info
409

    
410
ifneq ($(dbEngine),)
411
# Must come after dbEngine is set
412
mapEnv := in_engine=$(dbEngine) in_database=$(db)
413
endif
(2-2/2)