gerritssh

README

gerrit-stream-events

Go library to listen Gerrit stream events by SSH connection

Documentation

Index

• type Account
• type Approval
• type Change
• type Dependency
• type File
• type GerritSSH
  • func New(url string, username string, sshKeyPath string) GerritSSH
  • func (g *GerritSSH) Send(command string) (string, error)
  • func (g *GerritSSH) StartStreamEvents()
  • func (g *GerritSSH) StopStreamEvents()
• type Label
• type Message
• type PatchSet
• type PatchSetComment
• type RefUpdate
• type StreamEvent
• type SubmitRecord
• type TrackingID

Types

type Account

type Account struct {
	Name     string `json:"name,omitempty"`
	Email    string `json:"email,omitempty"`
	Username string `json:"username,omitempty"`
}

Account - A user account. https://gerrit-review.googlesource.com/Documentation/json.html#account

type Approval

type Approval struct {
	Type        string  `json:"type,omitempty"`
	Description string  `json:"description,omitempty"`
	Value       string  `json:"value,omitempty"`
	OldValue    string  `json:"oldValue,omitempty"`
	GrantedOn   int     `json:"grantedOn,omitempty"`
	Author      Account `json:"author,omitempty"`
}

Approval - Records the code review approval granted to a patch set. https://gerrit-review.googlesource.com/Documentation/json.html#approval

type Change

type Change struct {
	Project       string  `json:"project,omitempty"`
	Branch        string  `json:"branch,omitempty"`
	Topic         string  `json:"topic,omitempty"`
	ID            string  `json:"id,omitempty"`
	Number        string  `json:"number,omitempty"`
	Subject       string  `json:"subject,omitempty"`
	Owner         Account `json:"owner,omitempty"`
	URL           string  `json:"url,omitempty"`
	CommitMessage string  `json:"commitMessage,omitempty"`
	CreatedOn     int     `json:"createdOn,omitempty"`
	LastUpdate    int     `json:"lastUpdate,omitempty"`
	Open          bool    `json:"open,omitempty"`

	Status string `json:"status,omitempty"`

	Comments        []Message      `json:"comments,omitempty"`
	TrackingIDs     []TrackingID   `json:"trackingIds,omitempty"`
	CurrentPatchSet PatchSet       `json:"currentPatchSet,omitempty"`
	PatchSets       []PatchSet     `json:"patchSets,omitempty"`
	DependsOn       Dependency     `json:"dependsOn,omitempty"`
	NeededBy        Dependency     `json:"neededBy,omitempty"`
	SubmitRecords   []SubmitRecord `json:"submitRecords,omitempty"`
	AllReviewers    []Account      `json:"allReviewers,omitempty"`
}

Change - The Gerrit change being reviewed, or that was already reviewed https://gerrit-review.googlesource.com/Documentation/json.html#change

type Dependency

type Dependency struct {
	ID                string `json:"id,omitempty"`
	Number            string `json:"number,omitempty"`
	Revision          string `json:"revision,omitempty"`
	Ref               string `json:"ref,omitempty"`
	IsCurrentPatchSet bool   `json:"isCurrentPatchSet,omitempty"`
}

Dependency - Information about a change or patchset dependency. https://gerrit-review.googlesource.com/Documentation/json.html#dependency

type File

type File struct {
	File    string `json:"file,omitempty"`
	FileOld string `json:"fileOld,omitempty"`

	Type string `json:"type,omitempty"`

	Insertions int `json:"insertions,omitempty"`
	Deletions  int `json:"deletions,omitempty"`
}

File - Information about a patch on a file. https://gerrit-review.googlesource.com/Documentation/json.html#file

type GerritSSH

type GerritSSH struct {
	ID         int
	Username   string
	SSHKeyPath string
	URL        string
	StopChan   chan bool
	ResultChan chan StreamEvent
	Debug      bool
	// contains filtered or unexported fields
}

GerritSSH agent

func New

func New(url string, username string, sshKeyPath string) GerritSSH

New creates, and returns a new GerritESListener object. Its only argument is a channel that the worker can add itself to whenever it is done its work.

func (*GerritSSH) Send

func (g *GerritSSH) Send(command string) (string, error)

Send command over SSH to gerrit instance

func (*GerritSSH) StartStreamEvents

func (g *GerritSSH) StartStreamEvents()

StartStreamEvents starts stream event routine

func (*GerritSSH) StopStreamEvents

func (g *GerritSSH) StopStreamEvents()

StopStreamEvents stop stream event routine

type Label

type Label struct {
	Label  string `json:"label,omitempty"`
	Status string `json:"status,omitempty"`
	// OK - This label provides what is necessary for submission.
	// REJECT - This label prevents the change from being submitted.
	// NEED - The label is required for submission, but has not been satisfied.
	// MAY - The label may be set, but it’s neither necessary for submission nor does it block submission if set.
	// IMPOSSIBLE - The label is required for submission, but is impossible to complete. The likely cause is access has not been granted correctly by the project owner or site administrator.
	By Account `json:"by,omitempty"`
}

