flapjack 1.6.0 → 2.0.0b1

data/spec/service_consumers/provider_support.rb

@@ -0,0 +1,8 @@
+module ProviderSupport
+
+  def default_tear_down
+    Flapjack.logger.messages.clear
+    Flapjack.redis.flushdb
+  end
+
+end

data/spec/spec_helper.rb

@@ -10,60 +10,40 @@ if ENV['COVERAGE']
   end
 end
 
+require 'i18n'
+I18n.config.enforce_available_locales = true
+
 FLAPJACK_ENV    = ENV["FLAPJACK_ENV"] || 'test'
 FLAPJACK_ROOT   = File.join(File.dirname(__FILE__), '..')
-FLAPJACK_CONFIG = File.join(FLAPJACK_ROOT, 'etc', 'flapjack_config.yaml')
+FLAPJACK_CONFIG = File.join(FLAPJACK_ROOT, 'etc', 'flapjack_test_config.toml')
 ENV['RACK_ENV'] = ENV["FLAPJACK_ENV"]
 
 require 'bundler'
 Bundler.require(:default, :test)
 
+ActiveSupport.use_standard_json_time_format = true
+ActiveSupport.time_precision = 0
+
 require 'webmock/rspec'
 WebMock.disable_net_connect!
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
-
-require 'redis'
+require 'flapjack'
+require 'flapjack/patches'
 require 'flapjack/configuration'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
-class MockLogger
-  attr_accessor :messages, :errors
-
-  def initialize
-    @messages = []
-    @errors   = []
-  end
-
-  %w(debug info warn).each do |level|
-    class_eval <<-RUBY
-      def #{level}(msg)
-        @messages << '#{level.upcase}' + ': ' + msg
-      end
-    RUBY
-  end
-
-  %w(error fatal).each do |level|
-    class_eval <<-ERRORS
-      def #{level}(msg)
-        @messages << '#{level.upcase}' + ': ' + msg
-        @errors   << '#{level.upcase}' + ': ' + msg
-      end
-    ERRORS
-  end
+require 'mail'
+::Mail.defaults do
+  delivery_method :test
+end
 
-  %w(debug info warn error fatal).each do |level|
-    class_eval <<-LEVELS
-      def #{level}?
-        true
-      end
-    LEVELS
-  end
+require 'flapjack/redis_proxy'
 
-end
+require './spec/service_consumers/fixture_data.rb'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -72,7 +52,6 @@ end
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  # config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
@@ -82,6 +61,9 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
 
+  # # TODO clear these up, where possible
+  # config.warnings = true
+
   unless (ENV.keys & ['SHOW_LOGGER_ALL', 'SHOW_LOGGER_ERRORS']).empty?
     config.instance_variable_set('@formatters', [])
     config.add_formatter(:documentation)
@@ -95,32 +77,40 @@ RSpec.configure do |config|
   end
 
   config.around(:each, :redis => true) do |example|
-    @redis = ::Redis.new($redis_options)
-    @redis.flushdb
+    Flapjack::RedisProxy.config = $redis_options
+    Zermelo.redis = Flapjack.redis
+    Flapjack.redis.flushdb
     example.run
-    @redis.quit
+    Flapjack.redis.quit
   end
 
   config.around(:each, :logger => true) do |example|
-    @logger = MockLogger.new
+    MockLogger.configure_log('flapjack')
+    Flapjack.logger = MockLogger.new
     example.run
 
     if ENV['SHOW_LOGGER_ALL']
-      puts @logger.messages.compact.join("\n")
+      puts Flapjack.logger.messages.compact.join("\n")
     end
 
     if ENV['SHOW_LOGGER_ERRORS']
-      puts @logger.errors.compact.join("\n")
+      puts Flapjack.logger.errors.compact.join("\n")
     end
 
-    @logger.errors.clear
+    Flapjack.logger.errors.clear
   end
 
   config.after(:each, :time => true) do
     Delorean.back_to_the_present
   end
 
+  config.after(:each) do
+    WebMock.reset!
+  end
+
+  config.include JsonSpec::Helpers, :sinatra => true
+  config.include Factory, :redis => true
   config.include ErbViewHelper, :erb_view => true
   config.include Rack::Test::Methods, :sinatra => true
