stoplight 3.0.1 → 4.0.0

data/spec/stoplight/light/runnable_spec.rb

@@ -3,15 +3,7 @@
 require 'spec_helper'
 require 'stringio'
 
-RSpec.describe Stoplight::Light::Runnable do
-  subject { Stoplight::Light.new(name, &code) }
-
-  let(:code) { -> { code_result } }
-  let(:code_result) { random_string }
-  let(:fallback) { ->(_) { fallback_result } }
-  let(:fallback_result) { random_string }
-  let(:name) { random_string }
-
+RSpec.describe Stoplight::Light::Runnable, :redis do
   let(:failure) do
     Stoplight::Failure.new(error.class.name, error.message, time)
   end
@@ -24,266 +16,21 @@ RSpec.describe Stoplight::Light::Runnable do
     ('a'..'z').to_a.sample(8).join
   end
 
-  describe '#color' do
-    it 'is initially green' do
-      expect(subject.color).to eql(Stoplight::Color::GREEN)
-    end
-
-    it 'is green when locked green' do
-      subject.data_store.set_state(subject, Stoplight::State::LOCKED_GREEN)
-      expect(subject.color).to eql(Stoplight::Color::GREEN)
-    end
-
-    it 'is red when locked red' do
-      subject.data_store.set_state(subject, Stoplight::State::LOCKED_RED)
-      expect(subject.color).to eql(Stoplight::Color::RED)
-    end
-
-    it 'is red when there are many failures' do
-      subject.threshold.times do
-        subject.data_store.record_failure(subject, failure)
-      end
-      expect(subject.color).to eql(Stoplight::Color::RED)
-    end
-
-    it 'is yellow when the most recent failure is old' do
-      (subject.threshold - 1).times do
-        subject.data_store.record_failure(subject, failure)
-      end
-      other = Stoplight::Failure.new(
-        error.class.name, error.message, Time.new - subject.cool_off_time
-      )
-      subject.data_store.record_failure(subject, other)
-      expect(subject.color).to eql(Stoplight::Color::YELLOW)
-    end
-
-    it 'is red when the least recent failure is old' do
-      other = Stoplight::Failure.new(
-        error.class.name, error.message, Time.new - subject.cool_off_time
-      )
-      subject.data_store.record_failure(subject, other)
-      (subject.threshold - 1).times do
-        subject.data_store.record_failure(subject, failure)
-      end
-      expect(subject.color).to eql(Stoplight::Color::RED)
-    end
+  before do
+    light.with_data_store(data_store)
   end
 
-  describe '#run' do
-    let(:notifiers) { [notifier] }
-    let(:notifier) { Stoplight::Notifier::IO.new(io) }
-    let(:io) { StringIO.new }
-
-    before { subject.with_notifiers(notifiers) }
-
-    context 'when the light is green' do
-      before { subject.data_store.clear_failures(subject) }
-
-      it 'runs the code' do
-        expect(subject.run).to eql(code_result)
-      end
-
-      context 'with some failures' do
-        before { subject.data_store.record_failure(subject, failure) }
-
-        it 'clears the failures' do
-          subject.run
-          expect(subject.data_store.get_failures(subject).size).to eql(0)
-        end
-      end
-
-      context 'when the code is failing' do
-        let(:code_result) { raise error }
-
-        it 're-raises the error' do
-          expect { subject.run }.to raise_error(error.class)
-        end
-
-        it 'records the failure' do
-          expect(subject.data_store.get_failures(subject).size).to eql(0)
-          begin
-            subject.run
-          rescue error.class
-            nil
-          end
-          expect(subject.data_store.get_failures(subject).size).to eql(1)
-        end
-
-        context 'when we did not send notifications yet' do
-          it 'notifies when transitioning to red' do
-            subject.threshold.times do
-              expect(io.string).to eql('')
-              begin
-                subject.run
-              rescue error.class
-                nil
-              end
-            end
-            expect(io.string).to_not eql('')
-          end
-        end
-
-        context 'when we already sent notifications' do
-          before do
-            subject.data_store.with_notification_lock(subject, Stoplight::Color::GREEN, Stoplight::Color::RED) {}
-          end
-
-          it 'does not send new notifications' do
-            subject.threshold.times do
-              expect(io.string).to eql('')
-              begin
-                subject.run
-              rescue error.class
-                nil
-              end
-            end
-            expect(io.string).to eql('')
-          end
-        end
-
-        it 'notifies when transitioning to red' do
-          subject.threshold.times do
-            expect(io.string).to eql('')
-            begin
-              subject.run
-            rescue error.class
-              nil
-            end
-          end
-          expect(io.string).to_not eql('')
-        end
+  context 'with memory data store' do
+    let(:data_store) { Stoplight::DataStore::Memory.new }
 
