source

type Access struct {
	Credential api.GitCredential

	// Connection names the source connection it came from, for messages:
	// "the source connection 'GitHub (acme)'".
	Connection string
}

type Checkout struct {
	// Dir is the root of the working tree.
	Dir string

	// Commit is the resolved SHA. R-120: Ref is what the user asked for, Commit
	// is what runs, and it is written back into the spec so a redeploy of the
	// same revision builds the same code.
	Commit string

	// Digest names an uploaded source, which has no commit: the SHA-256 of the
	// archive it was unpacked from, as "sha256:<hex>". Never written into the
	// spec as a commit (R-120) — it is how a scan knows the same archive when
	// it sees it again (R-312).
	Digest string
	// contains filtered or unexported fields
}

type Credentials interface {
	Access(ctx context.Context, src spec.Source, purpose Purpose) (*Access, error)
}

type Guard struct {
	// OwnPorts are the ports Pando listens on. Refused on loopback and on
	// every address of this machine's interfaces.
	OwnPorts []uint16

	// Database is where Pando's state store is, as host and port. A host
	// name is resolved when a dial is checked, since it may be a Compose
	// service name whose address changes.
	Database []HostPort

	// Resolve looks a database host up. net.DefaultResolver when nil.
	Resolve func(ctx context.Context, host string) ([]netip.Addr, error)

	// LocalAddrs lists this machine's interface addresses.
	// net.InterfaceAddrs when nil.
	LocalAddrs func() ([]netip.Addr, error)
}

type HostPort struct {
	Host string
	Port uint16
}

type Purpose int

type Sources struct {
	// Uploads keeps uploaded sources in the database, where every control
	// host reads them (R-417). Nil keeps them as files under UploadDir.
	Uploads UploadStore

	// UploadDir is where uploaded sources were kept as files. With Uploads
	// set, a file found here is moved into the database when it is read.
	UploadDir string

	// WorkDir is where a clone or an unpacked upload is made while a deploy or
	// a detection reads it: server.work_dir, beside Pando's other working
	// files, rather than the system temporary directory, which is often a
	// small tmpfs that a few concurrent clones fill (issue #72). Empty means
	// the system temporary directory, for tests and embeddings.
	WorkDir string

	// Credentials finds what a repository is read with, from the install's
	// source connections (R-091, issue #127). Nil reads every repository
	// anonymously, which is what a public one needs.
	Credentials Credentials
}

type Tracked struct {
	// Ref is fully qualified: refs/heads/main or refs/tags/v1.2.0. It goes in
	// the revision's Source.Ref, so the revision says what it was cut from.
	Ref    string
	Commit string
}

type UploadStore interface {
	PutUpload(ctx context.Context, appID string, r io.Reader) error
	// AddUpload stores r only if the app has none, and reports whether it
	// did. An app that no longer exists is errs.NotFound.
	AddUpload(ctx context.Context, appID string, r io.Reader) (bool, error)
	// OpenUpload answers ok false when the app has no upload stored.
	OpenUpload(ctx context.Context, appID string) (io.ReadCloser, bool, error)
	DeleteUpload(ctx context.Context, appID string) error
}