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
ifneq ($(wildcard $(sortFile)),)
113
tables := $(shell cat $(sortFile))# $(shell) replaces "\n" with " "
114
else
115
allSubdirs := $(call wildcard/,*/)
116
tables := $(call sortFilenames,$(filter-out _% src verify,$(allSubdirs:%/=%)))
117
endif
118

    
119
srcMaps := $(wildcard */src.csv)
120

    
121
srcMap := %/src.csv
122
viaMap := %/map.csv
123
fullViaMap := %/map.full.csv
124
directMap := %/VegBIEN.csv
125
anyMap := $(srcMap) $(viaMap) $(fullViaMap) $(directMap)
126

    
127
extsFilter := $(addprefix %.,$(exts))
128
dataOnly = $(filter $(extsFilter),$(1))
129

    
130
anyTest = $*/test.%
131
srcsOnly = $(filter-out $(anyMap) $(anyTest) %/logs,$(call dataOnly,$(1)))
132

    
133
via := Veg+
134

    
135
coreMap := $(mappings)/$(via)-VegBIEN.csv
136
coreSelfMap := $(mappings)/$(via).self.csv
137

    
138
viaMaps := $(wildcard $(tables:%=%/map.csv))
139
viaMaps += $(filter-out $(viaMaps),$(srcMaps:%/src.csv=%/map.csv))
140
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard */map.csv))
141

    
142
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
143
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
144
$(wildcard */VegBIEN.csv))
145

    
146
##### Sources
147

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

    
154
# Usage: `make {--silent|-s} inputs/<datasrc>/cat` (don't echo make commands)
155
cat: $(addprefix cat-,$(tables)) _always ;
156

    
157
cat-%: _always
158
	$(catSrcs)
159

    
160
##### Staging tables installation
161

    
162
install: _always schema $(addprefix install-,$(tables)) ;
163

    
164
uninstall: _always rm_schema ;
165
# rm_schema will also drop all staging tables
166

    
167
reinstall: _always uninstall install ;
168

    
169
schema: _always
170
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
171
# ignore errors if schema exists
172

    
173
rm_schema: _always
174
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
175

    
176
install-%: _always
177
	$(if $(isCsv),$(import_install_))
178
import_install_ = (prefix=; . $(bin)/vegbien_dest; "time" nice -n +5\
179
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs)\
180
$(if $(log),$(if $(quiet),&>,2>&1|tee )$*/logs/install.log.sql))
181

    
182
##### Maps building
183

    
184
# Maps to (try to) build are added to one of these
185
maps :=
186
createOnlyMaps :=
187

    
188
srcRoot = $(mappings)/root.sh
189
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
190

    
191
# Src maps cleanup
192
ifneq ($(filter %/.src.csv.last_cleanup,$(MAKECMDGOALS)),)
193
%/.src.csv.last_cleanup: %/src.csv
194
	$(bin)/in_place $< $(bin)/cols +
195
	touch $@
196
else
197
# Autogen src maps with known table names
198
%/src.csv: _always
199
	$(if $(wildcard $@),,$(if $(isCsv),$(mkSrcMap)))
200
	+$(if $(isCsv),$(selfMake) $(@:%/src.csv=%/.src.csv.last_cleanup))
201
# only build if doesn't exist
202
# only build if CSV srcs exist for that table name
203
endif
204

    
205
createOnlyMaps += $(tables:%=%/src.csv)
206

    
207
# Must come before $(root)/% to override it
208
$(coreSelfMap): _always
209
	-+$(subMake)
210
# ignore errors if $(coreSelfMap) does not exist
211

    
212
# Via maps cleanup
213
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
214
%/.map.csv.last_cleanup: %/map.csv $(coreMap)
215
	$(bin)/in_place $< env ignore=1 $(bin)/subtract $(word 2,$+) 0 1 2
216
	touch $@
217
# Include comment column so commented mappings are never removed
218
else
219
%/map.csv: %/src.csv _always
220
	$(if $(wildcard $@),,$(if $(wildcard $<),$(CP) $< $@))
221
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
222
endif
223

    
224
srcMap* = $*/src.csv
225
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(srcMap*) 0)
226
hasSrc = $(shell test -s $(word 3,$+) && echo t)
227

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

    
230
%/map.full.csv: %/map.csv $(coreSelfMap)
231
	$(makeFullCsv)
