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
schema_only ?=
14
use_staged ?= $(by_col)
15

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

    
20
##### Vars/functions
21

    
22
# Paths
23
datasrc := $(patsubst .%,%,$(notdir $(realpath .)))
24
bin := $(root)/bin
25
mappings := $(root)/mappings
26

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

    
34
# Terminal
35
termCols := $(shell tput cols)
36
esc := '['
37
reset := $(esc)'0m'
38
emph := $(esc)'7m '
39
endEmph := ' '$(reset)
40

    
41
# User interaction
42

    
43
confirm = $(if $(shell read -p $(emph)"$(1)"$(endEmph)$$'$(if\
44
$(2),\n$(2))\nContinue? (y/n) ' REPLY; test "$$REPLY" = y && echo t),,\
45
$(error Aborting))
46

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

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

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

    
73
##### Environment
74

    
75
export PATH := $(bin):$(PATH)
76

    
77
##### General targets
78

    
79
all: _always maps ;
80

    
81
clean: _always
82
	$(RM) $(all)
83

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

    
88
# Only remake if doesn't exist. This prevents unintentional remaking when the
89
# make script is newly checked out from svn (which sets the mod time to now) but
90
# the output is synced externally.
91
# Can't remove prereq to do this, because it determines when the rule applies.
92
make_script = $(if $(wildcard $@),,"time" ./$< >$@)
93

    
94
%/: % _always ;
95

    
96
%: %.make
97
	$(make_script)
98
.PRECIOUS: % # save partial outputs of aborted src make scripts
99

    
100
##### SVN
101

    
102
noImportFile := _no_import
103

    
104
svnFilesGlob:= */{,$(noImportFile),{,.}{map,*terms,VegBIEN}.csv{,.*},*header.*,*.sql,test*.xml*}
105
svnFilesGlob := {map.csv,*{schema,~}*.sql,{,*/}*.make,$(svnFilesGlob)}
106
_svnFilesGlob := {_MySQL/{,*schema*.sql,*.make},_src/*.{url,pdf}}
107
svnFiles = $(filter-out _% logs/%,$(call wildcard/,$(svnFilesGlob)))\
108
$(call wildcard/,$(_svnFilesGlob))
109

    
110
add: _always
111
	$(call setSvnIgnore,.,'*')
112
	$(call addDirWithIgnore,logs,$$'*.log.sql\n*.trace')
113
	$(call addDirWithIgnore,verify,'*.out')
114
	$(call addFile,import_order.txt)
115
	$(if $(wildcard _MySQL/),$(call addDirWithIgnore,_MySQL,'*'))
116
	$(if $(wildcard _src/),$(call addDirWithIgnore,_src,'*'))
117
	$(call add*,$(svnFiles))
118

    
119
# Adds a new table subdir
120
%/add: _always
121
	$(call addDirWithIgnore,$*,'*')
122
	$(call addDirWithIgnore,$*/logs,$$'*.log.sql\n*.trace')
123

    
124
##### Existing maps discovery
125

    
126
sortFile := import_order.txt
127

    
128
dontImport = $(wildcard $(1)/$(noImportFile))
129

    
130
tables := $(if $(wildcard $(sortFile)),$(shell cat $(sortFile)))
131
    # $(shell) replaces "\n" with " "
132
allSubdirs := $(call wildcard/,*/)
133
allTables := $(call sortFilenames,$(filter-out _% verify logs,$(allSubdirs:%/=%)))
134
joinedTables := $(filter-out $(tables),$(allTables))
135
allTables := $(strip $(joinedTables) $(tables))# move joined tables to beginning
136
ifeq ($(tables),)# none specified in sort file
137
tables := $(allTables)
138
endif
139
importTables := $(foreach table,$(tables),$(if\
140
$(call dontImport,$(table)),,$(table)))
141

    
142
anyMap := %/map.csv %/VegBIEN.csv %/unmapped_terms.csv %/new_terms.csv
143

    
144
extsFilter := $(addprefix %.,$(exts))
145
dataOnly = $(filter $(extsFilter),$(1))
146

    
147
anyTest = $*/test.%
148
srcsOnly = $(filter-out $(anyMap) $(anyTest) %/logs,$(call dataOnly,$(1)))
149

    
150
srcDict := map.csv
151

    
152
vocab := $(mappings)/VegCore.csv
153
coreMap := $(mappings)/VegCore-VegBIEN.csv
154
dict := $(mappings)/Veg+-VegCore.csv
155

    
156
viaMaps := $(importTables:%=%/map.csv)
157

    
158
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
159
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
160
$(wildcard */VegBIEN.csv))
161

    
162
##### Sources
163

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

    
175
# Usage: `make {--silent|-s} inputs/<datasrc>/cat` (don't echo make commands)
176
cat: $(importTables:%=%/cat) _always ;
177

    
178
%/cat: _always
179
	$(catSrcs)
