server

Documentation

Index

• Constants
• func GetPachClient(t testing.TB) *client.APIClient
• func IsPermissionError(err error) bool
• func RegisterCacheStats(cacheName string, groupCacheStats *groupcache.Stats)
• type APIServer
  • func NewAPIServer(env *serviceenv.ServiceEnv, txnEnv *txnenv.TransactionEnv, etcdPrefix string, ...) (APIServer, error)
• type BlockAPIServer
  • func NewBlockAPIServer(dir string, cacheBytes int64, backend string, etcdAddress string) (BlockAPIServer, error)
• type CommitEvent
• type CommitStream
• type ErrBranchInfoNotFound
  • func (e ErrBranchInfoNotFound) Error() string
• type ErrBranchProvenanceTransitivity
  • func (e ErrBranchProvenanceTransitivity) Error() string
• type ErrCommitInfoNotFound
  • func (e ErrCommitInfoNotFound) Error() string
• type ErrHeadProvenanceInconsistentWithBranch
  • func (e ErrHeadProvenanceInconsistentWithBranch) Error() string
• type ErrInconsistentCommitProvenance
  • func (e ErrInconsistentCommitProvenance) Error() string
• type ErrNilCommitInSubvenance
  • func (e ErrNilCommitInSubvenance) Error() string
• type ErrProvenanceOfSubvenance
  • func (e ErrProvenanceOfSubvenance) Error() string
• type ErrProvenanceTransitivity
  • func (e ErrProvenanceTransitivity) Error() string
• type ErrSubvenanceOfProvenance
  • func (e ErrSubvenanceOfProvenance) Error() string
• type Propagater
  • func (t *Propagater) PropagateCommit(branch *pfs.Branch, isNewCommit bool) error
  • func (t *Propagater) Run() error

Constants

const (
	MinioBackendEnvVar     = "MINIO"
	AmazonBackendEnvVar    = "AMAZON"
	GoogleBackendEnvVar    = "GOOGLE"
	MicrosoftBackendEnvVar = "MICROSOFT"
	LocalBackendEnvVar     = "LOCAL"
)

Valid object storage backends

Functions

func GetPachClient

func GetPachClient(t testing.TB) *client.APIClient

GetPachClient initializes a new PFSAPIServer and blockAPIServer and begins serving requests for them on a new port, and then returns a client connected to the new servers (allows PFS tests to run in parallel without conflict)

func IsPermissionError

func IsPermissionError(err error) bool

IsPermissionError returns true if a given error is a permission error.

func RegisterCacheStats

func RegisterCacheStats(cacheName string, groupCacheStats *groupcache.Stats)

RegisterCacheStats creates a new wrapper for groupcache stats that implements the prometheus.Collector interface, and registers it

Types

type APIServer

type APIServer interface {
	pfsclient.APIServer
	txnenv.PfsTransactionServer
}

APIServer represents an api server.

func NewAPIServer

func NewAPIServer(
	env *serviceenv.ServiceEnv,
	txnEnv *txnenv.TransactionEnv,
	etcdPrefix string,
	treeCache *hashtree.Cache,
	storageRoot string,
	memoryRequest int64,
) (APIServer, error)

NewAPIServer creates an APIServer.

type BlockAPIServer

type BlockAPIServer interface {
	pfsclient.ObjectAPIServer
}

BlockAPIServer combines BlockAPIServer and ObjectAPIServer.

func NewBlockAPIServer

func NewBlockAPIServer(dir string, cacheBytes int64, backend string, etcdAddress string) (BlockAPIServer, error)

NewBlockAPIServer creates a BlockAPIServer using the credentials it finds in the environment

type CommitEvent

type CommitEvent struct {
	Err   error
	Value *pfs.CommitInfo
}

CommitEvent is an event that contains a CommitInfo or an error

type CommitStream

type CommitStream interface {
	Stream() <-chan CommitEvent
	Close()
}

CommitStream is a stream of CommitInfos

type ErrBranchInfoNotFound

type ErrBranchInfoNotFound struct {
	Branch *pfs.Branch
}

ErrBranchInfoNotFound Branch info could not be found. Typically because of an incomplete deletion of a branch. This struct contains all the information that was used to demonstrate that this invariant is not being satisfied.

func (ErrBranchInfoNotFound) Error

func (e ErrBranchInfoNotFound) Error() string

