1use std::fmt::Write as FmtWrite;
4
5use crate::config::E2eConfig;
6use crate::escape::sanitize_filename;
7use crate::field_access::FieldResolver;
8use crate::fixture::{Fixture, FixtureGroup};
9
10use super::args::{emit_rust_visitor_method, render_rust_arg, resolve_visitor_trait};
11use super::assertions::render_assertion;
12use super::http::render_http_test_function;
13use super::mock_server::render_mock_server_setup;
14
15pub(super) fn resolve_function_name_for_call(call_config: &crate::config::CallConfig) -> String {
16 call_config
17 .overrides
18 .get("rust")
19 .and_then(|o| o.function.clone())
20 .unwrap_or_else(|| call_config.function.clone())
21}
22
23pub(super) fn resolve_module(e2e_config: &E2eConfig, dep_name: &str) -> String {
24 resolve_module_for_call(&e2e_config.call, dep_name)
25}
26
27pub(super) fn resolve_module_for_call(call_config: &crate::config::CallConfig, dep_name: &str) -> String {
28 let overrides = call_config.overrides.get("rust");
31 overrides
32 .and_then(|o| o.crate_name.clone())
33 .or_else(|| overrides.and_then(|o| o.module.clone()))
34 .unwrap_or_else(|| dep_name.to_string())
35}
36
37pub(super) fn is_skipped(fixture: &Fixture, language: &str) -> bool {
38 fixture.skip.as_ref().is_some_and(|s| s.should_skip(language))
39}
40
41pub fn render_test_file(
42 category: &str,
43 fixtures: &[&Fixture],
44 e2e_config: &E2eConfig,
45 dep_name: &str,
46 needs_mock_server: bool,
47) -> String {
48 let mut out = String::new();
49 out.push_str(&alef_core::hash::header(alef_core::hash::CommentStyle::DoubleSlash));
50 let _ = writeln!(out, "//! E2e tests for category: {category}");
51 let _ = writeln!(out);
52
53 let module = resolve_module(e2e_config, dep_name);
54 let field_resolver = FieldResolver::new(
55 &e2e_config.fields,
56 &e2e_config.fields_optional,
57 &e2e_config.result_fields,
58 &e2e_config.fields_array,
59 &e2e_config.fields_method_calls,
60 );
61
62 let file_has_http = fixtures.iter().any(|f| f.http.is_some());
64 let file_has_call_based = fixtures.iter().any(|f| {
67 if f.mock_response.is_some() {
68 return true;
69 }
70 if f.http.is_none() && f.mock_response.is_none() {
71 let call_config = e2e_config.resolve_call_for_fixture(f.call.as_deref(), &f.input);
72 let fn_name = resolve_function_name_for_call(call_config);
73 return !fn_name.is_empty();
74 }
75 false
76 });
77
78 let rust_call_override = e2e_config.call.overrides.get("rust");
83 let client_factory = rust_call_override.and_then(|o| o.client_factory.as_deref());
84
85 if file_has_call_based && client_factory.is_none() {
87 let mut imported: std::collections::BTreeSet<(String, String)> = std::collections::BTreeSet::new();
88 for fixture in fixtures.iter().filter(|f| {
89 if f.mock_response.is_some() {
90 return true;
91 }
92 if f.http.is_none() && f.mock_response.is_none() {
93 let call_config = e2e_config.resolve_call_for_fixture(f.call.as_deref(), &f.input);
94 let fn_name = resolve_function_name_for_call(call_config);
95 return !fn_name.is_empty();
96 }
97 false
98 }) {
99 let call_config = e2e_config.resolve_call_for_fixture(fixture.call.as_deref(), &fixture.input);
100 let fn_name = resolve_function_name_for_call(call_config);
101 let mod_name = resolve_module_for_call(call_config, dep_name);
102 imported.insert((mod_name, fn_name));
103 }
104 let mut by_module: std::collections::BTreeMap<String, Vec<String>> = std::collections::BTreeMap::new();
106 for (mod_name, fn_name) in &imported {
107 by_module.entry(mod_name.clone()).or_default().push(fn_name.clone());
108 }
109 for (mod_name, fns) in &by_module {
110 if fns.len() == 1 {
111 let _ = writeln!(out, "use {mod_name}::{};", fns[0]);
112 } else {
113 let joined = fns.join(", ");
114 let _ = writeln!(out, "use {mod_name}::{{{joined}}};");
115 }
116 }
117 }
118
119 if file_has_http {
121 let _ = writeln!(out, "use {module}::{{App, RequestContext}};");
122 }
123
124 let has_handle_args = e2e_config.call.args.iter().any(|a| a.arg_type == "handle");
126 if has_handle_args {
127 let _ = writeln!(out, "use {module}::CrawlConfig;");
128 }
129 for arg in &e2e_config.call.args {
130 if arg.arg_type == "handle" {
131 use heck::ToSnakeCase;
132 let constructor_name = format!("create_{}", arg.name.to_snake_case());
133 let _ = writeln!(out, "use {module}::{constructor_name};");
134 }
135 }
136
137 if client_factory.is_some() && file_has_call_based {
140 let trait_imports: Vec<String> = e2e_config
141 .call
142 .overrides
143 .get("rust")
144 .map(|o| o.trait_imports.clone())
145 .unwrap_or_default();
146 for trait_name in &trait_imports {
147 let _ = writeln!(out, "use {module}::{trait_name};");
148 }
149 }
150
151 let file_needs_mock = needs_mock_server && fixtures.iter().any(|f| f.mock_response.is_some());
153 if file_needs_mock {
154 let _ = writeln!(out, "mod mock_server;");
155 let _ = writeln!(out, "use mock_server::{{MockRoute, MockServer}};");
156 }
157
158 let file_needs_visitor = fixtures.iter().any(|f| f.visitor.is_some());
165 if file_needs_visitor {
166 let visitor_trait = resolve_visitor_trait(rust_call_override).unwrap_or_else(|| {
167 panic!(
168 "category '{}': fixture declares a visitor block but \
169 `[e2e.call.overrides.rust] visitor_trait` is not configured",
170 category
171 )
172 });
173 let _ = writeln!(
174 out,
175 "use {module}::visitor::{{{visitor_trait}, NodeContext, VisitResult}};"
176 );
177 }
178
179 if file_has_call_based {
184 let rust_options_type = e2e_config
185 .call
186 .overrides
187 .get("rust")
188 .and_then(|o| o.options_type.as_deref());
189 if let Some(opts_type) = rust_options_type {
190 let has_json_object_arg = e2e_config.call.args.iter().any(|a| a.arg_type == "json_object");
193 if has_json_object_arg {
194 let _ = writeln!(out, "use {module}::{opts_type};");
195 }
196 }
197 }
198
199 if file_has_call_based {
203 let mut element_types: std::collections::BTreeSet<String> = std::collections::BTreeSet::new();
204 for fixture in fixtures.iter().filter(|f| {
205 if f.mock_response.is_some() {
206 return true;
207 }
208 if f.http.is_none() && f.mock_response.is_none() {
209 let call_config = e2e_config.resolve_call_for_fixture(f.call.as_deref(), &f.input);
210 let fn_name = resolve_function_name_for_call(call_config);
211 return !fn_name.is_empty();
212 }
213 false
214 }) {
215 let call_config = e2e_config.resolve_call_for_fixture(fixture.call.as_deref(), &fixture.input);
216 for arg in &call_config.args {
217 if arg.arg_type == "json_object" {
218 if let Some(ref elem_type) = arg.element_type {
219 element_types.insert(elem_type.clone());
220 }
221 }
222 }
223 }
224 for elem_type in &element_types {
225 let _ = writeln!(out, "use {module}::{elem_type};");
226 }
227 }
228
229 let _ = writeln!(out);
230
231 for fixture in fixtures {
232 render_test_function(&mut out, fixture, e2e_config, dep_name, &field_resolver, client_factory);
233 let _ = writeln!(out);
234 }
235
236 if !out.ends_with('\n') {
237 out.push('\n');
238 }
239 out
240}
241
242pub fn render_test_function(
243 out: &mut String,
244 fixture: &Fixture,
245 e2e_config: &E2eConfig,
246 dep_name: &str,
247 field_resolver: &FieldResolver,
248 client_factory: Option<&str>,
249) {
250 if fixture.http.is_some() {
252 render_http_test_function(out, fixture, dep_name);
253 return;
254 }
255
256 if fixture.http.is_none() && fixture.mock_response.is_none() {
262 let call_config = e2e_config.resolve_call_for_fixture(fixture.call.as_deref(), &fixture.input);
263 let resolved_fn_name = resolve_function_name_for_call(call_config);
264 if resolved_fn_name.is_empty() {
265 let fn_name = crate::escape::sanitize_ident(&fixture.id);
266 let description = &fixture.description;
267 let _ = writeln!(out, "#[tokio::test]");
268 let _ = writeln!(out, "async fn test_{fn_name}() {{");
269 let _ = writeln!(out, " // {description}");
270 let _ = writeln!(
271 out,
272 " // TODO: implement when a callable API is available for this fixture type."
273 );
274 let _ = writeln!(out, "}}");
275 return;
276 }
277 }
279
280 let fn_name = crate::escape::sanitize_ident(&fixture.id);
281 let description = &fixture.description;
282 let call_config = e2e_config.resolve_call_for_fixture(fixture.call.as_deref(), &fixture.input);
283 let function_name = resolve_function_name_for_call(call_config);
284 let module = resolve_module_for_call(call_config, dep_name);
285 let result_var = &call_config.result_var;
286 let has_mock = fixture.mock_response.is_some();
287
288 let rust_overrides = call_config.overrides.get("rust");
290
291 let returns_result = rust_overrides
294 .and_then(|o| o.returns_result)
295 .unwrap_or(if client_factory.is_some() {
296 true
297 } else {
298 call_config.returns_result
299 });
300
301 let is_async = call_config.r#async || has_mock;
303 if is_async {
304 let _ = writeln!(out, "#[tokio::test]");
305 let _ = writeln!(out, "async fn test_{fn_name}() {{");
306 } else {
307 let _ = writeln!(out, "#[test]");
308 let _ = writeln!(out, "fn test_{fn_name}() {{");
309 }
310 let _ = writeln!(out, " // {description}");
311
312 if has_mock {
315 render_mock_server_setup(out, fixture, e2e_config);
316 }
317
318 let has_error_assertion = fixture.assertions.iter().any(|a| a.assertion_type == "error");
320
321 let wrap_options_in_some = rust_overrides.is_some_and(|o| o.wrap_options_in_some);
323 let extra_args: Vec<String> = rust_overrides.map(|o| o.extra_args.clone()).unwrap_or_default();
324 let options_type: Option<String> = rust_overrides.and_then(|o| o.options_type.clone());
328
329 let visitor_via_options = fixture.visitor.is_some() && rust_overrides.is_none_or(|o| o.visitor_function.is_none());
334
335 let mut arg_exprs: Vec<String> = Vec::new();
337 let mut options_arg_name: Option<String> = None;
339 for arg in &call_config.args {
340 let value = crate::codegen::resolve_field(&fixture.input, &arg.field);
341 let var_name = &arg.name;
342 let (mut bindings, expr) = render_rust_arg(
343 var_name,
344 value,
345 &arg.arg_type,
346 arg.optional,
347 &module,
348 &fixture.id,
349 if has_mock {
350 Some("mock_server.url.as_str()")
351 } else {
352 None
353 },
354 arg.owned,
355 arg.element_type.as_deref(),
356 &e2e_config.test_documents_dir,
357 );
358 if arg.arg_type == "json_object" {
362 if let Some(ref opts_type) = options_type {
363 bindings = bindings
364 .into_iter()
365 .map(|b| {
366 let prefix = format!("let {var_name} = ");
368 if b.starts_with(&prefix) {
369 format!("let {var_name}: {opts_type} = {}", &b[prefix.len()..])
370 } else {
371 b
372 }
373 })
374 .collect();
375 }
376 }
377 if visitor_via_options && arg.arg_type == "json_object" {
380 options_arg_name = Some(var_name.clone());
381 bindings = bindings
382 .into_iter()
383 .map(|b| {
384 let prefix = format!("let {var_name}");
386 if b.starts_with(&prefix) {
387 format!("let mut {}", &b[4..])
388 } else {
389 b
390 }
391 })
392 .collect();
393 }
394 for binding in &bindings {
395 let _ = writeln!(out, " {binding}");
396 }
397 let final_expr = if wrap_options_in_some && arg.arg_type == "json_object" {
401 if visitor_via_options {
402 let name = if let Some(rest) = expr.strip_prefix('&') {
405 rest.to_string()
406 } else {
407 expr.clone()
408 };
409 format!("Some({name})")
410 } else if let Some(rest) = expr.strip_prefix('&') {
411 format!("Some({rest}.clone())")
412 } else {
413 format!("Some({expr})")
414 }
415 } else {
416 expr
417 };
418 arg_exprs.push(final_expr);
419 }
420
421 if let Some(visitor_spec) = &fixture.visitor {
423 let visitor_trait = resolve_visitor_trait(rust_overrides)
426 .expect("visitor_trait must be set in [e2e.call.overrides.rust] when a fixture declares a visitor block");
427 let _ = writeln!(out, " #[derive(Debug)]");
429 let _ = writeln!(out, " struct _TestVisitor;");
430 let _ = writeln!(out, " impl {visitor_trait} for _TestVisitor {{");
431 for (method_name, action) in &visitor_spec.callbacks {
432 emit_rust_visitor_method(out, method_name, action);
433 }
434 let _ = writeln!(out, " }}");
435 let _ = writeln!(
436 out,
437 " let visitor = std::rc::Rc::new(std::cell::RefCell::new(_TestVisitor));"
438 );
439 if visitor_via_options {
440 let opts_name = options_arg_name.as_deref().unwrap_or("options");
442 let _ = writeln!(out, " {opts_name}.visitor = Some(visitor);");
443 } else {
444 arg_exprs.push("Some(visitor)".to_string());
446 }
447 } else {
448 arg_exprs.extend(extra_args);
451 }
452
453 let args_str = arg_exprs.join(", ");
454
455 let await_suffix = if is_async { ".await" } else { "" };
456
457 let call_expr = if let Some(factory) = client_factory {
461 let base_url_arg = if has_mock {
462 "Some(mock_server.url.clone())"
463 } else {
464 "None"
465 };
466 let _ = writeln!(
467 out,
468 " let client = {module}::{factory}(\"test-key\".to_string(), {base_url_arg}, None, None, None).unwrap();"
469 );
470 format!("client.{function_name}({args_str})")
471 } else {
472 format!("{function_name}({args_str})")
473 };
474
475 let result_is_tree = call_config.result_var == "tree";
476 let result_is_simple = call_config.result_is_simple || rust_overrides.is_some_and(|o| o.result_is_simple);
480 let result_is_vec = rust_overrides.is_some_and(|o| o.result_is_vec);
483 let result_is_option = call_config.result_is_option || rust_overrides.is_some_and(|o| o.result_is_option);
486
487 if has_error_assertion {
488 let _ = writeln!(out, " let {result_var} = {call_expr}{await_suffix};");
489 let has_non_error_assertions = fixture
491 .assertions
492 .iter()
493 .any(|a| !matches!(a.assertion_type.as_str(), "error" | "not_error"));
494 if returns_result && has_non_error_assertions {
497 let _ = writeln!(out, " let {result_var}_ok = {result_var}.as_ref().ok();");
499 }
500 for assertion in &fixture.assertions {
502 render_assertion(
503 out,
504 assertion,
505 result_var,
506 &module,
507 dep_name,
508 true,
509 &[],
510 field_resolver,
511 result_is_tree,
512 result_is_simple,
513 false,
514 false,
515 returns_result,
516 );
517 }
518 let _ = writeln!(out, "}}");
519 return;
520 }
521
522 let has_not_error = fixture.assertions.iter().any(|a| a.assertion_type == "not_error");
524
525 let has_usable_assertion = fixture.assertions.iter().any(|a| {
529 if a.assertion_type == "not_error" || a.assertion_type == "error" {
530 return false;
531 }
532 if a.assertion_type == "method_result" {
533 let supported_checks = [
536 "equals",
537 "is_true",
538 "is_false",
539 "greater_than_or_equal",
540 "count_min",
541 "is_error",
542 "contains",
543 "not_empty",
544 "is_empty",
545 ];
546 let check = a.check.as_deref().unwrap_or("is_true");
547 if a.method.is_none() || !supported_checks.contains(&check) {
548 return false;
549 }
550 }
551 match &a.field {
552 Some(f) if !f.is_empty() => field_resolver.is_valid_for_result(f),
553 _ => true,
554 }
555 });
556
557 let result_binding = if has_usable_assertion {
558 result_var.to_string()
559 } else {
560 "_".to_string()
561 };
562
563 let has_field_access = fixture
567 .assertions
568 .iter()
569 .any(|a| a.field.as_ref().is_some_and(|f| !f.is_empty()));
570 let only_emptiness_checks = !has_field_access
571 && fixture.assertions.iter().all(|a| {
572 matches!(
573 a.assertion_type.as_str(),
574 "is_empty" | "is_false" | "not_empty" | "is_true" | "not_error"
575 )
576 });
577
578 let unwrap_suffix = if returns_result {
579 ".expect(\"should succeed\")"
580 } else {
581 ""
582 };
583 if !returns_result || (only_emptiness_checks && !has_not_error) {
584 let _ = writeln!(out, " let {result_binding} = {call_expr}{await_suffix};");
587 } else if has_not_error || !fixture.assertions.is_empty() {
588 let _ = writeln!(
589 out,
590 " let {result_binding} = {call_expr}{await_suffix}{unwrap_suffix};"
591 );
592 } else {
593 let _ = writeln!(out, " let {result_binding} = {call_expr}{await_suffix};");
594 }
595
596 let string_assertion_types = [
602 "equals",
603 "contains",
604 "contains_all",
605 "contains_any",
606 "not_contains",
607 "starts_with",
608 "ends_with",
609 "min_length",
610 "max_length",
611 "matches_regex",
612 ];
613 let mut unwrapped_fields: Vec<(String, String)> = Vec::new(); if !result_is_vec {
615 for assertion in &fixture.assertions {
616 if let Some(f) = &assertion.field {
617 if !f.is_empty()
618 && string_assertion_types.contains(&assertion.assertion_type.as_str())
619 && !unwrapped_fields.iter().any(|(ff, _)| ff == f)
620 {
621 let is_string_assertion = assertion.value.as_ref().is_none_or(|v| v.is_string());
624 if !is_string_assertion {
625 continue;
626 }
627 if let Some((binding, local_var)) = field_resolver.rust_unwrap_binding(f, result_var) {
628 let _ = writeln!(out, " {binding}");
629 unwrapped_fields.push((f.clone(), local_var));
630 }
631 }
632 }
633 }
634 }
635
636 for assertion in &fixture.assertions {
638 if assertion.assertion_type == "not_error" {
639 continue;
641 }
642 render_assertion(
643 out,
644 assertion,
645 result_var,
646 &module,
647 dep_name,
648 false,
649 &unwrapped_fields,
650 field_resolver,
651 result_is_tree,
652 result_is_simple,
653 result_is_vec,
654 result_is_option,
655 returns_result,
656 );
657 }
658
659 let _ = writeln!(out, "}}");
660}
661
662pub fn collect_test_filenames(groups: &[FixtureGroup]) -> Vec<String> {
664 groups
665 .iter()
666 .filter(|g| !g.fixtures.is_empty())
667 .map(|g| format!("{}_test.rs", sanitize_filename(&g.category)))
668 .collect()
669}
670
671#[cfg(test)]
672mod tests {
673 use super::*;
674
675 #[test]
676 fn resolve_module_for_call_prefers_crate_name_override() {
677 use crate::config::CallConfig;
678 use std::collections::HashMap;
679 let mut overrides = HashMap::new();
680 overrides.insert(
681 "rust".to_string(),
682 crate::config::CallOverride {
683 crate_name: Some("custom_crate".to_string()),
684 module: Some("ignored_module".to_string()),
685 ..Default::default()
686 },
687 );
688 let call = CallConfig {
689 overrides,
690 ..Default::default()
691 };
692 let result = resolve_module_for_call(&call, "dep_name");
693 assert_eq!(result, "custom_crate");
694 }
695}