Project

General

Profile

1
##### Configuration
2

    
3
log ?= $(if $(test),,1)
4
profile ?=
5
exts ?= csv xml
6
test_n ?= 2
7
tablesSort ?= plots organisms stems
8

    
9
##### Vars/functions
10

    
11
selfDir_uZPPqC := $(dir $(lastword $(MAKEFILE_LIST)))
12

    
13
# Make
14
SHELL := /bin/bash
15
subMake = $(MAKE) $(@F) --directory=$(@D)
16
+_ = $(+:_%=)
17
addBeforeExt = $(basename $(2))$(1)$(suffix $(2))
18

    
19
# System
20
date = $(shell date +"%Y-%m-%d-%H-%M-%S")
21

    
22
# Terminal
23
termCols := $(shell tput cols)
24
esc := '['
25
reset := $(esc)'0m'
26
emph := $(esc)'7m '
27
endEmph := ' '$(reset)
28

    
29
# Commands
30
MKDIR = mkdir -p
31
mkdir = $(MKDIR) $(@D)
32
CP = cp -p
33
diff = diff --unified=2
34
diffVerbose = $(if $(verbose),diff --side-by-side --left-column\
35
--width=$(termCols),$(diff))
36

    
37
# Paths
38
root := $(selfDir_uZPPqC)..
39
mappings := $(root)/mappings
40
datasrc := $(notdir $(realpath .))
41
psqlOpts := --set ON_ERROR_STOP=1 --quiet
42
psqlAsBien := $(root)/bin/psql_vegbien $(psqlOpts)
43

    
44
##### General targets
45

    
46
all: _always maps ;
47

    
48
.SUFFIXES: # turn off built-in suffix rules
49
.SECONDARY: # don't automatically delete intermediate files
50

    
51
_always:
52
.PHONY: _always
53

    
54
clean: _always
55
	$(RM) $(all)
56

    
57
%.out: %.make _always
58
	./$* >$@
59

    
60
##### SVN
61

    
62
svn_props: _always
63
	svn propset svn:ignore $$'*.log\n*.trace\nsrc*' .
64
	$(if $(wildcard maps/),svn propset svn:ignore $$'.~*' maps)
65
	$(if $(wildcard verify/),svn propset svn:ignore $$'*.out' verify)
66
	$(if $(wildcard test/),svn propset svn:ignore $$'*.out\n*.xml' test)