type ErrBranchProvenanceTransitivity

type ErrBranchProvenanceTransitivity struct {
	BranchInfo     *pfs.BranchInfo
	FullProvenance []*pfs.Branch
}

ErrBranchProvenanceTransitivity Branch provenance is not transitively closed. This struct contains all the information that was used to demonstrate that this invariant is not being satisfied.

func (ErrBranchProvenanceTransitivity) Error

func (e ErrBranchProvenanceTransitivity) Error() string

type ErrCommitInfoNotFound

type ErrCommitInfoNotFound struct {
	Location string
	Commit   *pfs.Commit
}

ErrCommitInfoNotFound Commit info could not be found. Typically because of an incomplete deletion of a commit. This struct contains all the information that was used to demonstrate that this invariant is not being satisfied.

func (ErrCommitInfoNotFound) Error

func (e ErrCommitInfoNotFound) Error() string

type ErrHeadProvenanceInconsistentWithBranch

type ErrHeadProvenanceInconsistentWithBranch struct {
	BranchInfo     *pfs.BranchInfo
	ProvBranchInfo *pfs.BranchInfo
	HeadCommitInfo *pfs.CommitInfo
}

ErrHeadProvenanceInconsistentWithBranch The head provenance of a branch does not match the branch's provenance This struct contains all the information that was used to demonstrate that this invariant is not being satisfied.

func (ErrHeadProvenanceInconsistentWithBranch) Error

func (e ErrHeadProvenanceInconsistentWithBranch) Error() string

type ErrInconsistentCommitProvenance

type ErrInconsistentCommitProvenance struct {
	CommitProvenance *pfs.CommitProvenance
}

ErrInconsistentCommitProvenance Commit provenance somehow has a branch and commit from different repos. This struct contains all the information that was used to demonstrate that this invariant is not being satisfied.

func (ErrInconsistentCommitProvenance) Error

func (e ErrInconsistentCommitProvenance) Error() string

type ErrNilCommitInSubvenance

type ErrNilCommitInSubvenance struct {
	CommitInfo      *pfs.CommitInfo
	SubvenanceRange *pfs.CommitRange
}

ErrNilCommitInSubvenance Commit provenance somehow has a branch and commit from different repos. This struct contains all the information that was used to demonstrate that this invariant is not being satisfied.

func (ErrNilCommitInSubvenance) Error

func (e ErrNilCommitInSubvenance) Error() string

type ErrProvenanceOfSubvenance

type ErrProvenanceOfSubvenance struct {
	CommitInfo     *pfs.CommitInfo
	SubvCommitInfo *pfs.CommitInfo
}

ErrProvenanceOfSubvenance The commit was not found in its subvenance's provenance This struct contains all the information that was used to demonstrate that this invariant is not being satisfied.

func (ErrProvenanceOfSubvenance) Error

func (e ErrProvenanceOfSubvenance) Error() string

type ErrProvenanceTransitivity

type ErrProvenanceTransitivity struct {
	CommitInfo     *pfs.CommitInfo
	FullProvenance []*pfs.Commit
}

ErrProvenanceTransitivity Commit provenance is not transitively closed. This struct contains all the information that was used to demonstrate that this invariant is not being satisfied.

func (ErrProvenanceTransitivity) Error

func (e ErrProvenanceTransitivity) Error() string

type ErrSubvenanceOfProvenance

type ErrSubvenanceOfProvenance struct {
	CommitInfo     *pfs.CommitInfo
	ProvCommitInfo *pfs.CommitInfo
}

ErrSubvenanceOfProvenance The commit was not found in its provenance's subvenance This struct contains all the information that was used to demonstrate that this invariant is not being satisfied.

func (ErrSubvenanceOfProvenance) Error

func (e ErrSubvenanceOfProvenance) Error() string

type Propagater

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

Propagater is an object that is used to propagate PFS branches at the end of a transaction. The transactionenv package provides the interface for this and will call the Run function at the end of a transaction.

func (*Propagater) PropagateCommit

func (t *Propagater) PropagateCommit(branch *pfs.Branch, isNewCommit bool) error

PropagateCommit marks a branch as needing propagation once the transaction successfully ends. This will be performed by the Run function.

func (*Propagater) Run

func (t *Propagater) Run() error

Run performs any final tasks and cleanup tasks in the STM, such as propagating branches