bot

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 25, 2018 License: Apache-2.0 Imports: 18 Imported by: 0

README

micro bot

The micro bot is a bot for ChatOps.

Run the bot inside your platform environment like any other service and interact with it via slack, hipchat, xmpp, etc.

Getting Started

Install Micro

go get github.com/micro/micro

Inputs

Inputs are services from which the bot can send and receive messages. This could be slack, hipchat, xmpp, irc, smtp, etc.

Slack Input
micro bot --inputs=slack --slack_token=SLACK_TOKEN
-
HipChat Input
micro bot --inputs=hipchat --hipchat_username=XMPP_USER --hipchat_password=XMPP_PASSWORD
-

Use multiple inputs by specifying a comma separated list

micro bot --inputs=hipchat,slack --slack_token=SLACK_TOKEN --hipchat_username=XMPP_USER --hipchat_password=XMPP_PASSWORD

Commands

Commands are executable actions. Think of a CLI via messaging.

The bot commands can be extended. See the example.

Type @micro help in slack to see a list of commands.

micro help

deregister service [definition] - Deregisters a service
echo [text] - Returns the [text]
get service [name] - Returns a registered service
health [service] - Returns health of a service
hello - Returns a greeting
list services - Returns a list of registered services
ping - Returns pong
call [service] [method] [request] - Returns the response for a service call
register service [definition] - Registers a service
the three laws - Returns the three laws of robotics
time - Returns the server time

Adding Commands

Commands are functions executed by the bot based on text based pattern matching.

Write a Command
import "github.com/micro/go-bot/command"

func Ping() command.Command {
	usage := "ping"
	description := "Returns pong"

	return command.NewCommand("ping", usage, desc, func(args ...string) ([]byte, error) {
		return []byte("pong"), nil
	})
}
Register the command

Add the command to the Commands map with a pattern key that can be matched by golang/regexp.Match

import "github.com/micro/go-bot/command"

func init() {
	command.Commands["^ping$"] = Ping()
}
Rebuild Micro

Build binary

cd github.com/micro/micro

// For local use
go build -i -o micro ./main.go

// For docker image
CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -ldflags '-w' -i -o micro ./main.go

Adding Inputs

Inputs are plugins for communication e.g Slack, HipChat, XMPP, IRC, SMTP, etc, etc.

New inputs can be added in the following way.

Write an Input

Write an input that satisfies the Input interface.

type Input interface {
	// Provide cli flags
	Flags() []cli.Flag
	// Initialise input using cli context
	Init(*cli.Context) error
	// Stream events from the input
	Stream() (Conn, error)
	// Start the input
	Start() error
	// Stop the input
	Stop() error
	// name of the input
	String() string
}
Register the input

Add the input to the Inputs map.

import "github.com/micro/go-bot/input"

func init() {
	input.Inputs["name"] = MyInput
}
Rebuild Micro

Build binary

cd github.com/micro/micro

// For local use
go build -i -o micro ./main.go

// For docker image
CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -ldflags '-w' -i -o micro ./main.go

Commands as Services

The micro bot supports the ability to create commands as microservices.

How does it work?

The bot watches the service registry for services with it's namespace. The default namespace is go.micro.bot. Any service within this namespace will automatically be added to the list of available commands. When a command is executed, the bot will call the service with method Command.Exec. It also expects the method Command.Help to exist for usage info.

The service interface is as follows and can be found at go-bot/proto

syntax = "proto3";

package go.micro.bot;

service Command {
	rpc Help(HelpRequest) returns (HelpResponse) {};
	rpc Exec(ExecRequest) returns (ExecResponse) {};
}

message HelpRequest {
}

message HelpResponse {
	string usage = 1;
	string description = 2;
}

message ExecRequest {
	repeated string args = 1;
}

message ExecResponse {
	bytes result = 1;
	string error = 2;
}

Example

Here's an example echo command as a microservice

package main

import (
	"context"
	"fmt"
	"strings"

	"github.com/micro/go-micro"

	proto "github.com/micro/go-bot/proto"
)

type Command struct{}

// Help returns the command usage
func (c *Command) Help(ctx context.Context, req *proto.HelpRequest, rsp *proto.HelpResponse) error {
	// Usage should include the name of the command
	rsp.Usage = "echo"
	rsp.Description = "This is an example bot command as a micro service which echos the message"
	return nil
}

// Exec executes the command
func (c *Command) Exec(ctx context.Context, req *proto.ExecRequest, rsp *proto.ExecResponse) error {
	rsp.Result = []byte(strings.Join(req.Args, " "))
	// rsp.Error could be set to return an error instead
	// the function error would only be used for service level issues
	return nil
}

func main() {
	service := micro.NewService(
		micro.Name("go.micro.bot.echo"),
	)

	service.Init()

	proto.RegisterCommandHandler(service.Server(), new(Command))

	if err := service.Run(); err != nil {
		fmt.Println(err)
	}
}

Documentation

Overview

Package bot is a Hubot style bot that sits a microservice environment

Index

Constants

This section is empty.

Variables

View Source
var (
	// Default server name
	Name = "go.micro.bot"
	// Namespace for commands
	Namespace = "go.micro.bot"
)

Functions

func Commands

func Commands() []cli.Command

func Plugins

func Plugins() []plugin.Plugin

Plugins lists the bot plugins

func Register

func Register(pl plugin.Plugin) error

Register registers an bot plugin

Types

This section is empty.

Directories

Path Synopsis
Package go_micro_bot is a generated protocol buffer package.
Package go_micro_bot is a generated protocol buffer package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL