stoplight 3.0.0 → 4.0.0

data/spec/stoplight/data_store/memory_spec.rb

@@ -7,127 +7,16 @@ RSpec.describe Stoplight::DataStore::Memory do
   let(:light) { Stoplight::Light.new(name) {} }
   let(:name) { ('a'..'z').to_a.shuffle.join }
   let(:failure) { Stoplight::Failure.new('class', 'message', Time.new) }
-
-  it 'is a class' do
-    expect(described_class).to be_a(Class)
-  end
-
-  it 'is a subclass of Base' do
-    expect(described_class).to be < Stoplight::DataStore::Base
-  end
-
-  describe '#names' do
-    it 'is initially empty' do
-      expect(data_store.names).to eql([])
-    end
-
-    it 'contains the name of a light with a failure' do
-      data_store.record_failure(light, failure)
-      expect(data_store.names).to eql([light.name])
-    end
-
-    it 'contains the name of a light with a set state' do
-      data_store.set_state(light, Stoplight::State::UNLOCKED)
-      expect(data_store.names).to eql([light.name])
-    end
-
-    it 'does not duplicate names' do
-      data_store.record_failure(light, failure)
-      data_store.set_state(light, Stoplight::State::UNLOCKED)
-      expect(data_store.names).to eql([light.name])
-    end
-
-    it 'supports names containing colons' do
-      light = Stoplight::Light.new('http://api.example.com/some/action')
-      data_store.record_failure(light, failure)
-      expect(data_store.names).to eql([light.name])
-    end
-  end
-
-  describe '#get_all' 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
-
-  describe '#get_failures' do
-    it 'is initially empty' do
-      expect(data_store.get_failures(light)).to eql([])
-    end
-  end
-
-  describe '#record_failure' do
-    it 'returns the number of failures' do
-      expect(data_store.record_failure(light, failure)).to eql(1)
-    end
-
-    it 'persists the failure' do
-      data_store.record_failure(light, failure)
-      expect(data_store.get_failures(light)).to eql([failure])
-    end
-
-    it 'stores more recent failures at the front' do
-      data_store.record_failure(light, failure)
-      other = Stoplight::Failure.new('class', 'message 2', Time.new)
-      data_store.record_failure(light, other)
-      expect(data_store.get_failures(light)).to eql([other, failure])
-    end
-
-    it 'limits the number of stored failures' do
-      light.with_threshold(1)
-      data_store.record_failure(light, failure)
-      other = Stoplight::Failure.new('class', 'message 2', Time.new)
-      data_store.record_failure(light, other)
-      expect(data_store.get_failures(light)).to eql([other])
-    end
-  end
-
-  describe '#clear_failures' do
-    it 'returns the failures' do
-      data_store.record_failure(light, failure)
-      expect(data_store.clear_failures(light)).to eql([failure])
-    end
-
-    it 'clears the failures' do
-      data_store.record_failure(light, failure)
-      data_store.clear_failures(light)
-      expect(data_store.get_failures(light)).to eql([])
-    end
-  end
-
-  describe '#get_state' do
-    it 'is initially unlocked' do
-      expect(data_store.get_state(light)).to eql(Stoplight::State::UNLOCKED)
-    end
-  end
-
-  describe '#set_state' do
-    it 'returns the state' do
-      state = 'state'
-      expect(data_store.set_state(light, state)).to eql(state)
-    end
-
-    it 'persists the state' do
-      state = 'state'
-      data_store.set_state(light, state)
-      expect(data_store.get_state(light)).to eql(state)
-    end
-  end
-
-  describe '#clear_state' do
-    it 'returns the state' do
-      state = 'state'
-      data_store.set_state(light, state)
-      expect(data_store.clear_state(light)).to eql(state)
-    end
-
-    it 'clears the state' do
-      state = 'state'
-      data_store.set_state(light, state)
-      data_store.clear_state(light)
-      expect(data_store.get_state(light)).to eql(Stoplight::State::UNLOCKED)
-    end
-  end
+  let(:other) { Stoplight::Failure.new('class', 'message 2', Time.new) }
+
+  it_behaves_like 'Stoplight::DataStore::Base'
+  it_behaves_like 'Stoplight::DataStore::Base#names'
+  it_behaves_like 'Stoplight::DataStore::Base#get_failures'
+  it_behaves_like 'Stoplight::DataStore::Base#get_all'
+  it_behaves_like 'Stoplight::DataStore::Base#record_failure'
+  it_behaves_like 'Stoplight::DataStore::Base#clear_failures'
+  it_behaves_like 'Stoplight::DataStore::Base#get_state'
+  it_behaves_like 'Stoplight::DataStore::Base#set_state'
+  it_behaves_like 'Stoplight::DataStore::Base#clear_state'
+  it_behaves_like 'Stoplight::DataStore::Base#with_notification_lock'
 end

