flipper 0.3.0 → 0.4.0

data/spec/flipper/gates/actor_spec.rb

@@ -0,0 +1,52 @@
+require 'helper'
+require 'flipper/instrumenters/memory'
+
+describe Flipper::Gates::Actor do
+  let(:adapter) { double('Adapter', :set_members => []) }
+  let(:feature) { double('Feature', :name => :search, :adapter => adapter) }
+  let(:instrumenter) { Flipper::Instrumenters::Memory.new }
+
+  subject {
+    described_class.new(feature, :instrumenter => instrumenter)
+  }
+
+  describe "instrumentation" do
+    it "is recorded for open" do
+      thing = Struct.new(:flipper_id).new('22')
+      subject.open?(thing)
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('gate_operation.flipper')
+      event.payload.should eq({
+        :thing => thing,
+        :operation => :open?,
+        :result => false,
+        :gate_name => :actor,
+        :feature_name => :search,
+      })
+    end
+  end
+
+  describe "#description" do
+    context "with actors in set" do
+      before do
+        adapter.stub(:set_members => Set['bacon', 'ham'])
+      end
+
+      it "returns text" do
+        subject.description.should eq("actors (bacon, ham)")
+      end
+    end
+
+    context "with no actors in set" do
+      before do
+        adapter.stub(:set_members => Set.new)
+      end
+
+      it "returns disabled" do
+        subject.description.should eq('disabled')
+      end
+    end
+  end
+end

data/spec/flipper/gates/boolean_spec.rb

@@ -0,0 +1,52 @@
+require 'helper'
+require 'flipper/instrumenters/memory'
+
+describe Flipper::Gates::Boolean do
+  let(:adapter) { double('Adapter', :read => nil) }
+  let(:feature) { double('Feature', :name => :search, :adapter => adapter) }
+  let(:instrumenter) { Flipper::Instrumenters::Memory.new }
+
+  subject {
+    described_class.new(feature, :instrumenter => instrumenter)
+  }
+
+  describe "#description" do
+    context "for enabled" do
+      before do
+        subject.stub(:enabled? => true)
+      end
+
+      it "returns Enabled" do
+        subject.description.should eq('Enabled')
+      end
+    end
+
+    context "for disabled" do
+      before do
+        subject.stub(:enabled? => false)
+      end
+
+      it "returns Disabled" do
+        subject.description.should eq('Disabled')
+      end
+    end
+  end
+
+  describe "instrumentation" do
+    it "is recorded for open" do
+      thing = nil
+      subject.open?(thing)
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('gate_operation.flipper')
+      event.payload.should eq({
+        :thing => thing,
+        :operation => :open?,
+        :result => false,
+        :gate_name => :boolean,
+        :feature_name => :search,
+      })
+    end
+  end
+end

data/spec/flipper/gates/group_spec.rb

@@ -0,0 +1,79 @@
+require 'helper'
+require 'flipper/instrumenters/memory'
+
+describe Flipper::Gates::Group do
+  let(:adapter) { double('Adapter', :set_members => []) }
+  let(:feature) { double('Feature', :name => :search, :adapter => adapter) }
+  let(:instrumenter) { Flipper::Instrumenters::Memory.new }
+
+  subject {
+    described_class.new(feature, :instrumenter => instrumenter)
+  }
+
+  describe "instrumentation" do
+    it "is recorded for open" do
+      thing = Struct.new(:flipper_id).new('22')
+      subject.open?(thing)
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('gate_operation.flipper')
+      event.payload.should eq({
+        :thing => thing,
+        :operation => :open?,
+        :result => false,
+        :gate_name => :group,
+        :feature_name => :search,
+      })
+    end
+  end
+
+  describe "#description" do
+    context "with groups in set" do
+      before do
+        adapter.stub(:set_members => Set['bacon', 'ham'])
+      end
+
+      it "returns text" do
+        subject.description.should eq("groups (bacon, ham)")
+      end
+    end
+
+    context "with no groups in set" do
+      before do
+        adapter.stub(:set_members => Set.new)
+      end
+
+      it "returns disabled" do
+        subject.description.should eq('disabled')
+      end
+    end
+  end
+
+  describe "#open?" do
+    context "with a group in adapter, but not registered" do
+      before do
+        Flipper.register(:staff) { |thing| true }
+        adapter.stub(:set_members => Set[:newbs, :staff])
+      end
+
+      it "ignores group" do
+        thing = Struct.new(:flipper_id).new('5')
+        subject.open?(thing).should be_true
+      end
+    end
+
+    context "thing that does not respond to method in group block" do
+      before do
+        Flipper.register(:stinkers) { |thing| thing.stinker? }
+        adapter.stub(:set_members => Set[:stinkers])
+      end
+
+      it "raises error" do
+        expect {
+          subject.open?(Object.new)
+        }.to raise_error(NoMethodError)
+      end
+    end
+  end
+end

data/spec/flipper/gates/percentage_of_actors_spec.rb

