flapjack 1.0.0rc1 → 1.0.0rc2

data/libexec/oneoff.go

@@ -0,0 +1,75 @@
+package main
+
+import (
+	"os"
+	"fmt"
+	"time"
+	"strings"
+	"flapjack"
+	"gopkg.in/alecthomas/kingpin.v1"
+	"encoding/json"
+)
+
+var (
+	entity 		= kingpin.Arg("entity", "Entity name").Required().String()
+	check 		= kingpin.Arg("check", "Check name").Required().String()
+	state 		= kingpin.Arg("state", "Current state").Required().String()
+	summary 	= kingpin.Arg("summary", "Summary of event").Required().String()
+	debug		= kingpin.Flag("debug", "Enable verbose output (default false)").Bool()
+	server		= kingpin.Flag("server", "Redis server to connect to (default localhost:6380)").Default("localhost:6380").String()
+	database	= kingpin.Flag("database", "Redis database to connect to (default 0)").Int()
+)
+
+func main() {
+	kingpin.Version("0.0.1")
+	kingpin.Parse()
+
+	if *debug {
+		fmt.Println("Entity:", *entity)
+		fmt.Println("Check:", *check)
+		fmt.Println("State:", *state)
+		fmt.Println("Summary:", *summary)
+		fmt.Println("Debug:", *debug)
+		fmt.Println("Server:", *server)
+		fmt.Println("Database:", *database)
+	}
+
+	addr := strings.Split(*server, ":")
+	if len(addr) != 2 {
+		fmt.Println("Error: invalid address specified:", *server)
+		fmt.Println("Should be in format `addr:port` (e.g. 127.0.0.1:6380)")
+		os.Exit(1)
+	}
+
+	event := flapjack.Event{
+		Entity: 	*entity,
+		Check: 		*check,
+		Type:		"service",
+		State:		*state,
+		Summary:	*summary,
+		Time:		time.Now().Unix(),
+	}
+
+	if *debug {
+		data, _ := json.Marshal(event)
+		fmt.Printf("Event data: %s\n", data)
+	}
+
+	transport, err := flapjack.Dial(*server, *database)
+	if *debug {
+		fmt.Printf("Transport: %+v\n", transport)
+	}
+	if err != nil {
+		fmt.Println("Error: couldn't connect to Redis:", err)
+		os.Exit(1)
+	}
+
+	reply, err := transport.Send(event)
+	if *debug {
+		fmt.Println("Reply from Redis:", reply)
+	}
+	if err != nil {
+		fmt.Println("Error: couldn't send event:", err)
+		os.Exit(1)
+	}
+}

data/spec/lib/flapjack/data/entity_spec.rb

@@ -11,7 +11,7 @@ describe Flapjack::Data::Entity, :redis => true do
 
     expect(entity).not_to be_nil
     expect(entity.name).to eq(name)
-    expect(@redis.get("entity_id:#{name}")).to eq('')
+    expect(@redis.get("entity_id:#{name}")).to match(/^\S+$/)
   end
 
   it "adds a registered contact with an entity" do

data/spec/lib/flapjack/gateways/jabber_spec.rb

@@ -3,13 +3,14 @@ require 'flapjack/gateways/jabber'
 
 describe Flapjack::Gateways::Jabber, :logger => true do
 
