Merge remote-tracking branch 'origin/topic/vern/script-opt-keep-asserts'

* origin/topic/vern/script-opt-keep-asserts:
  ZAM documentation updates for asserts and event handler run-time errors
  BTest updates for ZAM support of (optionally) keeping "assert" statements
  command-line options for controlling script optimization: keeping asserts, avoiding event handler coalescence
  ZAM support for option to not coalesce event handlers
  ZAM support for keeping "assert" statements
  internal support for script optimization options for keeping asserts, not consolidating event handlers
  ZAM operations to support asserts
  simplified "assert" by not trying to catch messages that themselves have errors

Fixed some TEST-REQUIRES "${ZEEK_ZAM}" == "1" to use "=" instead to
be /bin/sh compatible.

testing/btest/Baseline.zam/language.assert-2/out

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert.zeek, line 3: assertion failure: fmt("%s", 1) == "2" ("1" != "2")
+fatal error: errors occurred while initializing

testing/btest/Baseline.zam/language.assert-3/out

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert.zeek, line 3: assertion failure: (coerce to_count("42") to double) == 42.5 (always failing)
+fatal error: errors occurred while initializing

testing/btest/Baseline.zam/language.assert-4/out

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert.zeek, line 4: assertion failure: 1 == x (Expected x to be 1, have 2)
+fatal error: errors occurred while initializing

testing/btest/Baseline.zam/language.assert-5/out

@@ -0,0 +1,6 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert.zeek, line 9: assertion failure: "ghi" in tbl ({
+	[abc] = 123,
+	[def] = 456
+})
+fatal error: errors occurred while initializing

testing/btest/Baseline.zam/language.assert-6/out

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+runtime error in <...>/assert.zeek, line 9: field value missing: $b
+fatal error: errors occurred while initializing

testing/btest/Baseline.zam/language.assert-7/out

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+runtime error in <...>/assert.zeek, line 9: field value missing: $b
+fatal error: errors occurred while initializing

testing/btest/Baseline.zam/language.assert-8/out

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert.zeek, line 2: assertion failure: 1 == 2 (always false)
+fatal error: failed to execute script statements at top-level scope

testing/btest/Baseline.zam/language.assert-error-2/.stderr

@@ -0,0 +1,2 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert-error.zeek, line 3: message must be string (1234)

testing/btest/Baseline.zam/language.assert-error-3/.stderr

@@ -0,0 +1,2 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert-error.zeek, line 3: syntax error, at or near ";"

testing/btest/Baseline.zam/language.assert-error-4/.stderr

@@ -0,0 +1,2 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert-error.zeek, line 3: syntax error, at or near ","

testing/btest/Baseline.zam/language.assert-error/.stderr

@@ -0,0 +1,2 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert-error.zeek, line 8: conditional must be boolean (1)

testing/btest/Baseline.zam/language.assert-hook-2/.stderr

@@ -0,0 +1 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.

testing/btest/Baseline.zam/language.assert-hook-2/out

@@ -0,0 +1,4 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+assertion_failure, to_count("5") == 4, 5 is not 4
+assert <...>/assert-hook.zeek:21
+ zeek_init <none>:0

testing/btest/Baseline.zam/language.assert-hook-3/.stderr

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert-hook.zeek, line 12: assertion failure: F (terminate me!)
+received termination signal

testing/btest/Baseline.zam/language.assert-hook-3/out

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+assertion_failure, terminate me!
+zeek_done()

testing/btest/Baseline.zam/language.assert-hook-4/.stderr

@@ -0,0 +1 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.

testing/btest/Baseline.zam/language.assert-hook-4/out

@@ -0,0 +1,2 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+assertion_failure, calling exit!

testing/btest/Baseline.zam/language.assert-hook-5/.stderr

@@ -0,0 +1 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.

testing/btest/Baseline.zam/language.assert-hook-5/out

@@ -0,0 +1,8 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+assertion_result T at <...>/assert-hook.zeek:25: md5_hash("") == "d41d8cd98f00b204e9800998ecf8427e"
+assertion_result T at <...>/assert-hook.zeek:30: sha1_hash("") == "da39a3ee5e6b4b0d3255bfef95601890afd80709"
+assertion_result F at <...>/assert-hook.zeek:35: sha1_hash("") == "wrong"
+assertion_failure at <...>/assert-hook.zeek:35: sha1_hash("") == "wrong"
+assertion_result F at <...>/assert-hook.zeek:40: md5_hash("") == "wrong"
+assertion_failure at <...>/assert-hook.zeek:40: md5_hash("") == "wrong"
+2 of 4 assertions failed

