1mod answers;
8mod executors;
9mod plan_builders;
10mod types;
11
12use std::path::Path;
13
14use anyhow::anyhow;
15
16use crate::plan::*;
17use crate::platform_setup::{
18 persist_static_routes_artifact, persist_telemetry_artifact, persist_tunnel_artifact,
19};
20
21pub use answers::{emit_answers, encrypt_secret_answers, load_answers, prompt_secret_answers};
23pub use executors::{
24 auto_install_provider_packs, domain_from_provider_id, execute_add_packs_to_bundle,
25 execute_apply_pack_setup, execute_build_flow_index, execute_copy_resolved_manifests,
26 execute_create_bundle, execute_remove_provider_artifacts, execute_resolve_packs,
27 execute_validate_bundle, execute_write_gmap_rules, find_provider_pack_source,
28 get_pack_target_dir, invoke_setup_component_operation,
29};
30pub use plan_builders::{
31 apply_create, apply_remove, apply_update, build_metadata, build_metadata_with_ops,
32 compute_simple_hash, dedup_sorted, extract_default_from_help, infer_default_value,
33 infer_update_ops, normalize_tenants, print_plan_summary,
34};
35pub use types::{LoadedAnswers, SetupConfig, SetupRequest};
36
37pub struct SetupEngine {
39 config: SetupConfig,
40}
41
42impl SetupEngine {
43 pub fn new(config: SetupConfig) -> Self {
44 Self { config }
45 }
46
47 pub fn plan(
49 &self,
50 mode: SetupMode,
51 request: &SetupRequest,
52 dry_run: bool,
53 ) -> anyhow::Result<SetupPlan> {
54 match mode {
55 SetupMode::Create => apply_create(request, dry_run),
56 SetupMode::Update => apply_update(request, dry_run),
57 SetupMode::Remove => apply_remove(request, dry_run),
58 }
59 }
60
61 pub fn print_plan(&self, plan: &SetupPlan) {
63 print_plan_summary(plan);
64 }
65
66 pub fn config(&self) -> &SetupConfig {
68 &self.config
69 }
70
71 pub fn execute(&self, plan: &SetupPlan) -> anyhow::Result<SetupExecutionReport> {
76 if plan.dry_run {
77 return Err(anyhow!("cannot execute a dry-run plan"));
78 }
79
80 let bundle = &plan.bundle;
81 let mut report = SetupExecutionReport {
82 bundle: bundle.clone(),
83 resolved_packs: Vec::new(),
84 resolved_manifests: Vec::new(),
85 provider_updates: 0,
86 pending_setup_actions: Vec::new(),
87 warnings: Vec::new(),
88 };
89
90 for step in &plan.steps {
91 match step.kind {
92 SetupStepKind::NoOp => {
93 if self.config.verbose {
94 println!(" [skip] {}", step.description);
95 }
96 }
97 SetupStepKind::CreateBundle => {
98 execute_create_bundle(bundle, &plan.metadata)?;
99 if self.config.verbose {
100 println!(" [done] {}", step.description);
101 }
102 }
103 SetupStepKind::ResolvePacks => {
104 let resolved = execute_resolve_packs(bundle, &plan.metadata)?;
105 report.resolved_packs.extend(resolved);
106 if self.config.verbose {
107 println!(" [done] {}", step.description);
108 }
109 }
110 SetupStepKind::AddPacksToBundle => {
111 if !plan.metadata.providers_remove.is_empty() {
112 report.provider_updates += execute_remove_provider_artifacts(
113 bundle,
114 &plan.metadata.providers_remove,
115 )?;
116 }
117 execute_add_packs_to_bundle(bundle, &report.resolved_packs)?;
118 let _ = crate::deployment_targets::persist_explicit_deployment_targets(
119 bundle,
120 &plan.metadata.deployment_targets,
121 );
122 if self.config.verbose {
123 println!(" [done] {}", step.description);
124 }
125 }
126 SetupStepKind::ValidateCapabilities => {
127 let cap_report = crate::capabilities::validate_and_upgrade_packs(bundle)?;
128 for warn in &cap_report.warnings {
129 report.warnings.push(warn.message.clone());
130 }
131 if self.config.verbose {
132 println!(
133 " [done] {} (checked={}, upgraded={})",
134 step.description,
135 cap_report.checked,
136 cap_report.upgraded.len()
137 );
138 }
139 }
140 SetupStepKind::ApplyPackSetup => {
141 let setup_report =
142 execute_apply_pack_setup(bundle, &plan.metadata, &self.config)?;
143 report.provider_updates += setup_report.provider_updates;
144 report
145 .pending_setup_actions
146 .extend(setup_report.pending_setup_actions);
147 if self.config.verbose {
148 println!(" [done] {}", step.description);
149 }
150 }
151 SetupStepKind::WriteGmapRules => {
152 execute_write_gmap_rules(bundle, &plan.metadata)?;
153 if self.config.verbose {
154 println!(" [done] {}", step.description);
155 }
156 }
157 SetupStepKind::RunResolver => {
158 if self.config.verbose {
160 println!(" [skip] {} (deferred to runtime)", step.description);
161 }
162 }
163 SetupStepKind::CopyResolvedManifest => {
164 let manifests = execute_copy_resolved_manifests(bundle, &plan.metadata)?;
165 report.resolved_manifests.extend(manifests);
166 if self.config.verbose {
167 println!(" [done] {}", step.description);
168 }
169 }
170 SetupStepKind::ValidateBundle => {
171 execute_validate_bundle(bundle)?;
172 if self.config.verbose {
173 println!(" [done] {}", step.description);
174 }
175 }
176 SetupStepKind::BuildFlowIndex => {
177 execute_build_flow_index(bundle, &self.config)?;
178 if self.config.verbose {
179 println!(" [done] {}", step.description);
180 }
181 }
182 }
183 }
184
185 persist_static_routes_artifact(bundle, &plan.metadata.static_routes)?;
188 let _ = crate::deployment_targets::persist_explicit_deployment_targets(
189 bundle,
190 &plan.metadata.deployment_targets,
191 );
192 if let Some(tunnel) = plan.metadata.tunnel.as_ref() {
193 let _ = persist_tunnel_artifact(bundle, tunnel);
194 }
195 if let Some(telemetry) = plan.metadata.telemetry.as_ref() {
196 let _ = persist_telemetry_artifact(bundle, telemetry);
197 }
198
199 Ok(report)
200 }
201
202 pub fn emit_answers(
207 &self,
208 plan: &SetupPlan,
209 output_path: &Path,
210 key: Option<&str>,
211 interactive: bool,
212 ) -> anyhow::Result<()> {
213 emit_answers(&self.config, plan, output_path, key, interactive)
214 }
215
216 pub fn load_answers(
218 &self,
219 answers_path: &Path,
220 key: Option<&str>,
221 interactive: bool,
222 ) -> anyhow::Result<LoadedAnswers> {
223 load_answers(answers_path, key, interactive)
224 }
225}
226
227#[cfg(test)]
228mod tests {
229 use super::*;
230 use crate::bundle;
231 use crate::platform_setup::{StaticRoutesPolicy, static_routes_artifact_path};
232 use serde_json::json;
233 use std::collections::BTreeSet;
234 use std::path::PathBuf;
235
236 fn empty_request(bundle: PathBuf) -> SetupRequest {
237 SetupRequest {
238 bundle,
239 bundle_name: None,
240 pack_refs: Vec::new(),
241 tenants: vec![TenantSelection {
242 tenant: "demo".to_string(),
243 team: Some("default".to_string()),
244 allow_paths: vec!["packs/default".to_string()],
245 }],
246 default_assignments: Vec::new(),
247 providers: Vec::new(),
248 update_ops: BTreeSet::new(),
249 remove_targets: BTreeSet::new(),
250 packs_remove: Vec::new(),
251 providers_remove: Vec::new(),
252 tenants_remove: Vec::new(),
253 access_changes: Vec::new(),
254 static_routes: StaticRoutesPolicy::default(),
255 setup_answers: serde_json::Map::new(),
256 ..Default::default()
257 }
258 }
259
260 #[test]
261 fn create_plan_is_deterministic() {
262 let req = SetupRequest {
263 bundle: PathBuf::from("bundle"),
264 bundle_name: None,
265 pack_refs: vec![
266 "repo://zeta/pack@1".to_string(),
267 "repo://alpha/pack@1".to_string(),
268 "repo://alpha/pack@1".to_string(),
269 ],
270 tenants: vec![
271 TenantSelection {
272 tenant: "demo".to_string(),
273 team: Some("default".to_string()),
274 allow_paths: vec!["pack/b".to_string(), "pack/a".to_string()],
275 },
276 TenantSelection {
277 tenant: "alpha".to_string(),
278 team: None,
279 allow_paths: vec!["x".to_string()],
280 },
281 ],
282 default_assignments: Vec::new(),
283 providers: Vec::new(),
284 update_ops: BTreeSet::new(),
285 remove_targets: BTreeSet::new(),
286 packs_remove: Vec::new(),
287 providers_remove: Vec::new(),
288 tenants_remove: Vec::new(),
289 access_changes: Vec::new(),
290 static_routes: StaticRoutesPolicy::default(),
291 setup_answers: serde_json::Map::new(),
292 ..Default::default()
293 };
294 let plan = apply_create(&req, true).unwrap();
295 assert_eq!(
296 plan.metadata.pack_refs,
297 vec![
298 "repo://alpha/pack@1".to_string(),
299 "repo://zeta/pack@1".to_string()
300 ]
301 );
302 assert_eq!(plan.metadata.tenants[0].tenant, "alpha");
303 assert_eq!(
304 plan.metadata.tenants[1].allow_paths,
305 vec!["pack/a".to_string(), "pack/b".to_string()]
306 );
307 }
308
309 #[test]
310 fn dry_run_does_not_create_files() {
311 let bundle = PathBuf::from("/tmp/nonexistent-bundle");
312 let req = empty_request(bundle.clone());
313 let _plan = apply_create(&req, true).unwrap();
314 assert!(!bundle.exists());
315 }
316
317 #[test]
318 fn create_requires_tenants() {
319 let req = SetupRequest {
320 tenants: vec![],
321 ..empty_request(PathBuf::from("x"))
322 };
323 assert!(apply_create(&req, true).is_err());
324 }
325
326 #[test]
327 fn load_answers_reads_platform_setup_and_provider_answers() {
328 let temp = tempfile::tempdir().unwrap();
329 let answers_path = temp.path().join("answers.yaml");
330 std::fs::write(
331 &answers_path,
332 r#"
333bundle_source: ./bundle
334tenant: acme
335team: core
336env: prod
337platform_setup:
338 static_routes:
339 public_web_enabled: true
340 public_base_url: https://example.com/base/
341 deployment_targets:
342 - target: aws
343 provider_pack: packs/aws.gtpack
344 default: true
345setup_answers:
346 messaging-webchat:
347 jwt_signing_key: abc
348"#,
349 )
350 .unwrap();
351
352 let loaded = load_answers(&answers_path, None, false).unwrap();
353 assert_eq!(
354 loaded
355 .platform_setup
356 .static_routes
357 .as_ref()
358 .and_then(|v| v.public_base_url.as_deref()),
359 Some("https://example.com/base/")
360 );
361 assert_eq!(
362 loaded
363 .setup_answers
364 .get("messaging-webchat")
365 .and_then(|v| v.get("jwt_signing_key"))
366 .and_then(serde_json::Value::as_str),
367 Some("abc")
368 );
369 assert_eq!(loaded.tenant.as_deref(), Some("acme"));
370 assert_eq!(loaded.team.as_deref(), Some("core"));
371 assert_eq!(loaded.env.as_deref(), Some("prod"));
372 assert_eq!(loaded.platform_setup.deployment_targets.len(), 1);
373 assert_eq!(loaded.platform_setup.deployment_targets[0].target, "aws");
374 }
375
376 #[test]
377 fn emit_answers_includes_platform_setup() {
378 let temp = tempfile::tempdir().unwrap();
379 let bundle_root = temp.path().join("bundle");
380 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
381
382 let engine = SetupEngine::new(SetupConfig {
383 tenant: "demo".into(),
384 team: None,
385 env: "prod".into(),
386 offline: false,
387 verbose: false,
388 });
389 let request = SetupRequest {
390 bundle: bundle_root.clone(),
391 tenants: vec![TenantSelection {
392 tenant: "demo".into(),
393 team: None,
394 allow_paths: Vec::new(),
395 }],
396 static_routes: StaticRoutesPolicy {
397 public_web_enabled: true,
398 public_base_url: Some("https://example.com".into()),
399 public_surface_policy: "enabled".into(),
400 default_route_prefix_policy: "pack_declared".into(),
401 tenant_path_policy: "pack_declared".into(),
402 ..StaticRoutesPolicy::default()
403 },
404 ..Default::default()
405 };
406 let plan = engine.plan(SetupMode::Create, &request, true).unwrap();
407 let output = temp.path().join("answers.json");
408 engine.emit_answers(&plan, &output, None, false).unwrap();
409 let emitted: serde_json::Value =
410 serde_json::from_str(&std::fs::read_to_string(output).unwrap()).unwrap();
411 assert_eq!(
412 emitted["platform_setup"]["static_routes"]["public_base_url"],
413 json!("https://example.com")
414 );
415 assert_eq!(emitted["platform_setup"]["deployment_targets"], json!([]));
416 }
417
418 #[test]
419 fn emit_answers_falls_back_to_runtime_public_endpoint() {
420 let temp = tempfile::tempdir().unwrap();
421 let bundle_root = temp.path().join("bundle");
422 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
423 let runtime_dir = bundle_root
424 .join("state")
425 .join("runtime")
426 .join("demo.default");
427 std::fs::create_dir_all(&runtime_dir).unwrap();
428 std::fs::write(
429 runtime_dir.join("endpoints.json"),
430 r#"{"tenant":"demo","team":"default","public_base_url":"https://runtime.example.com"}"#,
431 )
432 .unwrap();
433
434 let engine = SetupEngine::new(SetupConfig {
435 tenant: "demo".into(),
436 team: Some("default".into()),
437 env: "prod".into(),
438 offline: false,
439 verbose: false,
440 });
441 let request = SetupRequest {
442 bundle: bundle_root.clone(),
443 tenants: vec![TenantSelection {
444 tenant: "demo".into(),
445 team: Some("default".into()),
446 allow_paths: Vec::new(),
447 }],
448 ..Default::default()
449 };
450 let plan = engine.plan(SetupMode::Create, &request, true).unwrap();
451 let output = temp.path().join("answers-runtime.json");
452 engine.emit_answers(&plan, &output, None, false).unwrap();
453 let emitted: serde_json::Value =
454 serde_json::from_str(&std::fs::read_to_string(output).unwrap()).unwrap();
455 assert_eq!(
456 emitted["platform_setup"]["static_routes"]["public_base_url"],
457 json!("https://runtime.example.com")
458 );
459 }
460
461 #[test]
462 fn execute_persists_static_routes_artifact() {
463 let temp = tempfile::tempdir().unwrap();
464 let bundle_root = temp.path().join("bundle");
465 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
466
467 let engine = SetupEngine::new(SetupConfig {
468 tenant: "demo".into(),
469 team: None,
470 env: "prod".into(),
471 offline: false,
472 verbose: false,
473 });
474 let mut metadata = build_metadata(&empty_request(bundle_root.clone()), Vec::new(), vec![]);
475 metadata.static_routes = StaticRoutesPolicy {
476 public_web_enabled: true,
477 public_base_url: Some("https://example.com".into()),
478 public_surface_policy: "enabled".into(),
479 default_route_prefix_policy: "pack_declared".into(),
480 tenant_path_policy: "pack_declared".into(),
481 ..StaticRoutesPolicy::default()
482 };
483
484 execute_apply_pack_setup(&bundle_root, &metadata, engine.config()).unwrap();
485 let artifact = static_routes_artifact_path(&bundle_root);
486 assert!(artifact.exists());
487 let stored: serde_json::Value =
488 serde_json::from_str(&std::fs::read_to_string(artifact).unwrap()).unwrap();
489 assert_eq!(stored["public_web_enabled"], json!(true));
490 }
491
492 #[test]
493 fn setup_actions_are_persisted_and_stripped_from_provider_config() {
494 let temp = tempfile::tempdir().unwrap();
506 let bundle_root = temp.path().to_path_buf();
507
508 let answers = json!({
509 "bot_token": "secret",
510 "setup_actions": [{
511 "id": "install",
512 "kind": "oauth_install_button",
513 "label": "Add to Example",
514 "authorize_url": "https://example.com/oauth"
515 }]
516 });
517
518 let actions = crate::setup_actions::extract_setup_actions(
519 "messaging-example",
520 "demo",
521 Some("default"),
522 &answers,
523 )
524 .unwrap();
525 assert_eq!(actions.len(), 1);
526 assert_eq!(
527 actions[0].kind,
528 crate::setup_actions::SetupActionKind::OauthInstallButton
529 );
530
531 crate::setup_actions::persist_setup_actions(&bundle_root, &actions).unwrap();
532 let action_path = crate::setup_actions::setup_actions_state_path(
533 &bundle_root,
534 "demo",
535 "default",
536 "messaging-example",
537 );
538 assert!(action_path.exists());
539 let state: crate::setup_actions::SetupActionStateFile =
540 serde_json::from_str(&std::fs::read_to_string(&action_path).unwrap()).unwrap();
541 assert_eq!(state.actions.len(), 1);
542 assert_eq!(state.actions[0].id, "install");
543
544 let persisted = crate::setup_actions::strip_setup_actions(&answers);
546 assert!(persisted.get("setup_actions").is_none());
547 assert_eq!(persisted["bot_token"], json!("secret"));
548 }
549
550 #[test]
551 fn execute_apply_pack_setup_persists_pack_declared_setup_actions() {
552 use std::io::Write;
553 use zip::write::{FileOptions, ZipWriter};
554
555 let temp = tempfile::tempdir().unwrap();
556 let bundle_root = temp.path().join("bundle");
557 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
558 let providers_dir = bundle_root.join("providers/messaging");
559 std::fs::create_dir_all(&providers_dir).unwrap();
560 let pack_path = providers_dir.join("messaging-slack.gtpack");
561 let file = std::fs::File::create(&pack_path).unwrap();
562 let mut writer = ZipWriter::new(file);
563 let options: FileOptions<'_, ()> =
564 FileOptions::default().compression_method(zip::CompressionMethod::Stored);
565 writer.start_file("pack.manifest.json", options).unwrap();
566 writer
567 .write_all(
568 json!({
569 "pack_id": "messaging-slack",
570 "display_name": "Slack"
571 })
572 .to_string()
573 .as_bytes(),
574 )
575 .unwrap();
576 writer.start_file("assets/setup.yaml", options).unwrap();
577 writer
578 .write_all(
579 br#"
580title: Slack
581questions: []
582setup_actions:
583 - id: add_to_slack
584 label: Add to Slack
585 kind: oauth_install_button
586 provider_id: slack
587 authorize_url: https://slack.example/install
588"#,
589 )
590 .unwrap();
591 writer.finish().unwrap();
592
593 let engine = SetupEngine::new(SetupConfig {
594 tenant: "demo".into(),
595 team: Some("default".into()),
596 env: "dev".into(),
597 offline: false,
598 verbose: false,
599 });
600 let request = empty_request(bundle_root.clone());
601 let plan = engine.plan(SetupMode::Create, &request, false).unwrap();
602 assert!(
603 plan.steps
604 .iter()
605 .any(|step| step.kind == crate::plan::SetupStepKind::ApplyPackSetup),
606 "pack-declared setup actions should schedule ApplyPackSetup"
607 );
608 let metadata = build_metadata(&request, Vec::new(), vec![]);
609
610 let report = execute_apply_pack_setup(&bundle_root, &metadata, engine.config()).unwrap();
611 assert_eq!(report.pending_setup_actions.len(), 1);
612 assert_eq!(report.pending_setup_actions[0].id, "add_to_slack");
613 assert_eq!(report.pending_setup_actions[0].label, "Add to Slack");
614 assert_eq!(
615 report.pending_setup_actions[0].provider_id,
616 "messaging-slack"
617 );
618 let action_path = crate::setup_actions::setup_actions_state_path(
619 &bundle_root,
620 "demo",
621 "default",
622 "messaging-slack",
623 );
624 assert!(action_path.exists());
625 }
626
627 #[test]
628 fn execute_apply_pack_setup_hydrates_oauth_install_url_from_answers() {
629 let temp = tempfile::tempdir().unwrap();
630 let bundle_root = temp.path().join("bundle");
631 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
632 write_registration_test_pack(
636 &bundle_root,
637 r#"
638title: Example
639questions:
640 - name: workspace_name
641 kind: string
642"#,
643 json!({"operations": {}}),
644 );
645
646 let engine = SetupEngine::new(SetupConfig {
647 tenant: "demo".into(),
648 team: Some("default".into()),
649 env: "dev".into(),
650 offline: false,
651 verbose: false,
652 });
653 let mut request = empty_request(bundle_root.clone());
654 request.setup_answers.insert(
655 "messaging-example".into(),
656 json!({
657 "slack_client_id": "client-123",
658 "setup_actions": [{
659 "id": "install",
660 "kind": "oauth_install_button",
661 "label": "Add",
662 "authorize_url": "https://slack.com/oauth/v2/authorize",
663 "client_id_field": "slack_client_id",
664 "scopes": ["chat:write", "channels:read"]
665 }]
666 }),
667 );
668 let metadata = build_metadata(&request, Vec::new(), vec![]);
669
670 let report = execute_apply_pack_setup(&bundle_root, &metadata, engine.config()).unwrap();
671 let url = report.pending_setup_actions[0]
672 .authorize_url
673 .as_deref()
674 .unwrap();
675 assert!(url.contains("client_id=client-123"), "{url}");
676 assert!(
677 url.contains("scope=chat%3Awrite%2Cchannels%3Aread"),
678 "{url}"
679 );
680 }
681
682 #[test]
683 fn execute_apply_pack_setup_runs_pack_declared_registration_before_oauth_hydration() {
684 let temp = tempfile::tempdir().unwrap();
685 let bundle_root = temp.path().join("bundle");
686 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
687 write_registration_test_pack(
688 &bundle_root,
689 r#"
690title: Example
691questions:
692 - name: workspace_name
693 kind: string
694setup_actions:
695 - id: install
696 label: Add
697 kind: oauth_install_button
698 authorize_url: https://example.com/oauth
699 client_id_source: registration
700 client_id_field: oauth_client_id
701 registration:
702 component_ref: components/registration.json
703 op: register
704 app_name_field: app_name
705 client_id_output: registered_client_id
706 client_secret_output: registered_client_secret
707 app_id_output: registered_app_id
708"#,
709 json!({
710 "operations": {
711 "register": {
712 "result": {
713 "registered_client_id": "client-from-registration",
714 "registered_client_secret": "secret-from-registration",
715 "registered_app_id": "app-from-registration"
716 }
717 }
718 }
719 }),
720 );
721
722 let engine = SetupEngine::new(SetupConfig {
723 tenant: "demo".into(),
724 team: Some("default".into()),
725 env: "dev".into(),
726 offline: false,
727 verbose: false,
728 });
729 let mut request = empty_request(bundle_root.clone());
730 request
731 .setup_answers
732 .insert("messaging-example".into(), json!({"app_name": "Demo App"}));
733 let metadata = build_metadata(&request, Vec::new(), vec![]);
734
735 let report = execute_apply_pack_setup(&bundle_root, &metadata, engine.config()).unwrap();
736 let url = report.pending_setup_actions[0]
737 .authorize_url
738 .as_deref()
739 .unwrap();
740 assert!(url.contains("client_id=client-from-registration"), "{url}");
747 }
748
749 #[test]
750 fn execute_apply_pack_setup_skips_actions_for_disabled_provider() {
751 let temp = tempfile::tempdir().unwrap();
752 let bundle_root = temp.path().join("bundle");
753 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
754 write_registration_test_pack(
755 &bundle_root,
756 r#"
757title: Example
758questions: []
759setup_actions:
760 - id: install
761 label: Add
762 kind: oauth_install_button
763 authorize_url: https://example.com/oauth
764 client_id_source: registration
765 client_id_field: oauth_client_id
766 registration:
767 component_ref: components/registration.json
768 op: register
769 client_id_output: registered_client_id
770"#,
771 json!({
772 "operations": {
773 "register": {
774 "result": {
775 "registered_client_id": "client-from-registration"
776 }
777 }
778 }
779 }),
780 );
781
782 let engine = SetupEngine::new(SetupConfig {
783 tenant: "demo".into(),
784 team: Some("default".into()),
785 env: "dev".into(),
786 offline: false,
787 verbose: false,
788 });
789 let mut request = empty_request(bundle_root.clone());
790 request
791 .setup_answers
792 .insert("messaging-example".into(), json!({"enabled": false}));
793 let metadata = build_metadata(&request, Vec::new(), vec![]);
794
795 let report = execute_apply_pack_setup(&bundle_root, &metadata, engine.config()).unwrap();
796
797 assert!(report.pending_setup_actions.is_empty());
798 assert!(
799 !bundle_root
800 .join("state/config/setup-actions/demo/default/messaging-example.json")
801 .exists()
802 );
803 let setup_answers_path =
804 bundle_root.join("state/config/messaging-example/setup-answers.json");
805 let stored: serde_json::Value =
806 serde_json::from_str(&std::fs::read_to_string(setup_answers_path).unwrap()).unwrap();
807 assert_eq!(stored["enabled"], json!(false));
808 }
809
810 #[test]
811 fn execute_apply_pack_setup_uses_bundle_name_for_registration_app_name_template() {
812 let temp = tempfile::tempdir().unwrap();
813 let bundle_root = temp.path().join("bundle");
814 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
815 write_registration_test_pack(
816 &bundle_root,
817 r#"
818title: Example
819questions:
820 - name: workspace_name
821 kind: string
822setup_actions:
823 - id: install
824 label: Add
825 kind: oauth_install_button
826 authorize_url: https://example.com/oauth
827 client_id_source: registration
828 client_id_field: oauth_client_id
829 app_name_template: "{{ bundle_name }} Slack"
830 default_app_name: "Greentic Slack"
831 registration:
832 component_ref: components/registration.json
833 op: register
834 app_name_field: slack_app_name
835 config_access_token_field: access_token
836 client_id_output: app_name
837 app_id_output: slack_app_name
838"#,
839 json!({
840 "operations": {
841 "register": {
842 "echo_request": true
843 }
844 }
845 }),
846 );
847
848 let engine = SetupEngine::new(SetupConfig {
849 tenant: "demo".into(),
850 team: Some("default".into()),
851 env: "dev".into(),
852 offline: false,
853 verbose: false,
854 });
855 let mut request = empty_request(bundle_root.clone());
856 request.bundle_name = Some("Acme Support".into());
857 request
858 .setup_answers
859 .insert("messaging-example".into(), json!({"access_token": "token"}));
860 let metadata = build_metadata(&request, Vec::new(), vec![]);
861
862 execute_apply_pack_setup(&bundle_root, &metadata, engine.config()).unwrap();
863
864 use greentic_secrets_lib::SecretsStore as _;
871 let store = crate::secrets::open_dev_store(&bundle_root).expect("open dev store");
872 let rt = tokio::runtime::Runtime::new().unwrap();
873 let env = crate::resolve_env(Some("dev"));
875 let read = |key: &str| -> String {
876 let uri = crate::canonical_secret_uri(
877 &env,
878 "demo",
879 Some("default"),
880 "messaging-example",
881 key,
882 );
883 let bytes = rt
884 .block_on(async { store.get(&uri).await })
885 .unwrap_or_else(|_| panic!("missing dev-store key: {key}"));
886 String::from_utf8(bytes).expect("utf8")
887 };
888 assert_eq!(read("slack_app_name"), "Acme Support Slack");
889 assert_eq!(read("app_name"), "Acme Support Slack");
890 }
891
892 #[test]
893 fn execute_apply_pack_setup_registration_failure_does_not_persist_broken_action() {
894 let temp = tempfile::tempdir().unwrap();
895 let bundle_root = temp.path().join("bundle");
896 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
897 write_registration_test_pack(
898 &bundle_root,
899 r#"
900title: Example
901questions: []
902setup_actions:
903 - id: install
904 label: Add
905 kind: oauth_install_button
906 authorize_url: https://example.com/oauth
907 client_id_source: registration
908 registration:
909 component_ref: components/registration.json
910 op: register
911 config_access_token_field: config_token
912 client_id_output: client_id
913"#,
914 json!({"operations": {}}),
915 );
916
917 let engine = SetupEngine::new(SetupConfig {
918 tenant: "demo".into(),
919 team: Some("default".into()),
920 env: "dev".into(),
921 offline: false,
922 verbose: false,
923 });
924 let mut request = empty_request(bundle_root.clone());
925 request
926 .setup_answers
927 .insert("messaging-example".into(), json!({"config_token": "token"}));
928 let metadata = build_metadata(&request, Vec::new(), vec![]);
929
930 let err = execute_apply_pack_setup(&bundle_root, &metadata, engine.config())
931 .expect_err("registration failure should fail setup");
932 assert!(
933 err.to_string()
934 .contains("failed to run setup action registration"),
935 "{err:#}"
936 );
937 let action_path = crate::setup_actions::setup_actions_state_path(
938 &bundle_root,
939 "demo",
940 "default",
941 "messaging-example",
942 );
943 assert!(!action_path.exists());
944 }
945
946 #[test]
947 fn execute_apply_pack_setup_registration_passes_original_input_field_names() {
948 let temp = tempfile::tempdir().unwrap();
949 let bundle_root = temp.path().join("bundle");
950 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
951 write_registration_test_pack(
952 &bundle_root,
953 r#"
954title: Example
955questions:
956 - name: workspace_name
957 kind: string
958setup_actions:
959 - id: install
960 label: Add
961 kind: oauth_install_button
962 authorize_url: https://example.com/oauth
963 client_id_source: registration
964 registration:
965 component_ref: components/registration.json
966 op: register
967 config_access_token_field: provider_specific_token
968 client_id_output: provider_specific_token
969"#,
970 json!({
971 "operations": {
972 "register": {
973 "echo_request": true
974 }
975 }
976 }),
977 );
978
979 let engine = SetupEngine::new(SetupConfig {
980 tenant: "demo".into(),
981 team: Some("default".into()),
982 env: "dev".into(),
983 offline: false,
984 verbose: false,
985 });
986 let mut request = empty_request(bundle_root.clone());
987 request.setup_answers.insert(
988 "messaging-example".into(),
989 json!({"provider_specific_token": "client-from-original-field"}),
990 );
991 let metadata = build_metadata(&request, Vec::new(), vec![]);
992
993 let report = execute_apply_pack_setup(&bundle_root, &metadata, engine.config()).unwrap();
994 let url = report.pending_setup_actions[0]
995 .authorize_url
996 .as_deref()
997 .unwrap();
998 assert!(
999 url.contains("client_id=client-from-original-field"),
1000 "{url}"
1001 );
1002 }
1003
1004 fn write_registration_test_pack(
1005 bundle_root: &std::path::Path,
1006 setup_yaml: &str,
1007 registration_component: serde_json::Value,
1008 ) {
1009 use std::io::Write;
1010 use zip::write::{FileOptions, ZipWriter};
1011
1012 let providers_dir = bundle_root.join("providers/messaging");
1013 std::fs::create_dir_all(&providers_dir).unwrap();
1014 let pack_path = providers_dir.join("messaging-example.gtpack");
1015 let file = std::fs::File::create(&pack_path).unwrap();
1016 let mut writer = ZipWriter::new(file);
1017 let options: FileOptions<'_, ()> =
1018 FileOptions::default().compression_method(zip::CompressionMethod::Stored);
1019 writer.start_file("pack.manifest.json", options).unwrap();
1020 writer
1021 .write_all(
1022 json!({
1023 "pack_id": "messaging-example",
1024 "display_name": "Example"
1025 })
1026 .to_string()
1027 .as_bytes(),
1028 )
1029 .unwrap();
1030 writer.start_file("assets/setup.yaml", options).unwrap();
1031 writer.write_all(setup_yaml.as_bytes()).unwrap();
1032 writer
1033 .start_file("components/registration.json", options)
1034 .unwrap();
1035 writer
1036 .write_all(registration_component.to_string().as_bytes())
1037 .unwrap();
1038 writer.finish().unwrap();
1039 }
1040
1041 #[test]
1042 fn execute_create_persists_platform_metadata_without_provider_steps() {
1043 let temp = tempfile::tempdir().unwrap();
1044 let bundle_root = temp.path().join("bundle");
1045
1046 let engine = SetupEngine::new(SetupConfig {
1047 tenant: "demo".into(),
1048 team: Some("default".into()),
1049 env: "prod".into(),
1050 offline: false,
1051 verbose: false,
1052 });
1053 let request = SetupRequest {
1054 bundle: bundle_root.clone(),
1055 static_routes: StaticRoutesPolicy {
1056 public_web_enabled: true,
1057 public_base_url: Some("https://example.com".into()),
1058 public_surface_policy: "enabled".into(),
1059 default_route_prefix_policy: "pack_declared".into(),
1060 tenant_path_policy: "pack_declared".into(),
1061 ..StaticRoutesPolicy::default()
1062 },
1063 deployment_targets: vec![crate::deployment_targets::DeploymentTargetRecord {
1064 target: "runtime".into(),
1065 provider_pack: None,
1066 default: Some(true),
1067 }],
1068 ..empty_request(bundle_root.clone())
1069 };
1070
1071 let plan = engine.plan(SetupMode::Create, &request, false).unwrap();
1072 engine.execute(&plan).unwrap();
1073
1074 let routes_artifact = static_routes_artifact_path(&bundle_root);
1075 assert!(routes_artifact.exists());
1076
1077 let targets_artifact = bundle_root
1078 .join(".greentic")
1079 .join("deployment-targets.json");
1080 assert!(targets_artifact.exists());
1081 let stored: serde_json::Value =
1082 serde_json::from_str(&std::fs::read_to_string(targets_artifact).unwrap()).unwrap();
1083 assert_eq!(stored["targets"][0]["target"], json!("runtime"));
1084 assert_eq!(stored["targets"][0]["default"], json!(true));
1085 }
1086
1087 #[test]
1088 fn remove_execute_deletes_provider_artifact_and_config_dir() {
1089 let temp = tempfile::tempdir().unwrap();
1090 let bundle_root = temp.path().join("bundle");
1091 bundle::create_demo_bundle_structure(&bundle_root, Some("demo")).unwrap();
1092 let provider_dir = bundle_root.join("providers").join("messaging");
1093 std::fs::create_dir_all(&provider_dir).unwrap();
1094 let provider_pack = provider_dir.join("messaging-webchat.gtpack");
1095 std::fs::copy(
1096 bundle_root.join("packs").join("default.gtpack"),
1097 &provider_pack,
1098 )
1099 .unwrap();
1100 let config_dir = bundle_root
1101 .join("state")
1102 .join("config")
1103 .join("messaging-webchat");
1104 std::fs::create_dir_all(&config_dir).unwrap();
1105 std::fs::write(config_dir.join("setup-answers.json"), "{}").unwrap();
1106
1107 let engine = SetupEngine::new(SetupConfig {
1108 tenant: "demo".into(),
1109 team: None,
1110 env: "prod".into(),
1111 offline: false,
1112 verbose: false,
1113 });
1114 let request = SetupRequest {
1115 bundle: bundle_root.clone(),
1116 providers_remove: vec!["messaging-webchat".into()],
1117 ..Default::default()
1118 };
1119 let plan = engine.plan(SetupMode::Remove, &request, false).unwrap();
1120 engine.execute(&plan).unwrap();
1121
1122 assert!(!provider_pack.exists());
1123 assert!(!config_dir.exists());
1124 }
1125
1126 #[test]
1127 fn update_plan_preserves_static_routes_policy() {
1128 let req = SetupRequest {
1129 bundle: PathBuf::from("bundle"),
1130 tenants: vec![TenantSelection {
1131 tenant: "demo".into(),
1132 team: None,
1133 allow_paths: Vec::new(),
1134 }],
1135 static_routes: StaticRoutesPolicy {
1136 public_web_enabled: true,
1137 public_base_url: Some("https://example.com/new".into()),
1138 public_surface_policy: "enabled".into(),
1139 default_route_prefix_policy: "pack_declared".into(),
1140 tenant_path_policy: "pack_declared".into(),
1141 ..StaticRoutesPolicy::default()
1142 },
1143 ..Default::default()
1144 };
1145 let plan = apply_update(&req, true).unwrap();
1146 assert_eq!(
1147 plan.metadata.static_routes.public_base_url.as_deref(),
1148 Some("https://example.com/new")
1149 );
1150 }
1151
1152 #[test]
1153 fn extract_default_from_help_parses_parenthesized() {
1154 let help = "Slack API base URL (default: https://slack.com/api)";
1155 let result = extract_default_from_help(help);
1156 assert_eq!(result, Some("https://slack.com/api".to_string()));
1157 }
1158
1159 #[test]
1160 fn extract_default_from_help_parses_bracketed() {
1161 let help = "Enable feature [default: true]";
1162 let result = extract_default_from_help(help);
1163 assert_eq!(result, Some("true".to_string()));
1164 }
1165
1166 #[test]
1167 fn extract_default_from_help_case_insensitive() {
1168 let help = "Some setting (Default: custom_value)";
1169 let result = extract_default_from_help(help);
1170 assert_eq!(result, Some("custom_value".to_string()));
1171 }
1172
1173 #[test]
1174 fn extract_default_from_help_returns_none_without_default() {
1175 let help = "Just a plain help text with no default";
1176 let result = extract_default_from_help(help);
1177 assert_eq!(result, None);
1178 }
1179
1180 #[test]
1181 fn infer_default_value_uses_explicit_default() {
1182 use crate::setup_input::SetupQuestion;
1183 let question = SetupQuestion {
1184 name: "api_base_url".to_string(),
1185 kind: "string".to_string(),
1186 required: true,
1187 help: Some("Some help (default: wrong_value)".to_string()),
1188 choices: vec![],
1189 default: Some(json!("https://explicit.com")),
1190 secret: false,
1191 title: None,
1192 visible_if: None,
1193 ..Default::default()
1194 };
1195 let result = infer_default_value(&question);
1196 assert_eq!(result, json!("https://explicit.com"));
1197 }
1198
1199 #[test]
1200 fn infer_default_value_extracts_from_help() {
1201 use crate::setup_input::SetupQuestion;
1202 let question = SetupQuestion {
1203 name: "api_base_url".to_string(),
1204 kind: "string".to_string(),
1205 required: true,
1206 help: Some("Slack API base URL (default: https://slack.com/api)".to_string()),
1207 choices: vec![],
1208 default: None,
1209 secret: false,
1210 title: None,
1211 visible_if: None,
1212 ..Default::default()
1213 };
1214 let result = infer_default_value(&question);
1215 assert_eq!(result, json!("https://slack.com/api"));
1216 }
1217
1218 #[test]
1219 fn infer_default_value_returns_empty_without_default() {
1220 use crate::setup_input::SetupQuestion;
1221 let question = SetupQuestion {
1222 name: "bot_token".to_string(),
1223 kind: "string".to_string(),
1224 required: true,
1225 help: Some("Your bot token".to_string()),
1226 choices: vec![],
1227 default: None,
1228 secret: true,
1229 title: None,
1230 visible_if: None,
1231 ..Default::default()
1232 };
1233 let result = infer_default_value(&question);
1234 assert_eq!(result, json!(""));
1235 }
1236}