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
directMap := %/VegBIEN.csv
134
anyMap := $(srcMap) $(viaMap) $(directMap) %/unmapped_terms.csv\
135
%/new_terms.csv
136

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

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

    
143
via := Veg+
144

    
145
coreMap := $(mappings)/$(via)-VegBIEN.csv
146
vocab := $(mappings)/$(via).vocab.csv
147
dict := $(mappings)/$(via)-VegCore.csv
148

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

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

    
157
##### Sources
158

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

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

    
173
%/cat: _always
174
	$(catSrcs)
175

    
176
##### Staging tables installation
177

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

    
183
install: _always schema $(allInstalls:%=%/install) ;
184

    
185
uninstall: _always rm_schema ;
186
# rm_schema will also drop all staging tables
187

    
188
reinstall: _always uninstall install ;
189

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

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

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

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

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

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

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

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

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

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

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

    
249
##### Maps building
250

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

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

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

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

    
275
createOnlyMaps += $(tables:%=%/src.csv)
276

    
277
# Via maps cleanup
278
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
279
%/.map.csv.last_cleanup: %/map.csv $(coreMap) $(vocab) $(dict)
280
	$(bin)/in_place $< $(bin)/canon 1 $(word 3,$+)
281
	$(bin)/in_place $< $(bin)/translate 1 $(word 4,$+)
282
	touch $@
283
	+$(selfMake) $(<:%/map.csv=%/unmapped_terms.csv)
284
	+$(selfMake) $(<:%/map.csv=%/new_terms.csv)
285
# Include comment column so commented mappings are never removed
286
else
287
%/map.csv: _always
288
	$(if $(wildcard $@),,$(if $(nonXml),$(mkSrcMap)))
289
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
290
endif
291

    
292
%/VegBIEN.csv: %/map.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
define newTerms
303
$(bin)/filter_out_ci <$< $(1) $(word 2,$+)|$(bin)/cols $(1)$(2)|tail -n +2 >$@
304
$(bin)/autoremove $@
305
endef
306

    
307
%/unmapped_terms.csv: %/map.csv $(vocab)
308
	$(call newTerms,1)
309

    
310
%/new_terms.csv: %/map.csv $(vocab) %/unmapped_terms.csv
311
	$(call newTerms,0,$(rmNewTerms))
312
rmNewTerms = $(if $(wildcard $(word 3,$+)),|$(bin)/filter_out_ci 0 $(word 3,$+))
313

    
314
termsSubdirs := $(tables)
315

    
316
include $(root)/lib/mappings.Makefile
317

    
318
##### External dependencies
319

    
320
$(root)/%: _always
321
	+$(subMake)
322
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
323

    
324
##### Mapping
325

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

    
333
##### Import to VegBIEN
334

    
335
profileTest = $(if $(profile),$(if $(test),1))
336
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
337
$(bin)/profile_stats /dev/fd/0
338

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

    
346
import: $(tables:%=%/import) _always ;
347

    
348
%/import: %/VegBIEN.csv _always
349
	$(import)
350
# default:
351
%/import: _always ;
352

    
353
##### Log files from import
354

    
355
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
356

    
357
rm_logs: _always
358
	$(RM) $(logs)
359

    
360
##### Verification of import
361

    
362
verify: $(tables:%=%/verify) _always ;
363

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

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

    
377
verify/%.out: $(mappings)/verify.%.sql _always
378
	$(verify)
379
# default:
380
verify/%.out: _always ;
381

    
382
all += $(wildcard verify/*.out)
383

    
384
%.ref: %.ref.sql
385
	($(inDatasrc); cat $<)|$(psqlExport) >$@
386

    
387
##### Editing import
388

    
389
rotate: _always
390
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
391
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
392

    
393
rm: _always
394
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
395
$(psqlAsBien)
396

    
397
##### Testing
398

    
399
testRefOutput = $(subst .by_col,,$(1))
400
testRef = $(testRefOutput).ref
401
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
402
# filter returns non-empty if they are equal
403

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

    
426
tests :=
427

    
428
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
429
# Non-flat-file inputs fall back to mimicking a successful test
430
%/test.xml: %/VegBIEN.csv _always
431
	$(if $(nonXml),$(call runTest,by_col=))
432
tests += %/test.xml
433

    
434
%/test.by_col.xml: %/VegBIEN.csv _always
435
	-$(if $(nonXml),$(call runTest,by_col=1))
436
# Don't abort tester if only by-column test fails
437

    
438
# Only run column-based tests if column-based mode enabled, because these tests
439
# are much slower than the row-based tests for small numbers of rows
440
ifneq ($(by_col),)
441
tests += %/test.by_col.xml
442
endif
443

    
444
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
445

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

    
448
test: _always $(testOutputs) ;
449

    
450
all += $(wildcard %/test*.xml)
451

    
452
# Accepts a test output: make <test_output_path>-ok
453
%-ok: _always
454
	mv $* $(call testRef,$*)
455

    
456
accept-all: _always
457
	+yes|$(selfMake) test
458

    
459
##### Documentation
460

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

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