testing/btest/Baseline.zam/language.assert-hook-6/.stderr

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+runtime error in <...>/assert-hook.zeek, line 18: field value missing: $ip
+error in <...>/assert-hook.zeek, line 24: assertion failure: 2 + 2 == 5 ({"msg":"false and works"})

testing/btest/Baseline.zam/language.assert-hook-6/out

@@ -0,0 +1,4 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+assertion_result, T, 2 + 2 == 4, {"msg":"true and works"}, <...>/assert-hook.zeek, 15
+assertion_result, F, 2 + 2 == 5, {"msg":"false and works"}, <...>/assert-hook.zeek, 24
+assertion_failure, 2 + 2 == 5, {"msg":"false and works"}, <...>/assert-hook.zeek, 24

testing/btest/Baseline.zam/language.assert-hook-7/.stderr

@@ -0,0 +1 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.

testing/btest/Baseline.zam/language.assert-hook-7/out

@@ -0,0 +1,5 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+assertion_result, T, 2 + 2 == 4, this is true, <...>/assert-hook.zeek, 10
+assertion_result, T, 2 + 2 == 4, {"msg":"this is also true"}, <...>/assert-hook.zeek, 11
+assertion_result, F, 2 + 2 == 5, this is false, <...>/assert-hook.zeek, 12
+assertion_result, F, 2 + 2 == 5, this is false, <...>/assert-hook.zeek, 18

testing/btest/Baseline.zam/language.assert-hook-8/.stderr

@@ -0,0 +1 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.

testing/btest/Baseline.zam/language.assert-hook-8/out

@@ -0,0 +1,6 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+zeek_init
+returning true
+assertion_result, T, always_true(), always true, <...>/assert-hook.zeek, 23
+returning false
+assertion_result, F, always_false(), always false, <...>/assert-hook.zeek, 24

testing/btest/Baseline.zam/language.assert-hook/.stderr

@@ -0,0 +1,2 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert-hook.zeek, line 15: assertion failure: 1 != 1

testing/btest/Baseline.zam/language.assert-hook/out

@@ -0,0 +1,2 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+assertion_failure, 1 != 1, , <...>/assert-hook.zeek, 15

testing/btest/Baseline.zam/language.assert-misc/out

@@ -0,0 +1,7 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+f, lambda_<10820400278317158366>: function() : void
+ZAM-code lambda_<10820400278317158366>
+g, lambda_<9730512750166342063>: function() : void
+ZAM-code lambda_<9730512750166342063>
+test_function, test_function: function() : void
+ZAM-code test_function

testing/btest/Baseline.zam/language.assert/out

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+error in <...>/assert.zeek, line 8: assertion failure: fmt("%s", 1) == "2"
+fatal error: errors occurred while initializing

testing/btest/Baseline.zam/opt.validate-ZAM/output

@@ -1,2 +1,2 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-1245 valid, 1883 tested, 437 skipped
+1248 valid, 1892 tested, 437 skipped

testing/btest/Baseline/language.assert-7/out

@@ -1,4 +1,3 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-expression error in <...>/assert.zeek, line 10: field value missing (r$b)
-error in <...>/assert.zeek, line 10: assertion failure: r?$b (<error eval fmt("r$b is not set trying anyway: %s", r$b)>)
+expression error in <...>/assert.zeek, line 12: field value missing (r$b)
 fatal error: errors occurred while initializing

testing/btest/Baseline/language.assert-hook-6/.stderr

@@ -1,5 +1,3 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-expression error in <...>/assert-hook.zeek, line 15: field value missing (get_current_packet_header()$ip)
-expression error in <...>/assert-hook.zeek, line 17: field value missing (get_current_packet_header()$ip)
-error in <...>/assert-hook.zeek, line 17: assertion failure: 2 + 2 == 5 (<error eval cat(get_current_packet_header()$ip)>)
-error in <...>/assert-hook.zeek, line 22: assertion failure: 2 + 2 == 5 ({"msg":"false and works"})
+expression error in <...>/assert-hook.zeek, line 18: field value missing (get_current_packet_header()$ip)
+error in <...>/assert-hook.zeek, line 24: assertion failure: 2 + 2 == 5 ({"msg":"false and works"})

testing/btest/Baseline/language.assert-hook-6/out

