remotecontext

Documentation

Overview

Package remotecontext is a generated protocol buffer package.

It is generated from these files:

tarsum.proto

It has these top-level messages:

TarsumBackup

Index

• Constants
• Variables
• func Detect(config backend.BuildConfig) (remote builder.Source, dockerfile *parser.Result, err error)
• func FromArchive(tarStream io.Reader) (builder.Source, error)
• func FullPath(remote builder.Source, path string) (string, error)
• func GetWithStatusError(address string) (resp *http.Response, err error)
• func MakeGitContext(gitURL string) (builder.Source, error)
• func MakeRemoteContext(remoteURL string, ...) (builder.Source, error)
• func NewFileHash(path, name string, fi os.FileInfo) (hash.Hash, error)
• func NewLazySource(root string) (builder.Source, error)
• func Rel(basepath, targpath string) (string, error)
• func StatAt(remote builder.Source, path string) (os.FileInfo, error)
• type CachableSource
  • func NewCachableSource(root string) *CachableSource
  • func (cs *CachableSource) Close() error
  • func (cs *CachableSource) HandleChange(kind fsutil.ChangeKind, p string, fi os.FileInfo, err error) (retErr error)
  • func (cs *CachableSource) Hash(path string) (string, error)
  • func (cs *CachableSource) MarshalBinary() ([]byte, error)
  • func (cs *CachableSource) Root() string
  • func (cs *CachableSource) Scan() error
  • func (cs *CachableSource) UnmarshalBinary(data []byte) error
• type TarsumBackup
  • func (*TarsumBackup) Descriptor() ([]byte, []int)
  • func (this *TarsumBackup) Equal(that interface{}) bool
  • func (m *TarsumBackup) GetHashes() map[string]string
  • func (this *TarsumBackup) GoString() string
  • func (m *TarsumBackup) Marshal() (dAtA []byte, err error)
  • func (m *TarsumBackup) MarshalTo(dAtA []byte) (int, error)
  • func (*TarsumBackup) ProtoMessage()
  • func (m *TarsumBackup) Reset()
  • func (m *TarsumBackup) Size() (n int)
  • func (this *TarsumBackup) String() string
  • func (m *TarsumBackup) Unmarshal(dAtA []byte) error

Constants

const ClientSessionRemote = "client-session"

ClientSessionRemote is identifier for client-session context transport

Variables

var (
	ErrInvalidLengthTarsum = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTarsum   = fmt.Errorf("proto: integer overflow")
)

Functions

func Detect

func Detect(config backend.BuildConfig) (remote builder.Source, dockerfile *parser.Result, err error)

Detect returns a context and dockerfile from remote location or local archive. progressReader is only used if remoteURL is actually a URL (not empty, and not a Git endpoint).

func FromArchive

func FromArchive(tarStream io.Reader) (builder.Source, error)

FromArchive returns a build source from a tar stream.

It extracts the tar stream to a temporary folder that is deleted as soon as the Context is closed. As the extraction happens, a tarsum is calculated for every file, and the set of all those sums then becomes the source of truth for all operations on this Context.

Closing tarStream has to be done by the caller.

func FullPath

func FullPath(remote builder.Source, path string) (string, error)

FullPath is a helper for getting a full path for a path from a source

func GetWithStatusError

func GetWithStatusError(address string) (resp *http.Response, err error)

GetWithStatusError does an http.Get() and returns an error if the status code is 4xx or 5xx.

func MakeGitContext

func MakeGitContext(gitURL string) (builder.Source, error)

MakeGitContext returns a Context from gitURL that is cloned in a temporary directory.

func MakeRemoteContext

func MakeRemoteContext(remoteURL string, contentTypeHandlers map[string]func(io.ReadCloser) (io.ReadCloser, error)) (builder.Source, error)

MakeRemoteContext downloads a context from remoteURL and returns it.

If contentTypeHandlers is non-nil, then the Content-Type header is read along with a maximum of maxPreambleLength bytes from the body to help detecting the MIME type. Look at acceptableRemoteMIME for more details.

If a match is found, then the body is sent to the contentType handler and a (potentially compressed) tar stream is expected to be returned. If no match is found, it is assumed the body is a tar stream (compressed or not). In either case, an (assumed) tar stream is passed to FromArchive whose result is returned.

func NewFileHash

func NewFileHash(path, name string, fi os.FileInfo) (hash.Hash, error)

NewFileHash returns new hash that is used for the builder cache keys

func NewLazySource

func NewLazySource(root string) (builder.Source, error)

NewLazySource creates a new LazyContext. LazyContext defines a hashed build context based on a root directory. Individual files are hashed first time they are asked. It is not safe to call methods of LazyContext concurrently.

func Rel

func Rel(basepath, targpath string) (string, error)

Rel makes a path relative to base path. Same as `filepath.Rel` but can also handle UUID paths in windows.

func StatAt

func StatAt(remote builder.Source, path string) (os.FileInfo, error)

StatAt is a helper for calling Stat on a path from a source

Types

type CachableSource

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

CachableSource is a source that contains cache records for its contents

func NewCachableSource

func NewCachableSource(root string) *CachableSource

NewCachableSource creates new CachableSource

func (*CachableSource) Close

func (cs *CachableSource) Close() error

Close closes the source

func (*CachableSource) HandleChange

func (cs *CachableSource) HandleChange(kind fsutil.ChangeKind, p string, fi os.FileInfo, err error) (retErr error)

HandleChange notifies the source about a modification operation

func (*CachableSource) Hash

func (cs *CachableSource) Hash(path string) (string, error)

Hash returns a hash for a single file in the source

func (*CachableSource) MarshalBinary

func (cs *CachableSource) MarshalBinary() ([]byte, error)

MarshalBinary marshals current cache information to a byte array

func (*CachableSource) Root

func (cs *CachableSource) Root() string

Root returns a root directory for the source

func (*CachableSource) Scan

func (cs *CachableSource) Scan() error

Scan rescans the cache information from the file system

func (*CachableSource) UnmarshalBinary

func (cs *CachableSource) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes cache information for presented byte array

type TarsumBackup

type TarsumBackup struct {
	Hashes map[string]string `` /* 146-byte string literal not displayed */
}

func (*TarsumBackup) Descriptor

func (*TarsumBackup) Descriptor() ([]byte, []int)

func (*TarsumBackup) Equal

func (this *TarsumBackup) Equal(that interface{}) bool

func (*TarsumBackup) GetHashes

func (m *TarsumBackup) GetHashes() map[string]string

func (*TarsumBackup) GoString

func (this *TarsumBackup) GoString() string

func (*TarsumBackup) Marshal

func (m *TarsumBackup) Marshal() (dAtA []byte, err error)

func (*TarsumBackup) MarshalTo

func (m *TarsumBackup) MarshalTo(dAtA []byte) (int, error)

func (*TarsumBackup) ProtoMessage

func (*TarsumBackup) ProtoMessage()

func (*TarsumBackup) Reset

func (m *TarsumBackup) Reset()

func (*TarsumBackup) Size

func (m *TarsumBackup) Size() (n int)

func (*TarsumBackup) String

func (this *TarsumBackup) String() string

func (*TarsumBackup) Unmarshal

func (m *TarsumBackup) Unmarshal(dAtA []byte) error