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,logs,$$'*.log.sql\n*.trace')
107
	$(call addDirWithIgnore,verify,'*.out')
108
	$(call addFile,import_order.txt)
109

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

    
115
##### Existing maps discovery
116

    
117
sortFile := import_order.txt
118

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

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

    
131
srcMap := %/src.csv
132
viaMap := %/map.csv
133
fullViaMap := %/map.full.csv
134
directMap := %/VegBIEN.csv
135
anyMap := $(srcMap) $(viaMap) $(fullViaMap) $(directMap) %/unmapped_terms.csv\
136
%/new_terms.csv
137

    
138
extsFilter := $(addprefix %.,$(exts))
139
dataOnly = $(filter $(extsFilter),$(1))
140

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

    
144
via := Veg+
145

    
146
coreMap := $(mappings)/$(via)-VegBIEN.csv
147
coreSelfMap := $(mappings)/$(via).self.csv
148
vocab := $(mappings)/$(via).vocab.csv
149
dict := $(mappings)/$(via)-VegCore.csv
150

    
151
viaMaps := $(wildcard $(tables:%=%/map.csv))
152
viaMaps += $(filter-out $(viaMaps),$(srcMaps:%/src.csv=%/map.csv))
153
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard */map.csv))
154

    
155
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
156
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
157
$(wildcard */VegBIEN.csv))
158

    
159
##### Sources
160

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

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

    
175
%/cat: _always
176
	$(catSrcs)
177

    
178
##### Staging tables installation
179

    
180
dbExports := $(sort $(wildcard *.schema.sql))# schemas first
181
dbExports += $(sort $(filter-out $(dbExports),$(wildcard *.sql)))# all others
182
dbExports := $(strip $(dbExports))# += adds extra whitespace
183
allInstalls := $(if $(dbExports),sql) $(allTables)
184

    
185
install: _always schema $(allInstalls:%=%/install) ;
186

    
187
uninstall: _always rm_schema ;
188
# rm_schema will also drop all staging tables
189

    
190
reinstall: _always uninstall install ;
191

    
192
schema: _always
193
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
194
# ignore errors if schema exists
195

    
196
rm_schema: _always
197
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
198

    
199
logInstall = $(if $(log),$(if $(quiet),&>,2>&1|tee $(2)\
200
)$(1)logs/install.log.sql)
201
logInstall* = $(call logInstall,$*/)
202
logInstall*Add = $(call logInstall,$*/,-a)# append to log
203

    
204
# Must come before %/install to override it
205
sql/install: $(dbExports)
206
	($(inDatasrc); cat $+|grep -vF 'SET search_path')|"time" $(psqlAsBien) \
207
$(logInstall)
208

    
209
# The export must be created with:
210
# `--compatible=postgresql --add-locks=false --set-charset --no-create-info`
211
# Must come before `%.sql: _MySQL/%.sql` to override it
212
%.data.sql: _MySQL/%.data.sql
213
	$(bin)/my2pg.data <$< >$@
214

    
215
# The export must be created with:
216
# `--compatible=postgresql --add-locks=false --set-charset`
217
# Add `--no-data` to create a schema-only export.
218
%.sql: _MySQL/%.sql
219
	$(bin)/my2pg <$< >$@
220

    
221
cleanup = (prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$*\
222
$(bin)/csv2db) $(logInstall*Add)
223

    
224
define exportHeader
225
$(cleanup)
226
echo 'SELECT * FROM "$(datasrc)"."$*" LIMIT 0;'|$(psqlAsBien) \
227
--no-align --field-separator=, --pset=footer=off >$*/header.csv
228
endef
229

    
230
# For staging tables which are derived by joining together other staging tables.
231
%/install %/header.csv: %/create.sql _always
232
	($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';')|"time" \
233
$(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*)
234
	-$(addRowNum)
235
	$(exportHeader)
