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 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 let per_call_getter_map = build_php_getter_map(
946 type_defs,
947 php_enum_names,
948 call_config,
949 e2e_config.effective_result_fields(call_config),
950 );
951 let call_field_resolver = FieldResolver::new_with_php_getters(
952 e2e_config.effective_fields(call_config),
953 e2e_config.effective_fields_optional(call_config),
954 e2e_config.effective_result_fields(call_config),
955 e2e_config.effective_fields_array(call_config),
956 &HashSet::new(),
957 &HashMap::new(),
958 per_call_getter_map,
959 );
960 let field_resolver = &call_field_resolver;
961 let call_overrides = call_config.overrides.get(lang);
962 let has_override = call_overrides.is_some_and(|o| o.function.is_some());
963 let result_is_simple = call_overrides.is_some_and(|o| o.result_is_simple) || result_is_simple;
967 let mut function_name = call_overrides
968 .and_then(|o| o.function.as_ref())
969 .cloned()
970 .unwrap_or_else(|| call_config.function.clone());
971 if !has_override {
976 function_name = function_name.to_lower_camel_case();
977 }
978 let result_var = &call_config.result_var;
979 let args = &call_config.args;
980
981 let method_name = sanitize_filename(&fixture.id);
982 let description = &fixture.description;
983 let expects_error = fixture.assertions.iter().any(|a| a.assertion_type == "error");
984
985 let call_options_type = call_overrides.and_then(|o| o.options_type.as_deref()).or_else(|| {
987 e2e_config
988 .call
989 .overrides
990 .get(lang)
991 .and_then(|o| o.options_type.as_deref())
992 });
993
994 let adapter_request_type: Option<String> = adapters
995 .iter()
996 .find(|a| a.name == call_config.function.as_str())
997 .and_then(|a| a.request_type.as_deref())
998 .map(|rt| rt.rsplit("::").next().unwrap_or(rt).to_string());
999 let (mut setup_lines, args_str) = build_args_and_setup(
1000 &fixture.input,
1001 args,
1002 class_name,
1003 enum_fields,
1004 fixture,
1005 options_via,
1006 call_options_type,
1007 adapter_request_type.as_deref(),
1008 );
1009
1010 let skip_test = call_config.skip_languages.iter().any(|l| l == "php");
1012 if skip_test {
1013 let rendered = crate::template_env::render(
1014 "php/test_method.jinja",
1015 minijinja::context! {
1016 method_name => method_name,
1017 description => description,
1018 client_factory => String::new(),
1019 setup_lines => Vec::<String>::new(),
1020 expects_error => false,
1021 skip_test => true,
1022 has_usable_assertions => false,
1023 call_expr => String::new(),
1024 result_var => result_var,
1025 assertions_body => String::new(),
1026 },
1027 );
1028 out.push_str(&rendered);
1029 return;
1030 }
1031
1032 let mut options_already_created = !args_str.is_empty() && args_str == "$options";
1034 if let Some(visitor_spec) = &fixture.visitor {
1035 build_php_visitor(&mut setup_lines, visitor_spec);
1036 if !options_already_created {
1037 let options_type = call_options_type.unwrap_or("ConversionOptions");
1038 setup_lines.push(format!("$builder = \\{namespace}\\{options_type}::builder();"));
1039 setup_lines.push("$options = $builder->visitor($visitor)->build();".to_string());
1040 options_already_created = true;
1041 }
1042 }
1043
1044 let final_args = if options_already_created {
1045 if args_str.is_empty() || args_str == "$options" {
1046 "$options".to_string()
1047 } else {
1048 format!("{args_str}, $options")
1049 }
1050 } else {
1051 args_str
1052 };
1053
1054 let call_expr = if php_client_factory.is_some() {
1055 format!("$client->{function_name}({final_args})")
1056 } else {
1057 format!("{class_name}::{function_name}({final_args})")
1058 };
1059
1060 let has_mock = fixture.mock_response.is_some() || fixture.http.is_some();
1061 let api_key_var = fixture.env.as_ref().and_then(|e| e.api_key_var.as_deref());
1062 let client_factory = if let Some(factory) = php_client_factory {
1063 let fixture_id = &fixture.id;
1064 if let Some(var) = api_key_var.filter(|_| has_mock) {
1065 format!(
1066 "$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);"
1067 )
1068 } else if has_mock {
1069 let base_url_expr = if fixture.has_host_root_route() {
1070 let env_key = format!("MOCK_SERVER_{}", fixture_id.to_uppercase());
1071 format!("(getenv('{env_key}') ?: getenv('MOCK_SERVER_URL') . '/fixtures/{fixture_id}')")
1072 } else {
1073 format!("getenv('MOCK_SERVER_URL') . '/fixtures/{fixture_id}'")
1074 };
1075 format!("$client = \\{namespace}\\{class_name}::{factory}('test-key', {base_url_expr});")
1076 } else if let Some(var) = api_key_var {
1077 format!(
1078 "$apiKey = getenv('{var}');\n if (!$apiKey) {{ $this->markTestSkipped('{var} not set'); return; }}\n $client = \\{namespace}\\{class_name}::{factory}($apiKey);"
1079 )
1080 } else {
1081 format!("$client = \\{namespace}\\{class_name}::{factory}('test-key');")
1082 }
1083 } else {
1084 String::new()
1085 };
1086
1087 let is_streaming = crate::codegen::streaming_assertions::resolve_is_streaming(fixture, call_config.streaming);
1089
1090 let has_usable_assertions = fixture.assertions.iter().any(|a| {
1093 if a.assertion_type == "error" || a.assertion_type == "not_error" {
1094 return false;
1095 }
1096 match &a.field {
1097 Some(f) if !f.is_empty() => {
1098 if is_streaming && crate::codegen::streaming_assertions::is_streaming_virtual_field(f) {
1099 return true;
1100 }
1101 field_resolver.is_valid_for_result(f)
1102 }
1103 _ => true,
1104 }
1105 });
1106
1107 let collect_snippet = if is_streaming {
1109 crate::codegen::streaming_assertions::StreamingFieldResolver::collect_snippet("php", result_var, "chunks")
1110 .unwrap_or_default()
1111 } else {
1112 String::new()
1113 };
1114
1115 let mut fields_array_bindings = std::collections::HashMap::new();
1118 for assertion in &fixture.assertions {
1119 if let Some(f) = &assertion.field {
1120 if !f.is_empty() && field_resolver.is_array(f) {
1121 if !fields_array_bindings.contains_key(f.as_str()) {
1123 let accessor = field_resolver.accessor(f, "php", &format!("${result_var}"));
1124 let var_name = f.to_lower_camel_case();
1125 fields_array_bindings.insert(f.clone(), (var_name, accessor));
1126 }
1127 }
1128 }
1129 }
1130
1131 let mut field_bindings = String::new();
1137 for (var_name, accessor) in fields_array_bindings.values() {
1138 field_bindings.push_str(&format!(" ${} = {};\n", var_name, accessor));
1139 }
1140
1141 let mut assertions_body = String::new();
1143 for assertion in &fixture.assertions {
1144 render_assertion(
1145 &mut assertions_body,
1146 assertion,
1147 result_var,
1148 field_resolver,
1149 result_is_simple,
1150 call_config.result_is_array,
1151 &fields_array_bindings,
1152 );
1153 }
1154
1155 if is_streaming && !expects_error && assertions_body.trim().is_empty() {
1161 assertions_body.push_str(" $this->assertTrue(is_array($chunks), 'expected drained chunks list');\n");
1162 }
1163
1164 let rendered = crate::template_env::render(
1165 "php/test_method.jinja",
1166 minijinja::context! {
1167 method_name => method_name,
1168 description => description,
1169 client_factory => client_factory,
1170 setup_lines => setup_lines,
1171 expects_error => expects_error,
1172 skip_test => fixture.assertions.is_empty(),
1173 has_usable_assertions => has_usable_assertions || is_streaming,
1174 call_expr => call_expr,
1175 result_var => result_var,
1176 collect_snippet => collect_snippet,
1177 field_bindings => field_bindings,
1178 assertions_body => assertions_body,
1179 },
1180 );
1181 out.push_str(&rendered);
1182}
1183
1184fn emit_php_batch_item_array(arr: &serde_json::Value, elem_type: &str) -> String {
1197 if let Some(items) = arr.as_array() {
1198 let item_strs: Vec<String> = items
1199 .iter()
1200 .filter_map(|item| {
1201 if let Some(obj) = item.as_object() {
1202 match elem_type {
1203 "BatchBytesItem" => {
1204 let content = obj.get("content").and_then(|v| v.as_array());
1205 let mime_type = obj.get("mime_type").and_then(|v| v.as_str()).unwrap_or("text/plain");
1206 let content_code = if let Some(arr) = content {
1207 let bytes: Vec<String> = arr
1208 .iter()
1209 .filter_map(|v| v.as_u64())
1210 .map(|n| format!("\\x{:02x}", n))
1211 .collect();
1212 format!("\"{}\"", bytes.join(""))
1213 } else {
1214 "\"\"".to_string()
1215 };
1216 Some(format!(
1217 "new {}(content: {}, mimeType: \"{}\")",
1218 elem_type, content_code, mime_type
1219 ))
1220 }
1221 "BatchFileItem" => {
1222 let path = obj.get("path").and_then(|v| v.as_str()).unwrap_or("");
1223 Some(format!("new {}(path: \"{}\")", elem_type, path))
1224 }
1225 _ => None,
1226 }
1227 } else {
1228 None
1229 }
1230 })
1231 .collect();
1232 format!("[{}]", item_strs.join(", "))
1233 } else {
1234 "[]".to_string()
1235 }
1236}
1237
1238#[allow(clippy::too_many_arguments)]
1239fn build_args_and_setup(
1240 input: &serde_json::Value,
1241 args: &[crate::config::ArgMapping],
1242 class_name: &str,
1243 _enum_fields: &HashMap<String, String>,
1244 fixture: &crate::fixture::Fixture,
1245 options_via: &str,
1246 options_type: Option<&str>,
1247 adapter_request_type: Option<&str>,
1248) -> (Vec<String>, String) {
1249 let fixture_id = &fixture.id;
1250 if args.is_empty() {
1251 let is_empty_input = match input {
1254 serde_json::Value::Null => true,
1255 serde_json::Value::Object(m) => m.is_empty(),
1256 _ => false,
1257 };
1258 if is_empty_input {
1259 return (Vec::new(), String::new());
1260 }
1261 return (Vec::new(), json_to_php(input));
1262 }
1263
1264 let mut setup_lines: Vec<String> = Vec::new();
1265 let mut parts: Vec<String> = Vec::new();
1266
1267 let arg_has_emission = |arg: &crate::config::ArgMapping| -> bool {
1272 let val = if arg.field == "input" {
1273 Some(input)
1274 } else {
1275 let field = arg.field.strip_prefix("input.").unwrap_or(&arg.field);
1276 input.get(field)
1277 };
1278 match val {
1279 None | Some(serde_json::Value::Null) => !arg.optional,
1280 Some(_) => true,
1281 }
1282 };
1283 let any_later_has_emission = |from_idx: usize| -> bool { args[from_idx..].iter().any(arg_has_emission) };
1284
1285 for (idx, arg) in args.iter().enumerate() {
1286 if arg.arg_type == "mock_url" {
1287 if fixture.has_host_root_route() {
1288 let env_key = format!("MOCK_SERVER_{}", fixture_id.to_uppercase());
1289 setup_lines.push(format!(
1290 "${} = getenv('{env_key}') ?: getenv('MOCK_SERVER_URL') . '/fixtures/{fixture_id}';",
1291 arg.name,
1292 ));
1293 } else {
1294 setup_lines.push(format!(
1295 "${} = getenv('MOCK_SERVER_URL') . '/fixtures/{fixture_id}';",
1296 arg.name,
1297 ));
1298 }
1299 if let Some(req_type) = adapter_request_type {
1300 let req_var = format!("${}_req", arg.name);
1301 setup_lines.push(format!("{req_var} = new {req_type}(${});", arg.name));
1302 parts.push(req_var);
1303 } else {
1304 parts.push(format!("${}", arg.name));
1305 }
1306 continue;
1307 }
1308
1309 if arg.arg_type == "handle" {
1310 let constructor_name = format!("create{}", arg.name.to_upper_camel_case());
1312 let config_value = if arg.field == "input" {
1313 input
1314 } else {
1315 let field = arg.field.strip_prefix("input.").unwrap_or(&arg.field);
1316 input.get(field).unwrap_or(&serde_json::Value::Null)
1317 };
1318 if config_value.is_null()
1319 || config_value.is_object() && config_value.as_object().is_some_and(|o| o.is_empty())
1320 {
1321 setup_lines.push(format!("${} = {class_name}::{constructor_name}(null);", arg.name,));
1322 } else {
1323 let name = &arg.name;
1324 let filtered_config = filter_empty_enum_strings(config_value);
1329 setup_lines.push(format!(
1330 "${name}_config = CrawlConfig::from_json(json_encode({}));",
1331 json_to_php_camel_keys(&filtered_config)
1332 ));
1333 setup_lines.push(format!(
1334 "${} = {class_name}::{constructor_name}(${name}_config);",
1335 arg.name,
1336 ));
1337 }
1338 parts.push(format!("${}", arg.name));
1339 continue;
1340 }
1341
1342 let val = if arg.field == "input" {
1343 Some(input)
1344 } else {
1345 let field = arg.field.strip_prefix("input.").unwrap_or(&arg.field);
1346 input.get(field)
1347 };
1348
1349 if arg.arg_type == "bytes" {
1353 match val {
1354 None | Some(serde_json::Value::Null) => {
1355 if arg.optional {
1356 parts.push("null".to_string());
1357 } else {
1358 parts.push("\"\"".to_string());
1359 }
1360 }
1361 Some(serde_json::Value::String(s)) => {
1362 let var_name = format!("{}Bytes", arg.name);
1363 setup_lines.push(format!(
1364 "${var_name} = file_get_contents(\"{path}\");\n if (${var_name} === false) {{ $this->fail(\"failed to read fixture: {path}\"); }}",
1365 path = s.replace('"', "\\\"")
1366 ));
1367 parts.push(format!("${var_name}"));
1368 }
1369 Some(serde_json::Value::Array(arr)) => {
1370 let bytes: String = arr
1371 .iter()
1372 .filter_map(|v| v.as_u64())
1373 .map(|n| format!("\\x{:02x}", n))
1374 .collect();
1375 parts.push(format!("\"{bytes}\""));
1376 }
1377 Some(other) => {
1378 parts.push(json_to_php(other));
1379 }
1380 }
1381 continue;
1382 }
1383
1384 match val {
1385 None | Some(serde_json::Value::Null) if arg.arg_type == "json_object" && arg.name == "config" => {
1386 let type_name = if arg.name == "config" {
1392 "ExtractionConfig".to_string()
1393 } else {
1394 format!("{}Config", arg.name.to_upper_camel_case())
1395 };
1396 parts.push(format!("{type_name}::from_json('{{}}')"));
1397 continue;
1398 }
1399 None | Some(serde_json::Value::Null) if arg.optional => {
1400 if any_later_has_emission(idx + 1) {
1405 parts.push("null".to_string());
1406 }
1407 continue;
1408 }
1409 None | Some(serde_json::Value::Null) => {
1410 let default_val = match arg.arg_type.as_str() {
1412 "string" => "\"\"".to_string(),
1413 "int" | "integer" => "0".to_string(),
1414 "float" | "number" => "0.0".to_string(),
1415 "bool" | "boolean" => "false".to_string(),
1416 "json_object" if options_via == "json" => "null".to_string(),
1417 _ => "null".to_string(),
1418 };
1419 parts.push(default_val);
1420 }
1421 Some(v) => {
1422 if arg.arg_type == "json_object" && !v.is_null() {
1423 if let Some(elem_type) = &arg.element_type {
1425 if (elem_type == "BatchBytesItem" || elem_type == "BatchFileItem") && v.is_array() {
1426 parts.push(emit_php_batch_item_array(v, elem_type));
1427 continue;
1428 }
1429 if v.is_array() && is_php_reserved_type(elem_type) {
1433 parts.push(json_to_php(v));
1434 continue;
1435 }
1436 }
1437 match options_via {
1438 "json" => {
1439 let filtered_v = filter_empty_enum_strings(v);
1442
1443 if let serde_json::Value::Object(obj) = &filtered_v {
1445 if obj.is_empty() {
1446 parts.push("null".to_string());
1447 continue;
1448 }
1449 }
1450
1451 parts.push(format!("json_encode({})", json_to_php_camel_keys(&filtered_v)));
1452 continue;
1453 }
1454 _ => {
1455 if let Some(type_name) = options_type {
1456 let filtered_v = filter_empty_enum_strings(v);
1461
1462 if let serde_json::Value::Object(obj) = &filtered_v {
1465 if obj.is_empty() {
1466 let arg_var = format!("${}", arg.name);
1467 setup_lines.push(format!("{arg_var} = {type_name}::from_json('{{}}');"));
1468 parts.push(arg_var);
1469 continue;
1470 }
1471 }
1472
1473 let arg_var = format!("${}", arg.name);
1474 setup_lines.push(format!(
1478 "{arg_var} = {type_name}::from_json(json_encode({}));",
1479 json_to_php_camel_keys(&filtered_v)
1480 ));
1481 parts.push(arg_var);
1482 continue;
1483 }
1484 if let Some(obj) = v.as_object() {
1488 setup_lines.push("$builder = $this->createDefaultOptionsBuilder();".to_string());
1489 for (k, vv) in obj {
1490 let snake_key = k.to_snake_case();
1491 if snake_key == "preprocessing" {
1492 if let Some(prep_obj) = vv.as_object() {
1493 let enabled =
1494 prep_obj.get("enabled").and_then(|v| v.as_bool()).unwrap_or(true);
1495 let preset =
1496 prep_obj.get("preset").and_then(|v| v.as_str()).unwrap_or("Minimal");
1497 let remove_navigation = prep_obj
1498 .get("remove_navigation")
1499 .and_then(|v| v.as_bool())
1500 .unwrap_or(true);
1501 let remove_forms =
1502 prep_obj.get("remove_forms").and_then(|v| v.as_bool()).unwrap_or(true);
1503 setup_lines.push(format!(
1504 "$preprocessing = $this->createPreprocessingOptions({}, {}, {}, {});",
1505 if enabled { "true" } else { "false" },
1506 json_to_php(&serde_json::Value::String(preset.to_string())),
1507 if remove_navigation { "true" } else { "false" },
1508 if remove_forms { "true" } else { "false" }
1509 ));
1510 setup_lines.push(
1511 "$builder = $builder->preprocessing($preprocessing);".to_string(),
1512 );
1513 }
1514 }
1515 }
1516 setup_lines.push("$options = $builder->build();".to_string());
1517 parts.push("$options".to_string());
1518 continue;
1519 }
1520 }
1521 }
1522 }
1523 parts.push(json_to_php(v));
1524 }
1525 }
1526 }
1527
1528 (setup_lines, parts.join(", "))
1529}
1530
1531fn render_assertion(
1532 out: &mut String,
1533 assertion: &Assertion,
1534 result_var: &str,
1535 field_resolver: &FieldResolver,
1536 result_is_simple: bool,
1537 result_is_array: bool,
1538 fields_array_bindings: &std::collections::HashMap<String, (String, String)>,
1539) {
1540 if let Some(f) = &assertion.field {
1543 match f.as_str() {
1544 "chunks_have_content" => {
1545 let pred = format!(
1546 "array_reduce(${result_var}->chunks ?? [], fn($carry, $c) => $carry && !empty($c->content), true)"
1547 );
1548 out.push_str(&crate::template_env::render(
1549 "php/synthetic_assertion.jinja",
1550 minijinja::context! {
1551 assertion_kind => "chunks_content",
1552 assertion_type => assertion.assertion_type.as_str(),
1553 pred => pred,
1554 field_name => f,
1555 },
1556 ));
1557 return;
1558 }
1559 "chunks_have_embeddings" => {
1560 let pred = format!(
1561 "array_reduce(${result_var}->chunks ?? [], fn($carry, $c) => $carry && !empty($c->embedding), true)"
1562 );
1563 out.push_str(&crate::template_env::render(
1564 "php/synthetic_assertion.jinja",
1565 minijinja::context! {
1566 assertion_kind => "chunks_embeddings",
1567 assertion_type => assertion.assertion_type.as_str(),
1568 pred => pred,
1569 field_name => f,
1570 },
1571 ));
1572 return;
1573 }
1574 "embeddings" => {
1578 let php_val = assertion.value.as_ref().map(json_to_php).unwrap_or_default();
1579 out.push_str(&crate::template_env::render(
1580 "php/synthetic_assertion.jinja",
1581 minijinja::context! {
1582 assertion_kind => "embeddings",
1583 assertion_type => assertion.assertion_type.as_str(),
1584 php_val => php_val,
1585 result_var => result_var,
1586 },
1587 ));
1588 return;
1589 }
1590 "embedding_dimensions" => {
1591 let expr = format!("(empty(${result_var}) ? 0 : count(${result_var}[0]))");
1592 let php_val = assertion.value.as_ref().map(json_to_php).unwrap_or_default();
1593 out.push_str(&crate::template_env::render(
1594 "php/synthetic_assertion.jinja",
1595 minijinja::context! {
1596 assertion_kind => "embedding_dimensions",
1597 assertion_type => assertion.assertion_type.as_str(),
1598 expr => expr,
1599 php_val => php_val,
1600 },
1601 ));
1602 return;
1603 }
1604 "embeddings_valid" | "embeddings_finite" | "embeddings_non_zero" | "embeddings_normalized" => {
1605 let pred = match f.as_str() {
1606 "embeddings_valid" => {
1607 format!("array_reduce(${result_var}, fn($carry, $e) => $carry && count($e) > 0, true)")
1608 }
1609 "embeddings_finite" => {
1610 format!(
1611 "array_reduce(${result_var}, fn($carry, $e) => $carry && array_reduce($e, fn($c, $v) => $c && is_finite($v), true), true)"
1612 )
1613 }
1614 "embeddings_non_zero" => {
1615 format!(
1616 "array_reduce(${result_var}, fn($carry, $e) => $carry && count(array_filter($e, fn($v) => $v !== 0.0)) > 0, true)"
1617 )
1618 }
1619 "embeddings_normalized" => {
1620 format!(
1621 "array_reduce(${result_var}, fn($carry, $e) => $carry && abs(array_sum(array_map(fn($v) => $v * $v, $e)) - 1.0) < 1e-3, true)"
1622 )
1623 }
1624 _ => unreachable!(),
1625 };
1626 let assertion_kind = format!("embeddings_{}", f.strip_prefix("embeddings_").unwrap_or(f));
1627 out.push_str(&crate::template_env::render(
1628 "php/synthetic_assertion.jinja",
1629 minijinja::context! {
1630 assertion_kind => assertion_kind,
1631 assertion_type => assertion.assertion_type.as_str(),
1632 pred => pred,
1633 field_name => f,
1634 },
1635 ));
1636 return;
1637 }
1638 "keywords" | "keywords_count" => {
1641 out.push_str(&crate::template_env::render(
1642 "php/synthetic_assertion.jinja",
1643 minijinja::context! {
1644 assertion_kind => "keywords",
1645 field_name => f,
1646 },
1647 ));
1648 return;
1649 }
1650 _ => {}
1651 }
1652 }
1653
1654 if let Some(f) = &assertion.field {
1657 if !f.is_empty() && crate::codegen::streaming_assertions::is_streaming_virtual_field(f) {
1658 if let Some(expr) =
1659 crate::codegen::streaming_assertions::StreamingFieldResolver::accessor(f, "php", "chunks")
1660 {
1661 let line = match assertion.assertion_type.as_str() {
1662 "count_min" => {
1663 if let Some(n) = assertion.value.as_ref().and_then(|v| v.as_u64()) {
1664 format!(
1665 " $this->assertGreaterThanOrEqual({n}, count({expr}), 'expected >= {n} chunks');\n"
1666 )
1667 } else {
1668 String::new()
1669 }
1670 }
1671 "count_equals" => {
1672 if let Some(n) = assertion.value.as_ref().and_then(|v| v.as_u64()) {
1673 format!(" $this->assertCount({n}, {expr});\n")
1674 } else {
1675 String::new()
1676 }
1677 }
1678 "equals" => {
1679 if let Some(serde_json::Value::String(s)) = &assertion.value {
1680 let escaped = s.replace('\\', "\\\\").replace('\'', "\\'");
1681 format!(" $this->assertEquals('{escaped}', {expr});\n")
1682 } else if let Some(n) = assertion.value.as_ref().and_then(|v| v.as_u64()) {
1683 format!(" $this->assertEquals({n}, {expr});\n")
1684 } else {
1685 String::new()
1686 }
1687 }
1688 "not_empty" => format!(" $this->assertNotEmpty({expr});\n"),
1689 "is_empty" => format!(" $this->assertEmpty({expr});\n"),
1690 "is_true" => format!(" $this->assertTrue({expr});\n"),
1691 "is_false" => format!(" $this->assertFalse({expr});\n"),
1692 "greater_than" => {
1693 if let Some(n) = assertion.value.as_ref().and_then(|v| v.as_u64()) {
1694 format!(" $this->assertGreaterThan({n}, {expr});\n")
1695 } else {
1696 String::new()
1697 }
1698 }
1699 "greater_than_or_equal" => {
1700 if let Some(n) = assertion.value.as_ref().and_then(|v| v.as_u64()) {
1701 format!(" $this->assertGreaterThanOrEqual({n}, {expr});\n")
1702 } else {
1703 String::new()
1704 }
1705 }
1706 "contains" => {
1707 if let Some(serde_json::Value::String(s)) = &assertion.value {
1708 let escaped = s.replace('\\', "\\\\").replace('\'', "\\'");
1709 format!(" $this->assertStringContainsString('{escaped}', {expr});\n")
1710 } else {
1711 String::new()
1712 }
1713 }
1714 _ => format!(
1715 " // streaming field '{f}': assertion type '{}' not rendered\n",
1716 assertion.assertion_type
1717 ),
1718 };
1719 if !line.is_empty() {
1720 out.push_str(&line);
1721 }
1722 }
1723 return;
1724 }
1725 }
1726
1727 if let Some(f) = &assertion.field {
1729 if !f.is_empty() && !field_resolver.is_valid_for_result(f) {
1730 out.push_str(&crate::template_env::render(
1731 "php/synthetic_assertion.jinja",
1732 minijinja::context! {
1733 assertion_kind => "skipped",
1734 field_name => f,
1735 },
1736 ));
1737 return;
1738 }
1739 }
1740
1741 if result_is_simple {
1744 if let Some(f) = &assertion.field {
1745 let f_lower = f.to_lowercase();
1746 if !f.is_empty()
1747 && f_lower != "content"
1748 && (f_lower.starts_with("metadata")
1749 || f_lower.starts_with("document")
1750 || f_lower.starts_with("structure"))
1751 {
1752 out.push_str(&crate::template_env::render(
1753 "php/synthetic_assertion.jinja",
1754 minijinja::context! {
1755 assertion_kind => "result_is_simple",
1756 field_name => f,
1757 },
1758 ));
1759 return;
1760 }
1761 }
1762 }
1763
1764 let field_expr = match &assertion.field {
1765 _ if result_is_simple => format!("${result_var}"),
1769 Some(f) if !f.is_empty() => {
1770 if let Some((var_name, _)) = fields_array_bindings.get(f) {
1772 format!("${}", var_name)
1773 } else {
1774 field_resolver.accessor(f, "php", &format!("${result_var}"))
1775 }
1776 }
1777 _ => format!("${result_var}"),
1778 };
1779
1780 let field_is_array = assertion.field.as_ref().map_or(result_is_array, |f| {
1783 if f.is_empty() {
1784 result_is_array
1785 } else {
1786 field_resolver.is_array(f)
1787 }
1788 });
1789
1790 let trimmed_field_expr_for = |expected: &serde_json::Value| -> String {
1794 if expected.is_string() {
1795 format!("trim({})", field_expr)
1796 } else {
1797 field_expr.clone()
1798 }
1799 };
1800
1801 let assertion_type = assertion.assertion_type.as_str();
1803 let has_php_val = assertion.value.is_some();
1804 let php_val = match assertion.value.as_ref() {
1808 Some(v) => json_to_php(v),
1809 None if assertion_type == "equals" => "null".to_string(),
1810 None => String::new(),
1811 };
1812 let trimmed_field_expr = trimmed_field_expr_for(assertion.value.as_ref().unwrap_or(&serde_json::Value::Null));
1813 let is_string_val = assertion.value.as_ref().is_some_and(|v| v.is_string());
1814 let values_php: Vec<String> = assertion
1818 .values
1819 .as_ref()
1820 .map(|vals| vals.iter().map(json_to_php).collect::<Vec<_>>())
1821 .or_else(|| assertion.value.as_ref().map(|v| vec![json_to_php(v)]))
1822 .unwrap_or_default();
1823 let contains_any_checks: Vec<String> = assertion
1824 .values
1825 .as_ref()
1826 .map_or(Vec::new(), |vals| vals.iter().map(json_to_php).collect());
1827 let n = assertion.value.as_ref().and_then(|v| v.as_u64()).unwrap_or(0);
1828
1829 let call_expr = if let Some(method_name) = &assertion.method {
1831 build_php_method_call(result_var, method_name, assertion.args.as_ref())
1832 } else {
1833 String::new()
1834 };
1835 let check = assertion.check.as_deref().unwrap_or("is_true");
1836 let has_php_check_val = matches!(assertion.assertion_type.as_str(), "method_result") && assertion.value.is_some();
1837 let php_check_val = if matches!(assertion.assertion_type.as_str(), "method_result") {
1838 assertion.value.as_ref().map(json_to_php).unwrap_or_default()
1839 } else {
1840 String::new()
1841 };
1842 let check_n = assertion.value.as_ref().and_then(|v| v.as_u64()).unwrap_or(0);
1843 let is_bool_val = assertion.value.as_ref().is_some_and(|v| v.is_boolean());
1844 let bool_is_true = assertion.value.as_ref().and_then(|v| v.as_bool()).unwrap_or(false);
1845
1846 if matches!(assertion_type, "not_error" | "error") {
1848 if assertion_type == "not_error" {
1849 }
1851 return;
1853 }
1854
1855 let rendered = crate::template_env::render(
1856 "php/assertion.jinja",
1857 minijinja::context! {
1858 assertion_type => assertion_type,
1859 field_expr => field_expr,
1860 php_val => php_val,
1861 has_php_val => has_php_val,
1862 trimmed_field_expr => trimmed_field_expr,
1863 is_string_val => is_string_val,
1864 field_is_array => field_is_array,
1865 values_php => values_php,
1866 contains_any_checks => contains_any_checks,
1867 n => n,
1868 call_expr => call_expr,
1869 check => check,
1870 php_check_val => php_check_val,
1871 has_php_check_val => has_php_check_val,
1872 check_n => check_n,
1873 is_bool_val => is_bool_val,
1874 bool_is_true => bool_is_true,
1875 },
1876 );
1877 let _ = write!(out, " {}", rendered);
1878}
1879
1880fn build_php_method_call(result_var: &str, method_name: &str, args: Option<&serde_json::Value>) -> String {
1887 let extra_args = if let Some(args_val) = args {
1888 args_val
1889 .as_object()
1890 .map(|obj| {
1891 obj.values()
1892 .map(|v| match v {
1893 serde_json::Value::String(s) => format!("\"{}\"", s.replace('\\', "\\\\").replace('"', "\\\"")),
1894 serde_json::Value::Bool(true) => "true".to_string(),
1895 serde_json::Value::Bool(false) => "false".to_string(),
1896 serde_json::Value::Number(n) => n.to_string(),
1897 serde_json::Value::Null => "null".to_string(),
1898 other => format!("\"{}\"", other.to_string().replace('\\', "\\\\").replace('"', "\\\"")),
1899 })
1900 .collect::<Vec<_>>()
1901 .join(", ")
1902 })
1903 .unwrap_or_default()
1904 } else {
1905 String::new()
1906 };
1907
1908 if extra_args.is_empty() {
1909 format!("${result_var}->{method_name}()")
1910 } else {
1911 format!("${result_var}->{method_name}({extra_args})")
1912 }
1913}
1914
1915fn filter_empty_enum_strings(value: &serde_json::Value) -> serde_json::Value {
1919 match value {
1920 serde_json::Value::Object(map) => {
1921 let filtered: serde_json::Map<String, serde_json::Value> = map
1922 .iter()
1923 .filter_map(|(k, v)| {
1924 if let serde_json::Value::String(s) = v {
1926 if s.is_empty() {
1927 return None;
1928 }
1929 }
1930 Some((k.clone(), filter_empty_enum_strings(v)))
1932 })
1933 .collect();
1934 serde_json::Value::Object(filtered)
1935 }
1936 serde_json::Value::Array(arr) => {
1937 let filtered: Vec<serde_json::Value> = arr.iter().map(filter_empty_enum_strings).collect();
1938 serde_json::Value::Array(filtered)
1939 }
1940 other => other.clone(),
1941 }
1942}
1943
1944fn json_to_php(value: &serde_json::Value) -> String {
1946 match value {
1947 serde_json::Value::String(s) => format!("\"{}\"", escape_php(s)),
1948 serde_json::Value::Bool(true) => "true".to_string(),
1949 serde_json::Value::Bool(false) => "false".to_string(),
1950 serde_json::Value::Number(n) => n.to_string(),
1951 serde_json::Value::Null => "null".to_string(),
1952 serde_json::Value::Array(arr) => {
1953 let items: Vec<String> = arr.iter().map(json_to_php).collect();
1954 format!("[{}]", items.join(", "))
1955 }
1956 serde_json::Value::Object(map) => {
1957 let items: Vec<String> = map
1958 .iter()
1959 .map(|(k, v)| format!("\"{}\" => {}", escape_php(k), json_to_php(v)))
1960 .collect();
1961 format!("[{}]", items.join(", "))
1962 }
1963 }
1964}
1965
1966fn json_to_php_camel_keys(value: &serde_json::Value) -> String {
1971 match value {
1972 serde_json::Value::Object(map) => {
1973 let items: Vec<String> = map
1974 .iter()
1975 .map(|(k, v)| {
1976 let camel_key = k.to_lower_camel_case();
1977 format!("\"{}\" => {}", escape_php(&camel_key), json_to_php_camel_keys(v))
1978 })
1979 .collect();
1980 format!("[{}]", items.join(", "))
1981 }
1982 serde_json::Value::Array(arr) => {
1983 let items: Vec<String> = arr.iter().map(json_to_php_camel_keys).collect();
1984 format!("[{}]", items.join(", "))
1985 }
1986 _ => json_to_php(value),
1987 }
1988}
1989
1990fn build_php_visitor(setup_lines: &mut Vec<String>, visitor_spec: &crate::fixture::VisitorSpec) {
1996 setup_lines.push("$visitor = new class {".to_string());
1997 for (method_name, action) in &visitor_spec.callbacks {
1998 emit_php_visitor_method(setup_lines, method_name, action);
1999 }
2000 setup_lines.push("};".to_string());
2001}
2002
2003fn emit_php_visitor_method(setup_lines: &mut Vec<String>, method_name: &str, action: &CallbackAction) {
2005 let params = match method_name {
2006 "visit_link" => "$ctx, $href, $text, $title",
2007 "visit_image" => "$ctx, $src, $alt, $title",
2008 "visit_heading" => "$ctx, $level, $text, $id",
2009 "visit_code_block" => "$ctx, $lang, $code",
2010 "visit_code_inline"
2011 | "visit_strong"
2012 | "visit_emphasis"
2013 | "visit_strikethrough"
2014 | "visit_underline"
2015 | "visit_subscript"
2016 | "visit_superscript"
2017 | "visit_mark"
2018 | "visit_button"
2019 | "visit_summary"
2020 | "visit_figcaption"
2021 | "visit_definition_term"
2022 | "visit_definition_description" => "$ctx, $text",
2023 "visit_text" => "$ctx, $text",
2024 "visit_list_item" => "$ctx, $ordered, $marker, $text",
2025 "visit_blockquote" => "$ctx, $content, $depth",
2026 "visit_table_row" => "$ctx, $cells, $isHeader",
2027 "visit_custom_element" => "$ctx, $tagName, $html",
2028 "visit_form" => "$ctx, $actionUrl, $method",
2029 "visit_input" => "$ctx, $input_type, $name, $value",
2030 "visit_audio" | "visit_video" | "visit_iframe" => "$ctx, $src",
2031 "visit_details" => "$ctx, $isOpen",
2032 "visit_element_end" | "visit_table_end" | "visit_definition_list_end" | "visit_figure_end" => "$ctx, $output",
2033 "visit_list_start" => "$ctx, $ordered",
2034 "visit_list_end" => "$ctx, $ordered, $output",
2035 _ => "$ctx",
2036 };
2037
2038 let (action_type, action_value, return_form) = match action {
2039 CallbackAction::Skip => ("skip", String::new(), "dict"),
2040 CallbackAction::Continue => ("continue", String::new(), "dict"),
2041 CallbackAction::PreserveHtml => ("preserve_html", String::new(), "dict"),
2042 CallbackAction::Custom { output } => ("custom", escape_php(output), "dict"),
2043 CallbackAction::CustomTemplate { template, return_form } => {
2044 let form = match return_form {
2045 TemplateReturnForm::Dict => "dict",
2046 TemplateReturnForm::BareString => "bare_string",
2047 };
2048 ("custom_template", escape_php(template), form)
2049 }
2050 };
2051
2052 let rendered = crate::template_env::render(
2053 "php/visitor_method.jinja",
2054 minijinja::context! {
2055 method_name => method_name,
2056 params => params,
2057 action_type => action_type,
2058 action_value => action_value,
2059 return_form => return_form,
2060 },
2061 );
2062 for line in rendered.lines() {
2063 setup_lines.push(line.to_string());
2064 }
2065}
2066
2067fn is_php_reserved_type(name: &str) -> bool {
2069 matches!(
2070 name.to_ascii_lowercase().as_str(),
2071 "string"
2072 | "int"
2073 | "integer"
2074 | "float"
2075 | "double"
2076 | "bool"
2077 | "boolean"
2078 | "array"
2079 | "object"
2080 | "null"
2081 | "void"
2082 | "callable"
2083 | "iterable"
2084 | "never"
2085 | "self"
2086 | "parent"
2087 | "static"
2088 | "true"
2089 | "false"
2090 | "mixed"
2091 )
2092}