cmdtest

Documentation

Index

• Variables
• func CopyTestRepo(log fatalLogger, name string) string
• func Eq(t *testing.T, got any, expected any)
• func ExecuteCommand(cmd *cobra.Command, cli string, stdout *bytes.Buffer, stderr *bytes.Buffer) (*test.CmdOut, error)
• func FirstLine(output []byte) string
• func InitIOStreams(isTTY bool, doHyperlinks string) (*iostreams.IOStreams, *bytes.Buffer, *bytes.Buffer, *bytes.Buffer)
• func InitTest(m *testing.M, suffix string)
• func RunCommand(cmd *cobra.Command, cli string, stds ...*bytes.Buffer) (*test.CmdOut, error)
• func StubFactory(repo string, io *iostreams.IOStreams) cmdutils.Factory
• func StubFactoryWithConfig(repo string, io *iostreams.IOStreams) (cmdutils.Factory, error)
• type CmdExecFunc
  • func SetupCmdForTest(t *testing.T, cmdFunc CmdFunc, opts ...FactoryOption) CmdExecFunc
• type CmdFunc
• type Factory
  • func InitFactory(ios *iostreams.IOStreams, rt http.RoundTripper) *Factory
  • func NewTestFactory(t *testing.T, ios *iostreams.IOStreams, opts ...FactoryOption) *Factory
  • func (f *Factory) BaseRepo() (glrepo.Interface, error)
  • func (f *Factory) Branch() (string, error)
  • func (f *Factory) Config() (config.Config, error)
  • func (f *Factory) HttpClient() (*gitlab.Client, error)
  • func (f *Factory) IO() *iostreams.IOStreams
  • func (f *Factory) Remotes() (glrepo.Remotes, error)
  • func (f *Factory) RepoOverride(repo string)
• type FactoryOption
  • func WithBaseRepo(owner, repo string) FactoryOption
  • func WithBaseRepoError(err error) FactoryOption
  • func WithBranch(branch string) FactoryOption
  • func WithBranchError(err error) FactoryOption
  • func WithConfig(cfg config.Config) FactoryOption
  • func WithConfigError(err error) FactoryOption
  • func WithGitLabClient(client *gitlab.Client) FactoryOption
  • func WithHttpClientError(err error) FactoryOption

Variables

var (
	ProjectPath    string
	GlabBinaryPath string
)

Functions

func CopyTestRepo

func CopyTestRepo(log fatalLogger, name string) string

func Eq

func Eq(t *testing.T, got any, expected any)

func ExecuteCommand

func ExecuteCommand(cmd *cobra.Command, cli string, stdout *bytes.Buffer, stderr *bytes.Buffer) (*test.CmdOut, error)

func FirstLine

func FirstLine(output []byte) string

func InitIOStreams

func InitIOStreams(isTTY bool, doHyperlinks string) (*iostreams.IOStreams, *bytes.Buffer, *bytes.Buffer, *bytes.Buffer)

func InitTest

func InitTest(m *testing.M, suffix string)

func RunCommand

func RunCommand(cmd *cobra.Command, cli string, stds ...*bytes.Buffer) (*test.CmdOut, error)

func StubFactory

func StubFactory(repo string, io *iostreams.IOStreams) cmdutils.Factory

func StubFactoryWithConfig

func StubFactoryWithConfig(repo string, io *iostreams.IOStreams) (cmdutils.Factory, error)

Types

type CmdExecFunc

type CmdExecFunc func(cli string) (*test.CmdOut, error)

func SetupCmdForTest

func SetupCmdForTest(t *testing.T, cmdFunc CmdFunc, opts ...FactoryOption) CmdExecFunc

SetupCmdForTest creates a test environment with a configured Factory

type CmdFunc

type CmdFunc func(cmdutils.Factory) *cobra.Command

type Factory

type Factory struct {
	HttpClientStub func() (*gitlab.Client, error)
	BaseRepoStub   func() (glrepo.Interface, error)
	RemotesStub    func() (glrepo.Remotes, error)
	ConfigStub     func() (config.Config, error)
	BranchStub     func() (string, error)
	IOStub         *iostreams.IOStreams
	// contains filtered or unexported fields
}

func InitFactory

func InitFactory(ios *iostreams.IOStreams, rt http.RoundTripper) *Factory

func NewTestFactory

func NewTestFactory(t *testing.T, ios *iostreams.IOStreams, opts ...FactoryOption) *Factory

NewTestFactory creates a Factory configured for testing with the given options

func (*Factory) BaseRepo

func (f *Factory) BaseRepo() (glrepo.Interface, error)

func (*Factory) Branch

func (f *Factory) Branch() (string, error)

func (*Factory) Config

func (f *Factory) Config() (config.Config, error)

func (*Factory) HttpClient

func (f *Factory) HttpClient() (*gitlab.Client, error)

func (*Factory) IO

func (f *Factory) IO() *iostreams.IOStreams

func (*Factory) Remotes

func (f *Factory) Remotes() (glrepo.Remotes, error)

func (*Factory) RepoOverride

func (f *Factory) RepoOverride(repo string)

type FactoryOption

type FactoryOption func(f *Factory)

FactoryOption is a function that configures a Factory

func WithBaseRepo

func WithBaseRepo(owner, repo string) FactoryOption

WithBaseRepo configures the Factory with a specific base repository

func WithBaseRepoError

func WithBaseRepoError(err error) FactoryOption

WithBaseRepoError configures the Factory to return an error when getting base repo

func WithBranch

func WithBranch(branch string) FactoryOption

WithBranch configures the Factory with a specific branch

func WithBranchError

func WithBranchError(err error) FactoryOption

WithBranchError configures the Factory to return an error when getting branch

func WithConfig

func WithConfig(cfg config.Config) FactoryOption

WithConfig configures the Factory with a specific config

func WithConfigError

func WithConfigError(err error) FactoryOption

func WithGitLabClient

func WithGitLabClient(client *gitlab.Client) FactoryOption

WithGitLabClient configures the Factory with a specific GitLab client

func WithHttpClientError

func WithHttpClientError(err error) FactoryOption

WithHttpClientError configures the Factory to return an error when creating HTTP client