git_policy_cli/wrapped_command.rs
1//! What:
2//! Decide what one wrapped Git command does once real Git is known:
3//! forward it,
4//! possibly rewritten,
5//! or stop with policy events or a refusal.
6//! Why:
7//! This is the whole lifecycle of a forwarded command in one place and in the
8//! installed wrapper's order:
9//! unported work is refused,
10//! configuration is loaded only
11//! for commands that need it,
12//! the policy pass runs,
13//! and a real push is stopped until
14//! its own lifecycle exists.
15//! A read-only command never reads configuration and asks
16//! Git at most where it runs.
17//!
18//! In TS you'd write (pseudocode):
19//! ```ts
20//! // const outcome = await runWrappedCommand(stripped, environment, checks);
21//! ```
22
23/// What:
24/// `use` brings names from sibling files into this file;
25/// `super::` means "the parent
26/// module",
27/// where every sibling file of this crate is declared.
28/// Why:
29/// The lifecycle joins control stripping,
30/// the frontier,
31/// configuration and the pass.
32///
33/// In TS you'd write (pseudocode):
34/// ```ts
35/// import { runPolicyPass } from './policy_pass.ts';
36/// ```
37use super::action::ENGINE_FAILURE_EXIT_CODE;
38use super::auto_push_single_flight::PushGit;
39use super::child_environment::environment_with_overlay;
40/// `git add` asks for what it would stage.
41use super::candidate_prediction::CandidateRequest;
42use super::command_options::OptionError;
43use super::command_push::{PushRegion, parse_push_region};
44use super::config_loading::{ConfigLoading, classify_config_loading};
45use super::command_commit::{CommitRegion, parse_commit_region};
46use super::commit_command::{CommitCommand, run_commit_command};
47use super::config_schema::{CliGitConfig, PolicyConfig};
48use super::diagnostics::EngineFailureCode;
49use super::discard_audit::{AuditOutcome, record_audit};
50use super::global_arguments::GlobalOutcome;
51use super::invocation_config::{config_invalid_event, load_identity_config};
52use super::manual_push_lifecycle::manual_push_scope;
53use super::policy_checks::ShippedChecks;
54/// What the command offers its content policies.
55use super::policy_content::LifecycleContent;
56use super::policy_engine::{
57 StageEnd, StageRequest, StageResult, any_policy_applies, pass_exit_code, run_policy_stage,
58};
59use super::policy_events::{PolicyEvent, render_policy_events};
60use super::policy_pass::{PassResult, policies_of_kind, run_policy_pass};
61use super::policy_registry::PolicyId;
62use super::landed_summary::short_name;
63use super::push_failure_notice::{ORPHAN_NOTICE_DIRECTORY, is_machine_read, notice_directory, take_orphaned_failures, take_push_failures_for};
64use super::worktree_removal_rescue::{settle_removals, snapshot_linked_worktrees};
65use super::policy_trigger::Trigger;
66use super::rule_linked_worktree::{LinkedWorktreeDecision, decide_linked_worktree};
67use super::repository_facts::RepositoryFacts;
68use super::repository_location::RepositoryLocation;
69/// Startup recovery as a command step.
70use super::startup_gate::{Gate, recover_for_command};
71/// A valid preparation lease marks a command started by a hook of a live transaction.
72use super::unported::{Unported, unported_from_unavailable, unported_notice};
73use super::worktree_identity::worktree_root;
74use super::wrapper_controls::is_escaped;
75use super::wrapper_invocation::{StrippedInvocation, command_region, command_word};
76/// What:
77/// `OsString` is owned operating-system text of raw bytes.
78/// Sibling the reader might
79/// expect:
80/// `String`,
81/// which must be valid UTF-8.
82/// Why:
83/// Arguments and environment values are never decoded.
84///
85/// In TS you'd write (pseudocode):
86/// ```ts
87/// // string, but byte-preserving.
88/// ```
89use std::ffi::OsString;
90use std::io::Write;
91/// Paths of the probe's working directory.
92use std::path::{Path, PathBuf};
93
94/// What:
95/// How the lifecycle of one wrapped command ended.
96/// An `enum` is a closed set of named
97/// alternatives;
98/// each carries the values its ending needs.
99/// `#[derive(...)]` asks the
100/// compiler to generate copying,
101/// debug printing and `==`.
102/// Why:
103/// The caller either becomes Git with these arguments or exits with this code;
104/// both may first print event lines on standard error.
105///
106/// In TS you'd write (pseudocode):
107/// ```ts
108/// type WrappedOutcome = { kind: 'forward'; args: string[]; stderr: string } | { kind: 'exit'; code: number; stderr: string };
109/// ```
110#[derive(Clone, Debug, Eq, PartialEq)]
111pub enum WrappedOutcome {
112 /// Run real Git with these arguments.
113 Forward {
114 /// The arguments for Git:
115 /// no wrapper control,
116 /// fixed transforms applied.
117 arguments: Vec<OsString>,
118 /// Complete event lines for standard error,
119 /// written before Git starts.
120 stderr: String,
121 },
122 /// Stop without running Git.
123 Exit {
124 /// Process exit code:
125 /// 1 for a policy rejection,
126 /// 2 for a failure or a refusal.
127 code: i32,
128 /// Complete text for standard error.
129 stderr: String,
130 },
131}
132
133/// What:
134/// The ending for a command that needs unported work:
135/// events so far,
136/// then the notice.
137/// `String` is the owned event text;
138/// `&Unported` borrows the reason;
139/// `&str` borrows
140/// the command word.
141/// Why:
142/// Every refusal exits 2,
143/// whether it was found before or inside the policy pass.
144///
145/// In TS you'd write (pseudocode):
146/// ```ts
147/// function refused(events: string, what: Unported, command: string): WrappedOutcome;
148/// ```
149fn refused(events: String, what: &Unported, command: &str) -> WrappedOutcome {
150 // `mut` allows appending the notice after the events.
151 let mut stderr: String = events;
152 // `.as_str()` lends the owned notice as borrowed text.
153 stderr.push_str(unported_notice(what, command).as_str());
154 return WrappedOutcome::Exit {
155 code: ENGINE_FAILURE_EXIT_CODE,
156 stderr,
157 };
158}
159
160/// What:
161/// The ending of a stage that did not let the command proceed,
162/// or nothing when it
163/// did.
164/// `&[PolicyEvent]` borrows every event so far;
165/// `Option<WrappedOutcome>` is "an
166/// ending or nothing".
167/// Why:
168/// The pre-forward pass and the push gate end the same way:
169/// an unavailable stage is
170/// a refusal,
171/// a failed one exits 2,
172/// and an error finding exits 1,
173/// each after the
174/// events gathered so far.
175///
176/// In TS you'd write (pseudocode):
177/// ```ts
178/// function stageEnding(events: PolicyEvent[], end: StageEnd, command: string): WrappedOutcome | undefined;
179/// ```
180fn stage_ending(events: &[PolicyEvent], end: StageEnd, command: &str) -> Option<WrappedOutcome> {
181 let rendered: String = render_policy_events(0, events);
182 // `if let StageEnd::Unavailable(x) = end` runs only for that ending and binds what it carries.
183 if let StageEnd::Unavailable(unavailable) = end {
184 // `Some(x)` is the "present" case of `Option`.
185 return Some(refused(
186 rendered,
187 &unported_from_unavailable(unavailable),
188 command,
189 ));
190 }
191 let code: i32 = pass_exit_code(events, end);
192 if code == 0 {
193 // `None` is the "absent" case: the command may proceed.
194 return None;
195 }
196 return Some(WrappedOutcome::Exit {
197 code,
198 stderr: rendered,
199 });
200}
201
202/// What:
203/// Whether Git's own option table reads the tokens after `push` as a dry run.
204/// `&[OsString]` borrows those tokens,
205/// already free of wrapper controls.
206/// Why:
207/// Only a dry run publishes nothing.
208/// A region the table refuses is not known to be
209/// a dry run,
210/// so it is treated as a real push.
211///
212/// In TS you'd write (pseudocode):
213/// ```ts
214/// function pushIsDryRun(region: string[]): boolean { try { return parsePushRegion(region).isDryRun; } catch { return false; } }
215/// ```
216fn push_is_dry_run(region: &[OsString]) -> bool {
217 // `&[]` is an empty list of wrapper flags: they were removed before this point.
218 let parsed: Result<PushRegion, OptionError> = parse_push_region(region, &[]);
219 // `match` unpacks the `Result`: `Ok` carries the facts, `Err(_)` ignores the refusal.
220 match parsed {
221 Ok(found) => return found.dry_run,
222 Err(_) => return false,
223 }
224}
225
226/// What:
227/// Every shipped policy in registry order:
228/// the built-in ones,
229/// then the optional ones.
230/// Why:
231/// The push gate asks all of them at once,
232/// as the installed wrapper does.
233///
234/// In TS you'd write (pseudocode):
235/// ```ts
236/// const everyPolicy = [...builtInPolicies, ...optionalPolicies];
237/// ```
238fn every_policy() -> Vec<PolicyId> {
239 // `mut` allows appending the second kind.
240 let mut policies: Vec<PolicyId> = policies_of_kind(false);
241 policies.extend(policies_of_kind(true));
242 return policies;
243}
244
245/// What:
246/// Prepare a command that loads configuration:
247/// recover dead transactions,
248/// read the
249/// configuration of the worktree Git reports,
250/// and say what a content policy may
251/// read.
252/// Returns the effective policy settings,
253/// or the ending that stops the command.
254/// `Result<PolicyConfig, WrappedOutcome>` is "settings,
255/// or an ending".
256/// Why:
257/// The order is the installed wrapper's:
258/// dead transactions are recovered before
259/// configuration,
260/// and a commit is refused only after its configuration was accepted,
261/// so an invalid file is always reported as such.
262///
263/// In TS you'd write (pseudocode):
264/// ```ts
265/// async function prepareGuardedCommand(stripped, environment, checks): Promise<PolicyConfig>; // throws the ending
266/// ```
267fn prepare_guarded_command<F: RepositoryFacts>(
268 stripped: &StrippedInvocation,
269 checks: &mut ShippedChecks<F>,
270) -> Result<CliGitConfig, WrappedOutcome> {
271 // `match` unpacks the location answer; a failure to ask Git stops the command.
272 let location: RepositoryLocation = match checks.facts.location() {
273 Ok(found) => found,
274 Err(message) => {
275 return Err(WrappedOutcome::Exit {
276 code: ENGINE_FAILURE_EXIT_CODE,
277 // `format!` builds the owned, line-terminated text.
278 stderr: format!("cli-git: {message}\n"),
279 });
280 }
281 };
282 // An isolated merge whose process died is settled before configuration loads, so the checks that follow never read
283 // its half-finished checkout.
284 match recover_for_command(&checks.facts.transaction_context(), &location.identity) {
285 Gate::Clear => {}
286 Gate::Stop(stderr) => {
287 return Err(WrappedOutcome::Exit {
288 code: ENGINE_FAILURE_EXIT_CODE,
289 stderr,
290 });
291 }
292 }
293 let config: CliGitConfig = match load_identity_config(&location.identity) {
294 Ok(loaded) => loaded.config,
295 Err(error) => {
296 return Err(WrappedOutcome::Exit {
297 code: ENGINE_FAILURE_EXIT_CODE,
298 stderr: config_invalid_event(&error),
299 });
300 }
301 };
302 // `.clone()` copies the scanner and Markdown options the configuration chose.
303 checks.scanner_settings.options = config.policies.forbidden_strings.clone();
304 checks.markdown.options = config.policies.markdown_autofix.clone();
305 // Only `git add` inside a worktree has content for a policy to read before Git runs:
306 // what it would stage, predicted when a content policy first reads it.
307 if command_word(stripped) == b"add" && worktree_root(&location.identity).is_some() {
308 checks.candidates = LifecycleContent::Requested(CandidateRequest::Add(
309 // `.to_vec()` copies the arguments after `add` for the prediction.
310 command_region(stripped).to_vec(),
311 ));
312 }
313 // `Ok(x)` is the success case.
314 return Ok(config);
315}
316
317/// What:
318/// Run a real `git commit` through the commit transaction, or nothing when the command is anything else.
319/// `Option<WrappedOutcome>` is "the ending, or nothing to say".
320/// Why:
321/// Every non-dry-run commit goes through the transaction instead of being forwarded, because native `git commit`
322/// keeps `index.lock` on disk through hooks and the editor. A region Git's table refuses is not known to be a
323/// dry run, so it is treated as a real commit and Git itself rejects it.
324///
325/// In TS you'd write (pseudocode):
326/// ```ts
327/// const transaction = willShortCircuit ? NOT_APPLICABLE : await runCommitTransactionBoundary({ args, gitPath, policyOptions, concurrency });
328/// ```
329fn run_commit_if_real<F: RepositoryFacts>(
330 stripped: &StrippedInvocation,
331 environment: &[(OsString, OsString)],
332 checks: &mut ShippedChecks<F>,
333 config: &CliGitConfig,
334) -> Option<WrappedOutcome> {
335 if command_word(stripped) != b"commit" {
336 return None;
337 }
338 let region: CommitRegion = match parse_commit_region(command_region(stripped), &[]) {
339 Ok(found) => found,
340 Err(_) => return None,
341 };
342 if region.dry_run {
343 return None;
344 }
345 let context = checks.facts.transaction_context();
346 let ending = run_commit_command(
347 &CommitCommand {
348 context: &context,
349 environment,
350 arguments: stripped.arguments.as_slice(),
351 subcommand_index: stripped.layout.prefix_len,
352 region: ®ion,
353 config,
354 controls: &stripped.controls,
355 },
356 checks,
357 );
358 return Some(WrappedOutcome::Exit {
359 code: ending.code,
360 stderr: String::new(),
361 });
362}
363
364/// What:
365/// Record a guarded command form that runs because the invocation carries the escape for the linked-worktree-only
366/// policy.
367/// Why:
368/// The policy never runs under its escape, so nothing else would say that a discarding form was deliberately let
369/// through; a later loss must be attributable to the escape.
370///
371/// In TS you'd write (pseudocode):
372/// ```ts
373/// recordEscapeUse(stripped, checks);
374/// ```
375fn record_escape_use<F: RepositoryFacts>(stripped: &StrippedInvocation, checks: &mut ShippedChecks<F>) {
376 if !is_escaped(&stripped.controls, PolicyId::LinkedWorktreeOnly) {
377 return;
378 }
379 let command = match decide_linked_worktree(stripped.arguments.as_slice()) {
380 LinkedWorktreeDecision::Pass => return,
381 LinkedWorktreeDecision::NeedsEffectiveTarget(command) | LinkedWorktreeDecision::WhenDirty(command) => command,
382 };
383 if let Ok(location) = checks.facts.location() {
384 record_audit(&location.identity, command, AuditOutcome::Hatch, stripped.arguments.as_slice(), None);
385 }
386}
387
388/// What:
389/// Recover before a read-only command that already asked Git for the repository location;
390/// a live transaction does not stop it,
391/// a legacy directory or a recovery failure does.
392/// `Option<WrappedOutcome>` is "the ending,
393/// or nothing to say".
394/// Why:
395/// The incumbent recovers before read-only commands too,
396/// reusing the identity it already
397/// resolved;
398/// a command that never asked for the location starts no extra work.
399///
400/// In TS you'd write (pseudocode):
401/// ```ts
402/// if (configFreeIdentity !== undefined) await recoverCommitTransaction({ args, gitPath, identity: configFreeIdentity });
403/// ```
404fn recover_before_read_only<F: RepositoryFacts>(
405 checks: &ShippedChecks<F>,
406) -> Option<WrappedOutcome> {
407 let Some(Ok(location)) = checks.facts.asked_location() else {
408 return None;
409 };
410 match recover_for_command(&checks.facts.transaction_context(), &location.identity) {
411 Gate::Clear => return None,
412 Gate::Stop(stderr) => {
413 return Some(WrappedOutcome::Exit {
414 code: ENGINE_FAILURE_EXIT_CODE,
415 stderr,
416 });
417 }
418 }
419}
420
421/// What:
422/// Shows, on standard error, each backup push failure the service recorded since one was last shown and that belongs to this
423/// worktree, before the command runs.
424/// Why:
425/// The service pushes after a commit returned, so the command that made the commit cannot print the failure; the next
426/// command in the worktree whose commit it was does, because the records live under that worktree's own Git directory.
427/// A command whose output a program reads shows nothing and takes
428/// nothing, and neither does a command run where the repository is not found without starting Git. When nothing
429/// failed the check is one directory read.
430///
431/// In TS you'd write (pseudocode):
432/// ```ts
433/// if (!isMachineRead(command)) for (const text of takePushFailures(gitDir)) stderr.write(text + '\n');
434/// ```
435fn show_push_failures<F: RepositoryFacts>(stripped: &StrippedInvocation, checks: &mut ShippedChecks<F>) {
436 if is_machine_read(command_word(stripped), command_region(stripped)) {
437 return;
438 }
439 // The records are the worktree's own, so a notice shows in the worktree whose push failed.
440 let Some(git_dir) = checks.facts.known_git_dir() else { return };
441 let common_dir: PathBuf = checks.facts.known_common_dir().unwrap_or_else(|| { return git_dir.clone(); });
442 // A worktree Git removed took its Git directory along; what it held is shown to whoever asks next. What could not be kept
443 // for the person is said here, each time, until it can be.
444 for problem in settle_removals(common_dir.as_path()) {
445 // A closed terminal is not a reason to stop the command the person asked for.
446 let _written = writeln!(std::io::stderr(), "{problem}");
447 }
448 // Nothing failed: two directory checks, and no question to Git.
449 let own: bool = notice_directory(git_dir.as_path()).is_dir();
450 let orphaned: bool = common_dir.join(ORPHAN_NOTICE_DIRECTORY).is_dir();
451 if !own && !orphaned {
452 return;
453 }
454 let context = checks.facts.transaction_context();
455 let cwd: PathBuf = std::env::current_dir().unwrap_or_else(|_| { return git_dir.clone(); });
456 let objects: PathBuf = common_dir.join("objects");
457 // The name Git gives the commit in this repository as it is now, asked of Git once per shown notice.
458 let abbreviate = |commit: &str| -> String { return short_name(&context, cwd.as_path(), objects.as_path(), None, commit); };
459 let mut texts: Vec<String> = take_push_failures_for(git_dir.as_path(), None, &abbreviate);
460 texts.extend(take_orphaned_failures(common_dir.as_path(), &abbreviate));
461 for text in texts {
462 // A closed terminal is not a reason to stop the command the person asked for.
463 let _written = writeln!(std::io::stderr(), "{text}");
464 }
465}
466
467/// What:
468/// Before `git worktree remove` or `git worktree prune`, copies the records of the linked worktrees into snapshots that
469/// survive the removal.
470/// Why:
471/// Git deletes a removed worktree's Git directory, and with it the failed pushes nobody was told about and the pushes the
472/// service had not run yet; the process is handed to Git, so only a copy made first can keep them. Which worktrees go is
473/// decided later, from whether each still exists (`worktree_removal_rescue.rs`).
474///
475/// In TS you'd write (pseudocode):
476/// ```ts
477/// if (command === 'worktree' && ['remove', 'prune'].includes(region[0])) await snapshotLinkedWorktrees(commonDir);
478/// ```
479fn snapshot_before_worktree_removal<F: RepositoryFacts>(stripped: &StrippedInvocation, checks: &mut ShippedChecks<F>) {
480 if command_word(stripped) != b"worktree" {
481 return;
482 }
483 let removes: bool = command_region(stripped).first().is_some_and(|word| { return matches!(word.as_encoded_bytes(), b"remove" | b"prune"); });
484 if !removes {
485 return;
486 }
487 if let Some(common_dir) = checks.facts.known_common_dir() {
488 // A record that could not be saved is lost with the worktree, so the person is told before Git runs.
489 for problem in snapshot_linked_worktrees(common_dir.as_path()) {
490 // A closed terminal is not a reason to stop the command the person asked for.
491 let _written = writeln!(std::io::stderr(), "{problem}");
492 }
493 }
494}
495
496/// What:
497/// Run the lifecycle of one wrapped command.
498/// `&StrippedInvocation` borrows the
499/// invocation without its wrapper controls;
500/// `&mut ShippedChecks<F>` lends the shipped
501/// policies and their facts provider `F` for writing.
502/// Why:
503/// A command Git does not run as a subcommand is forwarded as it is.
504/// A read-only
505/// command skips configuration and every refusal check,
506/// and uses the default
507/// settings.
508/// Every other command is prepared first.
509/// Then one pre-forward pass runs,
510/// and a real push must also clear the manual-push gate.
511///
512/// In TS you'd write (pseudocode):
513/// ```ts
514/// async function runWrappedCommand(stripped, environment, checks): Promise<WrappedOutcome>;
515/// ```
516pub fn run_wrapped_command<F: RepositoryFacts>(
517 stripped: &StrippedInvocation,
518 environment: &[(OsString, OsString)],
519 checks: &mut ShippedChecks<F>,
520) -> WrappedOutcome {
521 if stripped.layout.outcome != GlobalOutcome::Command {
522 return WrappedOutcome::Forward {
523 // `.clone()` copies the arguments for the caller.
524 arguments: stripped.arguments.clone(),
525 stderr: String::new(),
526 };
527 }
528 // `String::from_utf8_lossy` renders the command word for messages, replacing bytes that
529 // are not UTF-8; `.into_owned()` makes it owned text.
530 let command: String = String::from_utf8_lossy(command_word(stripped)).into_owned();
531 // `.as_slice()` lends an owned list as a borrowed view.
532 let skips_config: bool =
533 classify_config_loading(stripped.arguments.as_slice()) == ConfigLoading::Skip;
534 let loaded: Option<CliGitConfig> = if skips_config {
535 None
536 } else {
537 match prepare_guarded_command(stripped, checks) {
538 Ok(found) => Some(found),
539 Err(ending) => return ending,
540 }
541 };
542 // After the configuration step, so a command that had Git answer the repository location shows from that answer, and
543 // before the commit, so a failure shows ahead of the commit's own output.
544 show_push_failures(stripped, checks);
545 snapshot_before_worktree_removal(stripped, checks);
546 if let Some(config) = &loaded
547 && let Some(ending) = run_commit_if_real(stripped, environment, checks, config)
548 {
549 return ending;
550 }
551 let policies: PolicyConfig = match loaded {
552 Some(config) => config.policies,
553 None => PolicyConfig::defaults(),
554 };
555 record_escape_use(stripped, checks);
556 let request: StageRequest = StageRequest {
557 trigger: Trigger::PreForward,
558 config: policies,
559 controls: stripped.controls.clone(),
560 // `Vec::<PolicyId>::new()` is an empty owned list: a wrapped command selects every policy.
561 selected: Vec::<PolicyId>::new(),
562 };
563 let pass: PassResult = run_policy_pass(&request, checks);
564 if let Some(ending) = stage_ending(pass.events.as_slice(), pass.end, command.as_str()) {
565 return ending;
566 }
567 if skips_config
568 && let Some(ending) = recover_before_read_only(checks)
569 {
570 return ending;
571 }
572 // `mut` allows the push gate to append its events.
573 let mut events: Vec<PolicyEvent> = pass.events;
574 if command_word(stripped) == b"push" && !push_is_dry_run(command_region(stripped)) {
575 let gate_request: StageRequest = StageRequest {
576 trigger: Trigger::ManualPush,
577 config: request.config,
578 controls: request.controls,
579 selected: request.selected,
580 };
581 let gated: Vec<PolicyId> = every_policy();
582 if any_policy_applies(&gate_request, gated.as_slice()) {
583 // The push's scope is discovered before any policy reads content; a discovery failure refuses the push.
584 if let Err(failure) = prepare_manual_push(checks, environment, command_region(stripped)) {
585 events.push(PolicyEvent::EngineFailure {
586 code: EngineFailureCode::ContentUnavailable,
587 message: failure.message,
588 trigger: Some(Trigger::ManualPush),
589 policy: None,
590 path: None,
591 });
592 return WrappedOutcome::Exit {
593 code: ENGINE_FAILURE_EXIT_CODE,
594 stderr: render_policy_events(0, events.as_slice()),
595 };
596 }
597 let gate: StageResult = run_policy_stage(&gate_request, gated.as_slice(), checks);
598 // `.extend(list)` moves every item of `list` onto the end.
599 events.extend(gate.events);
600 if let Some(ending) = stage_ending(events.as_slice(), gate.end, command.as_str()) {
601 return ending;
602 }
603 }
604 }
605 return WrappedOutcome::Forward {
606 arguments: pass.arguments,
607 stderr: render_policy_events(0, events.as_slice()),
608 };
609}
610
611/// Lifecycle order,
612/// fact use and every ending stay out of the release executable.
613/// What:
614/// Discover the scope of a manual push and hand it to the manual-push stage as its candidates.
615/// Why:
616/// The stage reads only what the push publishes, and the discovery runs against the repository the
617/// command targets, with the invocation's global options and environment.
618///
619/// In TS you'd write (pseudocode):
620/// ```ts
621/// const scope = await manualPushScope({ gitPath, cwd, args }); // then the manual-push stage reads it
622/// ```
623fn prepare_manual_push<F: RepositoryFacts>(
624 checks: &mut ShippedChecks<F>,
625 environment: &[(OsString, OsString)],
626 post_subcommand: &[OsString],
627) -> Result<(), super::manual_push_lifecycle::ManualPushFailure> {
628 let worktree: Option<PathBuf> = match checks.facts.location() {
629 Ok(location) => worktree_root(&location.identity).map(Path::to_path_buf),
630 Err(message) => return Err(super::manual_push_lifecycle::ManualPushFailure { message }),
631 };
632 let context = checks.facts.transaction_context();
633 let cwd = match worktree {
634 Some(root) => root,
635 None => std::env::current_dir().map_err(|error| {
636 return super::manual_push_lifecycle::ManualPushFailure {
637 message: format!("the working directory could not be read: {error}"),
638 };
639 })?,
640 };
641 let git = PushGit {
642 real_git: context.real_git,
643 cwd,
644 environment: environment_with_overlay(environment, context.overlay.as_slice()),
645 // The scope probe is a dry-run push; an upload during it would run before any policy has decided.
646 lfs: false,
647 };
648 let scope = manual_push_scope(&git, context.global_prefix.as_slice(), post_subcommand)?;
649 checks.candidates = LifecycleContent::Requested(CandidateRequest::Pushed(scope));
650 return Ok(());
651}
652
653#[cfg(test)]
654#[path = "wrapped_command_tests.rs"]
655mod tests;