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
logInstall = $(if $(log),$(if $(quiet),&>,2>&1|tee $(2)\
188
)$(1)logs/install.log.sql)
189
logInstall* = $(call logInstall,$*/)
190
logInstall*Add = $(call logInstall,$*/,-a)# append to log
191

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

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

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

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

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

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

    
224
%/install: _always
225
	$(if $(isRef),$(exportHeader),$(if $(nonXml),$(import_install_)))
226
	$(if $(wildcard $*/postprocess.sql),($(inDatasrc); cat $*/postprocess.sql;)\
227
|"time" $(psqlAsBien) --echo-all --set=table='"$*"' $(logInstall*Add))
228
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
229
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs) $(logInstall*))
230

    
231
##### Maps building
232

    
233
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
234
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
235

    
236
# Maps to (try to) build are added to this
237
maps :=
238

    
239
srcRoot = $(mappings)/root.sh
240
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
241

    
242
# Via maps cleanup
243
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
244
%/.map.csv.last_cleanup: %/map.csv $(vocab) $(dict)
245
	$(bin)/in_place $< $(bin)/canon 1 $(vocab)
246
	$(bin)/in_place $< $(bin)/canon 1 $(dict)
247
	$(bin)/in_place $< $(bin)/translate 1 $(dict)
248
	touch $@
249
	+$(selfMake) $(<:%/map.csv=%/unmapped_terms.csv)
250
	+$(selfMake) $(<:%/map.csv=%/new_terms.csv)
251
# Include comment column so commented mappings are never removed
252
else
253
%/map.csv: _always
254
	$(if $(wildcard $@),,$(if $(nonXml),$(mkSrcMap)))
255
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
256
endif
257

    
258
%/VegBIEN.csv: %/map.csv $(coreMap)
259
	<$< $(bin)/cat_cols 1 2|$(bin)/join $(coreMap)|$(bin)/sort_map >$@
260
maps += $(autogenMaps)
261

    
262
maps: $(maps) _always ;
263

    
264
all += $(maps)
265

    
266
##### Maps validation
267

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

    
271
%/unmapped_terms.csv: %/map.csv $(coreMap)
272
	tail -n +2 $<|$(bin)/cols 1|$(bin)/filter_out_ci 0 $(coreMap) >$@
273
	$(bin)/autoremove $@
274

    
275
%/new_terms.csv: %/map.csv $(vocab) $(dict) %/unmapped_terms.csv
276
	$(newTerms)
277
	$(bin)/autoremove $@
278
newTerms = tail -n +2 $<|$(bin)/filter_out_ci 0 $(vocab)|$(bin)/filter_out_ci 0\
279
$(dict) $(if $(wildcard $(word 4,$+)),|$(bin)/filter_out_ci 0 $(word 4,$+)) >$@
280

    
281
termsSubdirs := $(tables)
282

    
283
include $(root)/lib/mappings.Makefile
284

    
285
##### External dependencies
286

    
287
$(root)/%: _always
288
	+$(subMake)
289
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
290

    
291
##### Mapping
292

    
293
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
294
map2db = env in_database=vegbien in_schema=$(datasrc) in_table=$*\
295
out_database=vegbien $(root)/map $(+maps)
296

    
297
##### Import to VegBIEN
298

    
299
profileTest = $(if $(profile),$(if $(test),1))
300
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
301
$(bin)/profile_stats /dev/fd/0
302

    
303
log_ = $*/logs/$(if $(n),n=$(n).,)$(date).log.sql
304
trace = $(log_:.log.sql=.trace)
305
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
306
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
307
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
308
# don't abort on import errors, which often relate to invalid input data
309

    
310
import: $(tables:%=%/import) _always ;
311

    
312
%/import: %/VegBIEN.csv _always
313
	$(import)
314
# default:
315
%/import: _always ;
316

    
317
##### Log files from import
318

    
319
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
320

    
321
rm_logs: _always
322
	$(RM) $(logs)
323

    
324
##### Verification of import
325

    
326
verify: $(tables:%=%/verify) _always ;
327

    
328
%/verify: verify/%.ref verify/%.out _always
329
	-$(diffVerbose) $(+_)
330
# don't abort on verification errors, which are expected during development
331
# default:
332
%/verify: verify/%.out _always
333
	$(if $(shell test -e $< && echo t),cat $<)
334
# don't run if verify/%.out's default do-nothing action was used
335
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
336

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

    
341
verify/%.out: $(mappings)/verify.%.sql _always
342
	$(verify)
343
# default:
344
verify/%.out: _always ;
345

    
346
all += $(wildcard verify/*.out)
347

    
348
%.ref: %.ref.sql
349
	($(inDatasrc); cat $<)|$(psqlExport) >$@
350

    
351
##### Editing import
352

    
353
rotate: _always
354
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
355
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
356

    
357
rm: _always
358
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
359
$(psqlAsBien)
360

    
361
##### Testing
362

    
363
testRefOutput = $(subst .by_col,,$(1))
364
testRef = $(testRefOutput).ref
365
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
366
# filter returns non-empty if they are equal
367

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

    
390
tests :=
391

    
392
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
393
# Non-flat-file inputs fall back to mimicking a successful test
394
%/test.xml: %/VegBIEN.csv _always
395
	$(if $(nonXml),$(call runTest,by_col=))
396
tests += %/test.xml
397

    
398
%/test.by_col.xml: %/VegBIEN.csv _always
399
	$(if $(nonXml),$(call runTest,by_col=1))
400

    
401
# Only run column-based tests if column-based mode enabled, because these tests
402
# are much slower than the row-based tests for small numbers of rows
403
ifneq ($(by_col),)
404
tests += %/test.by_col.xml
405
endif
406

    
407
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
408

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

    
411
test: _always $(testOutputs) ;
412

    
413
all += $(wildcard %/test*.xml)
414

    
415
# Accepts a test output: make <test_output_path>-ok
416
%-ok: _always
417
	mv $* $(call testRef,$*)
418

    
419
accept-all: _always
420
	+yes|$(selfMake) test
421

    
422
##### Documentation
423

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

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