buildenv

type BindMount struct {
	PathInHost     string
	PathInBuildEnv string
}

type BuildEnv interface {
	// GetInfo returns a [BuildEnvInfo] structure that contains information about the build
	// environment. This information can be used to identify the build environment and its properties.
	GetInfo() BuildEnvInfo

	// CreateCmd builds a new [exec.Cmd] for running the given command within the build environment.
	CreateCmd(ctx context.Context, args []string, options RunOptions) (cmd opctx.Cmd, err error)

	// Destroy permanently (and irreversibly) destroys the build environment, removing its files from
	// the filesystem.
	Destroy(ctx opctx.Ctx) error
}

type BuildEnvInfo struct {
	// Name is the human-readable name moniker for the build environment.
	Name string `json:"name"`

	// UserCreated indicates whether the build environment was created on behalf of a direct user request.
	// If this is false, the build environment was created automatically as part of a larger operation.
	UserCreated bool `json:"userCreated"`

	// Type is the type of build environment. This is used to determine which technology can be used
	// to interact with the build environment.
	Type EnvType `json:"type"`

	// CreationTime is the time when the build environment was created. This can be useful for users to
	// better understanding their environments.
	CreationTime time.Time `json:"creationTime"`

	// Dir is the directory under which the build environment's files are stored.
	Dir string `json:"dir"`

	// Description optionally provides a human-readable description of the environment's purpose.
	Description string `json:"description"`
}

type CreateOptions struct {
	// Name is the user-referenceable name of the build environment.
	Name string
	// Dir is the directory under which the build environment's files should be stored.
	Dir string
	// UserCreated indicates whether the build environment was explicitly created by the
	// user for direct use (as opposed to being created as part of a build operation).
	UserCreated bool
	// Description optionally provides a human-readable description for the purpose of
	// this environment.
	Description string
	// ConfigOpts is an optional set of key-value pairs that will be passed through to the
	// underlying build environment backend as configuration overrides (e.g., mock's --config-opts).
	ConfigOpts map[string]string
}

type EnvType string

type Factory interface {
	// CreateEnv creates a new instance of a build environment (e.g., a specific mock root);
	// note that creation is decoupled from executing operations within the build environment.
	CreateEnv(options CreateOptions) (buildEnv BuildEnv, err error)
}

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

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

type RPMAwareBuildEnv interface {
	BuildEnv

	// BuildSRPM uses this build environment to build a source RPM package.
	BuildSRPM(ctx context.Context, specPath, sourceDirPath, outputDirPath string, options SRPMBuildOptions) error

	// BuildRPM uses this build environment to build binary RPM packages from the provided SRPM package.
	BuildRPM(ctx context.Context, srpmPath, outputDirPath string, options RPMBuildOptions) error

	// TryGetFailureDetails makes a best-effort attempt to extract details from build logs that may be
	// relevant to understanding the cause of a build failure. This is intended to be called after a build
	// failure to glean any insights we can from logs about why the failure might have occurred.
	TryGetFailureDetails(fs opctx.FS, outputDirPath string) (details *RPMBuildLogDetails)
}

type RPMAwareFactory interface {
	// CreateEnv creates a new instance of a build environment (e.g., a specific mock root);
	// note that creation is decoupled from executing operations within the build environment.
	CreateRPMAwareEnv(options CreateOptions) (buildEnv RPMAwareBuildEnv, err error)
}

type RPMBuildLogDetails = mock.BuildLogDetails

type RPMBuildOptions = mock.RPMBuildOptions

type RunOptions struct {
	// EnableNetworking indicates whether the build environment should allow networking operations.
	// If set to false, the build environment will be entirely isolated from the network.
	EnableNetworking bool

	// Interactive indicates whether the command should be run interactively. If set to true, the
	// command will be run in an interactive terminal, allowing the user to interact with it via
	// stdin.
	Interactive bool

	// BindMounts is a list of bind mounts that should be created for the build environment, allowing
	// mapping of host paths into the build environment.
	BindMounts []BindMount
}

type SRPMBuildOptions = mock.SRPMBuildOptions