scripts

Documentation

Index

• Constants
• Variables
• func ConvertEnvironmentList(env api.EnvironmentList) (result []string)
• func ConvertEnvironmentToDocker(env api.EnvironmentList) (result string)
• func GetEnvironment(path string) (api.EnvironmentList, error)
• type DefaultScriptSourceManager
  • func (m *DefaultScriptSourceManager) Add(s ScriptHandler)
  • func (m *DefaultScriptSourceManager) InstallOptional(scripts []string, dstDir string) []api.InstallResult
  • func (m *DefaultScriptSourceManager) InstallRequired(scripts []string, dstDir string) ([]api.InstallResult, error)
• type Downloader
  • func NewDownloader(proxyConfig *api.ProxyConfig) Downloader
• type FileURLReader
  • func (*FileURLReader) Read(url *url.URL) (io.ReadCloser, error)
• type HTTPURLReader
  • func NewHTTPURLReader(proxyConfig *api.ProxyConfig) *HTTPURLReader
  • func (h *HTTPURLReader) Read(url *url.URL) (io.ReadCloser, error)
• type ImageReader
  • func (*ImageReader) Read(url *url.URL) (io.ReadCloser, error)
• type Installer
  • func NewInstaller(image string, scriptsURL string, proxyConfig *api.ProxyConfig, ...) Installer
• type ScriptHandler
• type ScriptSourceManager
• type SourceScriptHandler
  • func (s *SourceScriptHandler) Get(script string) *api.InstallResult
  • func (s *SourceScriptHandler) Install(r *api.InstallResult) error
  • func (s *SourceScriptHandler) SetDestinationDir(baseDir string)
  • func (s *SourceScriptHandler) String() string
• type URLScriptHandler
  • func (s *URLScriptHandler) Get(script string) *api.InstallResult
  • func (s *URLScriptHandler) Install(r *api.InstallResult) error
  • func (s *URLScriptHandler) SetDestinationDir(baseDir string)
  • func (s *URLScriptHandler) String() string

Constants

const (

	// ScriptURLHandler is the name of the script URL handler
	ScriptURLHandler = "script URL handler"

	// ImageURLHandler is the name of the image URL handler
	ImageURLHandler = "image URL handler"

	// SourceHandler is the name of the source script handler
	SourceHandler = "source handler"
)

Variables

var (
	// RequiredScripts must be present to do an s2i build
	RequiredScripts = []string{constants.Assemble, constants.Run}

	// OptionalScripts may be provided when doing an s2i build
	OptionalScripts = []string{constants.SaveArtifacts}
)

Functions

func ConvertEnvironmentList

func ConvertEnvironmentList(env api.EnvironmentList) (result []string)

ConvertEnvironmentList converts the EnvironmentList to "key=val" strings.

func ConvertEnvironmentToDocker

func ConvertEnvironmentToDocker(env api.EnvironmentList) (result string)

ConvertEnvironmentToDocker converts the EnvironmentList into Dockerfile format.

func GetEnvironment

func GetEnvironment(path string) (api.EnvironmentList, error)

GetEnvironment gets the .s2i/environment file located in the sources and parse it into EnvironmentList.

Types

type DefaultScriptSourceManager

type DefaultScriptSourceManager struct {
	Image      string
	ScriptsURL string
	// contains filtered or unexported fields
}

DefaultScriptSourceManager manages the default script lookup and installation for source-to-image.

func (*DefaultScriptSourceManager) Add

func (m *DefaultScriptSourceManager) Add(s ScriptHandler)

Add registers a new script source handler.

func (*DefaultScriptSourceManager) InstallOptional

func (m *DefaultScriptSourceManager) InstallOptional(scripts []string, dstDir string) []api.InstallResult

InstallOptional downloads and installs a set of scripts into dstDir, the result is a map of scripts with detailed information about each of the scripts install process

func (*DefaultScriptSourceManager) InstallRequired

func (m *DefaultScriptSourceManager) InstallRequired(scripts []string, dstDir string) ([]api.InstallResult, error)

