shell

type Environment struct {
	// Name defines the environment variable name
	Name string `yaml:",omitempty" jsonschema:"required"`
	// Value defines the environment variable value
	Value *string `yaml:",omitempty"`
}

type Environments []Environment

type ErrEmptyCommand struct{}

type ExecutionFailedError struct{}

type MockCommandExecutor struct {
	GotCommand command
	Result     commandResult
	Err        error
}

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

type Spec struct {
	Command string `yaml:",omitempty" jsonschema:"required"`
	// environments allows to pass environment variable(s) to the shell script.
	//
	//  default:
	//     If environments is unset then it depends on the operating system.
	//       - Windows: ["PATH","", "PSModulePath", "PSModuleAnalysisCachePath", "", "PATHEXT", "", "TEMP", "", "HOME", "", "USERPROFILE", "", "PROFILE"]
	//       - Darwin/Linux: ["PATH", "", "HOME", "", "USER", "", "LOGNAME", "", "SHELL", "", "LANG", "", "LC_ALL"]
	//
	// remark:
	//   For security reason, Updatecli doesn't pass the entire environment to the shell command but instead works
	//   with an allow list of environment variables.
	//
	Environments *Environments `yaml:",omitempty"`
	// ChangedIf defines how to interpret shell command execution.
	// What a success means, what an error means, and what a warning would mean in the context of Updatecli.
	//
	// Please note that in the context of Updatecli,
	//  - a success means nothing changed
	//  - a warning means something changed
	//  - an error means something went wrong
	//
	// Changedif can be of kind "exitcode", "console/output", or "file/checksum"
	//
	//   "console/output" (default)
	//     Check the output of the command to identify if Updatecli should report a success, a warning, or an error.
	//     If a target returns anything to stdout, Updatecli interprets it as a something changed, otherwise it's a success.
	//
	//     example:
	//
	//
	//     ---
	//     targets:
	//       default:
	//         name: 'doc: synchronize release note'
	//         kind: 'shell'
	//         disablesourceinput: true
	//         spec:
	//           command: 'releasepost --dry-run="$DRY_RUN" --config {{ .config }} --clean'
	//     ---
	//
	//   "exitcode":
	//     Check the exit code of the command to identify if Updatecli should report a success, a warning, or an error.
	//
	//     example:
	//
	//     ---
	//     targets:
	//       default:
	//         name: 'doc: synchronize release note'
	//         kind: 'shell'
	//         disablesourceinput: true
	//         spec:
	//           command: 'releasepost --dry-run="$DRY_RUN" --config {{ .config }} --clean'
	//           environments:
	//             - name: 'GITHUB_TOKEN'
	//             - name: 'PATH'
	//           changedif:
	//             kind: 'exitcode'
	//             spec:
	//               warning: 0
	//               success: 1
	//               failure: 2
	//     ---
	//
	//
	//   "file/checksum":
	//     Check the checksum of file(s) to identify if Updatecli should report a success, a warning, or an error.
	//
	//     example:
	//
	//     ---
	//     targets:
	//       default:
	//         disablesourceinput: true
	//         name: Example of a shell command with a checksum success criteria
	//         kind: shell
	//         spec:
	//           command: |
	//     	  	   yq -i '.a.b[0].c = "cool"' file.yaml
	//           changedif:
	//             kind: file/checksum
	//             spec:
	//               files:
	//                 - file.yaml
	//     ---
	//
	//
	//
	ChangedIf SpecChangedIf `yaml:",omitempty" json:",omitempty"`
	// Shell specifies which shell interpreter to use.
	//
	// default:
	//   Depends on the operating system:
	//     - Windows: "powershell"
	//     - Darwin/Linux: "/bin/sh"
	//
	Shell string `yaml:",omitempty"`
	// workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path.
	//
	// default: If a scmid is specified then the default
	WorkDir string `yaml:",omitempty"`
}

type SpecChangedIf struct {
	// Kind specifies the success criteria kind, accepted answer ["console/output","exitcode","file/checksum"]
	Kind string `yaml:",omitempty"`
	// Spec specifies the parameter for a specific success criteria kind
	Spec interface{} `yaml:",omitempty"`
}

type Successer interface {
	PreCommand(workingDir string) error
	PostCommand(workingDir string) error
	SourceResult(resultSource *result.Source) error
	ConditionResult() (bool, error)
	TargetResult() (bool, error)
}