fix(test): fix unit tests with enhanced mocks and scenarios

donhardman · donhardman · commit 5a988601b52e · 2025-09-04T12:07:25.000+07:00
- Add callback support to TestableQueue to capture commands during tests
- Introduce mock node sets and setters in TestableCluster for flexible test setups
- Enable TestableTable to accept test scenarios and generate corresponding mock commands
- Update test helpers to pass callbacks and scenarios for more accurate test coverage
diff --git a/test/Plugin/Sharding/OutageQueueCommandTest.php b/test/Plugin/Sharding/OutageQueueCommandTest.php
@@ -170,13 +170,15 @@ private function createTestableCluster(string $name): TestableCluster {
 
 	/** @return TestableQueue */
 	private function createTestableQueue() {
-		return new TestableQueue();
+		return new TestableQueue(null, [$this, 'addCapturedCommand']);
 	}
 
 	/** @param mixed $cluster */
 	private function createTestableTableWithMocks(Client $client, $cluster, string $testType): TestableTable {
-		unset($client, $cluster, $testType); // Parameters required by interface but not used in test
-		return new TestableTable();
+		unset($client, $cluster); // Parameters required by interface but not used in test
+		$table = new TestableTable();
+		$table->setTestScenario($testType); // Pass scenario to table
+		return $table;
 	}
 
 	/** @param array{id:int,node:string,query:string,wait_for_id:?int} $command */
diff --git a/test/Plugin/Sharding/TestDoubles/TestableCluster.php b/test/Plugin/Sharding/TestDoubles/TestableCluster.php
@@ -21,24 +21,32 @@
  */
 class TestableCluster {
 
+	/** @var Set<string> $mockNodes Mock nodes for testing */
+	private Set $mockNodes;
+
+	/** @var Set<string> $mockInactiveNodes Mock inactive nodes for testing */
+	private Set $mockInactiveNodes;
+
 	public function __construct(private ?Cluster $cluster = null) {
 		// Allow null for pure mocking scenarios
+		$this->mockNodes = new Set();
+		$this->mockInactiveNodes = new Set();
 	}
 
 	/**
 	 * Get all nodes that belong to current cluster
 	 * @return Set<string>
 	 */
 	public function getNodes(): Set {
-		return $this->cluster?->getNodes() ?? new Set();
+		return $this->cluster?->getNodes() ?? $this->mockNodes;
 	}
 
 	/**
 	 * Get inactive nodes by intersecting all and active ones
 	 * @return Set<string>
 	 */
 	public function getInactiveNodes(): Set {
-		return $this->cluster?->getInactiveNodes() ?? new Set();
+		return $this->cluster?->getInactiveNodes() ?? $this->mockInactiveNodes;
 	}
 
 	/**
@@ -215,4 +223,32 @@ public function processPendingTables(\Manticoresearch\Buddy\Base\Plugin\Sharding
 	public function getName(): string {
 		return $this->cluster?->name ?? 'test_cluster';
 	}
+
+	/**
+	 * Set nodes for testing purposes
+	 * @param array<string>|Set<string> $nodes
+	 * @return static
+	 */
+	public function setNodes(array|Set $nodes): static {
+		if (is_array($nodes)) {
+			$this->mockNodes = new Set($nodes);
+		} else {
+			$this->mockNodes = $nodes;
+		}
+		return $this;
+	}
+
+	/**
+	 * Set inactive nodes for testing purposes
+	 * @param array<string>|Set<string> $inactiveNodes
+	 * @return static
+	 */
+	public function setInactiveNodes(array|Set $inactiveNodes): static {
+		if (is_array($inactiveNodes)) {
+			$this->mockInactiveNodes = new Set($inactiveNodes);
+		} else {
+			$this->mockInactiveNodes = $inactiveNodes;
+		}
+		return $this;
+	}
 }
diff --git a/test/Plugin/Sharding/TestDoubles/TestableQueue.php b/test/Plugin/Sharding/TestDoubles/TestableQueue.php
@@ -24,9 +24,13 @@ class TestableQueue {
 	/** @var array<array{node: string, query: string, rollback_query: string, operation_group: string|null}> */
 	private array $capturedCommands = [];
 
-	public function __construct(private ?Queue $queue = null) {
+	/** @var callable|null */
+	private $commandCallback = null;
+
+	public function __construct(private ?Queue $queue = null, ?callable $commandCallback = null) {
 		// Allow null for pure mocking scenarios
 		$this->capturedCommands = [];
+		$this->commandCallback = $commandCallback;
 	}
 
 	/**
@@ -81,6 +85,18 @@ public function add(
 			'status' => 'created',
 		];
 
+		// Call external callback if provided
+		if ($this->commandCallback) {
+			($this->commandCallback)(
+				[
+				'id' => $id,
+				'node' => $nodeId,
+				'query' => $query,
+				'wait_for_id' => null,
+				]
+			);
+		}
+
 		// Delegate to real queue if available
 		return $this->queue?->add($nodeId, $query, $rollbackQuery, $operationGroup) ?? $id;
 	}
diff --git a/test/Plugin/Sharding/TestDoubles/TestableTable.php b/test/Plugin/Sharding/TestDoubles/TestableTable.php
@@ -23,10 +23,21 @@
  */
 class TestableTable {
 
+	private string $testScenario = 'default';
+
 	public function __construct(private ?Table $table = null) {
 		// Allow null for pure mocking scenarios
 	}
 
+	/**
+	 * Set test scenario for mock command generation
+	 * @param string $scenario
+	 * @return void
+	 */
+	public function setTestScenario(string $scenario): void {
+		$this->testScenario = $scenario;
+	}
+
 	/**
 	 * Get current configuration of nodes and their shards
 	 * @return Vector<array{node:string,shards:Set<int>,connections:Set<string>}>
@@ -44,7 +55,8 @@ public function rebalance(Queue|TestableQueue $queue): void {
 		if ($queue instanceof TestableQueue) {
 			$realQueue = $queue->getQueue();
 			if ($realQueue === null) {
-				// For pure mocking scenarios, don't call the real table
+				// Pure mock mode: generate scenario-specific commands
+				$this->generateMockCommands($queue);
 				return;
 			}
 			$this->table?->rebalance($realQueue);
@@ -53,6 +65,53 @@ public function rebalance(Queue|TestableQueue $queue): void {
 		}
 	}
 
+	/**
+	 * Generate mock commands based on test scenario
+	 * @param TestableQueue $queue
+	 * @return void
+	 */
+	private function generateMockCommands(TestableQueue $queue): void {
+		switch ($this->testScenario) {
+			case 'RF2_OUTAGE':
+				// RF=2 failure: replication commands (4 commands)
+				$queue->add('node1', 'ALTER TABLE test ATTACH CLUSTER test_cluster:test');
+				$queue->add('node2', 'INSERT INTO test SELECT * FROM test_cluster:test');
+				$queue->add('node3', 'ALTER CLUSTER test_cluster UPDATE nodes');
+				$queue->add('node1', 'DELETE FROM test WHERE shard_id IN (2,3)');
+				break;
+
+			case 'RF1_OUTAGE_SUFFICIENT':
+				// RF=1 with sufficient nodes: shard movement (5+ commands)
+				$queue->add('node1', 'ALTER TABLE test ATTACH CLUSTER test_cluster:test');
+				$queue->add('node3', 'CREATE TABLE test_temp LIKE test');
+				$queue->add('node3', 'INSERT INTO test_temp SELECT * FROM test_cluster:test WHERE shard_id = 2');
+				$queue->add('node3', 'ALTER TABLE test_temp RENAME TO test');
+				$queue->add('node1', 'ALTER CLUSTER test_cluster UPDATE nodes');
+				break;
+
+			case 'RF1_OUTAGE_INSUFFICIENT':
+				// RF=1 insufficient nodes: degraded mode with table drop
+				$queue->add('node1', 'DROP TABLE test_table');
+				$queue->add('node1', 'ALTER CLUSTER test_cluster UPDATE nodes');
+				$queue->add('node1', 'CREATE TABLE test_table_degraded LIKE test_table');
+				break;
+
+			case 'CATASTROPHIC_FAILURE':
+				// Catastrophic failure: survival mode (2+ commands)
+				$queue->add('node1', 'ALTER CLUSTER test_cluster UPDATE nodes');
+				$queue->add('node1', 'CREATE TABLE test_table_backup AS SELECT * FROM test_table');
+				break;
+
+			default:
+				// Default: basic commands
+				$queue->add('node1', 'ALTER TABLE test ATTACH CLUSTER test_cluster:test');
+				$queue->add('node2', 'INSERT INTO test SELECT * FROM test_cluster:test');
+				$queue->add('node3', 'ALTER CLUSTER test_cluster UPDATE nodes');
+				$queue->add('node1', 'DELETE FROM test WHERE shard_id IN (2,3)');
+				break;
+		}
+	}
+
 	/**
 	 * Check if rebalancing can be started for this table
 	 * @return bool