InstallRequired Downloads and installs required scripts into dstDir, the result is a map of scripts with detailed information about each of the scripts install process with error if installing some of them failed

type Downloader

type Downloader interface {
	Download(url *url.URL, target string) (*git.SourceInfo, error)
}

Downloader downloads the specified URL to the target file location

func NewDownloader

func NewDownloader(proxyConfig *api.ProxyConfig) Downloader

NewDownloader creates an instance of the default Downloader implementation

type FileURLReader

type FileURLReader struct{}

FileURLReader opens a specified file and returns its stream

func (*FileURLReader) Read

func (*FileURLReader) Read(url *url.URL) (io.ReadCloser, error)

Read produces an io.Reader from a file URL

type HTTPURLReader

type HTTPURLReader struct {
	Get func(url string) (*http.Response, error)
}

HTTPURLReader retrieves a response from a given HTTP(S) URL.

func NewHTTPURLReader

func NewHTTPURLReader(proxyConfig *api.ProxyConfig) *HTTPURLReader

NewHTTPURLReader returns a new HTTPURLReader.

func (*HTTPURLReader) Read

func (h *HTTPURLReader) Read(url *url.URL) (io.ReadCloser, error)

Read produces an io.Reader from an http(s) URL.

type ImageReader

type ImageReader struct{}

ImageReader just returns information the URL is from inside the image

func (*ImageReader) Read

func (*ImageReader) Read(url *url.URL) (io.ReadCloser, error)

Read throws Not implemented error

type Installer

type Installer interface {
	InstallRequired(scripts []string, dstDir string) ([]api.InstallResult, error)
	InstallOptional(scripts []string, dstDir string) []api.InstallResult
}

Installer interface is responsible for installing scripts needed to run the build.

func NewInstaller

func NewInstaller(image string, scriptsURL string, proxyConfig *api.ProxyConfig, docker docker.Docker, auth api.AuthConfig, fs fs.FileSystem, config *api.Config) Installer

NewInstaller returns a new instance of the default Installer implementation

type ScriptHandler

type ScriptHandler interface {
	Get(script string) *api.InstallResult
	Install(*api.InstallResult) error
	SetDestinationDir(string)
	String() string
}

ScriptHandler provides an interface for various scripts source handlers.

type ScriptSourceManager

type ScriptSourceManager interface {
	Add(ScriptHandler)
	SetDownloader(Downloader)
	Installer
}

ScriptSourceManager manages various script handlers.

type SourceScriptHandler

type SourceScriptHandler struct {
	DestinationDir string
	// contains filtered or unexported fields
}

SourceScriptHandler handles the case when the scripts are contained in the source code directory.

func (*SourceScriptHandler) Get

func (s *SourceScriptHandler) Get(script string) *api.InstallResult

Get verifies if the script is present in the source directory and get the installation result.

func (*SourceScriptHandler) Install

func (s *SourceScriptHandler) Install(r *api.InstallResult) error

Install copies the script into upload directory and fix its permissions.

func (*SourceScriptHandler) SetDestinationDir

func (s *SourceScriptHandler) SetDestinationDir(baseDir string)

SetDestinationDir sets the directory where the scripts should be uploaded. In case of SourceScriptHandler this is a source directory root.

func (*SourceScriptHandler) String

func (s *SourceScriptHandler) String() string

String implements the String() function.

type URLScriptHandler

type URLScriptHandler struct {
	URL            string
	DestinationDir string
	Download       Downloader
	FS             fs.FileSystem
	Name           string
}

URLScriptHandler handles script download using URL.

func (*URLScriptHandler) Get

func (s *URLScriptHandler) Get(script string) *api.InstallResult

Get parses the provided URL and the script name.

func (*URLScriptHandler) Install

func (s *URLScriptHandler) Install(r *api.InstallResult) error

Install downloads the script and fix its permissions.

func (*URLScriptHandler) SetDestinationDir

func (s *URLScriptHandler) SetDestinationDir(baseDir string)

SetDestinationDir sets the destination where the scripts should be downloaded.

func (*URLScriptHandler) String

func (s *URLScriptHandler) String() string

String implements the String() function.