Interface ProvisionVm

The slice of VirtualMachine the provisioner drives (fakeable in tests).

interface ProvisionVm {
    exec(
        command: string,
        options?: { timeout?: number },
    ): Promise<ExecResult>;
    getGuestPath(key: GuestPathKey): string;
    start(): Promise<void>;
    stop(): Promise<void>;
    syncCode(projectRoot: string, opts?: SyncCodeOptions): Promise<void>;
}

Index

Methods

exec getGuestPath start stop syncCode

Methods

exec

exec(command: string, options?: { timeout?: number }): Promise<ExecResult>
Run a shell command in the guest over SSH. Never rejects; check exitCode.
Parameters
- command: string
- Optionaloptions: { timeout?: number }
Returns Promise<ExecResult>
- Defined in src/node/vm/provision.ts:71

getGuestPath

getGuestPath(key: GuestPathKey): string
Resolve a well-known guest location (CLI/agent binary path).
Parameters
- key: GuestPathKey
Returns string
- Defined in src/node/vm/provision.ts:75

start

start(): Promise<void>
Boot the VM (see VirtualMachine.start).

Returns Promise<void>
- Defined in src/node/vm/provision.ts:67

stop

stop(): Promise<void>
Stop the VM and release its resources. Idempotent.

Returns Promise<void>
- Defined in src/node/vm/provision.ts:69

syncCode

syncCode(projectRoot: string, opts?: SyncCodeOptions): Promise<void>
rsync the repo into the guest's /opt/edgible and optionally build there.
Parameters
- projectRoot: string
- Optionalopts: SyncCodeOptions
Returns Promise<void>
- Defined in src/node/vm/provision.ts:73