Project

General

Profile

1 3761 aaronmk
selfDir_uZPPqC := $(dir $(lastword $(MAKEFILE_LIST)))
2
root := $(selfDir_uZPPqC)..
3
include $(root)/lib/common.Makefile
4
5
6 783 aaronmk
##### Configuration
7
8 1921 aaronmk
# Command line
9 1190 aaronmk
log ?= $(if $(test),,1)
10 1257 aaronmk
profile ?=
11 1983 aaronmk
quiet ?=
12 1620 aaronmk
reverify ?= 1
13 1990 aaronmk
use_staged ?= $(by_col)
14 1921 aaronmk
15
# Makefile
16 4110 aaronmk
tablesSort ?= 0.plots 1.organisms 2.stems specimens
17 1386 aaronmk
exts ?= csv tsv txt xml
18 783 aaronmk
test_n ?= 2
19
20
##### Vars/functions
21
22 1821 aaronmk
# Paths
23
datasrc := $(notdir $(realpath .))
24
bin := $(root)/bin
25
mappings := $(root)/mappings
26
27 368 aaronmk
# Make
28 640 aaronmk
SHELL := /bin/bash
29 1509 aaronmk
selfMake = $(MAKE) --makefile=../input.Makefile
30 1821 aaronmk
subMake = $(MAKE) $(@:$(root)/%=%) --directory=$(root)
31 404 aaronmk
+_ = $(+:_%=)
32 368 aaronmk
addBeforeExt = $(basename $(2))$(1)$(suffix $(2))
33
34 1742 aaronmk
# 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 790 aaronmk
# System
42
date = $(shell date +"%Y-%m-%d-%H-%M-%S")
43
44 640 aaronmk
# Terminal
45 1184 aaronmk
termCols := $(shell tput cols)
46 640 aaronmk
esc := '['
47
reset := $(esc)'0m'
48
emph := $(esc)'7m '
49
endEmph := ' '$(reset)
50
51 368 aaronmk
# Commands
52 1245 aaronmk
MKDIR = mkdir -p
53
mkdir = $(MKDIR) $(@D)
54 395 aaronmk
CP = cp -p
55 1184 aaronmk
diff = diff --unified=2
56 3721 aaronmk
diffIgnoreSpace = $(diff) --ignore-space-change
57 1184 aaronmk
diffVerbose = $(if $(verbose),diff --side-by-side --left-column\
58
--width=$(termCols),$(diff))
59 368 aaronmk
60 1918 aaronmk
# BIEN commands
61 1524 aaronmk
selfMap = $(bin)/cols 0 0
62 1081 aaronmk
psqlOpts := --set ON_ERROR_STOP=1 --quiet
63 1289 aaronmk
psqlAsBien := $(bin)/psql_vegbien $(psqlOpts)
64 353 aaronmk
65 1594 aaronmk
# SVN
66
addDir = $(if $(wildcard $(1)/),svn add --depth=empty $(1),svn mkdir $(1))
67 1771 aaronmk
setSvnIgnore = svn propset svn:ignore $(2) $(1)
68 1594 aaronmk
define addDirWithIgnore
69
$(addDir)
70 1771 aaronmk
$(setSvnIgnore)
71 1594 aaronmk
endef
72
73 783 aaronmk
##### General targets
74 250 aaronmk
75 418 aaronmk
all: _always maps ;
76 247 aaronmk
77 383 aaronmk
clean: _always
78 256 aaronmk
	$(RM) $(all)
79
80 1742 aaronmk
remake: _always clean
81
	+$(selfMake)
82
# re-run make so that cache of existing files is reset
83
84 1627 aaronmk
make_script = ./$< >$@
85 368 aaronmk
86 1604 aaronmk
%/: % _always ;
87
88 1627 aaronmk
# Must come before `%: %.make` to override it
89
src/%: src/%.make _always
90 3317 aaronmk
	(set -x; $(make_script)) 2>>$<.log.sql
91 1627 aaronmk
.PRECIOUS: src/% # save partial outputs of aborted src make scripts
92
93
%: %.make _always
94
	$(make_script)
95
96 783 aaronmk
##### SVN
97 250 aaronmk
98 1594 aaronmk
add: _always
99 1771 aaronmk
	$(call setSvnIgnore,.,$$'')
100 1594 aaronmk
	$(call addDirWithIgnore,src,$$'*')
101
	$(call addDirWithIgnore,maps,$$'.~*')
102
	$(call addDirWithIgnore,import,$$'*')
103
	$(call addDirWithIgnore,test,$$'*.out\n*.xml')