67

    
68
##### Installation
69

    
70
reinstall: _always uninstall install ;
71

    
72
##### Maps
73

    
74
fullViaMap := maps/%.full.csv
75
allViaMaps := $(filter-out maps/VegBIEN.%.csv $(fullViaMap),\
76
$(wildcard maps/*.csv))
77
via := $(firstword $(sort $(basename $(basename $(notdir $(allViaMaps))))))
78

    
79
coreMap := $(mappings)/$(via)-VegBIEN.%.csv
80
selfMap := $(mappings)/$(via).self.%.csv
81

    
82
viaMaps := $(wildcard $(tablesSort:%=maps/$(via).%.csv))
83
viaMaps += $(filter-out $(viaMaps) $(fullViaMap),$(wildcard maps/$(via).*.csv))
84

    
85
autogenMaps := $(subst $(via).,VegBIEN.,$(viaMaps))
86
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
87
$(wildcard maps/VegBIEN.*.csv))
88
tables := $(directMaps:maps/VegBIEN.%.csv=%)
89

    
90
# Must come before $(root)/% to override it
91
$(selfMap): _always
92
	-+$(subMake)
93
# ignore errors if $(selfMap) does not exist
94

    
95
$(root)/%: _always
96
	+$(subMake)
97

    
98
maps :=
99

    
100
maps/VegBIEN.%.csv: maps/$(via).%.csv $(coreMap)
101
	$(root)/bin/join_union_sort <$+ >$@
102

    
103
maps += $(autogenMaps)
104

    
105
makeFullCsv = $(if $(shell test -e $(word 2,$+) && echo t),\
106
env ignore=1 $(root)/bin/union <$+|$(root)/bin/sort_map >$@,$(CP) $< $@)
107

    
108
maps/$(via).%.full.csv: maps/$(via).%.csv $(selfMap)
109
	$(makeFullCsv)
110
# can't use $(wildcard) because it won't recheck file after $(selfMap) is run
111

    
112
maps += $(patsubst maps/%.csv,maps/%.full.csv,$(viaMaps))
113

    
114
maps: $(maps) _always ;
115

    
116
all += $(maps)
117

    
118
##### Mapping
119

    
120
dbFile := $(firstword $(wildcard src/db.*.sql))
121
inputFiles := $(wildcard src/*.csv src/*.xml)
122

    
123
+maps = $(filter maps/% $(mappings)/%,$(+_))
124
<in = $(firstword $(filter-out $(+maps),$(+_)) $(wildcard $(exts:%=src/*.$*.%)))
125
map = $(if $(<in),<$(<in) ,$(if $(mapEnv),env $(mapEnv) ,$(error\
126
No input file src/*.$*.{$(exts)} )))$(root)/map $(+maps)
127
map2db = env out_database=vegbien $(map)
128

    
129
##### Import to VegBIEN
130

    
131
ifneq ($(dbFile)$(inputFiles),)
132

    
133
log_ = $(@:-all=)$(if $(n),.n=$(n),).$(date).log
134
trace = $(log_:.log=.trace)
135
import = -(set -x; "time" env commit=1 verbose=1\
136
$(if $(profile),profile_to=$(trace)) $(map2db)) $(if $(log),\
137
$(if $(n),,>>$(log_))) 2>&1$(if $(log),$(if $(n),|tee -a $(log_)))
138
# don't abort on import errors, which often relate to invalid input data
139

    
140
import: $(addprefix import-,$(tables)) _always ;
141

    
142
import-%: maps/VegBIEN.%.csv _always
143
	$(import)
144
# default:
145
import-%: _always ;
146

    
147
else
148
import: _always ;
149
endif
150

    
151
##### Log files from import
152

    
153
logs := $(wildcard *.log *.trace)
154

    
155
rm_logs: _always
156
	$(RM) $(logs)
157

    
158
##### Verification of import
159

    
160
verify: $(addprefix verify-,$(tables)) _always ;
161

    
162
verify-%: verify/%.ref verify/%.out _always
163
	-$(diffVerbose) $(+_)
164
# don't abort on verification errors, which are expected during development
165
# default:
166
verify-%: verify/%.out _always
167
	$(if $(shell test -e $< && echo t),cat $<)
168
# don't run if verify/%.out's default do-nothing action was used
169
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
170

    
171
define verify
172
$(mkdir)
173
$(psqlAsBien) --set=datasource="'$(datasrc)'" --no-align\
174
--field-separator=$$'\t' --pset=footer=off --pset=null=NULL <$< >$@
175
endef
176

    
177
verify/%.out: $(mappings)/verify.%.sql _always
178
	$(verify)
179
# default:
180
verify/%.out: _always ;
181

    
182
all += $(wildcard verify/*.out)
183

    
184
ifneq ($(dbFile),)
185
%.ref: %.ref.sql
186
	$(dbAsBien) $(db) <$< >$@
187
endif
188

    
189
##### Testing
190

    
191
ifneq ($(wildcard test/),)
192

    
193
hasOwnRef = $(filter-out %.2-step.xml,$@)
194
testRef = $(1:.2-step.xml=.xml).ref
195

    
196
define runTest
197
@echo "Testing $(abspath $@)..."
198
>$@ env test=1 n=$(test_n) $(1)
199
@(set -x; $(diff) $(call testRef,$@) $@) 2>&1 || { e=$$?;\
200
$(if $(wildcard $(call testRef,$@)),,cat $@;)\
201
$(if $(hasOwnRef),\
202
echo $(emph)"To accept new test output:"$(endEmph);\
203
echo "$(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile";\
204
,\
205
echo $(emph)"Note: The preceding failed test is compared to another test's\
206
output"$(endEmph);\
207
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
208
)\
209
exit $$e;}
210
endef
211

    
212
test2File = $(call runTest,$(map))
213

    
214
tests :=
215

    
216
test/$(via).%.xml: maps/$(via).%.full.csv _always
217
	$(test2File)
218
tests += test/$(via).%.xml
219

    
220
test/VegBIEN.%.xml: maps/VegBIEN.%.csv _always
221
	$(test2File)
222
tests += test/VegBIEN.%.xml
223

    
224
test/VegBIEN.%.2-step.xml: test/$(via).%.xml $(coreMap) _always
225
	-$(test2File)
226
# Don't abort tester if only 2-step test fails, as it's often finicky
227
tests += test/VegBIEN.%.2-step.xml
228

    
229
test/import.%.out: maps/VegBIEN.%.csv _always
230
	$(call runTest,$(map2db))
231
tests += test/import.%.out
232

    
233
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
234

    
235
test: _always $(testOutputs) ;
236

    
237
all += $(testOutputs)
238

    
239
# Accepts a test output: make <test_output_path>-ok
240
%-ok: _always
241
	$(CP) $* $(call testRef,$*)
242

    
243
else
244
test: _always ;
245
endif
246

    
247
##### Input-type-specific
248

    
249
# Each input type needs var $(mapEnv) and targets install, uninstall
250

    
251
ifneq ($(dbFile),)
252

    
253
dbEngineExt := $(subst .,,$(suffix $(basename $(notdir $(dbFile)))))
254
db := $(datasrc)
255

    
256
#### Installation
257

    
258
install: _always db ;
259

    
260
uninstall: _always rm_db ;
261

    
262
#### DB-engine-specific
263

    
264
# Each DB engine needs vars $(dbEngine), $(dbAsBien) and targets db, rm_db
265

    
266
ifeq ($(dbEngineExt),my)
267

    
268
dbEngine := MySQL
269

    
270
bienPassword := $(shell cat $(root)/config/bien_password)
271
mysqlAs = mysql --user=$(1) --password='$(bienPassword)'
272
mysqlAsRoot := $(call mysqlAs,root)
273
dbAsBien := $(call mysqlAs,bien)
274

    
275
dbExists = $(shell echo "SHOW DATABASES LIKE '$(db)';"|$(mysqlAsRoot))
276

    
277
define createDb
278
echo "CREATE DATABASE $(db) DEFAULT CHARACTER SET latin1;"|$(mysqlAsRoot)
279
-$(mysqlAsRoot) --database=$(db) <$<
280
endef
281
# ignore errors in db import so that GRANT will still be run
282

    
283
db: $(dbFile) _always
284
	$(if $(dbExists),,$(createDb))
285
	echo "GRANT SELECT ON $(db).* TO 'bien'@'localhost';"|$(mysqlAsRoot)
286

    
287
rm_db: _always
288
	-echo "REVOKE ALL ON $(db).* FROM 'bien'@'localhost';"|$(mysqlAsRoot)
289
	echo "DROP DATABASE IF EXISTS $(db);"|$(mysqlAsRoot)
290
# ignore errors if grant not defined
291

    
292
### Unrecognized DB engine
293

    
294
else
295
$(error The DB filename $(dbFile) must be db.my.sql)
296
endif
297

    
298
# Must come after dbEngine is set
299
mapEnv := in_engine=$(dbEngine) in_database=$(db)
300

    
301
#### Unrecognized input type
302

    
303
else
304
install: _always ;
305
uninstall: _always ;
306
endif
(2-2/2)