notification

package

v0.0.0-...-03dd7be Latest Latest Go to latest Published: Jul 28, 2017 License: AGPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var NotifierTypes = map[string]Notifier{
	"shell": &ShellNotifier{},
	"log":   &LogNotifier{},
}

func Initialize(nbs []*NotifierBackend) error

func Send(e *event.Event) error

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

Log notifier dumps events to the specified file destination. Arguments:

"destination": log file path or STDOUT or STDERR (optional, default is STDERR)

func (l *LogNotifier) Destruct() error

func (l *LogNotifier) Initialize(args map[string]string) error

func (l *LogNotifier) Notify(e *event.Event) error

type Notifier interface {
	Initialize(map[string]string) error
	Notify(*event.Event) error
	Destruct() error
}

type NotifierBackend struct {
	Type string
	Args map[string]string
	// contains filtered or unexported fields
}

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

Shell notifier executes commands on fail and pass events. Event message is acessible from the commands with the %q format string. Arguments:

"fail_command": command to run on fail event
"pass_command": command to run on pass event

TODO implement proper shell escaping instead of relying on golang's format strings

func (_ *ShellNotifier) Destruct() error

func (s *ShellNotifier) Initialize(args map[string]string) error

func (s *ShellNotifier) Notify(e *event.Event) error