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
use_staged ?= $(by_col)
14

    
15
# Makefile
16
exts ?= csv tsv txt dmp xml
17
test_n ?= 2
18

    
19
##### Vars/functions
20

    
21
# Paths
22
datasrc := $(patsubst .%,%,$(notdir $(realpath .)))
23
bin := $(root)/bin
24
mappings := $(root)/mappings
25

    
26
# Make
27
SHELL := /bin/bash
28
selfMake = $(MAKE) --makefile=../input.Makefile
29
subMake = $(MAKE) $(@:$(root)/%=%) --directory=$(root)
30
+_ = $(+:_%=)
31
addBeforeExt = $(basename $(2))$(1)$(suffix $(2))
32

    
33
# Terminal
34
termCols := $(shell tput cols)
35
esc := '['
36
reset := $(esc)'0m'
37
emph := $(esc)'7m '
38
endEmph := ' '$(reset)
39

    
40
# User interaction
41

    
42
confirm = $(if $(shell read -p $(emph)"$(1)"$(endEmph)$$'$(if\
43
$(2),\n$(2))\nContinue? (y/n) ' REPLY; test "$$REPLY" = y && echo t),,\
44
$(error Aborting))
45

    
46
# Commands
47
MKDIR = mkdir -p
48
mkdir = $(MKDIR) $(@D)
49
CP = cp -p
50
diff = diff --unified=2
51
diffIgnoreSpace = $(diff) --ignore-space-change
52
diffVerbose = $(if $(verbose),diff --side-by-side --left-column\
53
--width=$(termCols),$(diff))
54

    
55
# BIEN commands
56
sortFilenames = $(shell $(bin)/sort_filenames $(1))
57
selfMap = $(bin)/cols 0 0
58
psqlOpts := --set ON_ERROR_STOP=1 --quiet
59
psqlAsBien := $(bin)/psql_vegbien $(psqlOpts)
60
searchPath := $(datasrc),$(shell prefix=; . $(bin)/vegbien_dest;\
61
echo "$$schemas")
62
searchPath := "$(subst $(comma),"$(comma)",$(searchPath))"
63
# Usage: ($(inDatasrc); cat $(file))|$(psqlCmd)
64
inDatasrc := echo 'SET search_path TO $(searchPath);'
65

    
66
# SVN
67
addDir = $(if $(wildcard $(1)/),svn add --depth=empty $(1),svn mkdir $(1))
68
setSvnIgnore = svn propset svn:ignore $(2) $(1)
69
define addDirWithIgnore
70
$(addDir)
71
$(setSvnIgnore)
72
endef
73

    
74
##### Environment
75

    
76
export PATH := $(bin):$(PATH)
77

    
78
##### General targets
79

    
80
all: _always maps ;
81

    
82
clean: _always
83
	$(RM) $(all)
84

    
85
remake: _always clean
86
	+$(selfMake)
87
# re-run make so that cache of existing files is reset
88

    
89
make_script = ./$< >$@
90

    
91
%/: % _always ;
92

    
93
%: %.make
94
	$(if $(wildcard $@),,"time" $(make_script))
95
# Only remake if doesn't exist. This prevents unintentional remaking when the
96
# make script is newly checked out from svn (which sets the mod time to now) but
97
# the output is synced externally.
98
# Can't remove prereq to do this, because it determines when the rule applies.
99
.PRECIOUS: % # save partial outputs of aborted src make scripts
100

    
101
##### SVN
102

    
103
add: _always
104
	$(call setSvnIgnore,.,'*')
105
	$(call addDirWithIgnore,logs,$$'*.log.sql\n*.trace')
106
	$(call addDirWithIgnore,verify,'*.out')
107
	$(call addFile,import_order.txt)
108

    
109
# Adds a new table subdir
110
%/add: _always
111
	$(call addDirWithIgnore,$*,'*')
112
	$(call addDirWithIgnore,$*/logs,$$'*.log.sql\n*.trace')
113

    
114
##### Existing maps discovery
115

    
116
sortFile := import_order.txt
117

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

    
128
anyMap := %/map.csv %/VegBIEN.csv %/unmapped_terms.csv %/new_terms.csv
129

    
130
extsFilter := $(addprefix %.,$(exts))
131
dataOnly = $(filter $(extsFilter),$(1))
132

    
133
anyTest = $*/test.%
134
srcsOnly = $(filter-out $(anyMap) $(anyTest) %/logs,$(call dataOnly,$(1)))
135

    
136
vocab := $(mappings)/VegCore.csv
137
coreMap := $(mappings)/VegCore-VegBIEN.csv
138
dict := $(mappings)/Veg+-VegCore.csv
139

    
140
viaMaps := $(tables:%=%/map.csv)
141

    
142
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
143
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
144
$(wildcard */VegBIEN.csv))
145

    
146
##### Sources
147

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

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

    
162
%/cat: _always
163
	$(catSrcs)