-        context 'with an error handler' do
-          let(:result) do
-            subject.run
-            expect(false).to be(true)
-          rescue error.class
-            expect(true).to be(true)
-          end
-
-          it 'records the failure when the handler does nothing' do
-            subject.with_error_handler { |_error, _handler| }
-            expect { result }
-              .to change { subject.data_store.get_failures(subject).size }
-              .by(1)
-          end
-
-          it 'records the failure when the handler calls handle' do
-            subject.with_error_handler { |error, handle| handle.call(error) }
-            expect { result }
-              .to change { subject.data_store.get_failures(subject).size }
-              .by(1)
-          end
-
-          it 'does not record the failure when the handler raises' do
-            subject.with_error_handler { |error, _handle| raise error }
-            expect { result }
-              .to_not change { subject.data_store.get_failures(subject).size }
-          end
-        end
-
-        context 'with a fallback' do
-          before { subject.with_fallback(&fallback) }
-
-          it 'runs the fallback' do
-            expect(subject.run).to eql(fallback_result)
-          end
-
-          it 'passes the error to the fallback' do
-            subject.with_fallback do |e|
-              expect(e).to eql(error)
-              fallback_result
-            end
-            expect(subject.run).to eql(fallback_result)
-          end
-        end
-      end
-
-      context 'when the data store is failing' do
-        let(:data_store) { Object.new }
-        let(:error_notifier) { ->(_) {} }
-
-        before do
-          subject
-            .with_data_store(data_store)
-            .with_error_notifier(&error_notifier)
-        end
-
-        it 'runs the code' do
-          expect(subject.run).to eql(code_result)
-        end
-
-        it 'notifies about the error' do
-          has_notified = false
-          subject.with_error_notifier do |e|
-            has_notified = true
-            expect(e).to be_a(NoMethodError)
-          end
-          subject.run
-          expect(has_notified).to eql(true)
-        end
-      end
-    end
-
-    context 'when the light is yellow' do
-      before do
-        (subject.threshold - 1).times do
-          subject.data_store.record_failure(subject, failure)
-        end
-
-        other = Stoplight::Failure.new(
-          error.class.name, error.message, time - subject.cool_off_time
-        )
-        subject.data_store.record_failure(subject, other)
-      end
-
-      it 'runs the code' do
-        expect(subject.run).to eql(code_result)
-      end
-
-      it 'notifies when transitioning to green' do
-        expect(io.string).to eql('')
-        subject.run
-        expect(io.string).to_not eql('')
-      end
-    end
-
-    context 'when the light is red' do
-      before do
-        subject.threshold.times do
-          subject.data_store.record_failure(subject, failure)
-        end
-      end
-
-      it 'raises an error' do
-        expect { subject.run }.to raise_error(Stoplight::Error::RedLight)
-      end
-
-      it 'uses the name as the error message' do
-        e =
-          begin
-            subject.run
-          rescue Stoplight::Error::RedLight => e
-            e
-          end
-        expect(e.message).to eql(subject.name)
-      end
-
-      context 'with a fallback' do
-        before { subject.with_fallback(&fallback) }
+    it_behaves_like 'Stoplight::Light::Runnable#color'
+    it_behaves_like 'Stoplight::Light::Runnable#run'
+  end
 
-        it 'runs the fallback' do
-          expect(subject.run).to eql(fallback_result)
-        end
+  context 'with redis data store', :redis do
+    let(:data_store) { Stoplight::DataStore::Redis.new(redis) }
 
