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