@@ -0,0 +1,98 @@
+require 'helper'
+require 'flipper/instrumenters/memory'
+
+describe Flipper::Gates::PercentageOfActors do
+  let(:adapter) { double('Adapter', :read => nil) }
+  let(:feature) { double('Feature', :name => :search, :adapter => adapter) }
+  let(:instrumenter) { Flipper::Instrumenters::Memory.new }
+
+  subject {
+    described_class.new(feature, :instrumenter => instrumenter)
+  }
+
+  describe "instrumentation" do
+    it "is recorded for open" do
+      thing = Struct.new(:flipper_id).new('22')
+      subject.open?(thing)
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('gate_operation.flipper')
+      event.payload.should eq({
+        :thing => thing,
+        :operation => :open?,
+        :result => false,
+        :gate_name => :percentage_of_actors,
+        :feature_name => :search,
+      })
+    end
+  end
+
+  describe "#description" do
+    context "when enabled" do
+      before do
+        adapter.stub(:read => 22)
+      end
+
+      it "returns text" do
+        subject.description.should eq('22% of actors')
+      end
+    end
+
+    context "when disabled" do
+      before do
+        adapter.stub(:read => nil)
+      end
+
+      it "returns disabled" do
+        subject.description.should eq('disabled')
+      end
+    end
+  end
+
+  describe "#open?" do
+    context "when compared against two features" do
+      let(:percentage) { 0.05 }
+      let(:number_of_actors) { 100 }
+
+      let(:actors) {
+        (1..number_of_actors).map { |n|
+          Struct.new(:flipper_id).new(n)
+        }
+      }
+
+      let(:feature_one_enabled_actors) do
+        feature_one = double('Feature', :name => :name_one, :adapter => adapter)
+        gate = described_class.new(feature_one)
+        actors.select { |actor| gate.open? actor }
+      end
+
+      let(:feature_two_enabled_actors) do
+        feature_two = double('Feature', :name => :name_two, :adapter => adapter)
+        gate = described_class.new(feature_two)
+        actors.select { |actor| gate.open? actor }
+      end
+
+      before do
+        percentage_as_integer = percentage * 100
+        adapter.stub(:read => percentage_as_integer)
+      end
+
+      it "does not enable both features for same set of actors" do
+        feature_one_enabled_actors.should_not eq(feature_two_enabled_actors)
+      end
+
+      it "enables feature for accurate number of actors for each feature" do
+        margin_of_error = 0.02 * number_of_actors # 2 percent margin of error
+        expected_enabled_size = number_of_actors * percentage
+
+        [
+          feature_one_enabled_actors.size,
+          feature_two_enabled_actors.size,
+        ].each do |actual_enabled_size|
+          actual_enabled_size.should be_within(margin_of_error).of(expected_enabled_size)
+        end
+      end
+    end
+  end
+end

data/spec/flipper/gates/percentage_of_random_spec.rb

@@ -0,0 +1,54 @@
+require 'helper'
+require 'flipper/instrumenters/memory'
+
+describe Flipper::Gates::PercentageOfRandom do
+  let(:adapter) { double('Adapter', :read => 5) }
+  let(:feature) { double('Feature', :name => :search, :adapter => adapter) }
+  let(:instrumenter) { Flipper::Instrumenters::Memory.new }
+
+  subject {
+    described_class.new(feature, :instrumenter => instrumenter)
+  }
+
+  describe "instrumentation" do
+    it "is recorded for open" do
+      thing = Struct.new(:flipper_id).new('22')
+      subject.open?(thing)
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('gate_operation.flipper')
+
+      event.payload[:thing].should eq(thing)
+      event.payload[:operation].should eq(:open?)
+      event.payload[:gate_name].should eq(:percentage_of_random)
+      event.payload[:feature_name].should eq(:search)
+
+      # random so don't test value
+      event.payload.key?(:result).should be_true
+      event.payload[:result].should_not be_nil
+    end
+  end
+
+  describe "#description" do
+    context "when enabled" do
+      before do
+        adapter.stub(:read => 22)
+      end
+
+      it "returns text" do
+        subject.description.should eq('22% of the time')
+      end
+    end
+
+    context "when disabled" do
+      before do
+        adapter.stub(:read => nil)
+      end
+
+      it "returns disabled" do
+        subject.description.should eq('disabled')
+      end
+    end
+  end
+end

data/spec/flipper/instrumentation/log_subscriber_spec.rb

