util

Documentation

Index

• func CheckSameFile(f1name, f2name string) (bool, error)
• func CheckSameSymlink(f1name, f2name string) (bool, error)
• func CheckTar(image string) bool
• func CleanFilePath(dirtyPath string) string
• func CleanupImage(image Image)
• func DirIsEmpty(path string) (bool, error)
• func GetFileContents(path string) (*string, error)
• func GetFileSystemForImage(image v1.Image, root string, whitelist []string) error
• func GetFileSystemForLayer(layer v1.Layer, root string, whitelist []string) error
• func GetImageLayers(pathToImage string) []string
• func GetSize(path string) int64
• func HasFilepathPrefix(path, prefix string) bool
• func HasTag(image string) bool
• func IsTar(path string) bool
• func RemoveTag(image string) string
• func SortMap(m map[string]string) string
• type Directory
  • func GetDirectory(path string, deep bool) (Directory, error)
• type DirectoryEntry
  • func CreateDirectoryEntries(root string, entryNames []string) (entries []DirectoryEntry)
  • func GetDirectoryEntries(d Directory) []DirectoryEntry
• type Image
  • func GetImage(imageName string, includeLayers bool, cacheDir string) (Image, error)
  • func GetImageForName(imageName string) (Image, error)
• type ImageHistoryItem
• type Layer
• type OriginalPerm
• type TestImage
  • func (i *TestImage) BlobSet() (map[v1.Hash]struct{}, error)
  • func (i *TestImage) ConfigFile() (*v1.ConfigFile, error)
  • func (i *TestImage) ConfigName() (v1.Hash, error)
  • func (i *TestImage) Digest() (v1.Hash, error)
  • func (i *TestImage) LayerByDiffID(diffID v1.Hash) (v1.Layer, error)
  • func (i *TestImage) LayerByDigest(v1.Hash) (v1.Layer, error)
  • func (i *TestImage) Layers() ([]v1.Layer, error)
  • func (i *TestImage) Manifest() (*v1.Manifest, error)
  • func (i *TestImage) MediaType() (types.MediaType, error)
  • func (i *TestImage) RawConfigFile() ([]byte, error)
  • func (i *TestImage) RawManifest() ([]byte, error)

Functions

func CheckSameFile

func CheckSameFile(f1name, f2name string) (bool, error)

func CheckSameSymlink

func CheckSameSymlink(f1name, f2name string) (bool, error)

func CheckTar

func CheckTar(image string) bool

func CleanFilePath

func CleanFilePath(dirtyPath string) string

CleanFilePath removes characters from a given path that cannot be used in paths by the underlying platform (e.g. Windows)

func CleanupImage

func CleanupImage(image Image)

func DirIsEmpty

func DirIsEmpty(path string) (bool, error)

given a path to a directory, check if it has any contents

func GetFileContents

func GetFileContents(path string) (*string, error)

GetFileContents returns the contents of a file at the specified path

func GetFileSystemForImage

func GetFileSystemForImage(image v1.Image, root string, whitelist []string) error

unpack image filesystem to local disk if provided directory is not empty, do nothing

func GetFileSystemForLayer

func GetFileSystemForLayer(layer v1.Layer, root string, whitelist []string) error

GetFileSystemForLayer unpacks a layer to local disk

func GetImageLayers

func GetImageLayers(pathToImage string) []string

func GetSize

func GetSize(path string) int64

func HasFilepathPrefix

func HasFilepathPrefix(path, prefix string) bool

HasFilepathPrefix checks if the given file path begins with prefix

func HasTag

func HasTag(image string) bool

checks to see if an image string contains a tag.

func IsTar

func IsTar(path string) bool

func RemoveTag

func RemoveTag(image string) string

returns a raw image name with the tag removed

func SortMap

func SortMap(m map[string]string) string

Types

type Directory

type Directory struct {
	Root    string
	Content []string
}

Directory stores a representation of a file directory.

func GetDirectory

func GetDirectory(path string, deep bool) (Directory, error)

GetDirectoryContents converts the directory starting at the provided path into a Directory struct.

type DirectoryEntry

type DirectoryEntry struct {
	Name string
	Size int64
}

func CreateDirectoryEntries

func CreateDirectoryEntries(root string, entryNames []string) (entries []DirectoryEntry)

func GetDirectoryEntries

func GetDirectoryEntries(d Directory) []DirectoryEntry

type Image

type Image struct {
	Image  v1.Image
	Source string
	FSPath string
	Digest v1.Hash
	Layers []Layer
}

func GetImage

func GetImage(imageName string, includeLayers bool, cacheDir string) (Image, error)

GetImage infers the source of an image and retrieves a v1.Image reference to it. Once a reference is obtained, it attempts to unpack the v1.Image's reader's contents into a temp directory on the local filesystem.

func GetImageForName

func GetImageForName(imageName string) (Image, error)

GetImageForName retrieves an image by name alone. It does not return layer information, or respect caching.

type ImageHistoryItem

type ImageHistoryItem struct {
	CreatedBy string `json:"created_by"`
}

type Layer

type Layer struct {
	FSPath string
	Digest v1.Hash
}

type OriginalPerm

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

type TestImage

type TestImage struct {
	Config *v1.ConfigFile
}

func (*TestImage) BlobSet

func (i *TestImage) BlobSet() (map[v1.Hash]struct{}, error)

func (*TestImage) ConfigFile

func (i *TestImage) ConfigFile() (*v1.ConfigFile, error)

func (*TestImage) ConfigName

func (i *TestImage) ConfigName() (v1.Hash, error)

func (*TestImage) Digest

func (i *TestImage) Digest() (v1.Hash, error)

func (*TestImage) LayerByDiffID

func (i *TestImage) LayerByDiffID(diffID v1.Hash) (v1.Layer, error)

func (*TestImage) LayerByDigest

func (i *TestImage) LayerByDigest(v1.Hash) (v1.Layer, error)

func (*TestImage) Layers

func (i *TestImage) Layers() ([]v1.Layer, error)

func (*TestImage) Manifest

func (i *TestImage) Manifest() (*v1.Manifest, error)

func (*TestImage) MediaType

func (i *TestImage) MediaType() (types.MediaType, error)

func (*TestImage) RawConfigFile

func (i *TestImage) RawConfigFile() ([]byte, error)

func (*TestImage) RawManifest

func (i *TestImage) RawManifest() ([]byte, error)