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 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
# OS
34
os := $(shell uname)
35
forOs = $(patsubst %,%-$(filter Linux Darwin,$(os)),$(1))
36

    
37
# Formatting
38
SED = sed -$(if $(filter Darwin,$(os)),E,r)
39

    
40
# System
41
date = $(shell date +"%Y-%m-%d-%H-%M-%S")
42

    
43
# Terminal
44
termCols := $(shell tput cols)
45
esc := '['
46
reset := $(esc)'0m'
47
emph := $(esc)'7m '
48
endEmph := ' '$(reset)
49

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

    
59
# BIEN commands
60
sortFilenames = $(shell $(bin)/sort_filenames $(1))
61
selfMap = $(bin)/cols 0 0
62
psqlOpts := --set ON_ERROR_STOP=1 --quiet
63
psqlAsBien := $(bin)/psql_vegbien $(psqlOpts)
64
# Usage: ($(inDatasrc); cat $(file))|$(psqlCmd)
65
inDatasrc = echo 'SET search_path TO "$(datasrc)";'
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
dbExports := $(sort $(wildcard *.schema.sql))# schemas first
169
dbExports += $(sort $(filter-out $(dbExports),$(wildcard *.sql)))# all others
170
dbExports := $(strip $(dbExports))# += adds extra whitespace
171
allInstalls := $(if $(dbExports),sql) $(allTables)
172

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

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

    
178
reinstall: _always uninstall install ;
179

    
180
schema: _always
181
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
182
# ignore errors if schema exists
183

    
184
rm_schema: _always
185
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
186

    
187
installLog := logs/install.log.sql
188

    
189
logInstall = $(if $(log),$(if $(quiet),$(2)$(1)$(installLog) 2>&1,2>&1|tee $(3)\
190
$(1)$(installLog)))
191
logInstall* = $(call logInstall,$*/,>)
192
logInstall*Add = $(call logInstall,$*/,>>,-a)# append to log
193

    
194
# Must come before %/install to override it
195
sql/install: $(dbExports)
196
	($(inDatasrc); cat $+|grep -vF 'SET search_path')|"time" $(psqlAsBien) \
197
$(logInstall)
198

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

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

    
211
cleanup = (prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$*\
212
$(bin)/csv2db) $(logInstall*Add)
213

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

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

    
226
%/install: _always
227
	$(if $(isRef),$(exportHeader),$(if $(nonXml),$(import_install_)))
228
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
229
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs) $(logInstall*))
230

    
231
cleanup: _always $(tables:%=%/cleanup) ;
232

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

    
240
##### Maps building
241

    
242
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
243
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
244

    
245
# Maps to (try to) build are added to this
246
maps :=
247

    
248
srcRoot = $(mappings)/root.sh
249
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
250

    
251
# Via maps cleanup
252
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
253
%/.map.csv.last_cleanup: %/map.csv $(vocab) $(dict)
254
	$(bin)/in_place $< $(bin)/canon 1 $(vocab)
255
	$(bin)/in_place $< $(bin)/canon 1 $(dict)
256
	$(bin)/in_place $< $(bin)/translate 1 $(dict)
257
	touch $@
258
	+$(selfMake) $(<:%/map.csv=%/unmapped_terms.csv)
259
	+$(selfMake) $(<:%/map.csv=%/new_terms.csv)
260
# Include comment column so commented mappings are never removed
261
else
262
%/map.csv: _always
263
	$(if $(wildcard $@),,$(if $(nonXml),$(mkSrcMap)))
264
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
265
endif
266

    
267
%/VegBIEN.csv: %/map.csv $(coreMap)
268
	<$< $(bin)/cat_cols 1 2|$(bin)/join $(coreMap)|$(bin)/sort_map >$@
269
maps += $(autogenMaps)
270

    
271
maps: $(maps) _always ;
272

    
273
all += $(maps)
274

    
275
##### Maps validation
276

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

    
280
%/unmapped_terms.csv: %/map.csv $(coreMap)
281
	tail -n +2 $<|$(bin)/cols 1|$(bin)/filter_out_ci 0 $(coreMap) >$@
282
	$(bin)/autoremove $@
283

    
284
%/new_terms.csv: %/map.csv $(vocab) $(dict) %/unmapped_terms.csv
285
	$(newTerms)
286
	$(bin)/autoremove $@
287
newTerms = tail -n +2 $<|$(bin)/filter_out_ci 0 $(vocab)|$(bin)/filter_out_ci 0\
288
$(dict) $(if $(wildcard $(word 4,$+)),|$(bin)/filter_out_ci 0 $(word 4,$+)) >$@
289

    
290
termsSubdirs := $(tables)
291

    
292
include $(root)/lib/mappings.Makefile
293

    
294
##### External dependencies
295

    
296
$(root)/%: _always
297
	+$(subMake)
298
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
299

    
300
##### Mapping
301

    
302
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
303
map2db = env in_database=vegbien in_schema=$(datasrc) in_table=$*\
304
out_database=vegbien $(root)/map $(+maps)
305

    
306
##### Import to VegBIEN
307

    
308
profileTest = $(if $(profile),$(if $(test),1))
309
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
310
$(bin)/profile_stats /dev/fd/0
311

    
312
log_ = $*/logs/$(if $(n),n=$(n).,)$(date).log.sql
313
trace = $(log_:.log.sql=.trace)
314
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
315
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
316
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
317
# don't abort on import errors, which often relate to invalid input data
318

    
319
import: $(tables:%=%/import) _always ;
320

    
321
%/import: %/VegBIEN.csv _always
322
	$(import)
323
# default:
324
%/import: _always ;
325

    
326
##### Log files from import
327

    
328
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
329

    
330
rm_logs: _always
331
	$(RM) $(logs)
332

    
333
##### Verification of import
334

    
335
verify: $(tables:%=%/verify) _always ;
336

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

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

    
350
verify/%.out: $(mappings)/verify.%.sql _always
351
	$(verify)
352
# default:
353
verify/%.out: _always ;
354

    
355
all += $(wildcard verify/*.out)
356

    
357
%.ref: %.ref.sql
358
	($(inDatasrc); cat $<)|$(psqlExport) >$@
359

    
360
##### Editing import
361

    
362
rotate: _always
363
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
364
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
365

    
366
rm: _always
367
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
368
$(psqlAsBien)
369

    
370
##### Testing
371

    
372
testRefOutput = $(subst .by_col,,$(1))
373
testRef = $(testRefOutput).ref
374
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
375
# filter returns non-empty if they are equal
376

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

    
399
tests :=
400

    
401
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
402
# Non-flat-file inputs fall back to mimicking a successful test
403
%/test.xml: %/VegBIEN.csv _always
404
	$(if $(nonXml),$(call runTest,by_col=))
405
tests += %/test.xml
406

    
407
%/test.by_col.xml: %/VegBIEN.csv _always
408
	$(if $(nonXml),$(call runTest,by_col=1))
409

    
410
# Only run column-based tests if column-based mode enabled, because these tests
411
# are much slower than the row-based tests for small numbers of rows
412
ifneq ($(by_col),)
413
tests += %/test.by_col.xml
414
endif
415

    
416
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
417

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

    
420
test: _always $(testOutputs) ;
421

    
422
all += $(wildcard %/test*.xml)
423

    
424
# Accepts a test output: make <test_output_path>-ok
425
%-ok: _always
426
	mv $* $(call testRef,$*)
427

    
428
accept-all: _always
429
	+yes|$(selfMake) test
430

    
431
##### Documentation
432

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

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