engine

type Interface ¶

type Interface interface {
	// List lists tasks by their IDs.
	List(ctx context.Context, ids []string) ([]task.Ticket, error)
	// Get returns a single task by its ID.
	Get(ctx context.Context, id string) (task.Ticket, error)
}

Interface defines methods for task tracker engines.

type InterfaceMock ¶

type InterfaceMock struct {
	// GetFunc mocks the Get method.
	GetFunc func(ctx context.Context, id string) (task.Ticket, error)

	// ListFunc mocks the List method.
	ListFunc func(ctx context.Context, ids []string) ([]task.Ticket, error)
	// contains filtered or unexported fields
}

InterfaceMock is a mock implementation of Interface.

func TestSomethingThatUsesInterface(t *testing.T) {

	// make and configure a mocked Interface
	mockedInterface := &InterfaceMock{
		GetFunc: func(ctx context.Context, id string) (task.Ticket, error) {
			panic("mock out the Get method")
		},
		ListFunc: func(ctx context.Context, ids []string) ([]task.Ticket, error) {
			panic("mock out the List method")
		},
	}

	// use mockedInterface in code that requires Interface
	// and then make assertions.

}

func (mock *InterfaceMock) Get(ctx context.Context, id string) (task.Ticket, error)

func (mock *InterfaceMock) GetCalls() []struct {
	Ctx context.Context
	ID  string
}

len(mockedInterface.GetCalls())

func (mock *InterfaceMock) List(ctx context.Context, ids []string) ([]task.Ticket, error)

func (mock *InterfaceMock) ListCalls() []struct {
	Ctx context.Context
	Ids []string
}

len(mockedInterface.ListCalls())

type Jira ¶

type Jira struct {
	JiraParams
	// contains filtered or unexported fields
}

Jira is a Jira task tracker engine.

func NewJira(ctx context.Context, params JiraParams) (*Jira, error)

func (j *Jira) Get(ctx context.Context, key string) (task.Ticket, error)

func (j *Jira) List(ctx context.Context, keys []string) ([]task.Ticket, error)

type JiraParams ¶

type JiraParams struct {
	BaseURL    string
	Token      string
	HTTPClient http.Client
	Enricher   struct {
		LoadWatchers bool
	}
}

JiraParams is a set of parameters for Jira engine.

type Tracker ¶

type Tracker struct {
	Interface
}

Tracker is a wrapper for task tracker engine with common functions for each tracker implementation.

func (s *Tracker) List(ctx context.Context, ids []string, loadParents bool) ([]task.Ticket, error)

type Unsupported ¶

type Unsupported struct{}

Unsupported is a tracker implementation that returns an error for each method.

func (Unsupported) Get(context.Context, string) (task.Ticket, error)

func (Unsupported) List(context.Context, []string) ([]task.Ticket, error)