test

package
v0.0.0-...-44a430f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 10, 2021 License: Apache-2.0, Apache-2.0 Imports: 20 Imported by: 0

Documentation

Overview

Package test is a test-only package that can be used by other cli package to write unit test.

It as an internal package and cannot be used outside of github.com/docker/cli package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CompareMultipleValues

func CompareMultipleValues(t *testing.T, value, expected string)

CompareMultipleValues compares comma-separated values, whatever the order is

func EnableContentTrust

func EnableContentTrust(c *FakeCli)

EnableContentTrust on the fake cli

func NewFakeStore

func NewFakeStore() credentials.Store

NewFakeStore creates a new file credentials store.

Types

type FakeCli

type FakeCli struct {
	command.DockerCli
	// contains filtered or unexported fields
}

FakeCli emulates the default DockerCli

func NewFakeCli

func NewFakeCli(client client.APIClient, opts ...func(*FakeCli)) *FakeCli

NewFakeCli returns a fake for the command.Cli interface

func (*FakeCli) Client

func (c *FakeCli) Client() client.APIClient

Client returns a docker API client

func (*FakeCli) ClientInfo

func (c *FakeCli) ClientInfo() command.ClientInfo

ClientInfo returns client information

func (*FakeCli) ConfigFile

func (c *FakeCli) ConfigFile() *configfile.ConfigFile

ConfigFile returns the cli configfile object (to get client configuration)

func (*FakeCli) ContentTrustEnabled

func (c *FakeCli) ContentTrustEnabled() bool

ContentTrustEnabled on the fake cli

func (*FakeCli) ContextStore

func (c *FakeCli) ContextStore() store.Store

ContextStore returns the cli context store

func (*FakeCli) CurrentContext

func (c *FakeCli) CurrentContext() string

CurrentContext returns the cli context

func (*FakeCli) DockerEndpoint

func (c *FakeCli) DockerEndpoint() docker.Endpoint

DockerEndpoint returns the current DockerEndpoint

func (*FakeCli) Err

func (c *FakeCli) Err() io.Writer

Err returns the output stream (stderr) the cli should write on

func (*FakeCli) ErrBuffer

func (c *FakeCli) ErrBuffer() *bytes.Buffer

ErrBuffer Buffer returns the stderr buffer

func (*FakeCli) In

func (c *FakeCli) In() *streams.In

In returns the input stream the cli will use

func (*FakeCli) ManifestStore

func (c *FakeCli) ManifestStore() manifeststore.Store

ManifestStore returns a fake store used for testing

func (*FakeCli) NotaryClient

func (c *FakeCli) NotaryClient(imgRefAndAuth trust.ImageRefAndAuth, actions []string) (notaryclient.Repository, error)

NotaryClient returns an err for testing unless defined

func (*FakeCli) Out

func (c *FakeCli) Out() *streams.Out

Out returns the output stream (stdout) the cli should write on

func (*FakeCli) OutBuffer

func (c *FakeCli) OutBuffer() *bytes.Buffer

OutBuffer returns the stdout buffer

func (*FakeCli) RegistryClient

func (c *FakeCli) RegistryClient(insecure bool) registryclient.RegistryClient

RegistryClient returns a fake client for testing

func (*FakeCli) ResetOutputBuffers

func (c *FakeCli) ResetOutputBuffers()

ResetOutputBuffers resets the .OutBuffer() and.ErrBuffer() back to empty

func (*FakeCli) ServerInfo

func (c *FakeCli) ServerInfo() command.ServerInfo

ServerInfo returns API server information for the server used by this client

func (*FakeCli) SetClientInfo

func (c *FakeCli) SetClientInfo(clientInfoFunc clientInfoFuncType)

SetClientInfo sets the internal getter for retrieving a ClientInfo

func (*FakeCli) SetConfigFile

func (c *FakeCli) SetConfigFile(configfile *configfile.ConfigFile)

SetConfigFile sets the "fake" config file

func (*FakeCli) SetContextStore

func (c *FakeCli) SetContextStore(store store.Store)

SetContextStore sets the "fake" context store

func (*FakeCli) SetCurrentContext

func (c *FakeCli) SetCurrentContext(name string)

SetCurrentContext sets the "fake" current context

func (*FakeCli) SetDockerEndpoint

func (c *FakeCli) SetDockerEndpoint(ep docker.Endpoint)

SetDockerEndpoint sets the "fake" docker endpoint

func (*FakeCli) SetErr

func (c *FakeCli) SetErr(err *bytes.Buffer)

SetErr sets the stderr stream for the cli to the specified io.Writer

func (*FakeCli) SetIn

func (c *FakeCli) SetIn(in *streams.In)

SetIn sets the input of the cli to the specified ReadCloser

func (*FakeCli) SetManifestStore

func (c *FakeCli) SetManifestStore(store manifeststore.Store)

SetManifestStore on the fake cli

func (*FakeCli) SetNotaryClient

func (c *FakeCli) SetNotaryClient(notaryClientFunc NotaryClientFuncType)

SetNotaryClient sets the internal getter for retrieving a NotaryClient

func (*FakeCli) SetOut

func (c *FakeCli) SetOut(out *streams.Out)

SetOut sets the stdout stream for the cli to the specified io.Writer

func (*FakeCli) SetRegistryClient

func (c *FakeCli) SetRegistryClient(client registryclient.RegistryClient)

SetRegistryClient on the fake cli

func (*FakeCli) StackOrchestrator

func (c *FakeCli) StackOrchestrator(flagValue string) (command.Orchestrator, error)

StackOrchestrator return the selected stack orchestrator

type FakeStore

type FakeStore struct {
	// contains filtered or unexported fields
}

FakeStore implements a credentials.Store that only acts as an in memory map

func (*FakeStore) Erase

func (c *FakeStore) Erase(serverAddress string) error

Erase removes the given credentials from the map store

func (*FakeStore) Get

func (c *FakeStore) Get(serverAddress string) (types.AuthConfig, error)

Get retrieves credentials for a specific server from the map store.

func (*FakeStore) GetAll

func (c *FakeStore) GetAll() (map[string]types.AuthConfig, error)

GetAll returns the key value pairs of ServerAddress => Username

func (*FakeStore) SetEraseFunc

func (c *FakeStore) SetEraseFunc(eraseFunc func(string) error)

SetEraseFunc is used to overrides Erase function

func (*FakeStore) SetGetAllFunc

func (c *FakeStore) SetGetAllFunc(getAllFunc func() (map[string]types.AuthConfig, error))

SetGetAllFunc is used to overrides GetAll function

func (*FakeStore) SetGetFunc

func (c *FakeStore) SetGetFunc(getFunc func(string) (types.AuthConfig, error))

SetGetFunc is used to overrides Get function

func (*FakeStore) SetStore

func (c *FakeStore) SetStore(store map[string]types.AuthConfig)

SetStore is used to overrides Set function

func (*FakeStore) SetStoreFunc

func (c *FakeStore) SetStoreFunc(storeFunc func(types.AuthConfig) error)

SetStoreFunc is used to override Store function

func (*FakeStore) Store

func (c *FakeStore) Store(authConfig types.AuthConfig) error

Store saves the given credentials in the map store.

type NotaryClientFuncType

type NotaryClientFuncType func(imgRefAndAuth trust.ImageRefAndAuth, actions []string) (notaryclient.Repository, error)

NotaryClientFuncType defines a function that returns a fake notary client

Directories

Path Synopsis
Package builders helps you create struct for your unit test while keeping them expressive.
Package builders helps you create struct for your unit test while keeping them expressive.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL