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
srcsOnly = $(filter-out $(anyMap),$(1))
116 3574 aaronmk
117 4095 aaronmk
via := Veg+
118 783 aaronmk
119 4098 aaronmk
coreMap := $(mappings)/$(via)-VegBIEN.csv
120
coreSelfMap := $(mappings)/$(via).self.csv
121 783 aaronmk
122 4118 aaronmk
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 783 aaronmk
126 4117 aaronmk
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
127 728 aaronmk
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
128 4118 aaronmk
$(wildcard src/*/VegBIEN.csv))
129
tables := $(directMaps:src/%/VegBIEN.csv=%)
130 728 aaronmk
131 1969 aaronmk
##### Sources
132
133 4118 aaronmk
srcs = $(shell $(bin)/sort_filenames $(call srcsOnly,$(wildcard src/$*/*)))
134 1969 aaronmk
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 1986 aaronmk
# Usage: `make {--silent|-s} inputs/<datasrc>/cat` (don't echo make commands)
140 1969 aaronmk
cat: $(addprefix cat-,$(tables)) _always ;
141
142
cat-%: _always
143
	$(catSrcs)
144
145 1921 aaronmk
##### Installation
146
147 4094 aaronmk
install: _always import/install ;
148 1921 aaronmk
149 4094 aaronmk
uninstall: _always import/uninstall ;
150 1921 aaronmk
151
reinstall: _always uninstall install ;
152
153
##### Staging tables
154
155
import/install: _always import/schema $(addprefix import/install-,$(tables)) ;
156
157
import/uninstall: _always import/rm_schema ;
158
# rm_schema will also drop all staging tables
159
160
import/schema: _always
161
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
162
# ignore errors if schema exists
163
164
import/rm_schema: _always
165
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
166
167
import/install-%: _always
168 1955 aaronmk
	$(if $(isCsv),$(import_install_))
