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 := $(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
##### General targets
76

    
77
all: _always maps ;
78

    
79
clean: _always
80
	$(RM) $(all)
81

    
82
remake: _always clean
83
	+$(selfMake)
84
# re-run make so that cache of existing files is reset
85

    
86
make_script = ./$< >$@
87

    
88
%/: % _always ;
89

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

    
98
##### SVN
99

    
100
add: _always
101
	$(call setSvnIgnore,.,'*')
102
	$(call addDirWithIgnore,verify,'*.out')
103
	$(call addFile,import_order.txt)
104

    
105
# Adds a new table subdir
106
%/add: _always
107
	$(call addDirWithIgnore,$*,'*')
108
	$(call addDirWithIgnore,$*/logs,$$'*.log.sql\n*.trace')
109

    
110
##### Existing maps discovery
111

    
112
sortFile := import_order.txt
113

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

    
124
srcMaps := $(wildcard */src.csv)
125

    
126
srcMap := %/src.csv
127
viaMap := %/map.csv
128
fullViaMap := %/map.full.csv
129
directMap := %/VegBIEN.csv
130
anyMap := $(srcMap) $(viaMap) $(fullViaMap) $(directMap)
131

    
132
extsFilter := $(addprefix %.,$(exts))
133
dataOnly = $(filter $(extsFilter),$(1))
134

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

    
138
via := Veg+
139

    
140
coreMap := $(mappings)/$(via)-VegBIEN.csv
141
coreSelfMap := $(mappings)/$(via).self.csv
142

    
143
viaMaps := $(wildcard $(tables:%=%/map.csv))
144
viaMaps += $(filter-out $(viaMaps),$(srcMaps:%/src.csv=%/map.csv))
145
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard */map.csv))
146

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

    
151
##### Sources
152

    
153
srcs = $(call sortFilenames,$(call srcsOnly,$(wildcard $*/*)))
154
isCsv = $(if $(srcs),$(if $(filter %.xml,$(srcs)),,1))
155
    # true if $(srcs) non-empty and contains no *.xml
156
catSrcs = $(bin)/cat$(if $(isCsv),_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 := $(wildcard *.sql)
168
allInstalls := $(dbExports) $(allTables)
169

    
170
install: _always schema $(allInstalls:%=%/install) ;
171

    
172
uninstall: _always rm_schema ;
173
# rm_schema will also drop all staging tables
174

    
175
reinstall: _always uninstall install ;
176

    
177
schema: _always
178
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
179
# ignore errors if schema exists
180

    
181
rm_schema: _always
182
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
183

    
184
# Must come before %/install to override it
185
%.sql/install: %.sql _always
186
	($(inDatasrc); grep -vF 'SET search_path' $<)|"time" $(psqlAsBien)
187

    
188
# For staging tables which are derived by joining together other staging tables.
189
%/install %/header.csv: %/create.sql _always
190
	($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';'; \
191
echo 'ALTER TABLE "$*" ADD COLUMN row_num serial NOT NULL PRIMARY KEY;'; \
192
echo 'VACUUM ANALYZE "$*";')|$(psqlAsBien) --echo-all
193
	(prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$* \
194
errors_table_only=1 $(bin)/csv2db)
195
	echo 'SELECT * FROM "$(datasrc)"."$*" LIMIT 0;'|$(psqlAsBien) \
196
--no-align --field-separator=, --pset=footer=off >$*/header.csv
197

    
198
# The joined tables must be suffixed with ".src" to prevent the creation of a
199
# row_num column, which collides during joins.
200
isJoinedTable = $(filter %.src,$*)
201
hasRowNum = $(if $(isJoinedTable),,1)
202

    
203
%/install: _always
204
	$(if $(isCsv),$(import_install_))
205
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
206
env schema=$(datasrc) table=$* has_row_num=$(hasRowNum) $(bin)/csv2db\
207
$(catSrcs) $(if $(log),$(if $(quiet),&>,2>&1|tee )$*/logs/install.log.sql))
208

    
209
##### Maps building
210

    
211
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
212
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
213

    
214
# Maps to (try to) build are added to one of these
215
maps :=
216
createOnlyMaps :=
217

    
218
srcRoot = $(mappings)/root.sh
219
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
220

    
221
# Src maps cleanup
222
ifneq ($(filter %/.src.csv.last_cleanup,$(MAKECMDGOALS)),)
223
%/.src.csv.last_cleanup: %/src.csv
224
	$(bin)/in_place $< $(bin)/cols +
225
	touch $@
226
else
227
# Autogen src maps with known table names
228
%/src.csv: _always
229
	$(if $(wildcard $@),,$(if $(isCsv),$(mkSrcMap)))
230
	+$(if $(isCsv),$(selfMake) $(@:%/src.csv=%/.src.csv.last_cleanup))
231
# only build if doesn't exist
232
# only build if CSV srcs exist for that table name
233
endif
234

    
235
createOnlyMaps += $(tables:%=%/src.csv)
236

    
237
# Must come before $(root)/% to override it
238
$(coreSelfMap): _always
239
	-+$(subMake)
240
# ignore errors if $(coreSelfMap) does not exist
241

    
242
# Via maps cleanup
243
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
244
%/.map.csv.last_cleanup: %/map.csv $(coreMap)
245
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
246
	touch $@
247
# Include comment column so commented mappings are never removed
248
else
249
%/map.csv: %/src.csv _always
250
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
251
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
252
endif
253

    
254
srcMap* = $*/src.csv
255
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(srcMap*) 0)
256
hasSrc = $(shell test -s $(word 3,$+) && echo t)
257

    
258
makeFullCsv = env ignore=1 $(bin)/union <$(wordlist 1,2,$+)|$(bin)/sort_map >$@
259

    
260
%/map.full.csv: %/map.csv $(coreSelfMap)
261
	$(makeFullCsv)
262
	$(joinSrcMap)
263
maps += $(patsubst %/map.csv,%/map.full.csv,$(viaMaps))
264

    
265
%/VegBIEN.csv: %/map.full.csv $(coreMap)
266
	$(bin)/join <$+|$(bin)/sort_map >$@
267
maps += $(autogenMaps)
268

    
269
maps: $(createOnlyMaps) $(maps) _always ;
270

    
271
all += $(maps)
272

    
273
##### Maps validation
274

    
275
missingMappingsCmd = +$(selfMake) remake 2>&1\
276
|$(SED) -n 's/^.*No $(*2Space) mapping for (.*)$$/\1/p'|$(SED) 's/\/_.*//'\
277
$(if $(filter non-empty_join,$*),|$(bin)/ucase_first 0)|sort|uniq
278

    
279
include $(root)/lib/mappings.Makefile
280

    
281
##### External dependencies
282

    
283
$(root)/%: _always
284
	+$(subMake)
285
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
286

    
287
##### Mapping
288

    
289
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
290
map = $(if $(srcs),$(withCatSrcs) $(root)/map $(+maps),\
291
$(shell echo Warning: No input file $*/*.{$(exts)} >&2)false)
292
# need false to run some command, when prefixed by `env ...` below
293
map2db = $(if $(use_staged),env in_database=vegbien in_schema=$(datasrc)\
294
in_table=$*) env out_database=vegbien $(map)
295

    
296
##### Import to VegBIEN
297

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

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

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

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

    
316
##### Log files from import
317

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

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

    
323
##### Verification of import
324

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

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

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

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

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

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

    
350
##### Editing import
351

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

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

    
360
##### Testing
361

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

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

    
389
tests :=
390

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

    
397
%/test.by_col.xml: %/VegBIEN.csv _always
398
	-$(if $(isCsv),$(call runTest,by_col=1))
399
# Don't abort tester if only by-column test fails
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)