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

    
106
add: _always
107
	$(call setSvnIgnore,.,'*')
108
	$(call addDirWithIgnore,logs,$$'*.log.sql\n*.trace')
109
	$(call addDirWithIgnore,verify,'*.out')
110
	$(call addFile,import_order.txt)
111
	$(call add*,$(call wildcard/,$(svnFilesGlob)))
112

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

    
118
##### Existing maps discovery
119

    
120
sortFile := import_order.txt
121

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

    
132
anyMap := %/map.csv %/VegBIEN.csv %/unmapped_terms.csv %/new_terms.csv
133

    
134
extsFilter := $(addprefix %.,$(exts))
135
dataOnly = $(filter $(extsFilter),$(1))
136

    
137
anyTest = $*/test.%
138
srcsOnly = $(filter-out $(anyMap) $(anyTest) %/logs,$(call dataOnly,$(1)))
139

    
140
vocab := $(mappings)/VegCore.csv
141
coreMap := $(mappings)/VegCore-VegBIEN.csv
142
dict := $(mappings)/Veg+-VegCore.csv
143

    
144
viaMaps := $(tables:%=%/map.csv)
145

    
146
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
147
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
148
$(wildcard */VegBIEN.csv))
149

    
150
##### Sources
151

    
152
srcs = $(call sortFilenames,$(call srcsOnly,$(wildcard $*/*)))
153
nonHeaderSrcs = $(filter-out %/header.csv,$(srcs))
154
isRef = $(if $(nonHeaderSrcs),,1)
155
    # empty subdir, so references an already-installed staging table
156
isXml = $(filter %.xml,$(nonHeaderSrcs))
157
nonXml = $(if $(isXml),,1)
158
isCsv = $(if $(nonHeaderSrcs),$(if $(isXml),,1))
159
    # true if $(srcs) non-empty and contains no *.xml
160
catSrcs = $(bin)/cat$(if $(nonXml),_csv) $(srcs)
161
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
162

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

    
166
%/cat: _always
167
	$(catSrcs)
168

    
169
##### Staging tables installation
170

    
171
srcTable := %.src
172

    
173
dbExports := $(sort $(wildcard *schema*.sql))# schemas first
174
ifeq ($(schema_only),)
175
dbExports += $(sort $(filter-out $(dbExports),$(wildcard *.sql)))# all others
176
endif
177
dbExports := $(strip $(dbExports))# += adds extra whitespace
178
allInstalls := $(if $(dbExports),sql) $(allTables)
179

    
180
install: _always schema $(allInstalls:%=%/install) ;
181

    
182
uninstall: _always confirm_rm_schema rm_schema ;
183
# rm_schema will also drop all staging tables
184

    
185
reinstall: _always uninstall install ;
186

    
187
confirm_rm_schema: _always
188
	$(if $(filter TNRS,$(datasrc)),$(call confirm,WARNING: This will delete the\
189
TNRS cache!,To save it: make backups/TNRS.backup-remake))
190

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

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

    
198
installLog := logs/install.log.sql
199

    
200
logInstall = $(if $(log),$(if $(quiet),$(2)$(1)$(installLog) 2>&1,2>&1|tee $(3)\
201
$(1)$(installLog)))
202
logInstallRoot = $(call logInstall,,>)
203
logInstall* = $(call logInstall,$*/,>)
204
logInstall*Add = $(call logInstall,$*/,>>,-a)# append to log
205

    
206
# Must come before %/install to override it
207
sql/install: $(dbExports)
208
	($(inDatasrc); cat $+|grep -vF 'SET search_path')|"time" $(psqlAsBien) \
209
--set=schema='"$(datasrc)"' $(logInstallRoot)
210

    
211
# Must come before `%.sql: _MySQL/%.sql` to override it
212
%.sql: %.sql.make
213
	$(make_script)
214

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

    
221
# The export must be created with:
222
# `--compatible=postgresql --add-locks=false --set-charset`
223
# Add `--no-data` to create a schema-only export.
224
%.sql: _MySQL/%.sql
225
	$(bin)/my2pg <$< >$@
226

    
227
cleanup = $(if $(wildcard $*/cleanup.sql),($(inDatasrc); cat $*/cleanup.sql)\
228
|"time" $(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*Add),\
229
(prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$* $(bin)/csv2db)\
230
$(logInstall*Add))
231

    
232
define exportHeader
233
$(cleanup)
234
echo 'SELECT * FROM "$(datasrc)"."$*" LIMIT 0;'|$(psqlAsBien) \
235
--no-align --field-separator=, --pset=footer=off >$*/header.csv
236
endef
237

    
238
# For staging tables which are derived by joining together other staging tables.
239
%/install %/header.csv: %/create.sql _always
240
	($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';')|"time" \
241
$(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*)
242
	$(exportHeader)
243
.PRECIOUS: %/header.csv
244

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

    
256
%/uninstall: _always
257
	echo 'DROP TABLE IF EXISTS "$(datasrc)"."$*" CASCADE;'|$(psqlAsBien)
258

    
259
%/reinstall: _always %/uninstall %/install ;
260

    
261
cleanup: _always $(tables:%=%/cleanup) ;
262

    
263
# WARNING: This removes any index comments, due to a PostgreSQL bug.
264
# This occurs because ALTER TABLE recreates the index but not its comment.
265
%/cleanup: _always
266
	$(cleanup)
267

    
268
##### Maps building
269

    
270
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
271
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
272

    
273
# Maps to (try to) build are added to this
274
maps :=
275

    
276
srcRoot = $(mappings)/root.sh
277
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
278

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

    
296
%/VegBIEN.csv: %/map.csv $(coreMap)
297
	<$< $(bin)/cat_cols 1 2|$(bin)/join $(coreMap)|$(bin)/sort_map >$@
298
maps += $(autogenMaps)
299

    
300
maps: $(maps) _always ;
301

    
302
all += $(maps)
303

    
304
##### Maps validation
305

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

    
309
%/unmapped_terms.csv: %/map.csv $(coreMap)
310
	tail -n +2 $<|$(bin)/cols 1|$(bin)/filter_out_ci 0 $(coreMap) >$@
311
	$(bin)/autoremove $@
312

    
313
%/new_terms.csv: %/map.csv $(vocab) $(dict) %/unmapped_terms.csv
314
	$(newTerms)
315
	$(bin)/autoremove $@
316
newTerms = tail -n +2 $<|$(bin)/filter_out_ci 0 $(vocab)|$(bin)/filter_out_ci 0\
317
$(dict) $(if $(wildcard $(word 4,$+)),|$(bin)/filter_out_ci 0 $(word 4,$+)) >$@
318

    
319
termsSubdirs := $(tables)
320

    
321
include $(root)/lib/mappings.Makefile
322

    
323
##### External dependencies
324

    
325
$(root)/%: _always
326
	+$(subMake)
327
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
328

    
329
##### Mapping
330

    
331
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
332
map2db = env in_database=vegbien in_schema=$(datasrc) in_table=$*\
333
out_database=vegbien $(root)/map $(+maps)
334

    
335
##### Import to VegBIEN
336

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

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

    
348
import: $(tables:%=%/import) _always ;
349

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

    
355
##### Log files from import
356

    
357
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
358

    
359
rm_logs: _always
360
	$(RM) $(logs)
361

    
362
##### Verification of import
363

    
364
verifyTables := $(patsubst verify/%.ref,%,$(wildcard verify/*.ref))
365

    
366
verify: $(verifyTables:%=%/verify) _always ;
367

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

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

    
381
verify/%.out: $(mappings)/verify.%.sql _always
382
	$(verify)
383
# default:
384
verify/%.out: _always ;
385

    
386
all += $(wildcard verify/*.out)
387

    
388
%.ref: %.ref.sql
389
	($(inDatasrc); cat $<)|$(psqlExport) >$@
390

    
391
##### Editing import
392

    
393
rotate: _always
394
	echo "UPDATE party SET organizationname = organizationname||'.$(version)'\
395
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
396

    
397
rm: _always
398
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
399
$(psqlAsBien)
400

    
401
##### Testing
402

    
403
testRefOutput = $(subst .by_col,,$(1))
404
testRef = $(testRefOutput).ref
405
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
406
# filter returns non-empty if they are equal
407

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

    
430
tests :=
431

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

    
438
%/test.by_col.xml: %/VegBIEN.csv _always
439
	$(if $(nonXml),$(call runTest,by_col=1))
440

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

    
447
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
448

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

    
451
test: _always $(testOutputs) ;
452

    
453
all += $(wildcard %/test*.xml)
454

    
455
# Accepts a test output: make <test_output_path>-ok
456
%-ok: _always
457
	mv $* $(call testRef,$*)
458

    
459
accept-all: _always
460
	+yes|$(selfMake) test
461

    
462
##### Documentation
463

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

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