reifydb-testing 0.4.12

Testing utilities and helpers for ReifyDB
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

// This file includes and modifies code from the toydb project (https://github.com/erikgrinaker/toydb),
// originally licensed under the Apache License, Version 2.0.
// Original copyright:
//   Copyright (c) 2024 Erik Grinaker
//
// The original Apache License can be found at:
//   http://www.apache.org/licenses/LICENSE-2.0

use std::{collections::HashSet, error, fmt};

use crate::testscript::command::{Argument, Block, Command};

#[derive(Debug, Clone)]
pub struct ParseError {
	pub message: String,
	pub line: u32,
	pub column: usize,
	pub input: LocatedSpan,
	pub code: String,
}

impl fmt::Display for ParseError {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		write!(f, "Parse error at line {}:{}: {}", self.line, self.column, self.message)
	}
}

impl error::Error for ParseError {}

#[derive(Debug, Clone)]
pub struct LocatedSpan {
	column: usize,
	line: u32,
	line_text: String,
}

impl LocatedSpan {
	fn new(_line_start: usize, column: usize, line: u32, line_text: String) -> Self {
		LocatedSpan {
			column,
			line,
			line_text,
		}
	}

	pub fn location_line(&self) -> u32 {
		self.line
	}

	pub fn get_column(&self) -> usize {
		self.column
	}

	pub fn get_utf8_column(&self) -> usize {
		self.column
	}

	pub fn get_line_beginning(&self) -> &[u8] {
		self.line_text.as_bytes()
	}
}

pub(crate) fn parse(input: &str) -> Result<Vec<Block>, ParseError> {
	let mut parser = Parser::new(input);
	parser.parse_blocks()
}

#[cfg(test)]
pub(crate) fn parse_command(input: &str) -> Result<Command, ParseError> {
	let mut parser = Parser::new(input);
	parser.parse_command()
}

struct Parser<'a> {
	input: &'a str,
	pos: usize,
	line: u32,
	column: usize,
	line_start_pos: usize,
}

impl<'a> Parser<'a> {
	fn new(input: &'a str) -> Self {
		Parser {
			input,
			pos: 0,
			line: 1,
			column: 1,
			line_start_pos: 0,
		}
	}

	fn current_char(&self) -> Option<char> {
		self.input[self.pos..].chars().next()
	}

	fn peek_char(&self) -> Option<char> {
		self.current_char()
	}

	fn peek_str(&self, n: usize) -> &str {
		// This function returns n bytes from current position
		// It's only used for checking ASCII patterns like "---" and
		// "//"
		let end = (self.pos + n).min(self.input.len());

		// Make sure we don't split a UTF-8 character
		let mut safe_end = end;
		while safe_end > self.pos && !self.input.is_char_boundary(safe_end) {
			safe_end -= 1;
		}

		&self.input[self.pos..safe_end]
	}

	fn advance(&mut self) -> Option<char> {
		if let Some(ch) = self.current_char() {
			self.pos += ch.len_utf8();
			if ch == '\n' {
				self.line += 1;
				self.column = 1;
				self.line_start_pos = self.pos;
			} else {
				self.column += 1;
			}
			Some(ch)
		} else {
			None
		}
	}

	fn skip_whitespace(&mut self) {
		while let Some(ch) = self.peek_char() {
			if ch.is_whitespace() && ch != '\n' {
				self.advance();
			} else {
				break;
			}
		}
	}

	fn skip_line(&mut self) {
		while let Some(ch) = self.peek_char() {
			if ch == '\n' {
				self.advance();
				break;
			}
			self.advance();
		}
	}

	fn is_at_end(&self) -> bool {
		self.pos >= self.input.len()
	}

	fn error(&self, message: impl Into<String>) -> ParseError {
		let line_end = self.input[self.line_start_pos..]
			.find('\n')
			.map(|i| self.line_start_pos + i)
			.unwrap_or(self.input.len());
		let line_text = &self.input[self.line_start_pos..line_end];

		ParseError {
			message: message.into(),
			line: self.line,
			column: self.column,
			input: LocatedSpan::new(self.line_start_pos, self.column, self.line, line_text.to_string()),
			code: format!("{:?}", line_text),
		}
	}

	fn parse_blocks(&mut self) -> Result<Vec<Block>, ParseError> {
		let mut blocks = Vec::new();

		while !self.is_at_end() {
			if let Some(block) = self.parse_block()? {
				blocks.push(block);
			}
		}

		Ok(blocks)
	}

