refactor: DRY evidence tab page wrapper

evidence_tab.php

@@ -28,6 +28,7 @@
 include_once('./lib/snmp.php');
 include_once('./plugins/evidence/include/functions.php');
 include_once('./plugins/evidence/include/arrays.php');
+include_once('./plugins/evidence/include/ui_helpers.php');
 
 set_default_action();
 
@@ -42,18 +43,12 @@
 		break;
 
 	case 'find':
-		general_header();
-		evidence_display_form();
-		evidence_find();
-		bottom_footer();
+		evidence_render_tab_page('evidence_find');
 
 		break;
 
         default:
-		general_header();
-		evidence_display_form();
-		evidence_stats();
-		bottom_footer();
+		evidence_render_tab_page('evidence_stats');
 
 		break;
 }
@@ -260,4 +255,3 @@ function evidence_stats() {
 	print 'Oldest record: ' . $old . '<br/>';
 }
 
-

include/ui_helpers.php

@@ -0,0 +1,20 @@
+<?php
+/*
+ +-------------------------------------------------------------------------+
+ | Copyright (C) 2021-2024 Petr Macek                                      |
+ |                                                                         |
+ | This program is free software; you can redistribute it and/or           |
+ | modify it under the terms of the GNU General Public License             |
+ | as published by the Free Software Foundation; either version 2          |
+ | of the License, or (at your option) any later version.                  |
+ +-------------------------------------------------------------------------+
+ */
+
+if (!function_exists('evidence_render_tab_page')) {
+	function evidence_render_tab_page(callable $content_renderer) {
+		general_header();
+		evidence_display_form();
+		$content_renderer();
+		bottom_footer();
+	}
+}

tests/test_tab_wrapper.php

@@ -0,0 +1,64 @@
+<?php
+
+require_once __DIR__ . '/../include/ui_helpers.php';
+
+$events = [];
+
+function general_header() {
+	global $events;
+	$events[] = 'header';
+}
+
+function evidence_display_form() {
+	global $events;
+	$events[] = 'form';
+}
+
+function bottom_footer() {
+	global $events;
+	$events[] = 'footer';
+}
+
+function evidence_tab_test_content() {
+	global $events;
+	$events[] = 'content';
+}
+
+function assert_same($expected, $actual, $message) {
+	if ($expected !== $actual) {
+		fwrite(STDERR, $message . PHP_EOL);
+		fwrite(STDERR, 'Expected: ' . json_encode($expected) . PHP_EOL);
+		fwrite(STDERR, 'Actual:   ' . json_encode($actual) . PHP_EOL);
+		exit(1);
+	}
+}
+
+function assert_regex($pattern, $subject, $message) {
+	if (!preg_match($pattern, $subject)) {
+		fwrite(STDERR, $message . PHP_EOL);
+		exit(1);
+	}
+}
+
+evidence_render_tab_page('evidence_tab_test_content');
+assert_same(['header', 'form', 'content', 'footer'], $events, 'Tab helper should render wrapper in correct order.');
+
+$source = file_get_contents(__DIR__ . '/../evidence_tab.php');
+if ($source === false) {
+	fwrite(STDERR, "Unable to read evidence_tab.php\n");
+	exit(1);
+}
+
+assert_regex(
+	"/evidence_render_tab_page\\(\\s*'evidence_find'\\s*\\)\\s*;/",
+	$source,
+	"Expected find action to use evidence_render_tab_page()."
+);
+
+assert_regex(
+	"/evidence_render_tab_page\\(\\s*'evidence_stats'\\s*\\)\\s*;/",
+	$source,
+	"Expected default action to use evidence_render_tab_page()."
+);
+
+echo "OK\n";