Project

General

Profile

1 3761 aaronmk
selfDir_uZPPqC := $(dir $(lastword $(MAKEFILE_LIST)))
2
root := $(selfDir_uZPPqC)..
3
include $(root)/lib/common.Makefile
4
5
6 783 aaronmk
##### Configuration
7
8 1921 aaronmk
# Command line
9 10582 aaronmk
continue ?=
10 10106 aaronmk
debug ?=
11 7245 aaronmk
full_import ?=
12 6592 aaronmk
import_source ?= 1
13 11251 aaronmk
is_view ?=
14 1190 aaronmk
log ?= $(if $(test),,1)
15 9833 aaronmk
noclobber ?=
16 1257 aaronmk
profile ?=
17 1983 aaronmk
quiet ?=
18 1620 aaronmk
reverify ?= 1
19 5810 aaronmk
schema_only ?=
20 1990 aaronmk
use_staged ?= $(by_col)
21 1921 aaronmk
22
# Makefile
23 12867 aaronmk
exts ?= csv tsv tab txt dat dmp
24 783 aaronmk
test_n ?= 2
25
26
##### Vars/functions
27
28 1821 aaronmk
# Paths
29 5008 aaronmk
datasrc := $(patsubst .%,%,$(notdir $(realpath .)))
30 1821 aaronmk
bin := $(root)/bin
31
mappings := $(root)/mappings
32
33 368 aaronmk
# Make
34 640 aaronmk
SHELL := /bin/bash
35 1509 aaronmk
selfMake = $(MAKE) --makefile=../input.Makefile
36 11253 aaronmk
subMake = $(MAKE) "$(@:$(root)/%=%)" --directory=$(root)
37 404 aaronmk
+_ = $(+:_%=)
38 10103 aaronmk
# used to filter the output of embedded $(shell make ...) invocations
39
filter_make := grep -vF -e lib -e ".Makefile'."
40 368 aaronmk
addBeforeExt = $(basename $(2))$(1)$(suffix $(2))
41
42 640 aaronmk
# Terminal
43 1184 aaronmk
termCols := $(shell tput cols)
44 640 aaronmk
45 368 aaronmk
# Commands
46 1245 aaronmk
MKDIR = mkdir -p
47
mkdir = $(MKDIR) $(@D)
48 1184 aaronmk
diff = diff --unified=2
49 3721 aaronmk
diffIgnoreSpace = $(diff) --ignore-space-change
50 1184 aaronmk
diffVerbose = $(if $(verbose),diff --side-by-side --left-column\
51
--width=$(termCols),$(diff))
52 368 aaronmk
53 1918 aaronmk
# BIEN commands
54 4137 aaronmk
sortFilenames = $(shell $(bin)/sort_filenames $(1))
55 1524 aaronmk
selfMap = $(bin)/cols 0 0
56 8108 aaronmk
psqlAsBien := $(bin)/psql_verbose_vegbien
57 6186 aaronmk
psqlNoSearchPath := env no_search_path=1 $(psqlAsBien)
58 4408 aaronmk
# Usage: ($(inDatasrc); cat $(file))|$(psqlCmd)
59 6186 aaronmk
inDatasrc := echo 'SET search_path TO "$(datasrc)";'
60 353 aaronmk
61 1594 aaronmk
# SVN
62 1771 aaronmk
setSvnIgnore = svn propset svn:ignore $(2) $(1)
63 1594 aaronmk
define addDirWithIgnore
64
$(addDir)
65 1771 aaronmk
$(setSvnIgnore)
66 1594 aaronmk
endef
67
68 4414 aaronmk
##### Environment
69
70
export PATH := $(bin):$(PATH)
71
72 783 aaronmk
##### General targets
73 250 aaronmk
74 418 aaronmk
all: _always maps ;
75 247 aaronmk
76 383 aaronmk
clean: _always
77 256 aaronmk
	$(RM) $(all)
78
79 1742 aaronmk
remake: _always clean
80
	+$(selfMake)
81
# re-run make so that cache of existing files is reset
82
83 5876 aaronmk
# Only remake if doesn't exist. This prevents unintentional remaking when the
84
# make script is newly checked out from svn (which sets the mod time to now) but
85
# the output is synced externally.
86
# Can't remove prereq to do this, because it determines when the rule applies.
87
make_script = $(if $(wildcard $@),,"time" ./$< >$@)
88 368 aaronmk
89 6743 aaronmk
%/: %/map.csv _always ;
90
91 1604 aaronmk
%/: % _always ;
92
93 4379 aaronmk
%: %.make
94 5876 aaronmk
	$(make_script)