-        it 'does not pass anything to the fallback' do
-          subject.with_fallback do |e|
-            expect(e).to eql(nil)
-            fallback_result
-          end
-          expect(subject.run).to eql(fallback_result)
-        end
-      end
-    end
+    it_behaves_like 'Stoplight::Light::Runnable#color'
+    it_behaves_like 'Stoplight::Light::Runnable#run'
   end
 end

data/spec/stoplight/light_spec.rb

@@ -122,19 +122,9 @@ RSpec.describe Stoplight::Light do
     end
   end
 
-  describe '#with_cool_off_time' do
-    it 'sets the cool off time' do
-      cool_off_time = 1.2
-      light.with_cool_off_time(cool_off_time)
-      expect(light.cool_off_time).to eql(cool_off_time)
-    end
-  end
-
-  describe '#with_data_store' do
-    it 'sets the data store' do
-      data_store = Stoplight::DataStore::Memory.new
-      light.with_data_store(data_store)
-      expect(light.data_store).to eql(data_store)
+  describe '#window_size' do
+    it 'is initially the default' do
+      expect(light.window_size).to eql(Stoplight::Default::WINDOW_SIZE)
     end
   end
 
@@ -162,19 +152,5 @@ RSpec.describe Stoplight::Light do
     end
   end
 
-  describe '#with_notifiers' do
-    it 'sets the notifiers' do
-      notifiers = [Stoplight::Notifier::IO.new(StringIO.new)]
-      light.with_notifiers(notifiers)
-      expect(light.notifiers).to eql(notifiers)
-    end
-  end
-
-  describe '#with_threshold' do
-    it 'sets the threshold' do
-      threshold = 12
-      light.with_threshold(threshold)
-      expect(light.threshold).to eql(threshold)
-    end
-  end
+  it_behaves_like Stoplight::Configurable
 end

data/spec/stoplight/notifier/generic_spec.rb

@@ -2,49 +2,49 @@
 
 require 'spec_helper'
 
-RSpec.shared_examples_for 'a generic notifier' do
-  it 'includes Generic' do
-    expect(described_class).to include(Stoplight::Notifier::Generic)
+RSpec.describe Stoplight::Notifier::Generic do
+  let(:light) { Stoplight::Light.new(name) {} }
+  let(:name) { ('a'..'z').to_a.shuffle.join }
+  let(:from_color) { Stoplight::Color::GREEN }
+  let(:to_color) { Stoplight::Color::RED }
+  let(:error) { nil }
+
+  it 'is a module' do
+    expect(described_class).to be_a(Module)
   end
 
-  describe '#formatter' do
-    it 'is initially the default' do
-      formatter = nil
-      expect(described_class.new(nil, formatter).formatter)
-        .to eql(Stoplight::Default::FORMATTER)
+  describe '#put' do
+    let(:notifier) { notifier_class.new(double.as_null_object) }
+    let(:notifier_class) do
+      Class.new do
+        include Stoplight::Notifier::Generic
+      end
     end
 
-    it 'reads the formatter' do
-      formatter = proc {}
-      expect(described_class.new(nil, formatter).formatter)
-        .to eql(formatter)
+    it 'has to implement the #put method' do
+      expect do
+        notifier.notify(light, from_color, to_color, error)
+      end.to raise_error(NotImplementedError)
     end
   end
 
   describe '#notify' do
-    let(:light) { Stoplight::Light.new(name, &code) }
-    let(:name) { ('a'..'z').to_a.shuffle.join }
-    let(:code) { -> {} }
-    let(:from_color) { Stoplight::Color::GREEN }
-    let(:to_color) { Stoplight::Color::RED }
-    let(:notifier) { described_class.new(double.as_null_object) }
-
-    it 'returns the message' do
-      error = nil
-      expect(notifier.notify(light, from_color, to_color, error))
-        .to eql(notifier.formatter.call(light, from_color, to_color, error))
-    end
-
-    it 'returns the message with an error' do
-      error = ZeroDivisionError.new('divided by 0')
-      expect(notifier.notify(light, from_color, to_color, error))
-        .to eql(notifier.formatter.call(light, from_color, to_color, error))
+    let(:formatted_message) { 'formatted message' }
+    let(:notifier) { notifier_class.new(object) }
+    let(:notifier_class) do
+      Class.new do
+        include Stoplight::Notifier::Generic
+        def put(message)
+          object.put(message)
+        end
+      end
+
+      it 'puts formatted message' do
+        expect(formatter).to receive(:call).with(light, from_color, to_color, error) { formatted_message }
+        expect(object).to receive(:put).with(formatted_message)
+
+        expect(notifier.notify(light, from_color, to_color, error)).to eq(formatted_message)
+      end
     end
   end
 end
