Merge pull request #5984 from sysown/test/coverage-low-lib-files

test: add unit tests for low-coverage lib files

Author: renecannao

lib/MySQLFFTO.cpp

@@ -252,7 +252,9 @@ void MySQLFFTO::report_query_stats(const std::string& query, unsigned long long
     if (query.empty() || !GloMyQPro || !m_session) return;
     if (!m_session->client_myds || !m_session->client_myds->myconn || !m_session->client_myds->myconn->userinfo) return;
     auto* ui = m_session->client_myds->myconn->userinfo;
-    if (!ui->username || !ui->schemaname) return;
+    if (!ui->username) return;
+    char empty_schema[] = "";
+    char* schemaname = ui->schemaname ? ui->schemaname : empty_schema;
 
 	options opts;
 	opts.lowercase = mysql_thread___query_digests_lowercase;
@@ -276,7 +278,7 @@ void MySQLFFTO::report_query_stats(const std::string& query, unsigned long long
         uint64_t hash2; SpookyHash myhash; myhash.Init(19, 3);
         myhash.Update(ui->username, strlen(ui->username));
         myhash.Update(&qp.digest, sizeof(qp.digest));
-        myhash.Update(ui->schemaname, strlen(ui->schemaname));
+        myhash.Update(schemaname, strlen(schemaname));
         myhash.Update(&m_session->current_hostgroup, sizeof(m_session->current_hostgroup));
         myhash.Update(ca, strlen(ca));
         myhash.Final(&qp.digest_total, &hash2);
@@ -297,7 +299,9 @@ void MySQLFFTO::report_error(const unsigned char* data, size_t len) {
     if (!mysql_parse_err_packet(data, len, &err_no, &errmsg, &errmsg_len)) return;
 
     auto* ui = m_session->client_myds->myconn->userinfo;
-    if (!ui->username || !ui->schemaname) return;
+    if (!ui->username) return;
+    /* schemaname may be unset before COM_INIT_DB; still record the error */
+    char* schemaname = ui->schemaname ? ui->schemaname : (char*)"";
 
     // Build a null-terminated copy of the error message
     std::string msg(errmsg ? errmsg : "", errmsg_len);
@@ -322,7 +326,7 @@ void MySQLFFTO::report_error(const unsigned char* data, size_t len) {
 
     MyHGM->add_mysql_errors(
         hostgroup, hostname, port,
-        ui->username, client_addr, ui->schemaname,
+        ui->username, client_addr, schemaname,
         err_no, (char*)msg.c_str()
     );
 }

lib/PgSQLFFTO.cpp

@@ -279,7 +279,9 @@ void PgSQLFFTO::report_query_stats(const std::string& query, unsigned long long
     if (query.empty() || !GloPgQPro || !m_session) return;
     if (!m_session->client_myds || !m_session->client_myds->myconn || !m_session->client_myds->myconn->userinfo) return;
     auto* ui = m_session->client_myds->myconn->userinfo;
-    if (!ui->username || !ui->schemaname) return;
+    if (!ui->username) return;
+    char empty_schema[] = "";
+    char* schemaname = ui->schemaname ? ui->schemaname : empty_schema;
 
     options opts;
     opts.lowercase = pgsql_thread___query_digests_lowercase;
@@ -303,7 +305,7 @@ void PgSQLFFTO::report_query_stats(const std::string& query, unsigned long long
         uint64_t hash2; SpookyHash myhash; myhash.Init(19, 3);
         myhash.Update(ui->username, strlen(ui->username));
         myhash.Update(&qp.digest, sizeof(qp.digest));
-        myhash.Update(ui->schemaname, strlen(ui->schemaname));
+        myhash.Update(schemaname, strlen(schemaname));
         myhash.Update(&m_session->current_hostgroup, sizeof(m_session->current_hostgroup));
         myhash.Update(ca, strlen(ca));
         myhash.Final(&qp.digest_total, &hash2);
@@ -322,7 +324,9 @@ void PgSQLFFTO::report_error(const unsigned char* payload, size_t len) {
     if (!err.parsed) return;
 
     auto* ui = m_session->client_myds->myconn->userinfo;
-    if (!ui->username || !ui->schemaname) return;
+    if (!ui->username) return;
+    /* database/schemaname may be unset early in the session; still record */
+    char* schemaname = ui->schemaname ? ui->schemaname : (char*)"";
 
     // Build a null-terminated copy of the error message
     std::string msg(err.message ? err.message : "", err.message_len);
@@ -348,7 +352,7 @@ void PgSQLFFTO::report_error(const unsigned char* payload, size_t len) {
     // ui->schemaname and ui->dbname are the same field (union in PgSQL_Connection_userinfo)
     PgHGM->add_pgsql_errors(
         hostgroup, hostname, port,
-        ui->username, client_addr, ui->schemaname,
+        ui->username, client_addr, schemaname,
         err.sqlstate, msg.c_str()
     );
 }

test/infra/control/run-tests-isolated.bash

@@ -49,6 +49,19 @@ COVERAGE_REPORT_DIR="${WORKSPACE}/ci_infra_logs/${INFRA_ID}/coverage-report"
 if [ "${COVERAGE_MODE}" = "1" ]; then
     echo ">>> Code coverage enabled - reports will be saved to ${COVERAGE_REPORT_DIR}"
     mkdir -p "${COVERAGE_REPORT_DIR}"
+
+    # Coverage workflows use sparse checkout for source trees, so the tracked
+    # root codecov.yml may not be materialized in the worktree even though it
+    # exists at HEAD. codecov-action is explicitly pointed at this path; restore
+    # just that file from the tested commit without broadening sparse checkout.
+    if [ ! -f "${WORKSPACE}/codecov.yml" ]; then
+        if git -C "${WORKSPACE}" cat-file -e HEAD:codecov.yml 2>/dev/null; then
+            git -C "${WORKSPACE}" show HEAD:codecov.yml > "${WORKSPACE}/codecov.yml"
+            echo ">>> Materialized codecov.yml from HEAD for coverage upload"
+        else
+            echo ">>> WARNING: codecov.yml is not tracked at HEAD"
+        fi
+    fi
 fi
 
 # 1. Determine Required Infras

test/infra/docker-base/test-connector-version-pins.bash

@@ -1,21 +1,27 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
+# Portable pin check for CI runners without ripgrep (uses POSIX grep -F/-x/-q).
 dockerfile_path="${1:-$(dirname "$0")/Dockerfile}"
 
+if [ ! -f "$dockerfile_path" ]; then
+	echo "ERROR: Dockerfile not found: $dockerfile_path" >&2
+	exit 1
+fi
+
 expected_arg='ARG MYSQL_CONNECTOR_PYTHON_VERSION=9.7.0'
-if ! rg -Fqx -- "$expected_arg" "$dockerfile_path"; then
-    echo "ERROR: missing Dockerfile argument: $expected_arg" >&2
-    exit 1
+if ! grep -Fqx -- "$expected_arg" "$dockerfile_path"; then
+	echo "ERROR: missing Dockerfile argument: $expected_arg" >&2
+	exit 1
 fi
 
 for package in mysql-connector-python mysqlx-connector-python; do
-    expected_pin="${package}==\${MYSQL_CONNECTOR_PYTHON_VERSION}"
-    expected_dependency="\"${expected_pin}\" \\"
-    if ! rg -Fq -- "$expected_dependency" "$dockerfile_path"; then
-        echo "ERROR: missing package pin: $expected_pin" >&2
-        exit 1
-    fi
+	expected_pin="${package}==\${MYSQL_CONNECTOR_PYTHON_VERSION}"
+	expected_dependency="\"${expected_pin}\" \\"
+	if ! grep -Fq -- "$expected_dependency" "$dockerfile_path"; then
+		echo "ERROR: missing package pin: $expected_pin" >&2
+		exit 1
+	fi
 done
 
 echo "PASS: MySQLX Connector/Python version pins are present"

test/tap/groups/groups.json

@@ -34,6 +34,7 @@
   "fast_forward_grace_close_libmysql-t" : [ "legacy-g3","mysql-auto_increment_delay_multiplex=0-g3","mysql-multiplexing=false-g3","mysql-query_digests=0-g3","mysql-query_digests_keep_comment=1-g3","mysql84-g3","mysql90-g3","mysql95-g3" ],
   "fast_forward_switch_replication_deprecate_eof_libmysql-t" : [ "legacy-g3","mysql-auto_increment_delay_multiplex=0-g3","mysql-multiplexing=false-g3","mysql-query_digests=0-g3","mysql-query_digests_keep_comment=1-g3","mysql84-g3","mysql90-g3","mysql95-g3" ],
   "ffto_protocol_unit-t" : [ "unit-tests-g1","@proxysql_min_version:3.1" ],
+  "ffto_state_machine_unit-t" : [ "unit-tests-g1","@proxysql_min_version:3.1" ],
   "firewall_commands1-t" : [ "legacy-g1","mariadb10-galera-g1","mysql-auto_increment_delay_multiplex=0-g1","mysql-multiplexing=false-g1","mysql-query_digests=0-g1","mysql-query_digests_keep_comment=1-g1","mysql84-g1","mysql84-gr-g1","mysql90-g1","mysql90-gr-g1","mysql93-g1","mysql93-gr-g1","mysql95-g1","mysql95-gr-g1" ],
   "gen_utils_unit-t" : [ "unit-tests-g1" ],
   "genai_config_query_unit-t" : [ "ai-g1","@proxysql_min_version:4.0" ],
@@ -57,6 +58,7 @@
   "gtid_trxid_interval_unit-t" : [ "unit-tests-g1" ],
   "hostgroup_routing_unit-t" : [ "unit-tests-g1" ],
   "hostgroups_unit-t" : [ "unit-tests-g1" ],
+  "http_server_unit-t" : [ "unit-tests-g1" ],
   "issue5384-t" : [ "legacy-g4","mysql-auto_increment_delay_multiplex=0-g4","mysql-multiplexing=false-g4","mysql-query_digests=0-g4","mysql-query_digests_keep_comment=1-g4","mysql84-g4","mysql90-g4","mysql95-g4" ],
   "kill_connection-t" : [ "legacy-g1","mariadb10-galera-g1","mysql-auto_increment_delay_multiplex=0-g1","mysql-multiplexing=false-g1","mysql-query_digests=0-g1","mysql-query_digests_keep_comment=1-g1","mysql84-g1","mysql84-gr-g1","mysql90-g1","mysql90-gr-g1","mysql93-g1","mysql93-gr-g1","mysql95-g1","mysql95-gr-g1" ],
   "kill_connection2-t" : [ "legacy-g1","mariadb10-galera-g1","mysql-auto_increment_delay_multiplex=0-g1","mysql-multiplexing=false-g1","mysql-query_digests=0-g1","mysql-query_digests_keep_comment=1-g1","mysql84-g1","mysql84-gr-g1","mysql90-g1","mysql90-gr-g1","mysql93-g1","mysql93-gr-g1","mysql95-g1","mysql95-gr-g1" ],
@@ -147,6 +149,7 @@
   "nl2sql_unit_base-t" : [ "ai-g1","@proxysql_min_version:4.0" ],
   "ok_packet_mixed_queries-t" : [ "legacy-g4","mysql-auto_increment_delay_multiplex=0-g4","mysql-multiplexing=false-g4","mysql-query_digests=0-g4","mysql-query_digests_keep_comment=1-g4","mysql84-g4","mysql90-g4","mysql95-g4" ],
   "parsersql_digest_test-t" : [ "unit-tests-g1" ],
+  "parsersql_unit-t" : [ "unit-tests-g1" ],
   "pgsql-admin_metacmds-t" : [ "legacy-g4","mysql-auto_increment_delay_multiplex=0-g4","mysql-multiplexing=false-g4","mysql-query_digests=0-g4","mysql-query_digests_keep_comment=1-g4" ],
   "pgsql-admin_metacmds_describe_all_tables-t" : [ "legacy-g4","mysql-auto_increment_delay_multiplex=0-g4","mysql-multiplexing=false-g4","mysql-query_digests=0-g4","mysql-query_digests_keep_comment=1-g4" ],
   "pgsql-admin_metacmds_describe_queries-t" : [ "legacy-g4","mysql-auto_increment_delay_multiplex=0-g4","mysql-multiplexing=false-g4","mysql-query_digests=0-g4","mysql-query_digests_keep_comment=1-g4" ],
@@ -203,6 +206,7 @@
   "pgsql_monitor_unit-t" : [ "unit-tests-g1" ],
   "pgsql_query_logging_autodump-t" : [ "legacy-g6","mysql-auto_increment_delay_multiplex=0-g1","mysql-multiplexing=false-g1","mysql-query_digests=0-g1","mysql-query_digests_keep_comment=1-g1" ],
   "pgsql_query_logging_memory-t" : [ "legacy-g6","mysql-auto_increment_delay_multiplex=0-g1","mysql-multiplexing=false-g1","mysql-query_digests=0-g1","mysql-query_digests_keep_comment=1-g1" ],
+  "pgsql_query_processor_unit-t" : [ "unit-tests-g1" ],
   "pgsql_servers_ssl_params_unit-t" : [ "unit-tests-g1" ],
   "pgsql_tokenizer_unit-t" : [ "unit-tests-g1" ],
   "pgsql_txn_state_unit-t" : [ "unit-tests-g1" ],
@@ -302,6 +306,7 @@
   "reg_test_stmt_resultset_err_no_rows_php-t" : [ "legacy-g7","mysql-auto_increment_delay_multiplex=0-g2","mysql-multiplexing=false-g2","mysql-query_digests=0-g2","mysql-query_digests_keep_comment=1-g2","mysql84-g7","mysql90-g2","mysql95-g2" ],
   "reg_test_stmt_send_long_data_short_packet-t" : [ "mysql84-g6","mysql95-g1" ],
   "reg_test_unexp_ping_pkt-t" : [ "legacy-g7","mysql-auto_increment_delay_multiplex=0-g2","mysql-multiplexing=false-g2","mysql-query_digests=0-g2","mysql-query_digests_keep_comment=1-g2","mysql84-g7","mysql90-g2","mysql95-g2" ],
+  "restapi_server_unit-t" : [ "unit-tests-g1" ],
   "rule_matching_unit-t" : [ "unit-tests-g1" ],
   "savepoint-3749-t" : [ "legacy-g7","mysql-auto_increment_delay_multiplex=0-g2","mysql-multiplexing=false-g2","mysql-query_digests=0-g2","mysql-query_digests_keep_comment=1-g2","mysql84-g7","mysql90-g2","mysql95-g2" ],
   "savepoint-948-t" : [ "legacy-g7","mariadb10-galera-g7","mysql-auto_increment_delay_multiplex=0-g2","mysql-multiplexing=false-g2","mysql-query_digests=0-g2","mysql-query_digests_keep_comment=1-g2","mysql84-g7","mysql84-gr-g7","mysql90-g2","mysql95-g2" ],

test/tap/tests/ffto_mysql_helpers.h

@@ -0,0 +1,167 @@
+/**
+ * @file ffto_mysql_helpers.h
+ * @brief Shared setup for MySQL FFTO TAP tests.
+ *
+ * Ensures:
+ *  1. mysql-ffto_enabled is on at runtime
+ *  2. fast_forward=1 on the connecting user's frontend credential
+ *  3. After connect, session actually has fast_forward (via processlist extended_info)
+ */
+#ifndef FFTO_MYSQL_HELPERS_H
+#define FFTO_MYSQL_HELPERS_H
+
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+#include "mysql.h"
+#include "tap.h"
+#include "command_line.h"
+#include "utils.h"
+
+/**
+ * @brief Enable FFTO + fast_forward for @p username and LOAD to runtime.
+ * @return 0 on success, non-zero on failure (diags already emitted).
+ */
+static inline int ffto_mysql_enable_ff(MYSQL* admin, const char* username) {
+	if (!admin || !username || !username[0]) {
+		diag("ffto_mysql_enable_ff: invalid args");
+		return 1;
+	}
+
+	/* Prefer SET (same path as mysql-fast_forward-t / session_track FF tests). */
+	if (mysql_query(admin, "SET mysql-ffto_enabled='true'")) {
+		diag("SET mysql-ffto_enabled failed: %s", mysql_error(admin));
+		return 1;
+	}
+	if (mysql_query(admin, "SET mysql-ffto_max_buffer_size=1048576")) {
+		diag("SET mysql-ffto_max_buffer_size failed: %s", mysql_error(admin));
+		return 1;
+	}
+	if (mysql_query(admin, "SET mysql-show_processlist_extended=2")) {
+		diag("SET mysql-show_processlist_extended failed: %s", mysql_error(admin));
+		return 1;
+	}
+	if (mysql_query(admin, "LOAD MYSQL VARIABLES TO RUNTIME")) {
+		diag("LOAD MYSQL VARIABLES TO RUNTIME failed: %s", mysql_error(admin));
+		return 1;
+	}
+
+	/* Enable fast_forward on every row for this user (frontend + backend). */
+	char q[512];
+	snprintf(q, sizeof(q),
+		"UPDATE mysql_users SET fast_forward=1 WHERE username='%s'", username);
+	if (mysql_query(admin, q)) {
+		diag("UPDATE mysql_users fast_forward failed: %s", mysql_error(admin));
+		return 1;
+	}
+	/* Belt-and-suspenders: also flip all users (matches historical suite setup). */
+	if (mysql_query(admin, "UPDATE mysql_users SET fast_forward=1")) {
+		diag("UPDATE mysql_users SET fast_forward=1 (all) failed: %s", mysql_error(admin));
+		return 1;
+	}
+	if (mysql_query(admin, "LOAD MYSQL USERS TO RUNTIME")) {
+		diag("LOAD MYSQL USERS TO RUNTIME failed: %s", mysql_error(admin));
+		return 1;
+	}
+
+	/* Hard-require the connecting user's FRONTEND credential has fast_forward=1. */
+	snprintf(q, sizeof(q),
+		"SELECT COUNT(*) FROM runtime_mysql_users "
+		"WHERE username='%s' AND frontend=1 AND fast_forward=1", username);
+	if (mysql_query(admin, q)) {
+		diag("runtime_mysql_users check failed: %s", mysql_error(admin));
+		return 1;
+	}
+	MYSQL_RES* res = mysql_store_result(admin);
+	MYSQL_ROW row = res ? mysql_fetch_row(res) : NULL;
+	int cnt = row && row[0] ? atoi(row[0]) : 0;
+	if (res) mysql_free_result(res);
+	if (cnt < 1) {
+		diag("FATAL: runtime frontend user '%s' still has fast_forward=0 after LOAD", username);
+		if (mysql_query(admin,
+			"SELECT username, frontend, backend, fast_forward FROM runtime_mysql_users") == 0) {
+			MYSQL_RES* dump = mysql_store_result(admin);
+			MYSQL_ROW r;
+			while (dump && (r = mysql_fetch_row(dump))) {
+				diag("  runtime_mysql_users: user=%s fe=%s be=%s ff=%s",
+					r[0] ? r[0] : "NULL",
+					r[1] ? r[1] : "NULL",
+					r[2] ? r[2] : "NULL",
+					r[3] ? r[3] : "NULL");
+			}
+			if (dump) mysql_free_result(dump);
+		}
+		return 1;
+	}
+	diag("runtime frontend user '%s' has fast_forward=1", username);
+	return 0;
+}
+
+/**
+ * @brief After a client connection is up, confirm the session is in fast_forward.
+ * Polls stats_mysql_processlist.extended_info for up to 2s.
+ * @return true if session reports fast_forward != 0.
+ */
+static inline bool ffto_mysql_session_is_ff(MYSQL* admin, const char* username) {
+	if (!admin || !username) return false;
+	char q[512];
+	snprintf(q, sizeof(q),
+		"SELECT extended_info FROM stats_mysql_processlist WHERE user='%s'", username);
+	for (int i = 0; i < 20; i++) {
+		if (mysql_query(admin, q) != 0) { usleep(100000); continue; }
+		MYSQL_RES* res = mysql_store_result(admin);
+		if (!res) { usleep(100000); continue; }
+		MYSQL_ROW row;
+		bool found = false;
+		while ((row = mysql_fetch_row(res))) {
+			const char* info = row[0] ? row[0] : "";
+			/* extended_info JSON: "fast_forward":1 or "fast_forward": 1 */
+			if (strstr(info, "\"fast_forward\":1") || strstr(info, "\"fast_forward\": 1")) {
+				found = true;
+				break;
+			}
+			/* Also accept non-zero enum values dumped as numbers > 0 */
+			const char* p = strstr(info, "\"fast_forward\":");
+			if (p) {
+				p += strlen("\"fast_forward\":");
+				while (*p == ' ') p++;
+				if (*p && *p != '0' && *p != ',' && *p != '}') {
+					found = true;
+					break;
+				}
+			}
+		}
+		mysql_free_result(res);
+		if (found) return true;
+		usleep(100000);
+	}
+	return false;
+}
+
+/**
+ * @brief Clear in-memory query digests (DELETE on the stats mirror is NOT enough).
+ */
+static inline int ffto_mysql_reset_digests(MYSQL* admin) {
+	if (mysql_query(admin, "SELECT * FROM stats_mysql_query_digest_reset")) {
+		diag("stats_mysql_query_digest_reset failed: %s", mysql_error(admin));
+		return 1;
+	}
+	MYSQL_RES* r = mysql_store_result(admin);
+	if (r) mysql_free_result(r);
+	return 0;
+}
+
+/**
+ * @brief Clear in-memory mysql error stats.
+ */
+static inline int ffto_mysql_reset_errors(MYSQL* admin) {
+	if (mysql_query(admin, "SELECT * FROM stats_mysql_errors_reset")) {
+		diag("stats_mysql_errors_reset failed: %s", mysql_error(admin));
+		return 1;
+	}
+	MYSQL_RES* r = mysql_store_result(admin);
+	if (r) mysql_free_result(r);
+	return 0;
+}
+
+#endif /* FFTO_MYSQL_HELPERS_H */

test/tap/tests/test_ffto_bypass-t.cpp

@@ -30,14 +30,15 @@ int main(int argc, char** argv) {
     ok(admin != NULL, "Connected to ProxySQL Admin");
 
     // Set a very small threshold: 100 bytes
-    ok(mysql_query(admin, "UPDATE global_variables SET variable_value='true' WHERE variable_name='mysql-ffto_enabled'") == 0, "Enable FFTO");
+    ok(mysql_query(admin, "SET mysql-ffto_enabled='true'") == 0, "Enable FFTO");
     ok(mysql_query(admin, "UPDATE global_variables SET variable_value='100' WHERE variable_name='mysql-ffto_max_buffer_size'") == 0, "Set FFTO max buffer size to 100");
     ok(mysql_query(admin, "LOAD MYSQL VARIABLES TO RUNTIME") == 0, "Load variables to runtime");
 
-    // Ensure user exists
-    char user_query[1024];
-    snprintf(user_query, sizeof(user_query), "INSERT OR REPLACE INTO mysql_users (username, password, default_hostgroup, fast_forward, default_schema) VALUES ('%s', '%s', 0, 1, 'information_schema')", cl.username, cl.password);
-    ok(mysql_query(admin, user_query) == 0, "Configure user with fast_forward=1 and default_schema");
+    /* Enable fast_forward on ALL mysql_users rows (frontend + backend).
+     * Partial INSERT OR REPLACE only updates the backend PK row and leaves
+     * frontend credentials at fast_forward=0, so FFTO never runs. */
+    ok(mysql_query(admin, "UPDATE mysql_users SET fast_forward=1, default_schema='information_schema'") == 0,
+       "Enable fast_forward on all mysql_users");
     ok(mysql_query(admin, "LOAD MYSQL USERS TO RUNTIME") == 0, "Load users to runtime");
 
     // Ensure backend server exists