1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
|
# Relx plugin.
#
# Sleeps when interacting with relx script are necessary after start and upgrade
# as both of those interactions are not synchronized.
relx_TARGETS = $(call list_targets,relx)
.PHONY: relx $(relx_TARGETS)
ifeq ($(PLATFORM),msys2)
RELX_REL_EXT = .cmd
else
RELX_REL_EXT =
endif
relx: $(relx_TARGETS)
relx-rel: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Build the release"
$t $(MAKE) -C $(APP) $v
$i "Check that the release was built"
$t test -d $(APP)/_rel
$t test -d $(APP)/_rel/$(APP)_release
$t test -d $(APP)/_rel/$(APP)_release/bin
$t test -d $(APP)/_rel/$(APP)_release/lib
$t test -d $(APP)/_rel/$(APP)_release/releases
$t test -d $(APP)/_rel/$(APP)_release/releases/1
$i "Clean the application"
$t $(MAKE) -C $(APP) clean $v
$i "Check that the release still exists"
$t test -d $(APP)/_rel
$t test -d $(APP)/_rel/$(APP)_release
$t test -d $(APP)/_rel/$(APP)_release/bin
$t test -d $(APP)/_rel/$(APP)_release/lib
$t test -d $(APP)/_rel/$(APP)_release/releases
$t test -d $(APP)/_rel/$(APP)_release/releases/1
$i "Distclean the application"
$t $(MAKE) -C $(APP) distclean $v
$i "Check that the output directory was removed entirely"
$t test ! -d $(APP)/_rel/
relx-apps-with-deps: init
$i "Bootstrap a new release as a multi application repository"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap-lib bootstrap-rel $v
$i "Create a new application my_app"
$t $(MAKE) -C $(APP) new-app in=my_app $v
$i "Include my_app in the release"
$t perl -pi.bak -e 's/$(APP),/$(APP), my_app,/' $(APP)/relx.config
$i "Add Cowlib 2.13.0 to the list of dependencies for my_app"
$t perl -ni.bak -e 'print;if ($$.==1) {print "DEPS = cowlib\ndep_cowlib_commit = 2.13.0\n"}' $(APP)/apps/my_app/Makefile
ifdef LEGACY
$i "Add Cowlib to the applications key in the my_app.app.src file"
$t perl -ni.bak -e 'print;if ($$.==7) {print "\t\tcowlib,\n"}' $(APP)/apps/my_app/src/my_app.app.src
endif
$i "Build the application"
$t $(MAKE) -C $(APP) $v
$i "Check that all compiled files exist"
$t test -f $(APP)/apps/my_app/my_app.d
$t test -f $(APP)/apps/my_app/ebin/my_app.app
$t test -f $(APP)/apps/my_app/ebin/my_app_app.beam
$t test -f $(APP)/apps/my_app/ebin/my_app_sup.beam
$t test -f $(APP)/deps/cowlib/ebin/cowlib.app
$i "Check that Cowlib was included in the release"
$t test -d $(APP)/_rel/test_relx_apps_with_deps_release/lib/cowlib-2.13.0
relx-bare-rel: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Build the release"
$t $(MAKE) -C $(APP) rel $v
$i "Check that the release was built"
$t test -d $(APP)/_rel
$t test -d $(APP)/_rel/$(APP)_release
$t test -d $(APP)/_rel/$(APP)_release/bin
$t test -d $(APP)/_rel/$(APP)_release/lib
$t test -d $(APP)/_rel/$(APP)_release/releases
$t test -d $(APP)/_rel/$(APP)_release/releases/1
relx-output-dir: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Set RELX_OUTPUT_DIR to _rel2"
$t perl -ni.bak -e 'print;if ($$.==1) {print "RELX_OUTPUT_DIR = _rel2\n"}' $(APP)/Makefile
$i "Build the release"
$t $(MAKE) -C $(APP) $v
$i "Check that the release exists in the correct location"
$t ! test -d $(APP)/_rel
$t test -d $(APP)/_rel2
relx-post-rel: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Add relx-post-rel target to Makefile"
$t echo "relx-post-rel::" >> $(APP)/Makefile
$t echo " echo test post rel > _rel/$(APP)_release/test_post_rel" >> $(APP)/Makefile
$i "Build the release"
$t $(MAKE) -C $(APP) $v
$i "Check that the release was built"
$t test -d $(APP)/_rel
$t test -d $(APP)/_rel/$(APP)_release
$t test -d $(APP)/_rel/$(APP)_release/bin
$t test -d $(APP)/_rel/$(APP)_release/lib
$t test -d $(APP)/_rel/$(APP)_release/releases
$t test -d $(APP)/_rel/$(APP)_release/releases/1
$t test -f $(APP)/_rel/$(APP)_release/test_post_rel
$t test "test post rel" = "`cat $(APP)/_rel/$(APP)_release/test_post_rel`"
$i "Clean the application"
$t $(MAKE) -C $(APP) clean $v
$i "Check that the release still exists"
$t test -d $(APP)/_rel
$t test -d $(APP)/_rel/$(APP)_release
$t test -d $(APP)/_rel/$(APP)_release/bin
$t test -d $(APP)/_rel/$(APP)_release/lib
$t test -d $(APP)/_rel/$(APP)_release/releases
$t test -d $(APP)/_rel/$(APP)_release/releases/1
$t test -f $(APP)/_rel/$(APP)_release/test_post_rel
$t test "test post rel" = "`cat $(APP)/_rel/$(APP)_release/test_post_rel`"
$i "Distclean the application"
$t $(MAKE) -C $(APP) distclean $v
$i "Check that the output directory was removed entirely"
$t test ! -d $(APP)/_rel/
relx-rel-with-script: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Create a relx.config.script file"
$t printf "%s\n" \
"{release, {App, _Ver}, Apps} = lists:keyfind(release, 1, CONFIG)," \
"lists:keyreplace(release, 1, CONFIG, {release, {App, \"ONE\"}, Apps})." \
> $(APP)/relx.config.script
$i "Build the release"
$t $(MAKE) -C $(APP) $v
$i "Check that the release was built"
$t test -d $(APP)/_rel
$t test -d $(APP)/_rel/$(APP)_release
$t test -d $(APP)/_rel/$(APP)_release/bin
$t test -d $(APP)/_rel/$(APP)_release/lib
$t test -d $(APP)/_rel/$(APP)_release/releases
$t test -d $(APP)/_rel/$(APP)_release/releases/ONE
$i "Clean the application"
$t $(MAKE) -C $(APP) clean $v
$i "Check that the release still exists"
$t test -d $(APP)/_rel
$t test -d $(APP)/_rel/$(APP)_release
$t test -d $(APP)/_rel/$(APP)_release/bin
$t test -d $(APP)/_rel/$(APP)_release/lib
$t test -d $(APP)/_rel/$(APP)_release/releases
$t test -d $(APP)/_rel/$(APP)_release/releases/ONE
$i "Distclean the application"
$t $(MAKE) -C $(APP) distclean $v
$i "Check that the output directory was removed entirely"
$t test ! -d $(APP)/_rel/
define relx-rel-with-only-script-relx.config.script.erl
endef
relx-rel-with-script-only: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Delete relx.config and create a relx.config.script file"
$t rm -f $(APP)/relx.config
$t printf "%s\n" \
"CONFIG = [], %% Assert that config is empty." \
"[" \
" {release, {$(APP)_release, \"ONE\"}, [$(APP), sasl, runtime_tools]}," \
" {dev_mode, false}," \
" {include_erts, true}," \
" {extended_start_script, true}," \
" {sys_config, \"config/sys.config\"}," \
" {vm_args, \"config/vm.args\"}" \
"| CONFIG]." \
> $(APP)/relx.config.script
$i "Build the release"
$t $(MAKE) -C $(APP) $v
$i "Check that the release was built"
$t test -d $(APP)/_rel
$t test -d $(APP)/_rel/$(APP)_release
$t test -d $(APP)/_rel/$(APP)_release/bin
$t test -d $(APP)/_rel/$(APP)_release/lib
$t test -d $(APP)/_rel/$(APP)_release/releases
$t test -d $(APP)/_rel/$(APP)_release/releases/ONE
$i "Clean the application"
$t $(MAKE) -C $(APP) clean $v
$i "Check that the release still exists"
$t test -d $(APP)/_rel
$t test -d $(APP)/_rel/$(APP)_release
$t test -d $(APP)/_rel/$(APP)_release/bin
$t test -d $(APP)/_rel/$(APP)_release/lib
$t test -d $(APP)/_rel/$(APP)_release/releases
$t test -d $(APP)/_rel/$(APP)_release/releases/ONE
$i "Distclean the application"
$t $(MAKE) -C $(APP) distclean $v
$i "Check that the output directory was removed entirely"
$t test ! -d $(APP)/_rel/
ifneq ($(PLATFORM),msys2)
# This test is currently disabled on Windows because we are
# running into too many issues preventing the test from
# executing properly and leaving the release running at the end.
relx-relup: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Set the initial application version"
ifeq ($(LEGACY),1)
$t sed -i.bak s/"{vsn, \"0.1.0\"}"/"{vsn, \"1\"}"/ $(APP)/src/$(APP).app.src
else
$t echo "PROJECT_VERSION = 1" >> $(APP)/Makefile
endif
$i "Generate a test module"
$t printf "%s\n"\
"-module(test)." \
"-export([test/0])." \
"test() -> old." > $(APP)/src/test.erl
$i "Build the initial release as a tarball"
$t $(MAKE) -C $(APP) $v
$i "Update the test module"
$t sed -i.bak s/"test() -> old."/"test() -> new."/ $(APP)/src/test.erl
$i "Bump the application version"
ifeq ($(LEGACY),1)
$t sed -i.bak s/"{vsn, \"1\"}"/"{vsn, \"2\"}"/ $(APP)/src/$(APP).app.src
else
$t sed -i.bak s/"PROJECT_VERSION = 1"/"PROJECT_VERSION = 2"/ $(APP)/Makefile
endif
$i "Generate a .appup for the application"
$t printf "%s\n" \
"{\"2\","\
" [{\"1\", [{load_module, test}]}],"\
" [{\"1\", [{load_module, test}]}]"\
"}." > $(APP)/ebin/$(APP).appup
$i "Bump the release version"
$t sed -i.bak s/"1"/"2"/ $(APP)/relx.config
$i "Build a new release with a relup as a tarball"
$t $(MAKE) -C $(APP) relup $v
$i "Test that both releases are available"
$t test -f $(APP)/_rel/$(APP)_release/$(APP)_release-1.tar.gz
$t test -f $(APP)/_rel/$(APP)_release/$(APP)_release-2.tar.gz
$i "Unpack initial release"
$t mkdir $(APP)/tmp
$t tar -xzf $(APP)/_rel/$(APP)_release/$(APP)_release-1.tar.gz -C $(APP)/tmp
ifeq ($(PLATFORM),msys2)
$i "Start initial release"
$t $(APP)/tmp/bin/$(APP)_release$(RELX_REL_EXT) install
else
$i "Start initial release and confirm it runs the old code"
endif
$t $(APP)/tmp/bin/$(APP)_release$(RELX_REL_EXT) daemon
$t sleep 1
ifneq ($(PLATFORM),msys2)
# On Windows the script does not have the commands rpc and versions.
$t test `$(APP)/tmp/bin/$(APP)_release$(RELX_REL_EXT) rpc test test` = old
$i "Check that it's 1 available version"
$t test `$(APP)/tmp/bin/$(APP)_release$(RELX_REL_EXT) versions | wc -l` = "2"
endif
$i "Copy the relup tarball to the release directory"
$t mkdir $(APP)/tmp/releases/2
$t cp $(APP)/_rel/$(APP)_release/$(APP)_release-2.tar.gz $(APP)/tmp/releases/2/$(APP)_release.tar.gz
$t test -f $(APP)/tmp/releases/2/$(APP)_release.tar.gz
ifeq ($(PLATFORM),msys2)
$i "Upgrade the release"
# On Windows the script doesn't seem to change the cwd properly
# which results in the release tarball not being found.
#
# We use --no-permanent to avoid another bug.
$t cd $(APP)/tmp && ./bin/$(APP)_release$(RELX_REL_EXT) upgrade --no-permanent "2"
else
$i "Upgrade the release and confirm it runs the new code"
$t $(APP)/tmp/bin/$(APP)_release$(RELX_REL_EXT) upgrade "2"
endif
$t sleep 1
ifneq ($(PLATFORM),msys2)
# On Windows the script does not have the commands rpc and versions.
$t test `$(APP)/tmp/bin/$(APP)_release$(RELX_REL_EXT) rpc test test` = new
$i "Check that it's 2 available versions"
$t test `$(APP)/tmp/bin/$(APP)_release$(RELX_REL_EXT) versions | wc -l` = "3"
endif
ifeq ($(PLATFORM),msys2)
$i "Downgrade the release"
# On Windows the script doesn't seem to change the cwd properly
# which results in the release tarball not being found.
#
# We use --no-permanent to avoid another bug.
$t cd $(APP)/tmp && ./bin/$(APP)_release$(RELX_REL_EXT) downgrade --no-permanent "1"
else
$i "Downgrade the release and confirm it runs the old code"
$t $(APP)/tmp/bin/$(APP)_release$(RELX_REL_EXT) downgrade "1"
endif
$t sleep 1
ifneq ($(PLATFORM),msys2)
# On Windows the script does not have the commands rpc and versions.
$t test `$(APP)/tmp/bin/$(APP)_release$(RELX_REL_EXT) rpc test test` = old
endif
$i "Stop the release"
# On Windows this fails with the following reason:
# The service test_relx_relup_release_2 is not an erlsrv controlled service.
$t $(APP)/_rel/$(APP)_release/bin/$(APP)_release$(RELX_REL_EXT) stop
ifeq ($(PLATFORM),msys2)
$t sleep 1
$t $(APP)/_rel/$(APP)_release/bin/$(APP)_release$(RELX_REL_EXT) uninstall
endif
endif
relx-start-stop: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Build the release"
$t $(MAKE) -C $(APP) $v
$i "Stop the release (in case one is running from a previously aborted run)"
$t $(APP)/_rel/$(APP)_release/bin/$(APP)_release$(RELX_REL_EXT) stop || true
ifeq ($(PLATFORM),msys2)
$t $(APP)/_rel/$(APP)_release/bin/$(APP)_release$(RELX_REL_EXT) uninstall || true
endif
$i "Start the release"
ifeq ($(PLATFORM),msys2)
$t $(APP)/_rel/$(APP)_release/bin/$(APP)_release$(RELX_REL_EXT) install
endif
$t $(APP)/_rel/$(APP)_release/bin/$(APP)_release$(RELX_REL_EXT) daemon
$i "Ping the release"
$t $(call wait_for_success,$(APP)/_rel/$(APP)_release/bin/$(APP)_release$(RELX_REL_EXT) ping)
$i "Stop the release"
$t $(APP)/_rel/$(APP)_release/bin/$(APP)_release$(RELX_REL_EXT) stop
ifeq ($(PLATFORM),msys2)
$t sleep 1
$t $(APP)/_rel/$(APP)_release/bin/$(APP)_release$(RELX_REL_EXT) uninstall
endif
ifneq ($(PLATFORM),msys2)
# The script will not return false on Windows when the ping fails.
# It sometimes also gets stuck. So we just skip the ping for now.
$i "Check that further pings get no replies"
$t $(call wait_for_failure,$(APP)/_rel/$(APP)_release/bin/$(APP)_release$(RELX_REL_EXT) ping)
endif
$i "Check that there's no erl_crash.dump file"
$t test ! -f $(APP)/_rel/$(APP)_release/erl_crash.dump
relx-tar: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Build the release without a tarball"
$t $(MAKE) -C $(APP) RELX_TAR=0 $v
$i "Check that tarball doesn't exist"
$t test ! -e $(APP)/_rel/$(APP)_release/$(APP)_release-1.tar.gz
$i "Build the release as a tarball"
$t $(MAKE) -C $(APP) $v
$i "Check that tarball exists"
$t test -f $(APP)/_rel/$(APP)_release/$(APP)_release-1.tar.gz
relx-vsn-cmd: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Replace the vsn"
$t sed -i.bak s/"\"1\""/"{cmd, \"printf 2\"}"/ $(APP)/relx.config
$i "Build the release"
$t $(MAKE) -C $(APP) $v
$i "Check that the correct release exists"
$t ! test -d $(APP)/_rel/$(APP)_release/releases/1
$t test -d $(APP)/_rel/$(APP)_release/releases/2
relx-vsn-git-long: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Replace the vsn"
$t sed -i.bak s/"\"1\""/"{git, long}"/ $(APP)/relx.config
$i "Build the release"
$t $(MAKE) -C $(APP) $v
$i "Check that the correct release exists"
$t ! test -d $(APP)/_rel/$(APP)_release/releases/1
$t test -d $(APP)/_rel/$(APP)_release/releases/$(shell git rev-parse HEAD)
relx-vsn-git-short: init
$i "Bootstrap a new release named $(APP)"
$t mkdir $(APP)/
$t cp ../erlang.mk $(APP)/
$t $(MAKE) -C $(APP) -f erlang.mk bootstrap bootstrap-rel $v
$i "Replace the vsn"
$t sed -i.bak s/"\"1\""/"{git, short}"/ $(APP)/relx.config
$i "Build the release"
$t $(MAKE) -C $(APP) $v
$i "Check that the correct release exists"
$t ! test -d $(APP)/_rel/$(APP)_release/releases/1
$t test -d $(APP)/_rel/$(APP)_release/releases/$(shell git rev-parse --short HEAD)
|