-  config.include AsyncRackTest::Methods, :sinatra => true
+  config.include FixtureData, :pact_fixture => true
 end

data/spec/support/erb_view_helper.rb

@@ -8,7 +8,7 @@ module ErbViewHelper
   include Flapjack::Utility
 
   def render_erb(file, bind)
-    erb = ERB.new(File.read(TEMPLATE_PATH + file))
+    erb = ERB.new(File.read(TEMPLATE_PATH + file), nil, '-')
     erb.result(bind)
   end
 

data/spec/support/factories.rb

@@ -0,0 +1,58 @@
+require 'securerandom'
+
+module Factory
+
+  def self.redis
+    Zermelo.redis
+  end
+
+  def self.contact(attrs = {})
+    redis.multi do |r|
+      attrs[:id] ||= SecureRandom.uuid
+      r.hmset("contact:#{attrs[:id]}:attrs", {'name' => attrs[:name]}.flatten)
+      r.sadd('contact::attrs:ids', attrs[:id])
+      name = attrs[:name].gsub(/%/, '%%').gsub(/ /, '%20').gsub(/:/, '%3A')
+      r.sadd("contact::indices:by_name:string:#{name}", attrs[:id])
+    end
+  end
+
+  def self.medium(contact, attrs = {})
+    redis.multi do |r|
+      attrs[:id] ||= SecureRandom.uuid
+      r.hmset("medium:#{attrs[:id]}:attrs", {'transport' => attrs[:transport],
+        'address' => attrs[:address], 'interval' => attrs[:interval],
+        'rollup_threshold' => attrs[:rollup_threshold]}.flatten)
+      r.sadd('medium::attrs:ids', attrs[:id].to_s)
+      # transport is known not to contain unsafe chars
+      r.sadd("medium::indices:by_transport:string:#{attrs[:transport]}", attrs[:id])
+
+      r.sadd("contact:#{contact.id}:assocs:medium_ids", attrs[:id].to_s)
+    end
+  end
+
+  def self.tag(attrs = {})
+    redis.multi do |r|
+      attrs[:id] ||= SecureRandom.uuid
+      r.hmset("tag:#{attrs[:id]}:attrs", {'name' => attrs[:name]}.flatten)
+      r.sadd('tag::attrs:ids', attrs[:id])
+      name = attrs[:name].gsub(/%/, '%%').gsub(/ /, '%20').gsub(/:/, '%3A')
+      r.hset("tag::indices:by_name", "string:#{name}", attrs[:id])
+    end
+  end
+
+  def self.check(attrs = {})
+    attrs[:state] ||= 'ok'
+    redis.multi do |r|
+      attrs[:id] ||= SecureRandom.uuid
+      r.hmset("check:#{attrs[:id]}:attrs", {'name' => attrs[:name],
+        'state' => attrs[:state], 'enabled' => (!!attrs[:enabled]).to_s}.flatten)
+      r.sadd('check::attrs:ids', attrs[:id])
+      name = attrs[:name].gsub(/%/, '%%').gsub(/ /, '%20').gsub(/:/, '%3A')
+      r.hset("check::indices:by_name", "string:#{name}", attrs[:id])
+      # state is known not to contain unsafe chars
+      r.sadd("check::indices:by_state:string:#{attrs[:state]}", attrs[:id])
+      r.sadd("check::indices:by_enabled:boolean:#{!!attrs[:enabled]}", attrs[:id])
+    end
+  end
+
+end

data/spec/support/jsonapi_helper.rb

@@ -6,31 +6,16 @@ module JsonapiHelper
       Flapjack::Gateways::JSONAPI
     end
 
-    let(:contact)      { double(Flapjack::Data::Contact, :id => '21') }
-    let(:contact_core) {
-      {'id'         => contact.id,
-       'first_name' => "Ada",
-       'last_name'  => "Lovelace",
-       'email'      => "ada@example.com",
-       'tags'       => ["legend", "first computer programmer"]
-      }
-    }
-
     let(:redis)           { double(::Redis) }
 