104
	$(call addDirWithIgnore,verify,$$'*.out')
105 766 aaronmk
106 1969 aaronmk
##### Existing maps discovery
107 1955 aaronmk
108 4118 aaronmk
srcMaps := $(wildcard src/*/src.csv)
109 1955 aaronmk
110 4118 aaronmk
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 3574 aaronmk
116 4120 aaronmk
anyTest = src/$*/test.%
117
srcsOnly = $(filter-out $(anyMap) $(anyTest),$(1))
118
119 4095 aaronmk
via := Veg+
120 783 aaronmk
121 4098 aaronmk
coreMap := $(mappings)/$(via)-VegBIEN.csv
122
coreSelfMap := $(mappings)/$(via).self.csv
123 783 aaronmk
124 4118 aaronmk
viaMaps := $(wildcard $(tablesSort:%=src/%/map.csv))
125
viaMaps += $(filter-out $(viaMaps),$(srcMaps:src/%/src.csv=src/%/map.csv))
126
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard src/*/map.csv))
127 783 aaronmk
128 4117 aaronmk
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
129 728 aaronmk
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
130 4118 aaronmk
$(wildcard src/*/VegBIEN.csv))
131
tables := $(directMaps:src/%/VegBIEN.csv=%)
132 728 aaronmk
133 1969 aaronmk
##### Sources
134
135 4118 aaronmk
srcs = $(shell $(bin)/sort_filenames $(call srcsOnly,$(wildcard src/$*/*)))
136 1969 aaronmk
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 1986 aaronmk
# Usage: `make {--silent|-s} inputs/<datasrc>/cat` (don't echo make commands)
142 1969 aaronmk
cat: $(addprefix cat-,$(tables)) _always ;
143
144
cat-%: _always
145
	$(catSrcs)
146
147 4121 aaronmk
##### Staging tables installation
148 1921 aaronmk
149 4121 aaronmk
install: _always schema $(addprefix install-,$(tables)) ;
150 1921 aaronmk
151 4121 aaronmk
uninstall: _always rm_schema ;
152
# rm_schema will also drop all staging tables
153 1921 aaronmk
154
reinstall: _always uninstall install ;
155
156 4121 aaronmk
schema: _always
157 1921 aaronmk
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
158
# ignore errors if schema exists
159
160 4121 aaronmk
rm_schema: _always
161 1921 aaronmk
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
162
163 4121 aaronmk
install-%: _always
164 1955 aaronmk
	$(if $(isCsv),$(import_install_))
165 3476 aaronmk
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
166
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs)\
167 3317 aaronmk
$(if $(log),$(if $(quiet),&>,2>&1|tee )import/install-$*.log.sql))
168 1921 aaronmk
169 1777 aaronmk
##### Maps building
170
171 1789 aaronmk
# Maps to (try to) build are added to one of these
172 1779 aaronmk
maps :=
173 1789 aaronmk
createOnlyMaps :=
174 1779 aaronmk
175 3569 aaronmk
srcRoot = $(mappings)/roots/$*.sh
176
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
177 1779 aaronmk
178 3567 aaronmk
# Src maps cleanup
179 4118 aaronmk
ifneq ($(filter src/%/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
180
src/%/.src.csv.last_cleanup: src/%/src.csv
181 3814 aaronmk
	$(bin)/in_place $< $(bin)/cols +
182 3567 aaronmk
	touch $@
183
else
184 1779 aaronmk
# Autogen src maps with known table names
185 4118 aaronmk
src/%/src.csv: _always
186 3567 aaronmk
	$(if $(wildcard $@),,$(if $(isCsv),$(mkSrcMap)))
187 4118 aaronmk
	+$(if $(isCsv),$(selfMake) $(@:src/%/src.csv=src/%/.map.csv.last_cleanup))
188 3567 aaronmk
# only build if doesn't exist
189 1779 aaronmk
# only build if CSV srcs exist for that table name
190 3567 aaronmk
endif
191
192 1779 aaronmk
# Try all table names
193 4118 aaronmk
createOnlyMaps += $(tablesSort:%=src/%/src.csv)
194 1779 aaronmk
195 1273 aaronmk
# Must come before $(root)/% to override it
196 1524 aaronmk
$(coreSelfMap): _always
197 1273 aaronmk
	-+$(subMake)
198 1524 aaronmk
# ignore errors if $(coreSelfMap) does not exist
199 1273 aaronmk
200 3561 aaronmk
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(word 3,$+) 0)
201
hasSrc = $(shell test -s $(word 3,$+) && echo t)
202 1526 aaronmk
203 1273 aaronmk
makeFullCsv = $(if $(shell test -e $(word 2,$+) && echo t),\
204 3561 aaronmk
env ignore=1 $(bin)/union <$(wordlist 1,2,$+)|,<$< )$(bin)/sort_map >$@
205 1524 aaronmk
# can't use $(wildcard) because it won't recheck file after $(coreSelfMap) runs
206 1273 aaronmk
207 4118 aaronmk
# Must come before src/%/map.csv to override it
208
src/%/map.full.csv: src/%/map.csv $(coreSelfMap) $(srcMap)
209 1273 aaronmk
	$(makeFullCsv)
210 1526 aaronmk
	$(joinSrcMap)
211 4118 aaronmk
maps += $(patsubst src/%/map.csv,src/%/map.full.csv,$(viaMaps))
212 1139 aaronmk
213 3572 aaronmk
# Via maps cleanup
214 4118 aaronmk
ifneq ($(filter src/%/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
215
src/%/.map.csv.last_cleanup: src/%/map.csv $(coreMap)
216 3572 aaronmk
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
217
	touch $@
218
# Include comment column so commented mappings are never removed
219
else
220 4118 aaronmk
src/%/map.csv: src/%/src.csv _always
221 3574 aaronmk
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
222 4118 aaronmk
	+$(selfMake) $(@:src/%/map.csv=src/%/.map.csv.last_cleanup)
223 3572 aaronmk
endif
224
225 4118 aaronmk
src/%/VegBIEN.csv: src/%/map.full.csv $(coreMap)
226 1530 aaronmk
	$(bin)/join <$+|$(bin)/sort_map >$@
227
maps += $(autogenMaps)
228
229 1789 aaronmk
maps: $(createOnlyMaps) $(maps) _always ;
230 1139 aaronmk
231
all += $(maps)
232
233 1742 aaronmk
##### Maps validation
234
235 3764 aaronmk
missingMappingsCmd = +$(selfMake) remake 2>&1\
236 3821 aaronmk
|$(SED) -n 's/^.*No $(*2Space) mapping for (.*)$$/\1/p'|$(SED) 's/\/_.*//'\
237 3764 aaronmk
$(if $(filter non-empty_join,$*),|$(bin)/ucase_first 0)|sort|uniq
238 1742 aaronmk
239 3764 aaronmk
include $(root)/lib/mappings.Makefile
240 1742 aaronmk
241 1509 aaronmk
##### External dependencies
242
243
$(root)/%: _always
244
	+$(subMake)
245 1628 aaronmk
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
246 1509 aaronmk
247 783 aaronmk
##### Mapping
248 368 aaronmk
249 4118 aaronmk
+maps = $(filter src/%/map.csv src/%/VegBIEN.csv $(mappings)/%,$(+_))
250 4106 aaronmk
map = $(if $(srcs),$(withCatSrcs) $(root)/map $(+maps),\
251
$(shell echo Warning: No input file src/$*/*.{$(exts)} >&2)false)
252
# need false to run some command, when prefixed by `env ...` below
253 3387 aaronmk
map2db = $(if $(use_staged),env in_database=vegbien in_schema=$(datasrc)\
254
in_table=$*) env out_database=vegbien $(map)
255 368 aaronmk
256 783 aaronmk
##### Import to VegBIEN
257 772 aaronmk
258 1853 aaronmk
profileTest = $(if $(profile),$(if $(test),1))
259
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
260
$(bin)/profile_stats /dev/fd/0
261
262 3317 aaronmk
log_ = import/$*$(if $(n),.n=$(n),).$(date).log.sql
263
trace = $(log_:.log.sql=.trace)
264 1853 aaronmk
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
265 1190 aaronmk
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
266 3616 aaronmk
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
267 1088 aaronmk
# don't abort on import errors, which often relate to invalid input data
268 624 aaronmk
269 1193 aaronmk
import: $(addprefix import-,$(tables)) _always ;
270 718 aaronmk
271 4118 aaronmk
import-%: src/%/VegBIEN.csv _always
272 718 aaronmk
	$(import)
273 772 aaronmk
# default:
274
import-%: _always ;
275 718 aaronmk
276 790 aaronmk
##### Log files from import
277
278 3317 aaronmk
logs := $(wildcard import/*.log.sql import/*.trace)
279 339 aaronmk
280 383 aaronmk
rm_logs: _always
281 339 aaronmk
	$(RM) $(logs)
282
283 783 aaronmk
##### Verification of import
284 264 aaronmk
285 1194 aaronmk
verify: $(addprefix verify-,$(tables)) _always ;
286
287 1199 aaronmk
verify-%: verify/%.ref verify/%.out _always
288 1184 aaronmk
	-$(diffVerbose) $(+_)
289 1088 aaronmk
# don't abort on verification errors, which are expected during development
290 1194 aaronmk
# default:
291 1199 aaronmk
verify-%: verify/%.out _always
292 1200 aaronmk
	$(if $(shell test -e $< && echo t),cat $<)
293 1199 aaronmk
# don't run if verify/%.out's default do-nothing action was used
294 1200 aaronmk
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
295 368 aaronmk
296 1620 aaronmk
verify = $(if $(reverify),"time" $(psqlAsBien) --set=datasource="'$(datasrc)'"\
297
--no-align --field-separator=$$'\t' --pset=footer=off --pset=null=NULL <$< >$@)
298 514 aaronmk
299 1199 aaronmk
verify/%.out: $(mappings)/verify.%.sql _always
300 1192 aaronmk
	$(verify)
301 1194 aaronmk
# default:
302 1199 aaronmk
verify/%.out: _always ;
303 369 aaronmk
304 1199 aaronmk
all += $(wildcard verify/*.out)
305 1192 aaronmk
306 1667 aaronmk
##### Editing import
307
308 4121 aaronmk
rotate: _always
309 1668 aaronmk
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
310 1854 aaronmk
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
311 1667 aaronmk
312 4121 aaronmk
rm: _always
313 1854 aaronmk
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
314
$(psqlAsBien)
315 1667 aaronmk
316 783 aaronmk
##### Testing
317 368 aaronmk
318 1986 aaronmk
testRefOutput = $(subst .2-step,,$(subst .staging,,$(1)))
319
testRef = $(testRefOutput).ref
320
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
321
# filter returns non-empty if they are equal
322 630 aaronmk
323 897 aaronmk
define runTest
324 776 aaronmk
@echo "Testing $(abspath $@)..."
325 991 aaronmk
>$@ env test=1 n=$(test_n) $(1)
326 3721 aaronmk
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 || { e=$$?;\
327 780 aaronmk
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
328 777 aaronmk
$(if $(hasOwnRef),\
329 3179 aaronmk
{\
330
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
331
if test "$$REPLY" = y; then\
332
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
333
exit 0;\
334
fi;\
335
};,\
336 777 aaronmk
echo $(emph)"Note: The preceding failed test is compared to another test's\
337
output"$(endEmph);\
338
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
339
)\
340 652 aaronmk
exit $$e;}
341 628 aaronmk
endef
342
343 1986 aaronmk
test2Db = $(call runTest,$(map2db))
344 775 aaronmk
345 876 aaronmk
tests :=
346
347 4120 aaronmk
src/%/test.xml: src/%/VegBIEN.csv _always
348 1986 aaronmk
	$(test2Db)
349 4120 aaronmk
tests += src/%/test.xml
350 627 aaronmk
351 1987 aaronmk
testStaged2Db = $(foreach use_staged,1,$(test2Db))
352
    # run with use_staged=1
353 1986 aaronmk
354
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
355 4120 aaronmk
src/%/test.staging.xml: src/%/VegBIEN.csv _always
356 3642 aaronmk
	-$(if $(isCsv),$(testStaged2Db),cp -p $(@:.staging.xml=.xml) $@)
357 1988 aaronmk
# Don't abort tester if only staging test fails, in case staging table missing
358
# Non-flat-file inputs fall back to mimicking a successful test
359 4120 aaronmk
tests += src/%/test.staging.xml
360 1986 aaronmk
361 876 aaronmk
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
362 724 aaronmk
363 1361 aaronmk
.PRECIOUS: $(testOutputs) # save outputs of failed tests so they can be accepted
364
365 876 aaronmk
test: _always $(testOutputs) ;
366
367 4120 aaronmk
all += $(wildcard src/%/test*.xml)
368 876 aaronmk
369 634 aaronmk
# Accepts a test output: make <test_output_path>-ok
370 626 aaronmk
%-ok: _always
371 630 aaronmk
	$(CP) $* $(call testRef,$*)
372 502 aaronmk
373 4120 aaronmk
accept-all: _always
374 3579 aaronmk
	+yes|$(selfMake) test
375
376 3133 aaronmk
##### Documentation
377
378 3590 aaronmk
steps = $(selfMake) -s import test=1 by_col=1 verbosity=2 n=100\
379 3385 aaronmk
2>&1|$(bin)/debug2redmine >$@
380 3188 aaronmk
381 3133 aaronmk
import/steps.by_col.sql: _always
382 3188 aaronmk
	+$(steps)