extensions

Documentation

Index

• type ExtTemplateType
• type Extension
• type ExtensionManager
• type ExtensionManagerMock
  • func (mock *ExtensionManagerMock) Create(name string, tmplType ExtTemplateType) error
  • func (mock *ExtensionManagerMock) CreateCalls() []struct{ ... }
  • func (mock *ExtensionManagerMock) Dispatch(args []string, stdin io.Reader, stdout io.Writer, stderr io.Writer) (bool, error)
  • func (mock *ExtensionManagerMock) DispatchCalls() []struct{ ... }
  • func (mock *ExtensionManagerMock) EnableDryRunMode()
  • func (mock *ExtensionManagerMock) EnableDryRunModeCalls() []struct{}
  • func (mock *ExtensionManagerMock) Install(interfaceMoqParam ghrepo.Interface, s string) error
  • func (mock *ExtensionManagerMock) InstallCalls() []struct{ ... }
  • func (mock *ExtensionManagerMock) InstallLocal(dir string) error
  • func (mock *ExtensionManagerMock) InstallLocalCalls() []struct{ ... }
  • func (mock *ExtensionManagerMock) List() []Extension
  • func (mock *ExtensionManagerMock) ListCalls() []struct{}
  • func (mock *ExtensionManagerMock) Remove(name string) error
  • func (mock *ExtensionManagerMock) RemoveCalls() []struct{ ... }
  • func (mock *ExtensionManagerMock) Upgrade(name string, force bool) error
  • func (mock *ExtensionManagerMock) UpgradeCalls() []struct{ ... }
• type ExtensionMock
  • func (mock *ExtensionMock) CurrentVersion() string
  • func (mock *ExtensionMock) CurrentVersionCalls() []struct{}
  • func (mock *ExtensionMock) IsBinary() bool
  • func (mock *ExtensionMock) IsBinaryCalls() []struct{}
  • func (mock *ExtensionMock) IsLocal() bool
  • func (mock *ExtensionMock) IsLocalCalls() []struct{}
  • func (mock *ExtensionMock) IsPinned() bool
  • func (mock *ExtensionMock) IsPinnedCalls() []struct{}
  • func (mock *ExtensionMock) LatestVersion() string
  • func (mock *ExtensionMock) LatestVersionCalls() []struct{}
  • func (mock *ExtensionMock) Name() string
  • func (mock *ExtensionMock) NameCalls() []struct{}
  • func (mock *ExtensionMock) Owner() string
  • func (mock *ExtensionMock) OwnerCalls() []struct{}
  • func (mock *ExtensionMock) Path() string
  • func (mock *ExtensionMock) PathCalls() []struct{}
  • func (mock *ExtensionMock) URL() string
  • func (mock *ExtensionMock) URLCalls() []struct{}
  • func (mock *ExtensionMock) UpdateAvailable() bool
  • func (mock *ExtensionMock) UpdateAvailableCalls() []struct{}

Types

type ExtTemplateType

type ExtTemplateType int

const (
	GitTemplateType      ExtTemplateType = 0
	GoBinTemplateType    ExtTemplateType = 1
	OtherBinTemplateType ExtTemplateType = 2
)

type Extension

type Extension interface {
	Name() string // Extension Name without gh-
	Path() string // Path to executable
	URL() string
	CurrentVersion() string
	LatestVersion() string
	IsPinned() bool
	UpdateAvailable() bool
	IsBinary() bool
	IsLocal() bool
	Owner() string
}

type ExtensionManager

type ExtensionManager interface {
	List() []Extension
	Install(ghrepo.Interface, string) error
	InstallLocal(dir string) error
	Upgrade(name string, force bool) error
	Remove(name string) error
	Dispatch(args []string, stdin io.Reader, stdout, stderr io.Writer) (bool, error)
	Create(name string, tmplType ExtTemplateType) error
	EnableDryRunMode()
}

type ExtensionManagerMock