180

    
181
##### Staging tables installation
182

    
183
srcTable := %.src
184

    
185
dbExports := $(sort $(wildcard *schema*.sql))# schemas first
186
ifeq ($(schema_only),)
187
dbExports += $(sort $(filter-out $(dbExports),$(wildcard *.sql)))# all others
188
endif
189
dbExports := $(strip $(dbExports))# += adds extra whitespace
190
allInstalls := $(if $(dbExports),sql) $(allTables)
191

    
192
install: _always schema $(allInstalls:%=%/install) ;
193

    
194
uninstall: _always confirm_rm_schema rm_schema ;
195
# rm_schema will also drop all staging tables
196

    
197
reinstall: _always uninstall install ;
198

    
199
confirm_rm_schema: _always
200
	$(if $(filter TNRS,$(datasrc)),$(call confirm,WARNING: This will delete the\
201
TNRS cache!,To save it: make backups/TNRS.backup-remake))
202

    
203
schema: _always
204
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlNoSearchPath)
205
# ignore errors if schema exists
206

    
207
rm_schema: _always
208
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlNoSearchPath)
209

    
210
installLog := logs/install.log.sql
211

    
212
logInstall = $(if $(log),$(if $(quiet),$(2)$(1)$(installLog) 2>&1,2>&1|tee $(3)\
213
$(1)$(installLog)))
214
logInstallRoot = $(call logInstall,,>)
215
logInstall* = $(call logInstall,$*/,>)
216
logInstall*Add = $(call logInstall,$*/,>>,-a)# append to log
217

    
218
# Must come before %/install to override it
219
sql/install: $(dbExports)
220
	($(inDatasrc); cat $+|pg_dump_limit)|"time" $(psqlNoSearchPath) \
221
--set=schema='"$(datasrc)"' $(logInstallRoot)
222

    
223
# Must come before `%.sql: _MySQL/%.sql` to override it
224
%.sql: %.sql.make
225
	$(make_script)
226

    
227
# The export must be created with:
228
# `--compatible=postgresql --add-locks=false --set-charset --no-create-info`
229
# Must come before `%.sql: _MySQL/%.sql` to override it
230
%.data.sql: _MySQL/%.data.sql
231
	$(if $(wildcard $@),,$(bin)/my2pg.data <$< >$@)
232

    
233
# The export must be created with:
234
# `--compatible=postgresql --add-locks=false --set-charset`
235
# Add `--no-data` to create a schema-only export.
236
%.sql: _MySQL/%.sql
237
	$(if $(wildcard $@),,$(bin)/my2pg <$< >$@)
238

    
239
cleanup = $(if $(wildcard $*/cleanup.sql),($(inDatasrc); cat $*/cleanup.sql)\
240
|"time" $(psqlNoSearchPath) --echo-all --set=table='"$*"' $(logInstall*Add),\
241
(prefix=; . $(bin)/vegbien_dest; unset schemas; env schema=$(datasrc) table=$*\
242
$(bin)/csv2db) $(logInstall*Add))
243

    
244
define exportHeader
245
$(cleanup)
246
echo 'SELECT * FROM "$(datasrc)"."$*" LIMIT 0;'|$(psqlNoSearchPath) \
247
--no-align --field-separator=, --pset=footer=off >$*/header.csv
248
endef
249

    
250
# For staging tables which are derived by joining together other staging tables.
251
%/install %/header.csv: %/create.sql _always
252
	($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';')|"time" \
