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
isXml = $(filter %.xml,$(nonHeaderSrcs))
162
nonXml = $(if $(isXml),,1)
163
isCsv = $(if $(nonHeaderSrcs),$(if $(isXml),,1))
164
    # true if $(srcs) non-empty and contains no *.xml
165
catSrcs = $(bin)/cat$(if $(isCsv),_csv) $(srcs)
166
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
167

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

    
171
%/cat: _always
172
	$(catSrcs)
173

    
174
##### Staging tables installation
175

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

    
181
install: _always schema $(allInstalls:%=%/install) ;
182

    
183
uninstall: _always rm_schema ;
184
# rm_schema will also drop all staging tables
185

    
186
reinstall: _always uninstall install ;
187

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

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

    
195
logInstall = $(if $(log),$(if $(quiet),&>,2>&1|tee )$*/logs/install.log.sql)
196

    
197
# Must come before %/install to override it
198
sql/install: $(dbExports)
199
	($(inDatasrc); cat $+|grep -vF 'SET search_path')|"time" $(psqlAsBien)
200

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

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

    
213
cleanup = (prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$*\
214
$(bin)/csv2db)
215

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

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

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

    
234
%/install: _always
235
	$(if $(nonXml),$(import_install_),$(if $(isRef),$(exportHeader)))
236
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
237
env schema=$(datasrc) table=$* has_row_num=$(hasRowNum) $(bin)/csv2db\
238
$(catSrcs) $(logInstall))
239

    
240
##### Maps building
241

    
242
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
243
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
244

    
245
# Maps to (try to) build are added to one of these
246
maps :=
247
createOnlyMaps :=
248

    
249
srcRoot = $(mappings)/root.sh
250
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
251

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

    
266
createOnlyMaps += $(tables:%=%/src.csv)
267

    
268
# Must come before $(root)/% to override it
269
$(coreSelfMap): _always
270
	-+$(subMake)
271
# ignore errors if $(coreSelfMap) does not exist
272

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

    
285
srcMap* = $*/src.csv
286
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(srcMap*) 0)
287
hasSrc = $(shell test -s $(word 3,$+) && echo t)
288

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

    
291
%/map.full.csv: %/map.csv $(coreSelfMap)
292
	$(makeFullCsv)
293
	$(joinSrcMap)
294
maps += $(patsubst %/map.csv,%/map.full.csv,$(viaMaps))
295

    
296
%/VegBIEN.csv: %/map.full.csv $(coreMap)
297
	$(bin)/join <$+|$(bin)/sort_map >$@
298
maps += $(autogenMaps)
299

    
300
maps: $(createOnlyMaps) $(maps) _always ;
301

    
302
all += $(maps)
303

    
304
##### Maps validation
305

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

    
310
include $(root)/lib/mappings.Makefile
311

    
312
##### External dependencies
313

    
314
$(root)/%: _always
315
	+$(subMake)
316
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
317

    
318
##### Mapping
319

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

    
327
##### Import to VegBIEN
328

    
329
profileTest = $(if $(profile),$(if $(test),1))
330
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
331
$(bin)/profile_stats /dev/fd/0
332

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

    
340
import: $(tables:%=%/import) _always ;
341

    
342
%/import: %/VegBIEN.csv _always
343
	$(import)
344
# default:
345
%/import: _always ;
346

    
347
##### Log files from import
348

    
349
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
350

    
351
rm_logs: _always
352
	$(RM) $(logs)
353

    
354
##### Verification of import
355

    
356
verify: $(tables:%=%/verify) _always ;
357

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

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

    
371
verify/%.out: $(mappings)/verify.%.sql _always
372
	$(verify)
373
# default:
374
verify/%.out: _always ;
375

    
376
all += $(wildcard verify/*.out)
377

    
378
%.ref: %.ref.sql
379
	($(inDatasrc); cat $<)|$(psqlExport) >$@
380

    
381
##### Editing import
382

    
383
rotate: _always
384
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
385
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
386

    
387
rm: _always
388
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
389
$(psqlAsBien)
390

    
391
##### Testing
392

    
393
testRefOutput = $(subst .by_col,,$(1))
394
testRef = $(testRefOutput).ref
395
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
396
# filter returns non-empty if they are equal
397

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

    
420
tests :=
421

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

    
428
%/test.by_col.xml: %/VegBIEN.csv _always
429
	-$(if $(nonXml),$(call runTest,by_col=1))
430
# Don't abort tester if only by-column test fails
431

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

    
438
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
439

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

    
442
test: _always $(testOutputs) ;
443

    
444
all += $(wildcard %/test*.xml)
445

    
446
# Accepts a test output: make <test_output_path>-ok
447
%-ok: _always
448
	mv $* $(call testRef,$*)
449

    
450
accept-all: _always
451
	+yes|$(selfMake) test
452

    
453
##### Documentation
454

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

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