164

    
165
##### Staging tables installation
166

    
167
dbExports := $(sort $(wildcard *.schema.sql))# schemas first
168
dbExports += $(sort $(filter-out $(dbExports),$(wildcard *.sql)))# all others
169
dbExports := $(strip $(dbExports))# += adds extra whitespace
170
allInstalls := $(if $(dbExports),sql) $(allTables)
171

    
172
install: _always schema $(allInstalls:%=%/install) ;
173

    
174
uninstall: _always confirm_rm_schema rm_schema ;
175
# rm_schema will also drop all staging tables
176

    
177
reinstall: _always uninstall install ;
178

    
179
confirm_rm_schema: _always
180
	$(if $(filter TNRS,$(datasrc)),$(call confirm,WARNING: This will delete the\
181
TNRS cache!,To save it: make backups/TNRS.backup-remake))
182

    
183
schema: _always
184
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
185
# ignore errors if schema exists
186

    
187
rm_schema: _always
188
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
189

    
190
installLog := logs/install.log.sql
191

    
192
logInstall = $(if $(log),$(if $(quiet),$(2)$(1)$(installLog) 2>&1,2>&1|tee $(3)\
193
$(1)$(installLog)))
194
logInstallRoot = $(call logInstall,,>)
195
logInstall* = $(call logInstall,$*/,>)
196
logInstall*Add = $(call logInstall,$*/,>>,-a)# append to log
197

    
198
# Must come before %/install to override it
199
sql/install: $(dbExports)
200
	($(inDatasrc); cat $+|grep -vF 'SET search_path')|"time" $(psqlAsBien) \
201
$(logInstallRoot)
202

    
203
# The export must be created with:
204
# `--compatible=postgresql --add-locks=false --set-charset --no-create-info`
205
# Must come before `%.sql: _MySQL/%.sql` to override it
206
%.data.sql: _MySQL/%.data.sql
207
	$(bin)/my2pg.data <$< >$@
208

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

    
215
cleanup = (prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$*\
216
$(bin)/csv2db) $(logInstall*Add)
217

    
218
define exportHeader
219
$(cleanup)
220
echo 'SELECT * FROM "$(datasrc)"."$*" LIMIT 0;'|$(psqlAsBien) \
221
--no-align --field-separator=, --pset=footer=off >$*/header.csv
222
endef
223

    
224
# For staging tables which are derived by joining together other staging tables.
225
%/install %/header.csv: %/create.sql _always
226
	($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';')|"time" \
227
$(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*)
228
	$(exportHeader)
229
.PRECIOUS: %/header.csv
230

    
231
%/install: _always
232
	$(if $(isRef),$(exportHeader),$(if $(nonXml),$(import_install_)))
233
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
234
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs) $(logInstall*))
235

    
236
cleanup: _always $(tables:%=%/cleanup) ;
237

    
238
# WARNING: This removes any index comments, due to a PostgreSQL bug.
239
# This occurs because ALTER TABLE recreates the index but not its comment.
240
%/cleanup: _always
241
	$(cleanup)
242
	$(if $(wildcard $*/cleanup.sql),($(inDatasrc); cat $*/cleanup.sql;)\
243
|"time" $(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*Add))
244

    
245
##### Maps building
246

    
247
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
248
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
249

    
250
# Maps to (try to) build are added to this
251
maps :=
252

    
253
srcRoot = $(mappings)/root.sh
254
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
255

    
256
# Via maps cleanup
257
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
258
%/.map.csv.last_cleanup: %/map.csv $(vocab) $(dict) $(coreMap)
259
	$(bin)/in_place $< $(bin)/canon 1 $(vocab)
260
	$(bin)/in_place $< $(bin)/canon 1 $(dict)
261
	$(bin)/in_place $< $(bin)/translate 1 $(dict)
262
	touch $@
263
	+$(selfMake) $(<:%/map.csv=%/unmapped_terms.csv)
264
	+$(selfMake) $(<:%/map.csv=%/new_terms.csv)
265
.PRECIOUS: %/.map.csv.last_cleanup
266
else
267
%/map.csv: _always
268
	$(if $(wildcard $@),,$(if $(nonXml),$(mkSrcMap)))
269
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
270
.PRECIOUS: %/map.csv
271
endif
272

    
273
%/VegBIEN.csv: %/map.csv $(coreMap)
274
	<$< $(bin)/cat_cols 1 2|$(bin)/join $(coreMap)|$(bin)/sort_map >$@
275
maps += $(autogenMaps)
276

    
277
maps: $(maps) _always ;
278

    
279
all += $(maps)
280

    
281
##### Maps validation
282

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

    
286
%/unmapped_terms.csv: %/map.csv $(coreMap)
287
	tail -n +2 $<|$(bin)/cols 1|$(bin)/filter_out_ci 0 $(coreMap) >$@