	fn parse_block(&mut self) -> Result<Option<Block>, ParseError> {
		let line_number = self.line;
		let literal_start = self.pos;

		// Parse commands
		let commands = self.parse_commands()?;

		// Capture literal
		let literal_end = self.pos;
		let literal = self.input[literal_start..literal_end].to_string();

		// Handle empty block at EOF
		if self.is_at_end() && commands.is_empty() {
			return Ok(Some(Block {
				literal,
				commands,
				line_number,
			}));
		}

		// If no commands and not at EOF, this isn't a valid block
		if commands.is_empty() {
			return Ok(None);
		}

		// Parse separator
		if !self.parse_separator()? {
			return Err(self.error("Expected --- separator"));
		}

		// Parse and skip output
		self.parse_output()?;

		Ok(Some(Block {
			literal,
			commands,
			line_number,
		}))
	}

	fn parse_commands(&mut self) -> Result<Vec<Command>, ParseError> {
		let mut commands = Vec::new();

		loop {
			// Skip empty and comment lines
			if self.skip_empty_or_comment_line() {
				continue;
			}

			// Check for EOF
			if self.is_at_end() {
				break;
			}

			// Check for separator
			if self.peek_str(3) == "---" && !commands.is_empty() {
				break;
			}

			// Check for leading whitespace (not allowed for
			// commands)
			if let Some(ch) = self.peek_char()
				&& ch.is_whitespace() && ch != '\n'
			{
				return Err(self.error("Command cannot start with whitespace"));
			}

			// Parse command
			match self.parse_command() {
				Ok(cmd) => commands.push(cmd),
				Err(e) => {
					// If we hit a separator but have no
					// commands, let parse_command error
					if self.peek_str(3) == "---" && commands.is_empty() {
						return Err(e);
					}
					return Err(e);
				}
			}
		}

		Ok(commands)
	}

	fn parse_command(&mut self) -> Result<Command, ParseError> {
		let line_number = self.line;

		// Check for silencing (
		let silent = if self.peek_char() == Some('(') {
			self.advance();
			self.skip_whitespace();
			true
		} else {
			false
		};

		// Parse prefix and tags
		let mut tags = HashSet::new();
		let mut prefix = None;

		// Try to parse prefix (string followed by :)
		let saved_pos = self.pos;
		self.skip_whitespace();
		if let Ok(s) = self.parse_string() {
			self.skip_whitespace();
			if self.peek_char() == Some(':') {
				self.advance();
				self.skip_whitespace();
				prefix = Some(s);
			} else {
				// Backtrack
				self.pos = saved_pos;
			}
		}

		// Parse tags before command
		self.skip_whitespace();
		if let Some(parsed_tags) = self.parse_taglist()? {
			tags.extend(parsed_tags);
		}
		self.skip_whitespace();

		// Check for fail marker
		let fail = if self.peek_char() == Some('!') {
			self.advance();
			self.skip_whitespace();
			true
		} else {
			false
		};

		// Check for literal command (>)
		if self.peek_char() == Some('>') {
			self.advance();
			self.skip_whitespace();
			// Also support >! (fail marker after literal marker)
			let fail = if !fail && self.peek_char() == Some('!') {
				self.advance();
				self.skip_whitespace();
				true
			} else {
				fail
			};
			let name = self.parse_line_continuation()?;
			return Ok(Command {
				name,
				args: Vec::new(),
				tags,
				prefix,
				silent,
				fail,
				line_number,
			});
		}

		// Parse command name
		self.skip_whitespace();
		let name = self.parse_string().map_err(|_| self.error("Expected command name"))?;

		// Parse arguments
		let mut args = Vec::new();
		loop {
			self.skip_whitespace();
			if self.peek_char() == Some('[') {
				// Might be trailing tags
				if let Some(parsed_tags) = self.parse_taglist()? {
					tags.extend(parsed_tags);
					break;
				}
			}

			// Check for end of command
			if silent && self.peek_char() == Some(')') {
				break;
			}

			if self.peek_char() == Some('#') || self.peek_str(2) == "//" {
				break;
			}

			if self.peek_char() == Some('\n') || self.is_at_end() {
				break;
			}

			// Try to parse an argument
			let saved_pos = self.pos;
			let saved_line = self.line;
			let saved_column = self.column;
			let saved_line_start = self.line_start_pos;
			match self.parse_argument() {
				Ok(arg) => args.push(arg),
				Err(_) => {
					self.pos = saved_pos;
					self.line = saved_line;
					self.column = saved_column;
					self.line_start_pos = saved_line_start;
					break;
				}
			}
		}

		// Handle closing ) for silent commands
		if silent {
			self.skip_whitespace();
			if self.peek_char() != Some(')') {
				return Err(self.error("Expected closing ) for silent command"));
			}
			self.advance();
		}

		// Skip trailing whitespace and comments
		self.skip_whitespace();
		if self.peek_char() == Some('#') || self.peek_str(2) == "//" {
			self.skip_line();
		} else if self.peek_char() == Some('\n') {
			self.advance();
		} else if !self.is_at_end() {
			return Err(self.error("Expected end of line"));
		}

		Ok(Command {
			name,
			args,
			tags,
			prefix,
			silent,
			fail,
			line_number,
		})
	}

