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
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
svnFilesGlob:= */{,{,.}{map,*terms,VegBIEN}.csv{,.*},*header.*,*.sql,test*.xml*}
105
svnFilesGlob := {*schema*.sql,{,*/}*.make,$(svnFilesGlob)}
106
_svnFilesGlob := _MySQL/{,*schema*.sql,*.make}
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
	$(call add*,$(svnFiles))
117

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

    
123
##### Existing maps discovery
124

    
125
sortFile := import_order.txt
126

    
127
tables := $(if $(wildcard $(sortFile)),$(shell cat $(sortFile)))
128
    # $(shell) replaces "\n" with " "
129
allSubdirs := $(call wildcard/,*/)
130
allTables := $(call sortFilenames,$(filter-out _% verify logs,$(allSubdirs:%/=%)))
131
joinedTables := $(filter-out $(tables),$(allTables))
132
allTables := $(joinedTables) $(tables)# move joined tables to beginning
133
ifeq ($(tables),)# none specified in sort file
134
tables := $(allTables)
135
endif
136

    
137
anyMap := %/map.csv %/VegBIEN.csv %/unmapped_terms.csv %/new_terms.csv
138

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

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

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

    
149
viaMaps := $(tables:%=%/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
nonHeaderSrcs = $(filter-out %/header.csv,$(srcs))
159
isRef = $(if $(nonHeaderSrcs),,1)
160
    # empty subdir, so references an already-installed staging table
161
isXml = $(filter %.xml,$(nonHeaderSrcs))
162
nonXml = $(if $(isXml),,1)
163
isCsv = $(if $(nonHeaderSrcs),$(if $(isXml),,1))
164
    # true if $(srcs) non-empty and contains no *.xml
165
catSrcs = $(bin)/cat$(if $(nonXml),_csv) $(srcs)
166
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
167

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

    
171
%/cat: _always
172
	$(catSrcs)
173

    
174
##### Staging tables installation
175

    
176
srcTable := %.src
177

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

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

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

    
190
reinstall: _always uninstall install ;
191

    
192
confirm_rm_schema: _always
193
	$(if $(filter TNRS,$(datasrc)),$(call confirm,WARNING: This will delete the\
194
TNRS cache!,To save it: make backups/TNRS.backup-remake))
195

    
196
schema: _always
197
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
198
# ignore errors if schema exists
199

    
200
rm_schema: _always
201
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
202

    
203
installLog := logs/install.log.sql
204

    
205
logInstall = $(if $(log),$(if $(quiet),$(2)$(1)$(installLog) 2>&1,2>&1|tee $(3)\
206
$(1)$(installLog)))
207
logInstallRoot = $(call logInstall,,>)
208
logInstall* = $(call logInstall,$*/,>)
209
logInstall*Add = $(call logInstall,$*/,>>,-a)# append to log
210

    
211
# Must come before %/install to override it
212
sql/install: $(dbExports)
213
	($(inDatasrc); cat $+|grep -vF 'SET search_path')|"time" $(psqlAsBien) \
214
--set=schema='"$(datasrc)"' $(logInstallRoot)
215

    
216
# Must come before `%.sql: _MySQL/%.sql` to override it
217
%.sql: %.sql.make
218
	$(make_script)
219

    
220
# The export must be created with:
221
# `--compatible=postgresql --add-locks=false --set-charset --no-create-info`
222
# Must come before `%.sql: _MySQL/%.sql` to override it
223
%.data.sql: _MySQL/%.data.sql
224
	$(if $(wildcard $@),,$(bin)/my2pg.data <$< >$@)
225

    
226
# The export must be created with:
227
# `--compatible=postgresql --add-locks=false --set-charset`
228
# Add `--no-data` to create a schema-only export.
229
%.sql: _MySQL/%.sql
230
	$(if $(wildcard $@),,$(bin)/my2pg <$< >$@)
231

    
232
cleanup = $(if $(wildcard $*/cleanup.sql),($(inDatasrc); cat $*/cleanup.sql)\
233
|"time" $(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*Add),\
234
(prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$* $(bin)/csv2db)\
235
$(logInstall*Add))
236

    
237
define exportHeader
238
$(cleanup)
239
echo 'SELECT * FROM "$(datasrc)"."$*" LIMIT 0;'|$(psqlAsBien) \
240
--no-align --field-separator=, --pset=footer=off >$*/header.csv
241
endef
242

    
243
# For staging tables which are derived by joining together other staging tables.
244
%/install %/header.csv: %/create.sql _always
245
	($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';')|"time" \
246
$(psqlAsBien) --echo-all --set=schema='"$(datasrc)"' --set=table='"$*"' \
247
$(logInstall*)
248
	$(exportHeader)
249
.PRECIOUS: %/header.csv
250

    
251
%/install: _always
252
	$(if $(isRef),$(exportHeader),$(if $(nonXml),$(import_install_)))
253
define import_install_
254
(prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
255
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs) $(logInstall*))
256
$(if $(filter $(srcTable),$*),($(inDatasrc);\
257
echo 'ALTER TABLE "$(datasrc)"."$*" RENAME row_num TO "$*.row_num";')|"time"\
258
$(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*Add))
259
endef
260
# table-scope src table's row_num col to allow joining it with other tables
261

    
262
%/uninstall: _always
263
	echo 'DROP TABLE IF EXISTS "$(datasrc)"."$*" CASCADE;'|$(psqlAsBien)