@@ -1,7 +1,4 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-assertion_result, T, 2 + 2 == 4, <error eval cat(get_current_packet_header()$ip)>, <...>/assert-hook.zeek, 15
-assertion_result, T, 2 + 2 == 4, {"msg":"true and works"}, <...>/assert-hook.zeek, 16
-assertion_result, F, 2 + 2 == 5, <error eval cat(get_current_packet_header()$ip)>, <...>/assert-hook.zeek, 17
-assertion_failure, 2 + 2 == 5, <error eval cat(get_current_packet_header()$ip)>, <...>/assert-hook.zeek, 17
-assertion_result, F, 2 + 2 == 5, {"msg":"false and works"}, <...>/assert-hook.zeek, 22
-assertion_failure, 2 + 2 == 5, {"msg":"false and works"}, <...>/assert-hook.zeek, 22
+assertion_result, T, 2 + 2 == 4, {"msg":"true and works"}, <...>/assert-hook.zeek, 15
+assertion_result, F, 2 + 2 == 5, {"msg":"false and works"}, <...>/assert-hook.zeek, 24
+assertion_failure, 2 + 2 == 5, {"msg":"false and works"}, <...>/assert-hook.zeek, 24

testing/btest/Baseline/language.assert-hook/.stderr

@@ -1,2 +1,2 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-error in <...>/assert-hook.zeek, line 18: assertion failure: 1 != 1
+error in <...>/assert-hook.zeek, line 15: assertion failure: 1 != 1

testing/btest/Baseline/language.assert-hook/out

@@ -1,2 +1,2 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-assertion_failure, 1 != 1, , <...>/assert-hook.zeek, 18
+assertion_failure, 1 != 1, , <...>/assert-hook.zeek, 15

testing/btest/Baseline/language.assert-top-level/.stderr

@@ -1,3 +1,3 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-error in <...>/assert-top-level.zeek, line 7: assertion failure: getpid() == 0 (my pid greater 0? T)
+error in <...>/assert-top-level.zeek, line 5: assertion failure: getpid() == 0 (my pid greater 0? T)
 fatal error: failed to execute script statements at top-level scope

testing/btest/Baseline/language.assert/out

@@ -1,3 +1,3 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-error in <...>/assert.zeek, line 11: assertion failure: fmt("%s", 1) == "2"
+error in <...>/assert.zeek, line 8: assertion failure: fmt("%s", 1) == "2"
 fatal error: errors occurred while initializing

testing/btest/btest.cfg

@@ -99,4 +99,5 @@ BTEST_BASELINE_DIR=%(testbase)s/Baseline.cpp:%(testbase)s/Baseline
 # (no -j).
 [environment-zam]
 ZEEK_ZAM=1
+ZEEK_ZAM_KEEP_ASSERTS=1
 BTEST_BASELINE_DIR=%(testbase)s/Baseline.zam:%(testbase)s/Baseline.xform:%(testbase)s/Baseline

testing/btest/language/assert-hook.zeek

@@ -1,9 +1,6 @@
 # @TEST-DOC: Assert statement testing with assertion_failure and assertion_result implementation.
 #
-# Doesn't make sense for ZAM as it ignores assert's.
-# @TEST-REQUIRES: test "${ZEEK_ZAM}" != "1"
-#
-# @TEST-EXEC: zeek -b %INPUT >out
+# @TEST-EXEC: zeek -b -O no-event-handler-coalescence %INPUT >out
 # @TEST-EXEC: TEST_DIFF_CANONIFIER=$SCRIPTS/diff-remove-abspath btest-diff out
 # @TEST-EXEC: TEST_DIFF_CANONIFIER=$SCRIPTS/diff-remove-abspath btest-diff .stderr
 
@@ -164,9 +161,11 @@ hook assertion_result(result: bool, cond: string, msg: string, bt: Backtrace)
 
 event zeek_init()
 	{
-	assert 2 + 2 == 4, cat(get_current_packet_header()$ip);
 	assert 2 + 2 == 4, to_json([$msg="true and works"]);
-	assert 2 + 2 == 5, cat(get_current_packet_header()$ip);
+	# This next assert will generate a run-time error, exiting the
+	# event handler.
+	assert 2 + 2 == 4, cat(get_current_packet_header()$ip);
+	assert 2 + 2 == 5, "didn't get to here";
 	}
 
 event zeek_done()

testing/btest/language/assert-misc.zeek

@@ -1,9 +1,6 @@
 # @TEST-DOC: Test Describe() of assert statement. Expressions may be canonicalized.
 #