95 4182 aaronmk
.PRECIOUS: % # save partial outputs of aborted src make scripts
96 1627 aaronmk
97 6379 aaronmk
##### Tables discovery
98 250 aaronmk
99 6379 aaronmk
sortFile := import_order.txt
100 6156 aaronmk
noImportFile := _no_import
101
102 9880 aaronmk
dontImport = $(wildcard $(noImportFile))$(wildcard $(1)/$(noImportFile))$(if\
103 6592 aaronmk
$(import_source),,$(filter Source,$(1)))
104 6379 aaronmk
105 10105 aaronmk
ifeq ($(sort_file_updated),)# keep $(sortFile) up-to-date
106
$(shell sort_file_updated=1 $(selfMake) $(sortFile)|$(filter_make) >&2)
107
export sort_file_updated=1
108 10104 aaronmk
endif
109
110 10101 aaronmk
sort_file_tables := $(if $(wildcard $(sortFile)),$(shell cat $(sortFile)))
111 6379 aaronmk
    # $(shell) replaces "\n" with " "
112 10101 aaronmk
tables := $(sort_file_tables)
113 6379 aaronmk
allSubdirs := $(call wildcard/,*/)
114
allTables := $(call sortFilenames,$(filter-out _% verify logs,$(allSubdirs:%/=%)))
115
joinedTables := $(filter-out $(tables),$(allTables))
116
allTables := $(strip $(joinedTables) $(tables))# move joined tables to beginning
117 8383 aaronmk
has_visible_files = $(call wildcard/,$(1)/*)
118
allTables := $(foreach table,$(allTables),$(if\
119
$(call has_visible_files,$(table)),$(table)))
120 6379 aaronmk
ifeq ($(tables),)# none specified in sort file
121
tables := $(allTables)
122
endif
123
importTables := $(foreach table,$(tables),$(if\
124
$(call dontImport,$(table)),,$(table)))
125
126 10100 aaronmk
list_tables: _always # use `make -s` to avoid echoing commands
127
	@for table in $(tables); do echo "$$table"; done
128
129 10101 aaronmk
$(sortFile): _always
130 10102 aaronmk
	$(if $(filter-out $(sort_file_tables),$(tables)),$(selfMake) -s list_tables >$@)
131 13416 aaronmk
# add any missing tables to $(sortFile)
132 10101 aaronmk
133 6379 aaronmk
##### SVN
134
135 14676 aaronmk
svnFilesGlob:= */{,{,.}{data,map,VegBIEN}.csv{,.*},*header.*,*.sql,test.xml.ref}
136
svnFilesGlob := {map.csv,*{grants,validations,~}*.sql,{,*/}{*.{log,make},*terms.csv},$(svnFilesGlob)}
137 11719 aaronmk
_svnFilesGlob := {_MySQL/{,*.make},{,*/}{$(noImportFile),*{run,Makefile},*.{md5,url},*README.TXT}}
138 9417 aaronmk
svnFiles = $(filter-out _% logs/% %.data.sql,$(call wildcard/,$(svnFilesGlob)))\
139 5923 aaronmk
$(call wildcard/,$(_svnFilesGlob))
140 5878 aaronmk
141 10167 aaronmk
add: _always $(if $(call dontImport,.),,add!) ;
142
143 6806 aaronmk
# To update all inputs with these settings: make inputs/add
144 10167 aaronmk
add!: _always Source/add $(allTables:%=%/add)
145 4182 aaronmk
	$(call setSvnIgnore,.,'*')
146 8801 aaronmk
	$(call addDirWithIgnore,logs,$$'*.gz\n*.log.sql\n*.trace')
147 13401 aaronmk
	$(call addDirWithIgnore,verify,$$'*.csv\n*.log\n*.out\n*.tsv\n*.txt\n*.xls\n*.xlsx')
148 4223 aaronmk
	$(call addFile,import_order.txt)
149 6014 aaronmk
	$(if $(wildcard _MySQL/),$(call addDirWithIgnore,_MySQL,'*'))
150 6064 aaronmk
	$(if $(wildcard _src/),$(call addDirWithIgnore,_src,'*'))
151 6733 aaronmk
	$(if $(wildcard _archive/),$(call addDirWithIgnore,_archive,'*'))
152 14761 aaronmk
	# invoke externally to clear $$(wildcard) cache before expanding $$(svnFiles)
153 14759 aaronmk
	$(selfMake) add_files
154
155
add_files: _always
156 12920 aaronmk
	$(call add*,$(svnFiles))
157 766 aaronmk
158 4217 aaronmk
# Adds a new table subdir
159
%/add: _always
160
	$(call addDirWithIgnore,$*,'*')
161 8801 aaronmk
	$(call addDirWithIgnore,$*/logs,$$'*.gz\n*.log.sql\n*.trace')
162 4217 aaronmk
163 1969 aaronmk
##### Existing maps discovery
164 1955 aaronmk
165 5035 aaronmk
anyMap := %/map.csv %/VegBIEN.csv %/unmapped_terms.csv %/new_terms.csv
166 3574 aaronmk
167 7386 aaronmk
exts := $(call ci,$(exts))
168 4214 aaronmk
extsFilter := $(addprefix %.,$(exts))
169
dataOnly = $(filter $(extsFilter),$(1))
170
171 4182 aaronmk
anyTest = $*/test.%
172 4214 aaronmk
srcsOnly = $(filter-out $(anyMap) $(anyTest) %/logs,$(call dataOnly,$(1)))
173 4120 aaronmk
174 6071 aaronmk
srcDict := map.csv
175
176 7485 aaronmk
vocab := $(mappings)/VegCore.vocab.csv
177
thesaurus := $(mappings)/VegCore.thesaurus.csv
178 4658 aaronmk
coreMap := $(mappings)/VegCore-VegBIEN.csv
179 783 aaronmk
180 10205 aaronmk
viaMaps := $(tables:%=%/map.csv)
181 783 aaronmk
182 4117 aaronmk
autogenMaps := $(subst map.,VegBIEN.,$(viaMaps))
183 728 aaronmk
directMaps := $(autogenMaps) $(filter-out $(autogenMaps),\
184 4182 aaronmk
$(wildcard */VegBIEN.csv))
185 728 aaronmk
186 1969 aaronmk
##### Sources
187
188 4182 aaronmk
srcs = $(call sortFilenames,$(call srcsOnly,$(wildcard $*/*)))
189 14777 aaronmk
nonHeaderSrcs = $(filter-out %/header.csv %/header.txt,$(srcs))
190 4450 aaronmk
isRef = $(if $(nonHeaderSrcs),,1)
191
    # empty subdir, so references an already-installed staging table
192 12795 aaronmk
catSrcs = $(bin)/cat_csv $(nonHeaderSrcs)
193 1969 aaronmk
withCatSrcs = $(catSrcs:$(bin)/%=$(bin)/with_%) --
194
195 14766 aaronmk
%/list_srcs: _always # use `make -s` to avoid echoing commands
196
	echo $(nonHeaderSrcs)
197
198 7076 aaronmk
# Run with `make -s` to avoid echoing make commands
199 6157 aaronmk
cat: $(importTables:%=%/cat) _always ;
200 1969 aaronmk
201 4252 aaronmk
%/cat: _always
202 1969 aaronmk
	$(catSrcs)
203
204 6363 aaronmk
##### Input data retrieval
205
206
# Must come before `%.sql: _MySQL/%.sql` to override it
207
%.sql: %.sql.make
208
	$(make_script)
209
210
# The export must be created with:
211
# `--compatible=postgresql --add-locks=false --set-charset --no-create-info`
212
# Must come before `%.sql: _MySQL/%.sql` to override it
213
%.data.sql: _MySQL/%.data.sql
214
	$(if $(wildcard $@),,$(bin)/my2pg.data <$< >$@)
215
216
# The export must be created with:
217
# `--compatible=postgresql --add-locks=false --set-charset`
218
# Add `--no-data` to create a schema-only export.
219
%.sql: _MySQL/%.sql
220
	$(if $(wildcard $@),,$(bin)/my2pg <$< >$@)
221
222 4121 aaronmk
##### Staging tables installation
223 1921 aaronmk
224 5693 aaronmk
srcTable := %.src
225
226 6364 aaronmk
dbExportsWildcard = $(sort $(patsubst _MySQL/%.make,%,$(wildcard\
227
$(1) _MySQL/$(1).make)))
228
229
dbExports := $(call dbExportsWildcard,*schema*.sql)# schemas first
230
ifeq ($(schema_only),) # add rest of .sql files
231
dbExports += $(filter-out $(dbExports),$(call dbExportsWildcard,*.sql))
232 5810 aaronmk
endif
233 10107 aaronmk
dbExports := $(filter-out grants.sql,$(dbExports))
234 4438 aaronmk
dbExports := $(strip $(dbExports))# += adds extra whitespace
235 10256 aaronmk
allInstalls := $(if $(dbExports),sql) $(allTables)
236 1921 aaronmk
237 13418 aaronmk
datasrc_schema_exists = $(shell schema=$(datasrc)\
238 13411 aaronmk
$(root)/lib/runscripts/local.run pg_schema_exists && echo t)
239 13410 aaronmk
240 11849 aaronmk
install: _always
241 13415 aaronmk
	$(if $(wildcard ./run),./run install,$(if $(wildcard table.run),$(if\
242
$(datasrc_schema_exists),,+$(selfMake) install_oldstyle)))
243 13369 aaronmk
	+$(selfMake) validate/install
244 13415 aaronmk
# table.run: only run this for datasource dirs
245 4413 aaronmk
246 11847 aaronmk
install_oldstyle: _always schema $(allInstalls:%=%/install) ;
247
248 5209 aaronmk
uninstall: _always confirm_rm_schema rm_schema ;
249 4121 aaronmk
# rm_schema will also drop all staging tables
250 1921 aaronmk
251
reinstall: _always uninstall install ;
252
253 5209 aaronmk
confirm_rm_schema: _always
254
	$(if $(filter TNRS,$(datasrc)),$(call confirm,WARNING: This will delete the\
255
TNRS cache!,To save it: make backups/TNRS.backup-remake))
256
257 4121 aaronmk
schema: _always
258 6186 aaronmk
	-echo 'CREATE SCHEMA "$(datasrc)";'|$(psqlNoSearchPath)
259 1921 aaronmk
# ignore errors if schema exists
260
261 4121 aaronmk
rm_schema: _always
262 6186 aaronmk
	echo 'DROP SCHEMA IF EXISTS "$(datasrc)" CASCADE;'|$(psqlNoSearchPath)
263 1921 aaronmk
264 5162 aaronmk
installLog := logs/install.log.sql
265 4453 aaronmk
266 8382 aaronmk
log_dir = $(1)logs
267 9833 aaronmk
has_log_dir = $(call and,$(wildcard $(log_dir)),$(call not,$(noclobber)))
268 8382 aaronmk
logInstall = $(if $(has_log_dir),$(if $(quiet),$(2)$(1)$(installLog)\
269
2>&1,2>&1|tee $(3) $(1)$(installLog)))
270 5692 aaronmk
logInstallRoot = $(call logInstall,,>)
271 5162 aaronmk
logInstall* = $(call logInstall,$*/,>)
272
logInstall*Add = $(call logInstall,$*/,>>,-a)# append to log
273
274 4413 aaronmk
# Must come before %/install to override it
275 4434 aaronmk
sql/install: $(dbExports)
276 14532 aaronmk
	set -o pipefail; ($(inDatasrc); $(if $(wildcard schema.sql),cat schema.sql;)\
277
cat $(filter-out schema.sql grants.sql,$+)|pg_dump_limit $(if $(wildcard\
278
grants.sql),; cat grants.sql))|"time" env no_search_path=1 \
279 10106 aaronmk
$(bin)/psql_$(if $(debug),verbose,script)_vegbien --set=schema='"$(datasrc)"' \
280
$(logInstallRoot)
281 4413 aaronmk
282 10106 aaronmk
# $debug option runs the *.sql import verbosely, to display which statements are
283
# being run. this should only be used for SQL files that use COPY FROM to import
284
# data, to avoid echoing pages of insert statements.
285 12793 aaronmk
cleanup = set -o pipefail; \
286
$(if $(wildcard $*/cleanup.sql),($(inDatasrc); cat $*/cleanup.sql)\
287 6186 aaronmk
|"time" $(psqlNoSearchPath) --echo-all --set=table='"$*"' $(logInstall*Add),\
288 7065 aaronmk
(export schema=$(datasrc) table=$*; . $(bin)/vegbien_dest; unset schemas; \
289 6186 aaronmk
$(bin)/csv2db) $(logInstall*Add))
290 4449 aaronmk
291 8160 aaronmk
%/header.csv:
292 11810 aaronmk
	set -o pipefail; \
293
echo 'COPY (SELECT * FROM "$(datasrc)"."$*" LIMIT 0) TO STDOUT CSV HEADER;'|\
294 8201 aaronmk
env no_search_path=1 $(bin)/psql_script_vegbien >$*/header.csv
295 4449 aaronmk
296 11253 aaronmk
exportHeader = $(selfMake) "$*/header.csv"
297 8160 aaronmk
298 7067 aaronmk
# Don't try to edit a view. Must come before %/install to override it.
299
%_view/install: _always ;
300
301 8238 aaronmk
%.sql/run: _always
302
	$(if $(wildcard $(@D)),($(inDatasrc); cat $(@D))|(cd '$(*D)';\
303
"time" env no_search_path=1 ../$(bin)/psql_verbose_vegbien \
304
--set=table='"$(*D)"' --set=table_str=\''"$(*D)"'\'))
305
306 12751 aaronmk
%/postprocess.sql: $(thesaurus) _always
307
	$(if $(wildcard $*/run),$(bin)/in_place $@ env text=1 $(bin)/repl $<)
308 10312 aaronmk
309 9842 aaronmk
%/postprocess: _always
310 13375 aaronmk
	$(if\
311
$(wildcard $*/run),$*/run postprocess,$(selfMake) "$*/postprocess.sql/run")
312 8238 aaronmk
313 10240 aaronmk
%/map_table: _always
314
	$(if $(wildcard $*/run),$*/run map_table)
315
316 4260 aaronmk
# For staging tables which are derived by joining together other staging tables.
317 10994 aaronmk
%/install: %/create.sql _always
318 11802 aaronmk
	set -o pipefail; \
319
($(inDatasrc); echo 'CREATE TABLE "$*" AS'; cat $<; echo ';')|"time" \
320 6186 aaronmk
$(psqlNoSearchPath) --echo-all --set=schema='"$(datasrc)"' --set=table='"$*"' \
321 5912 aaronmk
$(logInstall*)
322 14588 aaronmk
	$(exportHeader)
323 11253 aaronmk
	$(selfMake) "$*/postprocess"
324 8157 aaronmk
	$(cleanup)
325 4260 aaronmk
326 4252 aaronmk
%/install: _always
327 12795 aaronmk
	$(import_install_)
328 14588 aaronmk
	$(exportHeader)
329 11253 aaronmk
	$(selfMake) "$*/postprocess"
330 12795 aaronmk
	$(cleanup)
331 5693 aaronmk
define import_install_
332 14582 aaronmk
set -o pipefail; (. $(bin)/vegbien_dest; unset schemas; "time" $(nice)\
333 5028 aaronmk
env schema=$(datasrc) table=$* $(bin)/csv2db $(catSrcs) $(logInstall*))
334 5693 aaronmk
$(if $(filter $(srcTable),$*),($(inDatasrc);\
335
echo 'ALTER TABLE "$(datasrc)"."$*" RENAME row_num TO "$*.row_num";')|"time"\
336 6186 aaronmk
$(psqlNoSearchPath) --echo-all --set=table='"$*"' $(logInstall*Add))
337 5693 aaronmk
endef
338 5697 aaronmk
# table-scope src table's row_num col to allow joining it with other tables
339 1921 aaronmk
340 5819 aaronmk
%/uninstall: _always
341 11251 aaronmk
	echo 'DROP $(if\
342
$(is_view),VIEW,TABLE) IF EXISTS "$(datasrc)"."$*" CASCADE;'|$(psqlNoSearchPath)
343 5819 aaronmk
344
%/reinstall: _always %/uninstall %/install ;
345
346 8241 aaronmk
postprocess: _always $(allTables:%=%/postprocess) ;
347 8113 aaronmk
348 5155 aaronmk
cleanup: _always $(tables:%=%/cleanup) ;
349
350 5184 aaronmk
# WARNING: This removes any index comments, due to a PostgreSQL bug.
351
# This occurs because ALTER TABLE recreates the index but not its comment.
352 5155 aaronmk
%/cleanup: _always
353
	$(cleanup)
354
355 1777 aaronmk
##### Maps building
356
357 4646 aaronmk
# Maps to (try to) build are added to this
358 1779 aaronmk
maps :=
359
360 4208 aaronmk
srcRoot = $(mappings)/root.sh
361 8156 aaronmk
mkSrcMap = (. $(srcRoot); env datasrc=$(datasrc) $(bin)/src_map <$*/header.csv\
362
>$@)
363 1779 aaronmk
364 7437 aaronmk
translate = $(if $(wildcard $(1)),$(bin)/in_place $< $(bin)/translate_ci 1 $(1))
365 6074 aaronmk
366 6076 aaronmk
$(srcDict):# empty target in case it doesn't exist
367
368 3572 aaronmk
# Via maps cleanup
369 4182 aaronmk
ifneq ($(filter %/.map.csv.last_cleanup,$(MAKECMDGOALS)),)
370 7484 aaronmk
%/.map.csv.last_cleanup: %/map.csv $(vocab) $(thesaurus) $(coreMap) $(srcDict)
371 7437 aaronmk
	$(call translate,$(srcDict))
372 4844 aaronmk
	$(bin)/in_place $< $(bin)/canon 1 $(vocab)
373 7484 aaronmk
	$(call translate,$(thesaurus))
374 8176 aaronmk
	$(bin)/in_place $< $(bin)/fix_line_endings
375 3572 aaronmk
	touch $@
376 4601 aaronmk
	+$(selfMake) $(<:%/map.csv=%/unmapped_terms.csv)
377
	+$(selfMake) $(<:%/map.csv=%/new_terms.csv)
378 5253 aaronmk
.PRECIOUS: %/.map.csv.last_cleanup
379 3572 aaronmk
else
380 4644 aaronmk
%/map.csv: _always
381 8252 aaronmk
	$(if $(wildcard $@),,$(mk_map_csv))
382 4182 aaronmk
	+$(selfMake) $(@:%/map.csv=%/.map.csv.last_cleanup)
383 8252 aaronmk
define mk_map_csv
384 11253 aaronmk
+$(selfMake) "$*/header.csv"
385 12795 aaronmk
$(mkSrcMap)
386 8252 aaronmk
endef
387 3572 aaronmk
endif
388
389 4641 aaronmk
%/VegBIEN.csv: %/map.csv $(coreMap)
390 11236 aaronmk
	$(if $(wildcard $*/run),-ln -s "../$(coreMap)" "$@"\
391 10174 aaronmk
,<$< $(bin)/cat_cols 1 2|$(bin)/join $(coreMap)|$(bin)/sort_map >$@)
392
# ignore errors if symlink exists
393 1530 aaronmk
maps += $(autogenMaps)
394
395 4646 aaronmk
maps: $(maps) _always ;
396 1139 aaronmk
397
all += $(maps)
398
399 1742 aaronmk
##### Maps validation
400
401 4663 aaronmk
# `tail -n +2`: Remove header before running filter_out_ci because filter_out_ci
402
# only removes the header if it matches the vocabulary's header.
403 4601 aaronmk
404 4664 aaronmk
%/unmapped_terms.csv: %/map.csv $(coreMap)
405 4858 aaronmk
	tail -n +2 $<|$(bin)/cols 1|$(bin)/filter_out_ci 0 $(coreMap) >$@
406
	$(bin)/autoremove $@
407 4601 aaronmk
408 7484 aaronmk
%/new_terms.csv: %/map.csv $(vocab) $(thesaurus) %/unmapped_terms.csv
409 4857 aaronmk
	$(newTerms)
410
	$(bin)/autoremove $@
411
newTerms = tail -n +2 $<|$(bin)/filter_out_ci 0 $(vocab)|$(bin)/filter_out_ci 0\
412 7484 aaronmk
$(thesaurus) $(if $(wildcard $(word 4,$+)),|$(bin)/filter_out_ci 0 $(word 4,$+))\
413 7216 aaronmk
|grep -vE -e '^"?:' -e 'UNUSED' >$@; exit 0 # grep exits nonzero if no match
414 4601 aaronmk
415 10205 aaronmk
termsSubdirs := $(tables)
416 4600 aaronmk
417 3764 aaronmk
include $(root)/lib/mappings.Makefile
418 1742 aaronmk
419 1509 aaronmk
##### External dependencies
420
421
$(root)/%: _always
422
	+$(subMake)
423 1628 aaronmk
.PRECIOUS: $(root)/% # let ext. dir's Makefile decide whether to delete on error
424 1509 aaronmk
425 783 aaronmk
##### Mapping
426 368 aaronmk
427 4182 aaronmk
+maps = $(filter %/map.csv %/VegBIEN.csv $(mappings)/%,$(+_))
428 4746 aaronmk
map2db = env in_database=vegbien in_schema=$(datasrc) in_table=$*\
429 10863 aaronmk
out_database=vegbien source=$(datasrc).new $(root)/map $(+maps)
430 368 aaronmk
431 783 aaronmk
##### Import to VegBIEN
432 772 aaronmk
433 11285 aaronmk
import_temp: $(importTables:%=%/import) _always ;
434 7281 aaronmk
435 12992 aaronmk
import: _always import_temp publish validate ; # removes temp suffix when done
436 10869 aaronmk
437 7281 aaronmk
rm: _always
438 10798 aaronmk
	echo "SELECT datasource_rm('$(datasrc)');"|"time" $(psqlAsBien)
439 7281 aaronmk
440 11285 aaronmk
reimport: _always import ; # import replaces the previous import
441 7284 aaronmk
442 1853 aaronmk
profileTest = $(if $(profile),$(if $(test),1))
443
profileOnly = -env profile_to=/dev/fd/3 $(map2db) 3>&1 1>&2|\
444
$(bin)/profile_stats /dev/fd/0
445
446 5457 aaronmk
log_ = $*/logs/$(if $(n),n=$(n).,)$(version).log.sql
447 7075 aaronmk
448
# Displays the import log file path
449 7076 aaronmk
# Run with `make -s` to avoid echoing make commands
450 7075 aaronmk
%/log_file: _always
451
	echo $$(pwd)/$(log_)
452
453 3317 aaronmk
trace = $(log_:.log.sql=.trace)
454 10582 aaronmk
restart_row = $(shell set -x; grep -F Partition: $(log_)|tail -1|$(sed)\
455
's/^.* rows ([[:digit:]]+)-.*$$/\1/')
456 11777 aaronmk
import = $(if $(profileTest),$(profileOnly),(set -x; date; "time" env commit=1\
457 10582 aaronmk
$(if $(profile),profile_to=$(trace)) $(if $(continue),start=$(restart_row))\
458
$(map2db))$(if $(log), >>$(log_) 2>&1))
459 624 aaronmk
460 7245 aaronmk
import? = $(if $(call and,$(full_import),$(call dontImport,.)),,$(import))
461 7047 aaronmk
462 11440 aaronmk
%/import_temp: %/VegBIEN.csv _always
463 11777 aaronmk
	$(if $(full_import),-)$(import?)
464
# don't abort on import errors, which often relate to invalid input data
465 772 aaronmk
# default:
466 11440 aaronmk
%/import_temp: _always ;
467 718 aaronmk
468 11440 aaronmk
%/import: %/import_temp _always ;
469
470 7279 aaronmk
#### Taxonomic scrubbing
471
472 7282 aaronmk
scrub: _always
473 7275 aaronmk
	$(selfMake) $(root)/scrub & echo $$!
474 11794 aaronmk
# using & (background process) also ignores TNRS errors, so that TNRS bugs do
475
# not prevent the remaining tables from being imported even if TNRS can't be run
476 7265 aaronmk
477 7279 aaronmk
# Removes TNRS taxondeterminations
478
unscrub: _always
479
	echo "SELECT delete_scrubbed_taxondeterminations('$(datasrc)');"|\
480
"time" env no_query_results=1 $(psqlAsBien)
481
482 7283 aaronmk
rescrub: _always unscrub scrub ;
483
484 7282 aaronmk
import_scrub: _always import scrub ;
485
486 7285 aaronmk
reimport_scrub: _always reimport scrub ;
487
488 10581 aaronmk
%/import_scrub: _always %/import scrub ;
489
490 790 aaronmk
##### Log files from import
491
492 4182 aaronmk
logs := $(wildcard */logs/*.log.sql */logs/*.trace)
493 339 aaronmk
494 383 aaronmk
rm_logs: _always
495 339 aaronmk
	$(RM) $(logs)
496
497 783 aaronmk
##### Verification of import
498 264 aaronmk
499 12991 aaronmk
### new-style aggregating validations (also work w/ old-style import)
500
501
# must be in input.Makefile instead of table.run because some datasources that
502
# we validate still use old-style import
503
504 13370 aaronmk
# validations.sql must be in a subdir so it won't get run by sql/install
505
validate/install: _always verify/validations.sql/run ;
506 13368 aaronmk
507 12991 aaronmk
validate: _always
508 12993 aaronmk
	echo "SELECT remake_diff_tables('$(datasrc)');"\
509
|$(psqlAsBien)$(if $(log), >>.$(log_) 2>&1)
510 12991 aaronmk
511
### old-style aggregating validations (not related to old-style import)
512
513 5782 aaronmk
verifyTables := $(patsubst verify/%.ref,%,$(wildcard verify/*.ref))
514 1194 aaronmk
515 5782 aaronmk
verify: $(verifyTables:%=%/verify) _always ;
516
517 4252 aaronmk
%/verify: verify/%.ref verify/%.out _always
518 1184 aaronmk
	-$(diffVerbose) $(+_)
519 1088 aaronmk
# don't abort on verification errors, which are expected during development
520 1194 aaronmk
# default:
521 4252 aaronmk
%/verify: verify/%.out _always
522 1200 aaronmk
	$(if $(shell test -e $< && echo t),cat $<)
523 1199 aaronmk
# don't run if verify/%.out's default do-nothing action was used
524 1200 aaronmk
# can't use $(wildcard) because it won't recheck file after verify/%.out is run
525 368 aaronmk
526 6186 aaronmk
psqlExport := "time" $(psqlNoSearchPath) --no-align --field-separator=$$'\t'\
527 4401 aaronmk
--pset=footer=off --pset=null=NULL
528 5976 aaronmk
# Note that using $(inDatasrc) will not work with datasources whose tables are
529
# the same name as VegBIEN tables (likely only VegBank), because the datasource
530
# is first in the search_path.
531
verify = $(if $(reverify),($(inDatasrc); cat $<)|$(psqlExport)\
532
--set=datasource="'$(datasrc)'" >$@)
533 514 aaronmk
534 12039 aaronmk
verify/%.out: verify/%.out.sql _always
535 1192 aaronmk
	$(verify)
536 5973 aaronmk
.PRECIOUS: verify/%.out # save partial output in case of error to help debugging
537 1194 aaronmk
# default:
538 1199 aaronmk
verify/%.out: _always ;
539 369 aaronmk
540 1199 aaronmk
all += $(wildcard verify/*.out)
541 1192 aaronmk
542 4402 aaronmk
%.ref: %.ref.sql
543 4409 aaronmk
	($(inDatasrc); cat $<)|$(psqlExport) >$@
544 5981 aaronmk
.PRECIOUS: %.ref # there must always be a .ref for the make rules to work
545 4402 aaronmk
546 1667 aaronmk
##### Editing import
547
548 6984 aaronmk
rename/%: _always
549
	echo "UPDATE source SET shortname = '$*' WHERE shortname = '$(datasrc)';"\
550
|$(psqlAsBien)
551 1667 aaronmk
552 10860 aaronmk
%/publish: _always # usage: make inputs/src/src.version/publish
553
	echo "SELECT datasource_publish('$*');"|$(psqlAsBien)
554
555 10862 aaronmk
publish: _always $(datasrc).new/publish ; # usage: make inputs/src/publish
556
557 783 aaronmk
##### Testing
558 368 aaronmk
559 4274 aaronmk
testRefOutput = $(subst .by_col,,$(1))
560 1986 aaronmk
testRef = $(testRefOutput).ref
561
hasOwnRef = $(filter $@,$(call testRefOutput,$@))
562
# filter returns non-empty if they are equal
563 630 aaronmk
564 4246 aaronmk
# `rm $@`: Remove outputs of successful tests to reduce clutter
565 4272 aaronmk
# `$(foreach use_staged...)`: Run with use_staged=1
566 897 aaronmk
define runTest
567 776 aaronmk
@echo "Testing $(abspath $@)..."
568 4272 aaronmk
>$@ env test=1 n=$(test_n) $(1) $(foreach use_staged,1,$(map2db))
569 6446 aaronmk
$(if $(hasOwnRef),,-)@(set -x; $(diffIgnoreSpace) $(call testRef,$@) $@) 2>&1\
570
&& rm $@ || { e=$$?; $(if $(wildcard $(call testRef,$@)),,cat $@;)\
571 777 aaronmk
$(if $(hasOwnRef),\
572 3179 aaronmk
{\
573
read -p $(emph)'Accept new test output? (y/n)'$(endEmph) REPLY;\
574
if test "$$REPLY" = y; then\
575
(set -x; $(MAKE) $@-ok --directory=$(realpath .) --makefile=../input.Makefile);\
576
exit 0;\
577
fi;\
578
};,\
579 777 aaronmk
echo $(emph)"Note: The preceding failed test is compared to another test's\
580
output"$(endEmph);\
581
echo $(emph)"When it fails, this always indicates a bug"$(endEmph);\
582
)\
583 652 aaronmk
exit $$e;}
584 628 aaronmk
endef
585
586 876 aaronmk
tests :=
587
588 10839 aaronmk
%/test: %/test.xml $(if $(by_col),%/test.by_col.xml) _always ;
589 6744 aaronmk
590 4269 aaronmk
# Requires staging tables. To create them, run `make inputs/<datasrc>/install`.
591
# Non-flat-file inputs fall back to mimicking a successful test
592 4182 aaronmk
%/test.xml: %/VegBIEN.csv _always
593 12795 aaronmk
	$(call runTest,by_col=)
594 4182 aaronmk
tests += %/test.xml
595 627 aaronmk
596 4274 aaronmk
%/test.by_col.xml: %/VegBIEN.csv _always
597 12795 aaronmk
	$(call runTest,by_col=1)
598 4275 aaronmk
599
# Only run column-based tests if column-based mode enabled, because these tests
600
# are much slower than the row-based tests for small numbers of rows
601
ifneq ($(by_col),)
602 4274 aaronmk
tests += %/test.by_col.xml
603 4275 aaronmk
endif
604 4274 aaronmk
605 10205 aaronmk
testOutputs := $(foreach test,$(tests),$(tables:%=$(test)))
606 724 aaronmk
607 1361 aaronmk
.PRECIOUS: $(testOutputs) # save outputs of failed tests so they can be accepted
608
609 876 aaronmk
test: _always $(testOutputs) ;
610
611 4182 aaronmk
all += $(wildcard %/test*.xml)
612 876 aaronmk
613 634 aaronmk
# Accepts a test output: make <test_output_path>-ok
614 626 aaronmk
%-ok: _always
615 4383 aaronmk
	mv $* $(call testRef,$*)
616 502 aaronmk
617 4120 aaronmk
accept-all: _always
618 3579 aaronmk
	+yes|$(selfMake) test
619
620 3133 aaronmk
##### Documentation
621
622 4494 aaronmk
steps = $(selfMake) -s $*/import test=1 by_col=1 verbosity=2 n=100\
623 3385 aaronmk
2>&1|$(bin)/debug2redmine >$@
624 3188 aaronmk
625 4182 aaronmk
%/logs/steps.by_col.log.sql: _always
626 3188 aaronmk
	+$(steps)