264

    
265
%/reinstall: _always %/uninstall %/install ;
266

    
267
cleanup: _always $(tables:%=%/cleanup) ;
268

    
269
# WARNING: This removes any index comments, due to a PostgreSQL bug.
270
# This occurs because ALTER TABLE recreates the index but not its comment.
271
%/cleanup: _always
272
	$(cleanup)
273

    
274
##### Maps building
275

    
276
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
277
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
278

    
279
# Maps to (try to) build are added to this
280
maps :=
281

    
282
srcRoot = $(mappings)/root.sh
283
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
284

    
285
# Via maps cleanup
286
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
287
%/.map.csv.last_cleanup: %/map.csv $(vocab) $(dict) $(coreMap)
288
	$(bin)/in_place $< $(bin)/canon 1 $(vocab)
289
	$(bin)/in_place $< $(bin)/canon 1 $(dict)
290
	$(bin)/in_place $< $(bin)/translate 1 $(dict)
291
	touch $@
292
	+$(selfMake) $(<:%/map.csv=%/unmapped_terms.csv)
293
	+$(selfMake) $(<:%/map.csv=%/new_terms.csv)
294
.PRECIOUS: %/.map.csv.last_cleanup
295
else
296
%/map.csv: _always
297
	$(if $(wildcard $@),,$(if $(nonXml),$(mkSrcMap)))
298
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
299
.PRECIOUS: %/map.csv
300
endif
301

    
302
%/VegBIEN.csv: %/map.csv $(coreMap)
303
	<$< $(bin)/cat_cols 1 2|$(bin)/join $(coreMap)|$(bin)/sort_map >$@
304
maps += $(autogenMaps)
305

    
306
maps: $(maps) _always ;
307

    
308
all += $(maps)
309

    
310
##### Maps validation
311

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

    
315
%/unmapped_terms.csv: %/map.csv $(coreMap)
316
	tail -n +2 $<|$(bin)/cols 1|$(bin)/filter_out_ci 0 $(coreMap) >$@
317
	$(bin)/autoremove $@
318

    
319
%/new_terms.csv: %/map.csv $(vocab) $(dict) %/unmapped_terms.csv
320
	$(newTerms)
321
	$(bin)/autoremove $@
322
newTerms = tail -n +2 $<|$(bin)/filter_out_ci 0 $(vocab)|$(bin)/filter_out_ci 0\
323
$(dict) $(if $(wildcard $(word 4,$+)),|$(bin)/filter_out_ci 0 $(word 4,$+))\
324
|grep -vE '^"?:' >$@; exit 0# because grep exits nonzero if no match
325

    
326
termsSubdirs := $(tables)
327

    
328
include $(root)/lib/mappings.Makefile
329

    
330
##### External dependencies
331

    
332
$(root)/%: _always
333
	+$(subMake)
