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
svnFiles = $(filter-out _% logs/%,$(call wildcard/,$(svnFilesGlob)))
107

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

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

    
120
##### Existing maps discovery
121

    
122
sortFile := import_order.txt
123

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

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

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

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

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

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

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

    
152
##### Sources
153

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

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

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

    
171
##### Staging tables installation
172

    
173
srcTable := %.src
174

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

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

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

    
187
reinstall: _always uninstall install ;
188

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
262
%/reinstall: _always %/uninstall %/install ;
263

    
264
cleanup: _always $(tables:%=%/cleanup) ;
265

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

    
271
##### Maps building
272

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

    
276
# Maps to (try to) build are added to this
277
maps :=
278

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

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

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

    
303
maps: $(maps) _always ;
304

    
305
all += $(maps)
306

    
307
##### Maps validation
308

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

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

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

    
322
termsSubdirs := $(tables)
323

    
324
include $(root)/lib/mappings.Makefile
325

    
326
##### External dependencies
327

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

    
332
##### Mapping
333

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

    
338
##### Import to VegBIEN
339

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

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

    
351
import: $(tables:%=%/import) _always ;
352

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

    
358
##### Log files from import
359

    
360
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
361

    
362
rm_logs: _always
363
	$(RM) $(logs)
364

    
365
##### Verification of import
366

    
367
verifyTables := $(patsubst verify/%.ref,%,$(wildcard verify/*.ref))
368

    
369
verify: $(verifyTables:%=%/verify) _always ;
370

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

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

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

    
389
all += $(wildcard verify/*.out)
390

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

    
394
##### Editing import
395

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

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

    
404
##### Testing
405

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

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

    
433
tests :=
434

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

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

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

    
450
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
451

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

    
454
test: _always $(testOutputs) ;
455

    
456
all += $(wildcard %/test*.xml)
457

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

    
462
accept-all: _always
463
	+yes|$(selfMake) test
464

    
465
##### Documentation
466

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

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