flipper 0.24.1 → 1.3.0

data/spec/support/skippable.rb

@@ -0,0 +1,18 @@
+RSpec.configure do |config|
+  config.before(:all) do
+    $skip = false
+  end
+
+  def skip_on_error(error, message, &block)
+    # Premptively skip if we've already skipped
+    skip(message) if $skip
+    block.call
+  rescue error
+    if ENV["CI"]
+      raise
+    else
+      $skip = true
+      skip(message)
+    end
+  end
+end

data/spec/support/spec_helpers.rb

@@ -1,8 +1,11 @@
 require 'ice_age'
 require 'json'
 require 'rack/test'
+require 'rack/session'
 
 module SpecHelpers
+  extend self
+
   def self.included(base)
     base.let(:flipper) { build_flipper }
     base.let(:app) { build_app(flipper) }
@@ -10,7 +13,7 @@ module SpecHelpers
 
   def build_app(flipper, options = {})
     Flipper::UI.app(flipper, options) do |builder|
-      builder.use Rack::Session::Cookie, secret: 'test'
+      builder.use Rack::Session::Cookie, secret: 'test' * 16 # Rack 3+ wants a 64-character secret
     end
   end
 
@@ -27,7 +30,11 @@ module SpecHelpers
   end
 
   def json_response
-    JSON.parse(last_response.body)
+    body = last_response.body
+    if last_response["content-encoding"] == 'gzip'
+      body = Flipper::Typecast.from_gzip(body)
+    end
+    JSON.parse(body)
   end
 
   def api_error_code_reference_url
@@ -42,6 +49,14 @@ module SpecHelpers
     }
   end
 
+  def api_positive_percentage_error_response
+    {
+      'code' => 3,
+      'message' => 'Percentage must be a positive number less than or equal to 100.',
+      'more_info' => api_error_code_reference_url,
+    }
+  end
+
   def api_flipper_id_is_missing_response
     {
       'code' => 4,
@@ -50,10 +65,10 @@ module SpecHelpers
     }
   end
 
-  def api_positive_percentage_error_response
+  def api_expression_invalid_response
     {
-      'code' => 3,
-      'message' => 'Percentage must be a positive number less than or equal to 100.',
+      'code' => 7,
+      'message' => 'The provided expression was not valid.',
       'more_info' => api_error_code_reference_url,
     }
   end
@@ -68,11 +83,11 @@ module SpecHelpers
 
     yield
 
-    $stderr = original_stderr
-    $stdout = original_stdout
-
     # Return output
     output.string
+  ensure
+    $stderr = original_stderr
+    $stdout = original_stdout
   end
 end
 

data/test/adapters/actor_limit_test.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+require "flipper/test/shared_adapter_test"
+require "flipper/adapters/actor_limit"
+
+class Flipper::Adapters::ActorLimitTest < MiniTest::Test
+  prepend Flipper::Test::SharedAdapterTests
+
+  def setup
+    @memory = Flipper::Adapters::Memory.new
+    @adapter = Flipper::Adapters::ActorLimit.new(@memory, 5)
+  end
+
+  def test_enable_fails_when_limit_exceeded
+    5.times { |i| @feature.enable Flipper::Actor.new("User;#{i}") }
+
+    assert_raises Flipper::Adapters::ActorLimit::LimitExceeded do
+      @feature.enable Flipper::Actor.new("User;6")
+    end
+  end
+end

data/test_rails/generators/flipper/setup_generator_test.rb

@@ -0,0 +1,64 @@
+require "helper"
+require "generators/flipper/setup_generator"
+
+class SetupGeneratorTest < Rails::Generators::TestCase
+  tests Flipper::Generators::SetupGenerator
+  ROOT = File.expand_path("../../../tmp/generators", __dir__)
+  destination ROOT
+  setup :prepare_destination
+
+  test "invokes flipper:active_record generator if ActiveRecord adapter defined" do
+    begin
+      load 'flipper/adapters/active_record.rb'
+      run_generator
+      assert_migration "db/migrate/create_flipper_tables.rb"
+    ensure
+      Flipper::Adapters.send(:remove_const, :ActiveRecord)
+    end
+  end
+
+  test "does not invoke flipper:active_record generator if ActiveRecord adapter not defined" do
+    # Ensure adapter not defined
+    Flipper::Adapters.send(:remove_const, :ActiveRecord) rescue nil
+
+    run_generator
+    assert_no_migration "db/migrate/create_flipper_tables.rb"
+  end
+
+  %w(.env.development .env.local .env).each do |file|
+    test "configures Flipper Cloud token in #{file} if it exists" do
+      File.write("#{ROOT}/#{file}", "")
+      run_generator %w(--token abc123)
+      assert_file file, /^FLIPPER_CLOUD_TOKEN=abc123$/m
+    end
+  end
+
+  test "configures Flipper Cloud token in .env.development before .env" do
+    File.write("#{ROOT}/.env.development", "")
+    File.write("#{ROOT}/.env", "")
+
+    run_generator %w(--token abc123)
+    assert_file ".env.development", /^FLIPPER_CLOUD_TOKEN=abc123$/m
+    assert_file ".env", ""
+  end
+
+  test "does not write to .env if no token provided" do
+    File.write("#{ROOT}/.env", "")
+    run_generator
+    assert_file ".env", ""
+  end
+
+  test "configures Flipper Cloud token in config/credentials.yml.enc if credentials.yml.enc exist" do
+    Dir.chdir(ROOT) do
+      FileUtils.mkdir_p("config")
+      ENV["RAILS_MASTER_KEY"] = "a" * 32
+      Rails.application = Class.new(Rails::Application)
+      Rails.application.credentials.write("")
+
+      run_generator %w(--token abc123)
+      assert_file "config/credentials.yml.enc"
+      expected_config = { flipper: { cloud_token: "abc123" } }
+      assert_equal expected_config, Rails.application.credentials.config
+    end
+  end
+end