334
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
335

    
336
##### Mapping
337

    
338
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
339
map2db = env in_database=vegbien in_schema=$(datasrc) in_table=$*\
340
out_database=vegbien $(root)/map $(+maps)
341

    
342
##### Import to VegBIEN
343

    
344
profileTest = $(if $(profile),$(if $(test),1))
345
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
346
$(bin)/profile_stats /dev/fd/0
347

    
348
log_ = $*/logs/$(if $(n),n=$(n).,)$(version).log.sql
349
trace = $(log_:.log.sql=.trace)
350
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
351
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
352
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
353
# don't abort on import errors, which often relate to invalid input data
354

    
355
import: $(tables:%=%/import) _always ;
356

    
357
%/import: %/VegBIEN.csv _always
358
	$(import)
359
# default:
360
%/import: _always ;
361

    
362
##### Log files from import
363

    
364
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
365

    
366
rm_logs: _always
367
	$(RM) $(logs)
368

    
369
##### Verification of import
370

    
371
verifyTables := $(patsubst verify/%.ref,%,$(wildcard verify/*.ref))
372

    
373
verify: $(verifyTables:%=%/verify) _always ;
374

    
375
%/verify: verify/%.ref verify/%.out _always
376
	-$(diffVerbose) $(+_)
377
# don't abort on verification errors, which are expected during development
378
# default:
379
%/verify: verify/%.out _always
380
	$(if $(shell test -e $< && echo t),cat $<)
381
# don't run if verify/%.out's default do-nothing action was used
382
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
383

    
384
psqlExport := "time" $(psqlAsBien) --no-align --field-separator=$$'\t'\
385
--pset=footer=off --pset=null=NULL
386
# Note that using $(inDatasrc) will not work with datasources whose tables are
387
# the same name as VegBIEN tables (likely only VegBank), because the datasource
388
# is first in the search_path.
389
verify = $(if $(reverify),($(inDatasrc); cat $<)|$(psqlExport)\
390
--set=datasource="'$(datasrc)'" >$@)
391

    
392
verify/%.out: $(mappings)/verify.%.sql _always
393
	$(verify)
394
.PRECIOUS: verify/%.out # save partial output in case of error to help debugging
395
# default:
396
verify/%.out: _always ;
397

    
398
all += $(wildcard verify/*.out)
399

    
400
%.ref: %.ref.sql
401
	($(inDatasrc); cat $<)|$(psqlExport) >$@
402
.PRECIOUS: %.ref # there must always be a .ref for the make rules to work
403

    
404
##### Editing import
405

    
406
rotate: _always
407
	echo "UPDATE party SET organizationname = organizationname||'.$(version)'\
408
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
409

    
410
rm: _always
411
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
412
$(psqlAsBien)
413

    
414
##### Testing
415

    
416
testRefOutput = $(subst .by_col,,$(1))
417
testRef = $(testRefOutput).ref
418
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
419
# filter returns non-empty if they are equal
420

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

    
443
tests :=
444

    
445
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
446
# Non-flat-file inputs fall back to mimicking a successful test
447
%/test.xml: %/VegBIEN.csv _always
448
	$(if $(nonXml),$(call runTest,by_col=))
449
tests += %/test.xml
450

    
451
%/test.by_col.xml: %/VegBIEN.csv _always
452
	$(if $(nonXml),$(call runTest,by_col=1))
453

    
454
# Only run column-based tests if column-based mode enabled, because these tests
455
# are much slower than the row-based tests for small numbers of rows
456
ifneq ($(by_col),)
457
tests += %/test.by_col.xml
458
endif
459

    
460
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
461

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

    
464
test: _always $(testOutputs) ;
465

    
466
all += $(wildcard %/test*.xml)
467

    
468
# Accepts a test output: make <test_output_path>-ok
469
%-ok: _always
470
	mv $* $(call testRef,$*)
471

    
472
accept-all: _always
473
	+yes|$(selfMake) test
474

    
475
##### Documentation
476

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

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