Project

General

Profile

1
selfDir_uZPPqC := $(dir $(lastword $(MAKEFILE_LIST)))
2
root := $(selfDir_uZPPqC)..
3
include $(root)/lib/common.Makefile
4

    
5

    
6
##### Configuration
7

    
8
# Command line
9
log ?= $(if $(test),,1)
10
profile ?=
11
quiet ?=
12
reverify ?= 1
13
use_staged ?= $(by_col)
14

    
15
# Makefile
16
exts ?= csv tsv txt xml
17
test_n ?= 2
18

    
19
##### Vars/functions
20

    
21
# Paths
22
datasrc := $(notdir $(realpath .))
23
bin := $(root)/bin
24
mappings := $(root)/mappings
25

    
26
# Make
27
SHELL := /bin/bash
28
selfMake = $(MAKE) --makefile=../input.Makefile
29
subMake = $(MAKE) $(@:$(root)/%=%) --directory=$(root)
30
+_ = $(+:_%=)
31
addBeforeExt = $(basename $(2))$(1)$(suffix $(2))
32

    
33
# 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
# System
41
date = $(shell date +"%Y-%m-%d-%H-%M-%S")
42

    
43
# Terminal
44
termCols := $(shell tput cols)
45
esc := '['
46
reset := $(esc)'0m'
47
emph := $(esc)'7m '
48
endEmph := ' '$(reset)
49

    
50
# Commands
51
MKDIR = mkdir -p
52
mkdir = $(MKDIR) $(@D)
53
CP = cp -p
54
diff = diff --unified=2
55
diffIgnoreSpace = $(diff) --ignore-space-change
56
diffVerbose = $(if $(verbose),diff --side-by-side --left-column\
57
--width=$(termCols),$(diff))
58

    
59
# BIEN commands
60
sortFilenames = $(shell $(bin)/sort_filenames $(1))
61
selfMap = $(bin)/cols 0 0
62
psqlOpts := --set ON_ERROR_STOP=1 --quiet
63
psqlAsBien := $(bin)/psql_vegbien $(psqlOpts)
64
# Usage: ($(inDatasrc); cat $(file))|$(psqlCmd)
65
inDatasrc = echo 'SET search_path TO "$(datasrc)";'
66

    
67
# SVN
68
addDir = $(if $(wildcard $(1)/),svn add --depth=empty $(1),svn mkdir $(1))
69
setSvnIgnore = svn propset svn:ignore $(2) $(1)
70
define addDirWithIgnore
71
$(addDir)
72
$(setSvnIgnore)
73
endef
74

    
75
##### Environment
76

    
77
export PATH := $(bin):$(PATH)
78

    
79
##### General targets
80

    
81
all: _always maps ;
82

    
83
clean: _always
84
	$(RM) $(all)
85

    
86
remake: _always clean
87
	+$(selfMake)
88
# re-run make so that cache of existing files is reset
89

    
90
make_script = ./$< >$@
91

    
92
%/: % _always ;
93

    
94
%: %.make
95
	$(if $(wildcard $@),,"time" $(make_script))
96
# 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
.PRECIOUS: % # save partial outputs of aborted src make scripts
101

    
102
##### SVN
103

    
104
add: _always
105
	$(call setSvnIgnore,.,'*')
106
	$(call addDirWithIgnore,verify,'*.out')
107
	$(call addFile,import_order.txt)
108

    
109
# Adds a new table subdir
110
%/add: _always
111
	$(call addDirWithIgnore,$*,'*')
112
	$(call addDirWithIgnore,$*/logs,$$'*.log.sql\n*.trace')
113

    
114
##### Existing maps discovery
115

    
116
sortFile := import_order.txt
117

    
118
tables := $(if $(wildcard $(sortFile)),$(shell cat $(sortFile)))
119
    # $(shell) replaces "\n" with " "