-
-RSpec.describe Stoplight::Notifier::Generic do
-  it 'is a module' do
-    expect(described_class).to be_a(Module)
-  end
-end

data/spec/stoplight/notifier/io_spec.rb

@@ -2,6 +2,7 @@
 
 require 'spec_helper'
 require 'stringio'
+require 'stoplight/rspec'
 
 RSpec.describe Stoplight::Notifier::IO do
   it_behaves_like 'a generic notifier'

data/spec/stoplight/notifier/logger_spec.rb

@@ -3,8 +3,11 @@
 require 'spec_helper'
 require 'logger'
 require 'stringio'
+require 'stoplight/rspec'
 
 RSpec.describe Stoplight::Notifier::Logger do
+  it_behaves_like 'a generic notifier'
+
   it 'is a class' do
     expect(described_class).to be_a(Class)
   end

data/spec/stoplight_spec.rb

@@ -9,13 +9,24 @@ RSpec.describe Stoplight do
 end
 
 RSpec.describe 'Stoplight' do
-  subject(:light) { Stoplight(name, &code) }
   let(:name) { ('a'..'z').to_a.shuffle.join }
-  let(:code) { -> {} }
 
-  it 'creates a stoplight' do
-    expect(light).to be_a(Stoplight::Light)
-    expect(light.name).to eql(name)
-    expect(light.code).to eql(code)
+  context 'with code' do
+    subject(:light) { Stoplight(name, &code) }
+    let(:code) { -> {} }
+
+    it 'creates a stoplight' do
+      expect(light).to be_a(Stoplight::Light)
+      expect(light.name).to eql(name)
+      expect(light.code).to eql(code)
+    end
+  end
+
+  context 'without code' do
+    subject(:light) { Stoplight(name) }
+
+    it 'creates a stoplight' do
+      expect(light).to eq(Stoplight::Builder.with(name: name))
+    end
   end
 end

data/spec/support/configurable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples Stoplight::Configurable do
+  let(:configurable) { described_class.new(configuration) }
+
+  let(:configuration) do
+    Stoplight::Configuration.new(
+      name: name,
+      data_store: Stoplight.default_data_store,
+      notifiers: Stoplight.default_notifiers,
+      error_notifier: Stoplight.default_error_notifier,
+      cool_off_time: Stoplight::Default::COOL_OFF_TIME,
+      threshold: Stoplight::Default::THRESHOLD,
+      window_size: Stoplight::Default::WINDOW_SIZE
+    )
+  end
+
+  shared_examples 'configurable attribute' do |attribute|
+    subject(:with_attribute) do
+      configurable.__send__("with_#{attribute}", __send__(attribute))
+    end
+
+    it "configures #{attribute}" do
+      expect(with_attribute.configuration.__send__(attribute)).to eq(__send__(attribute))
+    end
+  end
+
+  describe '#with_data_store' do
+    let(:data_store) { instance_double(Stoplight::DataStore::Redis) }
+
+    include_examples 'configurable attribute', :data_store
+  end
+
+  describe '#cool_off_time' do
+    let(:cool_off_time) { 1_000 }
+
+    include_examples 'configurable attribute', :cool_off_time
+  end
+
+  describe '#with_threshold' do
+    let(:threshold) { 1_000 }
+
+    include_examples 'configurable attribute', :threshold
+  end
+
+  describe '#with_window_size' do
+    let(:window_size) { 1_000 }
+
+    include_examples 'configurable attribute', :window_size
+  end
+
+  describe '#with_notifiers' do
+    let(:notifiers) { 1_000 }
+
+    include_examples 'configurable attribute', :notifiers
+  end
+
+  describe '#with_error_notifier' do
+    let(:error_notifier) { ->(x) { x } }
+
+    subject(:with_attribute) do
+      configurable.with_error_notifier(&error_notifier)
+    end
+
+    it 'configures error notifier' do
+      expect(with_attribute.configuration.error_notifier).to eq(error_notifier)
+    end
+  end
+end