Label - Information about a code review label for a change. https://gerrit-review.googlesource.com/Documentation/json.html#label

type Message

type Message struct {
	Timestamp string  `json:"timestamp,omitempty"`
	Reviewer  Account `json:"reviewer,omitempty"`
	Message   string  `json:"message,omitempty"`
}

Message - Comment added on a change by a reviewer. https://gerrit-review.googlesource.com/Documentation/json.html#message

type PatchSet

type PatchSet struct {
	Number    string   `json:"number,omitempty"`
	Revision  string   `json:"revision,omitempty"`
	Parents   []string `json:"parents,omitempty"`
	Ref       string   `json:"ref,omitempty"`
	Uploader  Account  `json:"uploader,omitempty"`
	Author    Account  `json:"author,omitempty"`
	CreatedOn int      `json:"createdOn,omitempty"`
	IsDraft   bool     `json:"isDraft,omitempty"`

	Kind string `json:"kind,omitempty"`

	Approvals      []Approval        `json:"approvals,omitempty"`
	Comments       []PatchSetComment `json:"comments,omitempty"`
	Files          []File            `json:"files,omitempty"`
	SizeInsertions int               `json:"sizeInsertions,omitempty"`
	SizeDeletions  int               `json:"sizeDeletions,omitempty"`
}

PatchSet - Refers to a specific patchset within a change. https://gerrit-review.googlesource.com/Documentation/json.html#patchSet

type PatchSetComment

type PatchSetComment struct {
	File     string  `json:"file,omitempty"`
	Line     int     `json:"line,omitempty"`
	Reviewer Account `json:"reviewer,omitempty"`
	Message  string  `json:"message,omitempty"`
}

PatchSetComment - Comment added on a patchset by a reviewer. https://gerrit-review.googlesource.com/Documentation/json.html#patchsetcomment

type RefUpdate

type RefUpdate struct {
	OldRev  string `json:"oldRev,omitempty"`
	NewRev  string `json:"newRev,omitempty"`
	RefName string `json:"refName,omitempty"`
	Project string `json:"project,omitempty"`
}

RefUpdate - Information about a ref that was updated. https://gerrit-review.googlesource.com/Documentation/json.html#refUpdate

type StreamEvent

type StreamEvent struct {
	Type string `json:"type"`

	Change    Change     `json:"change,omitempty"`
	PatchSet  PatchSet   `json:"patchSet,omitempty"`
	Approvals []Approval `json:"approvals,omitempty"`

	Abandoner Account `json:"abandoner,omitempty"`
	Changer   Account `json:"changer,omitempty"`
	Submitter Account `json:"submitter,omitempty"`
	Restorer  Account `json:"restorer,omitempty"`
	Author    Account `json:"author, omitempty"`
	Uploader  Account `json:"uploader, omitempty"`
	Editor    Account `json:"editor, omitempty"`
	Reviewer  Account `json:"reviewer, omitempty"`

	NewRev      string    `json:"newRev,omitempty"`
	OldAssignee string    `json:"oldAssignee,omitempty"`
	OldTopic    string    `json:"oldTopic,omitempty"`
	Reason      string    `json:"reason,omitempty"`
	Comment     string    `json:"comment,omitempty"`
	Added       []string  `json:"added,omitempty"`
	Removed     []string  `json:"removed,omitempty"`
	HashTags    []string  `json:"hashtags,omitempty"`
	ProjectName string    `json:"projectName,omitempty"`
	ProjectHead string    `json:"projectHead,omitempty"`
	Project     string    `json:"project,omitempty"`
	RefName     string    `json:"refName,omitempty"`
	RefUpdate   RefUpdate `json:"refUpdate,omitempty"`

	EventCreatedOn int `json:"eventCreatedOn,omitempty"`
}

StreamEvent to store gerrit event https://gerrit-review.googlesource.com/Documentation/cmd-stream-events.html#events

type SubmitRecord

type SubmitRecord struct {
	Status string `json:"status,omitempty"`
	// OK - The change is ready for submission or already submitted.
	// NOT_READY - The change is missing a required label.
	// RULE_ERROR - An internal server error occurred preventing computation.
	Labels []Label `json:"labels,omitempty"`
}

SubmitRecord - Information about the submit status of a change. https://gerrit-review.googlesource.com/Documentation/json.html#submitRecord

type TrackingID

type TrackingID struct {
	System string `json:"system,omitempty"`
	ID     string `json:"id,omitempty"`
}

TrackingID - A link to an issue tracking system. https://gerrit-review.googlesource.com/Documentation/json.html#trackingid