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 1386 aaronmk
exts ?= csv tsv txt xml
17 783 aaronmk
test_n ?= 2
18
19
##### Vars/functions
20
21 1821 aaronmk
# Paths
22
datasrc := $(notdir $(realpath .))
23
bin := $(root)/bin
24
mappings := $(root)/mappings
25
26 368 aaronmk
# Make
27 640 aaronmk
SHELL := /bin/bash
28 1509 aaronmk
selfMake = $(MAKE) --makefile=../input.Makefile
29 1821 aaronmk
subMake = $(MAKE) $(@:$(root)/%=%) --directory=$(root)
30 404 aaronmk
+_ = $(+:_%=)
31 368 aaronmk
addBeforeExt = $(basename $(2))$(1)$(suffix $(2))
32
33 1742 aaronmk
# OS
34
os := $(shell uname)
35
forOs = $(patsubst %,%-$(filter Linux Darwin,$(os)),$(1))
36
37
# Formatting
38
SED = sed -$(if $(filter Darwin,$(os)),E,r)
39
40 790 aaronmk
# System
41
date = $(shell date +"%Y-%m-%d-%H-%M-%S")
42
43 640 aaronmk
# Terminal
44 1184 aaronmk
termCols := $(shell tput cols)
45 640 aaronmk
esc := '['
46
reset := $(esc)'0m'
47
emph := $(esc)'7m '
48
endEmph := ' '$(reset)
49
50 368 aaronmk
# Commands
51 1245 aaronmk
MKDIR = mkdir -p
52
mkdir = $(MKDIR) $(@D)
53 395 aaronmk
CP = cp -p
54 1184 aaronmk
diff = diff --unified=2
55 3721 aaronmk
diffIgnoreSpace = $(diff) --ignore-space-change
56 1184 aaronmk
diffVerbose = $(if $(verbose),diff --side-by-side --left-column\
57
--width=$(termCols),$(diff))
58 368 aaronmk
59 1918 aaronmk
# BIEN commands
60 4137 aaronmk
sortFilenames = $(shell $(bin)/sort_filenames $(1))
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 4408 aaronmk
# Usage: ($(inDatasrc); cat $(file))|$(psqlCmd)
65
inDatasrc = echo 'SET search_path TO "$(datasrc)";'
66 353 aaronmk
67 1594 aaronmk
# SVN
68
addDir = $(if $(wildcard $(1)/),svn add --depth=empty $(1),svn mkdir $(1))
69 1771 aaronmk
setSvnIgnore = svn propset svn:ignore $(2) $(1)
70 1594 aaronmk
define addDirWithIgnore
71
$(addDir)
72 1771 aaronmk
$(setSvnIgnore)
73 1594 aaronmk
endef
74
75 783 aaronmk
##### General targets
76 250 aaronmk
77 418 aaronmk
all: _always maps ;
78 247 aaronmk
79 383 aaronmk
clean: _always
80 256 aaronmk
	$(RM) $(all)
81
82 1742 aaronmk
remake: _always clean
83
	+$(selfMake)
84
# re-run make so that cache of existing files is reset
85
86 1627 aaronmk
make_script = ./$< >$@
87 368 aaronmk
88 1604 aaronmk
%/: % _always ;
89
90 1627 aaronmk
# Must come before `%: %.make` to override it
91 4379 aaronmk
%: %.make
92 4378 aaronmk
	(set -x; "time" $(make_script)) 2>>$<.log
93 4182 aaronmk
.PRECIOUS: % # save partial outputs of aborted src make scripts
94 1627 aaronmk
95 783 aaronmk
##### SVN
96 250 aaronmk
97 4221 aaronmk
add: _always
98 4182 aaronmk
	$(call setSvnIgnore,.,'*')
99 4124 aaronmk
	$(call addDirWithIgnore,verify,'*.out')
100 4223 aaronmk
	$(call addFile,import_order.txt)
101 766 aaronmk
102 4217 aaronmk
# Adds a new table subdir
103
%/add: _always
104
	$(call addDirWithIgnore,$*,'*')
