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
viaMap := %/map.csv
130
directMap := %/VegBIEN.csv
131
anyMap := $(viaMap) $(directMap) %/unmapped_terms.csv\
132
%/new_terms.csv
133

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

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

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

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

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

    
150
##### Sources
151

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

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

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

    
169
##### Staging tables installation
170

    
171
dbExports := $(sort $(wildcard *.schema.sql))# schemas first
172
dbExports += $(sort $(filter-out $(dbExports),$(wildcard *.sql)))# all others
173
dbExports := $(strip $(dbExports))# += adds extra whitespace
174
allInstalls := $(if $(dbExports),sql) $(allTables)
175

    
176
install: _always schema $(allInstalls:%=%/install) ;
177

    
178
uninstall: _always rm_schema ;
179
# rm_schema will also drop all staging tables
180

    
181
reinstall: _always uninstall install ;
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
logInstall = $(if $(log),$(if $(quiet),&>,2>&1|tee $(2)\
191
)$(1)logs/install.log.sql)
192
logInstall* = $(call logInstall,$*/)
193
logInstall*Add = $(call logInstall,$*/,-a)# append to log
194

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

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

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

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

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

    
221
# For staging tables which are derived by joining together other staging tables.
222
%/install %/header.csv: %/create.sql _always
223
	($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';')|"time" \
224
$(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*)
225
	-$(addRowNum)
226
	$(exportHeader)
227
# ignore errors if create.sql already added a primary key
228
addRowNum = echo 'ALTER TABLE "$(datasrc)"."$*"\
229
ADD COLUMN row_num serial NOT NULL PRIMARY KEY;'|$(psqlAsBien) $(logInstall*Add)
230

    
231
# The joined tables must be suffixed with ".src" to prevent the creation of a
232
# row_num column, which collides during joins.
233
isJoinedTable = $(filter %.src,$*)
234
hasRowNum = $(if $(isJoinedTable),,1)
235

    
236
%/install: _always
237
	$(if $(isRef),$(exportHeader),$(if $(nonXml),$(import_install_)))
238
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
239
env schema=$(datasrc) table=$* has_row_num=$(hasRowNum) $(bin)/csv2db\
240
$(catSrcs) $(logInstall*))
241

    
242
##### Maps building
243

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

    
247
# Maps to (try to) build are added to this
248
maps :=
249

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

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

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

    
273
maps: $(maps) _always ;
274

    
275
all += $(maps)
276

    
277
##### Maps validation
278

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

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

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

    
292
termsSubdirs := $(tables)
293

    
294
include $(root)/lib/mappings.Makefile
295

    
296
##### External dependencies
297

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

    
302
##### Mapping
303

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

    
308
##### Import to VegBIEN
309

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

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

    
321
import: $(tables:%=%/import) _always ;
322

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

    
328
##### Log files from import
329

    
330
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
331

    
332
rm_logs: _always
333
	$(RM) $(logs)
334

    
335
##### Verification of import
336

    
337
verify: $(tables:%=%/verify) _always ;
338

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

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

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

    
357
all += $(wildcard verify/*.out)
358

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

    
362
##### Editing import
363

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

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

    
372
##### Testing
373

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

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

    
401
tests :=
402

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

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

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

    
418
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
419

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

    
422
test: _always $(testOutputs) ;
423

    
424
all += $(wildcard %/test*.xml)
425

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

    
430
accept-all: _always
431
	+yes|$(selfMake) test
432

    
433
##### Documentation
434

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

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