data/spec/stoplight/data_store/redis_spec.rb

@@ -1,146 +1,45 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
-require 'fakeredis'
 
-RSpec.describe Stoplight::DataStore::Redis do
-  let(:data_store) { described_class.new(redis) }
-  let(:redis) { Redis.new }
+RSpec.describe Stoplight::DataStore::Redis, :redis do
+  let(:data_store) { described_class.new(redis, redlock: redlock) }
+  let(:redlock) { instance_double(Redlock::Client) }
   let(:light) { Stoplight::Light.new(name) {} }
   let(:name) { ('a'..'z').to_a.shuffle.join }
-  let(:failure) { Stoplight::Failure.new('class', 'message', Time.new) }
+  let(:failure) { Stoplight::Failure.new('class', 'message', Time.new - 60) }
+  let(:other) { Stoplight::Failure.new('class', 'message 2', Time.new) }
 
-  before { Redis::Connection::Memory.reset_all_databases }
+  it_behaves_like 'Stoplight::DataStore::Base'
+  it_behaves_like 'Stoplight::DataStore::Base#names'
+  it_behaves_like 'Stoplight::DataStore::Base#get_all'
+  it_behaves_like 'Stoplight::DataStore::Base#record_failure'
+  it_behaves_like 'Stoplight::DataStore::Base#clear_failures'
+  it_behaves_like 'Stoplight::DataStore::Base#get_state'
+  it_behaves_like 'Stoplight::DataStore::Base#set_state'
+  it_behaves_like 'Stoplight::DataStore::Base#clear_state'
 
-  it 'is a class' do
-    expect(described_class).to be_a(Class)
-  end
-
-  it 'is a subclass of Base' do
-    expect(described_class).to be < Stoplight::DataStore::Base
-  end
+  it_behaves_like 'Stoplight::DataStore::Base#get_failures' do
+    context 'when JSON is invalid' do
+      before do
+        light.with_error_notifier { |_error| }
+      end
 
-  describe '#names' do
-    it 'is initially empty' do
-      expect(data_store.names).to eql([])
-    end
-
-    it 'contains the name of a light with a failure' do
-      data_store.record_failure(light, failure)
-      expect(data_store.names).to eql([light.name])
-    end
+      it 'handles it without an error' do
+        expect(failure).to receive(:to_json).and_return('invalid JSON')
 
-    it 'contains the name of a light with a set state' do
-      data_store.set_state(light, Stoplight::State::UNLOCKED)
-      expect(data_store.names).to eql([light.name])
-    end
-
-    it 'does not duplicate names' do
-      data_store.record_failure(light, failure)
-      data_store.set_state(light, Stoplight::State::UNLOCKED)
-      expect(data_store.names).to eql([light.name])
-    end
-
-    it 'supports names containing colons' do
-      light = Stoplight::Light.new('http://api.example.com/some/action')
-      data_store.record_failure(light, failure)
-      expect(data_store.names).to eql([light.name])
+        expect { data_store.record_failure(light, failure) }
+          .to change { data_store.get_failures(light) }
+          .to([have_attributes(error_class: 'JSON::ParserError')])
+      end
     end
   end
 
-  describe '#get_all' 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
-
-  describe '#get_failures' do
-    it 'is initially empty' do
-      expect(data_store.get_failures(light)).to eql([])
-    end
-
-    it 'handles invalid JSON' do
-      expect(redis.keys.size).to eql(0)
-      data_store.record_failure(light, failure)
-      expect(redis.keys.size).to eql(1)
-      redis.lset(redis.keys.first, 0, 'invalid JSON')
-      light.with_error_notifier { |_error| }
-      expect(data_store.get_failures(light).size).to eql(1)
-    end
-  end
-
-  describe '#record_failure' do
-    it 'returns the number of failures' do
-      expect(data_store.record_failure(light, failure)).to eql(1)
-    end
-
-    it 'persists the failure' do
-      data_store.record_failure(light, failure)
-      expect(data_store.get_failures(light)).to eq([failure])
-    end
-
-    it 'stores more recent failures at the head' do
-      data_store.record_failure(light, failure)
-      other = Stoplight::Failure.new('class', 'message 2', Time.new)
-      data_store.record_failure(light, other)
-      expect(data_store.get_failures(light)).to eq([other, failure])
-    end
-
-    it 'limits the number of stored failures' do
-      light.with_threshold(1)
-      data_store.record_failure(light, failure)
-      other = Stoplight::Failure.new('class', 'message 2', Time.new)
-      data_store.record_failure(light, other)
-      expect(data_store.get_failures(light)).to eq([other])
-    end
-  end
-
-  describe '#clear_failures' do
-    it 'returns the failures' do
-      data_store.record_failure(light, failure)
-      expect(data_store.clear_failures(light)).to eq([failure])
-    end
-
-    it 'clears the failures' do
-      data_store.record_failure(light, failure)
-      data_store.clear_failures(light)
-      expect(data_store.get_failures(light)).to eql([])
-    end
-  end
-
-  describe '#get_state' do
-    it 'is initially unlocked' do
-      expect(data_store.get_state(light)).to eql(Stoplight::State::UNLOCKED)
-    end
-  end
-
-  describe '#set_state' do
-    it 'returns the state' do
-      state = 'state'
-      expect(data_store.set_state(light, state)).to eql(state)
-    end
-
-    it 'persists the state' do
-      state = 'state'
-      data_store.set_state(light, state)
-      expect(data_store.get_state(light)).to eql(state)
-    end
-  end
-
-  describe '#clear_state' do
-    it 'returns the state' do
-      state = 'state'
-      data_store.set_state(light, state)
-      expect(data_store.clear_state(light)).to eql(state)
-    end
+  it_behaves_like 'Stoplight::DataStore::Base#with_notification_lock' do
+    let(:lock_key) { "stoplight:v4:notification_lock:#{name}" }
 
