common

type File struct {
	// Path is the relative path in the git repo where the file or folder to upload is located.
	Path string `mapstructure:"path" required:"true"`
	// Destination is the path on the machine where the file or folder will be uploaded to.
	Destination string `mapstructure:"destination" required:"true"`
}

type FlatFile struct {
	Path        *string `mapstructure:"path" required:"true" cty:"path" hcl:"path"`
	Destination *string `mapstructure:"destination" required:"true" cty:"destination" hcl:"destination"`
}

type FlatScript struct {
	Path            *string  `mapstructure:"path" required:"true" cty:"path" hcl:"path"`
	Args            []string `mapstructure:"args" cty:"args" hcl:"args"`
	EnvironmentVars []string `mapstructure:"environment_vars" cty:"environment_vars" hcl:"environment_vars"`
}

type GitConfig struct {
	packer_common.PackerConfig `mapstructure:",squash"`

	// Source is the git URL (e.g., https://github.com/yorinasub17/packer-git-shell-example.git) where the scripts are
	// located.
	Source string `mapstructure:"source" required:"true"`
	// Ref is the git ref to checkout when sourcing the scripts.
	Ref string `mapstructure:"ref" required:"true"`
	// UsernameEnvVar is the name of the environment variable to lookup for the username to use when authing to the git
	// repo. Defaults to GIT_USERNAME.
	UsernameEnvVar string `mapstructure:"username_env_var"`
	// PasswordEnvVar is the name of the environment variable to lookup for the password to use when authing to the git
	// repo. If unset, defaults to GIT_PASSWORD.
	PasswordEnvVar string `mapstructure:"password_env_var"`
}

type GitOptions struct {
	// RepoURL is the URL of the git repo to clone.
	RepoURL string

	// Ref is the git ref to checkout after cloning.
	Ref string

	// UsernameEnvVar is the name of the environment variable to lookup for the username to use when authing to the git
	// repo. If unset, defaults to defaultUsernameEnvVar.
	UsernameEnvVar string

	// PasswordEnvVar is the name of the environment variable to lookup for the password to use when authing to the git
	// repo. If unset, defaults to defaultPasswordEnvVar.
	PasswordEnvVar string
}

type Script struct {
	// Path is the relative path in the git repo where the script to run is located.
	Path string `mapstructure:"path" required:"true"`
	// Args is the script args to pass when executing the script.
	Args []string `mapstructure:"args"`
	// EnvironmentVars is the list of environment variables that should be set when the script is called. Each entry is
	// a key=value string, setting the environment variable `key` to the given `value`.
	EnvironmentVars []string `mapstructure:"environment_vars"`
}

type ScriptConfig struct {
	// Scripts is a list of blocks that specify which scripts from the repo should be called, and with what args. The
	// scripts will be called in the order in which the blocks are defined. At least one script block must be defined.
	Scripts []Script `mapstructure:"script"`
}