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

    
65
# SVN
66
addDir = $(if $(wildcard $(1)/),svn add --depth=empty $(1),svn mkdir $(1))
67
setSvnIgnore = svn propset svn:ignore $(2) $(1)
68
define addDirWithIgnore
69
$(addDir)
70
$(setSvnIgnore)
71
endef
72

    
73
##### General targets
74

    
75
all: _always maps ;
76

    
77
clean: _always
78
	$(RM) $(all)
79

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

    
84
make_script = ./$< >$@
85

    
86
%/: % _always ;
87

    
88
# Must come before `%: %.make` to override it
89
%: %.make _always
90
	(set -x; $(make_script)) 2>>$<.log.sql
91
.PRECIOUS: % # save partial outputs of aborted src make scripts
92

    
93
%: %.make _always
94
	$(make_script)
95

    
96
##### SVN
97

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

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

    
108
##### Existing maps discovery
109

    
110
sortFile := import_order.txt
111

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

    
122
srcMaps := $(wildcard */src.csv)
123

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

    
130
extsFilter := $(addprefix %.,$(exts))
131
dataOnly = $(filter $(extsFilter),$(1))
132

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

    
136
via := Veg+
137

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

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

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

    
149
##### Sources
150

    
151
srcs = $(call sortFilenames,$(call srcsOnly,$(wildcard $*/*)))
152
isCsv = $(if $(srcs),$(if $(filter %.xml,$(srcs)),,1))
153
    # true if $(srcs) non-empty and contains no *.xml
154
catSrcs = $(bin)/cat$(if $(isCsv),_csv) $(srcs)
155
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
156

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

    
160
%/cat: _always
161
	$(catSrcs)
162

    
163
##### Staging tables installation
164

    
165
install: _always schema $(allTables:%=%/install) ;
166

    
167
uninstall: _always rm_schema ;
168
# rm_schema will also drop all staging tables
169

    
170
reinstall: _always uninstall install ;
171

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

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

    
179
# For staging tables which are derived by joining together other staging tables.
180
%/install: %/create.sql _always
181
	(echo 'SET search_path TO "$(datasrc)";'; echo 'CREATE TABLE "$*" AS';\
182
cat $<; echo ';'; \
183
echo 'ALTER TABLE "$*" ADD COLUMN row_num serial NOT NULL PRIMARY KEY;'; \
184
echo 'VACUUM ANALYZE "$*";')|$(psqlAsBien) --echo-all
185
	(prefix=; . $(bin)/vegbien_dest; env schema=$(datasrc) table=$* \
186
errors_table_only=1 $(bin)/csv2db)
187

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

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

    
199
##### Maps building
200

    
201
# Maps to (try to) build are added to one of these
202
maps :=
203
createOnlyMaps :=
204

    
205
srcRoot = $(mappings)/root.sh
206
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
207

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

    
222
createOnlyMaps += $(tables:%=%/src.csv)
223

    
224
# Must come before $(root)/% to override it
225
$(coreSelfMap): _always
226
	-+$(subMake)
227
# ignore errors if $(coreSelfMap) does not exist
228

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

    
241
srcMap* = $*/src.csv
242
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(srcMap*) 0)
243
hasSrc = $(shell test -s $(word 3,$+) && echo t)
244

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

    
247
%/map.full.csv: %/map.csv $(coreSelfMap)
248
	$(makeFullCsv)
249
	$(joinSrcMap)
250
maps += $(patsubst %/map.csv,%/map.full.csv,$(viaMaps))
251

    
252
%/VegBIEN.csv: %/map.full.csv $(coreMap)
253
	$(bin)/join <$+|$(bin)/sort_map >$@
254
maps += $(autogenMaps)
255

    
256
maps: $(createOnlyMaps) $(maps) _always ;
257

    
258
all += $(maps)
259

    
260
##### Maps validation
261

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

    
266
include $(root)/lib/mappings.Makefile
267

    
268
##### External dependencies
269

    
270
$(root)/%: _always
271
	+$(subMake)
272
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
273

    
274
##### Mapping
275

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

    
283
##### Import to VegBIEN
284

    
285
profileTest = $(if $(profile),$(if $(test),1))
286
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
287
$(bin)/profile_stats /dev/fd/0
288

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

    
296
import: $(tables:%=%/import) _always ;
297

    
298
%/import: %/VegBIEN.csv _always
299
	$(import)
300
# default:
301
%/import: _always ;
302

    
303
##### Log files from import
304

    
305
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
306

    
307
rm_logs: _always
308
	$(RM) $(logs)
309

    
310
##### Verification of import
311

    
312
verify: $(tables:%=%/verify) _always ;
313

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

    
323
verify = $(if $(reverify),"time" $(psqlAsBien) --set=datasource="'$(datasrc)'"\
324
--no-align --field-separator=$$'\t' --pset=footer=off --pset=null=NULL <$< >$@)
325

    
326
verify/%.out: $(mappings)/verify.%.sql _always
327
	$(verify)
328
# default:
329
verify/%.out: _always ;
330

    
331
all += $(wildcard verify/*.out)
332

    
333
##### Editing import
334

    
335
rotate: _always
336
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
337
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
338

    
339
rm: _always
340
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
341
$(psqlAsBien)
342

    
343
##### Testing
344

    
345
testRefOutput = $(subst .2-step,,$(subst .staging,,$(1)))
346
testRef = $(testRefOutput).ref
347
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
348
# filter returns non-empty if they are equal
349

    
350
# `rm $@`: Remove outputs of successful tests to reduce clutter
351
define runTest
352
@echo "Testing $(abspath $@)..."
353
>$@ env test=1 n=$(test_n) $(1)
354
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 && rm $@ || { e=$$?;\
355
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
356
$(if $(hasOwnRef),\
357
{\
358
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
359
if test "$$REPLY" = y; then\
360
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
361
exit 0;\
362
fi;\
363
};,\
364
echo $(emph)"Note: The preceding failed test is compared to another test's\
365
output"$(endEmph);\
366
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
367
)\
368
exit $$e;}
369
endef
370

    
371
test2Db = $(call runTest,$(map2db))
372

    
373
tests :=
374

    
375
%/test.xml: %/VegBIEN.csv _always
376
	$(test2Db)
377
tests += %/test.xml
378

    
379
testStaged2Db = $(foreach use_staged,1,$(test2Db))
380
    # run with use_staged=1
381

    
382
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
383
%/test.staging.xml: %/VegBIEN.csv _always
384
	-$(if $(isCsv),$(testStaged2Db))
385
# Don't abort tester if only staging test fails, in case staging table missing
386
# Non-flat-file inputs fall back to mimicking a successful test
387
tests += %/test.staging.xml
388

    
389
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
390

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

    
393
test: _always $(testOutputs) ;
394

    
395
all += $(wildcard %/test*.xml)
396

    
397
# Accepts a test output: make <test_output_path>-ok
398
%-ok: _always
399
	$(CP) $* $(call testRef,$*)
400

    
401
accept-all: _always
402
	+yes|$(selfMake) test
403

    
404
##### Documentation
405

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

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