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 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
srcMaps := $(wildcard src/*/src.csv)
109

    
110
srcMap := src/%/src.csv
111
viaMap := src/%/map.csv
112
fullViaMap := src/%/map.full.csv
113
directMap := src/%/VegBIEN.csv
114
anyMap := $(srcMap) $(viaMap) $(fullViaMap) $(directMap)
115
srcsOnly = $(filter-out $(anyMap),$(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
inputFiles := $(call srcsOnly,$(wildcard $(tablesSort:%=src/%/*)))
127

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

    
133
##### Sources
134

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

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

    
144
cat-%: _always
145
	$(catSrcs)
146

    
147
##### Installation
148

    
149
install: _always import/install ;
150

    
151
uninstall: _always import/uninstall ;
152

    
153
reinstall: _always uninstall install ;
154

    
155
##### Staging tables
156

    
157
import/install: _always import/schema $(addprefix import/install-,$(tables)) ;
158

    
159
import/uninstall: _always import/rm_schema ;
160
# rm_schema will also drop all staging tables
161

    
162
import/schema: _always
163
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
164
# ignore errors if schema exists
165

    
166
import/rm_schema: _always
167
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
168

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

    
175
##### Maps building
176

    
177
# Maps to (try to) build are added to one of these
178
maps :=
179
createOnlyMaps :=
180

    
181
srcRoot = $(mappings)/roots/$*.sh
182
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
183

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

    
198
# Try all table names
199
createOnlyMaps += $(tablesSort:%=src/%/src.csv)
200

    
201
# Must come before $(root)/% to override it
202
$(coreSelfMap): _always
203
	-+$(subMake)
204
# ignore errors if $(coreSelfMap) does not exist
205

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

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

    
213
# Must come before src/%/map.csv to override it
214
src/%/map.full.csv: src/%/map.csv $(coreSelfMap) $(srcMap)
215
	$(makeFullCsv)
216
	$(joinSrcMap)
217
maps += $(patsubst src/%/map.csv,src/%/map.full.csv,$(viaMaps))
218

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

    
231
src/%/VegBIEN.csv: src/%/map.full.csv $(coreMap)
232
	$(bin)/join <$+|$(bin)/sort_map >$@
233
maps += $(autogenMaps)
234

    
235
maps: $(createOnlyMaps) $(maps) _always ;
236

    
237
all += $(maps)
238

    
239
##### Maps validation
240

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

    
245
include $(root)/lib/mappings.Makefile
246

    
247
##### External dependencies
248

    
249
$(root)/%: _always
250
	+$(subMake)
251
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
252

    
253
##### Mapping
254

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

    
262
##### Import to VegBIEN
263

    
264
ifneq ($(inputFiles),)
265

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

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

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

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

    
284
else
285
import: _always ;
286
endif
287

    
288
##### Log files from import
289

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

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

    
295
##### Verification of import
296

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

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

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

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

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

    
318
##### Editing import
319

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

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

    
328
##### Testing
329

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

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

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

    
357
tests :=
358

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

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

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

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

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

    
377
test: _always $(testOutputs) ;
378

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

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

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

    
388
##### Documentation
389

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

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