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 ?= 0.plots 1.organisms 2.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 addDirWithIgnore,src,'*')
100
	$(call addDirWithIgnore,src/specimens,'*')
101
	$(call addDirWithIgnore,src/specimens/logs,$$'*.log.sql\n*.trace')
102
	$(call addDirWithIgnore,verify,'*.out')
103

    
104
##### Existing maps discovery
105

    
106
srcMaps := $(wildcard src/*/src.csv)
107

    
108
srcMap := src/%/src.csv
109
viaMap := src/%/map.csv
110
fullViaMap := src/%/map.full.csv
111
directMap := src/%/VegBIEN.csv
112
anyMap := $(srcMap) $(viaMap) $(fullViaMap) $(directMap)
113

    
114
anyTest = src/$*/test.%
115
srcsOnly = $(filter-out $(anyMap) $(anyTest) src/%/logs,$(1))
116

    
117
via := Veg+
118

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

    
122
viaMaps := $(wildcard $(tablesSort:%=src/%/map.csv))
123
viaMaps += $(filter-out $(viaMaps),$(srcMaps:src/%/src.csv=src/%/map.csv))
124
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard src/*/map.csv))
125

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

    
131
##### Sources
132

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

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

    
142
cat-%: _always
143
	$(catSrcs)
144

    
145
##### Staging tables installation
146

    
147
install: _always schema $(addprefix install-,$(tables)) ;
148

    
149
uninstall: _always rm_schema ;
150
# rm_schema will also drop all staging tables
151

    
152
reinstall: _always uninstall install ;
153

    
154
schema: _always
155
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
156
# ignore errors if schema exists
157

    
158
rm_schema: _always
159
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
160

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

    
167
##### Maps building
168

    
169
# Maps to (try to) build are added to one of these
170
maps :=
171
createOnlyMaps :=
172

    
173
srcRoot = $(mappings)/roots/$*.sh
174
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
175

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

    
190
# Try all table names
191
createOnlyMaps += $(tablesSort:%=src/%/src.csv)
192

    
193
# Must come before $(root)/% to override it
194
$(coreSelfMap): _always
195
	-+$(subMake)
196
# ignore errors if $(coreSelfMap) does not exist
197

    
198
# Via maps cleanup
199
ifneq ($(filter src/%/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
200
src/%/.map.csv.last_cleanup: src/%/map.csv $(coreMap)
201
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
202
	touch $@
203
# Include comment column so commented mappings are never removed
204
else
205
src/%/map.csv: src/%/src.csv _always
206
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
207
	+$(selfMake) $(@:src/%/map.csv=src/%/.map.csv.last_cleanup)
208
endif
209

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

    
213
makeFullCsv = env ignore=1 $(bin)/union <$(wordlist 1,2,$+)|$(bin)/sort_map >$@
214

    
215
src/%/map.full.csv: src/%/map.csv $(coreSelfMap) $(srcMap)
216
	$(makeFullCsv)
217
	$(joinSrcMap)
218
maps += $(patsubst src/%/map.csv,src/%/map.full.csv,$(viaMaps))
219

    
220
src/%/VegBIEN.csv: src/%/map.full.csv $(coreMap)
221
	$(bin)/join <$+|$(bin)/sort_map >$@
222
maps += $(autogenMaps)
223

    
224
maps: $(createOnlyMaps) $(maps) _always ;
225

    
226
all += $(maps)
227

    
228
##### Maps validation
229

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

    
234
include $(root)/lib/mappings.Makefile
235

    
236
##### External dependencies
237

    
238
$(root)/%: _always
239
	+$(subMake)
240
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
241

    
242
##### Mapping
243

    
244
+maps = $(filter src/%/map.csv src/%/VegBIEN.csv $(mappings)/%,$(+_))
245
map = $(if $(srcs),$(withCatSrcs) $(root)/map $(+maps),\
246
$(shell echo Warning: No input file src/$*/*.{$(exts)} >&2)false)
247
# need false to run some command, when prefixed by `env ...` below
248
map2db = $(if $(use_staged),env in_database=vegbien in_schema=$(datasrc)\
249
in_table=$*) env out_database=vegbien $(map)
250

    
251
##### Import to VegBIEN
252

    
253
profileTest = $(if $(profile),$(if $(test),1))
254
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
255
$(bin)/profile_stats /dev/fd/0
256

    
257
log_ = src/$*/logs/$(if $(n),n=$(n).,)$(date).log.sql
258
trace = $(log_:.log.sql=.trace)
259
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
260
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
261
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
262
# don't abort on import errors, which often relate to invalid input data
263

    
264
import: $(addprefix import-,$(tables)) _always ;
265

    
266
import-%: src/%/VegBIEN.csv _always
267
	$(import)
