common

type CommConfig struct {
	Comm communicator.Config `mapstructure:",squash"`
	// The minimum port to use for the Communicator port on the host machine which is forwarded
	// to the SSH or WinRM port on the guest machine. By default this is 2222.
	HostPortMin int `mapstructure:"host_port_min" required:"false"`
	// The maximum port to use for the Communicator port on the host machine which is forwarded
	// to the SSH or WinRM port on the guest machine. Because Packer often runs in parallel,
	// Packer will choose a randomly available port in this range to use as the
	// host port. By default this is 4444.
	HostPortMax int `mapstructure:"host_port_max" required:"false"`
	// Defaults to false. When enabled, Packer
	// does not setup forwarded port mapping for communicator (SSH or WinRM) requests and uses ssh_port or winrm_port
	// on the host to communicate to the virtual machine.
	SkipNatMapping bool `mapstructure:"skip_nat_mapping" required:"false"`

	// These are deprecated, but we keep them around for backwards compatibility
	// TODO: remove later
	SSHHostPortMin int `mapstructure:"ssh_host_port_min" required:"false"`
	// TODO: remove later
	SSHHostPortMax int `mapstructure:"ssh_host_port_max"`
	// TODO: remove later
	SSHSkipNatMapping bool `mapstructure:"ssh_skip_nat_mapping" required:"false"`
}

type Driver interface {
	// Delete a VM by name
	Delete(string) error

	// Executes the given AppleScript with the given arguments.
	ExecuteOsaScript(command ...string) (string, error)

	// Export a VM to a UTM file
	Export(string, string) error

	// Import a VM
	Import(string) (string, error)

	// Checks if the VM with the given id is running.
	IsRunning(string) (bool, error)

	// Get guest tools iso path
	GuestToolsIsoPath() (string, error)

	// Stop stops a running machine, forcefully.
	Stop(string) error

	// Utmctl executes the given Utmctl command
	// and returns the stdout channel as string
	Utmctl(...string) (string, error)

	// Verify checks to make sure that this driver should function
	// properly. If there is any indication the driver can't function,
	// this will return an error.
	Verify() error

	// Version reads the version of UTM that is installed.
	Version() (string, error)
}

type DriverMock struct {
	sync.Mutex

	DeleteCalled bool
	DeleteName   string
	DeleteErr    error

	ExecuteOsaCalls  [][]string
	ExecuteOsaErrs   []error
	ExecuteOsaResult string

	GuestToolsIsoPathCalled bool
	GuestToolsIsoPathErr    error

	ImportCalled bool
	ImportId     string
	ImportPath   string
	ImportErr    error

	IsRunningName   string
	IsRunningReturn bool
	IsRunningErr    error

	StopName string
	StopErr  error

	UtmctlCalls  [][]string
	UtmctlErrs   []error
	UtmctlResult string

	VerifyCalled bool
	VerifyErr    error

	VersionCalled bool
	VersionResult string
	VersionErr    error
}

type ExportConfig struct {
	// Only UTM, this specifies the output format
	// of the exported virtual machine. This defaults to utm.
	Format string `mapstructure:"format" required:"false"`
}

type GuestAdditionsConfig struct {
	// The method by which guest additions are
	// made available to the guest for installation. Valid options are `upload`,
	// `attach`, or `disable`. If the mode is `attach` the guest additions ISO will
	// be attached as a CD device to the virtual machine. If the mode is `upload`
	// the guest additions ISO will be uploaded to the path specified by
	// `guest_additions_path`. The default value is `upload`. If `disable` is used,
	// guest additions won't be downloaded, either.
	GuestAdditionsMode string `mapstructure:"guest_additions_mode"`
	// The interface type to use to mount guest additions when
	// guest_additions_mode is set to attach. Will default to the value set in
	// iso_interface, if iso_interface is set. Will default to "USB", if
	// iso_interface is not set. Options are none/‌IDE/‌SCSI/‌SD/‌MTD/‌Floppy/‌PFlash/‌VirtIO/‌NVMe/‌USB.
	GuestAdditionsInterface string `mapstructure:"guest_additions_interface" required:"false"`
	// The path on the guest virtual machine
	//  where the UTM guest additions ISO will be uploaded. By default this
	//  is `utm-guest-tools-<version>.iso` which should upload into the login directory of
	//  the user.
	GuestAdditionsPath string `mapstructure:"guest_additions_path"`
	// The SHA256 checksum of the guest
	//  additions ISO that will be uploaded to the guest VM. By default the
	//  checksums will be downloaded from the UTM website, so this only needs
	//  to be set if you want to be explicit about the checksum.
	GuestAdditionsSHA256 string `mapstructure:"guest_additions_sha256"`
	// The URL of the guest additions ISO
	//  to upload. This can also be a file URL if the ISO is at a local path. By
	//  default, the UTM builder will attempt to find the guest additions ISO
	//  on the local file system. If it is not available locally, the builder will
	//  download the proper guest additions ISO from the internet.
	GuestAdditionsURL string `mapstructure:"guest_additions_url" required:"false"`
}

type HWConfig struct {
	// The number of cpus to use for building the VM.
	// Defaults to 1.
	CpuCount int `mapstructure:"cpus" required:"false"`
	// The amount of memory to use for building the VM
	// in megabytes. Defaults to 512 megabytes.
	MemorySize int `mapstructure:"memory" required:"false"`
}

type NoPauseConfig struct {
	// If true, the build process will not pause to add display.
	// false by default
	DisplayNoPause bool `mapstructure:"display_nopause" required:"false"`
	// If true, the build process will not pause to confirm successful boot.
	// false by default
	BootNoPause bool `mapstructure:"boot_nopause" required:"false"`
	// If true, the build process will not pause to allow pre-export steps.
	// false by default
	ExportNoPause bool `mapstructure:"export_nopause" required:"false"`
}