	fn parse_argument(&mut self) -> Result<Argument, ParseError> {
		// Try key=value format first
		let saved_pos = self.pos;
		let saved_line = self.line;
		let saved_column = self.column;
		let saved_line_start = self.line_start_pos;

		self.skip_whitespace();
		if let Ok(key) = self.parse_string() {
			if self.peek_char() == Some('=') {
				self.advance();
				// Allow empty value after =
				// First check if we have an empty value (next
				// is whitespace or another key)
				let value = if matches!(self.peek_char(), Some(ch) if ch.is_whitespace())
					|| matches!(self.peek_char(), Some('[' | ')' | '#'))
					|| self.peek_char().is_none() || self.peek_str(2) == "//"
				{
					// Empty value case
					String::new()
				} else {
					// Try to parse a value
					match self.parse_string() {
						Ok(v) => v,
						Err(_) => {
							// Check if this looks
							// like another
							// key=value pair
							// by looking for a
							// string followed by =
							let check_pos = self.pos;
							let check_line = self.line;
							let check_column = self.column;
							let check_line_start = self.line_start_pos;

							// Try to parse what
							// comes next as a
							// potential key
							if self.parse_string().is_ok() {
								if self.peek_char() == Some('=') {
									// This looks like another key=value, so current
									// value is empty
									self.pos = check_pos;
									self.line = check_line;
									self.column = check_column;
									self.line_start_pos = check_line_start;
									String::new()
								} else {
									// Not a key=value, this is an error
									self.pos = saved_pos;
									self.line = saved_line;
									self.column = saved_column;
									self.line_start_pos = saved_line_start;
									return Err(self.error(
										"Expected argument value after =",
									));
								}
							} else {
								// Can't parse
								// anything, this
								// is an error
								self.pos = saved_pos;
								self.line = saved_line;
								self.column = saved_column;
								self.line_start_pos = saved_line_start;
								return Err(
									self.error("Expected argument value after =")
								);
							}
						}
					}
				};
				return Ok(Argument {
					key: Some(key),
					value,
				});
			}
			// Just a value
			return Ok(Argument {
				key: None,
				value: key,
			});
		}

		self.pos = saved_pos;
		Err(self.error("Expected argument"))
	}

	fn parse_taglist(&mut self) -> Result<Option<HashSet<String>>, ParseError> {
		if self.peek_char() != Some('[') {
			return Ok(None);
		}

		self.advance();
		let mut tags = HashSet::new();

		loop {
			self.skip_whitespace();

			if self.peek_char() == Some(']') {
				// Empty tag list is an error
				if tags.is_empty() {
					return Err(self.error("Empty tag list"));
				}
				self.advance();
				break;
			}

			self.skip_whitespace();
			let tag = self.parse_string().map_err(|_| self.error("Expected tag name"))?;
			tags.insert(tag);

			self.skip_whitespace();
			if self.peek_char() == Some(',') {
				self.advance();
				self.skip_whitespace();
			} else if self.peek_char() == Some(' ') {
				self.skip_whitespace();
			}
		}

		Ok(Some(tags))
	}

	fn parse_string(&mut self) -> Result<String, ParseError> {
		// Note: Don't skip whitespace here - the caller should handle
		// that self.skip_whitespace();

		match self.peek_char() {
			Some('\'') => self.parse_quoted_string('\''),
			Some('"') => self.parse_quoted_string('"'),
			_ => self.parse_unquoted_string(),
		}
	}

	fn parse_unquoted_string(&mut self) -> Result<String, ParseError> {
		let mut result = String::new();

		// First character must be alphanumeric or _
		match self.peek_char() {
			Some(ch) if ch.is_alphanumeric() || ch == '_' => {
				result.push(ch);
				self.advance();
			}
			_ => return Err(self.error("Expected string")),
		}

		// Subsequent characters
		while let Some(ch) = self.peek_char() {
			if ch.is_alphanumeric() || "_-./@".contains(ch) {
				result.push(ch);
				self.advance();
			} else {
				break;
			}
		}

		Ok(result)
	}

