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