-# Doesn't make sense for ZAM as it ignores assert's.
-# @TEST-REQUIRES: test "${ZEEK_ZAM}" != "1"
-#
-# @TEST-EXEC: zeek -b %INPUT >out 2>&1
+# @TEST-EXEC: zeek -b -O no-event-handler-coalescence %INPUT >out 2>&1
 # @TEST-EXEC: TEST_DIFF_CANONIFIER=$SCRIPTS/diff-remove-abspath btest-diff out
 
 function test_function()

testing/btest/language/assert-top-level.zeek

@@ -1,5 +1,3 @@
-# Doesn't make sense for ZAM as it ignores assert's.
-# @TEST-REQUIRES: test "${ZEEK_ZAM}" != "1"
 # @TEST-EXEC-FAIL: zeek -b %INPUT >out
 # @TEST-EXEC: TEST_DIFF_CANONIFIER=$SCRIPTS/diff-remove-abspath btest-diff .stderr
 

testing/btest/language/assert.zeek

@@ -1,9 +1,6 @@
 # @TEST-DOC: Assert statement behavior testing without an assertion_failure() hook.
 #
-# Doesn't make sense for ZAM as it ignores assert's.
-# @TEST-REQUIRES: test "${ZEEK_ZAM}" != "1"
-#
-# @TEST-EXEC-FAIL: unset ZEEK_ALLOW_INIT_ERRORS; zeek -b %INPUT >out 2>&1
+# @TEST-EXEC-FAIL: unset ZEEK_ALLOW_INIT_ERRORS; zeek -b -O no-event-handler-coalescence %INPUT >out 2>&1
 # @TEST-EXEC: TEST_DIFF_CANONIFIER=$SCRIPTS/diff-remove-abspath btest-diff out
 
 event zeek_init()
@@ -69,6 +66,8 @@ event zeek_init()
 	{
 	local r: MyRecord = [$a=1234];
 	assert ! r?$b, fmt("Unexpected r$b is set to %s", r$b);
+	# This will generate a run-time error, rather than reporting the
+	# failed assertion.
 	assert r?$b, fmt("r$b is not set trying anyway: %s", r$b);
 	}
 

testing/btest/language/type-cast-error-dynamic-ZAM.zeek

@@ -1,4 +1,4 @@
-# @TEST-REQUIRES: test "${ZEEK_ZAM}" == "1"
+# @TEST-REQUIRES: test "${ZEEK_ZAM}" = "1"
 # @TEST-EXEC-FAIL: zeek -b %INPUT >output 2>err
 # @TEST-EXEC: TEST_DIFF_CANONIFIER=$SCRIPTS/diff-remove-abspath btest-diff err
 

testing/btest/language/uninitialized-local.ZAM.zeek

@@ -1,5 +1,5 @@
 # A version of uninitialized-local.zeek suitable for ZAM's behavior.
-# @TEST-REQUIRES: test "${ZEEK_ZAM}" == "1"
+# @TEST-REQUIRES: test "${ZEEK_ZAM}" = "1"
 # @TEST-EXEC-FAIL: zeek -b %INPUT >out 2>&1
 
 event testit() &priority=10

testing/btest/opt/AST-side-effects.zeek

@@ -1,5 +1,5 @@
 # @TEST-DOC: Stress tests for the AST optimizer dealing with side effects.
-# @TEST-REQUIRES: test "${ZEEK_ZAM}" == "1"
+# @TEST-REQUIRES: test "${ZEEK_ZAM}" = "1"
 #
 # See below for an explanation of this convoluted invocation line.
 # @TEST-EXEC: zeek -b -O ZAM -O dump-xform --optimize-func='AST_opt_test_.*' %INPUT >output

testing/btest/opt/ZAM-bif-tracking.zeek

@@ -1,5 +1,5 @@
 # @TEST-DOC: ZAM maintenance script for tracking changes in BiFs.
-# @TEST-REQUIRES: test "${ZEEK_ZAM}" == "1"
+# @TEST-REQUIRES: test "${ZEEK_ZAM}" = "1"
 #
 # @TEST-EXEC: zeek -b %INPUT >output
 # @TEST-EXEC: btest-diff output

testing/btest/opt/validate-ZAM.zeek

@@ -1,5 +1,5 @@
 # @TEST-DOC: ZAM maintenance script for validating synthesized operations.
-# @TEST-REQUIRES: test "${ZEEK_ZAM}" == "1"
+# @TEST-REQUIRES: test "${ZEEK_ZAM}" = "1"
 #
 # @TEST-EXEC: zeek -b -O validate-ZAM %INPUT >output
 # @TEST-EXEC: btest-diff output