spi

Documentation

Index

• Constants
• Variables
• func DownloadDevfileUsingSPI(s SPI, ctx context.Context, component v1alpha1.Component, repoURL string, ...) ([]byte, string, error)
• func DownloadDevfileandDockerfileUsingSPI(s SPI, ctx context.Context, name string, component v1alpha1.Component, ...) ([]byte, []byte, string, error)
• func DownloadFileUsingSPI(s SPI, ctx context.Context, fcrName string, component v1alpha1.Component, ...) ([]byte, error)
• type MockSPIClient
  • func (s MockSPIClient) GetFileContents(ctx context.Context, name string, component v1alpha1.Component, repoURL string, ...) (io.ReadCloser, error)
• type SPI
• type SPIClient
  • func (s SPIClient) GetFileContents(ctx context.Context, name string, component v1alpha1.Component, repoUrl string, ...) (io.ReadCloser, error)
• type SPIFileContentRequestError
  • func (e *SPIFileContentRequestError) Error() string

Constants

const (
	SPIFCR_waiting_for_delivered_phase = "File content request status has not been delivered"
	SPIFCR_prefix                      = "spi-fcr-"
)

Variables

var ValidDevfileLocations = cdqanalysis.ValidDevfileLocations

Functions

func DownloadDevfileUsingSPI

func DownloadDevfileUsingSPI(s SPI, ctx context.Context, component v1alpha1.Component, repoURL string, ref string, path string) ([]byte, string, error)

func DownloadDevfileandDockerfileUsingSPI

func DownloadDevfileandDockerfileUsingSPI(s SPI, ctx context.Context, name string, component v1alpha1.Component, repoURL string, ref string, path string) ([]byte, []byte, string, error)

func DownloadFileUsingSPI

func DownloadFileUsingSPI(s SPI, ctx context.Context, fcrName string, component v1alpha1.Component, repoURL string, ref string, filepath string) ([]byte, error)

Types

type MockSPIClient

type MockSPIClient struct {
	K8sClient client.Client
}

func (MockSPIClient) GetFileContents

func (s MockSPIClient) GetFileContents(ctx context.Context, name string, component v1alpha1.Component, repoURL string, filepath string, ref string) (io.ReadCloser, error)

GetFileContents mocks the GetFileContents function from SPI If "repoURL" parameter contains "test-error-response", then an error value will be returned, otherwise we return a mock devfile that can be read.

type SPI

type SPI interface {
	GetFileContents(ctx context.Context, name string, component v1alpha1.Component, repoUrl string, filepath string, ref string) (io.ReadCloser, error)
}

type SPIClient

type SPIClient struct {
	K8sClient client.Client
}

func (SPIClient) GetFileContents

func (s SPIClient) GetFileContents(ctx context.Context, name string, component v1alpha1.Component, repoUrl string, filepath string, ref string) (io.ReadCloser, error)

GetFileContents is a wrapper call to scm file retriever's GetFileContents()

type SPIFileContentRequestError

type SPIFileContentRequestError struct {
	Message string
}

SPIFileContentRequestError returns an internal error

func (*SPIFileContentRequestError) Error

func (e *SPIFileContentRequestError) Error() string