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