cnbutils

Documentation

Overview

Package cnbutils provides utility functions to interact with Buildpacks

Index

• func CopyProject(source, target string, include, exclude *ignore.GitIgnore, utils BuildUtils) error
• func CreateEnvFiles(utils BuildUtils, platformPath string, env map[string]interface{}) error
• func DigestFromReport(utils BuildUtils) (string, error)
• func GenerateCnbAuth(config string, utils BuildUtils) (string, error)
• func MergeSBOMFiles(pattern, output, img, dockerConfigFile string, utils BuildUtils) error
• type BuildPackMetadata
• type BuildUtils
• type License
• type MockUtils
  • func (c *MockUtils) GetFileUtils() piperutils.FileUtils
• type Order
  • func DownloadBuildpacks(path string, bpacks []string, dockerCreds string, utils BuildUtils) (Order, error)
  • func (o Order) Save(path string) error
• type OrderEntry
• type TargetImage
  • func GetTargetImage(imageRegistry, imageName, imageTag, projectID, envRootPath string) (*TargetImage, error)

Functions

func CopyProject

func CopyProject(source, target string, include, exclude *ignore.GitIgnore, utils BuildUtils) error

func CreateEnvFiles

func CreateEnvFiles(utils BuildUtils, platformPath string, env map[string]interface{}) error

func DigestFromReport

func DigestFromReport(utils BuildUtils) (string, error)

func GenerateCnbAuth

func GenerateCnbAuth(config string, utils BuildUtils) (string, error)

func MergeSBOMFiles

func MergeSBOMFiles(pattern, output, img, dockerConfigFile string, utils BuildUtils) error

Types

type BuildPackMetadata

type BuildPackMetadata struct {
	ID          string    `toml:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty"`
	Name        string    `toml:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty"`
	Version     string    `toml:"version,omitempty" json:"version,omitempty" yaml:"version,omitempty"`
	Description string    `toml:"description,omitempty" json:"description,omitempty" yaml:"description,omitempty"`
	Homepage    string    `toml:"homepage,omitempty" json:"homepage,omitempty" yaml:"homepage,omitempty"`
	Keywords    []string  `toml:"keywords,omitempty" json:"keywords,omitempty" yaml:"keywords,omitempty"`
	Licenses    []License `toml:"licenses,omitempty" json:"licenses,omitempty" yaml:"licenses,omitempty"`
}

type BuildUtils

type BuildUtils interface {
	command.ExecRunner
	piperutils.FileUtils
	docker.Download
}

type License

type License struct {
	Type string `toml:"type" json:"type"`
	URI  string `toml:"uri" json:"uri"`
}

type MockUtils

type MockUtils struct {
	*mock.ExecMockRunner
	*mock.FilesMock
	*mock.DownloadMock
}

func (*MockUtils) GetFileUtils

func (c *MockUtils) GetFileUtils() piperutils.FileUtils

type Order

type Order struct {
	Order []OrderEntry `toml:"order"`
	Utils BuildUtils   `toml:"-"`
}

func DownloadBuildpacks

func DownloadBuildpacks(path string, bpacks []string, dockerCreds string, utils BuildUtils) (Order, error)

func (Order) Save

func (o Order) Save(path string) error

type OrderEntry

type OrderEntry struct {
	Group []BuildPackMetadata `toml:"group" json:"group"`
}

type TargetImage

type TargetImage struct {
	ContainerImageName string
	ContainerImageTag  string
	ContainerRegistry  *url.URL
}

func GetTargetImage

func GetTargetImage(imageRegistry, imageName, imageTag, projectID, envRootPath string) (*TargetImage, error)