Project

General

Profile

1
selfDir_uZPPqC := $(dir $(lastword $(MAKEFILE_LIST)))
2
root := $(selfDir_uZPPqC)..
3
include $(root)/lib/common.Makefile
4

    
5

    
6
##### Configuration
7

    
8
# Command line
9
log ?= $(if $(test),,1)
10
profile ?=
11
quiet ?=
12
reverify ?= 1
13
use_staged ?= $(by_col)
14

    
15
# Makefile
16
tablesSort ?= plots organisms stems specimens
17
exts ?= csv tsv txt xml
18
test_n ?= 2
19

    
20
##### Vars/functions
21

    
22
# Paths
23
datasrc := $(notdir $(realpath .))
24
bin := $(root)/bin
25
mappings := $(root)/mappings
26

    
27
# Make
28
SHELL := /bin/bash
29
selfMake = $(MAKE) --makefile=../input.Makefile
30
subMake = $(MAKE) $(@:$(root)/%=%) --directory=$(root)
31
+_ = $(+:_%=)
32
addBeforeExt = $(basename $(2))$(1)$(suffix $(2))
33

    
34
# OS
35
os := $(shell uname)
36
forOs = $(patsubst %,%-$(filter Linux Darwin,$(os)),$(1))
37

    
38
# Formatting
39
SED = sed -$(if $(filter Darwin,$(os)),E,r)
40

    
41
# System
42
date = $(shell date +"%Y-%m-%d-%H-%M-%S")
43

    
44
# Terminal
45
termCols := $(shell tput cols)
46
esc := '['
47
reset := $(esc)'0m'
48
emph := $(esc)'7m '
49
endEmph := ' '$(reset)
50

    
51
# Commands
52
MKDIR = mkdir -p
53
mkdir = $(MKDIR) $(@D)
54
CP = cp -p
55
diff = diff --unified=2
56
diffIgnoreSpace = $(diff) --ignore-space-change
57
diffVerbose = $(if $(verbose),diff --side-by-side --left-column\
58
--width=$(termCols),$(diff))
59

    
60
# BIEN commands
61
selfMap = $(bin)/cols 0 0
62
psqlOpts := --set ON_ERROR_STOP=1 --quiet
63
psqlAsBien := $(bin)/psql_vegbien $(psqlOpts)
64

    
65
# SVN
66
addDir = $(if $(wildcard $(1)/),svn add --depth=empty $(1),svn mkdir $(1))
67
setSvnIgnore = svn propset svn:ignore $(2) $(1)
68
define addDirWithIgnore
69
$(addDir)
70
$(setSvnIgnore)
71
endef
72

    
73
##### General targets
74

    
75
all: _always maps ;
76

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

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

    
84
make_script = ./$< >$@
85

    
86
%/: % _always ;
87

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

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

    
96
##### SVN
97

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

    
106
##### Existing maps discovery
107

    
108
inputFiles := $(wildcard $(exts:%=src/*.%))
109

    
110
srcMaps := $(wildcard maps/src.*.csv)
111

    
112
srcMap := maps/src.%.csv
113
fullViaMap := maps/%.full.csv
114
directMap := maps/VegBIEN.%.csv
115
via := Veg+
116

    
117
coreMap := $(mappings)/$(via)-VegBIEN.csv
118
coreSelfMap := $(mappings)/$(via).self.csv
119

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

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

    
129
##### Sources
130

    
131
srcs = $(shell $(bin)/sort_filenames $(wildcard $(exts:%=src/*.$*.%)))
132
isCsv = $(if $(srcs),$(if $(filter %.xml,$(srcs)),,1))
133
    # true if $(srcs) non-empty and contains no *.xml
134
catSrcs = $(bin)/cat$(if $(isCsv),_csv) $(srcs)
135
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
136

    
137
# Usage: `make {--silent|-s} inputs/<datasrc>/cat` (don't echo make commands)
138
cat: $(addprefix cat-,$(tables)) _always ;
139

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

    
143
##### Installation
144

    
145
install: _always import/install ;
146

    
147
uninstall: _always import/uninstall ;
148

    
149
reinstall: _always uninstall install ;
150

    
151
##### Staging tables
152

    
153
import/install: _always import/schema $(addprefix import/install-,$(tables)) ;
154

    
155
import/uninstall: _always import/rm_schema ;
156
# rm_schema will also drop all staging tables
157

    
158
import/schema: _always
159
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
160
# ignore errors if schema exists
161

    
162
import/rm_schema: _always
163
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
164

    
165
import/install-%: _always
166
	$(if $(isCsv),$(import_install_))
167
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
168
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs)\
169
$(if $(log),$(if $(quiet),&>,2>&1|tee )import/install-$*.log.sql))
170

    
171
##### Maps building
172

    
173
# Maps to (try to) build are added to one of these
174
maps :=
175
createOnlyMaps :=
176

    
177
srcRoot = $(mappings)/roots/$*.sh
178
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
179

    
180
# Src maps cleanup
181
ifneq ($(filter maps/.%.last_cleanup,$(MAKECMDGOALS)),)
182
maps/.src.%.csv.last_cleanup: maps/src.%.csv
183
	$(bin)/in_place $< $(bin)/cols +
184
	touch $@
185
else
186
# Autogen src maps with known table names
187
maps/src.%.csv: _always
188
	$(if $(wildcard $@),,$(if $(isCsv),$(mkSrcMap)))
189
	+$(if $(isCsv),$(selfMake) $(@:maps/%=maps/.%.last_cleanup))
190
# only build if doesn't exist
191
# only build if CSV srcs exist for that table name
192
endif
193

    
194
# Try all table names
195
createOnlyMaps += $(tablesSort:%=maps/src.%.csv)
196

    
197
# Must come before $(root)/% to override it
198
$(coreSelfMap): _always
199
	-+$(subMake)
200
# ignore errors if $(coreSelfMap) does not exist
201

    
202
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(word 3,$+) 0)
203
hasSrc = $(shell test -s $(word 3,$+) && echo t)
204

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

    
209
# Must come before maps/$(via).%.csv to override it
210
maps/$(via).%.full.csv: maps/$(via).%.csv $(coreSelfMap) $(srcMap)
211
	$(makeFullCsv)
212
	$(joinSrcMap)
213
maps += $(patsubst maps/%.csv,maps/%.full.csv,$(viaMaps))
214

    
215
# Via maps cleanup
216
ifneq ($(filter maps/.%.last_cleanup,$(MAKECMDGOALS)),)
217
maps/.$(via).%.csv.last_cleanup: maps/$(via).%.csv $(coreMap)
218
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
219
	touch $@
220
# Include comment column so commented mappings are never removed
221
else
222
maps/$(via).%.csv: maps/src.%.csv _always
223
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
224
	+$(selfMake) $(@:maps/%=maps/.%.last_cleanup)
225
endif
226

    
227
maps/VegBIEN.%.csv: maps/$(via).%.full.csv $(coreMap)
228
	$(bin)/join <$+|$(bin)/sort_map >$@
229
maps += $(autogenMaps)
230

    
231
maps: $(createOnlyMaps) $(maps) _always ;
232

    
233
all += $(maps)
234

    
235
##### Maps validation
236

    
237
missingMappingsCmd = +$(selfMake) remake 2>&1\
238
|$(SED) -n 's/^.*No $(*2Space) mapping for (.*)$$/\1/p'|$(SED) 's/\/_.*//'\
239
$(if $(filter non-empty_join,$*),|$(bin)/ucase_first 0)|sort|uniq
240

    
241
include $(root)/lib/mappings.Makefile
242

    
243
##### External dependencies
244

    
245
$(root)/%: _always
246
	+$(subMake)
247
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
248

    
249
##### Mapping
250

    
251
+maps = $(filter maps/% $(mappings)/%,$(+_))
252
<in = $(firstword $(filter-out $(+maps),$(+_)))
253
map = $(if $(<in),<$(<in),\
254
$(if $(srcs),$(withCatSrcs),\
255
$(if $(mapEnv),env $(mapEnv),\
256
$(error No input file src/*.$*.{$(exts)}))))\
257
$(root)/map $(+maps)
258
map2db = $(if $(use_staged),env in_database=vegbien in_schema=$(datasrc)\
259
in_table=$*) env out_database=vegbien $(map)
260

    
261
##### Import to VegBIEN
262

    
263
ifneq ($(inputFiles),)
264

    
265
profileTest = $(if $(profile),$(if $(test),1))
266
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
267
$(bin)/profile_stats /dev/fd/0
268

    
269
log_ = import/$*$(if $(n),.n=$(n),).$(date).log.sql
270
trace = $(log_:.log.sql=.trace)
271
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
272
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
273
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
274
# don't abort on import errors, which often relate to invalid input data
275

    
276
import: $(addprefix import-,$(tables)) _always ;
277

    
278
import-%: maps/VegBIEN.%.csv _always
279
	$(import)
280
# default:
281
import-%: _always ;
282

    
283
else
284
import: _always ;
285
endif
286

    
287
##### Log files from import
288

    
289
logs := $(wildcard import/*.log.sql import/*.trace)
290

    
291
rm_logs: _always
292
	$(RM) $(logs)
293

    
294
##### Verification of import
295

    
296
verify: $(addprefix verify-,$(tables)) _always ;
297

    
298
verify-%: verify/%.ref verify/%.out _always
299
	-$(diffVerbose) $(+_)
300
# don't abort on verification errors, which are expected during development
301
# default:
302
verify-%: verify/%.out _always
303
	$(if $(shell test -e $< && echo t),cat $<)
304
# don't run if verify/%.out's default do-nothing action was used
305
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
306

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

    
310
verify/%.out: $(mappings)/verify.%.sql _always
311
	$(verify)
312
# default:
313
verify/%.out: _always ;
314

    
315
all += $(wildcard verify/*.out)
316

    
317
##### Editing import
318

    
319
import/rotate: _always
320
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
321
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
322

    
323
import/rm: _always
324
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
325
$(psqlAsBien)
326

    
327
##### Testing
328

    
329
testRefOutput = $(subst .2-step,,$(subst .staging,,$(1)))
330
testRef = $(testRefOutput).ref
331
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
332
# filter returns non-empty if they are equal
333

    
334
define runTest
335
@echo "Testing $(abspath $@)..."
336
>$@ env test=1 n=$(test_n) $(1)
337
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 || { e=$$?;\
338
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
339
$(if $(hasOwnRef),\
340
{\
341
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
342
if test "$$REPLY" = y; then\
343
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
344
exit 0;\
345
fi;\
346
};,\
347
echo $(emph)"Note: The preceding failed test is compared to another test's\
348
output"$(endEmph);\
349
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
350
)\
351
exit $$e;}
352
endef
353

    
354
test2Db = $(call runTest,$(map2db))
355

    
356
tests :=
357

    
358
test/import.%.xml: maps/VegBIEN.%.csv _always
359
	$(test2Db)
360
tests += test/import.%.xml
361

    
362
testStaged2Db = $(foreach use_staged,1,$(test2Db))
363
    # run with use_staged=1
364

    
365
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
366
test/import.%.staging.xml: maps/VegBIEN.%.csv _always
367
	-$(if $(isCsv),$(testStaged2Db),cp -p $(@:.staging.xml=.xml) $@)
368
# Don't abort tester if only staging test fails, in case staging table missing
369
# Non-flat-file inputs fall back to mimicking a successful test
370
tests += test/import.%.staging.xml
371

    
372
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
373

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

    
376
test: _always $(testOutputs) ;
377

    
378
all += $(filter-out %.ref,$(wildcard test/*))
379

    
380
# Accepts a test output: make <test_output_path>-ok
381
%-ok: _always
382
	$(CP) $* $(call testRef,$*)
383

    
384
test/accept-all: _always
385
	+yes|$(selfMake) test
386

    
387
##### Documentation
388

    
389
steps = $(selfMake) -s import test=1 by_col=1 verbosity=2 n=100\
390
2>&1|$(bin)/debug2redmine >$@
391

    
392
import/steps.by_col.sql: _always
393
	+$(steps)
(4-4/4)