	fn parse_quoted_string(&mut self, quote: char) -> Result<String, ParseError> {
		let mut result = String::new();

		// Skip opening quote
		if self.peek_char() != Some(quote) {
			return Err(self.error(format!("Expected {} quote", quote)));
		}
		self.advance();

		while let Some(ch) = self.peek_char() {
			if ch == quote {
				self.advance();
				return Ok(result);
			} else if ch == '\\' {
				self.advance();
				match self.peek_char() {
					Some('\'') => {
						result.push('\'');
						self.advance();
					}
					Some('"') => {
						result.push('"');
						self.advance();
					}
					Some('\\') => {
						result.push('\\');
						self.advance();
					}
					Some('0') => {
						result.push('\0');
						self.advance();
					}
					Some('n') => {
						result.push('\n');
						self.advance();
					}
					Some('r') => {
						result.push('\r');
						self.advance();
					}
					Some('t') => {
						result.push('\t');
						self.advance();
					}
					Some('x') => {
						self.advance();
						let hex = self.parse_hex_digits(2, 2)?;
						let byte = u8::from_str_radix(&hex, 16)
							.map_err(|_| self.error("Invalid hex escape"))?;
						result.push(char::from(byte));
					}
					Some('u') => {
						self.advance();
						if self.peek_char() != Some('{') {
							return Err(self.error("Expected { after \\u"));
						}
						self.advance();
						let hex = self.parse_hex_digits(1, 6)?;
						if self.peek_char() != Some('}') {
							return Err(self.error("Expected } after unicode escape"));
						}
						self.advance();
						let codepoint = u32::from_str_radix(&hex, 16)
							.map_err(|_| self.error("Invalid unicode escape"))?;
						let ch = char::from_u32(codepoint)
							.ok_or_else(|| self.error("Invalid unicode codepoint"))?;
						result.push(ch);
					}
					_ => {
						return Err(self.error("Invalid escape sequence"));
					}
				}
			} else {
				result.push(ch);
				self.advance();
			}
		}

		Err(self.error(format!("Unterminated string (missing {})", quote)))
	}

	fn parse_hex_digits(&mut self, min: usize, max: usize) -> Result<String, ParseError> {
		let mut hex = String::new();
		for i in 0..max {
			match self.peek_char() {
				Some(ch) if ch.is_ascii_hexdigit() => {
					hex.push(ch);
					self.advance();
				}
				_ => {
					if i < min {
						return Err(self.error(format!("Expected at least {} hex digits", min)));
					}
					break;
				}
			}
		}
		if hex.len() < min {
			return Err(self.error(format!("Expected at least {} hex digits", min)));
		}
		Ok(hex)
	}

	fn skip_empty_or_comment_line(&mut self) -> bool {
		let saved_pos = self.pos;

		self.skip_whitespace();

		// Check for comment
		if self.peek_char() == Some('#') || self.peek_str(2) == "//" {
			self.skip_line();
			return true;
		}

		// Check for empty line
		if self.peek_char() == Some('\n') {
			self.advance();
			return true;
		}

		// Not an empty or comment line, restore position
		self.pos = saved_pos;
		false
	}

	fn parse_separator(&mut self) -> Result<bool, ParseError> {
		if self.peek_str(3) != "---" {
			return Ok(false);
		}

		self.advance(); // -
		self.advance(); // -
		self.advance(); // -

		// Must be followed by newline (with optional \r) or EOF
		match self.peek_char() {
			Some('\r') => {
				self.advance();
				if self.peek_char() == Some('\n') {
					self.advance();
				}
				Ok(true)
			}
			Some('\n') => {
				self.advance();
				Ok(true)
			}
			None => Ok(true),
			_ => Err(self.error("Separator must be followed by newline or EOF")),
		}
	}

	fn parse_output(&mut self) -> Result<(), ParseError> {
		// Special case: no output (immediate newline or EOF)
		if self.peek_char() == Some('\n') || self.is_at_end() {
			if self.peek_char() == Some('\n') {
				self.advance();
			}
			return Ok(());
		}

		// Read until double newline or EOF
		let mut last_was_newline = false;
		while !self.is_at_end() {
			let ch = self.advance().unwrap();
			if ch == '\n' {
				if last_was_newline {
					break;
				}
				last_was_newline = true;
			} else {
				last_was_newline = false;
			}
		}

		Ok(())
	}

	fn parse_line_continuation(&mut self) -> Result<String, ParseError> {
		let mut result = String::new();

		loop {
			// Read until end of line
			while let Some(ch) = self.peek_char() {
				if ch == '\n' {
					break;
				}
				result.push(ch);
				self.advance();
			}

			// Check for continuation
			if result.ends_with('\\') {
				result.pop(); // Remove the backslash
				if self.peek_char() == Some('\n') {
					self.advance(); // Skip newline
					continue;
				}
			}

			// Skip the final newline
			if self.peek_char() == Some('\n') {
				self.advance();
			}

			break;
		}

		Ok(result)
	}
}