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
|
searchPath := $(datasrc),$(shell prefix=; . $(bin)/vegbien_dest;\
|
62
|
echo "$$schemas")
|
63
|
searchPath := "$(subst $(comma),"$(comma)",$(searchPath))"
|
64
|
# Usage: ($(inDatasrc); cat $(file))|$(psqlCmd)
|
65
|
inDatasrc := echo 'SET search_path TO $(searchPath);'
|
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
|
# Only remake if doesn't exist. This prevents unintentional remaking when the
|
91
|
# make script is newly checked out from svn (which sets the mod time to now) but
|
92
|
# the output is synced externally.
|
93
|
# Can't remove prereq to do this, because it determines when the rule applies.
|
94
|
make_script = $(if $(wildcard $@),,"time" ./$< >$@)
|
95
|
|
96
|
%/: % _always ;
|
97
|
|
98
|
%: %.make
|
99
|
$(make_script)
|
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
|
anyMap := %/map.csv %/VegBIEN.csv %/unmapped_terms.csv %/new_terms.csv
|
130
|
|
131
|
extsFilter := $(addprefix %.,$(exts))
|
132
|
dataOnly = $(filter $(extsFilter),$(1))
|
133
|
|
134
|
anyTest = $*/test.%
|
135
|
srcsOnly = $(filter-out $(anyMap) $(anyTest) %/logs,$(call dataOnly,$(1)))
|
136
|
|
137
|
vocab := $(mappings)/VegCore.csv
|
138
|
coreMap := $(mappings)/VegCore-VegBIEN.csv
|
139
|
dict := $(mappings)/Veg+-VegCore.csv
|
140
|
|
141
|
viaMaps := $(tables:%=%/map.csv)
|
142
|
|
143
|
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
|
144
|
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
|
145
|
$(wildcard */VegBIEN.csv))
|
146
|
|
147
|
##### Sources
|
148
|
|
149
|
srcs = $(call sortFilenames,$(call srcsOnly,$(wildcard $*/*)))
|
150
|
nonHeaderSrcs = $(filter-out %/header.csv,$(srcs))
|
151
|
isRef = $(if $(nonHeaderSrcs),,1)
|
152
|
# empty subdir, so references an already-installed staging table
|
153
|
isXml = $(filter %.xml,$(nonHeaderSrcs))
|
154
|
nonXml = $(if $(isXml),,1)
|
155
|
isCsv = $(if $(nonHeaderSrcs),$(if $(isXml),,1))
|
156
|
# true if $(srcs) non-empty and contains no *.xml
|
157
|
catSrcs = $(bin)/cat$(if $(nonXml),_csv) $(srcs)
|
158
|
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
|
159
|
|
160
|
# Usage: `make {--silent|-s} inputs/<datasrc>/cat` (don't echo make commands)
|
161
|
cat: $(tables:%=%/cat) _always ;
|
162
|
|
163
|
%/cat: _always
|
164
|
$(catSrcs)
|
165
|
|
166
|
##### Staging tables installation
|
167
|
|
168
|
srcTable := %.src
|
169
|
|
170
|
dbExports := $(sort $(wildcard *schema.sql))# schemas first
|
171
|
ifeq ($(schema_only),)
|
172
|
dbExports += $(sort $(filter-out $(dbExports),$(wildcard *.sql)))# all others
|
173
|
endif
|
174
|
dbExports := $(strip $(dbExports))# += adds extra whitespace
|
175
|
allInstalls := $(if $(dbExports),sql) $(allTables)
|
176
|
|
177
|
install: _always schema $(allInstalls:%=%/install) ;
|
178
|
|
179
|
uninstall: _always confirm_rm_schema rm_schema ;
|
180
|
# rm_schema will also drop all staging tables
|
181
|
|
182
|
reinstall: _always uninstall install ;
|
183
|
|
184
|
confirm_rm_schema: _always
|
185
|
$(if $(filter TNRS,$(datasrc)),$(call confirm,WARNING: This will delete the\
|
186
|
TNRS cache!,To save it: make backups/TNRS.backup-remake))
|
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
|
installLog := logs/install.log.sql
|
196
|
|
197
|
logInstall = $(if $(log),$(if $(quiet),$(2)$(1)$(installLog) 2>&1,2>&1|tee $(3)\
|
198
|
$(1)$(installLog)))
|
199
|
logInstallRoot = $(call logInstall,,>)
|
200
|
logInstall* = $(call logInstall,$*/,>)
|
201
|
logInstall*Add = $(call logInstall,$*/,>>,-a)# append to log
|
202
|
|
203
|
# Must come before %/install to override it
|
204
|
sql/install: $(dbExports)
|
205
|
($(inDatasrc); cat $+|grep -vF 'SET search_path')|"time" $(psqlAsBien) \
|
206
|
--set=schema='"$(datasrc)"' $(logInstallRoot)
|
207
|
|
208
|
# Must come before `%.sql: _MySQL/%.sql` to override it
|
209
|
%.sql: %.sql.make
|
210
|
$(make_script)
|
211
|
|
212
|
# The export must be created with:
|
213
|
# `--compatible=postgresql --add-locks=false --set-charset --no-create-info`
|
214
|
# Must come before `%.sql: _MySQL/%.sql` to override it
|
215
|
%.data.sql: _MySQL/%.data.sql
|
216
|
$(bin)/my2pg.data <$< >$@
|
217
|
|
218
|
# The export must be created with:
|
219
|
# `--compatible=postgresql --add-locks=false --set-charset`
|
220
|
# Add `--no-data` to create a schema-only export.
|
221
|
%.sql: _MySQL/%.sql
|
222
|
$(bin)/my2pg <$< >$@
|
223
|
|
224
|
cleanup = $(if $(wildcard $*/cleanup.sql),($(inDatasrc); cat $*/cleanup.sql)\
|
225
|
|"time" $(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*Add),\
|
226
|
(prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$* $(bin)/csv2db)\
|
227
|
$(logInstall*Add))
|
228
|
|
229
|
define exportHeader
|
230
|
$(cleanup)
|
231
|
echo 'SELECT * FROM "$(datasrc)"."$*" LIMIT 0;'|$(psqlAsBien) \
|
232
|
--no-align --field-separator=, --pset=footer=off >$*/header.csv
|
233
|
endef
|
234
|
|
235
|
# For staging tables which are derived by joining together other staging tables.
|
236
|
%/install %/header.csv: %/create.sql _always
|
237
|
($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';')|"time" \
|
238
|
$(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*)
|
239
|
$(exportHeader)
|
240
|
.PRECIOUS: %/header.csv
|
241
|
|
242
|
%/install: _always
|
243
|
$(if $(isRef),$(exportHeader),$(if $(nonXml),$(import_install_)))
|
244
|
define import_install_
|
245
|
(prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
|
246
|
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs) $(logInstall*))
|
247
|
$(if $(filter $(srcTable),$*),($(inDatasrc);\
|
248
|
echo 'ALTER TABLE "$(datasrc)"."$*" RENAME row_num TO "$*.row_num";')|"time"\
|
249
|
$(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*Add))
|
250
|
endef
|
251
|
# table-scope src table's row_num col to allow joining it with other tables
|
252
|
|
253
|
%/uninstall: _always
|
254
|
echo 'DROP TABLE IF EXISTS "$(datasrc)"."$*" CASCADE;'|$(psqlAsBien)
|
255
|
|
256
|
%/reinstall: _always %/uninstall %/install ;
|
257
|
|
258
|
cleanup: _always $(tables:%=%/cleanup) ;
|
259
|
|
260
|
# WARNING: This removes any index comments, due to a PostgreSQL bug.
|
261
|
# This occurs because ALTER TABLE recreates the index but not its comment.
|
262
|
%/cleanup: _always
|
263
|
$(cleanup)
|
264
|
|
265
|
##### Maps building
|
266
|
|
267
|
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
|
268
|
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
|
269
|
|
270
|
# Maps to (try to) build are added to this
|
271
|
maps :=
|
272
|
|
273
|
srcRoot = $(mappings)/root.sh
|
274
|
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
|
275
|
|
276
|
# Via maps cleanup
|
277
|
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
|
278
|
%/.map.csv.last_cleanup: %/map.csv $(vocab) $(dict) $(coreMap)
|
279
|
$(bin)/in_place $< $(bin)/canon 1 $(vocab)
|
280
|
$(bin)/in_place $< $(bin)/canon 1 $(dict)
|
281
|
$(bin)/in_place $< $(bin)/translate 1 $(dict)
|
282
|
touch $@
|
283
|
+$(selfMake) $(<:%/map.csv=%/unmapped_terms.csv)
|
284
|
+$(selfMake) $(<:%/map.csv=%/new_terms.csv)
|
285
|
.PRECIOUS: %/.map.csv.last_cleanup
|
286
|
else
|
287
|
%/map.csv: _always
|
288
|
$(if $(wildcard $@),,$(if $(nonXml),$(mkSrcMap)))
|
289
|
+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
|
290
|
.PRECIOUS: %/map.csv
|
291
|
endif
|
292
|
|
293
|
%/VegBIEN.csv: %/map.csv $(coreMap)
|
294
|
<$< $(bin)/cat_cols 1 2|$(bin)/join $(coreMap)|$(bin)/sort_map >$@
|
295
|
maps += $(autogenMaps)
|
296
|
|
297
|
maps: $(maps) _always ;
|
298
|
|
299
|
all += $(maps)
|
300
|
|
301
|
##### Maps validation
|
302
|
|
303
|
# `tail -n +2`: Remove header before running filter_out_ci because filter_out_ci
|
304
|
# only removes the header if it matches the vocabulary's header.
|
305
|
|
306
|
%/unmapped_terms.csv: %/map.csv $(coreMap)
|
307
|
tail -n +2 $<|$(bin)/cols 1|$(bin)/filter_out_ci 0 $(coreMap) >$@
|
308
|
$(bin)/autoremove $@
|
309
|
|
310
|
%/new_terms.csv: %/map.csv $(vocab) $(dict) %/unmapped_terms.csv
|
311
|
$(newTerms)
|
312
|
$(bin)/autoremove $@
|
313
|
newTerms = tail -n +2 $<|$(bin)/filter_out_ci 0 $(vocab)|$(bin)/filter_out_ci 0\
|
314
|
$(dict) $(if $(wildcard $(word 4,$+)),|$(bin)/filter_out_ci 0 $(word 4,$+)) >$@
|
315
|
|
316
|
termsSubdirs := $(tables)
|
317
|
|
318
|
include $(root)/lib/mappings.Makefile
|
319
|
|
320
|
##### External dependencies
|
321
|
|
322
|
$(root)/%: _always
|
323
|
+$(subMake)
|
324
|
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
|
325
|
|
326
|
##### Mapping
|
327
|
|
328
|
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
|
329
|
map2db = env in_database=vegbien in_schema=$(datasrc) in_table=$*\
|
330
|
out_database=vegbien $(root)/map $(+maps)
|
331
|
|
332
|
##### Import to VegBIEN
|
333
|
|
334
|
profileTest = $(if $(profile),$(if $(test),1))
|
335
|
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
|
336
|
$(bin)/profile_stats /dev/fd/0
|
337
|
|
338
|
log_ = $*/logs/$(if $(n),n=$(n).,)$(version).log.sql
|
339
|
trace = $(log_:.log.sql=.trace)
|
340
|
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
|
341
|
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
|
342
|
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
|
343
|
# don't abort on import errors, which often relate to invalid input data
|
344
|
|
345
|
import: $(tables:%=%/import) _always ;
|
346
|
|
347
|
%/import: %/VegBIEN.csv _always
|
348
|
$(import)
|
349
|
# default:
|
350
|
%/import: _always ;
|
351
|
|
352
|
##### Log files from import
|
353
|
|
354
|
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
|
355
|
|
356
|
rm_logs: _always
|
357
|
$(RM) $(logs)
|
358
|
|
359
|
##### Verification of import
|
360
|
|
361
|
verifyTables := $(patsubst verify/%.ref,%,$(wildcard verify/*.ref))
|
362
|
|
363
|
verify: $(verifyTables:%=%/verify) _always ;
|
364
|
|
365
|
%/verify: verify/%.ref verify/%.out _always
|
366
|
-$(diffVerbose) $(+_)
|
367
|
# don't abort on verification errors, which are expected during development
|
368
|
# default:
|
369
|
%/verify: verify/%.out _always
|
370
|
$(if $(shell test -e $< && echo t),cat $<)
|
371
|
# don't run if verify/%.out's default do-nothing action was used
|
372
|
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
|
373
|
|
374
|
psqlExport := "time" $(psqlAsBien) --no-align --field-separator=$$'\t'\
|
375
|
--pset=footer=off --pset=null=NULL
|
376
|
verify = $(if $(reverify),$(psqlExport) --set=datasource="'$(datasrc)'" <$< >$@)
|
377
|
|
378
|
verify/%.out: $(mappings)/verify.%.sql _always
|
379
|
$(verify)
|
380
|
# default:
|
381
|
verify/%.out: _always ;
|
382
|
|
383
|
all += $(wildcard verify/*.out)
|
384
|
|
385
|
%.ref: %.ref.sql
|
386
|
($(inDatasrc); cat $<)|$(psqlExport) >$@
|
387
|
|
388
|
##### Editing import
|
389
|
|
390
|
rotate: _always
|
391
|
echo "UPDATE party SET organizationname = organizationname||'.$(version)'\
|
392
|
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
|
393
|
|
394
|
rm: _always
|
395
|
echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
|
396
|
$(psqlAsBien)
|
397
|
|
398
|
##### Testing
|
399
|
|
400
|
testRefOutput = $(subst .by_col,,$(1))
|
401
|
testRef = $(testRefOutput).ref
|
402
|
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
|
403
|
# filter returns non-empty if they are equal
|
404
|
|
405
|
# `rm $@`: Remove outputs of successful tests to reduce clutter
|
406
|
# `$(foreach use_staged...)`: Run with use_staged=1
|
407
|
define runTest
|
408
|
@echo "Testing $(abspath $@)..."
|
409
|
>$@ env test=1 n=$(test_n) $(1) $(foreach use_staged,1,$(map2db))
|
410
|
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 && rm $@ || { e=$$?;\
|
411
|
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
|
412
|
$(if $(hasOwnRef),\
|
413
|
{\
|
414
|
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
|
415
|
if test "$$REPLY" = y; then\
|
416
|
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
|
417
|
exit 0;\
|
418
|
fi;\
|
419
|
};,\
|
420
|
echo $(emph)"Note: The preceding failed test is compared to another test's\
|
421
|
output"$(endEmph);\
|
422
|
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
|
423
|
)\
|
424
|
exit $$e;}
|
425
|
endef
|
426
|
|
427
|
tests :=
|
428
|
|
429
|
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
|
430
|
# Non-flat-file inputs fall back to mimicking a successful test
|
431
|
%/test.xml: %/VegBIEN.csv _always
|
432
|
$(if $(nonXml),$(call runTest,by_col=))
|
433
|
tests += %/test.xml
|
434
|
|
435
|
%/test.by_col.xml: %/VegBIEN.csv _always
|
436
|
$(if $(nonXml),$(call runTest,by_col=1))
|
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)
|