type ExtensionManagerMock struct {
	// CreateFunc mocks the Create method.
	CreateFunc func(name string, tmplType ExtTemplateType) error

	// DispatchFunc mocks the Dispatch method.
	DispatchFunc func(args []string, stdin io.Reader, stdout io.Writer, stderr io.Writer) (bool, error)

	// EnableDryRunModeFunc mocks the EnableDryRunMode method.
	EnableDryRunModeFunc func()

	// InstallFunc mocks the Install method.
	InstallFunc func(interfaceMoqParam ghrepo.Interface, s string) error

	// InstallLocalFunc mocks the InstallLocal method.
	InstallLocalFunc func(dir string) error

	// ListFunc mocks the List method.
	ListFunc func() []Extension

	// RemoveFunc mocks the Remove method.
	RemoveFunc func(name string) error

	// UpgradeFunc mocks the Upgrade method.
	UpgradeFunc func(name string, force bool) error
	// contains filtered or unexported fields
}

ExtensionManagerMock is a mock implementation of ExtensionManager.

func TestSomethingThatUsesExtensionManager(t *testing.T) {

	// make and configure a mocked ExtensionManager
	mockedExtensionManager := &ExtensionManagerMock{
		CreateFunc: func(name string, tmplType ExtTemplateType) error {
			panic("mock out the Create method")
		},
		DispatchFunc: func(args []string, stdin io.Reader, stdout io.Writer, stderr io.Writer) (bool, error) {
			panic("mock out the Dispatch method")
		},
		EnableDryRunModeFunc: func()  {
			panic("mock out the EnableDryRunMode method")
		},
		InstallFunc: func(interfaceMoqParam ghrepo.Interface, s string) error {
			panic("mock out the Install method")
		},
		InstallLocalFunc: func(dir string) error {
			panic("mock out the InstallLocal method")
		},
		ListFunc: func() []Extension {
			panic("mock out the List method")
		},
		RemoveFunc: func(name string) error {
			panic("mock out the Remove method")
		},
		UpgradeFunc: func(name string, force bool) error {
			panic("mock out the Upgrade method")
		},
	}

	// use mockedExtensionManager in code that requires ExtensionManager
	// and then make assertions.

}

func (*ExtensionManagerMock) Create

func (mock *ExtensionManagerMock) Create(name string, tmplType ExtTemplateType) error

Create calls CreateFunc.

func (*ExtensionManagerMock) CreateCalls

func (mock *ExtensionManagerMock) CreateCalls() []struct {
	Name     string
	TmplType ExtTemplateType
}

CreateCalls gets all the calls that were made to Create. Check the length with:

len(mockedExtensionManager.CreateCalls())

func (*ExtensionManagerMock) Dispatch

func (mock *ExtensionManagerMock) Dispatch(args []string, stdin io.Reader, stdout io.Writer, stderr io.Writer) (bool, error)

Dispatch calls DispatchFunc.

func (*ExtensionManagerMock) DispatchCalls

func (mock *ExtensionManagerMock) DispatchCalls() []struct {
	Args   []string
	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer
}

DispatchCalls gets all the calls that were made to Dispatch. Check the length with:

len(mockedExtensionManager.DispatchCalls())

func (*ExtensionManagerMock) EnableDryRunMode

func (mock *ExtensionManagerMock) EnableDryRunMode()

EnableDryRunMode calls EnableDryRunModeFunc.

func (*ExtensionManagerMock) EnableDryRunModeCalls

func (mock *ExtensionManagerMock) EnableDryRunModeCalls() []struct {
}

EnableDryRunModeCalls gets all the calls that were made to EnableDryRunMode. Check the length with:

len(mockedExtensionManager.EnableDryRunModeCalls())

func (*ExtensionManagerMock) Install

func (mock *ExtensionManagerMock) Install(interfaceMoqParam ghrepo.Interface, s string) error

Install calls InstallFunc.

func (*ExtensionManagerMock) InstallCalls

