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
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
# Usage: `make {--silent|-s} inputs/<datasrc>/cat` (don't echo make commands)
164
cat: $(tables:%=%/cat) _always ;
165

    
166
%/cat: _always
167
	$(catSrcs)
168

    
169
##### Staging tables installation
170

    
171
dbExports := $(wildcard *.schema.sql)# schemas first
172
dbExports += $(filter-out $(dbExports),$(wildcard *.sql))# all others
173
allInstalls := $(if $(dbExports),sql) $(allTables)
174

    
175
install: _always schema $(allInstalls:%=%/install) ;
176

    
177
uninstall: _always rm_schema ;
178
# rm_schema will also drop all staging tables
179

    
180
reinstall: _always uninstall install ;
181

    
182
schema: _always
183
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
184
# ignore errors if schema exists
185

    
186
rm_schema: _always
187
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
188

    
189
# Must come before %/install to override it
190
sql/install: $(dbExports) _always
191
	($(inDatasrc); cat $+|grep -vF 'SET search_path')|"time" $(psqlAsBien)
192

    
193
# The export must be created with:
194
# `--compatible=postgresql --add-locks=false --set-charset --no-data`
195
%.schema.sql: _MySQL/%.schema.sql
196
	$(bin)/my2pg <$< >$@
197

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

    
203
# For staging tables which are derived by joining together other staging tables.
204
%/install %/header.csv: %/create.sql _always
205
	($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';'; \
206
echo 'ALTER TABLE "$*" ADD COLUMN row_num serial NOT NULL PRIMARY KEY;'; \
207
echo 'VACUUM ANALYZE "$*";')|$(psqlAsBien) --echo-all
208
	(prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$* \
209
errors_table_only=1 $(bin)/csv2db)
210
	echo 'SELECT * FROM "$(datasrc)"."$*" LIMIT 0;'|$(psqlAsBien) \
211
--no-align --field-separator=, --pset=footer=off >$*/header.csv
212

    
213
# The joined tables must be suffixed with ".src" to prevent the creation of a
214
# row_num column, which collides during joins.
215
isJoinedTable = $(filter %.src,$*)
216
hasRowNum = $(if $(isJoinedTable),,1)
217

    
218
%/install: _always
219
	$(if $(isCsv),$(import_install_))
220
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
221
env schema=$(datasrc) table=$* has_row_num=$(hasRowNum) $(bin)/csv2db\
222
$(catSrcs) $(if $(log),$(if $(quiet),&>,2>&1|tee )$*/logs/install.log.sql))
223

    
224
##### Maps building
225

    
226
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
227
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
228

    
229
# Maps to (try to) build are added to one of these
230
maps :=
231
createOnlyMaps :=
232

    
233
srcRoot = $(mappings)/root.sh
234
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
235

    
236
# Src maps cleanup
237
ifneq ($(filter %/.src.csv.last_cleanup,$(MAKECMDGOALS)),)
238
%/.src.csv.last_cleanup: %/src.csv
239
	$(bin)/in_place $< $(bin)/cols +
240
	touch $@
241
else
242
# Autogen src maps with known table names
243
%/src.csv: _always
244
	$(if $(wildcard $@),,$(if $(isCsv),$(mkSrcMap)))
245
	+$(if $(isCsv),$(selfMake) $(@:%/src.csv=%/.src.csv.last_cleanup))
246
# only build if doesn't exist
247
# only build if CSV srcs exist for that table name
248
endif
249

    
250
createOnlyMaps += $(tables:%=%/src.csv)
251

    
252
# Must come before $(root)/% to override it
253
$(coreSelfMap): _always
254
	-+$(subMake)
255
# ignore errors if $(coreSelfMap) does not exist
256

    
257
# Via maps cleanup
258
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
259
%/.map.csv.last_cleanup: %/map.csv $(coreMap)
260
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
261
	touch $@
