tracker

Documentation

Index

• Constants
• Variables
• type Connector
  • func NewConnector(t *model.Tracker) (conn Connector, err error)
• type IssueType
• type JiraConnector
  • func (r *JiraConnector) Create(t *model.Ticket) (err error)
  • func (r *JiraConnector) IssueTypes(id string) (issueTypes []IssueType, err error)
  • func (r *JiraConnector) Project(id string) (project Project, err error)
  • func (r *JiraConnector) Projects() (projects []Project, err error)
  • func (r *JiraConnector) RefreshAll() (tickets map[*model.Ticket]bool, err error)
  • func (r *JiraConnector) TestConnection() (connected bool, err error)
  • func (r *JiraConnector) With(t *model.Tracker)
• type Manager
  • func (m *Manager) Run(ctx context.Context)
• type Project

Constants

const (
	JiraEndpointBase    = "rest/api/2"
	JiraEndpointProject = JiraEndpointBase + "/project"
	JiraEndpointIssue   = JiraEndpointBase + "/issue"
	JiraEndpointSearch  = JiraEndpointBase + "/search"
	JiraEndpointMyself  = JiraEndpointBase + "/myself"
)

const (
	IntervalCreateRetry  = time.Second * 30
	IntervalRefresh      = time.Second * 30
	IntervalConnected    = time.Second * 60
	IntervalDisconnected = time.Second * 10
)

Intervals

const (
	JiraCloud  = "jira-cloud"
	JiraOnPrem = "jira-onprem"
)

Tracker types

const (
	New        = "New"
	InProgress = "In Progress"
	Done       = "Done"
	Unknown    = "Unknown"
)

Ticket status

const (
	BearerAuth = "bearer"
	BasicAuth  = "basic-auth"
)

Auth kinds

const IssueTypeEpic = "Epic"

Variables

var (
	Log = logr.WithName("tickets")
)

Types

type Connector

type Connector interface {
	// With updates the connector with the tracker model.
	With(t *model.Tracker)
	// Create a ticket in the external tracker.
	Create(t *model.Ticket) error
	// RefreshAll refreshes the status of all tickets.
	RefreshAll() (map[*model.Ticket]bool, error)
	// TestConnection to the external ticket tracker.
	TestConnection() (bool, error)
	// Projects lists the tracker's projects.
	Projects() ([]Project, error)
	// Project gets a project from the tracker.
	Project(id string) (Project, error)
	// IssueTypes gets the issue types for a project.
	IssueTypes(id string) ([]IssueType, error)
}

Connector is a connector for an external ticket tracker.

func NewConnector

func NewConnector(t *model.Tracker) (conn Connector, err error)

NewConnector instantiates a connector for an external ticket tracker.

type IssueType

type IssueType struct {
	ID   string
	Name string
}

IssueType represents a type of issue that can be created on an external issue tracker.

type JiraConnector

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

JiraConnector for the Jira Cloud API

func (*JiraConnector) Create

func (r *JiraConnector) Create(t *model.Ticket) (err error)

Create the ticket in Jira.

func (*JiraConnector) IssueTypes

func (r *JiraConnector) IssueTypes(id string) (issueTypes []IssueType, err error)

IssueTypes returns a list of IssueTypes for a Project.

func (*JiraConnector) Project

func (r *JiraConnector) Project(id string) (project Project, err error)

Project returns a Project.

func (*JiraConnector) Projects

func (r *JiraConnector) Projects() (projects []Project, err error)

Projects returns a list of Projects.

func (*JiraConnector) RefreshAll

func (r *JiraConnector) RefreshAll() (tickets map[*model.Ticket]bool, err error)

RefreshAll retrieves fresh status information for all the tracker's tickets.

func (*JiraConnector) TestConnection

func (r *JiraConnector) TestConnection() (connected bool, err error)

TestConnection to Jira Cloud.

func (*JiraConnector) With

func (r *JiraConnector) With(t *model.Tracker)

With updates the connector with the Tracker model.

type Manager

type Manager struct {
	// DB
	DB *gorm.DB
}

Manager provides ticket management.

func (*Manager) Run

func (m *Manager) Run(ctx context.Context)

Run the manager.

type Project

type Project struct {
	ID   string
	Name string
}

Project represents an external ticket tracker's project in which an issue can be created.