helm

Documentation

Index

• type CLI
  • func (cli CLI) Pull(ctx context.Context, opts PullOptions) error
  • func (cli CLI) Render(ctx context.Context, opts RenderOpts) (result string, err error)
• type Chart
  • func (chart Chart) ToURL() (*url.URL, error)
• type ChartCache
  • func (cache ChartCache) GetReleaseChart(release *v1alpha1.Release) (Chart, error)
  • func (cache ChartCache) GetReleaseChartFS(ctx context.Context, release *v1alpha1.Release) (*ChartFS, error)
• type ChartFS
• type PullOptions
• type PullRenderer
• type PullRendererMock
  • func (mock *PullRendererMock) Pull(contextMoqParam context.Context, pullOptions PullOptions) error
  • func (mock *PullRendererMock) PullCalls() []struct{ ... }
  • func (mock *PullRendererMock) Render(ctx context.Context, opts RenderOpts) (string, error)
  • func (mock *PullRendererMock) RenderCalls() []struct{ ... }
• type Puller
• type RenderOpts

Types

type CLI

type CLI struct {
	internal.IO
}

func (CLI) Pull

func (cli CLI) Pull(ctx context.Context, opts PullOptions) error

func (CLI) Render

func (cli CLI) Render(ctx context.Context, opts RenderOpts) (result string, err error)

type Chart

type Chart struct {
	RepoURL  string         `yaml:"repoUrl"`
	Name     string         `yaml:"name"`
	Version  string         `yaml:"version"`
	Mappings map[string]any `yaml:"mappings"`
}

func (Chart) ToURL

func (chart Chart) ToURL() (*url.URL, error)

type ChartCache

type ChartCache struct {
	Refs            map[string]Chart
	DefaultChartRef string
	Root            string
	Puller
}

func (ChartCache) GetReleaseChart

func (cache ChartCache) GetReleaseChart(release *v1alpha1.Release) (Chart, error)

func (ChartCache) GetReleaseChartFS

func (cache ChartCache) GetReleaseChartFS(ctx context.Context, release *v1alpha1.Release) (*ChartFS, error)

type ChartFS

type ChartFS struct {
	Chart
	xfs.FS
}

type PullOptions

type PullOptions struct {
	Chart     Chart
	OutputDir string
}

type PullRenderer

type PullRenderer interface {
	Puller
	Render(ctx context.Context, opts RenderOpts) (string, error)
}

type PullRendererMock

type PullRendererMock struct {
	// PullFunc mocks the Pull method.
	PullFunc func(contextMoqParam context.Context, pullOptions PullOptions) error

	// RenderFunc mocks the Render method.
	RenderFunc func(ctx context.Context, opts RenderOpts) (string, error)
	// contains filtered or unexported fields
}

PullRendererMock is a mock implementation of PullRenderer.

func TestSomethingThatUsesPullRenderer(t *testing.T) {

	// make and configure a mocked PullRenderer
	mockedPullRenderer := &PullRendererMock{
		PullFunc: func(contextMoqParam context.Context, pullOptions PullOptions) error {
			panic("mock out the Pull method")
		},
		RenderFunc: func(ctx context.Context, opts RenderOpts) (string, error) {
			panic("mock out the Render method")
		},
	}

	// use mockedPullRenderer in code that requires PullRenderer
	// and then make assertions.

}

func (*PullRendererMock) Pull

func (mock *PullRendererMock) Pull(contextMoqParam context.Context, pullOptions PullOptions) error

Pull calls PullFunc.

func (*PullRendererMock) PullCalls

func (mock *PullRendererMock) PullCalls() []struct {
	ContextMoqParam context.Context
	PullOptions     PullOptions
}

PullCalls gets all the calls that were made to Pull. Check the length with:

len(mockedPullRenderer.PullCalls())

func (*PullRendererMock) Render

func (mock *PullRendererMock) Render(ctx context.Context, opts RenderOpts) (string, error)

Render calls RenderFunc.

func (*PullRendererMock) RenderCalls

func (mock *PullRendererMock) RenderCalls() []struct {
	Ctx  context.Context
	Opts RenderOpts
}

RenderCalls gets all the calls that were made to Render. Check the length with:

len(mockedPullRenderer.RenderCalls())

type Puller

type Puller interface {
	Pull(context.Context, PullOptions) error
}

type RenderOpts

type RenderOpts struct {
	ReleaseName string
	Values      map[string]any
	ChartPath   string
}