120
allSubdirs := $(call wildcard/,*/)
121
allTables := $(call sortFilenames,$(filter-out _% verify,$(allSubdirs:%/=%)))
122
joinedTables := $(filter-out $(tables),$(allTables))
123
allTables := $(joinedTables) $(tables)# move joined tables to beginning
124
ifeq ($(tables),)# none specified in sort file
125
tables := $(allTables)
126
endif
127

    
128
srcMaps := $(wildcard */src.csv)
129

    
130
srcMap := %/src.csv
131
viaMap := %/map.csv
132
fullViaMap := %/map.full.csv
133
directMap := %/VegBIEN.csv
134
anyMap := $(srcMap) $(viaMap) $(fullViaMap) $(directMap)
135

    
136
extsFilter := $(addprefix %.,$(exts))
137
dataOnly = $(filter $(extsFilter),$(1))
138

    
139
anyTest = $*/test.%
140
srcsOnly = $(filter-out $(anyMap) $(anyTest) %/logs,$(call dataOnly,$(1)))
141

    
142
via := Veg+
143

    
144
coreMap := $(mappings)/$(via)-VegBIEN.csv
145
coreSelfMap := $(mappings)/$(via).self.csv
146

    
147
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

    
151
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
152
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
153
$(wildcard */VegBIEN.csv))
154

    
155
##### Sources
156

    
157
srcs = $(call sortFilenames,$(call srcsOnly,$(wildcard $*/*)))
158
nonHeaderSrcs = $(filter-out %/header.csv,$(srcs))
159
isRef = $(if $(nonHeaderSrcs),,1)
160
    # empty subdir, so references an already-installed staging table
161
isCsv = $(if $(nonHeaderSrcs),$(if $(filter %.xml,$(nonHeaderSrcs)),,1))
162
    # true if $(srcs) non-empty and contains no *.xml
163
catSrcs = $(bin)/cat$(if $(isCsv),_csv) $(srcs)
164
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
165

    
166
# Usage: `make {--silent|-s} inputs/<datasrc>/cat` (don't echo make commands)
167
cat: $(tables:%=%/cat) _always ;
168

    
169
%/cat: _always
170
	$(catSrcs)
171

    
172
##### Staging tables installation
173

    
174
dbExports := $(wildcard *.schema.sql)# schemas first
175
dbExports += $(filter-out $(dbExports),$(wildcard *.sql))# all others
176
dbExports := $(strip $(dbExports))# += adds extra whitespace
177
allInstalls := $(if $(dbExports),sql) $(allTables)
178

    
179
install: _always schema $(allInstalls:%=%/install) ;
180

    
181
uninstall: _always rm_schema ;
182
# rm_schema will also drop all staging tables
183

    
184
reinstall: _always uninstall install ;
185

    
186
schema: _always
187
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
188
# ignore errors if schema exists
189

    
190
rm_schema: _always
191
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
192

    
193
# Must come before %/install to override it
194
sql/install: $(dbExports)
195
	($(inDatasrc); cat $+|grep -vF 'SET search_path')|"time" $(psqlAsBien)
196

    
197
# The export must be created with:
198
# `--compatible=postgresql --add-locks=false --set-charset --no-create-info`
199
# Must come before `%.sql: _MySQL/%.sql` to override it
200
%.data.sql: _MySQL/%.data.sql
201
	$(bin)/my2pg.data <$< >$@
202

    
203
# The export must be created with:
204
# `--compatible=postgresql --add-locks=false --set-charset`
205
# Add `--no-data` to create a schema-only export.
206
%.sql: _MySQL/%.sql
207
	$(bin)/my2pg <$< >$@
208

    
209
cleanup = (prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$*\
210
$(bin)/csv2db)
211

    
212
define exportHeader
213
$(cleanup)
214
echo 'SELECT * FROM "$(datasrc)"."$*" LIMIT 0;'|$(psqlAsBien) \
215
--no-align --field-separator=, --pset=footer=off >$*/header.csv
216
endef
217

    
218
# For staging tables which are derived by joining together other staging tables.
219
%/install %/header.csv: %/create.sql _always
220
	($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';'; \
221
echo 'ALTER TABLE "$*" ADD COLUMN row_num serial NOT NULL PRIMARY KEY;'; \
222
echo 'VACUUM ANALYZE "$*";')|$(psqlAsBien) --echo-all
223
	$(exportHeader)
224

    
225
# The joined tables must be suffixed with ".src" to prevent the creation of a
226
# row_num column, which collides during joins.
227
isJoinedTable = $(filter %.src,$*)
228
hasRowNum = $(if $(isJoinedTable),,1)
229

    
230
%/install: _always
231
	$(if $(isCsv),$(import_install_),$(if $(isRef),$(exportHeader)))
232
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
233
env schema=$(datasrc) table=$* has_row_num=$(hasRowNum) $(bin)/csv2db\
234
$(catSrcs) $(if $(log),$(if $(quiet),&>,2>&1|tee )$*/logs/install.log.sql))
235

    
236
##### Maps building
237

    
238
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
239
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
240

    
241
# Maps to (try to) build are added to one of these
242
maps :=
243
createOnlyMaps :=
244

    
245
srcRoot = $(mappings)/root.sh
246
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
247

    
248
# Src maps cleanup
249
ifneq ($(filter %/.src.csv.last_cleanup,$(MAKECMDGOALS)),)
250
%/.src.csv.last_cleanup: %/src.csv
251
	$(bin)/in_place $< $(bin)/cols +
252
	touch $@
253
else
254
# Autogen src maps with known table names
255
%/src.csv: _always
256
	$(if $(wildcard $@),,$(if $(isCsv),$(mkSrcMap)))
257
	+$(if $(isCsv),$(selfMake) $(@:%/src.csv=%/.src.csv.last_cleanup))
258
# only build if doesn't exist
259
# only build if CSV srcs exist for that table name
260
endif
261

    
262
createOnlyMaps += $(tables:%=%/src.csv)
263

    
264
# Must come before $(root)/% to override it
265
$(coreSelfMap): _always
266
	-+$(subMake)
267
# ignore errors if $(coreSelfMap) does not exist
268

    
269
# Via maps cleanup
270
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
271
%/.map.csv.last_cleanup: %/map.csv $(coreMap)
272
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
273
	touch $@
274
# Include comment column so commented mappings are never removed
275
else
276
%/map.csv: %/src.csv _always
277
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
278
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
279
endif
280

    
281
srcMap* = $*/src.csv
282
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(srcMap*) 0)
283
hasSrc = $(shell test -s $(word 3,$+) && echo t)
284

    
285
makeFullCsv = env ignore=1 $(bin)/union <$(wordlist 1,2,$+)|$(bin)/sort_map >$@
286

    
287
%/map.full.csv: %/map.csv $(coreSelfMap)
288
	$(makeFullCsv)
289
	$(joinSrcMap)
290
maps += $(patsubst %/map.csv,%/map.full.csv,$(viaMaps))
291

    
292
%/VegBIEN.csv: %/map.full.csv $(coreMap)
293
	$(bin)/join <$+|$(bin)/sort_map >$@
294
maps += $(autogenMaps)
295

    
296
maps: $(createOnlyMaps) $(maps) _always ;
297

    
298
all += $(maps)
299

    
300
##### Maps validation
301

    
302
missingMappingsCmd = +$(selfMake) remake 2>&1\
303
|$(SED) -n 's/^.*No $(*2Space) mapping for (.*)$$/\1/p'|$(SED) 's/\/_.*//'\
304
$(if $(filter non-empty_join,$*),|$(bin)/ucase_first 0)|sort|uniq
305

    
306
include $(root)/lib/mappings.Makefile
307

    
308
##### External dependencies
309

    
310
$(root)/%: _always
311
	+$(subMake)
312
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
313

    
314
##### Mapping
315

    
316
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
317
map = $(if $(srcs),$(withCatSrcs) $(root)/map $(+maps),\
318
$(shell echo Warning: No input file $*/*.{$(exts)} >&2)false)
319
# need false to run some command, when prefixed by `env ...` below
320
map2db = $(if $(use_staged),env in_database=vegbien in_schema=$(datasrc)\
321
in_table=$*) env out_database=vegbien $(map)
322

    
323
##### Import to VegBIEN
324

    
325
profileTest = $(if $(profile),$(if $(test),1))
326
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
327
$(bin)/profile_stats /dev/fd/0
328

    
329
log_ = $*/logs/$(if $(n),n=$(n).,)$(date).log.sql
330
trace = $(log_:.log.sql=.trace)
331
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
332
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
333
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
334
# don't abort on import errors, which often relate to invalid input data
335

    
336
import: $(tables:%=%/import) _always ;
337

    
338
%/import: %/VegBIEN.csv _always
339
	$(import)
340
# default:
341
%/import: _always ;
342

    
343
##### Log files from import
344

    
345
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
346

    
347
rm_logs: _always
348
	$(RM) $(logs)
349

    
350
##### Verification of import
351

    
352
verify: $(tables:%=%/verify) _always ;
353

    
354
%/verify: verify/%.ref verify/%.out _always
355
	-$(diffVerbose) $(+_)
356
# don't abort on verification errors, which are expected during development
357
# default:
358
%/verify: verify/%.out _always
359
	$(if $(shell test -e $< && echo t),cat $<)
360
# don't run if verify/%.out's default do-nothing action was used
361
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
362

    
363
psqlExport := "time" $(psqlAsBien) --no-align --field-separator=$$'\t'\
364
--pset=footer=off --pset=null=NULL
365
verify = $(if $(reverify),$(psqlExport) --set=datasource="'$(datasrc)'" <$< >$@)
366

    
367
verify/%.out: $(mappings)/verify.%.sql _always
368
	$(verify)
369
# default:
370
verify/%.out: _always ;
371

    
372
all += $(wildcard verify/*.out)
373

    
374
%.ref: %.ref.sql
375
	($(inDatasrc); cat $<)|$(psqlExport) >$@
376

    
377
##### Editing import
378

    
379
rotate: _always
380
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
381
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
382

    
383
rm: _always
384
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
385
$(psqlAsBien)
386

    
387
##### Testing
388

    
389
testRefOutput = $(subst .by_col,,$(1))
390
testRef = $(testRefOutput).ref
391
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
392
# filter returns non-empty if they are equal
393

    
394
# `rm $@`: Remove outputs of successful tests to reduce clutter
395
# `$(foreach use_staged...)`: Run with use_staged=1
396
define runTest
397
@echo "Testing $(abspath $@)..."
398
>$@ env test=1 n=$(test_n) $(1) $(foreach use_staged,1,$(map2db))
399
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 && rm $@ || { e=$$?;\
400
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
401
$(if $(hasOwnRef),\
402
{\
403
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
404
if test "$$REPLY" = y; then\
405
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
406
exit 0;\
407
fi;\
408
};,\
409
echo $(emph)"Note: The preceding failed test is compared to another test's\
410
output"$(endEmph);\
411
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
412
)\
413
exit $$e;}
414
endef
415

    
416
tests :=
417

    
418
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
419
# Non-flat-file inputs fall back to mimicking a successful test
420
%/test.xml: %/VegBIEN.csv _always
421
	$(if $(isCsv),$(call runTest,by_col=))
422
tests += %/test.xml
423

    
424
%/test.by_col.xml: %/VegBIEN.csv _always
425
	-$(if $(isCsv),$(call runTest,by_col=1))
426
# Don't abort tester if only by-column test fails
427

    
428
# Only run column-based tests if column-based mode enabled, because these tests
429
# are much slower than the row-based tests for small numbers of rows
430
ifneq ($(by_col),)
431
tests += %/test.by_col.xml
432
endif
433

    
434
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
435

    
436
.PRECIOUS: $(testOutputs) # save outputs of failed tests so they can be accepted
437

    
438
test: _always $(testOutputs) ;
439

    
440
all += $(wildcard %/test*.xml)
441

    
442
# Accepts a test output: make <test_output_path>-ok
443
%-ok: _always
444
	mv $* $(call testRef,$*)
445

    
446
accept-all: _always
447
	+yes|$(selfMake) test
448

    
449
##### Documentation
450

    
451
steps = $(selfMake) -s import-$* test=1 by_col=1 verbosity=2 n=100\
452
2>&1|$(bin)/debug2redmine >$@
453

    
454
%/logs/steps.by_col.log.sql: _always
455
	+$(steps)
(4-4/4)