slack

Documentation

Index

• Variables
• func ParseUserMappings(users []string) (map[string]string, error)
• func Persist(path string, message Message) error
• type BuildsOptions
• type Client
  • func NewClient(slackClient SlackClient, emailMappings map[string]string, emailSuffix string) (*Client, error)
  • func NewMuteableClient(slackClient SlackClient, emailMappings map[string]string, emailSuffix string, ...) (*Client, error)
  • func (c *Client) NotifyK8SDeployEvent(ctx context.Context, event *http.ReleaseEvent) error
  • func (c *Client) NotifyK8SJobErrorEvent(ctx context.Context, event *http.JobErrorEvent) error
  • func (c *Client) NotifyK8SPodErrorEvent(ctx context.Context, event *http.PodErrorEvent) error
  • func (c *Client) NotifyRelease(ctx context.Context, releaseOptions ReleaseOptions)
  • func (c *Client) NotifyReleaseManagerError(ctx context.Context, ...) error
  • func (c *Client) NotifySlackBuildsChannel(options BuildsOptions) error
  • func (c *Client) NotifySlackPolicyFailed(ctx context.Context, email, title, errorMessage string) error
  • func (c *Client) NotifySlackPolicySucceeded(ctx context.Context, email, title, message string) error
  • func (c *Client) PostSlackBuildStarted(email, title, titleLink, text, color string) (string, string, error)
  • func (c *Client) UpdateMessage(path string, f func(Message) Message) error
  • func (c *Client) UpdateSlackBuildStatus(channel, title, titleLink, text, color, timestamp string) (string, string, error)
• type Message
  • func Get(path string) (Message, error)
• type MockSlackClient
  • func (_m *MockSlackClient) GetUserByEmailContext(ctx context.Context, email string) (*slack.User, error)
  • func (_m *MockSlackClient) PostMessage(channelID string, options ...slack.MsgOption) (string, string, error)
  • func (_m *MockSlackClient) PostMessageContext(ctx context.Context, channelID string, options ...slack.MsgOption) (string, string, error)
  • func (_m *MockSlackClient) UpdateMessage(channelID string, timestamp string, options ...slack.MsgOption) (string, string, string, error)
• type MuteOptions
• type ReleaseOptions
• type SlackClient

Variables

var (
	// ErrFileNotFound indicates that an artifact was not found.
	ErrFileNotFound = errors.New("file not found")
	// ErrNotParsable indicates that an artifact could not be parsed against the
	// artifact specification.
	ErrNotParsable = errors.New("message not parsable")
	// ErrUnknownFields indicates that an artifact contains an unknown field.
	ErrUnknownFields = errors.New("message contains unknown fields")

	MsgColorGreen  = "#73BF69"
	MsgColorYellow = "#FADE2A"
	MsgColorRed    = "#F2495C"
)

var (
	// ErrUnknownEmail indicates that an email is not from the specified domain
	// and no email mapping exists
	ErrUnknownEmail = errors.New("not an accepted email domain")
)

Functions

func ParseUserMappings

func ParseUserMappings(users []string) (map[string]string, error)

ParseUserMappings parses the slice users as key-value pairs separated with an equal (=) sign.

If any of the provided mappings are invalid or conflicting mappings are provided an error is returned.

func Persist

func Persist(path string, message Message) error

Types

type BuildsOptions

type BuildsOptions struct {
	Service       string
	ArtifactID    string
	Branch        string
	CommitSHA     string
	CommitLink    string
	CommitMessage string
	CommitAuthor  string
	CIJobURL      string
	Color         string
}

type Client

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

func NewClient

func NewClient(slackClient SlackClient, emailMappings map[string]string, emailSuffix string) (*Client, error)

func NewMuteableClient

func NewMuteableClient(slackClient SlackClient, emailMappings map[string]string, emailSuffix string, muteOptions MuteOptions) (*Client, error)

func (*Client) NotifyK8SDeployEvent

func (c *Client) NotifyK8SDeployEvent(ctx context.Context, event *http.ReleaseEvent) error

func (*Client) NotifyK8SJobErrorEvent