@@ -0,0 +1,104 @@
+require 'helper'
+require 'flipper/adapters/memory'
+require 'flipper/instrumentation/log_subscriber'
+
+describe Flipper::Instrumentation::LogSubscriber do
+  let(:adapter) { Flipper::Adapters::Memory.new }
+  let(:flipper) {
+    Flipper.new(adapter, :instrumenter => ActiveSupport::Notifications)
+  }
+
+  before do
+    Flipper.register(:admins) { |thing|
+      thing.respond_to?(:admin?) && thing.admin?
+    }
+
+    @io = StringIO.new
+    logger = Logger.new(@io)
+    logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }
+    described_class.logger = logger
+  end
+
+  after do
+    described_class.logger = nil
+  end
+
+  let(:log) { @io.string }
+
+  context "feature enabled checks" do
+    before do
+      clear_logs
+      flipper[:search].enabled?
+    end
+
+    it "logs feature calls with result after operation" do
+      feature_line = find_line('Flipper feature(search) enabled? false')
+      feature_line.should include('[ thing=nil ]')
+    end
+
+    it "logs adapter calls" do
+      adapter_line = find_line('Flipper feature(search) adapter(memory) read("search/boolean")')
+      adapter_line.should include('[ result=nil ]')
+    end
+
+    it "logs gate calls" do
+      gate_line = find_line('Flipper feature(search) gate(boolean) open? false')
+      gate_line.should include('[ thing=nil ]')
+    end
+  end
+
+  context "feature enabled checks with a thing" do
+    let(:user) { Struct.new(:flipper_id).new('1') }
+
+    before do
+      clear_logs
+      flipper[:search].enabled?(user)
+    end
+
+    it "logs thing for feature" do
+      feature_line = find_line('Flipper feature(search) enabled?')
+      feature_line.should include(user.inspect)
+    end
+
+    it "logs thing for gate" do
+      gate_line = find_line('Flipper feature(search) gate(boolean) open')
+      gate_line.should include(user.inspect)
+    end
+  end
+
+  context "changing feature enabled state" do
+    let(:user) { Struct.new(:flipper_id).new('1') }
+
+    before do
+      clear_logs
+      flipper[:search].enable(user)
+    end
+
+    it "logs feature calls with result in brackets" do
+      feature_line = find_line('Flipper feature(search) enable true')
+      feature_line.should include("[ thing=#{user.inspect} gate_name=actor ]")
+    end
+
+    it "logs adapter value" do
+      adapter_line = find_line('Flipper feature(search) adapter(memory) set_add("search/actors")')
+      adapter_line.should include("value=#{user.flipper_id.to_s.inspect}")
+    end
+
+    it "logs adapter calls not related to a specific feature" do
+      adapter_line = find_line('Flipper adapter(memory) set_add("features")')
+      log.should_not include('Could not log')
+      log.should_not include('NoMethodError: undefined method')
+    end
+  end
+
+  def find_line(str)
+    regex = /#{Regexp.escape(str)}/
+    lines = log.split("\n")
+    lines.detect { |line| line =~ regex } ||
+      raise("Could not find line matching #{str.inspect} in #{lines.inspect}")
+  end
+
+  def clear_logs
+    @io.string = ''
+  end
+end

data/spec/flipper/instrumentation/metriks_subscriber_spec.rb

@@ -0,0 +1,69 @@
+require 'helper'
+require 'flipper/adapters/memory'
+require 'flipper/instrumentation/metriks'
+
+describe Flipper::Instrumentation::MetriksSubscriber do
+  let(:adapter) { Flipper::Adapters::Memory.new }
+  let(:flipper) {
+    Flipper.new(adapter, :instrumenter => ActiveSupport::Notifications)
+  }
+
+  let(:user) { user = Struct.new(:flipper_id).new('1') }
+
+  before do
+    Metriks::Registry.default.clear
+  end
+
+  context "for enabled feature" do
+    it "updates feature metrics when calls happen" do
+      flipper[:stats].enable(user)
+      Metriks.timer("flipper.feature_operation.enable").count.should be(1)
+
+      flipper[:stats].enabled?(user)
+      Metriks.timer("flipper.feature_operation.enabled").count.should be(1)
+      Metriks.meter("flipper.feature.stats.enabled").count.should be(1)
+    end
+  end
+
+  context "for disabled feature" do
+    it "updates feature metrics when calls happen" do
+      flipper[:stats].disable(user)
+      Metriks.timer("flipper.feature_operation.disable").count.should be(1)
+
+      flipper[:stats].enabled?(user)
+      Metriks.timer("flipper.feature_operation.enabled").count.should be(1)
+      Metriks.meter("flipper.feature.stats.disabled").count.should be(1)
+    end
+  end
+
+  it "updates adapter metrics when calls happen" do
+    flipper[:stats].enable(user)
+    # one for features and one for actors
+    Metriks.timer("flipper.adapter.memory.set_add").count.should be(2)
+
+    flipper[:stats].enabled?(user)
+    Metriks.timer("flipper.adapter.memory.read").count.should be(1)
+    # one for actors and one for groups
+    Metriks.timer("flipper.adapter.memory.set_members").count.should be(2)
+
+    flipper[:stats].disable(user)
+    Metriks.timer("flipper.adapter.memory.set_delete").count.should be(1)
+  end
+
+  it "updates gate metrics when calls happen" do
+    flipper[:stats].enable(user)
+    flipper[:stats].enabled?(user)
+
+    Metriks.timer("flipper.gate_operation.boolean.open").count.should be(1)
+    Metriks.timer("flipper.feature.stats.gate_operation.boolean.open").count.should be(1)
+    Metriks.meter("flipper.feature.stats.gate.actor.open").count.should be(1)
+    Metriks.meter("flipper.feature.stats.gate.boolean.closed").count.should be(1)
+  end
+
+  # Helper for seeing what is in the metriks registry
+  def print_registry_names
+    Metriks::Registry.default.each do |name, metric|
+      puts name
+    end
+  end
+end