data/test_rails/generators/flipper/update_generator_test.rb

@@ -0,0 +1,96 @@
+require "helper"
+require "generators/flipper/update_generator"
+
+class UpdateGeneratorTest < Rails::Generators::TestCase
+  tests Flipper::Generators::UpdateGenerator
+  ROOT = File.expand_path("../../../../tmp/generators", __FILE__)
+  destination ROOT
+  setup :prepare_destination
+
+  setup do
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+  end
+
+  teardown do
+    ActiveRecord::Base.connection.close
+  end
+
+  test "generates migrations" do
+    run_generator
+
+    assert_migration "db/migrate/create_flipper_tables.rb" do |migration|
+      assert_method :up, migration do |up|
+        assert_match(/create_table :flipper_features/, up)
+        assert_match(/create_table :flipper_gates/, up)
+      end
+
+      assert_method :down, migration do |down|
+        assert_match(/drop_table :flipper_features/, down)
+        assert_match(/drop_table :flipper_gates/, down)
+      end
+    end
+
+    assert_migration "db/migrate/change_flipper_gates_value_to_text.rb" do |migration|
+      [:up, :down].each do |dir|
+        assert_method :up, migration do |method|
+          assert_match(/change_column/, method)
+        end
+      end
+    end
+
+    require_migrations
+
+    silence { CreateFlipperTables.migrate(:up) }
+    assert ActiveRecord::Base.connection.table_exists?(:flipper_features)
+    assert ActiveRecord::Base.connection.table_exists?(:flipper_gates)
+
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :string)
+    silence { ChangeFlipperGatesValueToText.migrate(:up) }
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :text)
+
+    silence { ChangeFlipperGatesValueToText.migrate(:down) }
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :string)
+
+    silence { CreateFlipperTables.migrate(:down) }
+    refute ActiveRecord::Base.connection.table_exists?(:flipper_features)
+    refute ActiveRecord::Base.connection.table_exists?(:flipper_gates)
+  end
+
+  test "ChangeFlipperGatesValueToText is a noop if value is already text" do
+    self.class.generator_class = Flipper::Generators::ActiveRecordGenerator
+    run_generator
+
+    self.class.generator_class = Flipper::Generators::UpdateGenerator
+    run_generator
+
+    assert_migration "db/migrate/create_flipper_tables.rb" do |migration|
+      assert_method :up, migration do |up|
+        assert_match /text :value/, up
+      end
+    end
+
+    assert_migration "db/migrate/change_flipper_gates_value_to_text.rb"
+
+    require_migrations
+
+    silence { CreateFlipperTables.migrate(:up) }
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :text)
+
+    assert_nothing_raised do
+      silence { ChangeFlipperGatesValueToText.migrate(:up) }
+    end
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :text)
+  end
+
+  def require_migrations
+    # If these are not reloaded, then test order can cause failures
+    Object.send(:remove_const, :CreateFlipperTables) if defined?(::CreateFlipperTables)
+    Object.send(:remove_const, :ChangeFlipperGatesValueToText) if defined?(::ChangeFlipperGatesValueToText)
+
+    Dir.glob("#{ROOT}/db/migrate/*.rb").each do |file|
+      assert_nothing_raised do
+        load file
+      end
+    end
+  end
+end

data/test_rails/helper.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
-require 'bundler'
-Bundler.setup(:default)
+require 'bundler/setup'
+require 'minitest/autorun'
 require 'rails'
 require 'rails/test_help'
 
@@ -9,3 +9,20 @@ begin
 rescue NoMethodError
   # no biggie, means we are on older version of AS that doesn't have this option
 end
+
+def silence
+  # Store the original stderr and stdout in order to restore them later
+  original_stderr = $stderr
+  original_stdout = $stdout
+
+  # Redirect stderr and stdout
+  output = $stderr = $stdout = StringIO.new
+
+  yield
+
+  $stderr = original_stderr
+  $stdout = original_stdout
+
+  # Return output
+  output.string
+end

data/test_rails/system/test_help_test.rb

@@ -0,0 +1,51 @@
+require_relative "../helper"
+
+# Not worth trying to test on old Rails versions
+return unless Rails::VERSION::MAJOR >= 7
+
+require "capybara/cuprite"
+require "flipper"
+require "flipper/test_help"
+
+require 'action_dispatch/system_testing/server'
+ActionDispatch::SystemTesting::Server.silence_puma = true
+
+class TestApp < Rails::Application
+  config.load_defaults "#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}"
+  config.eager_load = false
+  config.logger = ActiveSupport::Logger.new(StringIO.new)
+  routes.append do
+    root to: "features#index"
+  end
+end
+
+TestApp.initialize!
+
+class FeaturesController < ActionController::Base
+  def index
+    render json: Flipper.enabled?(:test) ? "Enabled" : "Disabled"
+  end
+end
+
+class TestHelpTest < ActionDispatch::SystemTestCase
+  # Any driver that runs the app in a separate thread will test what we want here.
+  driven_by :cuprite, options: { process_timeout: 60 }
+
+  setup do
+    # Reconfigure Flipper since other tests change the adapter.
+    flipper_configure
+
+    # Ensure this test uses this app instance
+    Rails.application = TestApp.instance
+  end
+
+  test "configures a shared adapter between tests and app" do
+    Flipper.disable(:test)
+    visit "/"
+    assert_selector "*", text: "Disabled"
+
+    Flipper.enable(:test)
+    visit "/"
+    assert_selector "*", text: "Enabled"
+  end
+end