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
srcRoots := $(srcMaps:maps/src.%.csv=$(mappings)/roots/%.sh)
112

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

    
120
# Look up via in src maps' roots
121
ifeq ($(via),)
122
ifneq ($(srcRoots),)
123
via := $(firstword $(sort\
124
$(shell $(SED) -n 's/^export out_root="([0-9A-Za-z_-]+).*$$/\1/p' $(srcRoots))))
125
endif
126
endif
127

    
128
coreMap := $(mappings)/$(via)-VegBIEN.%.csv
129
coreSelfMap := $(mappings)/$(via).self.%.csv
130

    
131
viaMaps := $(wildcard $(tablesSort:%=maps/$(via).%.csv))
132
viaMaps += $(filter-out $(viaMaps),$(srcMaps:maps/src.%=maps/$(via).%))
133
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard maps/$(via).*.csv))
134

    
135
autogenMaps := $(subst $(via).,VegBIEN.,$(viaMaps))
136
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
137
$(wildcard maps/VegBIEN.*.csv))
138
tables := $(directMaps:maps/VegBIEN.%.csv=%)
139

    
140
##### Sources
141

    
142
srcs = $(shell $(bin)/sort_filenames $(wildcard $(exts:%=src/*.$*.%)))
143
isCsv = $(if $(srcs),$(if $(filter %.xml,$(srcs)),,1))
144
    # true if $(srcs) non-empty and contains no *.xml
145
catSrcs = $(bin)/cat$(if $(isCsv),_csv) $(srcs)
146
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
147

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

    
151
cat-%: _always
152
	$(catSrcs)
153

    
154
##### Installation
155

    
156
install: _always import/install ;
157

    
158
uninstall: _always import/uninstall ;
159

    
160
reinstall: _always uninstall install ;
161

    
162
##### Staging tables
163

    
164
import/install: _always import/schema $(addprefix import/install-,$(tables)) ;
165

    
166
import/uninstall: _always import/rm_schema ;
167
# rm_schema will also drop all staging tables
168

    
169
import/schema: _always
170
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
171
# ignore errors if schema exists
172

    
173
import/rm_schema: _always
174
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
175

    
176
import/install-%: _always
177
	$(if $(isCsv),$(import_install_))
178
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
179
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs)\
180
$(if $(log),$(if $(quiet),&>,2>&1|tee )import/install-$*.log.sql))
181

    
182
##### Maps building
183

    
184
# Maps to (try to) build are added to one of these
185
maps :=
186
createOnlyMaps :=
187

    
188
srcRoot = $(mappings)/roots/$*.sh
189
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
190

    
191
# Src maps cleanup
192
ifneq ($(filter maps/.%.last_cleanup,$(MAKECMDGOALS)),)
193
maps/.src.%.csv.last_cleanup: maps/src.%.csv
194
	$(bin)/in_place $< $(bin)/cols +
195
	touch $@
196
else
197
# Autogen src maps with known table names
198
maps/src.%.csv: _always
199
	$(if $(wildcard $@),,$(if $(isCsv),$(mkSrcMap)))
200
	+$(if $(isCsv),$(selfMake) $(@:maps/%=maps/.%.last_cleanup))
201
# only build if doesn't exist
202
# only build if CSV srcs exist for that table name
203
endif
204

    
205
# Try all table names
206
createOnlyMaps += $(tablesSort:%=maps/src.%.csv)
207

    
208
# Must come before $(root)/% to override it
209
$(coreSelfMap): _always
210
	-+$(subMake)
211
# ignore errors if $(coreSelfMap) does not exist
212

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

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

    
220
# Must come before maps/$(via).%.csv to override it
221
maps/$(via).%.full.csv: maps/$(via).%.csv $(coreSelfMap) $(srcMap)
222
	$(makeFullCsv)
223
	$(joinSrcMap)
224
maps += $(patsubst maps/%.csv,maps/%.full.csv,$(viaMaps))
225

    
226
# Via maps cleanup
227
ifneq ($(filter maps/.%.last_cleanup,$(MAKECMDGOALS)),)
228
maps/.$(via).%.csv.last_cleanup: maps/$(via).%.csv $(coreMap)
229
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
230
	touch $@
231
# Include comment column so commented mappings are never removed
232
else
233
maps/$(via).%.csv: maps/src.%.csv _always
234
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
235
	+$(selfMake) $(@:maps/%=maps/.%.last_cleanup)
236
endif
237

    
238
maps/VegBIEN.%.csv: maps/$(via).%.full.csv $(coreMap)
239
	$(bin)/join <$+|$(bin)/sort_map >$@
240
maps += $(autogenMaps)
241

    
242
maps: $(createOnlyMaps) $(maps) _always ;
243

    
244
all += $(maps)
245

    
246
##### Maps validation
247

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

    
252
include $(root)/lib/mappings.Makefile
253

    
254
##### External dependencies
255

    
256
$(root)/%: _always
257
	+$(subMake)
258
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
259

    
260
##### Mapping
261

    
262
+maps = $(filter maps/% $(mappings)/%,$(+_))
263
<in = $(firstword $(filter-out $(+maps),$(+_)))
264
map = $(if $(<in),<$(<in),\
265
$(if $(srcs),$(withCatSrcs),\
266
$(if $(mapEnv),env $(mapEnv),\
267
$(error No input file src/*.$*.{$(exts)}))))\
268
$(root)/map $(+maps)
269
map2db = $(if $(use_staged),env in_database=vegbien in_schema=$(datasrc)\
270
in_table=$*) env out_database=vegbien $(map)
271

    
272
##### Import to VegBIEN
273

    
274
ifneq ($(inputFiles),)
275

    
276
profileTest = $(if $(profile),$(if $(test),1))
277
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
278
$(bin)/profile_stats /dev/fd/0
279

    
280
log_ = import/$*$(if $(n),.n=$(n),).$(date).log.sql
281
trace = $(log_:.log.sql=.trace)
282
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
283
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
284
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
285
# don't abort on import errors, which often relate to invalid input data
286

    
287
import: $(addprefix import-,$(tables)) _always ;
288

    
289
import-%: maps/VegBIEN.%.csv _always
290
	$(import)
291
# default:
292
import-%: _always ;
293

    
294
else
295
import: _always ;
296
endif
297

    
298
##### Log files from import
299

    
300
logs := $(wildcard import/*.log.sql import/*.trace)
301

    
302
rm_logs: _always
303
	$(RM) $(logs)
304

    
305
##### Verification of import
306

    
307
verify: $(addprefix verify-,$(tables)) _always ;
308

    
309
verify-%: verify/%.ref verify/%.out _always
310
	-$(diffVerbose) $(+_)
311
# don't abort on verification errors, which are expected during development
312
# default:
313
verify-%: verify/%.out _always
314
	$(if $(shell test -e $< && echo t),cat $<)
315
# don't run if verify/%.out's default do-nothing action was used
316
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
317

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

    
321
verify/%.out: $(mappings)/verify.%.sql _always
322
	$(verify)
323
# default:
324
verify/%.out: _always ;
325

    
326
all += $(wildcard verify/*.out)
327

    
328
##### Editing import
329

    
330
import/rotate: _always
331
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
332
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
333

    
334
import/rm: _always
335
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
336
$(psqlAsBien)
337

    
338
##### Testing
339

    
340
testRefOutput = $(subst .2-step,,$(subst .staging,,$(1)))
341
testRef = $(testRefOutput).ref
342
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
343
# filter returns non-empty if they are equal
344

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

    
365
test2Db = $(call runTest,$(map2db))
366

    
367
tests :=
368

    
369
test/import.%.xml: maps/VegBIEN.%.csv _always
370
	$(test2Db)
371
tests += test/import.%.xml
372

    
373
testStaged2Db = $(foreach use_staged,1,$(test2Db))
374
    # run with use_staged=1
375

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

    
383
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
384

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

    
387
test: _always $(testOutputs) ;
388

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

    
391
# Accepts a test output: make <test_output_path>-ok
392
%-ok: _always
393
	$(CP) $* $(call testRef,$*)
394

    
395
test/accept-all: _always
396
	+yes|$(selfMake) test
397

    
398
##### Documentation
399

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

    
403
import/steps.by_col.sql: _always
404
	+$(steps)
(4-4/4)