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
install: _always schema $(allTables:%=%/install) ;
168

    
169
uninstall: _always rm_schema ;
170
# rm_schema will also drop all staging tables
171

    
172
reinstall: _always uninstall install ;
173

    
174
schema: _always
175
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
176
# ignore errors if schema exists
177

    
178
rm_schema: _always
179
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
180

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

    
191
# The joined tables must be suffixed with ".src" to prevent the creation of a
192
# row_num column, which collides during joins.
193
isJoinedTable = $(filter %.src,$*)
194
hasRowNum = $(if $(isJoinedTable),,1)
195

    
196
%/install: _always
197
	$(if $(isCsv),$(import_install_))
198
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
199
env schema=$(datasrc) table=$* has_row_num=$(hasRowNum) $(bin)/csv2db\
200
$(catSrcs) $(if $(log),$(if $(quiet),&>,2>&1|tee )$*/logs/install.log.sql))
201

    
202
##### Maps building
203

    
204
# WARNING: You CANNOT make a subdir using `make inputs/<datasrc>/<subdir>/`.
205
# You must instead make the entire datasource dir: `make inputs/<datasrc>/`
206

    
207
# Maps to (try to) build are added to one of these
208
maps :=
209
createOnlyMaps :=
210

    
211
srcRoot = $(mappings)/root.sh
212
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
213

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

    
228
createOnlyMaps += $(tables:%=%/src.csv)
229

    
230
# Must come before $(root)/% to override it
231
$(coreSelfMap): _always
232
	-+$(subMake)
233
# ignore errors if $(coreSelfMap) does not exist
234

    
235
# Via maps cleanup
236
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
237
%/.map.csv.last_cleanup: %/map.csv $(coreMap)
238
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
239
	touch $@
240
# Include comment column so commented mappings are never removed
241
else
242
%/map.csv: %/src.csv _always
243
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
244
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
245
endif
246

    
247
srcMap* = $*/src.csv
248
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(srcMap*) 0)
249
hasSrc = $(shell test -s $(word 3,$+) && echo t)
250

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

    
253
%/map.full.csv: %/map.csv $(coreSelfMap)
254
	$(makeFullCsv)
255
	$(joinSrcMap)
256
maps += $(patsubst %/map.csv,%/map.full.csv,$(viaMaps))
257

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

    
262
maps: $(createOnlyMaps) $(maps) _always ;
263

    
264
all += $(maps)
265

    
266
##### Maps validation
267

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

    
272
include $(root)/lib/mappings.Makefile
273

    
274
##### External dependencies
275

    
276
$(root)/%: _always
277
	+$(subMake)
278
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
279

    
280
##### Mapping
281

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

    
289
##### Import to VegBIEN
290

    
291
profileTest = $(if $(profile),$(if $(test),1))
292
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
293
$(bin)/profile_stats /dev/fd/0
294

    
295
log_ = $*/logs/$(if $(n),n=$(n).,)$(date).log.sql
296
trace = $(log_:.log.sql=.trace)
297
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
298
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
299
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
300
# don't abort on import errors, which often relate to invalid input data
301

    
302
import: $(tables:%=%/import) _always ;
303

    
304
%/import: %/VegBIEN.csv _always
305
	$(import)
306
# default:
307
%/import: _always ;
308

    
309
##### Log files from import
310

    
311
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
312

    
313
rm_logs: _always
314
	$(RM) $(logs)
315

    
316
##### Verification of import
317

    
318
verify: $(tables:%=%/verify) _always ;
319

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

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

    
333
verify/%.out: $(mappings)/verify.%.sql _always
334
	$(verify)
335
# default:
336
verify/%.out: _always ;
337

    
338
all += $(wildcard verify/*.out)
339

    
340
%.ref: %.ref.sql
341
	($(inDatasrc); cat $<)|$(psqlExport) >$@
342

    
343
##### Editing import
344

    
345
rotate: _always
346
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
347
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
348

    
349
rm: _always
350
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
351
$(psqlAsBien)
352

    
353
##### Testing
354

    
355
testRefOutput = $(subst .by_col,,$(1))
356
testRef = $(testRefOutput).ref
357
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
358
# filter returns non-empty if they are equal
359

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

    
382
tests :=
383

    
384
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
385
# Non-flat-file inputs fall back to mimicking a successful test
386
%/test.xml: %/VegBIEN.csv _always
387
	$(if $(isCsv),$(call runTest,by_col=))
388
tests += %/test.xml
389

    
390
%/test.by_col.xml: %/VegBIEN.csv _always
391
	-$(if $(isCsv),$(call runTest,by_col=1))
392
# Don't abort tester if only by-column test fails
393

    
394
# Only run column-based tests if column-based mode enabled, because these tests
395
# are much slower than the row-based tests for small numbers of rows
396
ifneq ($(by_col),)
397
tests += %/test.by_col.xml
398
endif
399

    
400
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
401

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

    
404
test: _always $(testOutputs) ;
405

    
406
all += $(wildcard %/test*.xml)
407

    
408
# Accepts a test output: make <test_output_path>-ok
409
%-ok: _always
410
	mv $* $(call testRef,$*)
411

    
412
accept-all: _always
413
	+yes|$(selfMake) test
414

    
415
##### Documentation
416

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

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