-    let(:semaphore) {
-      double(Flapjack::Data::Semaphore, :resource => 'folly',
-             :key => 'semaphores:folly', :expiry => 30, :token => 'spatulas-R-us')
+    let(:jsonapi_env) {
+      {'CONTENT_TYPE' => 'application/vnd.api+json; charset=utf-8',
+       'HTTP_ACCEPT'  => 'application/vnd.api+json'}
     }
 
-    let(:jsonapi_post_env) {
-      {'CONTENT_TYPE' => 'application/json',
-       'HTTP_ACCEPT'  => 'application/json; q=0.8, application/vnd.api+json'}
-    }
-
-    let(:jsonapi_patch_env) {
-      {'CONTENT_TYPE' => 'application/json-patch+json',
-       'HTTP_ACCEPT'  => 'application/json; q=0.8, application/vnd.api+json'}
+    let(:jsonapi_bulk_env) {
+      {'CONTENT_TYPE' => 'application/vnd.api+json; ext=bulk; charset=utf-8',
+       'HTTP_ACCEPT'  => 'application/vnd.api+json'}
     }
 
     before(:all) do
@@ -40,20 +25,24 @@ module JsonapiHelper
     end
 
     before(:each) do
-      expect(Flapjack::RedisPool).to receive(:new).and_return(redis)
+      allow(Flapjack).to receive(:redis).and_return(redis)
       Flapjack::Gateways::JSONAPI.instance_variable_set('@config', {})
-      Flapjack::Gateways::JSONAPI.instance_variable_set('@logger', @logger)
       Flapjack::Gateways::JSONAPI.start
     end
 
     after(:each) do
-      if last_response.status >= 200 && last_response.status < 300
+      lr = nil
+      begin
+        lr = last_response
+      rescue Rack::Test::Error
+        lr = nil
+      end
+      if !lr.nil? && (last_response.status >= 200) && (last_response.status < 300)
         expect(last_response.headers.keys).to include('Access-Control-Allow-Methods')
         expect(last_response.headers['Access-Control-Allow-Origin']).to eq("*")
         unless last_response.status == 204
           expect(Flapjack.load_json(last_response.body)).to be_a(Enumerable)
-          ct = "#{Flapjack::Gateways::JSONAPI::JSONAPI_MEDIA_TYPE}; charset=UTF-8"
-          expect(last_response.headers['Content-Type']).to eq(ct)
+          expect(last_response.headers['Content-Type']).to eq( 'application/vnd.api+json; supported-ext=bulk; charset=utf-8')
         end
       end
     end

data/spec/support/mock_logger.rb

@@ -0,0 +1,43 @@
+class MockLogger
+  attr_accessor :messages, :errors
+
+  def self.configure_log(name, config = {})
+    @name = name
+  end
+
+  def initialize
+    @messages = []
+    @errors   = []
+  end
+
+  %w(debug info warn).each do |level|
+    class_eval <<-RUBY
+      def #{level}(msg = nil, &block)
+        msg = yield if msg.nil? && block_given?
+        @messages << '[#{level.upcase}] :: ' +
+          (self.class.instance_variable_get('@name') || 'flapjack') + ' :: ' + msg
+      end
+    RUBY
+  end
+
+  %w(error fatal).each do |level|
+    class_eval <<-ERRORS
+      def #{level}(msg = nil, &block)
+        msg = yield if msg.nil? && block_given?
+        @messages << '[#{level.upcase}] :: ' +
+          (self.class.instance_variable_get('@name') || 'flapjack') + ' :: ' + msg
+        @errors << '[#{level.upcase}] :: ' +
+          (self.class.instance_variable_get('@name') || 'flapjack') + ' :: ' + msg
+      end
+    ERRORS
+  end
+
+  %w(debug info warn error fatal).each do |level|
+    class_eval <<-LEVELS
+      def #{level}?
+        true
+      end
+    LEVELS
+  end
+
+end

data/spec/support/xmpp_comparable.rb

@@ -0,0 +1,24 @@
+# fix for deprecation warning introduced by
+# https://bugs.ruby-lang.org/issues/7688 ; remove when fixed in xmpp4r
+if (RUBY_VERSION.split('.') <=> ['2', '2', '0']) >= 0
+  require 'xmpp4r'
+  require 'xmpp4r/jid'
+  require 'xmpp4r/xmppstanza'
+
+  module ::Jabber
+    class JID
+      alias :orig_cmp :"<=>"
+      def <=>(o)
+        return nil unless o.kind_of?(::Jabber::JID)
+        orig_cmp(o)
+      end
+    end
+    class Presence < XMPPStanza
+      alias :orig_cmp :"<=>"
+      def <=>(o)
+        return nil unless o.kind_of?(::Jabber::Presence)
+        orig_cmp(o)
+      end
+    end
+  end
+end

data/src/flapjack/transport_test.go

@@ -12,4 +12,33 @@ func TestDialFails(t *testing.T) {
 	}
 }
 
-// TODO(auxesis): add test for sending and receiving Events
+func TestSendSucceeds(t *testing.T) {
+	transport, err := Dial("localhost:6379", 9)
+	if err != nil {
+		t.Fatalf("Couldn't establish connection to testing Redis: %s", err)
+	}
+	event := Event{
+		Entity:  "hello",
+		Check:   "world",
+		State:   "ok",
+		Summary: "hello world",
+	}
+
+	_, err = transport.Send(event)
+	if err != nil {
+		t.Fatalf("Error when sending event: %s", err)
+	}
+}
+
+func TestSendFails(t *testing.T) {
+	transport, err := Dial("localhost:0", 9)
+	if err == nil {
+		t.Fatal("Expected error when connecting to testing Redis, got none.")
+	}
+	event := Event{}
+
+	_, err = transport.Send(event)
+	if err == nil {
+		t.Fatal("Expected error when sending event, got none.")
+	}
+}

data/tasks/dump_keys.rake

@@ -0,0 +1,82 @@
+require 'redis'
+require 'securerandom'
+
+namespace :documentation do
+
+  require 'flapjack'
+  require 'flapjack/configuration'
+
+  require 'flapjack/data/check'
+  require 'flapjack/data/contact'
+  require 'flapjack/data/medium'
+  require 'flapjack/data/notification'
+  require 'flapjack/data/rule'
+  require 'flapjack/data/scheduled_maintenance'
+  require 'flapjack/data/state'
+  require 'flapjack/data/statistic'
+  require 'flapjack/data/tag'
+  require 'flapjack/data/unscheduled_maintenance'
+
+  task :dump_keys do
+
+    puts "Generated using `rake documentation:dump_keys` in the Flapjack codebase.\n\n---\n\n\n"
+
+    redis_klasses = [
+      Flapjack::Data::Check,
+      Flapjack::Data::Contact,
+      Flapjack::Data::Medium,
+      Flapjack::Data::Notification,
+      Flapjack::Data::Rule,
+      Flapjack::Data::ScheduledMaintenance,
+      Flapjack::Data::State,
+      Flapjack::Data::Statistic,
+      Flapjack::Data::Tag,
+      Flapjack::Data::UnscheduledMaintenance
+    ]
+
+    redis_klasses.each do |rk|
+      uuid = SecureRandom.uuid
+      klass_keys = rk.key_dump
+      instance_keys = rk.new(:id => uuid).key_dump
+
+      puts "# #{rk.short_model_name.human}\n\n"
+
+      unless klass_keys.empty?
+        puts "## global\n\n```"
+        klass_keys.keys.sort.each do |kk|
+          puts "#{kk} (#{klass_keys[kk].type})"
+        end
+      end
+
+      puts "```\n\n"
+
+      unless instance_keys.empty?
+        puts "## instance\n\n```"
+        attr_types = rk.attribute_types
+        unless attr_types.empty?
+          attrs_key = instance_keys.keys.detect {|ik| ik =~ /#{uuid}:attrs\z/}
+          attr_out = attrs_key.sub(/#{uuid}/, '[UUID]')
+          puts "#{attr_out} (hash)"
+          puts "  {\n"
+          complex_attrs = {}
+          attr_types.each_pair do |name, type|
+            if Zermelo::COLLECTION_TYPES.keys.include?(type)
+              complex_attrs[name] = type
+              next
+            end
+            puts "    :#{name}  => :#{type}"
+          end
+          puts "  }\n"
+        end
+        complex_attrs.each_pair do |name, type|
+          puts "#{attr_out}:#{name} (:#{type})"
+        end
+        instance_keys.keys.reject {|ik| ik.eql?(attrs_key)}.sort.each do |k|
+          puts "#{k.sub(/#{uuid}/, '[UUID]')} (#{instance_keys[k].type}) "
+        end
+      end
+
+      puts "```\n\n"
+    end
+  end
+end