236
# ignore errors if create.sql already added a primary key
237
addRowNum = echo 'ALTER TABLE "$(datasrc)"."$*"\
238
ADD COLUMN row_num serial NOT NULL PRIMARY KEY;'|$(psqlAsBien) $(logInstall*Add)
239

    
240
# The joined tables must be suffixed with ".src" to prevent the creation of a
241
# row_num column, which collides during joins.
242
isJoinedTable = $(filter %.src,$*)
243
hasRowNum = $(if $(isJoinedTable),,1)
244

    
245
%/install: _always
246
	$(if $(isRef),$(exportHeader),$(if $(nonXml),$(import_install_)))
247
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
248
env schema=$(datasrc) table=$* has_row_num=$(hasRowNum) $(bin)/csv2db\
249
$(catSrcs) $(logInstall*))
250

    
251
##### Maps building
252

    
253
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
254
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
255

    
256
# Maps to (try to) build are added to one of these
257
maps :=
258
createOnlyMaps :=
259

    
260
srcRoot = $(mappings)/root.sh
261
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
262

    
263
# Src maps cleanup
264
ifneq ($(filter %/.src.csv.last_cleanup,$(MAKECMDGOALS)),)
265
%/.src.csv.last_cleanup: %/src.csv
266
	$(bin)/in_place $< $(bin)/cols +
267
	touch $@
268
else
269
# Autogen src maps with known table names
270
%/src.csv: _always
271
	$(if $(wildcard $@),,$(if $(nonXml),$(mkSrcMap)))
272
	+$(if $(nonXml),$(selfMake) $(@:%/src.csv=%/.src.csv.last_cleanup))
273
# only build if doesn't exist
274
# only build if CSV srcs exist for that table name
275
endif
276

    
277
createOnlyMaps += $(tables:%=%/src.csv)
278

    
279
# Must come before $(root)/% to override it
280
$(coreSelfMap): _always
281
	-+$(subMake)
282
# ignore errors if $(coreSelfMap) does not exist
283

    
284
# Via maps cleanup
285
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
286
%/.map.csv.last_cleanup: %/map.csv $(coreMap) $(vocab) $(dict)
287
	$(bin)/in_place $< $(bin)/canon 1 $(word 3,$+)
288
	$(bin)/in_place $< $(bin)/translate 1 $(word 4,$+)
289
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
290
	touch $@
291
	+$(selfMake) $(<:%/map.csv=%/unmapped_terms.csv)
292
	+$(selfMake) $(<:%/map.csv=%/new_terms.csv)
293
# Include comment column so commented mappings are never removed
294
else
295
%/map.csv: %/src.csv _always
296
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
297
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
298
endif
299

    
300
srcMap* = $*/src.csv
301
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(srcMap*) 0)
302
hasSrc = $(shell test -s $(word 3,$+) && echo t)
303

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

    
306
%/map.full.csv: %/map.csv $(coreSelfMap)
307
	$(makeFullCsv)
308
	$(joinSrcMap)
309
maps += $(patsubst %/map.csv,%/map.full.csv,$(viaMaps))
310

    
311
%/VegBIEN.csv: %/map.full.csv $(coreMap)
312
	$(bin)/join <$+|$(bin)/sort_map >$@
313
maps += $(autogenMaps)
314

    
315
maps: $(createOnlyMaps) $(maps) _always ;
316

    
317
all += $(maps)
318

    
319
##### Maps validation
320

    
321
define newTerms
322
$(bin)/filter_out_ci <$< $(1) $(word 2,$+)|$(bin)/cols $(1)|tail +2 >$@
323
$(bin)/autoremove $@
324
endef
325

    
326
%/unmapped_terms.csv: %/map.csv $(vocab)
327
	$(call newTerms,1)
328

    
329
%/new_terms.csv: %/map.csv $(vocab)
330
	$(call newTerms,0)
331

    
332
# `env -i sort`: use system's sort, not bin/sort
333
missingMappingsCmd = +$(selfMake) remake 2>&1\
334
|$(SED) -n 's/^.*No $(*2Space) mapping for (.*)$$/\1/p'|$(SED) 's/\/_.*//'\
335
$(if $(filter non-empty_join,$*),|$(bin)/ucase_first 0)|env -i sort|uniq
336

    
337
termsSubdirs := $(tables)
338

    
339
include $(root)/lib/mappings.Makefile
340

    
341
##### External dependencies
342

    
343
$(root)/%: _always
344
	+$(subMake)