169 3476 aaronmk
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
170
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs)\
171 3317 aaronmk
$(if $(log),$(if $(quiet),&>,2>&1|tee )import/install-$*.log.sql))
172 1921 aaronmk
173 1777 aaronmk
##### Maps building
174
175 1789 aaronmk
# Maps to (try to) build are added to one of these
176 1779 aaronmk
maps :=
177 1789 aaronmk
createOnlyMaps :=
178 1779 aaronmk
179 3569 aaronmk
srcRoot = $(mappings)/roots/$*.sh
180
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
181 1779 aaronmk
182 3567 aaronmk
# Src maps cleanup
183 4118 aaronmk
ifneq ($(filter src/%/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
184
src/%/.src.csv.last_cleanup: src/%/src.csv
185 3814 aaronmk
	$(bin)/in_place $< $(bin)/cols +
186 3567 aaronmk
	touch $@
187
else
188 1779 aaronmk
# Autogen src maps with known table names
189 4118 aaronmk
src/%/src.csv: _always
190 3567 aaronmk
	$(if $(wildcard $@),,$(if $(isCsv),$(mkSrcMap)))
191 4118 aaronmk
	+$(if $(isCsv),$(selfMake) $(@:src/%/src.csv=src/%/.map.csv.last_cleanup))
192 3567 aaronmk
# only build if doesn't exist
193 1779 aaronmk
# only build if CSV srcs exist for that table name
194 3567 aaronmk
endif
195
196 1779 aaronmk
# Try all table names
197 4118 aaronmk
createOnlyMaps += $(tablesSort:%=src/%/src.csv)
198 1779 aaronmk
199 1273 aaronmk
# Must come before $(root)/% to override it
200 1524 aaronmk
$(coreSelfMap): _always
201 1273 aaronmk
	-+$(subMake)
202 1524 aaronmk
# ignore errors if $(coreSelfMap) does not exist
203 1273 aaronmk
204 3561 aaronmk
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(word 3,$+) 0)
205
hasSrc = $(shell test -s $(word 3,$+) && echo t)
206 1526 aaronmk
207 1273 aaronmk
makeFullCsv = $(if $(shell test -e $(word 2,$+) && echo t),\
208 3561 aaronmk
env ignore=1 $(bin)/union <$(wordlist 1,2,$+)|,<$< )$(bin)/sort_map >$@
209 1524 aaronmk
# can't use $(wildcard) because it won't recheck file after $(coreSelfMap) runs
210 1273 aaronmk
211 4118 aaronmk
# Must come before src/%/map.csv to override it
212
src/%/map.full.csv: src/%/map.csv $(coreSelfMap) $(srcMap)
213 1273 aaronmk
	$(makeFullCsv)
214 1526 aaronmk
	$(joinSrcMap)
215 4118 aaronmk
maps += $(patsubst src/%/map.csv,src/%/map.full.csv,$(viaMaps))
216 1139 aaronmk
217 3572 aaronmk
# Via maps cleanup
218 4118 aaronmk
ifneq ($(filter src/%/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
219
src/%/.map.csv.last_cleanup: src/%/map.csv $(coreMap)
220 3572 aaronmk
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
221
	touch $@
222
# Include comment column so commented mappings are never removed
223
else
224 4118 aaronmk
src/%/map.csv: src/%/src.csv _always
225 3574 aaronmk
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
226 4118 aaronmk
	+$(selfMake) $(@:src/%/map.csv=src/%/.map.csv.last_cleanup)
227 3572 aaronmk
endif
228
229 4118 aaronmk
src/%/VegBIEN.csv: src/%/map.full.csv $(coreMap)
230 1530 aaronmk
	$(bin)/join <$+|$(bin)/sort_map >$@
231
maps += $(autogenMaps)
232
233 1789 aaronmk
maps: $(createOnlyMaps) $(maps) _always ;
234 1139 aaronmk
235
all += $(maps)
236
237 1742 aaronmk
##### Maps validation
238
239 3764 aaronmk
missingMappingsCmd = +$(selfMake) remake 2>&1\
240 3821 aaronmk
|$(SED) -n 's/^.*No $(*2Space) mapping for (.*)$$/\1/p'|$(SED) 's/\/_.*//'\
241 3764 aaronmk
$(if $(filter non-empty_join,$*),|$(bin)/ucase_first 0)|sort|uniq
242 1742 aaronmk
243 3764 aaronmk
include $(root)/lib/mappings.Makefile
244 1742 aaronmk
245 1509 aaronmk
##### External dependencies
246
247
$(root)/%: _always
248
	+$(subMake)
249 1628 aaronmk
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
250 1509 aaronmk
251 783 aaronmk
##### Mapping
252 368 aaronmk
253 4118 aaronmk
+maps = $(filter src/%/map.csv src/%/VegBIEN.csv $(mappings)/%,$(+_))
254 4106 aaronmk
map = $(if $(srcs),$(withCatSrcs) $(root)/map $(+maps),\
255
$(shell echo Warning: No input file src/$*/*.{$(exts)} >&2)false)
256
# need false to run some command, when prefixed by `env ...` below
257 3387 aaronmk
map2db = $(if $(use_staged),env in_database=vegbien in_schema=$(datasrc)\
258
in_table=$*) env out_database=vegbien $(map)
259 368 aaronmk
260 783 aaronmk
##### Import to VegBIEN
261 772 aaronmk
262 1853 aaronmk
profileTest = $(if $(profile),$(if $(test),1))
263
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
264
$(bin)/profile_stats /dev/fd/0
265
266 3317 aaronmk
log_ = import/$*$(if $(n),.n=$(n),).$(date).log.sql
267
trace = $(log_:.log.sql=.trace)
268 1853 aaronmk
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
269 1190 aaronmk
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
270 3616 aaronmk
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
271 1088 aaronmk
# don't abort on import errors, which often relate to invalid input data
272 624 aaronmk
273 1193 aaronmk
import: $(addprefix import-,$(tables)) _always ;
274 718 aaronmk
275 4118 aaronmk
import-%: src/%/VegBIEN.csv _always
276 718 aaronmk
	$(import)
277 772 aaronmk
# default:
278
import-%: _always ;
279 718 aaronmk
280 790 aaronmk
##### Log files from import
281
282 3317 aaronmk
logs := $(wildcard import/*.log.sql import/*.trace)
283 339 aaronmk
284 383 aaronmk
rm_logs: _always
285 339 aaronmk
	$(RM) $(logs)
286
287 783 aaronmk
##### Verification of import
288 264 aaronmk
289 1194 aaronmk
verify: $(addprefix verify-,$(tables)) _always ;
290
291 1199 aaronmk
verify-%: verify/%.ref verify/%.out _always
292 1184 aaronmk
	-$(diffVerbose) $(+_)
293 1088 aaronmk
# don't abort on verification errors, which are expected during development
294 1194 aaronmk
# default:
295 1199 aaronmk
verify-%: verify/%.out _always
296 1200 aaronmk
	$(if $(shell test -e $< && echo t),cat $<)
297 1199 aaronmk
# don't run if verify/%.out's default do-nothing action was used
298 1200 aaronmk
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
299 368 aaronmk
300 1620 aaronmk
verify = $(if $(reverify),"time" $(psqlAsBien) --set=datasource="'$(datasrc)'"\
301
--no-align --field-separator=$$'\t' --pset=footer=off --pset=null=NULL <$< >$@)
302 514 aaronmk
303 1199 aaronmk
verify/%.out: $(mappings)/verify.%.sql _always
304 1192 aaronmk
	$(verify)
305 1194 aaronmk
# default:
306 1199 aaronmk
verify/%.out: _always ;
307 369 aaronmk
308 1199 aaronmk
all += $(wildcard verify/*.out)
309 1192 aaronmk
310 1667 aaronmk
##### Editing import
311
312
import/rotate: _always
313 1668 aaronmk
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
314 1854 aaronmk
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
315 1667 aaronmk
316
import/rm: _always
317 1854 aaronmk
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
318
$(psqlAsBien)
319 1667 aaronmk
320 783 aaronmk
##### Testing
321 368 aaronmk
322 1986 aaronmk
testRefOutput = $(subst .2-step,,$(subst .staging,,$(1)))
323
testRef = $(testRefOutput).ref
324
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
325
# filter returns non-empty if they are equal
326 630 aaronmk
327 897 aaronmk
define runTest
328 776 aaronmk
@echo "Testing $(abspath $@)..."
329 991 aaronmk
>$@ env test=1 n=$(test_n) $(1)
330 3721 aaronmk
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 || { e=$$?;\
331 780 aaronmk
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
332 777 aaronmk
$(if $(hasOwnRef),\
333 3179 aaronmk
{\
334
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
335
if test "$$REPLY" = y; then\
336
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
337
exit 0;\
338
fi;\
339
};,\
340 777 aaronmk
echo $(emph)"Note: The preceding failed test is compared to another test's\
341
output"$(endEmph);\
342
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
343
)\
344 652 aaronmk
exit $$e;}
345 628 aaronmk
endef
346
347 1986 aaronmk
test2Db = $(call runTest,$(map2db))
348 775 aaronmk
349 876 aaronmk
tests :=
350
351 4118 aaronmk
test/import.%.xml: src/%/VegBIEN.csv _always
352 1986 aaronmk
	$(test2Db)
353 3642 aaronmk
tests += test/import.%.xml
354 627 aaronmk
355 1987 aaronmk
testStaged2Db = $(foreach use_staged,1,$(test2Db))
356
    # run with use_staged=1
357 1986 aaronmk
358
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
359 4118 aaronmk
test/import.%.staging.xml: src/%/VegBIEN.csv _always
360 3642 aaronmk
	-$(if $(isCsv),$(testStaged2Db),cp -p $(@:.staging.xml=.xml) $@)
361 1988 aaronmk
# Don't abort tester if only staging test fails, in case staging table missing
362
# Non-flat-file inputs fall back to mimicking a successful test
363 3642 aaronmk
tests += test/import.%.staging.xml
364 1986 aaronmk
365 876 aaronmk
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
366 724 aaronmk
367 1361 aaronmk
.PRECIOUS: $(testOutputs) # save outputs of failed tests so they can be accepted
368
369 876 aaronmk
test: _always $(testOutputs) ;
370
371 1987 aaronmk
all += $(filter-out %.ref,$(wildcard test/*))
372 876 aaronmk
373 634 aaronmk
# Accepts a test output: make <test_output_path>-ok
374 626 aaronmk
%-ok: _always
375 630 aaronmk
	$(CP) $* $(call testRef,$*)
376 502 aaronmk
377 3579 aaronmk
test/accept-all: _always
378
	+yes|$(selfMake) test
379
380 3133 aaronmk
##### Documentation
381
382 3590 aaronmk
steps = $(selfMake) -s import test=1 by_col=1 verbosity=2 n=100\
383 3385 aaronmk
2>&1|$(bin)/debug2redmine >$@
384 3188 aaronmk
385 3133 aaronmk
import/steps.by_col.sql: _always
386 3188 aaronmk
	+$(steps)