268
# default:
269
import-%: _always ;
270

    
271
##### Log files from import
272

    
273
logs := $(wildcard src/*/logs/*.log.sql src/*/logs/*.trace)
274

    
275
rm_logs: _always
276
	$(RM) $(logs)
277

    
278
##### Verification of import
279

    
280
verify: $(addprefix verify-,$(tables)) _always ;
281

    
282
verify-%: verify/%.ref verify/%.out _always
283
	-$(diffVerbose) $(+_)
284
# don't abort on verification errors, which are expected during development
285
# default:
286
verify-%: verify/%.out _always
287
	$(if $(shell test -e $< && echo t),cat $<)
288
# don't run if verify/%.out's default do-nothing action was used
289
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
290

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

    
294
verify/%.out: $(mappings)/verify.%.sql _always
295
	$(verify)
296
# default:
297
verify/%.out: _always ;
298

    
299
all += $(wildcard verify/*.out)
300

    
301
##### Editing import
302

    
303
rotate: _always
304
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
305
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
306

    
307
rm: _always
308
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
309
$(psqlAsBien)
310

    
311
##### Testing
312

    
313
testRefOutput = $(subst .2-step,,$(subst .staging,,$(1)))
314
testRef = $(testRefOutput).ref
315
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
316
# filter returns non-empty if they are equal
317

    
318
define runTest
319
@echo "Testing $(abspath $@)..."
320
>$@ env test=1 n=$(test_n) $(1)
321
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 || { e=$$?;\
322
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
323
$(if $(hasOwnRef),\
324
{\
325
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
326
if test "$$REPLY" = y; then\
327
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
328
exit 0;\
329
fi;\
330
};,\
331
echo $(emph)"Note: The preceding failed test is compared to another test's\
332
output"$(endEmph);\
333
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
334
)\
335
exit $$e;}
336
endef
337

    
338
test2Db = $(call runTest,$(map2db))
339

    
340
tests :=
341

    
342
src/%/test.xml: src/%/VegBIEN.csv _always
343
	$(test2Db)
344
tests += src/%/test.xml
345

    
346
testStaged2Db = $(foreach use_staged,1,$(test2Db))
347
    # run with use_staged=1
348

    
349
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
350
src/%/test.staging.xml: src/%/VegBIEN.csv _always
351
	-$(if $(isCsv),$(testStaged2Db),cp -p $(@:.staging.xml=.xml) $@)
352
# Don't abort tester if only staging test fails, in case staging table missing
353
# Non-flat-file inputs fall back to mimicking a successful test
354
tests += src/%/test.staging.xml
355

    
356
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
357

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

    
360
test: _always $(testOutputs) ;
361

    
362
all += $(wildcard src/%/test*.xml)
363

    
364
# Accepts a test output: make <test_output_path>-ok
365
%-ok: _always
366
	$(CP) $* $(call testRef,$*)
367

    
368
accept-all: _always
369
	+yes|$(selfMake) test
370

    
371
##### Documentation
372

    
373
steps = $(selfMake) -s import-$* test=1 by_col=1 verbosity=2 n=100\
374
2>&1|$(bin)/debug2redmine >$@
375

    
376
src/%/logs/steps.by_col.log.sql: _always
377
	+$(steps)
(4-4/4)