Escape output of pg_amcheck test

petere · petere · commit 6a3631e251d1 · 2024-01-13T20:32:18.000+01:00
The pg_amcheck test reports a skip message if the layout of the index does not match expectations. That message includes the bytes that were expected and the ones that were found. But the found ones are arbitrary bytes, which can have funny effects on the terminal when they are printed. To avoid that, escape non-word characters before printing. Reviewed-by: Aleksander Alekseev <aleksander@timescale.com> Discussion: https://www.postgresql.org/message-id/flat/3f96f079-64e5-468a-8a19-cb481f0d31e5%40eisentraut.org
diff --git a/src/bin/pg_amcheck/t/004_verify_heapam.pl b/src/bin/pg_amcheck/t/004_verify_heapam.pl
@@ -367,10 +367,11 @@ sub write_tuple
 	{
 		close($file);    # ignore errors on close; we're exiting anyway
 		$node->clean_node;
-		plan skip_all =>
-		  sprintf(
+		plan skip_all => sprintf(
 			"Page layout of index %d differs from our expectations: expected (%x, %x, \"%s\"), got (%x, %x, \"%s\")",
-			$tupidx, 0xDEADF9F9, 0xDEADF9F9, "abcdefg", $a_1, $a_2, $b);
+			$tupidx, 0xDEADF9F9, 0xDEADF9F9, "abcdefg", $a_1, $a_2,
+			# escape non-word characters to avoid confusing the terminal
+			$b =~ s{(\W)}{ sprintf '\x%02x', ord($1) }aegr);
 		exit;
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -367,10 +367,11 @@ sub write_tuple`
`367`	`367`	`{`
`368`	`368`	`close($file); # ignore errors on close; we're exiting anyway`
`369`	`369`	`$node->clean_node;`
`370`		`- plan skip_all =>`
`371`		`- sprintf(`
	`370`	`+ plan skip_all => sprintf(`
`372`	`371`	`"Page layout of index %d differs from our expectations: expected (%x, %x, \"%s\"), got (%x, %x, \"%s\")",`
`373`		`- $tupidx, 0xDEADF9F9, 0xDEADF9F9, "abcdefg", $a_1, $a_2, $b);`
	`372`	`+ $tupidx, 0xDEADF9F9, 0xDEADF9F9, "abcdefg", $a_1, $a_2,`
	`373`	`+ # escape non-word characters to avoid confusing the terminal`
	`374`	`+ $b =~ s{(\W)}{ sprintf '\x%02x', ord($1) }aegr);`
`374`	`375`	`exit;`
`375`	`376`	`}`
`376`	`377`