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

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

    
220
cleanup = $(if $(wildcard $*/cleanup.sql),($(inDatasrc); cat $*/cleanup.sql)\
221
|"time" $(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*Add),\
222
(prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$* $(bin)/csv2db)\
223
$(logInstall*Add))
224

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

    
231
# For staging tables which are derived by joining together other staging tables.
232
%/install %/header.csv: %/create.sql _always
233
	($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';')|"time" \
234
$(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*)
235
	$(exportHeader)
236
.PRECIOUS: %/header.csv
237

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

    
249
cleanup: _always $(tables:%=%/cleanup) ;
250

    
251
# WARNING: This removes any index comments, due to a PostgreSQL bug.
252
# This occurs because ALTER TABLE recreates the index but not its comment.
253
%/cleanup: _always
254
	$(cleanup)
255

    
256
##### Maps building
257

    
258
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
259
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
260

    
261
# Maps to (try to) build are added to this
262
maps :=
263

    
264
srcRoot = $(mappings)/root.sh
265
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
266

    
267
# Via maps cleanup
268
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
269
%/.map.csv.last_cleanup: %/map.csv $(vocab) $(dict) $(coreMap)
270
	$(bin)/in_place $< $(bin)/canon 1 $(vocab)
271
	$(bin)/in_place $< $(bin)/canon 1 $(dict)
272
	$(bin)/in_place $< $(bin)/translate 1 $(dict)
273
	touch $@
274
	+$(selfMake) $(<:%/map.csv=%/unmapped_terms.csv)
275
	+$(selfMake) $(<:%/map.csv=%/new_terms.csv)
276
.PRECIOUS: %/.map.csv.last_cleanup
277
else
278
%/map.csv: _always
279
	$(if $(wildcard $@),,$(if $(nonXml),$(mkSrcMap)))
280
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
281
.PRECIOUS: %/map.csv
282
endif
283

    
284
%/VegBIEN.csv: %/map.csv $(coreMap)
285
	<$< $(bin)/cat_cols 1 2|$(bin)/join $(coreMap)|$(bin)/sort_map >$@
286
maps += $(autogenMaps)
287

    
288
maps: $(maps) _always ;
289

    
290
all += $(maps)
291

    
292
##### Maps validation
293

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

    
297
%/unmapped_terms.csv: %/map.csv $(coreMap)
298
	tail -n +2 $<|$(bin)/cols 1|$(bin)/filter_out_ci 0 $(coreMap) >$@
299
	$(bin)/autoremove $@
300

    
301
%/new_terms.csv: %/map.csv $(vocab) $(dict) %/unmapped_terms.csv
302
	$(newTerms)
303
	$(bin)/autoremove $@
304
newTerms = tail -n +2 $<|$(bin)/filter_out_ci 0 $(vocab)|$(bin)/filter_out_ci 0\
305
$(dict) $(if $(wildcard $(word 4,$+)),|$(bin)/filter_out_ci 0 $(word 4,$+)) >$@
306

    
307
termsSubdirs := $(tables)
308

    
309
include $(root)/lib/mappings.Makefile
310

    
311
##### External dependencies
312

    
313
$(root)/%: _always
314
	+$(subMake)
315
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
316

    
317
##### Mapping
318

    
319
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
320
map2db = env in_database=vegbien in_schema=$(datasrc) in_table=$*\
321
out_database=vegbien $(root)/map $(+maps)
322

    
323
##### Import to VegBIEN
324

    
325
profileTest = $(if $(profile),$(if $(test),1))
326
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
327
$(bin)/profile_stats /dev/fd/0
328

    
329
log_ = $*/logs/$(if $(n),n=$(n).,)$(version).log.sql
330
trace = $(log_:.log.sql=.trace)
331
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
332
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
333
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
334
# don't abort on import errors, which often relate to invalid input data
335

    
336
import: $(tables:%=%/import) _always ;
337

    
338
%/import: %/VegBIEN.csv _always
339
	$(import)
340
# default:
341
%/import: _always ;
342

    
343
##### Log files from import
344

    
345
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
346

    
347
rm_logs: _always
348
	$(RM) $(logs)
349

    
350
##### Verification of import
351

    
352
verifyTables := $(patsubst verify/%.ref,%,$(wildcard verify/*.ref))
353

    
354
verify: $(verifyTables:%=%/verify) _always ;
355

    
356
%/verify: verify/%.ref verify/%.out _always
357
	-$(diffVerbose) $(+_)
358
# don't abort on verification errors, which are expected during development
359
# default:
360
%/verify: verify/%.out _always
361
	$(if $(shell test -e $< && echo t),cat $<)
362
# don't run if verify/%.out's default do-nothing action was used
363
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
364

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

    
369
verify/%.out: $(mappings)/verify.%.sql _always
370
	$(verify)
371
# default:
372
verify/%.out: _always ;
373

    
374
all += $(wildcard verify/*.out)
375

    
376
%.ref: %.ref.sql
377
	($(inDatasrc); cat $<)|$(psqlExport) >$@
378

    
379
##### Editing import
380

    
381
rotate: _always
382
	echo "UPDATE party SET organizationname = organizationname||'.$(version)'\
383
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
384

    
385
rm: _always
386
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
387
$(psqlAsBien)
388

    
389
##### Testing
390

    
391
testRefOutput = $(subst .by_col,,$(1))
392
testRef = $(testRefOutput).ref
393
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
394
# filter returns non-empty if they are equal
395

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

    
418
tests :=
419

    
420
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
421
# Non-flat-file inputs fall back to mimicking a successful test
422
%/test.xml: %/VegBIEN.csv _always
423
	$(if $(nonXml),$(call runTest,by_col=))
424
tests += %/test.xml
425

    
426
%/test.by_col.xml: %/VegBIEN.csv _always
427
	$(if $(nonXml),$(call runTest,by_col=1))
428

    
429
# Only run column-based tests if column-based mode enabled, because these tests
430
# are much slower than the row-based tests for small numbers of rows
431
ifneq ($(by_col),)
432
tests += %/test.by_col.xml
433
endif
434

    
435
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
436

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

    
439
test: _always $(testOutputs) ;
440

    
441
all += $(wildcard %/test*.xml)
442

    
443
# Accepts a test output: make <test_output_path>-ok
444
%-ok: _always
445
	mv $* $(call testRef,$*)
446

    
447
accept-all: _always
448
	+yes|$(selfMake) test
449

    
450
##### Documentation
451

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

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