data/spec/support/data_store/base/clear_failures.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'Stoplight::DataStore::Base#clear_failures' do
+  before do
+    data_store.record_failure(light, failure)
+  end
+
+  it 'returns the failures' do
+    expect(data_store.clear_failures(light)).to contain_exactly(failure)
+  end
+
+  it 'clears the failures' do
+    expect do
+      data_store.clear_failures(light)
+    end.to change { data_store.get_failures(light) }
+      .from([failure]).to(be_empty)
+  end
+end

data/spec/support/data_store/base/clear_state.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'Stoplight::DataStore::Base#clear_state' do
+  let(:state) { 'state' }
+
+  it 'returns the state' do
+    data_store.set_state(light, state)
+
+    expect(data_store.clear_state(light)).to eql(state)
+  end
+
+  it 'clears the state' do
+    data_store.set_state(light, state)
+
+    expect do
+      data_store.clear_state(light)
+    end.to change { data_store.get_state(light) }
+      .from(state).to(Stoplight::State::UNLOCKED)
+  end
+end

data/spec/support/data_store/base/get_all.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'Stoplight::DataStore::Base#get_all' do
+  context 'when there are no errors' do
+    it 'returns the failures and the state' do
+      failures, state = data_store.get_all(light)
+
+      expect(failures).to eql([])
+      expect(state).to eql(Stoplight::State::UNLOCKED)
+    end
+  end
+
+  context 'when there are errors' do
+    before do
+      data_store.record_failure(light, failure)
+    end
+
+    it 'returns the failures and the state' do
+      failures, state = data_store.get_all(light)
+
+      expect(failures).to eq([failure])
+      expect(state).to eql(Stoplight::State::UNLOCKED)
+    end
+  end
+
+  context 'when there is a failure outside of the window' do
+    let(:window_size) { 3600 }
+    let(:older_failure) { Stoplight::Failure.new('class', 'message 3', Time.new - window_size - 1) }
+
+    before do
+      light.with_window_size(window_size)
+
+      data_store.record_failure(light, older_failure)
+      data_store.record_failure(light, failure)
+    end
+
+    it 'returns the failures within window and the state' do
+      failures, state = data_store.get_all(light)
+
+      expect(failures).to contain_exactly(failure)
+      expect(state).to eql(Stoplight::State::UNLOCKED)
+    end
+  end
+end

data/spec/support/data_store/base/get_failures.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'Stoplight::DataStore::Base#get_failures' do
+  it 'is initially empty' do
+    expect(data_store.get_failures(light)).to eql([])
+  end
+
+  it 'handles invalid JSON' do
+    expect { data_store.record_failure(light, failure) }
+      .to change { data_store.get_failures(light) }
+      .from(be_empty)
+      .to(contain_exactly(failure))
+  end
+
+  context 'when there is a failure outside of the window' do
+    let(:window_size) { 3600 }
+    let(:older_failure) { Stoplight::Failure.new('class', 'message 3', Time.new - window_size - 1) }
+
+    before do
+      light.with_window_size(window_size)
+
+      data_store.record_failure(light, failure)
+      data_store.record_failure(light, older_failure)
+    end
+
+    it 'returns failures withing given window' do
+      expect(data_store.get_failures(light)).to contain_exactly(failure)
+    end
+  end
+end

data/spec/support/data_store/base/get_state.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'Stoplight::DataStore::Base#get_state' do
+  it 'is initially unlocked' do
+    expect(data_store.get_state(light)).to eql(Stoplight::State::UNLOCKED)
+  end
+end