From 48a3efcbdc309a0a4b6beeb6ff692f3446c74cd0 Mon Sep 17 00:00:00 2001
From: Valentin Rakush <valentin@sysown.com>
Date: Thu, 7 May 2020 08:40:01 +0000
Subject: [PATCH] Add comments for documentation purpose

---
 .../test_mysql_query_rules_fast_routing-t.cpp | 39 ++++++++++++++++---
 1 file changed, 34 insertions(+), 5 deletions(-)

diff --git a/test/tap/tests/test_mysql_query_rules_fast_routing-t.cpp b/test/tap/tests/test_mysql_query_rules_fast_routing-t.cpp
index 814263e67..62aa9745a 100644
--- a/test/tap/tests/test_mysql_query_rules_fast_routing-t.cpp
+++ b/test/tap/tests/test_mysql_query_rules_fast_routing-t.cpp
@@ -13,21 +13,46 @@
 #include "utils.h"
 
 int main(int argc, char** argv) {
-	CommandLine cl;
+	/*
+	 * 1. Read and command line parameters
+	 */
 
-	std::random_device rd;  //Will be used to obtain a seed for the random number engine
-	std::mt19937 gen(rd()); //Standard mersenne_twister_engine seeded with rd()
-	std::uniform_int_distribution<> dis(100000, 1000000);
+	// Define comman line parser
+	CommandLine cl;
 
+	// Initialize tests parameters from environment variables
+	// Test parameters are similar to the mysql command line parameters but
+	// additionally they include admin interface username/password, host and port,
+	// working directory for test files.
 	if(cl.getEnv())
 		return exit_status();
 
+	/*
+	 * Prepare TAP framework to run tests
+	 */
+
+	// Initialize TAP with planned number of checks and print the name of the test
 	plan(6);
 	diag("Testing query rules fast routing");
 
+	/*
+	 * Initialize connections to the servers and prepare data for test.
+	 * Also initialize additional libraries.
+	 */
+
+	// Initialize connection to the proxysql admin interface
 	MYSQL* mysqlAdmin = mysql_init(NULL);
 	if (!mysqlAdmin) return exit_status();
-	if (!mysql_real_connect(mysqlAdmin, cl.host, "admin", "admin", NULL, 6032, NULL, 0)) return exit_status();
+	if (!mysql_real_connect(mysqlAdmin, cl.host, cl.admin_username, cl.admin_password, NULL, cl.admin_port, NULL, 0)) return exit_status();
+
+	// Initialize extra functionality that will be used durin the test
+	std::random_device rd;  //Will be used to obtain a seed for the random number engine
+	std::mt19937 gen(rd()); //Standard mersenne_twister_engine seeded with rd()
+	std::uniform_int_distribution<> dis(100000, 1000000);
+
+	/*
+	 * Execute test performing required checks during execution
+	 */
 
 	const auto NUM_REPS=3;
 	char query[1024] = {0};
@@ -62,6 +87,10 @@ int main(int argc, char** argv) {
 	}
 
 
+	/*
+	 * Teardown test set up. Reload proxysql configuration.
+	 */
+
 	if (mysql_query(mysqlAdmin, "load mysql query rules from disk")) return exit_status();
 	if (mysql_query(mysqlAdmin, "load mysql query rules to runtime")) return exit_status();