func (mock *ExtensionManagerMock) InstallCalls() []struct {
	InterfaceMoqParam ghrepo.Interface
	S                 string
}

InstallCalls gets all the calls that were made to Install. Check the length with:

len(mockedExtensionManager.InstallCalls())

func (*ExtensionManagerMock) InstallLocal

func (mock *ExtensionManagerMock) InstallLocal(dir string) error

InstallLocal calls InstallLocalFunc.

func (*ExtensionManagerMock) InstallLocalCalls

func (mock *ExtensionManagerMock) InstallLocalCalls() []struct {
	Dir string
}

InstallLocalCalls gets all the calls that were made to InstallLocal. Check the length with:

len(mockedExtensionManager.InstallLocalCalls())

func (*ExtensionManagerMock) List

func (mock *ExtensionManagerMock) List() []Extension

List calls ListFunc.

func (*ExtensionManagerMock) ListCalls

func (mock *ExtensionManagerMock) ListCalls() []struct {
}

ListCalls gets all the calls that were made to List. Check the length with:

len(mockedExtensionManager.ListCalls())

func (*ExtensionManagerMock) Remove

func (mock *ExtensionManagerMock) Remove(name string) error

Remove calls RemoveFunc.

func (*ExtensionManagerMock) RemoveCalls

func (mock *ExtensionManagerMock) RemoveCalls() []struct {
	Name string
}

RemoveCalls gets all the calls that were made to Remove. Check the length with:

len(mockedExtensionManager.RemoveCalls())

func (*ExtensionManagerMock) Upgrade

func (mock *ExtensionManagerMock) Upgrade(name string, force bool) error

Upgrade calls UpgradeFunc.

func (*ExtensionManagerMock) UpgradeCalls

func (mock *ExtensionManagerMock) UpgradeCalls() []struct {
	Name  string
	Force bool
}

UpgradeCalls gets all the calls that were made to Upgrade. Check the length with:

len(mockedExtensionManager.UpgradeCalls())

type ExtensionMock

type ExtensionMock struct {
	// CurrentVersionFunc mocks the CurrentVersion method.
	CurrentVersionFunc func() string

	// IsBinaryFunc mocks the IsBinary method.
	IsBinaryFunc func() bool

	// IsLocalFunc mocks the IsLocal method.
	IsLocalFunc func() bool

	// IsPinnedFunc mocks the IsPinned method.
	IsPinnedFunc func() bool

	// LatestVersionFunc mocks the LatestVersion method.
	LatestVersionFunc func() string

	// NameFunc mocks the Name method.
	NameFunc func() string

	// OwnerFunc mocks the Owner method.
	OwnerFunc func() string

	// PathFunc mocks the Path method.
	PathFunc func() string

	// URLFunc mocks the URL method.
	URLFunc func() string

	// UpdateAvailableFunc mocks the UpdateAvailable method.
	UpdateAvailableFunc func() bool
	// contains filtered or unexported fields
}

ExtensionMock is a mock implementation of Extension.

func TestSomethingThatUsesExtension(t *testing.T) {

	// make and configure a mocked Extension
	mockedExtension := &ExtensionMock{
		CurrentVersionFunc: func() string {
			panic("mock out the CurrentVersion method")
		},
		IsBinaryFunc: func() bool {
			panic("mock out the IsBinary method")
		},
		IsLocalFunc: func() bool {
			panic("mock out the IsLocal method")
		},
		IsPinnedFunc: func() bool {
			panic("mock out the IsPinned method")
		},
		LatestVersionFunc: func() string {
			panic("mock out the LatestVersion method")
		},
		NameFunc: func() string {
			panic("mock out the Name method")
		},
		OwnerFunc: func() string {
			panic("mock out the Owner method")
		},
		PathFunc: func() string {
			panic("mock out the Path method")
		},
		URLFunc: func() string {
			panic("mock out the URL method")
		},
		UpdateAvailableFunc: func() bool {
			panic("mock out the UpdateAvailable method")
		},
	}

	// use mockedExtension in code that requires Extension
	// and then make assertions.

}