105
	$(call addDirWithIgnore,$*/logs,$$'*.log.sql\n*.trace')
106
107 1969 aaronmk
##### Existing maps discovery
108 1955 aaronmk
109 4182 aaronmk
sortFile := import_order.txt
110 4181 aaronmk
111 4253 aaronmk
tables := $(if $(wildcard $(sortFile)),$(shell cat $(sortFile)))
112
    # $(shell) replaces "\n" with " "
113 4182 aaronmk
allSubdirs := $(call wildcard/,*/)
114 4256 aaronmk
allTables := $(call sortFilenames,$(filter-out _% verify,$(allSubdirs:%/=%)))
115
joinedTables := $(filter-out $(tables),$(allTables))
116
allTables := $(joinedTables) $(tables)# move joined tables to beginning
117 4253 aaronmk
ifeq ($(tables),)# none specified in sort file
118
tables := $(allTables)
119 4181 aaronmk
endif
120 4137 aaronmk
121 4182 aaronmk
srcMaps := $(wildcard */src.csv)
122 1955 aaronmk
123 4182 aaronmk
srcMap := %/src.csv
124
viaMap := %/map.csv
125
fullViaMap := %/map.full.csv
126
directMap := %/VegBIEN.csv
127 4118 aaronmk
anyMap := $(srcMap) $(viaMap) $(fullViaMap) $(directMap)
128 3574 aaronmk
129 4214 aaronmk
extsFilter := $(addprefix %.,$(exts))
130
dataOnly = $(filter $(extsFilter),$(1))
131
132 4182 aaronmk
anyTest = $*/test.%
133 4214 aaronmk
srcsOnly = $(filter-out $(anyMap) $(anyTest) %/logs,$(call dataOnly,$(1)))
134 4120 aaronmk
135 4095 aaronmk
via := Veg+
136 783 aaronmk
137 4098 aaronmk
coreMap := $(mappings)/$(via)-VegBIEN.csv
138
coreSelfMap := $(mappings)/$(via).self.csv
139 783 aaronmk
140 4182 aaronmk
viaMaps := $(wildcard $(tables:%=%/map.csv))
141
viaMaps += $(filter-out $(viaMaps),$(srcMaps:%/src.csv=%/map.csv))
142
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard */map.csv))
143 783 aaronmk
144 4117 aaronmk
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
145 728 aaronmk
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
146 4182 aaronmk
$(wildcard */VegBIEN.csv))
147 728 aaronmk
148 1969 aaronmk
##### Sources
149
150 4182 aaronmk
srcs = $(call sortFilenames,$(call srcsOnly,$(wildcard $*/*)))
151 1969 aaronmk
isCsv = $(if $(srcs),$(if $(filter %.xml,$(srcs)),,1))
152
    # true if $(srcs) non-empty and contains no *.xml
153
catSrcs = $(bin)/cat$(if $(isCsv),_csv) $(srcs)
154
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
155
156 1986 aaronmk
# Usage: `make {--silent|-s} inputs/<datasrc>/cat` (don't echo make commands)
157 4252 aaronmk
cat: $(tables:%=%/cat) _always ;
158 1969 aaronmk
159 4252 aaronmk
%/cat: _always
160 1969 aaronmk
	$(catSrcs)
161
162 4121 aaronmk
##### Staging tables installation
163 1921 aaronmk
164 4254 aaronmk
install: _always schema $(allTables:%=%/install) ;
165 1921 aaronmk
166 4121 aaronmk
uninstall: _always rm_schema ;
167
# rm_schema will also drop all staging tables
168 1921 aaronmk
169
reinstall: _always uninstall install ;
170
171 4121 aaronmk
schema: _always
172 1921 aaronmk
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
173
# ignore errors if schema exists
174
175 4121 aaronmk
rm_schema: _always
176 1921 aaronmk
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
177
178 4260 aaronmk
# For staging tables which are derived by joining together other staging tables.
179 4263 aaronmk
%/install %/header.csv: %/create.sql _always
180 4260 aaronmk
	(echo 'SET search_path TO "$(datasrc)";'; echo 'CREATE TABLE "$*" AS';\
181 4262 aaronmk
cat $<; echo ';'; \
182
echo 'ALTER TABLE "$*" ADD COLUMN row_num serial NOT NULL PRIMARY KEY;'; \
183
echo 'VACUUM ANALYZE "$*";')|$(psqlAsBien) --echo-all
184 4260 aaronmk
	(prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$* \
185
errors_table_only=1 $(bin)/csv2db)
186 4263 aaronmk
	echo 'SELECT * FROM "$(datasrc)"."$*" LIMIT 0;'|$(psqlAsBien) \
187
--no-align --field-separator=, --pset=footer=off >$*/header.csv
188 4260 aaronmk
189 4259 aaronmk
# The joined tables must be suffixed with ".src" to prevent the creation of a
190
# row_num column, which collides during joins.
191
isJoinedTable = $(filter %.src,$*)
192
hasRowNum = $(if $(isJoinedTable),,1)
193
194 4252 aaronmk
%/install: _always
195 1955 aaronmk
	$(if $(isCsv),$(import_install_))
196 3476 aaronmk
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
197 4259 aaronmk
env schema=$(datasrc) table=$* has_row_num=$(hasRowNum) $(bin)/csv2db\
198
$(catSrcs) $(if $(log),$(if $(quiet),&>,2>&1|tee )$*/logs/install.log.sql))
199 1921 aaronmk
200 1777 aaronmk
##### Maps building
201
202 4345 aaronmk
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
203
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
204
205 1789 aaronmk
# Maps to (try to) build are added to one of these
206 1779 aaronmk
maps :=
207 1789 aaronmk
createOnlyMaps :=
208 1779 aaronmk
209 4208 aaronmk
srcRoot = $(mappings)/root.sh
210 3569 aaronmk
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
211 1779 aaronmk
212 3567 aaronmk
# Src maps cleanup
213 4182 aaronmk
ifneq ($(filter %/.src.csv.last_cleanup,$(MAKECMDGOALS)),)
214
%/.src.csv.last_cleanup: %/src.csv
215 3814 aaronmk
	$(bin)/in_place $< $(bin)/cols +
216 3567 aaronmk
	touch $@
217
else
218 1779 aaronmk
# Autogen src maps with known table names
219 4182 aaronmk
%/src.csv: _always
220 3567 aaronmk
	$(if $(wildcard $@),,$(if $(isCsv),$(mkSrcMap)))
221 4182 aaronmk
	+$(if $(isCsv),$(selfMake) $(@:%/src.csv=%/.src.csv.last_cleanup))
222 3567 aaronmk
# only build if doesn't exist
223 1779 aaronmk
# only build if CSV srcs exist for that table name
224 3567 aaronmk
endif
225
226 4182 aaronmk
createOnlyMaps += $(tables:%=%/src.csv)
227 1779 aaronmk
228 1273 aaronmk
# Must come before $(root)/% to override it
229 1524 aaronmk
$(coreSelfMap): _always
230 1273 aaronmk
	-+$(subMake)
231 1524 aaronmk
# ignore errors if $(coreSelfMap) does not exist
232 1273 aaronmk
233 3572 aaronmk
# Via maps cleanup
234 4182 aaronmk
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
235
%/.map.csv.last_cleanup: %/map.csv $(coreMap)
236 3572 aaronmk
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
237
	touch $@
238
# Include comment column so commented mappings are never removed
239
else
240 4182 aaronmk
%/map.csv: %/src.csv _always
241 3574 aaronmk
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
242 4182 aaronmk
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
243 3572 aaronmk
endif
244
245 4182 aaronmk
srcMap* = $*/src.csv
246 4135 aaronmk
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(srcMap*) 0)
247 4133 aaronmk
hasSrc = $(shell test -s $(word 3,$+) && echo t)
248
249
makeFullCsv = env ignore=1 $(bin)/union <$(wordlist 1,2,$+)|$(bin)/sort_map >$@
250
251 4182 aaronmk
%/map.full.csv: %/map.csv $(coreSelfMap)
252 4133 aaronmk
	$(makeFullCsv)
253
	$(joinSrcMap)
254 4182 aaronmk
maps += $(patsubst %/map.csv,%/map.full.csv,$(viaMaps))
255 4133 aaronmk
256 4182 aaronmk
%/VegBIEN.csv: %/map.full.csv $(coreMap)
257 1530 aaronmk
	$(bin)/join <$+|$(bin)/sort_map >$@
258
maps += $(autogenMaps)
259
260 1789 aaronmk
maps: $(createOnlyMaps) $(maps) _always ;
261 1139 aaronmk
262
all += $(maps)
263
264 1742 aaronmk
##### Maps validation
265
266 3764 aaronmk
missingMappingsCmd = +$(selfMake) remake 2>&1\
267 3821 aaronmk
|$(SED) -n 's/^.*No $(*2Space) mapping for (.*)$$/\1/p'|$(SED) 's/\/_.*//'\
268 3764 aaronmk
$(if $(filter non-empty_join,$*),|$(bin)/ucase_first 0)|sort|uniq
269 1742 aaronmk
270 3764 aaronmk
include $(root)/lib/mappings.Makefile
271 1742 aaronmk
272 1509 aaronmk
##### External dependencies
273
274
$(root)/%: _always
275
	+$(subMake)
276 1628 aaronmk
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
277 1509 aaronmk
278 783 aaronmk
##### Mapping
279 368 aaronmk
280 4182 aaronmk
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
281 4106 aaronmk
map = $(if $(srcs),$(withCatSrcs) $(root)/map $(+maps),\
282 4182 aaronmk
$(shell echo Warning: No input file $*/*.{$(exts)} >&2)false)
283 4106 aaronmk
# need false to run some command, when prefixed by `env ...` below
284 3387 aaronmk
map2db = $(if $(use_staged),env in_database=vegbien in_schema=$(datasrc)\
285
in_table=$*) env out_database=vegbien $(map)
286 368 aaronmk
287 783 aaronmk
##### Import to VegBIEN
288 772 aaronmk
289 1853 aaronmk
profileTest = $(if $(profile),$(if $(test),1))
290
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
291
$(bin)/profile_stats /dev/fd/0
292
293 4182 aaronmk
log_ = $*/logs/$(if $(n),n=$(n).,)$(date).log.sql
294 3317 aaronmk
trace = $(log_:.log.sql=.trace)
295 1853 aaronmk
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
296 1190 aaronmk
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
297 3616 aaronmk
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
298 1088 aaronmk
# don't abort on import errors, which often relate to invalid input data
299 624 aaronmk
300 4252 aaronmk
import: $(tables:%=%/import) _always ;
301 718 aaronmk
302 4252 aaronmk
%/import: %/VegBIEN.csv _always
303 718 aaronmk
	$(import)
304 772 aaronmk
# default:
305 4252 aaronmk
%/import: _always ;
306 718 aaronmk
307 790 aaronmk
##### Log files from import
308
309 4182 aaronmk
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
310 339 aaronmk
311 383 aaronmk
rm_logs: _always
312 339 aaronmk
	$(RM) $(logs)
313
314 783 aaronmk
##### Verification of import
315 264 aaronmk
316 4252 aaronmk
verify: $(tables:%=%/verify) _always ;
317 1194 aaronmk
318 4252 aaronmk
%/verify: verify/%.ref verify/%.out _always
319 1184 aaronmk
	-$(diffVerbose) $(+_)
320 1088 aaronmk
# don't abort on verification errors, which are expected during development
321 1194 aaronmk
# default:
322 4252 aaronmk
%/verify: verify/%.out _always
323 1200 aaronmk
	$(if $(shell test -e $< && echo t),cat $<)
324 1199 aaronmk
# don't run if verify/%.out's default do-nothing action was used
325 1200 aaronmk
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
326 368 aaronmk
327 4401 aaronmk
psqlExport := "time" $(psqlAsBien) --no-align --field-separator=$$'\t'\
328
--pset=footer=off --pset=null=NULL
329
verify = $(if $(reverify),$(psqlExport) --set=datasource="'$(datasrc)'" <$< >$@)
330 514 aaronmk
331 1199 aaronmk
verify/%.out: $(mappings)/verify.%.sql _always
332 1192 aaronmk
	$(verify)
333 1194 aaronmk
# default:
334 1199 aaronmk
verify/%.out: _always ;
335 369 aaronmk
336 1199 aaronmk
all += $(wildcard verify/*.out)
337 1192 aaronmk
338 4402 aaronmk
%.ref: %.ref.sql
339
	(echo 'SET search_path TO "$(datasrc)";'; cat $<)|$(psqlExport) >$@
340
341 1667 aaronmk
##### Editing import
342
343 4121 aaronmk
rotate: _always
344 1668 aaronmk
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
345 1854 aaronmk
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
346 1667 aaronmk
347 4121 aaronmk
rm: _always
348 1854 aaronmk
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
349
$(psqlAsBien)
350 1667 aaronmk
351 783 aaronmk
##### Testing
352 368 aaronmk
353 4274 aaronmk
testRefOutput = $(subst .by_col,,$(1))
354 1986 aaronmk
testRef = $(testRefOutput).ref
355
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
356
# filter returns non-empty if they are equal
357 630 aaronmk
358 4246 aaronmk
# `rm $@`: Remove outputs of successful tests to reduce clutter
359 4272 aaronmk
# `$(foreach use_staged...)`: Run with use_staged=1
360 897 aaronmk
define runTest
361 776 aaronmk
@echo "Testing $(abspath $@)..."
362 4272 aaronmk
>$@ env test=1 n=$(test_n) $(1) $(foreach use_staged,1,$(map2db))
363 4246 aaronmk
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 && rm $@ || { e=$$?;\
364 780 aaronmk
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
365 777 aaronmk
$(if $(hasOwnRef),\
366 3179 aaronmk
{\
367
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
368
if test "$$REPLY" = y; then\
369
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
370
exit 0;\
371
fi;\
372
};,\
373 777 aaronmk
echo $(emph)"Note: The preceding failed test is compared to another test's\
374
output"$(endEmph);\
375
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
376
)\
377 652 aaronmk
exit $$e;}
378 628 aaronmk
endef
379
380 876 aaronmk
tests :=
381
382 4269 aaronmk
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
383
# Non-flat-file inputs fall back to mimicking a successful test
384 4182 aaronmk
%/test.xml: %/VegBIEN.csv _always
385 4275 aaronmk
	$(if $(isCsv),$(call runTest,by_col=))
386 4182 aaronmk
tests += %/test.xml
387 627 aaronmk
388 4274 aaronmk
%/test.by_col.xml: %/VegBIEN.csv _always
389
	-$(if $(isCsv),$(call runTest,by_col=1))
390
# Don't abort tester if only by-column test fails
391 4275 aaronmk
392
# Only run column-based tests if column-based mode enabled, because these tests
393
# are much slower than the row-based tests for small numbers of rows
394
ifneq ($(by_col),)
395 4274 aaronmk
tests += %/test.by_col.xml
396 4275 aaronmk
endif
397 4274 aaronmk
398 876 aaronmk
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
399 724 aaronmk
400 1361 aaronmk
.PRECIOUS: $(testOutputs) # save outputs of failed tests so they can be accepted
401
402 876 aaronmk
test: _always $(testOutputs) ;
403
404 4182 aaronmk
all += $(wildcard %/test*.xml)
405 876 aaronmk
406 634 aaronmk
# Accepts a test output: make <test_output_path>-ok
407 626 aaronmk
%-ok: _always
408 4383 aaronmk
	mv $* $(call testRef,$*)
409 502 aaronmk
410 4120 aaronmk
accept-all: _always
411 3579 aaronmk
	+yes|$(selfMake) test
412
413 3133 aaronmk
##### Documentation
414
415 4122 aaronmk
steps = $(selfMake) -s import-$* test=1 by_col=1 verbosity=2 n=100\
416 3385 aaronmk
2>&1|$(bin)/debug2redmine >$@
417 3188 aaronmk
418 4182 aaronmk
%/logs/steps.by_col.log.sql: _always
419 3188 aaronmk
	+$(steps)