-    it 'clears the state' do
-      state = 'state'
-      data_store.set_state(light, state)
-      data_store.clear_state(light)
-      expect(data_store.get_state(light)).to eql(Stoplight::State::UNLOCKED)
+    before do
+      allow(redlock).to receive(:lock).with(lock_key, 2_000).and_yield
     end
   end
 end

data/spec/stoplight/error_spec.rb

@@ -17,6 +17,16 @@ RSpec.describe Stoplight::Error do
     end
   end
 
+  describe '::IncorrectColor' do
+    it 'is a class' do
+      expect(Stoplight::Error::IncorrectColor).to be_a(Class)
+    end
+
+    it 'is a subclass of StandardError' do
+      expect(Stoplight::Error::IncorrectColor).to be < StandardError
+    end
+  end
+
   describe '::RedLight' do
     it 'is a class' do
       expect(Stoplight::Error::RedLight).to be_a(Class)

data/spec/stoplight/light/lockable_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Stoplight::Light::Lockable do
+  subject(:light) { Stoplight::Light.new(name, &code) }
+
+  let(:code) { -> { code_result } }
+  let(:code_result) { random_string }
+  let(:name) { random_string }
+
+  def random_string
+    ('a'..'z').to_a.sample(8).join
+  end
+
+  describe '#lock' do
+    let(:color) { Stoplight::Color::GREEN }
+
+    context 'with correct color' do
+      it 'returns the light' do
+        expect(light.lock(color)).to be_a Stoplight::Light
+      end
+
+      context 'with green color' do
+        let(:color) { Stoplight::Color::GREEN }
+
+        it 'locks green color' do
+          expect(light.data_store).to receive(:set_state).with(light, Stoplight::State::LOCKED_GREEN)
+
+          light.lock(color)
+        end
+      end
+
+      context 'with red color' do
+        let(:color) { Stoplight::Color::RED }
+
+        it 'locks red color' do
+          expect(light.data_store).to receive(:set_state).with(light, Stoplight::State::LOCKED_RED)
+
+          light.lock(color)
+        end
+      end
+    end
+
+    context 'with incorrect color' do
+      let(:color) { 'incorrect-color' }
+
+      it 'raises Error::IncorrectColor error' do
+        expect { light.lock(color) }.to raise_error(Stoplight::Error::IncorrectColor)
+      end
+
+      it 'does not lock color' do
+        expect(light.data_store).to_not receive(:set_state)
+
+        suppress(Stoplight::Error::IncorrectColor) { light.lock(color) }
+      end
+    end
+  end
+
+  describe '#unlock' do
+    it 'returns the light' do
+      expect(light.unlock).to be_a Stoplight::Light
+    end
+
+    context 'with locked green light' do
+      before { light.lock(Stoplight::Color::GREEN) }
+
+      it 'unlocks light' do
+        expect(light.data_store).to receive(:set_state).with(light, Stoplight::State::UNLOCKED)
+
+        light.unlock
+      end
+    end
+
+    context 'with locked red light' do
+      before { light.lock(Stoplight::Color::RED) }
+
+      it 'unlocks light' do
+        expect(light.data_store).to receive(:set_state).with(light, Stoplight::State::UNLOCKED)
+
+        light.unlock
+      end
+    end
+
+    context 'with unlocked light' do
+      it 'unlocks light' do
+        expect(light.data_store).to receive(:set_state).with(light, Stoplight::State::UNLOCKED)
+
+        light.unlock
+      end
+    end
+  end
+end

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,234 +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
-
-        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 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
+  context 'with memory data store' do
+    let(:data_store) { Stoplight::DataStore::Memory.new }
 
-          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