common

Documentation

Overview

Package common generated by go-bindata.// sources: static/spyglass-lens.html

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func DynamicPathForLens(lensName string) string
• func FetchArtifacts(ctx context.Context, pjFetcher ProwJobFetcher, cfg config.Getter, ...) ([]api.Artifact, error)
• func KeyToJob(src string) (jobName string, buildID string, err error)
• func MustAsset(name string) []byte
• func NewLensServer(listenAddress string, pjFetcher ProwJobFetcher, ...) (*http.Server, error)
• func ProwToGCS(fetcher ProwJobFetcher, config config.Getter, prowKey string) (string, string, error)
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type ArtifactFetcher
• type LensOpt
• type LensWithConfiguration
• type ProwJobFetcher

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func DynamicPathForLens

func DynamicPathForLens(lensName string) string

func FetchArtifacts

func FetchArtifacts(
	ctx context.Context,
	pjFetcher ProwJobFetcher,
	cfg config.Getter,
	storageArtifactFetcher ArtifactFetcher,
	podLogArtifactFetcher ArtifactFetcher,
	src string,
	podName string,
	sizeLimit int64,
	artifactNames []string,
) ([]api.Artifact, error)

FetchArtifacts fetches artifacts. TODO: Unexport once we only have remote lenses

func KeyToJob

func KeyToJob(src string) (jobName string, buildID string, err error)

keyToJob takes a spyglass URL and returns the jobName and buildID.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func NewLensServer

func NewLensServer(
	listenAddress string,
	pjFetcher ProwJobFetcher,
	storageArtifactFetcher ArtifactFetcher,
	podLogArtifactFetcher ArtifactFetcher,
	cfg config.Getter,
	lenses []LensWithConfiguration,
) (*http.Server, error)

func ProwToGCS

func ProwToGCS(fetcher ProwJobFetcher, config config.Getter, prowKey string) (string, string, error)

prowToGCS returns the GCS key corresponding to the given prow key TODO: Unexport once we only have remote lenses

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type ArtifactFetcher

type ArtifactFetcher interface {
	Artifact(ctx context.Context, key string, artifactName string, sizeLimit int64) (api.Artifact, error)
}

ArtifactFetcher knows how to fetch artifacts

type LensOpt

type LensOpt struct {
	LensResourcesDir string
	LensName         string
	LensTitle        string
}

type LensWithConfiguration

type LensWithConfiguration struct {
	Config LensOpt
	Lens   api.Lens
}

type ProwJobFetcher

type ProwJobFetcher interface {
	GetProwJob(job string, id string) (prowv1.ProwJob, error)
}

ProwJobFetcher knows how to get a ProwJob