-  let(:config) { {'queue'    => 'jabber_notifications',
-                  'server'   => 'example.com',
-                  'port'     => '5222',
-                  'jabberid' => 'flapjack@example.com',
-                  'password' => 'password',
-                  'alias'    => 'flapjack',
-                  'rooms'    => ['flapjacktest@conference.example.com']
+  let(:config) { {'queue'       => 'jabber_notifications',
+                  'server'      => 'example.com',
+                  'port'        => '5222',
+                  'jabberid'    => 'flapjack@example.com',
+                  'password'    => 'password',
+                  'alias'       => 'flapjack',
+                  'identifiers' => ['@flapjack'],
+                  'rooms'       => ['flapjacktest@conference.example.com']
                  }
   }
 
@@ -26,10 +27,11 @@ describe Flapjack::Gateways::Jabber, :logger => true do
     expect(fj).to receive(:register_handler).with(:ready).and_yield(stanza)
     expect(fj).to receive(:on_ready).with(stanza)
 
-    expect(fj).to receive(:register_handler).with(:message, :groupchat?, :body => /^flapjack:\s+/).and_yield(stanza)
+    body_matchers = [{:body => /^@flapjack[:\s]/}, {:body => /^flapjack[:\s]/}]
+    expect(fj).to receive(:register_handler).with(:message, :groupchat?, body_matchers).and_yield(stanza)
     expect(fj).to receive(:on_groupchat).with(stanza)
 
-    expect(fj).to receive(:register_handler).with(:message, :chat?).and_yield(stanza)
+    expect(fj).to receive(:register_handler).with(:message, :chat?, :body).and_yield(stanza)
     expect(fj).to receive(:on_chat).with(stanza)
 
     expect(fj).to receive(:register_handler).with(:disconnected).and_yield(stanza)
@@ -52,9 +54,8 @@ describe Flapjack::Gateways::Jabber, :logger => true do
   end
 
   it "receives an acknowledgement message" do
-    expect(stanza).to receive(:body).and_return('flapjack: ACKID 1f8ac10f fixing now duration: 90m')
+    expect(stanza).to receive(:body).twice.and_return('flapjack: ACKID 1f8ac10f fixing now duration: 90m')
     from = double('from')
-    expect(from).to receive(:resource).and_return('sender')
     expect(from).to receive(:stripped).and_return('sender')
     expect(stanza).to receive(:from).and_return(from)
 
@@ -85,12 +86,11 @@ describe Flapjack::Gateways::Jabber, :logger => true do
   end
 
   it "strips XML tags from the received message" do
-    expect(stanza).to receive(:body).
+    expect(stanza).to receive(:body).twice.
       and_return('flapjack: tell me about <span style="text-decoration: underline;">' +
                  '<a href="http://example.org/">example.org</a></span>')
 
     from = double('from')
-    expect(from).to receive(:resource).and_return('sender')
     expect(from).to receive(:stripped).and_return('sender')
     expect(stanza).to receive(:from).and_return(from)
 
@@ -119,11 +119,10 @@ describe Flapjack::Gateways::Jabber, :logger => true do
   end
 
   it "handles a message with a newline in it" do
-    expect(stanza).to receive(:body).
+    expect(stanza).to receive(:body).twice.
       and_return("flapjack: tell me about \nexample.com")
 
     from = double('from')
-    expect(from).to receive(:resource).and_return('sender')
     expect(from).to receive(:stripped).and_return('sender')
     expect(stanza).to receive(:from).and_return(from)
 
@@ -152,9 +151,8 @@ describe Flapjack::Gateways::Jabber, :logger => true do
   end
 
   it "receives a message it doesn't understand" do
-    expect(stanza).to receive(:body).once.and_return('flapjack: hello!')
+    expect(stanza).to receive(:body).twice.and_return('flapjack: hello!')
     from = double('from')
-    expect(from).to receive(:resource).and_return('sender')
     expect(from).to receive(:stripped).and_return('sender')
     expect(stanza).to receive(:from).and_return(from)
 

data/spec/lib/flapjack/gateways/jsonapi/check_methods_spec.rb

@@ -14,6 +14,63 @@ describe 'Flapjack::Gateways::JSONAPI::CheckMethods', :sinatra => true, :logger
 
   let(:check_presenter) { double(Flapjack::Gateways::JSONAPI::CheckPresenter) }
 
+  let(:check_data)      { {'entity_name' => 'www.example.com', 'name' => 'PING' } }
+
+  it "retrieves all checks" do
+    expect(entity).to receive(:id).and_return('23')
+
+    expect(entity_check).to receive(:entity).and_return(entity)
+    expect(entity_check).to receive(:key).twice.and_return('PING')
+    expect(entity_check).to receive(:to_jsonapi).and_return(check_data.to_json)
+    expect(Flapjack::Data::EntityCheck).to receive(:find_all).with(:redis => redis).
+      and_return([entity_check])
+
+    aget '/checks'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq({:checks => [check_data]}.to_json)
+  end
+
+  it "retrieves one check" do
+    expect(entity).to receive(:id).and_return('23')
+
+    expect(entity_check).to receive(:entity).and_return(entity)
+    expect(entity_check).to receive(:key).twice.and_return('PING')
+    expect(entity_check).to receive(:to_jsonapi).and_return(check_data.to_json)
+    expect(Flapjack::Data::EntityCheck).to receive(:for_event_id).
+      with('www.example.com:PING', :logger => @logger, :redis => redis).
+      and_return(entity_check)
+
+    aget '/checks/www.example.com:PING'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq({:checks => [check_data]}.to_json)
+  end
+
+  it "retrieves several entities" do
+    entity_check_2 = double(Flapjack::Data::EntityCheck)
+    check_data_2 = {'name'        => 'SSH',
+                    'entity_name' => 'www.example.com'}
+
+    expect(entity).to receive(:id).twice.and_return('23')
+
+    expect(entity_check).to receive(:entity).and_return(entity)
+    expect(entity_check).to receive(:key).twice.and_return('PING')
+    expect(entity_check).to receive(:to_jsonapi).and_return(check_data.to_json)
+    expect(Flapjack::Data::EntityCheck).to receive(:for_event_id).
+      with('www.example.com:PING', :logger => @logger, :redis => redis).
+      and_return(entity_check)
+
+    expect(entity_check_2).to receive(:entity).and_return(entity)
+    expect(entity_check_2).to receive(:key).twice.and_return('SSH')
+    expect(entity_check_2).to receive(:to_jsonapi).and_return(check_data_2.to_json)
+    expect(Flapjack::Data::EntityCheck).to receive(:for_event_id).
+      with('www.example.com:SSH', :logger => @logger, :redis => redis).
+      and_return(entity_check_2)
+
+    aget '/checks/www.example.com:PING,www.example.com:SSH'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq({:checks => [check_data, check_data_2]}.to_json)
+  end
+
   it 'disables a check' do
     expect(Flapjack::Data::Entity).to receive(:find_by_name).
       with(entity_name, :redis => redis).and_return(entity)

data/src/flapjack/event.go

@@ -0,0 +1,25 @@
+package flapjack
+
+import "errors"
+
+// Event is a basic representation of a Flapjack event.
+// Find more at https://github.com/flapjack/flapjack/wiki/DATA_STRUCTURES
+type Event struct {
+	Entity	string `json:"entity"`
+	Check	string `json:"check"`
+	Type	string `json:"type"`
+	State	string `json:"state"`
+	Summary	string `json:"summary"`
+	Time	int64  `json:"time"`
+}
+
+// IsValid performs basic validations on the event data.
+func (e Event) IsValid() (error) {
+	// FIXME(auxesis): provide validation errors for each failure
+	if len(e.Entity)  == 0 { return errors.New("no entity") }
+	if len(e.Check)   == 0 { return errors.New("no check") }
+	if len(e.State)   == 0 { return errors.New("no state") }
+	if len(e.Summary) == 0 { return errors.New("no summary") }
+	return nil
+}
+

data/src/flapjack/event_test.go

@@ -0,0 +1,26 @@
+package flapjack
+
+import "testing"
+
+func TestValidationFails(t *testing.T) {
+	event := Event{}
+	err := event.IsValid()
+
+	if err == nil {
+		t.Error("Expected validation to fail.")
+	}
+}
+
+func TestValidationPasses(t *testing.T) {
+	event := Event{
+		Entity:		"hello",
+		Check:		"world",
+		State:		"ok",
+		Summary:	"hello world",
+	}
+	err := event.IsValid()
+
+	if err != nil {
+		t.Error("Expected validation to pass, got:", err)
+	}
+}

data/src/flapjack/transport.go

@@ -0,0 +1,49 @@
+package flapjack
+
+import (
+	"encoding/json"
+	"github.com/garyburd/redigo/redis"
+)
+
+// Transport is a representation of a Redis connection.
+type Transport struct {
+	Address		string
+	Database	int
+	Connection	redis.Conn
+}
+
+// Dial establishes a connection to Redis, wrapped in a Transport.
+func Dial(address string, database int) (Transport,error) {
+	// Connect to Redis
+	conn, err := redis.Dial("tcp", address)
+	if err != nil {
+		return Transport{}, err
+	}
+
+	// Switch database
+	conn.Do("SELECT", database)
+
+	transport := Transport{
+		Address: 	address,
+		Database: 	database,
+		Connection:	conn,
+	}
+	return transport, nil
+}
+
+// Send takes an event and sends it over a transport.
+func (t Transport) Send(event Event) (interface{}, error) {
+	err := event.IsValid()
+	if err == nil {
+		data, _ := json.Marshal(event)
+		reply, err := t.Connection.Do("LPUSH", "events", data)
+		if err != nil {
+			return nil, err
+		}
+
+		return reply, nil
+	} else {
+		return nil, err
+	}
+}
+

data/src/flapjack/transport_test.go

@@ -0,0 +1,15 @@
+package flapjack
+
+import "testing"
+
+func TestDialFails(t *testing.T) {
+	address := "localhost:55555" // non-existent Redis server
+	database := 0
+	_, err := Dial(address, database)
+
+	if err == nil {
+		t.Error("Dial should fail")
+	}
+}
+
+// TODO(auxesis): add test for sending and receiving Events

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flapjack
 version: !ruby/object:Gem::Version
-  version: 1.0.0rc1
+  version: 1.0.0rc2
 platform: ruby
 authors:
 - Lindsay Holmwood
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dante
@@ -356,6 +356,7 @@ files:
 - README.md
 - Rakefile
 - bin/flapjack
+- build.sh
 - dist/etc/init.d/flapjack
 - dist/etc/init.d/flapjack-nagios-receiver
 - dist/etc/init.d/flapper
@@ -501,6 +502,8 @@ files:
 - lib/flapjack/redis_pool.rb
 - lib/flapjack/utility.rb
 - lib/flapjack/version.rb
+- libexec/httpbroker.go
+- libexec/oneoff.go
 - log/.gitkeep
 - spec/lib/flapjack/coordinator_spec.rb
 - spec/lib/flapjack/data/contact_spec.rb
@@ -546,6 +549,10 @@ files:
 - spec/support/jsonapi_helper.rb
 - spec/support/profile_all_formatter.rb
 - spec/support/uncolored_doc_formatter.rb
+- src/flapjack/event.go
+- src/flapjack/event_test.go
+- src/flapjack/transport.go
+- src/flapjack/transport_test.go
 - tasks/benchmarks.rake
 - tasks/events.rake
 - tasks/profile.rake