|
| 1 | +// Copyright 2025 Apache Doris Community |
| 2 | +// Licensed under the Apache License, Version 2.0 |
| 3 | + |
| 4 | +//! Java FE Specification Tests |
| 5 | +//! |
| 6 | +//! CLAUDE.md Principle #2: "Use Java FE behavior as the specification" |
| 7 | +//! |
| 8 | +//! These tests query the running Java FE to document expected behavior |
| 9 | +//! that Rust FE must match exactly. Each test is a specification requirement. |
| 10 | +
|
| 11 | +use std::io::{Read, Write}; |
| 12 | +use std::net::TcpStream; |
| 13 | + |
| 14 | +fn main() { |
| 15 | + println!("\n╔════════════════════════════════════════════════════════════╗"); |
| 16 | + println!("║ Java FE Specification Suite - CLAUDE.md Principle #2 ║"); |
| 17 | + println!("║ \"Use Java FE behavior as the specification\" ║"); |
| 18 | + println!("╚════════════════════════════════════════════════════════════╝\n"); |
| 19 | + |
| 20 | + spec_database_operations(); |
| 21 | + spec_metadata_queries(); |
| 22 | + spec_aggregation_queries(); |
| 23 | + spec_group_by_queries(); |
| 24 | + spec_order_limit_queries(); |
| 25 | + spec_where_clause(); |
| 26 | + spec_tpch_query_1(); |
| 27 | + |
| 28 | + println!("\n╔════════════════════════════════════════════════════════════╗"); |
| 29 | + println!("║ All Specifications Documented ✅ ║"); |
| 30 | + println!("║ Rust FE must match this behavior exactly ║"); |
| 31 | + println!("╚════════════════════════════════════════════════════════════╝\n"); |
| 32 | +} |
| 33 | + |
| 34 | +/// Java FE Specification: Database operations |
| 35 | +fn spec_database_operations() { |
| 36 | + println!("\n=== Java FE Specification: Database Operations ===\n"); |
| 37 | + |
| 38 | + let mut conn = connect_java_fe().expect("Java FE not running on 9030"); |
| 39 | + |
| 40 | + // SPEC: SHOW DATABASES returns list of databases |
| 41 | + println!("SPEC: SHOW DATABASES"); |
| 42 | + let result = execute_select(&mut conn, "SHOW DATABASES").unwrap(); |
| 43 | + println!("✓ Returns database list: {}", result); |
| 44 | + |
| 45 | + // SPEC: USE <database> switches context |
| 46 | + println!("\nSPEC: USE tpch"); |
| 47 | + execute_query(&mut conn, "USE tpch").unwrap(); |
| 48 | + println!("✓ Database context switched"); |
| 49 | + |
| 50 | + // SPEC: SHOW TABLES returns list of tables in current database |
| 51 | + println!("\nSPEC: SHOW TABLES"); |
| 52 | + let result = execute_select(&mut conn, "SHOW TABLES").unwrap(); |
| 53 | + println!("✓ Returns table list: {}", result); |
| 54 | + |
| 55 | + println!("\n=== Specification Documented ===\n"); |
| 56 | +} |
| 57 | + |
| 58 | +/// Java FE Specification: Metadata queries |
| 59 | +fn spec_metadata_queries() { |
| 60 | + println!("\n=== Java FE Specification: Metadata Queries ===\n"); |
| 61 | + |
| 62 | + let mut conn = connect_java_fe().expect("Java FE not running"); |
| 63 | + execute_query(&mut conn, "USE tpch").unwrap(); |
| 64 | + |
| 65 | + // SPEC: SHOW CREATE TABLE returns table DDL |
| 66 | + println!("SPEC: SHOW CREATE TABLE lineitem"); |
| 67 | + let result = execute_select(&mut conn, "SHOW CREATE TABLE lineitem").unwrap(); |
| 68 | + println!("✓ Returns DDL: {}", result); |
| 69 | + |
| 70 | + // SPEC: DESC table returns column information |
| 71 | + println!("\nSPEC: DESC lineitem"); |
| 72 | + let result = execute_select(&mut conn, "DESC lineitem").unwrap(); |
| 73 | + println!("✓ Returns column info: {}", result); |
| 74 | + |
| 75 | + // SPEC: SHOW COLUMNS returns detailed column metadata |
| 76 | + println!("\nSPEC: SHOW COLUMNS FROM lineitem"); |
| 77 | + let result = execute_select(&mut conn, "SHOW COLUMNS FROM lineitem").unwrap(); |
| 78 | + println!("✓ Returns column metadata: {}", result); |
| 79 | + |
| 80 | + println!("\n=== Specification Documented ===\n"); |
| 81 | +} |
| 82 | + |
| 83 | +/// Java FE Specification: Aggregation queries |
| 84 | +
|
| 85 | + |
| 86 | +fn spec_aggregation_queries() { |
| 87 | + println!("\n=== Java FE Specification: Aggregation Queries ===\n"); |
| 88 | + |
| 89 | + let mut conn = connect_java_fe().expect("Java FE not running"); |
| 90 | + execute_query(&mut conn, "USE tpch").unwrap(); |
| 91 | + |
| 92 | + // SPEC: COUNT(*) aggregation |
| 93 | + println!("SPEC: SELECT COUNT(*) FROM lineitem"); |
| 94 | + let result = execute_select(&mut conn, "SELECT COUNT(*) FROM lineitem").unwrap(); |
| 95 | + println!("✓ COUNT(*): {}", result); |
| 96 | + |
| 97 | + // SPEC: SUM aggregation |
| 98 | + println!("\nSPEC: SELECT SUM(l_quantity) FROM lineitem"); |
| 99 | + let result = execute_select(&mut conn, "SELECT SUM(l_quantity) FROM lineitem").unwrap(); |
| 100 | + println!("✓ SUM(): {}", result); |
| 101 | + |
| 102 | + // SPEC: AVG aggregation |
| 103 | + println!("\nSPEC: SELECT AVG(l_quantity) FROM lineitem"); |
| 104 | + let result = execute_select(&mut conn, "SELECT AVG(l_quantity) FROM lineitem").unwrap(); |
| 105 | + println!("✓ AVG(): {}", result); |
| 106 | + |
| 107 | + // SPEC: MIN/MAX aggregation |
| 108 | + println!("\nSPEC: SELECT MIN(l_quantity), MAX(l_quantity) FROM lineitem"); |
| 109 | + let result = execute_select(&mut conn, "SELECT MIN(l_quantity), MAX(l_quantity) FROM lineitem").unwrap(); |
| 110 | + println!("✓ MIN/MAX: {}", result); |
| 111 | + |
| 112 | + println!("\n=== Specification Documented ===\n"); |
| 113 | +} |
| 114 | + |
| 115 | +/// Java FE Specification: GROUP BY queries |
| 116 | +
|
| 117 | + |
| 118 | +fn spec_group_by_queries() { |
| 119 | + println!("\n=== Java FE Specification: GROUP BY Queries ===\n"); |
| 120 | + |
| 121 | + let mut conn = connect_java_fe().expect("Java FE not running"); |
| 122 | + execute_query(&mut conn, "USE tpch").unwrap(); |
| 123 | + |
| 124 | + // SPEC: Simple GROUP BY |
| 125 | + println!("SPEC: SELECT l_orderkey, COUNT(*) FROM lineitem GROUP BY l_orderkey"); |
| 126 | + let result = execute_select(&mut conn, |
| 127 | + "SELECT l_orderkey, COUNT(*) FROM lineitem GROUP BY l_orderkey").unwrap(); |
| 128 | + println!("✓ GROUP BY: {}", result); |
| 129 | + |
| 130 | + // SPEC: GROUP BY with multiple columns |
| 131 | + println!("\nSPEC: GROUP BY l_orderkey, l_returnflag"); |
| 132 | + let result = execute_select(&mut conn, |
| 133 | + "SELECT l_orderkey, l_returnflag, COUNT(*) FROM lineitem GROUP BY l_orderkey, l_returnflag").unwrap(); |
| 134 | + println!("✓ Multi-column GROUP BY: {}", result); |
| 135 | + |
| 136 | + // SPEC: GROUP BY with HAVING |
| 137 | + println!("\nSPEC: GROUP BY with HAVING COUNT(*) > 1"); |
| 138 | + let result = execute_select(&mut conn, |
| 139 | + "SELECT l_orderkey, COUNT(*) FROM lineitem GROUP BY l_orderkey HAVING COUNT(*) > 1").unwrap(); |
| 140 | + println!("✓ HAVING clause: {}", result); |
| 141 | + |
| 142 | + println!("\n=== Specification Documented ===\n"); |
| 143 | +} |
| 144 | + |
| 145 | +/// Java FE Specification: ORDER BY and LIMIT |
| 146 | +
|
| 147 | + |
| 148 | +fn spec_order_limit_queries() { |
| 149 | + println!("\n=== Java FE Specification: ORDER BY and LIMIT ===\n"); |
| 150 | + |
| 151 | + let mut conn = connect_java_fe().expect("Java FE not running"); |
| 152 | + execute_query(&mut conn, "USE tpch").unwrap(); |
| 153 | + |
| 154 | + // SPEC: ORDER BY ASC |
| 155 | + println!("SPEC: SELECT l_orderkey FROM lineitem ORDER BY l_orderkey ASC"); |
| 156 | + let result = execute_select(&mut conn, |
| 157 | + "SELECT l_orderkey FROM lineitem ORDER BY l_orderkey ASC LIMIT 2").unwrap(); |
| 158 | + println!("✓ ORDER BY ASC: {}", result); |
| 159 | + |
| 160 | + // SPEC: ORDER BY DESC |
| 161 | + println!("\nSPEC: SELECT l_orderkey FROM lineitem ORDER BY l_orderkey DESC"); |
| 162 | + let result = execute_select(&mut conn, |
| 163 | + "SELECT l_orderkey FROM lineitem ORDER BY l_orderkey DESC LIMIT 2").unwrap(); |
| 164 | + println!("✓ ORDER BY DESC: {}", result); |
| 165 | + |
| 166 | + // SPEC: LIMIT without ORDER BY |
| 167 | + println!("\nSPEC: SELECT * FROM lineitem LIMIT 1"); |
| 168 | + let result = execute_select(&mut conn, "SELECT * FROM lineitem LIMIT 1").unwrap(); |
| 169 | + println!("✓ LIMIT: {}", result); |
| 170 | + |
| 171 | + println!("\n=== Specification Documented ===\n"); |
| 172 | +} |
| 173 | + |
| 174 | +/// Java FE Specification: WHERE clause filtering |
| 175 | +
|
| 176 | + |
| 177 | +fn spec_where_clause() { |
| 178 | + println!("\n=== Java FE Specification: WHERE Clause ===\n"); |
| 179 | + |
| 180 | + let mut conn = connect_java_fe().expect("Java FE not running"); |
| 181 | + execute_query(&mut conn, "USE tpch").unwrap(); |
| 182 | + |
| 183 | + // SPEC: Equality filter |
| 184 | + println!("SPEC: WHERE l_orderkey = 1"); |
| 185 | + let result = execute_select(&mut conn, |
| 186 | + "SELECT COUNT(*) FROM lineitem WHERE l_orderkey = 1").unwrap(); |
| 187 | + println!("✓ Equality: {}", result); |
| 188 | + |
| 189 | + // SPEC: Range filter |
| 190 | + println!("\nSPEC: WHERE l_quantity > 30"); |
| 191 | + let result = execute_select(&mut conn, |
| 192 | + "SELECT COUNT(*) FROM lineitem WHERE l_quantity > 30").unwrap(); |
| 193 | + println!("✓ Range: {}", result); |
| 194 | + |
| 195 | + // SPEC: Date filter |
| 196 | + println!("\nSPEC: WHERE l_shipdate <= '1998-12-01'"); |
| 197 | + let result = execute_select(&mut conn, |
| 198 | + "SELECT COUNT(*) FROM lineitem WHERE l_shipdate <= '1998-12-01'").unwrap(); |
| 199 | + println!("✓ Date filter: {}", result); |
| 200 | + |
| 201 | + // SPEC: String filter |
| 202 | + println!("\nSPEC: WHERE l_returnflag = 'N'"); |
| 203 | + let result = execute_select(&mut conn, |
| 204 | + "SELECT COUNT(*) FROM lineitem WHERE l_returnflag = 'N'").unwrap(); |
| 205 | + println!("✓ String filter: {}", result); |
| 206 | + |
| 207 | + println!("\n=== Specification Documented ===\n"); |
| 208 | +} |
| 209 | + |
| 210 | +/// Java FE Specification: TPC-H Query 1 (simplified) |
| 211 | +
|
| 212 | + |
| 213 | +fn spec_tpch_query_1() { |
| 214 | + println!("\n=== Java FE Specification: TPC-H Query 1 ===\n"); |
| 215 | + |
| 216 | + let mut conn = connect_java_fe().expect("Java FE not running"); |
| 217 | + execute_query(&mut conn, "USE tpch").unwrap(); |
| 218 | + |
| 219 | + let tpch_q1 = r#" |
| 220 | + SELECT |
| 221 | + l_returnflag, |
| 222 | + l_linestatus, |
| 223 | + COUNT(*) as count_order, |
| 224 | + SUM(l_quantity) as sum_qty, |
| 225 | + SUM(l_extendedprice) as sum_base_price, |
| 226 | + AVG(l_quantity) as avg_qty, |
| 227 | + AVG(l_extendedprice) as avg_price |
| 228 | + FROM lineitem |
| 229 | + WHERE l_shipdate <= '1998-12-01' |
| 230 | + GROUP BY l_returnflag, l_linestatus |
| 231 | + ORDER BY l_returnflag, l_linestatus |
| 232 | + "#; |
| 233 | + |
| 234 | + println!("SPEC: TPC-H Query 1 (Pricing Summary Report)"); |
| 235 | + println!("Query:\n{}", tpch_q1); |
| 236 | + |
| 237 | + let result = execute_select(&mut conn, tpch_q1).unwrap(); |
| 238 | + println!("✓ Result: {}", result); |
| 239 | + |
| 240 | + println!("\n=== TPC-H Q1 Specification Documented ===\n"); |
| 241 | +} |
| 242 | + |
| 243 | +// Helper functions |
| 244 | + |
| 245 | +fn connect_java_fe() -> Result<TcpStream, Box<dyn std::error::Error>> { |
| 246 | + let mut stream = TcpStream::connect("127.0.0.1:9030")?; |
| 247 | + |
| 248 | + // Handshake |
| 249 | + let (handshake, _) = read_packet_with_seq(&mut stream)?; |
| 250 | + let _ = parse_handshake(&handshake)?; |
| 251 | + |
| 252 | + // Authenticate |
| 253 | + let auth_packet = build_auth_packet("root", "")?; |
| 254 | + write_packet_with_seq(&mut stream, &auth_packet, 1)?; |
| 255 | + |
| 256 | + let (auth_response, _) = read_packet_with_seq(&mut stream)?; |
| 257 | + if auth_response[0] != 0x00 && auth_response[0] != 0xFE { |
| 258 | + return Err("Authentication failed".into()); |
| 259 | + } |
| 260 | + |
| 261 | + Ok(stream) |
| 262 | +} |
| 263 | + |
| 264 | +fn execute_query(stream: &mut TcpStream, query: &str) -> Result<(), Box<dyn std::error::Error>> { |
| 265 | + let query_packet = build_query_packet(query); |
| 266 | + write_packet_with_seq(stream, &query_packet, 0)?; |
| 267 | + |
| 268 | + let (response, _) = read_packet_with_seq(stream)?; |
| 269 | + |
| 270 | + match response[0] { |
| 271 | + 0x00 => Ok(()), |
| 272 | + 0xFF => { |
| 273 | + let error_msg = parse_error_packet(&response)?; |
| 274 | + Err(format!("Query failed: {}", error_msg).into()) |
| 275 | + } |
| 276 | + _ => { |
| 277 | + let _ = read_packet_with_seq(stream); |
| 278 | + Ok(()) |
| 279 | + } |
| 280 | + } |
| 281 | +} |
| 282 | + |
| 283 | +fn execute_select(stream: &mut TcpStream, query: &str) -> Result<String, Box<dyn std::error::Error>> { |
| 284 | + let query_packet = build_query_packet(query); |
| 285 | + write_packet_with_seq(stream, &query_packet, 0)?; |
| 286 | + |
| 287 | + let (response, _) = read_packet_with_seq(stream)?; |
| 288 | + |
| 289 | + match response[0] { |
| 290 | + 0xFF => { |
| 291 | + let error_msg = parse_error_packet(&response)?; |
| 292 | + Err(format!("Query failed: {}", error_msg).into()) |
| 293 | + } |
| 294 | + _ => { |
| 295 | + let mut row_count = 0; |
| 296 | + let mut total_bytes = response.len(); |
| 297 | + |
| 298 | + loop { |
| 299 | + match read_packet_with_seq(stream) { |
| 300 | + Ok((pkt, _)) => { |
| 301 | + if pkt.is_empty() || pkt[0] == 0xFE { |
| 302 | + break; |
| 303 | + } |
| 304 | + row_count += 1; |
| 305 | + total_bytes += pkt.len(); |
| 306 | + } |
| 307 | + Err(_) => break, |
| 308 | + } |
| 309 | + } |
| 310 | + |
| 311 | + Ok(format!("{} rows, {} bytes", row_count, total_bytes)) |
| 312 | + } |
| 313 | + } |
| 314 | +} |
| 315 | + |
| 316 | +fn read_packet_with_seq(stream: &mut TcpStream) -> Result<(Vec<u8>, u8), Box<dyn std::error::Error>> { |
| 317 | + let mut header = [0u8; 4]; |
| 318 | + stream.read_exact(&mut header)?; |
| 319 | + let payload_len = u32::from_le_bytes([header[0], header[1], header[2], 0]) as usize; |
| 320 | + let sequence = header[3]; |
| 321 | + let mut payload = vec![0u8; payload_len]; |
| 322 | + stream.read_exact(&mut payload)?; |
| 323 | + Ok((payload, sequence)) |
| 324 | +} |
| 325 | + |
| 326 | +fn write_packet_with_seq( |
| 327 | + stream: &mut TcpStream, |
| 328 | + payload: &[u8], |
| 329 | + sequence: u8, |
| 330 | +) -> Result<(), Box<dyn std::error::Error>> { |
| 331 | + let len = payload.len() as u32; |
| 332 | + let header = [ |
| 333 | + (len & 0xFF) as u8, |
| 334 | + ((len >> 8) & 0xFF) as u8, |
| 335 | + ((len >> 16) & 0xFF) as u8, |
| 336 | + sequence, |
| 337 | + ]; |
| 338 | + stream.write_all(&header)?; |
| 339 | + stream.write_all(payload)?; |
| 340 | + stream.flush()?; |
| 341 | + Ok(()) |
| 342 | +} |
| 343 | + |
| 344 | +fn parse_handshake(packet: &[u8]) -> Result<String, Box<dyn std::error::Error>> { |
| 345 | + let mut null_pos = 1; |
| 346 | + while null_pos < packet.len() && packet[null_pos] != 0 { |
| 347 | + null_pos += 1; |
| 348 | + } |
| 349 | + Ok(String::from_utf8_lossy(&packet[1..null_pos]).to_string()) |
| 350 | +} |
| 351 | + |
| 352 | +fn build_auth_packet(username: &str, _password: &str) -> Result<Vec<u8>, Box<dyn std::error::Error>> { |
| 353 | + let mut packet = Vec::new(); |
| 354 | + let capabilities: u32 = 0x0000_A285; |
| 355 | + packet.extend_from_slice(&capabilities.to_le_bytes()); |
| 356 | + packet.extend_from_slice(&0x0100_0000u32.to_le_bytes()); |
| 357 | + packet.push(0x21); |
| 358 | + packet.extend_from_slice(&[0u8; 23]); |
| 359 | + packet.extend_from_slice(username.as_bytes()); |
| 360 | + packet.push(0x00); |
| 361 | + packet.push(0x00); |
| 362 | + Ok(packet) |
| 363 | +} |
| 364 | + |
| 365 | +fn build_query_packet(query: &str) -> Vec<u8> { |
| 366 | + let mut packet = Vec::new(); |
| 367 | + packet.push(0x03); |
| 368 | + packet.extend_from_slice(query.as_bytes()); |
| 369 | + packet |
| 370 | +} |
| 371 | + |
| 372 | +fn parse_error_packet(packet: &[u8]) -> Result<String, Box<dyn std::error::Error>> { |
| 373 | + if packet.len() < 3 || packet[0] != 0xFF { |
| 374 | + return Ok("Unknown error".to_string()); |
| 375 | + } |
| 376 | + let msg_start = if packet.len() > 9 && packet[3] == b'#' { 9 } else { 3 }; |
| 377 | + Ok(String::from_utf8_lossy(&packet[msg_start..]).to_string()) |
| 378 | +} |
0 commit comments