253
$(psqlNoSearchPath) --echo-all --set=schema='"$(datasrc)"' --set=table='"$*"' \
254
$(logInstall*)
255
	$(exportHeader)
256
.PRECIOUS: %/header.csv
257

    
258
%/install: _always
259
	$(if $(isRef),$(exportHeader),$(if $(nonXml),$(import_install_)))
260
	$(if $(wildcard $*/postprocess.sql),($(inDatasrc); cat $*/postprocess.sql;)\
261
|"time" $(psqlNoSearchPath) --echo-all --set=table='"$*"' $(logInstall*Add))
262
define import_install_
263
(prefix=; . $(bin)/vegbien_dest; unset schemas; "time" nice -n +5\
264
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs) $(logInstall*))
265
$(if $(filter $(srcTable),$*),($(inDatasrc);\
266
echo 'ALTER TABLE "$(datasrc)"."$*" RENAME row_num TO "$*.row_num";')|"time"\
267
$(psqlNoSearchPath) --echo-all --set=table='"$*"' $(logInstall*Add))
268
endef
269
# table-scope src table's row_num col to allow joining it with other tables
270

    
271
%/uninstall: _always
272
	echo 'DROP TABLE IF EXISTS "$(datasrc)"."$*" CASCADE;'|$(psqlNoSearchPath)
273

    
274
%/reinstall: _always %/uninstall %/install ;
275

    
276
cleanup: _always $(tables:%=%/cleanup) ;
277

    
278
# WARNING: This removes any index comments, due to a PostgreSQL bug.
279
# This occurs because ALTER TABLE recreates the index but not its comment.
280
%/cleanup: _always
281
	$(cleanup)
282

    
283
##### Maps building
284

    
285
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
286
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
287

    
288
# Maps to (try to) build are added to this
289
maps :=
290

    
291
srcRoot = $(mappings)/root.sh
292
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
293

    
294
define translate
295
$(bin)/in_place $< $(bin)/canon 1 $(1)
296
$(bin)/in_place $< $(bin)/translate 1 $(1)
297
endef
298
translate? = $(if $(wildcard $(1)),$(translate))
299

    
300
$(srcDict):# empty target in case it doesn't exist
301

    
302
# Via maps cleanup
303
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
304
%/.map.csv.last_cleanup: %/map.csv $(vocab) $(dict) $(coreMap) $(srcDict)
305
	$(call translate?,$(srcDict))
306
	$(bin)/in_place $< $(bin)/canon 1 $(vocab)
307
	$(call translate?,$(dict))
308
	touch $@
309
	+$(selfMake) $(<:%/map.csv=%/unmapped_terms.csv)
310
	+$(selfMake) $(<:%/map.csv=%/new_terms.csv)
311
.PRECIOUS: %/.map.csv.last_cleanup
312
else
313
%/map.csv: _always
314
	$(if $(wildcard $@),,$(if $(nonXml),$(mkSrcMap)))
315
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
316
.PRECIOUS: %/map.csv
317
endif
318

    
319
%/VegBIEN.csv: %/map.csv $(coreMap)
320
	<$< $(bin)/cat_cols 1 2|$(bin)/join $(coreMap)|$(bin)/sort_map >$@
321
maps += $(autogenMaps)
322

    
323
maps: $(maps) _always ;
324

    
325
all += $(maps)
326

    
327
##### Maps validation
328

    
329
# `tail -n +2`: Remove header before running filter_out_ci because filter_out_ci
330
# only removes the header if it matches the vocabulary's header.
331

    
332
%/unmapped_terms.csv: %/map.csv $(coreMap)
333
	tail -n +2 $<|$(bin)/cols 1|$(bin)/filter_out_ci 0 $(coreMap) >$@
334
	$(bin)/autoremove $@
335

    
336
%/new_terms.csv: %/map.csv $(vocab) $(dict) %/unmapped_terms.csv
337
	$(newTerms)