type OutputConfig struct {
	// This is the path to the directory where the
	// resulting virtual machine will be created. This may be relative or absolute.
	// If relative, the path is relative to the working directory when packer
	// is executed. This directory must not exist or be empty prior to running
	// the builder. By default this is output-BUILDNAME where "BUILDNAME" is the
	// name of the build.
	OutputDir string `mapstructure:"output_directory" required:"false"`
	// This is the base name of the file (excluding the file extension) where
	// the resulting virtual machine will be created. By default this is the
	// `vm_name`.
	OutputFilename string `mapstructure:"output_filename" required:"false"`
}

type ShutdownConfig struct {
	// The command to use to gracefully shut down the
	// machine once all the provisioning is done. By default this is an empty
	// string, which tells Packer to just forcefully shut down the machine unless a
	// shutdown command takes place inside script so this may safely be omitted. If
	// one or more scripts require a reboot it is suggested to leave this blank
	// since reboots may fail and specify the final shutdown command in your
	// last script.
	ShutdownCommand string `mapstructure:"shutdown_command" required:"false"`
	// The amount of time to wait after executing the
	// shutdown_command for the virtual machine to actually shut down. If it
	// doesn't shut down in this time, it is an error. By default, the timeout is
	// 5m or five minutes.
	ShutdownTimeout time.Duration `mapstructure:"shutdown_timeout" required:"false"`
	// The amount of time to wait after shutting
	// down the virtual machine. If you get the error
	// Error removing floppy controller, you might need to set this to 5m
	// or so. By default, the delay is 0s or disabled.
	PostShutdownDelay time.Duration `mapstructure:"post_shutdown_delay" required:"false"`
	// Packer normally halts the virtual machine after all provisioners have
	// run when no `shutdown_command` is defined.  If this is set to `true`, Packer
	// *will not* halt the virtual machine but will assume that you will send the stop
	// signal yourself through the preseed.cfg or your final provisioner.
	// Packer will wait for a default of 5 minutes until the virtual machine is shutdown.
	// The timeout can be changed using `shutdown_timeout` option.
	DisableShutdown bool `mapstructure:"disable_shutdown" required:"false"`
}

type StepAttachDisplay struct {
	HardwareType string
	// contains filtered or unexported fields
}

type StepAttachISOs struct {
	AttachBootISO           bool
	ISOInterface            string
	GuestAdditionsMode      string
	GuestAdditionsInterface string
	// contains filtered or unexported fields
}

type StepCreateVM struct {
	// takes
	VMName         string
	VMBackend      string
	VMArch         string
	VMIcon         string
	HWConfig       HWConfig
	UEFIBoot       bool
	Hypervisor     bool
	KeepRegistered bool
	// contains filtered or unexported fields
}

type StepDownloadGuestAdditions struct {
	GuestAdditionsMode   string
	GuestAdditionsURL    string
	GuestAdditionsSHA256 string
	Ctx                  interpolate.Context
}

type StepExport struct {
	Format         string
	OutputDir      string
	OutputFilename string
	ExportOpts     []string
	Bundling       UtmBundleConfig
	SkipNatMapping bool
	SkipExport     bool
}

type StepHTTPIPDiscover struct{}

type StepPause struct {
	Message string
	NoPause bool
}

type StepPortForwarding struct {
	CommConfig             *communicator.Config
	HostPortMin            int
	HostPortMax            int
	SkipNatMapping         bool
	ClearNetworkInterfaces bool // if true, all network interfaces will be cleared before adding new ones
	// contains filtered or unexported fields
}

type StepRemoveDevices struct {
	Bundling UtmBundleConfig
}

type StepRun struct {
	// contains filtered or unexported fields
}

type StepShutdown struct {
	Command         string
	Timeout         time.Duration
	Delay           time.Duration
	DisableShutdown bool
}

type StepSshKeyPair struct {
	Debug        bool
	DebugKeyPath string
	Comm         *communicator.Config
}

type StepStopVm struct{}

type StepUploadVersion struct {
	Path string
}

type StepUtmDownload struct {
	// The checksum and the type of the checksum for the download
	Checksum string

	// A short description of the type of download being done. Example:
	// "ISO" or "Guest Additions"
	Description string

	// The name of the key where the final path of the ISO will be put
	// into the state.
	ResultKey string

	// The path where the result should go, otherwise it goes to the
	// cache directory.
	TargetPath string

	// A list of URLs to attempt to download this thing.
	Url []string

	// Extension is the extension to force for the file that is downloaded.
	// Some systems require a certain extension. If this isn't set, the
	// extension on the URL is used. Otherwise, this will be forced
	// on the downloaded file for every URL.
	Extension string
}

type Utm45Driver struct {
	// This is the path to the utmctl binary
	UtmctlPath string
}

type Utm46Driver struct {
	Utm45Driver
}

type UtmBundleConfig struct {
	// Defaults to false. When enabled, Packer includes
	// any attached ISO disc devices into the final virtual machine. Useful for
	// some live distributions that require installation media to continue to be
	// attached after installation.
	BundleISO bool `mapstructure:"bundle_iso" required:"false"`
}

type UtmVersionConfig struct {
	// The path within the virtual machine to
	// upload a file that contains the UTM version that was used to create
	// the machine. This information can be useful for provisioning. By default
	// this is .utm_version, which will generally be upload it into the
	// home directory. Set to an empty string to skip uploading this file, which
	// can be useful when using the none communicator.
	UtmVersionFile *string `mapstructure:"utm_version_file" required:"false"`
}