288
	$(bin)/autoremove $@
289

    
290
%/new_terms.csv: %/map.csv $(vocab) $(dict) %/unmapped_terms.csv
291
	$(newTerms)
292
	$(bin)/autoremove $@
293
newTerms = tail -n +2 $<|$(bin)/filter_out_ci 0 $(vocab)|$(bin)/filter_out_ci 0\
294
$(dict) $(if $(wildcard $(word 4,$+)),|$(bin)/filter_out_ci 0 $(word 4,$+)) >$@
295

    
296
termsSubdirs := $(tables)
297

    
298
include $(root)/lib/mappings.Makefile
299

    
300
##### External dependencies
301

    
302
$(root)/%: _always
303
	+$(subMake)
304
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
305

    
306
##### Mapping
307

    
308
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
309
map2db = env in_database=vegbien in_schema=$(datasrc) in_table=$*\
310
out_database=vegbien $(root)/map $(+maps)
311

    
312
##### Import to VegBIEN
313

    
314
profileTest = $(if $(profile),$(if $(test),1))
315
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
316
$(bin)/profile_stats /dev/fd/0
317

    
318
log_ = $*/logs/$(if $(n),n=$(n).,)$(version).log.sql
319
trace = $(log_:.log.sql=.trace)
320
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
321
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
322
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
323
# don't abort on import errors, which often relate to invalid input data
324

    
325
import: $(tables:%=%/import) _always ;
326

    
327
%/import: %/VegBIEN.csv _always
328
	$(import)
329
# default:
330
%/import: _always ;
331

    
332
##### Log files from import
333

    
334
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
335

    
336
rm_logs: _always
337
	$(RM) $(logs)
338

    
339
##### Verification of import
340

    
341
verify: $(tables:%=%/verify) _always ;
342

    
343
%/verify: verify/%.ref verify/%.out _always
344
	-$(diffVerbose) $(+_)
345
# don't abort on verification errors, which are expected during development
346
# default:
347
%/verify: verify/%.out _always
348
	$(if $(shell test -e $< && echo t),cat $<)
349
# don't run if verify/%.out's default do-nothing action was used
350
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
351

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

    
356
verify/%.out: $(mappings)/verify.%.sql _always
357
	$(verify)
358
# default:
359
verify/%.out: _always ;
360

    
361
all += $(wildcard verify/*.out)
362

    
363
%.ref: %.ref.sql
364
	($(inDatasrc); cat $<)|$(psqlExport) >$@
365

    
366
##### Editing import
367

    
368
rotate: _always
369
	echo "UPDATE party SET organizationname = organizationname||'.$(version)'\
370
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
371

    
372
rm: _always
373
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
374
$(psqlAsBien)
375

    
376
##### Testing
377

    
378
testRefOutput = $(subst .by_col,,$(1))
379
testRef = $(testRefOutput).ref
380
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
381
# filter returns non-empty if they are equal
382

    
383
# `rm $@`: Remove outputs of successful tests to reduce clutter
384
# `$(foreach use_staged...)`: Run with use_staged=1
385
define runTest
386
@echo "Testing $(abspath $@)..."
387
>$@ env test=1 n=$(test_n) $(1) $(foreach use_staged,1,$(map2db))
388
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 && rm $@ || { e=$$?;\
389
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
390
$(if $(hasOwnRef),\
391
{\
392
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
393
if test "$$REPLY" = y; then\
394
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
395
exit 0;\
396
fi;\
397
};,\
398
echo $(emph)"Note: The preceding failed test is compared to another test's\
399
output"$(endEmph);\
400
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
401
)\
402
exit $$e;}
403
endef
404

    
405
tests :=
406

    
407
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
408
# Non-flat-file inputs fall back to mimicking a successful test
409
%/test.xml: %/VegBIEN.csv _always
410
	$(if $(nonXml),$(call runTest,by_col=))
411
tests += %/test.xml
412

    
413
%/test.by_col.xml: %/VegBIEN.csv _always
414
	$(if $(nonXml),$(call runTest,by_col=1))
415

    
416
# Only run column-based tests if column-based mode enabled, because these tests
417
# are much slower than the row-based tests for small numbers of rows
418
ifneq ($(by_col),)
419
tests += %/test.by_col.xml
420
endif
421

    
422
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
423

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

    
426
test: _always $(testOutputs) ;
427

    
428
all += $(wildcard %/test*.xml)
429

    
430
# Accepts a test output: make <test_output_path>-ok
431
%-ok: _always
432
	mv $* $(call testRef,$*)
433

    
434
accept-all: _always
435
	+yes|$(selfMake) test
436

    
437
##### Documentation
438

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

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