345
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
346

    
347
##### Mapping
348

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

    
356
##### Import to VegBIEN
357

    
358
profileTest = $(if $(profile),$(if $(test),1))
359
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
360
$(bin)/profile_stats /dev/fd/0
361

    
362
log_ = $*/logs/$(if $(n),n=$(n).,)$(date).log.sql
363
trace = $(log_:.log.sql=.trace)
364
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
365
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
366
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
367
# don't abort on import errors, which often relate to invalid input data
368

    
369
import: $(tables:%=%/import) _always ;
370

    
371
%/import: %/VegBIEN.csv _always
372
	$(import)
373
# default:
374
%/import: _always ;
375

    
376
##### Log files from import
377

    
378
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
379

    
380
rm_logs: _always
381
	$(RM) $(logs)
382

    
383
##### Verification of import
384

    
385
verify: $(tables:%=%/verify) _always ;
386

    
387
%/verify: verify/%.ref verify/%.out _always
388
	-$(diffVerbose) $(+_)
389
# don't abort on verification errors, which are expected during development
390
# default:
391
%/verify: verify/%.out _always
392
	$(if $(shell test -e $< && echo t),cat $<)
393
# don't run if verify/%.out's default do-nothing action was used
394
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
395

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

    
400
verify/%.out: $(mappings)/verify.%.sql _always
401
	$(verify)
402
# default:
403
verify/%.out: _always ;
404

    
405
all += $(wildcard verify/*.out)
406

    
407
%.ref: %.ref.sql
408
	($(inDatasrc); cat $<)|$(psqlExport) >$@
409

    
410
##### Editing import
411

    
412
rotate: _always
413
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
414
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
415

    
416
rm: _always
417
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
418
$(psqlAsBien)
419

    
420
##### Testing
421

    
422
testRefOutput = $(subst .by_col,,$(1))
423
testRef = $(testRefOutput).ref
424
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
425
# filter returns non-empty if they are equal
426

    
427
# `rm $@`: Remove outputs of successful tests to reduce clutter
428
# `$(foreach use_staged...)`: Run with use_staged=1
429
define runTest
430
@echo "Testing $(abspath $@)..."
431
>$@ env test=1 n=$(test_n) $(1) $(foreach use_staged,1,$(map2db))
432
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 && rm $@ || { e=$$?;\
433
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
434
$(if $(hasOwnRef),\
435
{\
436
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
437
if test "$$REPLY" = y; then\
438
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
439
exit 0;\
440
fi;\
441
};,\
442
echo $(emph)"Note: The preceding failed test is compared to another test's\
443
output"$(endEmph);\
444
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
445
)\
446
exit $$e;}
447
endef
448

    
449
tests :=
450

    
451
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
452
# Non-flat-file inputs fall back to mimicking a successful test
453
%/test.xml: %/VegBIEN.csv _always
454
	$(if $(nonXml),$(call runTest,by_col=))
455
tests += %/test.xml
456

    
457
%/test.by_col.xml: %/VegBIEN.csv _always
458
	-$(if $(nonXml),$(call runTest,by_col=1))
459
# Don't abort tester if only by-column test fails
460

    
461
# Only run column-based tests if column-based mode enabled, because these tests
462
# are much slower than the row-based tests for small numbers of rows
463
ifneq ($(by_col),)
464
tests += %/test.by_col.xml
465
endif
466

    
467
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
468

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

    
471
test: _always $(testOutputs) ;
472

    
473
all += $(wildcard %/test*.xml)
474

    
475
# Accepts a test output: make <test_output_path>-ok
476
%-ok: _always
477
	mv $* $(call testRef,$*)
478

    
479
accept-all: _always
480
	+yes|$(selfMake) test
481

    
482
##### Documentation
483

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

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