338
	$(bin)/autoremove $@
339
newTerms = tail -n +2 $<|$(bin)/filter_out_ci 0 $(vocab)|$(bin)/filter_out_ci 0\
340
$(dict) $(if $(wildcard $(word 4,$+)),|$(bin)/filter_out_ci 0 $(word 4,$+))\
341
|grep -vE '^"?:' >$@; exit 0# because grep exits nonzero if no match
342

    
343
termsSubdirs := $(importTables)
344

    
345
include $(root)/lib/mappings.Makefile
346

    
347
##### External dependencies
348

    
349
$(root)/%: _always
350
	+$(subMake)
351
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
352

    
353
##### Mapping
354

    
355
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
356
map2db = env in_database=vegbien in_schema=$(datasrc) in_table=$*\
357
out_database=vegbien $(root)/map $(+maps)
358

    
359
##### Import to VegBIEN
360

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

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

    
372
import: $(importTables:%=%/import) _always ;
373

    
374
%/import: %/VegBIEN.csv _always
375
	$(import)
376
# default:
377
%/import: _always ;
378

    
379
##### Log files from import
380

    
381
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
382

    
383
rm_logs: _always
384
	$(RM) $(logs)
385

    
386
##### Verification of import
387

    
388
verifyTables := $(patsubst verify/%.ref,%,$(wildcard verify/*.ref))
389

    
390
verify: $(verifyTables:%=%/verify) _always ;
391

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

    
401
psqlExport := "time" $(psqlNoSearchPath) --no-align --field-separator=$$'\t'\
402
--pset=footer=off --pset=null=NULL
403
# Note that using $(inDatasrc) will not work with datasources whose tables are
404
# the same name as VegBIEN tables (likely only VegBank), because the datasource
405
# is first in the search_path.
406
verify = $(if $(reverify),($(inDatasrc); cat $<)|$(psqlExport)\
407
--set=datasource="'$(datasrc)'" >$@)
408

    
409
verify/%.out: $(mappings)/verify.%.sql _always
410
	$(verify)
411
.PRECIOUS: verify/%.out # save partial output in case of error to help debugging
412
# default:
413
verify/%.out: _always ;
414

    
415
all += $(wildcard verify/*.out)
416

    
417
%.ref: %.ref.sql
418
	($(inDatasrc); cat $<)|$(psqlExport) >$@
419
.PRECIOUS: %.ref # there must always be a .ref for the make rules to work
420

    
421
##### Editing import
422

    
423
rotate: _always
424
	echo "UPDATE source SET shortname = shortname||'.$(version)'\
425
WHERE shortname = '$(datasrc)';"|$(psqlAsBien)
426

    
427
rm: _always
428
	echo "DELETE FROM source WHERE shortname = '$(datasrc)';"|$(psqlAsBien)
429

    
430
##### Testing
431

    
432
testRefOutput = $(subst .by_col,,$(1))
433
testRef = $(testRefOutput).ref
434
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
435
# filter returns non-empty if they are equal
436

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

    
459
tests :=
460

    
461
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
462
# Non-flat-file inputs fall back to mimicking a successful test
463
%/test.xml: %/VegBIEN.csv _always
464
	$(if $(nonXml),$(call runTest,by_col=))
465
tests += %/test.xml
466

    
467
%/test.by_col.xml: %/VegBIEN.csv _always
468
	$(if $(nonXml),$(call runTest,by_col=1))
469

    
470
# Only run column-based tests if column-based mode enabled, because these tests
471
# are much slower than the row-based tests for small numbers of rows
472
ifneq ($(by_col),)
473
tests += %/test.by_col.xml
474
endif
475

    
476
testOutputs := $(foreach test,$(tests),$(importTables:%=$(test)))
477

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

    
480
test: _always $(testOutputs) ;
481

    
482
all += $(wildcard %/test*.xml)
483

    
484
# Accepts a test output: make <test_output_path>-ok
485
%-ok: _always
486
	mv $* $(call testRef,$*)
487

    
488
accept-all: _always
489
	+yes|$(selfMake) test
490

    
491
##### Documentation
492

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

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