func (*ExtensionMock) CurrentVersion

func (mock *ExtensionMock) CurrentVersion() string

CurrentVersion calls CurrentVersionFunc.

func (*ExtensionMock) CurrentVersionCalls

func (mock *ExtensionMock) CurrentVersionCalls() []struct {
}

CurrentVersionCalls gets all the calls that were made to CurrentVersion. Check the length with:

len(mockedExtension.CurrentVersionCalls())

func (*ExtensionMock) IsBinary

func (mock *ExtensionMock) IsBinary() bool

IsBinary calls IsBinaryFunc.

func (*ExtensionMock) IsBinaryCalls

func (mock *ExtensionMock) IsBinaryCalls() []struct {
}

IsBinaryCalls gets all the calls that were made to IsBinary. Check the length with:

len(mockedExtension.IsBinaryCalls())

func (*ExtensionMock) IsLocal

func (mock *ExtensionMock) IsLocal() bool

IsLocal calls IsLocalFunc.

func (*ExtensionMock) IsLocalCalls

func (mock *ExtensionMock) IsLocalCalls() []struct {
}

IsLocalCalls gets all the calls that were made to IsLocal. Check the length with:

len(mockedExtension.IsLocalCalls())

func (*ExtensionMock) IsPinned

func (mock *ExtensionMock) IsPinned() bool

IsPinned calls IsPinnedFunc.

func (*ExtensionMock) IsPinnedCalls

func (mock *ExtensionMock) IsPinnedCalls() []struct {
}

IsPinnedCalls gets all the calls that were made to IsPinned. Check the length with:

len(mockedExtension.IsPinnedCalls())

func (*ExtensionMock) LatestVersion

func (mock *ExtensionMock) LatestVersion() string

LatestVersion calls LatestVersionFunc.

func (*ExtensionMock) LatestVersionCalls

func (mock *ExtensionMock) LatestVersionCalls() []struct {
}

LatestVersionCalls gets all the calls that were made to LatestVersion. Check the length with:

len(mockedExtension.LatestVersionCalls())

func (*ExtensionMock) Name

func (mock *ExtensionMock) Name() string

Name calls NameFunc.

func (*ExtensionMock) NameCalls

func (mock *ExtensionMock) NameCalls() []struct {
}

NameCalls gets all the calls that were made to Name. Check the length with:

len(mockedExtension.NameCalls())

func (*ExtensionMock) Owner

func (mock *ExtensionMock) Owner() string

Owner calls OwnerFunc.

func (*ExtensionMock) OwnerCalls

func (mock *ExtensionMock) OwnerCalls() []struct {
}

OwnerCalls gets all the calls that were made to Owner. Check the length with:

len(mockedExtension.OwnerCalls())

func (*ExtensionMock) Path

func (mock *ExtensionMock) Path() string

Path calls PathFunc.

func (*ExtensionMock) PathCalls

func (mock *ExtensionMock) PathCalls() []struct {
}

PathCalls gets all the calls that were made to Path. Check the length with:

len(mockedExtension.PathCalls())

func (*ExtensionMock) URL

func (mock *ExtensionMock) URL() string

URL calls URLFunc.

func (*ExtensionMock) URLCalls

func (mock *ExtensionMock) URLCalls() []struct {
}

URLCalls gets all the calls that were made to URL. Check the length with:

len(mockedExtension.URLCalls())

func (*ExtensionMock) UpdateAvailable

func (mock *ExtensionMock) UpdateAvailable() bool

UpdateAvailable calls UpdateAvailableFunc.

func (*ExtensionMock) UpdateAvailableCalls

func (mock *ExtensionMock) UpdateAvailableCalls() []struct {
}

UpdateAvailableCalls gets all the calls that were made to UpdateAvailable. Check the length with:

len(mockedExtension.UpdateAvailableCalls())