232
	$(joinSrcMap)
233
maps += $(patsubst %/map.csv,%/map.full.csv,$(viaMaps))
234

    
235
%/VegBIEN.csv: %/map.full.csv $(coreMap)
236
	$(bin)/join <$+|$(bin)/sort_map >$@
237
maps += $(autogenMaps)
238

    
239
maps: $(createOnlyMaps) $(maps) _always ;
240

    
241
all += $(maps)
242

    
243
##### Maps validation
244

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

    
249
include $(root)/lib/mappings.Makefile
250

    
251
##### External dependencies
252

    
253
$(root)/%: _always
254
	+$(subMake)
255
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
256

    
257
##### Mapping
258

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

    
266
##### Import to VegBIEN
267

    
268
profileTest = $(if $(profile),$(if $(test),1))
269
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
270
$(bin)/profile_stats /dev/fd/0
271

    
272
log_ = $*/logs/$(if $(n),n=$(n).,)$(date).log.sql
273
trace = $(log_:.log.sql=.trace)
274
import = -$(if $(profileTest),$(profileOnly),(set -x; "time" env commit=1\
275
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
276
$(if $(n),,&>$(log_)))$(if $(log),$(if $(n), 2>&1|tee -a $(log_))))
277
# don't abort on import errors, which often relate to invalid input data
278

    
279
import: $(addprefix import-,$(tables)) _always ;
280

    
281
import-%: %/VegBIEN.csv _always
282
	$(import)
283
# default:
284
import-%: _always ;
285

    
286
##### Log files from import
287

    
288
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
289

    
290
rm_logs: _always
291
	$(RM) $(logs)
292

    
293
##### Verification of import
294

    
295
verify: $(addprefix verify-,$(tables)) _always ;
296

    
297
verify-%: verify/%.ref verify/%.out _always
298
	-$(diffVerbose) $(+_)
299
# don't abort on verification errors, which are expected during development
300
# default:
301
verify-%: verify/%.out _always
302
	$(if $(shell test -e $< && echo t),cat $<)
303
# don't run if verify/%.out's default do-nothing action was used
304
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
305

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

    
309
verify/%.out: $(mappings)/verify.%.sql _always
310
	$(verify)
311
# default:
312
verify/%.out: _always ;
313

    
314
all += $(wildcard verify/*.out)
315

    
316
##### Editing import
317

    
318
rotate: _always
319
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
320
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
321

    
322
rm: _always
323
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
324
$(psqlAsBien)
325

    
326
##### Testing
327

    
328
testRefOutput = $(subst .2-step,,$(subst .staging,,$(1)))
329
testRef = $(testRefOutput).ref
330
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
331
# filter returns non-empty if they are equal
332

    
333
# `rm $@`: Remove outputs of successful tests to reduce clutter
334
define runTest
335
@echo "Testing $(abspath $@)..."
336
>$@ env test=1 n=$(test_n) $(1)
337
@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1 && rm $@ || { e=$$?;\
338
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
339
$(if $(hasOwnRef),\
340
{\
341
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
342
if test "$$REPLY" = y; then\
343
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
344
exit 0;\
345
fi;\
346
};,\
347
echo $(emph)"Note: The preceding failed test is compared to another test's\
348
output"$(endEmph);\
349
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
350
)\
351
exit $$e;}
352
endef
353

    
354
test2Db = $(call runTest,$(map2db))
355

    
356
tests :=
357

    
358
%/test.xml: %/VegBIEN.csv _always
359
	$(test2Db)
360
tests += %/test.xml
361

    
362
testStaged2Db = $(foreach use_staged,1,$(test2Db))
363
    # run with use_staged=1
364

    
365
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
366
%/test.staging.xml: %/VegBIEN.csv _always
367
	-$(if $(isCsv),$(testStaged2Db))
368
# Don't abort tester if only staging test fails, in case staging table missing
369
# Non-flat-file inputs fall back to mimicking a successful test
370
tests += %/test.staging.xml
371

    
372
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
373

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

    
376
test: _always $(testOutputs) ;
377

    
378
all += $(wildcard %/test*.xml)
379

    
380
# Accepts a test output: make <test_output_path>-ok
381
%-ok: _always
382
	$(CP) $* $(call testRef,$*)
383

    
384
accept-all: _always
385
	+yes|$(selfMake) test
386

    
387
##### Documentation
388

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

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