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,$(svnFilesGlob)}
106

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

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

    
119
##### Existing maps discovery
120

    
121
sortFile := import_order.txt
122

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

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

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

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

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

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

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

    
151
##### Sources
152

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

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

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

    
170
##### Staging tables installation
171

    
172
srcTable := %.src
173

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

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

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

    
186
reinstall: _always uninstall install ;
187

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
269
##### Maps building
270

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

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

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

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

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

    
301
maps: $(maps) _always ;
302

    
303
all += $(maps)
304

    
305
##### Maps validation
306

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

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

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

    
320
termsSubdirs := $(tables)
321

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

    
324
##### External dependencies
325

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

    
330
##### Mapping
331

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

    
336
##### Import to VegBIEN
337

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

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

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

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

    
356
##### Log files from import
357

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

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

    
363
##### Verification of import
364

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

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

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

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

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

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

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

    
392
##### Editing import
393

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

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

    
402
##### Testing
403

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

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

    
431
tests :=
432

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

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

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

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

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

    
452
test: _always $(testOutputs) ;
453

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

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

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

    
463
##### Documentation
464

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

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