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,specimens,'*')
101
	$(call addDirWithIgnore,specimens/logs,$$'*.log.sql\n*.trace')
102
	$(call addDirWithIgnore,verify,'*.out')
103

    
104
##### Existing maps discovery
105

    
106
sortFile := import_order.txt
107

    
108
ifneq ($(wildcard $(sortFile)),)
109
tables := $(shell cat $(sortFile))# $(shell) replaces "\n" with " "
110
else
111
allSubdirs := $(call wildcard/,*/)
112
tables := $(call sortFilenames,$(filter-out _% src verify,$(allSubdirs:%/=%)))
113
endif
114

    
115
srcMaps := $(wildcard */src.csv)
116

    
117
srcMap := %/src.csv
118
viaMap := %/map.csv
119
fullViaMap := %/map.full.csv
120
directMap := %/VegBIEN.csv
121
anyMap := $(srcMap) $(viaMap) $(fullViaMap) $(directMap)
122

    
123
extsFilter := $(addprefix %.,$(exts))
124
dataOnly = $(filter $(extsFilter),$(1))
125

    
126
anyTest = $*/test.%
127
srcsOnly = $(filter-out $(anyMap) $(anyTest) %/logs,$(call dataOnly,$(1)))
128

    
129
via := Veg+
130

    
131
coreMap := $(mappings)/$(via)-VegBIEN.csv
132
coreSelfMap := $(mappings)/$(via).self.csv
133

    
134
viaMaps := $(wildcard $(tables:%=%/map.csv))
135
viaMaps += $(filter-out $(viaMaps),$(srcMaps:%/src.csv=%/map.csv))
136
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard */map.csv))
137

    
138
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
139
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
140
$(wildcard */VegBIEN.csv))
141

    
142
##### Sources
143

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

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

    
153
cat-%: _always
154
	$(catSrcs)
155

    
156
##### Staging tables installation
157

    
158
install: _always schema $(addprefix install-,$(tables)) ;
159

    
160
uninstall: _always rm_schema ;
161
# rm_schema will also drop all staging tables
162

    
163
reinstall: _always uninstall install ;
164

    
165
schema: _always
166
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlAsBien)
167
# ignore errors if schema exists
168

    
169
rm_schema: _always
170
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlAsBien)
171

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

    
178
##### Maps building
179

    
180
# Maps to (try to) build are added to one of these
181
maps :=
182
createOnlyMaps :=
183

    
184
srcRoot = $(mappings)/root.sh
185
mkSrcMap = $(catSrcs)|(. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map >$@)
186

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

    
201
createOnlyMaps += $(tables:%=%/src.csv)
202

    
203
# Must come before $(root)/% to override it
204
$(coreSelfMap): _always
205
	-+$(subMake)
206
# ignore errors if $(coreSelfMap) does not exist
207

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

    
220
srcMap* = $*/src.csv
221
joinSrcMap = $(if $(hasSrc),$(bin)/in_place $@ $(bin)/intersect $(srcMap*) 0)
222
hasSrc = $(shell test -s $(word 3,$+) && echo t)
223

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

    
226
%/map.full.csv: %/map.csv $(coreSelfMap)
227
	$(makeFullCsv)
228
	$(joinSrcMap)
229
maps += $(patsubst %/map.csv,%/map.full.csv,$(viaMaps))
230

    
231
%/VegBIEN.csv: %/map.full.csv $(coreMap)
232
	$(bin)/join <$+|$(bin)/sort_map >$@
233
maps += $(autogenMaps)
234

    
235
maps: $(createOnlyMaps) $(maps) _always ;
236

    
237
all += $(maps)
238

    
239
##### Maps validation
240

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

    
245
include $(root)/lib/mappings.Makefile
246

    
247
##### External dependencies
248

    
249
$(root)/%: _always
250
	+$(subMake)
251
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
252

    
253
##### Mapping
254

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

    
262
##### Import to VegBIEN
263

    
264
profileTest = $(if $(profile),$(if $(test),1))
265
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
266
$(bin)/profile_stats /dev/fd/0
267

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

    
275
import: $(addprefix import-,$(tables)) _always ;
276

    
277
import-%: %/VegBIEN.csv _always
278
	$(import)
279
# default:
280
import-%: _always ;
281

    
282
##### Log files from import
283

    
284
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
285

    
286
rm_logs: _always
287
	$(RM) $(logs)
288

    
289
##### Verification of import
290

    
291
verify: $(addprefix verify-,$(tables)) _always ;
292

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

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

    
305
verify/%.out: $(mappings)/verify.%.sql _always
306
	$(verify)
307
# default:
308
verify/%.out: _always ;
309

    
310
all += $(wildcard verify/*.out)
311

    
312
##### Editing import
313

    
314
rotate: _always
315
	echo "UPDATE party SET organizationname = organizationname||'.$(date)'\
316
WHERE organizationname = '$(datasrc)';"|$(psqlAsBien)
317

    
318
rm: _always
319
	echo "DELETE FROM party WHERE organizationname = '$(datasrc)';"|\
320
$(psqlAsBien)
321

    
322
##### Testing
323

    
324
testRefOutput = $(subst .2-step,,$(subst .staging,,$(1)))
325
testRef = $(testRefOutput).ref
326
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
327
# filter returns non-empty if they are equal
328

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

    
349
test2Db = $(call runTest,$(map2db))
350

    
351
tests :=
352

    
353
%/test.xml: %/VegBIEN.csv _always
354
	$(test2Db)
355
tests += %/test.xml
356

    
357
testStaged2Db = $(foreach use_staged,1,$(test2Db))
358
    # run with use_staged=1
359

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

    
367
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
368

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

    
371
test: _always $(testOutputs) ;
372

    
373
all += $(wildcard %/test*.xml)
374

    
375
# Accepts a test output: make <test_output_path>-ok
376
%-ok: _always
377
	$(CP) $* $(call testRef,$*)
378

    
379
accept-all: _always
380
	+yes|$(selfMake) test
381

    
382
##### Documentation
383

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

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