func (c *Client) NotifyK8SJobErrorEvent(ctx context.Context, event *http.JobErrorEvent) error

func (*Client) NotifyK8SPodErrorEvent

func (c *Client) NotifyK8SPodErrorEvent(ctx context.Context, event *http.PodErrorEvent) error

func (*Client) NotifyRelease

func (c *Client) NotifyRelease(ctx context.Context, releaseOptions ReleaseOptions)

func (*Client) NotifyReleaseManagerError

func (c *Client) NotifyReleaseManagerError(ctx context.Context, msgType, service, environment, branch, namespace, actorEmail string, inputErr error) error

func (*Client) NotifySlackBuildsChannel

func (c *Client) NotifySlackBuildsChannel(options BuildsOptions) error

func (*Client) NotifySlackPolicyFailed

func (c *Client) NotifySlackPolicyFailed(ctx context.Context, email, title, errorMessage string) error

func (*Client) NotifySlackPolicySucceeded

func (c *Client) NotifySlackPolicySucceeded(ctx context.Context, email, title, message string) error

func (*Client) PostSlackBuildStarted

func (c *Client) PostSlackBuildStarted(email, title, titleLink, text, color string) (string, string, error)

func (*Client) UpdateMessage

func (c *Client) UpdateMessage(path string, f func(Message) Message) error

UpdateMessage updates the message in the file located at path by applying f on the contents.

The stored Slack build message is updated accordingly.

func (*Client) UpdateSlackBuildStatus

func (c *Client) UpdateSlackBuildStatus(channel, title, titleLink, text, color, timestamp string) (string, string, error)

type Message

type Message struct {
	Color     string `json:"color,omitempty"`
	Channel   string `json:"channel,omitempty"`
	Text      string `json:"text,omitempty"`
	Title     string `json:"title,omitempty"`
	TitleLink string `json:"titleLink,omitempty"`
	Timestamp string `json:"timestamp,omitempty"`
	Service   string `json:"service,omitempty"`
}

func Get

func Get(path string) (Message, error)

type MockSlackClient

type MockSlackClient struct {
	mock.Mock
}

MockSlackClient is an autogenerated mock type for the SlackClient type

func (*MockSlackClient) GetUserByEmailContext

func (_m *MockSlackClient) GetUserByEmailContext(ctx context.Context, email string) (*slack.User, error)

GetUserByEmailContext provides a mock function with given fields: ctx, email

func (*MockSlackClient) PostMessage

func (_m *MockSlackClient) PostMessage(channelID string, options ...slack.MsgOption) (string, string, error)

PostMessage provides a mock function with given fields: channelID, options

func (*MockSlackClient) PostMessageContext

func (_m *MockSlackClient) PostMessageContext(ctx context.Context, channelID string, options ...slack.MsgOption) (string, string, error)

PostMessageContext provides a mock function with given fields: ctx, channelID, options

func (*MockSlackClient) UpdateMessage

func (_m *MockSlackClient) UpdateMessage(channelID string, timestamp string, options ...slack.MsgOption) (string, string, string, error)

UpdateMessage provides a mock function with given fields: channelID, timestamp, options

type MuteOptions

type MuteOptions struct {
	Kubernetes          bool
	Policy              bool
	ReleaseProcessed    bool
	Releases            bool
	BuildStatus         bool
	ReleaseManagerError bool
}

type ReleaseOptions

type ReleaseOptions struct {
	Service           string
	ArtifactID        string
	CommitSHA         string
	CommitLink        string
	CommitMessage     string
	CommitAuthor      string
	CommitAuthorEmail string
	Releaser          string
	Environment       string
}

type SlackClient

type SlackClient interface {
	GetUserByEmailContext(ctx context.Context, email string) (*slack.User, error)
	UpdateMessage(channelID, timestamp string, options ...slack.MsgOption) (string, string, string, error)
	PostMessage(channelID string, options ...slack.MsgOption) (string, string, error)
	PostMessageContext(ctx context.Context, channelID string, options ...slack.MsgOption) (string, string, error)
}