1use crate::config::E2eConfig;
8use crate::escape::{escape_php, sanitize_filename};
9use crate::field_access::{FieldResolver, PhpGetterMap};
10use crate::fixture::{
11 Assertion, CallbackAction, Fixture, FixtureGroup, HttpFixture, TemplateReturnForm, ValidationErrorExpectation,
12};
13use alef_backend_php::naming::php_autoload_namespace;
14use alef_core::backend::GeneratedFile;
15use alef_core::config::ResolvedCrateConfig;
16use alef_core::hash::{self, CommentStyle};
17use alef_core::ir::TypeRef;
18use alef_core::template_versions as tv;
19use anyhow::Result;
20use heck::{ToLowerCamelCase, ToSnakeCase, ToUpperCamelCase};
21use std::collections::{HashMap, HashSet};
22use std::fmt::Write as FmtWrite;
23use std::path::PathBuf;
24
25use super::E2eCodegen;
26use super::client;
27
28pub struct PhpCodegen;
30
31impl E2eCodegen for PhpCodegen {
32 fn generate(
33 &self,
34 groups: &[FixtureGroup],
35 e2e_config: &E2eConfig,
36 config: &ResolvedCrateConfig,
37 type_defs: &[alef_core::ir::TypeDef],
38 enums: &[alef_core::ir::EnumDef],
39 ) -> Result<Vec<GeneratedFile>> {
40 let lang = self.language_name();
41 let output_base = PathBuf::from(e2e_config.effective_output()).join(lang);
42
43 let mut files = Vec::new();
44
45 let call = &e2e_config.call;
49 let overrides = call.overrides.get(lang);
50 let extension_name = config.php_extension_name();
51 let class_name = overrides
52 .and_then(|o| o.class.as_ref())
53 .cloned()
54 .map(|cn| cn.split('\\').next_back().unwrap_or(&cn).to_string())
55 .unwrap_or_else(|| extension_name.to_upper_camel_case());
56 let namespace = overrides.and_then(|o| o.module.as_ref()).cloned().unwrap_or_else(|| {
57 if extension_name.contains('_') {
58 extension_name
59 .split('_')
60 .map(|p| p.to_upper_camel_case())
61 .collect::<Vec<_>>()
62 .join("\\")
63 } else {
64 extension_name.to_upper_camel_case()
65 }
66 });
67 let empty_enum_fields = HashMap::new();
68 let enum_fields = overrides.map(|o| &o.enum_fields).unwrap_or(&empty_enum_fields);
69 let result_is_simple = overrides.is_some_and(|o| o.result_is_simple);
70 let php_client_factory = overrides.and_then(|o| o.php_client_factory.as_deref());
71 let options_via = overrides.and_then(|o| o.options_via.as_deref()).unwrap_or("array");
72
73 let php_pkg = e2e_config.resolve_package("php");
75 let pkg_name = php_pkg
76 .as_ref()
77 .and_then(|p| p.name.as_ref())
78 .cloned()
79 .unwrap_or_else(|| {
80 let org = config
83 .try_github_repo()
84 .ok()
85 .as_deref()
86 .and_then(alef_core::config::derive_repo_org)
87 .unwrap_or_else(|| config.name.clone());
88 format!("{org}/{}", call.module.replace('_', "-"))
89 });
90 let pkg_path = php_pkg
91 .as_ref()
92 .and_then(|p| p.path.as_ref())
93 .cloned()
94 .unwrap_or_else(|| "../../packages/php".to_string());
95 let pkg_version = php_pkg
96 .as_ref()
97 .and_then(|p| p.version.as_ref())
98 .cloned()
99 .or_else(|| config.resolved_version())
100 .unwrap_or_else(|| "0.1.0".to_string());
101
102 let e2e_vendor = pkg_name.split('/').next().unwrap_or(&pkg_name).to_string();
107 let e2e_pkg_name = format!("{e2e_vendor}/e2e-php");
108 let php_namespace_escaped = php_autoload_namespace(config).replace('\\', "\\\\");
113 let e2e_autoload_ns = format!("{php_namespace_escaped}\\\\E2e\\\\");
114
115 files.push(GeneratedFile {
117 path: output_base.join("composer.json"),
118 content: render_composer_json(
119 &e2e_pkg_name,
120 &e2e_autoload_ns,
121 &pkg_name,
122 &pkg_path,
123 &pkg_version,
124 e2e_config.dep_mode,
125 ),
126 generated_header: false,
127 });
128
129 files.push(GeneratedFile {
131 path: output_base.join("phpunit.xml"),
132 content: render_phpunit_xml(),
133 generated_header: false,
134 });
135
136 let has_http_fixtures = groups
139 .iter()
140 .flat_map(|g| g.fixtures.iter())
141 .any(|f| f.needs_mock_server());
142
143 let has_file_fixtures = groups.iter().flat_map(|g| g.fixtures.iter()).any(|f| {
145 let cc = e2e_config.resolve_call_for_fixture(
146 f.call.as_deref(),
147 &f.id,
148 &f.resolved_category(),
149 &f.tags,
150 &f.input,
151 );
152 cc.args
153 .iter()
154 .any(|a| a.arg_type == "file_path" || a.arg_type == "bytes")
155 });
156
157 files.push(GeneratedFile {
159 path: output_base.join("bootstrap.php"),
160 content: render_bootstrap(
161 &pkg_path,
162 has_http_fixtures,
163 has_file_fixtures,
164 &e2e_config.test_documents_relative_from(0),
165 ),
166 generated_header: true,
167 });
168
169 files.push(GeneratedFile {
171 path: output_base.join("run_tests.php"),
172 content: render_run_tests_php(&extension_name, config.php_cargo_crate_name()),
173 generated_header: true,
174 });
175
176 let tests_base = output_base.join("tests");
178
179 let php_enum_names: HashSet<String> = enums.iter().map(|e| e.name.clone()).collect();
193
194 for group in groups {
195 let active: Vec<&Fixture> = group
196 .fixtures
197 .iter()
198 .filter(|f| super::should_include_fixture(f, lang, e2e_config))
199 .collect();
200
201 if active.is_empty() {
202 continue;
203 }
204
205 let test_class = format!("{}Test", sanitize_filename(&group.category).to_upper_camel_case());
206 let filename = format!("{test_class}.php");
207 let content = render_test_file(
208 &group.category,
209 &active,
210 e2e_config,
211 lang,
212 &namespace,
213 &class_name,
214 &test_class,
215 type_defs,
216 &php_enum_names,
217 enum_fields,
218 result_is_simple,
219 php_client_factory,
220 options_via,
221 &config.adapters,
222 );
223 files.push(GeneratedFile {
224 path: tests_base.join(filename),
225 content,
226 generated_header: true,
227 });
228 }
229
230 Ok(files)
231 }
232
233 fn language_name(&self) -> &'static str {
234 "php"
235 }
236}
237
238fn build_php_getter_map(
264 type_defs: &[alef_core::ir::TypeDef],
265 enum_names: &HashSet<String>,
266 call: &alef_core::config::e2e::CallConfig,
267 result_fields: &HashSet<String>,
268) -> PhpGetterMap {
269 let mut getters: HashMap<String, HashSet<String>> = HashMap::new();
270 let mut field_types: HashMap<String, HashMap<String, String>> = HashMap::new();
271 let mut all_fields: HashMap<String, HashSet<String>> = HashMap::new();
272 for td in type_defs {
273 let mut getter_fields: HashSet<String> = HashSet::new();
274 let mut field_type_map: HashMap<String, String> = HashMap::new();
275 let mut td_all_fields: HashSet<String> = HashSet::new();
276 for f in &td.fields {
277 td_all_fields.insert(f.name.clone());
278 if !is_php_scalar(&f.ty, enum_names) {
279 getter_fields.insert(f.name.clone());
280 }
281 if let Some(named) = inner_named(&f.ty) {
282 field_type_map.insert(f.name.clone(), named);
283 }
284 }
285 getters.insert(td.name.clone(), getter_fields);
286 all_fields.insert(td.name.clone(), td_all_fields);
287 if !field_type_map.is_empty() {
288 field_types.insert(td.name.clone(), field_type_map);
289 }
290 }
291 let root_type = derive_root_type(call, type_defs, result_fields);
292 PhpGetterMap {
293 getters,
294 field_types,
295 root_type,
296 all_fields,
297 }
298}
299
300fn inner_named(ty: &TypeRef) -> Option<String> {
303 match ty {
304 TypeRef::Named(n) => Some(n.clone()),
305 TypeRef::Optional(inner) | TypeRef::Vec(inner) => inner_named(inner),
306 _ => None,
307 }
308}
309
310fn derive_root_type(
321 call: &alef_core::config::e2e::CallConfig,
322 type_defs: &[alef_core::ir::TypeDef],
323 result_fields: &HashSet<String>,
324) -> Option<String> {
325 const LOOKUP_LANGS: &[&str] = &["php", "c", "csharp", "java", "kotlin", "go"];
326 for lang in LOOKUP_LANGS {
327 if let Some(o) = call.overrides.get(*lang)
328 && let Some(rt) = o.result_type.as_deref()
329 && !rt.is_empty()
330 && type_defs.iter().any(|td| td.name == rt)
331 {
332 return Some(rt.to_string());
333 }
334 }
335 if result_fields.is_empty() {
336 return None;
337 }
338 let matches: Vec<&alef_core::ir::TypeDef> = type_defs
339 .iter()
340 .filter(|td| {
341 let names: HashSet<&str> = td.fields.iter().map(|f| f.name.as_str()).collect();
342 result_fields.iter().all(|rf| names.contains(rf.as_str()))
343 })
344 .collect();
345 if matches.len() == 1 {
346 return Some(matches[0].name.clone());
347 }
348 None
349}
350
351fn is_php_scalar(ty: &TypeRef, enum_names: &HashSet<String>) -> bool {
352 match ty {
353 TypeRef::Primitive(_) | TypeRef::String | TypeRef::Char | TypeRef::Duration | TypeRef::Path => true,
354 TypeRef::Optional(inner) => is_php_scalar(inner, enum_names),
355 TypeRef::Vec(inner) => {
356 matches!(inner.as_ref(), TypeRef::Primitive(_) | TypeRef::String | TypeRef::Char)
357 || matches!(inner.as_ref(), TypeRef::Named(n) if enum_names.contains(n))
358 }
359 TypeRef::Named(n) if enum_names.contains(n) => true,
360 TypeRef::Named(_) | TypeRef::Map(_, _) | TypeRef::Json | TypeRef::Bytes | TypeRef::Unit => false,
361 }
362}
363
364fn render_composer_json(
369 e2e_pkg_name: &str,
370 e2e_autoload_ns: &str,
371 pkg_name: &str,
372 pkg_path: &str,
373 pkg_version: &str,
374 dep_mode: crate::config::DependencyMode,
375) -> String {
376 let (require_section, autoload_section) = match dep_mode {
377 crate::config::DependencyMode::Registry => {
378 let require = format!(
379 r#" "require": {{
380 "{pkg_name}": "{pkg_version}"
381 }},
382 "require-dev": {{
383 "phpunit/phpunit": "{phpunit}",
384 "guzzlehttp/guzzle": "{guzzle}"
385 }},"#,
386 phpunit = tv::packagist::PHPUNIT,
387 guzzle = tv::packagist::GUZZLE,
388 );
389 (require, String::new())
390 }
391 crate::config::DependencyMode::Local => {
392 let require = format!(
393 r#" "require-dev": {{
394 "phpunit/phpunit": "{phpunit}",
395 "guzzlehttp/guzzle": "{guzzle}"
396 }},"#,
397 phpunit = tv::packagist::PHPUNIT,
398 guzzle = tv::packagist::GUZZLE,
399 );
400 let pkg_namespace = pkg_name
403 .split('/')
404 .nth(1)
405 .unwrap_or(pkg_name)
406 .split('-')
407 .map(heck::ToUpperCamelCase::to_upper_camel_case)
408 .collect::<Vec<_>>()
409 .join("\\");
410 let autoload = format!(
411 r#"
412 "autoload": {{
413 "psr-4": {{
414 "{}\\": "{}/src/"
415 }}
416 }},"#,
417 pkg_namespace.replace('\\', "\\\\"),
418 pkg_path
419 );
420 (require, autoload)
421 }
422 };
423
424 crate::template_env::render(
425 "php/composer.json.jinja",
426 minijinja::context! {
427 e2e_pkg_name => e2e_pkg_name,
428 e2e_autoload_ns => e2e_autoload_ns,
429 require_section => require_section,
430 autoload_section => autoload_section,
431 },
432 )
433}
434
435fn render_phpunit_xml() -> String {
436 crate::template_env::render("php/phpunit.xml.jinja", minijinja::context! {})
437}
438
439fn render_bootstrap(
440 pkg_path: &str,
441 has_http_fixtures: bool,
442 has_file_fixtures: bool,
443 test_documents_path: &str,
444) -> String {
445 let header = hash::header(CommentStyle::DoubleSlash);
446 crate::template_env::render(
447 "php/bootstrap.php.jinja",
448 minijinja::context! {
449 header => header,
450 pkg_path => pkg_path,
451 has_http_fixtures => has_http_fixtures,
452 has_file_fixtures => has_file_fixtures,
453 test_documents_path => test_documents_path,
454 },
455 )
456}
457
458fn render_run_tests_php(extension_name: &str, cargo_crate_name: Option<&str>) -> String {
459 let header = hash::header(CommentStyle::DoubleSlash);
460 let ext_lib_name = if let Some(crate_name) = cargo_crate_name {
461 format!("lib{}", crate_name.replace('-', "_"))
464 } else {
465 format!("lib{extension_name}_php")
466 };
467 format!(
468 r#"#!/usr/bin/env php
469<?php
470{header}
471declare(strict_types=1);
472
473// Determine platform-specific extension suffix.
474$extSuffix = match (PHP_OS_FAMILY) {{
475 'Darwin' => '.dylib',
476 default => '.so',
477}};
478$extPath = __DIR__ . '/../../target/release/{ext_lib_name}' . $extSuffix;
479
480// If the locally-built extension exists and we have not already restarted with it,
481// re-exec PHP with no system ini (-n) to avoid conflicts with any system-installed
482// version of the extension, then load the local build explicitly.
483if (file_exists($extPath) && !getenv('ALEF_PHP_LOCAL_EXT_LOADED')) {{
484 putenv('ALEF_PHP_LOCAL_EXT_LOADED=1');
485 $php = PHP_BINARY;
486 $phpunitPath = __DIR__ . '/vendor/bin/phpunit';
487
488 $cmd = array_merge(
489 [$php, '-n', '-d', 'extension=' . $extPath],
490 [$phpunitPath],
491 array_slice($GLOBALS['argv'], 1)
492 );
493
494 passthru(implode(' ', array_map('escapeshellarg', $cmd)), $exitCode);
495 exit($exitCode);
496}}
497
498// Extension is now loaded (via the restart above with -n flag).
499// Invoke PHPUnit normally.
500$phpunitPath = __DIR__ . '/vendor/bin/phpunit';
501if (!file_exists($phpunitPath)) {{
502 echo "PHPUnit not found at $phpunitPath. Run 'composer install' first.\n";
503 exit(1);
504}}
505
506require $phpunitPath;
507"#
508 )
509}
510
511#[allow(clippy::too_many_arguments)]
512fn render_test_file(
513 category: &str,
514 fixtures: &[&Fixture],
515 e2e_config: &E2eConfig,
516 lang: &str,
517 namespace: &str,
518 class_name: &str,
519 test_class: &str,
520 type_defs: &[alef_core::ir::TypeDef],
521 php_enum_names: &HashSet<String>,
522 enum_fields: &HashMap<String, String>,
523 result_is_simple: bool,
524 php_client_factory: Option<&str>,
525 options_via: &str,
526 adapters: &[alef_core::config::extras::AdapterConfig],
527) -> String {
528 let header = hash::header(CommentStyle::DoubleSlash);
529
530 let needs_crawl_config_import = fixtures.iter().any(|f| {
532 let call =
533 e2e_config.resolve_call_for_fixture(f.call.as_deref(), &f.id, &f.resolved_category(), &f.tags, &f.input);
534 call.args.iter().filter(|a| a.arg_type == "handle").any(|a| {
535 let v = f.input.get(&a.field).unwrap_or(&serde_json::Value::Null);
536 !(v.is_null() || v.is_object() && v.as_object().is_some_and(|o| o.is_empty()))
537 })
538 });
539
540 let has_http_tests = fixtures.iter().any(|f| f.is_http_test());
542
543 let mut options_type_imports: Vec<String> = fixtures
545 .iter()
546 .flat_map(|f| {
547 let call = e2e_config.resolve_call_for_fixture(
548 f.call.as_deref(),
549 &f.id,
550 &f.resolved_category(),
551 &f.tags,
552 &f.input,
553 );
554 let php_override = call.overrides.get(lang);
555 let opt_type = php_override.and_then(|o| o.options_type.as_deref()).or_else(|| {
556 e2e_config
557 .call
558 .overrides
559 .get(lang)
560 .and_then(|o| o.options_type.as_deref())
561 });
562 let element_types: Vec<String> = call
563 .args
564 .iter()
565 .filter_map(|a| a.element_type.as_ref().map(|t| t.to_string()))
566 .filter(|t| !is_php_reserved_type(t))
567 .collect();
568 opt_type.map(|t| t.to_string()).into_iter().chain(element_types)
569 })
570 .collect::<std::collections::HashSet<_>>()
571 .into_iter()
572 .collect();
573 options_type_imports.sort();
574
575 let mut imports_use: Vec<String> = Vec::new();
577 if needs_crawl_config_import {
578 imports_use.push(format!("use {namespace}\\CrawlConfig;"));
579 }
580 for type_name in &options_type_imports {
581 if type_name != class_name {
582 imports_use.push(format!("use {namespace}\\{type_name};"));
583 }
584 }
585
586 let mut fixtures_body = String::new();
588 for (i, fixture) in fixtures.iter().enumerate() {
589 if fixture.is_http_test() {
590 render_http_test_method(&mut fixtures_body, fixture, fixture.http.as_ref().unwrap());
591 } else {
592 render_test_method(
593 &mut fixtures_body,
594 fixture,
595 e2e_config,
596 lang,
597 namespace,
598 class_name,
599 type_defs,
600 php_enum_names,
601 enum_fields,
602 result_is_simple,
603 php_client_factory,
604 options_via,
605 adapters,
606 );
607 }
608 if i + 1 < fixtures.len() {
609 fixtures_body.push('\n');
610 }
611 }
612
613 crate::template_env::render(
614 "php/test_file.jinja",
615 minijinja::context! {
616 header => header,
617 namespace => namespace,
618 class_name => class_name,
619 test_class => test_class,
620 category => category,
621 imports_use => imports_use,
622 has_http_tests => has_http_tests,
623 fixtures_body => fixtures_body,
624 },
625 )
626}
627
628struct PhpTestClientRenderer;
636
637impl client::TestClientRenderer for PhpTestClientRenderer {
638 fn language_name(&self) -> &'static str {
639 "php"
640 }
641
642 fn sanitize_test_name(&self, id: &str) -> String {
644 sanitize_filename(id)
645 }
646
647 fn render_test_open(&self, out: &mut String, fn_name: &str, description: &str, skip_reason: Option<&str>) {
653 let escaped_reason = skip_reason.map(escape_php);
654 let rendered = crate::template_env::render(
655 "php/http_test_open.jinja",
656 minijinja::context! {
657 fn_name => fn_name,
658 description => description,
659 skip_reason => escaped_reason,
660 },
661 );
662 out.push_str(&rendered);
663 }
664
665 fn render_test_close(&self, out: &mut String) {
667 let rendered = crate::template_env::render("php/http_test_close.jinja", minijinja::context! {});
668 out.push_str(&rendered);
669 }
670
671 fn render_call(&self, out: &mut String, ctx: &client::CallCtx<'_>) {
676 let method = ctx.method.to_uppercase();
677
678 let mut opts: Vec<String> = Vec::new();
680
681 if let Some(body) = ctx.body {
682 let php_body = json_to_php(body);
683 opts.push(format!("'json' => {php_body}"));
684 }
685
686 let mut header_pairs: Vec<String> = Vec::new();
688 if let Some(ct) = ctx.content_type {
689 if !ctx.headers.keys().any(|k| k.to_lowercase() == "content-type") {
691 header_pairs.push(format!("\"Content-Type\" => \"{}\"", escape_php(ct)));
692 }
693 }
694 for (k, v) in ctx.headers {
695 header_pairs.push(format!("\"{}\" => \"{}\"", escape_php(k), escape_php(v)));
696 }
697 if !header_pairs.is_empty() {
698 opts.push(format!("'headers' => [{}]", header_pairs.join(", ")));
699 }
700
701 if !ctx.cookies.is_empty() {
702 let cookie_str = ctx
703 .cookies
704 .iter()
705 .map(|(k, v)| format!("{}={}", k, v))
706 .collect::<Vec<_>>()
707 .join("; ");
708 opts.push(format!("'headers' => ['Cookie' => \"{}\"]", escape_php(&cookie_str)));
709 }
710
711 if !ctx.query_params.is_empty() {
712 let pairs: Vec<String> = ctx
713 .query_params
714 .iter()
715 .map(|(k, v)| {
716 let val_str = match v {
717 serde_json::Value::String(s) => s.clone(),
718 other => other.to_string(),
719 };
720 format!("\"{}\" => \"{}\"", escape_php(k), escape_php(&val_str))
721 })
722 .collect();
723 opts.push(format!("'query' => [{}]", pairs.join(", ")));
724 }
725
726 let path_lit = format!("\"{}\"", escape_php(ctx.path));
727
728 let rendered = crate::template_env::render(
729 "php/http_request.jinja",
730 minijinja::context! {
731 method => method,
732 path => path_lit,
733 opts => opts,
734 response_var => ctx.response_var,
735 },
736 );
737 out.push_str(&rendered);
738 }
739
740 fn render_assert_status(&self, out: &mut String, _response_var: &str, status: u16) {
742 let rendered = crate::template_env::render(
743 "php/http_assertions.jinja",
744 minijinja::context! {
745 response_var => "",
746 status_code => status,
747 headers => Vec::<std::collections::HashMap<&str, String>>::new(),
748 body_assertion => String::new(),
749 partial_body => Vec::<std::collections::HashMap<&str, String>>::new(),
750 validation_errors => Vec::<std::collections::HashMap<&str, String>>::new(),
751 },
752 );
753 out.push_str(&rendered);
754 }
755
756 fn render_assert_header(&self, out: &mut String, _response_var: &str, name: &str, expected: &str) {
761 let header_key = name.to_lowercase();
762 let header_key_lit = format!("\"{}\"", escape_php(&header_key));
763 let assertion_code = match expected {
764 "<<present>>" => {
765 format!("$this->assertTrue($response->hasHeader({header_key_lit}));")
766 }
767 "<<absent>>" => {
768 format!("$this->assertFalse($response->hasHeader({header_key_lit}));")
769 }
770 "<<uuid>>" => {
771 format!(
772 "$this->assertMatchesRegularExpression('/^[0-9a-f]{{8}}-[0-9a-f]{{4}}-[0-9a-f]{{4}}-[0-9a-f]{{4}}-[0-9a-f]{{12}}$/i', $response->getHeaderLine({header_key_lit}));"
773 )
774 }
775 literal => {
776 let val_lit = format!("\"{}\"", escape_php(literal));
777 format!("$this->assertEquals({val_lit}, $response->getHeaderLine({header_key_lit}));")
778 }
779 };
780
781 let mut headers = vec![std::collections::HashMap::new()];
782 headers[0].insert("assertion_code", assertion_code);
783
784 let rendered = crate::template_env::render(
785 "php/http_assertions.jinja",
786 minijinja::context! {
787 response_var => "",
788 status_code => 0u16,
789 headers => headers,
790 body_assertion => String::new(),
791 partial_body => Vec::<std::collections::HashMap<&str, String>>::new(),
792 validation_errors => Vec::<std::collections::HashMap<&str, String>>::new(),
793 },
794 );
795 out.push_str(&rendered);
796 }
797
798 fn render_assert_json_body(&self, out: &mut String, _response_var: &str, expected: &serde_json::Value) {
804 let body_assertion = match expected {
805 serde_json::Value::String(s) if !s.is_empty() => {
806 let php_val = format!("\"{}\"", escape_php(s));
807 format!("$this->assertEquals({php_val}, (string) $response->getBody());")
808 }
809 _ => {
810 let php_val = json_to_php(expected);
811 format!(
812 "$body = json_decode((string) $response->getBody(), true, 512, JSON_THROW_ON_ERROR);\n $this->assertEquals({php_val}, $body);"
813 )
814 }
815 };
816
817 let rendered = crate::template_env::render(
818 "php/http_assertions.jinja",
819 minijinja::context! {
820 response_var => "",
821 status_code => 0u16,
822 headers => Vec::<std::collections::HashMap<&str, String>>::new(),
823 body_assertion => body_assertion,
824 partial_body => Vec::<std::collections::HashMap<&str, String>>::new(),
825 validation_errors => Vec::<std::collections::HashMap<&str, String>>::new(),
826 },
827 );
828 out.push_str(&rendered);
829 }
830
831 fn render_assert_partial_body(&self, out: &mut String, _response_var: &str, expected: &serde_json::Value) {
833 if let Some(obj) = expected.as_object() {
834 let mut partial_body: Vec<std::collections::HashMap<&str, String>> = Vec::new();
835 for (key, val) in obj {
836 let php_key = format!("\"{}\"", escape_php(key));
837 let php_val = json_to_php(val);
838 let assertion_code = format!("$this->assertEquals({php_val}, $body[{php_key}]);");
839 let mut entry = std::collections::HashMap::new();
840 entry.insert("assertion_code", assertion_code);
841 partial_body.push(entry);
842 }
843
844 let rendered = crate::template_env::render(
845 "php/http_assertions.jinja",
846 minijinja::context! {
847 response_var => "",
848 status_code => 0u16,
849 headers => Vec::<std::collections::HashMap<&str, String>>::new(),
850 body_assertion => String::new(),
851 partial_body => partial_body,
852 validation_errors => Vec::<std::collections::HashMap<&str, String>>::new(),
853 },
854 );
855 out.push_str(&rendered);
856 }
857 }
858
859 fn render_assert_validation_errors(
862 &self,
863 out: &mut String,
864 _response_var: &str,
865 errors: &[ValidationErrorExpectation],
866 ) {
867 let mut validation_errors: Vec<std::collections::HashMap<&str, String>> = Vec::new();
868 for err in errors {
869 let msg_lit = format!("\"{}\"", escape_php(&err.msg));
870 let assertion_code =
871 format!("$this->assertStringContainsString({msg_lit}, json_encode($body, JSON_UNESCAPED_SLASHES));");
872 let mut entry = std::collections::HashMap::new();
873 entry.insert("assertion_code", assertion_code);
874 validation_errors.push(entry);
875 }
876
877 let rendered = crate::template_env::render(
878 "php/http_assertions.jinja",
879 minijinja::context! {
880 response_var => "",
881 status_code => 0u16,
882 headers => Vec::<std::collections::HashMap<&str, String>>::new(),
883 body_assertion => String::new(),
884 partial_body => Vec::<std::collections::HashMap<&str, String>>::new(),
885 validation_errors => validation_errors,
886 },
887 );
888 out.push_str(&rendered);
889 }
890}
891
892fn render_http_test_method(out: &mut String, fixture: &Fixture, http: &HttpFixture) {
897 if http.expected_response.status_code == 101 {
901 let method_name = sanitize_filename(&fixture.id);
902 let description = &fixture.description;
903 out.push_str(&crate::template_env::render(
904 "php/http_test_skip_101.jinja",
905 minijinja::context! {
906 method_name => method_name,
907 description => description,
908 },
909 ));
910 return;
911 }
912
913 client::http_call::render_http_test(out, &PhpTestClientRenderer, fixture);
914}
915
916#[allow(clippy::too_many_arguments)]
921fn render_test_method(
922 out: &mut String,
923 fixture: &Fixture,
924 e2e_config: &E2eConfig,
925 lang: &str,
926 namespace: &str,
927 class_name: &str,
928 type_defs: &[alef_core::ir::TypeDef],
929 php_enum_names: &HashSet<String>,
930 enum_fields: &HashMap<String, String>,
931 result_is_simple: bool,
932 php_client_factory: Option<&str>,
933 options_via: &str,
934 adapters: &[alef_core::config::extras::AdapterConfig],
935) {
936 let mut call_config = e2e_config.resolve_call_for_fixture(
938 fixture.call.as_deref(),
939 &fixture.id,
940 &fixture.resolved_category(),
941 &fixture.tags,
942 &fixture.input,
943 );
944 call_config = super::select_best_matching_call(call_config, e2e_config, fixture);
947 let per_call_getter_map = build_php_getter_map(
949 type_defs,
950 php_enum_names,
951 call_config,
952 e2e_config.effective_result_fields(call_config),
953 );
954 let call_field_resolver = FieldResolver::new_with_php_getters(
955 e2e_config.effective_fields(call_config),
956 e2e_config.effective_fields_optional(call_config),
957 e2e_config.effective_result_fields(call_config),
958 e2e_config.effective_fields_array(call_config),
959 &HashSet::new(),
960 &HashMap::new(),
961 per_call_getter_map,
962 );
963 let field_resolver = &call_field_resolver;
964 let call_overrides = call_config.overrides.get(lang);
965 let has_override = call_overrides.is_some_and(|o| o.function.is_some());
966 let result_is_simple = call_overrides.is_some_and(|o| o.result_is_simple) || result_is_simple;
970 let mut function_name = call_overrides
971 .and_then(|o| o.function.as_ref())
972 .cloned()
973 .unwrap_or_else(|| call_config.function.clone());
974 if !has_override {
979 function_name = function_name.to_lower_camel_case();
980 }
981 let result_var = &call_config.result_var;
982 let args = &call_config.args;
983
984 let method_name = sanitize_filename(&fixture.id);
985 let description = &fixture.description;
986 let expects_error = fixture.assertions.iter().any(|a| a.assertion_type == "error");
987
988 let call_options_type = call_overrides.and_then(|o| o.options_type.as_deref()).or_else(|| {
990 e2e_config
991 .call
992 .overrides
993 .get(lang)
994 .and_then(|o| o.options_type.as_deref())
995 });
996
997 let adapter_request_type: Option<String> = adapters
998 .iter()
999 .find(|a| a.name == call_config.function.as_str())
1000 .and_then(|a| a.request_type.as_deref())
1001 .map(|rt| rt.rsplit("::").next().unwrap_or(rt).to_string());
1002 let (mut setup_lines, args_str) = build_args_and_setup(
1003 &fixture.input,
1004 args,
1005 class_name,
1006 enum_fields,
1007 fixture,
1008 options_via,
1009 call_options_type,
1010 adapter_request_type.as_deref(),
1011 );
1012
1013 let skip_test = call_config.skip_languages.iter().any(|l| l == "php");
1015 if skip_test {
1016 let rendered = crate::template_env::render(
1017 "php/test_method.jinja",
1018 minijinja::context! {
1019 method_name => method_name,
1020 description => description,
1021 client_factory => String::new(),
1022 setup_lines => Vec::<String>::new(),
1023 expects_error => false,
1024 skip_test => true,
1025 has_usable_assertions => false,
1026 call_expr => String::new(),
1027 result_var => result_var,
1028 assertions_body => String::new(),
1029 },
1030 );
1031 out.push_str(&rendered);
1032 return;
1033 }
1034
1035 let mut options_already_created = !args_str.is_empty() && args_str == "$options";
1037 if let Some(visitor_spec) = &fixture.visitor {
1038 build_php_visitor(&mut setup_lines, visitor_spec);
1039 if !options_already_created {
1040 let options_type = call_options_type.unwrap_or("ConversionOptions");
1041 if options_via == "from_json" {
1042 setup_lines.push(format!("$options = \\{namespace}\\{options_type}::from_json('{{}}');"));
1045 setup_lines.push(format!(
1046 "$visitorHandle = \\{namespace}\\VisitorHandle::from_php_object($visitor);"
1047 ));
1048 setup_lines.push("$options = $options->withVisitor($visitorHandle);".to_string());
1051 } else {
1052 setup_lines.push(format!("$builder = \\{namespace}\\{options_type}::builder();"));
1054 setup_lines.push("$options = $builder->visitor($visitor)->build();".to_string());
1055 }
1056 options_already_created = true;
1057 }
1058 }
1059
1060 let final_args = if options_already_created {
1061 if args_str.is_empty() || args_str == "$options" {
1062 "$options".to_string()
1063 } else {
1064 format!("{args_str}, $options")
1065 }
1066 } else {
1067 args_str
1068 };
1069
1070 let call_expr = if php_client_factory.is_some() {
1071 format!("$client->{function_name}({final_args})")
1072 } else {
1073 format!("{class_name}::{function_name}({final_args})")
1074 };
1075
1076 let has_mock = fixture.mock_response.is_some() || fixture.http.is_some();
1077 let api_key_var = fixture.env.as_ref().and_then(|e| e.api_key_var.as_deref());
1078 let client_factory = if let Some(factory) = php_client_factory {
1079 let fixture_id = &fixture.id;
1080 if let Some(var) = api_key_var.filter(|_| has_mock) {
1081 format!(
1082 "$apiKey = getenv('{var}');\n $baseUrl = ($apiKey !== false && $apiKey !== '') ? null : getenv('MOCK_SERVER_URL') . '/fixtures/{fixture_id}';\n fwrite(STDERR, \"{fixture_id}: \" . ($baseUrl === null ? 'using real API ({var} is set)' : 'using mock server ({var} not set)') . \"\\n\");\n $client = \\{namespace}\\{class_name}::{factory}($baseUrl === null ? $apiKey : 'test-key', $baseUrl);"
1083 )
1084 } else if has_mock {
1085 let base_url_expr = if fixture.has_host_root_route() {
1086 let env_key = format!("MOCK_SERVER_{}", fixture_id.to_uppercase());
1087 format!("(getenv('{env_key}') ?: getenv('MOCK_SERVER_URL') . '/fixtures/{fixture_id}')")
1088 } else {
1089 format!("getenv('MOCK_SERVER_URL') . '/fixtures/{fixture_id}'")
1090 };
1091 format!("$client = \\{namespace}\\{class_name}::{factory}('test-key', {base_url_expr});")
1092 } else if let Some(var) = api_key_var {
1093 format!(
1094 "$apiKey = getenv('{var}');\n if (!$apiKey) {{ $this->markTestSkipped('{var} not set'); return; }}\n $client = \\{namespace}\\{class_name}::{factory}($apiKey);"
1095 )
1096 } else {
1097 format!("$client = \\{namespace}\\{class_name}::{factory}('test-key');")
1098 }
1099 } else {
1100 String::new()
1101 };
1102
1103 let is_streaming = crate::codegen::streaming_assertions::resolve_is_streaming(fixture, call_config.streaming);
1105
1106 let has_usable_assertions = fixture.assertions.iter().any(|a| {
1109 if a.assertion_type == "error" || a.assertion_type == "not_error" {
1110 return false;
1111 }
1112 match &a.field {
1113 Some(f) if !f.is_empty() => {
1114 if is_streaming && crate::codegen::streaming_assertions::is_streaming_virtual_field(f) {
1115 return true;
1116 }
1117 field_resolver.is_valid_for_result(f)
1118 }
1119 _ => true,
1120 }
1121 });
1122
1123 let collect_snippet = if is_streaming {
1125 crate::codegen::streaming_assertions::StreamingFieldResolver::collect_snippet("php", result_var, "chunks")
1126 .unwrap_or_default()
1127 } else {
1128 String::new()
1129 };
1130
1131 let mut fields_array_bindings: std::collections::BTreeMap<String, (String, String)> =
1141 std::collections::BTreeMap::new();
1142 for assertion in &fixture.assertions {
1143 if let Some(f) = &assertion.field {
1144 if !f.is_empty() && field_resolver.is_array(f) {
1145 if !fields_array_bindings.contains_key(f.as_str()) {
1147 let accessor = field_resolver.accessor(f, "php", &format!("${result_var}"));
1148 let var_name = f.to_lower_camel_case();
1149 fields_array_bindings.insert(f.clone(), (var_name, accessor));
1150 }
1151 }
1152 }
1153 }
1154
1155 let mut field_bindings = String::new();
1162 for (var_name, accessor) in fields_array_bindings.values() {
1163 field_bindings.push_str(&format!(" ${} = {};\n", var_name, accessor));
1164 }
1165
1166 let mut assertions_body = String::new();
1168 for assertion in &fixture.assertions {
1169 render_assertion(
1170 &mut assertions_body,
1171 assertion,
1172 result_var,
1173 field_resolver,
1174 result_is_simple,
1175 call_config.result_is_array,
1176 &fields_array_bindings,
1177 );
1178 }
1179
1180 if is_streaming && !expects_error && assertions_body.trim().is_empty() {
1186 assertions_body.push_str(" $this->assertTrue(is_array($chunks), 'expected drained chunks list');\n");
1187 }
1188
1189 let rendered = crate::template_env::render(
1190 "php/test_method.jinja",
1191 minijinja::context! {
1192 method_name => method_name,
1193 description => description,
1194 client_factory => client_factory,
1195 setup_lines => setup_lines,
1196 expects_error => expects_error,
1197 skip_test => fixture.assertions.is_empty(),
1198 has_usable_assertions => has_usable_assertions || is_streaming,
1199 call_expr => call_expr,
1200 result_var => result_var,
1201 collect_snippet => collect_snippet,
1202 field_bindings => field_bindings,
1203 assertions_body => assertions_body,
1204 },
1205 );
1206 out.push_str(&rendered);
1207}
1208
1209fn emit_php_batch_item_array(arr: &serde_json::Value, elem_type: &str) -> String {
1222 if let Some(items) = arr.as_array() {
1223 let item_strs: Vec<String> = items
1224 .iter()
1225 .filter_map(|item| {
1226 if let Some(obj) = item.as_object() {
1227 match elem_type {
1228 "BatchBytesItem" => {
1229 let content = obj.get("content").and_then(|v| v.as_array());
1230 let mime_type = obj.get("mime_type").and_then(|v| v.as_str()).unwrap_or("text/plain");
1231 let content_code = if let Some(arr) = content {
1232 let bytes: Vec<String> = arr
1233 .iter()
1234 .filter_map(|v| v.as_u64())
1235 .map(|n| format!("\\x{:02x}", n))
1236 .collect();
1237 format!("\"{}\"", bytes.join(""))
1238 } else {
1239 "\"\"".to_string()
1240 };
1241 Some(format!(
1242 "new {}(content: {}, mimeType: \"{}\")",
1243 elem_type, content_code, mime_type
1244 ))
1245 }
1246 "BatchFileItem" => {
1247 let path = obj.get("path").and_then(|v| v.as_str()).unwrap_or("");
1248 Some(format!("new {}(path: \"{}\")", elem_type, path))
1249 }
1250 _ => {
1251 Some(json_to_php(&serde_json::Value::Object(obj.clone())))
1254 }
1255 }
1256 } else {
1257 None
1258 }
1259 })
1260 .collect();
1261 format!("[{}]", item_strs.join(", "))
1262 } else {
1263 "[]".to_string()
1264 }
1265}
1266
1267#[allow(clippy::too_many_arguments)]
1268fn build_args_and_setup(
1269 input: &serde_json::Value,
1270 args: &[crate::config::ArgMapping],
1271 class_name: &str,
1272 _enum_fields: &HashMap<String, String>,
1273 fixture: &crate::fixture::Fixture,
1274 options_via: &str,
1275 options_type: Option<&str>,
1276 adapter_request_type: Option<&str>,
1277) -> (Vec<String>, String) {
1278 let fixture_id = &fixture.id;
1279 if args.is_empty() {
1280 let is_empty_input = match input {
1283 serde_json::Value::Null => true,
1284 serde_json::Value::Object(m) => m.is_empty(),
1285 _ => false,
1286 };
1287 if is_empty_input {
1288 return (Vec::new(), String::new());
1289 }
1290 return (Vec::new(), json_to_php(input));
1291 }
1292
1293 let mut setup_lines: Vec<String> = Vec::new();
1294 let mut parts: Vec<String> = Vec::new();
1295
1296 let arg_has_emission = |arg: &crate::config::ArgMapping| -> bool {
1301 let val = if arg.field == "input" {
1302 Some(input)
1303 } else {
1304 let field = arg.field.strip_prefix("input.").unwrap_or(&arg.field);
1305 input.get(field)
1306 };
1307 match val {
1308 None | Some(serde_json::Value::Null) => !arg.optional,
1309 Some(_) => true,
1310 }
1311 };
1312 let any_later_has_emission = |from_idx: usize| -> bool { args[from_idx..].iter().any(arg_has_emission) };
1313
1314 for (idx, arg) in args.iter().enumerate() {
1315 if arg.arg_type == "mock_url" {
1316 if fixture.has_host_root_route() {
1317 let env_key = format!("MOCK_SERVER_{}", fixture_id.to_uppercase());
1318 setup_lines.push(format!(
1319 "${} = getenv('{env_key}') ?: getenv('MOCK_SERVER_URL') . '/fixtures/{fixture_id}';",
1320 arg.name,
1321 ));
1322 } else {
1323 setup_lines.push(format!(
1324 "${} = getenv('MOCK_SERVER_URL') . '/fixtures/{fixture_id}';",
1325 arg.name,
1326 ));
1327 }
1328 if let Some(req_type) = adapter_request_type {
1329 let req_var = format!("${}_req", arg.name);
1330 setup_lines.push(format!("{req_var} = new {req_type}(${});", arg.name));
1331 parts.push(req_var);
1332 } else {
1333 parts.push(format!("${}", arg.name));
1334 }
1335 continue;
1336 }
1337
1338 if arg.arg_type == "mock_url_list" {
1339 let env_key = format!("MOCK_SERVER_{}", fixture_id.to_uppercase());
1344 let field = arg.field.strip_prefix("input.").unwrap_or(&arg.field);
1345 let val = if let Some(v) = input.get(field).filter(|v| !v.is_null()) {
1347 v.clone()
1348 } else {
1349 super::resolve_urls_field(input, &arg.field).clone()
1350 };
1351 let paths: Vec<String> = if let Some(arr) = val.as_array() {
1352 arr.iter()
1353 .filter_map(|v| v.as_str().map(|s| format!("\"{}\"", escape_php(s))))
1354 .collect()
1355 } else {
1356 Vec::new()
1357 };
1358 let paths_literal = paths.join(", ");
1359 let name = &arg.name;
1360 setup_lines.push(format!(
1361 "${name}_base = getenv('{env_key}') ?: getenv('MOCK_SERVER_URL') . '/fixtures/{fixture_id}';"
1362 ));
1363 setup_lines.push(format!(
1364 "${name} = array_map(fn($p) => str_starts_with($p, 'http') ? $p : ${name}_base . $p, [{paths_literal}]);"
1365 ));
1366 parts.push(format!("${name}"));
1367 continue;
1368 }
1369
1370 if arg.arg_type == "handle" {
1371 let constructor_name = format!("create{}", arg.name.to_upper_camel_case());
1373 let config_value = if arg.field == "input" {
1374 input
1375 } else {
1376 let field = arg.field.strip_prefix("input.").unwrap_or(&arg.field);
1377 input.get(field).unwrap_or(&serde_json::Value::Null)
1378 };
1379 if config_value.is_null()
1380 || config_value.is_object() && config_value.as_object().is_some_and(|o| o.is_empty())
1381 {
1382 setup_lines.push(format!("${} = {class_name}::{constructor_name}(null);", arg.name,));
1383 } else {
1384 let name = &arg.name;
1385 let filtered_config = filter_empty_enum_strings(config_value);
1390 setup_lines.push(format!(
1391 "${name}_config = CrawlConfig::from_json(json_encode({}));",
1392 json_to_php_camel_keys(&filtered_config)
1393 ));
1394 setup_lines.push(format!(
1395 "${} = {class_name}::{constructor_name}(${name}_config);",
1396 arg.name,
1397 ));
1398 }
1399 parts.push(format!("${}", arg.name));
1400 continue;
1401 }
1402
1403 let val = if arg.field == "input" {
1404 Some(input)
1405 } else {
1406 let field = arg.field.strip_prefix("input.").unwrap_or(&arg.field);
1407 input.get(field)
1408 };
1409
1410 if arg.arg_type == "bytes" {
1414 match val {
1415 None | Some(serde_json::Value::Null) => {
1416 if arg.optional {
1417 parts.push("null".to_string());
1418 } else {
1419 parts.push("\"\"".to_string());
1420 }
1421 }
1422 Some(serde_json::Value::String(s)) => {
1423 let var_name = format!("{}Bytes", arg.name);
1424 setup_lines.push(format!(
1425 "${var_name} = file_get_contents(\"{path}\");\n if (${var_name} === false) {{ $this->fail(\"failed to read fixture: {path}\"); }}",
1426 path = s.replace('"', "\\\"")
1427 ));
1428 parts.push(format!("${var_name}"));
1429 }
1430 Some(serde_json::Value::Array(arr)) => {
1431 let bytes: String = arr
1432 .iter()
1433 .filter_map(|v| v.as_u64())
1434 .map(|n| format!("\\x{:02x}", n))
1435 .collect();
1436 parts.push(format!("\"{bytes}\""));
1437 }
1438 Some(other) => {
1439 parts.push(json_to_php(other));
1440 }
1441 }
1442 continue;
1443 }
1444
1445 match val {
1446 None | Some(serde_json::Value::Null) if arg.arg_type == "json_object" && arg.name == "config" => {
1447 let type_name = if let Some(opt_type) = options_type {
1454 opt_type.to_string()
1455 } else if arg.name == "config" {
1456 "ExtractionConfig".to_string()
1457 } else {
1458 format!("{}Config", arg.name.to_upper_camel_case())
1459 };
1460 parts.push(format!("{type_name}::from_json('{{}}')"));
1461 continue;
1462 }
1463 None | Some(serde_json::Value::Null) if arg.optional => {
1464 if any_later_has_emission(idx + 1) {
1469 parts.push("null".to_string());
1470 }
1471 continue;
1472 }
1473 None | Some(serde_json::Value::Null) => {
1474 let default_val = match arg.arg_type.as_str() {
1476 "string" => "\"\"".to_string(),
1477 "int" | "integer" => "0".to_string(),
1478 "float" | "number" => "0.0".to_string(),
1479 "bool" | "boolean" => "false".to_string(),
1480 "json_object" if options_via == "json" => "null".to_string(),
1481 _ => "null".to_string(),
1482 };
1483 parts.push(default_val);
1484 }
1485 Some(v) => {
1486 if arg.arg_type == "json_object" && !v.is_null() {
1487 if let Some(elem_type) = &arg.element_type {
1489 if v.is_array() {
1490 if elem_type == "BatchBytesItem" || elem_type == "BatchFileItem" {
1491 parts.push(emit_php_batch_item_array(v, elem_type));
1492 continue;
1493 }
1494 if is_php_reserved_type(elem_type) {
1498 parts.push(json_to_php(v));
1499 continue;
1500 }
1501 if let Some(arr) = v.as_array() {
1503 let items: Vec<String> = arr
1504 .iter()
1505 .filter_map(|item| {
1506 item.as_object()
1507 .map(|obj| json_to_php(&serde_json::Value::Object(obj.clone())))
1508 })
1509 .collect();
1510 parts.push(format!("[{}]", items.join(", ")));
1511 continue;
1512 }
1513 }
1514 }
1515 match options_via {
1516 "json" => {
1517 let filtered_v = filter_empty_enum_strings(v);
1520
1521 if let serde_json::Value::Object(obj) = &filtered_v {
1523 if obj.is_empty() {
1524 parts.push("null".to_string());
1525 continue;
1526 }
1527 }
1528
1529 parts.push(format!("json_encode({})", json_to_php_camel_keys(&filtered_v)));
1530 continue;
1531 }
1532 _ => {
1533 if let Some(type_name) = options_type {
1534 let filtered_v = filter_empty_enum_strings(v);
1539
1540 if let serde_json::Value::Object(obj) = &filtered_v {
1543 if obj.is_empty() {
1544 let arg_var = format!("${}", arg.name);
1545 setup_lines.push(format!("{arg_var} = {type_name}::from_json('{{}}');"));
1546 parts.push(arg_var);
1547 continue;
1548 }
1549 }
1550
1551 let arg_var = format!("${}", arg.name);
1552 setup_lines.push(format!(
1556 "{arg_var} = {type_name}::from_json(json_encode({}));",
1557 json_to_php_camel_keys(&filtered_v)
1558 ));
1559 parts.push(arg_var);
1560 continue;
1561 }
1562 if let Some(obj) = v.as_object() {
1566 setup_lines.push("$builder = $this->createDefaultOptionsBuilder();".to_string());
1567 for (k, vv) in obj {
1568 let snake_key = k.to_snake_case();
1569 if snake_key == "preprocessing" {
1570 if let Some(prep_obj) = vv.as_object() {
1571 let enabled =
1572 prep_obj.get("enabled").and_then(|v| v.as_bool()).unwrap_or(true);
1573 let preset =
1574 prep_obj.get("preset").and_then(|v| v.as_str()).unwrap_or("Minimal");
1575 let remove_navigation = prep_obj
1576 .get("remove_navigation")
1577 .and_then(|v| v.as_bool())
1578 .unwrap_or(true);
1579 let remove_forms =
1580 prep_obj.get("remove_forms").and_then(|v| v.as_bool()).unwrap_or(true);
1581 setup_lines.push(format!(
1582 "$preprocessing = $this->createPreprocessingOptions({}, {}, {}, {});",
1583 if enabled { "true" } else { "false" },
1584 json_to_php(&serde_json::Value::String(preset.to_string())),
1585 if remove_navigation { "true" } else { "false" },
1586 if remove_forms { "true" } else { "false" }
1587 ));
1588 setup_lines.push(
1589 "$builder = $builder->preprocessing($preprocessing);".to_string(),
1590 );
1591 }
1592 }
1593 }
1594 setup_lines.push("$options = $builder->build();".to_string());
1595 parts.push("$options".to_string());
1596 continue;
1597 }
1598 }
1599 }
1600 }
1601 parts.push(json_to_php(v));
1602 }
1603 }
1604 }
1605
1606 (setup_lines, parts.join(", "))
1607}
1608
1609fn render_assertion(
1610 out: &mut String,
1611 assertion: &Assertion,
1612 result_var: &str,
1613 field_resolver: &FieldResolver,
1614 result_is_simple: bool,
1615 result_is_array: bool,
1616 fields_array_bindings: &std::collections::BTreeMap<String, (String, String)>,
1617) {
1618 if let Some(f) = &assertion.field {
1621 match f.as_str() {
1622 "chunks_have_content" => {
1623 let pred = format!(
1624 "array_reduce(${result_var}->chunks ?? [], fn($carry, $c) => $carry && !empty($c->content), true)"
1625 );
1626 out.push_str(&crate::template_env::render(
1627 "php/synthetic_assertion.jinja",
1628 minijinja::context! {
1629 assertion_kind => "chunks_content",
1630 assertion_type => assertion.assertion_type.as_str(),
1631 pred => pred,
1632 field_name => f,
1633 },
1634 ));
1635 return;
1636 }
1637 "chunks_have_embeddings" => {
1638 let pred = format!(
1639 "array_reduce(${result_var}->chunks ?? [], fn($carry, $c) => $carry && !empty($c->embedding), true)"
1640 );
1641 out.push_str(&crate::template_env::render(
1642 "php/synthetic_assertion.jinja",
1643 minijinja::context! {
1644 assertion_kind => "chunks_embeddings",
1645 assertion_type => assertion.assertion_type.as_str(),
1646 pred => pred,
1647 field_name => f,
1648 },
1649 ));
1650 return;
1651 }
1652 "embeddings" => {
1656 let php_val = assertion.value.as_ref().map(json_to_php).unwrap_or_default();
1657 out.push_str(&crate::template_env::render(
1658 "php/synthetic_assertion.jinja",
1659 minijinja::context! {
1660 assertion_kind => "embeddings",
1661 assertion_type => assertion.assertion_type.as_str(),
1662 php_val => php_val,
1663 result_var => result_var,
1664 },
1665 ));
1666 return;
1667 }
1668 "embedding_dimensions" => {
1669 let expr = format!("(empty(${result_var}) ? 0 : count(${result_var}[0]))");
1670 let php_val = assertion.value.as_ref().map(json_to_php).unwrap_or_default();
1671 out.push_str(&crate::template_env::render(
1672 "php/synthetic_assertion.jinja",
1673 minijinja::context! {
1674 assertion_kind => "embedding_dimensions",
1675 assertion_type => assertion.assertion_type.as_str(),
1676 expr => expr,
1677 php_val => php_val,
1678 },
1679 ));
1680 return;
1681 }
1682 "embeddings_valid" | "embeddings_finite" | "embeddings_non_zero" | "embeddings_normalized" => {
1683 let pred = match f.as_str() {
1684 "embeddings_valid" => {
1685 format!("array_reduce(${result_var}, fn($carry, $e) => $carry && count($e) > 0, true)")
1686 }
1687 "embeddings_finite" => {
1688 format!(
1689 "array_reduce(${result_var}, fn($carry, $e) => $carry && array_reduce($e, fn($c, $v) => $c && is_finite($v), true), true)"
1690 )
1691 }
1692 "embeddings_non_zero" => {
1693 format!(
1694 "array_reduce(${result_var}, fn($carry, $e) => $carry && count(array_filter($e, fn($v) => $v !== 0.0)) > 0, true)"
1695 )
1696 }
1697 "embeddings_normalized" => {
1698 format!(
1699 "array_reduce(${result_var}, fn($carry, $e) => $carry && abs(array_sum(array_map(fn($v) => $v * $v, $e)) - 1.0) < 1e-3, true)"
1700 )
1701 }
1702 _ => unreachable!(),
1703 };
1704 let assertion_kind = format!("embeddings_{}", f.strip_prefix("embeddings_").unwrap_or(f));
1705 out.push_str(&crate::template_env::render(
1706 "php/synthetic_assertion.jinja",
1707 minijinja::context! {
1708 assertion_kind => assertion_kind,
1709 assertion_type => assertion.assertion_type.as_str(),
1710 pred => pred,
1711 field_name => f,
1712 },
1713 ));
1714 return;
1715 }
1716 "keywords" | "keywords_count" => {
1719 out.push_str(&crate::template_env::render(
1720 "php/synthetic_assertion.jinja",
1721 minijinja::context! {
1722 assertion_kind => "keywords",
1723 field_name => f,
1724 },
1725 ));
1726 return;
1727 }
1728 _ => {}
1729 }
1730 }
1731
1732 if let Some(f) = &assertion.field {
1735 if !f.is_empty() && crate::codegen::streaming_assertions::is_streaming_virtual_field(f) {
1736 if let Some(expr) =
1737 crate::codegen::streaming_assertions::StreamingFieldResolver::accessor(f, "php", "chunks")
1738 {
1739 let line = match assertion.assertion_type.as_str() {
1740 "count_min" => {
1741 if let Some(n) = assertion.value.as_ref().and_then(|v| v.as_u64()) {
1742 format!(
1743 " $this->assertGreaterThanOrEqual({n}, count({expr}), 'expected >= {n} chunks');\n"
1744 )
1745 } else {
1746 String::new()
1747 }
1748 }
1749 "count_equals" => {
1750 if let Some(n) = assertion.value.as_ref().and_then(|v| v.as_u64()) {
1751 format!(" $this->assertCount({n}, {expr});\n")
1752 } else {
1753 String::new()
1754 }
1755 }
1756 "equals" => {
1757 if let Some(serde_json::Value::String(s)) = &assertion.value {
1758 let escaped = s.replace('\\', "\\\\").replace('\'', "\\'");
1759 format!(" $this->assertEquals('{escaped}', {expr});\n")
1760 } else if let Some(n) = assertion.value.as_ref().and_then(|v| v.as_u64()) {
1761 format!(" $this->assertEquals({n}, {expr});\n")
1762 } else {
1763 String::new()
1764 }
1765 }
1766 "not_empty" => format!(" $this->assertNotEmpty({expr});\n"),
1767 "is_empty" => format!(" $this->assertEmpty({expr});\n"),
1768 "is_true" => format!(" $this->assertTrue({expr});\n"),
1769 "is_false" => format!(" $this->assertFalse({expr});\n"),
1770 "greater_than" => {
1771 if let Some(n) = assertion.value.as_ref().and_then(|v| v.as_u64()) {
1772 format!(" $this->assertGreaterThan({n}, {expr});\n")
1773 } else {
1774 String::new()
1775 }
1776 }
1777 "greater_than_or_equal" => {
1778 if let Some(n) = assertion.value.as_ref().and_then(|v| v.as_u64()) {
1779 format!(" $this->assertGreaterThanOrEqual({n}, {expr});\n")
1780 } else {
1781 String::new()
1782 }
1783 }
1784 "contains" => {
1785 if let Some(serde_json::Value::String(s)) = &assertion.value {
1786 let escaped = s.replace('\\', "\\\\").replace('\'', "\\'");
1787 format!(" $this->assertStringContainsString('{escaped}', {expr});\n")
1788 } else {
1789 String::new()
1790 }
1791 }
1792 _ => format!(
1793 " // streaming field '{f}': assertion type '{}' not rendered\n",
1794 assertion.assertion_type
1795 ),
1796 };
1797 if !line.is_empty() {
1798 out.push_str(&line);
1799 }
1800 }
1801 return;
1802 }
1803 }
1804
1805 if let Some(f) = &assertion.field {
1807 if !f.is_empty() && !field_resolver.is_valid_for_result(f) {
1808 out.push_str(&crate::template_env::render(
1809 "php/synthetic_assertion.jinja",
1810 minijinja::context! {
1811 assertion_kind => "skipped",
1812 field_name => f,
1813 },
1814 ));
1815 return;
1816 }
1817 }
1818
1819 if result_is_simple {
1822 if let Some(f) = &assertion.field {
1823 let f_lower = f.to_lowercase();
1824 if !f.is_empty()
1825 && f_lower != "content"
1826 && (f_lower.starts_with("metadata")
1827 || f_lower.starts_with("document")
1828 || f_lower.starts_with("structure"))
1829 {
1830 out.push_str(&crate::template_env::render(
1831 "php/synthetic_assertion.jinja",
1832 minijinja::context! {
1833 assertion_kind => "result_is_simple",
1834 field_name => f,
1835 },
1836 ));
1837 return;
1838 }
1839 }
1840 }
1841
1842 let field_expr = match &assertion.field {
1843 _ if result_is_simple => format!("${result_var}"),
1847 Some(f) if !f.is_empty() => {
1848 if let Some((var_name, _)) = fields_array_bindings.get(f) {
1850 format!("${}", var_name)
1851 } else {
1852 field_resolver.accessor(f, "php", &format!("${result_var}"))
1853 }
1854 }
1855 _ => format!("${result_var}"),
1856 };
1857
1858 let field_is_array = assertion.field.as_ref().map_or(result_is_array, |f| {
1861 if f.is_empty() {
1862 result_is_array
1863 } else {
1864 field_resolver.is_array(f)
1865 }
1866 });
1867
1868 let trimmed_field_expr_for = |expected: &serde_json::Value| -> String {
1872 if expected.is_string() {
1873 format!("trim({})", field_expr)
1874 } else {
1875 field_expr.clone()
1876 }
1877 };
1878
1879 let assertion_type = assertion.assertion_type.as_str();
1881 let has_php_val = assertion.value.is_some();
1882 let php_val = match assertion.value.as_ref() {
1886 Some(v) => json_to_php(v),
1887 None if assertion_type == "equals" => "null".to_string(),
1888 None => String::new(),
1889 };
1890 let trimmed_field_expr = trimmed_field_expr_for(assertion.value.as_ref().unwrap_or(&serde_json::Value::Null));
1891 let is_string_val = assertion.value.as_ref().is_some_and(|v| v.is_string());
1892 let values_php: Vec<String> = assertion
1896 .values
1897 .as_ref()
1898 .map(|vals| vals.iter().map(json_to_php).collect::<Vec<_>>())
1899 .or_else(|| assertion.value.as_ref().map(|v| vec![json_to_php(v)]))
1900 .unwrap_or_default();
1901 let contains_any_checks: Vec<String> = assertion
1902 .values
1903 .as_ref()
1904 .map_or(Vec::new(), |vals| vals.iter().map(json_to_php).collect());
1905 let n = assertion.value.as_ref().and_then(|v| v.as_u64()).unwrap_or(0);
1906
1907 let call_expr = if let Some(method_name) = &assertion.method {
1909 build_php_method_call(result_var, method_name, assertion.args.as_ref())
1910 } else {
1911 String::new()
1912 };
1913 let check = assertion.check.as_deref().unwrap_or("is_true");
1914 let has_php_check_val = matches!(assertion.assertion_type.as_str(), "method_result") && assertion.value.is_some();
1915 let php_check_val = if matches!(assertion.assertion_type.as_str(), "method_result") {
1916 assertion.value.as_ref().map(json_to_php).unwrap_or_default()
1917 } else {
1918 String::new()
1919 };
1920 let check_n = assertion.value.as_ref().and_then(|v| v.as_u64()).unwrap_or(0);
1921 let is_bool_val = assertion.value.as_ref().is_some_and(|v| v.is_boolean());
1922 let bool_is_true = assertion.value.as_ref().and_then(|v| v.as_bool()).unwrap_or(false);
1923
1924 if matches!(assertion_type, "not_error" | "error") {
1926 if assertion_type == "not_error" {
1927 }
1929 return;
1931 }
1932
1933 let rendered = crate::template_env::render(
1934 "php/assertion.jinja",
1935 minijinja::context! {
1936 assertion_type => assertion_type,
1937 field_expr => field_expr,
1938 php_val => php_val,
1939 has_php_val => has_php_val,
1940 trimmed_field_expr => trimmed_field_expr,
1941 is_string_val => is_string_val,
1942 field_is_array => field_is_array,
1943 values_php => values_php,
1944 contains_any_checks => contains_any_checks,
1945 n => n,
1946 call_expr => call_expr,
1947 check => check,
1948 php_check_val => php_check_val,
1949 has_php_check_val => has_php_check_val,
1950 check_n => check_n,
1951 is_bool_val => is_bool_val,
1952 bool_is_true => bool_is_true,
1953 },
1954 );
1955 let _ = write!(out, " {}", rendered);
1956}
1957
1958fn build_php_method_call(result_var: &str, method_name: &str, args: Option<&serde_json::Value>) -> String {
1965 let extra_args = if let Some(args_val) = args {
1966 args_val
1967 .as_object()
1968 .map(|obj| {
1969 obj.values()
1970 .map(|v| match v {
1971 serde_json::Value::String(s) => format!("\"{}\"", s.replace('\\', "\\\\").replace('"', "\\\"")),
1972 serde_json::Value::Bool(true) => "true".to_string(),
1973 serde_json::Value::Bool(false) => "false".to_string(),
1974 serde_json::Value::Number(n) => n.to_string(),
1975 serde_json::Value::Null => "null".to_string(),
1976 other => format!("\"{}\"", other.to_string().replace('\\', "\\\\").replace('"', "\\\"")),
1977 })
1978 .collect::<Vec<_>>()
1979 .join(", ")
1980 })
1981 .unwrap_or_default()
1982 } else {
1983 String::new()
1984 };
1985
1986 if extra_args.is_empty() {
1987 format!("${result_var}->{method_name}()")
1988 } else {
1989 format!("${result_var}->{method_name}({extra_args})")
1990 }
1991}
1992
1993fn filter_empty_enum_strings(value: &serde_json::Value) -> serde_json::Value {
1997 match value {
1998 serde_json::Value::Object(map) => {
1999 let filtered: serde_json::Map<String, serde_json::Value> = map
2000 .iter()
2001 .filter_map(|(k, v)| {
2002 if let serde_json::Value::String(s) = v {
2004 if s.is_empty() {
2005 return None;
2006 }
2007 }
2008 Some((k.clone(), filter_empty_enum_strings(v)))
2010 })
2011 .collect();
2012 serde_json::Value::Object(filtered)
2013 }
2014 serde_json::Value::Array(arr) => {
2015 let filtered: Vec<serde_json::Value> = arr.iter().map(filter_empty_enum_strings).collect();
2016 serde_json::Value::Array(filtered)
2017 }
2018 other => other.clone(),
2019 }
2020}
2021
2022fn json_to_php(value: &serde_json::Value) -> String {
2024 match value {
2025 serde_json::Value::String(s) => format!("\"{}\"", escape_php(s)),
2026 serde_json::Value::Bool(true) => "true".to_string(),
2027 serde_json::Value::Bool(false) => "false".to_string(),
2028 serde_json::Value::Number(n) => n.to_string(),
2029 serde_json::Value::Null => "null".to_string(),
2030 serde_json::Value::Array(arr) => {
2031 let items: Vec<String> = arr.iter().map(json_to_php).collect();
2032 format!("[{}]", items.join(", "))
2033 }
2034 serde_json::Value::Object(map) => {
2035 let items: Vec<String> = map
2036 .iter()
2037 .map(|(k, v)| format!("\"{}\" => {}", escape_php(k), json_to_php(v)))
2038 .collect();
2039 format!("[{}]", items.join(", "))
2040 }
2041 }
2042}
2043
2044fn json_to_php_camel_keys(value: &serde_json::Value) -> String {
2049 match value {
2050 serde_json::Value::Object(map) => {
2051 let items: Vec<String> = map
2052 .iter()
2053 .map(|(k, v)| {
2054 let camel_key = k.to_lower_camel_case();
2055 format!("\"{}\" => {}", escape_php(&camel_key), json_to_php_camel_keys(v))
2056 })
2057 .collect();
2058 format!("[{}]", items.join(", "))
2059 }
2060 serde_json::Value::Array(arr) => {
2061 let items: Vec<String> = arr.iter().map(json_to_php_camel_keys).collect();
2062 format!("[{}]", items.join(", "))
2063 }
2064 _ => json_to_php(value),
2065 }
2066}
2067
2068fn build_php_visitor(setup_lines: &mut Vec<String>, visitor_spec: &crate::fixture::VisitorSpec) {
2074 setup_lines.push("$visitor = new class {".to_string());
2075 for (method_name, action) in &visitor_spec.callbacks {
2076 emit_php_visitor_method(setup_lines, method_name, action);
2077 }
2078 setup_lines.push("};".to_string());
2079}
2080
2081fn emit_php_visitor_method(setup_lines: &mut Vec<String>, method_name: &str, action: &CallbackAction) {
2083 let params = match method_name {
2084 "visit_link" => "$ctx, $href, $text, $title",
2085 "visit_image" => "$ctx, $src, $alt, $title",
2086 "visit_heading" => "$ctx, $level, $text, $id",
2087 "visit_code_block" => "$ctx, $lang, $code",
2088 "visit_code_inline"
2089 | "visit_strong"
2090 | "visit_emphasis"
2091 | "visit_strikethrough"
2092 | "visit_underline"
2093 | "visit_subscript"
2094 | "visit_superscript"
2095 | "visit_mark"
2096 | "visit_button"
2097 | "visit_summary"
2098 | "visit_figcaption"
2099 | "visit_definition_term"
2100 | "visit_definition_description" => "$ctx, $text",
2101 "visit_text" => "$ctx, $text",
2102 "visit_list_item" => "$ctx, $ordered, $marker, $text",
2103 "visit_blockquote" => "$ctx, $content, $depth",
2104 "visit_table_row" => "$ctx, $cells, $isHeader",
2105 "visit_custom_element" => "$ctx, $tagName, $html",
2106 "visit_form" => "$ctx, $actionUrl, $method",
2107 "visit_input" => "$ctx, $input_type, $name, $value",
2108 "visit_audio" | "visit_video" | "visit_iframe" => "$ctx, $src",
2109 "visit_details" => "$ctx, $isOpen",
2110 "visit_element_end" | "visit_table_end" | "visit_definition_list_end" | "visit_figure_end" => "$ctx, $output",
2111 "visit_list_start" => "$ctx, $ordered",
2112 "visit_list_end" => "$ctx, $ordered, $output",
2113 _ => "$ctx",
2114 };
2115
2116 let (action_type, action_value, return_form) = match action {
2117 CallbackAction::Skip => ("skip", String::new(), "dict"),
2118 CallbackAction::Continue => ("continue", String::new(), "dict"),
2119 CallbackAction::PreserveHtml => ("preserve_html", String::new(), "dict"),
2120 CallbackAction::Custom { output } => ("custom", escape_php(output), "dict"),
2121 CallbackAction::CustomTemplate { template, return_form } => {
2122 let form = match return_form {
2123 TemplateReturnForm::Dict => "dict",
2124 TemplateReturnForm::BareString => "bare_string",
2125 };
2126 ("custom_template", escape_php(template), form)
2127 }
2128 };
2129
2130 let rendered = crate::template_env::render(
2131 "php/visitor_method.jinja",
2132 minijinja::context! {
2133 method_name => method_name,
2134 params => params,
2135 action_type => action_type,
2136 action_value => action_value,
2137 return_form => return_form,
2138 },
2139 );
2140 for line in rendered.lines() {
2141 setup_lines.push(line.to_string());
2142 }
2143}
2144
2145fn is_php_reserved_type(name: &str) -> bool {
2147 matches!(
2148 name.to_ascii_lowercase().as_str(),
2149 "string"
2150 | "int"
2151 | "integer"
2152 | "float"
2153 | "double"
2154 | "bool"
2155 | "boolean"
2156 | "array"
2157 | "object"
2158 | "null"
2159 | "void"
2160 | "callable"
2161 | "iterable"
2162 | "never"
2163 | "self"
2164 | "parent"
2165 | "static"
2166 | "true"
2167 | "false"
2168 | "mixed"
2169 )
2170}