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