262
# Include comment column so commented mappings are never removed
263
else
264
%/map.csv: %/src.csv _always
265
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
266
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
267
endif
268

    
269
srcMap* = $*/src.csv
270
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(srcMap*) 0)
271
hasSrc = $(shell test -s $(word 3,$+) && echo t)
272

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

    
275
%/map.full.csv: %/map.csv $(coreSelfMap)
276
	$(makeFullCsv)
277
	$(joinSrcMap)
278
maps += $(patsubst %/map.csv,%/map.full.csv,$(viaMaps))
279

    
280
%/VegBIEN.csv: %/map.full.csv $(coreMap)
281
	$(bin)/join <$+|$(bin)/sort_map >$@
282
maps += $(autogenMaps)
283

    
284
maps: $(createOnlyMaps) $(maps) _always ;
285

    
286
all += $(maps)
287

    
288
##### Maps validation
289

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

    
294
include $(root)/lib/mappings.Makefile
295

    
296
##### External dependencies
297

    
298
$(root)/%: _always
299
	+$(subMake)
300
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
301

    
302
##### Mapping
303

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

    
311
##### Import to VegBIEN
312

    
313
profileTest = $(if $(profile),$(if $(test),1))
314
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
315
$(bin)/profile_stats /dev/fd/0
316

    
317
log_ = $*/logs/$(if $(n),n=$(n).,)$(date).log.sql
318
trace = $(log_:.log.sql=.trace)
319
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
320
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
321
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
322
# don't abort on import errors, which often relate to invalid input data
323

    
324
import: $(tables:%=%/import) _always ;
325

    
326
%/import: %/VegBIEN.csv _always
327
	$(import)
328
# default:
329
%/import: _always ;
330

    
331
##### Log files from import
332

    
333
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
334

    
335
rm_logs: _always
336
	$(RM) $(logs)
337

    
338
##### Verification of import
339

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

    
342
%/verify: verify/%.ref verify/%.out _always
343
	-$(diffVerbose) $(+_)
344
# don't abort on verification errors, which are expected during development
345
# default:
346
%/verify: verify/%.out _always
347
	$(if $(shell test -e $< && echo t),cat $<)
348
# don't run if verify/%.out's default do-nothing action was used
349
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
350

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

    
355
verify/%.out: $(mappings)/verify.%.sql _always
356
	$(verify)
357
# default:
358
verify/%.out: _always ;
359

    
360
all += $(wildcard verify/*.out)
361

    
362
%.ref: %.ref.sql
363
	($(inDatasrc); cat $<)|$(psqlExport) >$@
364

    
365
##### Editing import
366

    
367
rotate: _always
368
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
369
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
370

    
371
rm: _always
372
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
373
$(psqlAsBien)
374

    
375
##### Testing
376

    
377
testRefOutput = $(subst .by_col,,$(1))
378
testRef = $(testRefOutput).ref
379
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
380
# filter returns non-empty if they are equal
381

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

    
404
tests :=
405

    
406
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
407
# Non-flat-file inputs fall back to mimicking a successful test
408
%/test.xml: %/VegBIEN.csv _always
409
	$(if $(isCsv),$(call runTest,by_col=))
410
tests += %/test.xml
411

    
412
%/test.by_col.xml: %/VegBIEN.csv _always
413
	-$(if $(isCsv),$(call runTest,by_col=1))
414
# Don't abort tester if only by-column test fails
415

    
416
# Only run column-based tests if column-based mode enabled, because these tests
417
# are much slower than the row-based tests for small numbers of rows
418
ifneq ($(by_col),)
419
tests += %/test.by_col.xml
420
endif
421

    
422
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
423

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

    
426
test: _always $(testOutputs) ;
427

    
428
all += $(wildcard %/test*.xml)
429

    
430
# Accepts a test output: make <test_output_path>-ok
431
%-ok: _always
432
	mv $* $(call testRef,$*)
433

    
434
accept-all: _always
435
	+yes|$(selfMake) test
436

    
437
##### Documentation
438

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

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