semian 0.6.0 → 0.6.1

data/Rakefile

@@ -1,56 +0,0 @@
-require 'bundler/gem_tasks'
-begin
-  require 'rubocop/rake_task'
-  RuboCop::RakeTask.new
-rescue LoadError
-end
-
-# ==========================================================
-# Packaging
-# ==========================================================
-
-GEMSPEC = eval(File.read('semian.gemspec'))
-
-require 'rubygems/package_task'
-Gem::PackageTask.new(GEMSPEC) do |_pkg|
-end
-
-# ==========================================================
-# Ruby Extension
-# ==========================================================
-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require 'semian/platform'
-if Semian.sysv_semaphores_supported?
-  require 'rake/extensiontask'
-  Rake::ExtensionTask.new('semian', GEMSPEC) do |ext|
-    ext.ext_dir = 'ext/semian'
-    ext.lib_dir = 'lib/semian'
-  end
-  task build: :compile
-else
-  task :build do
-  end
-end
-
-# ==========================================================
-# Testing
-# ==========================================================
-
-require 'rake/testtask'
-Rake::TestTask.new 'test' do |t|
-  t.libs = %w(lib test)
-  t.pattern = "test/*_test.rb"
-end
-task test: :build
-
-# ==========================================================
-# Documentation
-# ==========================================================
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_files.include("lib/*.rb", "ext/semian/*.c")
-end
-
-task default: :test
-task default: :rubocop

data/repodb.yml

@@ -1 +0,0 @@
-classification: library

data/scripts/install_toxiproxy.sh

@@ -1,25 +0,0 @@
-set -e
-
-if which toxiproxy > /dev/null; then
-  echo "Toxiproxy is already installed."
-  exit 0
-fi
-
-if which apt-get > /dev/null; then
-  echo "Installing toxiproxy"
-  wget -O /tmp/toxiproxy.deb https://github.com/Shopify/toxiproxy/releases/download/v2.0.0/toxiproxy_2.0.0_amd64.deb
-  sudo dpkg -i /tmp/toxiproxy.deb
-  sudo service toxiproxy start
-  exit 0
-fi
-
-if which brew > /dev/null; then
-  echo "Installing toxiproxy from homebrew."
-  brew tap shopify/shopify
-  brew install toxiproxy
-  brew info toxiproxy
-  exit 0
-fi
-
-echo "Sorry, there is no toxiproxy package available for your system. You might need to build it from source."
-exit 1

data/semian.gemspec

@@ -1,29 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
-
-require 'semian/version'
-require 'semian/platform'
-
-Gem::Specification.new do |s|
-  s.name = 'semian'
-  s.version = Semian::VERSION
-  s.summary = 'Bulkheading for Ruby with SysV semaphores'
-  s.description = <<-DOC
-    A Ruby C extention that is used to control access to shared resources
-    across process boundaries with SysV semaphores.
-  DOC
-  s.homepage = 'https://github.com/shopify/semian'
-  s.authors = ['Scott Francis', 'Simon Eskildsen']
-  s.email = 'scott.francis@shopify.com'
-  s.license = 'MIT'
-
-  s.files = `git ls-files`.split("\n")
-  s.extensions = ['ext/semian/extconf.rb']
-  s.add_development_dependency 'rake-compiler', '~> 0.9'
-  s.add_development_dependency 'rake', '< 11.0'
-  s.add_development_dependency 'timecop'
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'mysql2'
-  s.add_development_dependency 'redis'
-  s.add_development_dependency 'thin', '~> 1.6.4'
-  s.add_development_dependency 'toxiproxy', '~> 1.0.0'
-end

data/test/circuit_breaker_test.rb

@@ -1,133 +0,0 @@
-require 'test_helper'
-
-class TestCircuitBreaker < Minitest::Test
-  SomeError = Class.new(StandardError)
-
-  def setup
-    begin
-      Semian.destroy(:testing)
-    rescue
-      nil
-    end
-    Semian.register(:testing, tickets: 1, exceptions: [SomeError], error_threshold: 2, error_timeout: 5, success_threshold: 1)
-    @resource = Semian[:testing]
-  end
-
-  def test_acquire_yield_when_the_circuit_is_closed
-    block_called = false
-    @resource.acquire { block_called = true }
-    assert_equal true, block_called
-  end
-
-  def test_acquire_raises_circuit_open_error_when_the_circuit_is_open
-    open_circuit!
-    assert_raises Semian::OpenCircuitError do
-      @resource.acquire { 1 + 1 }
-    end
-  end
-
-  def test_after_error_threshold_the_circuit_is_open
-    open_circuit!
-    assert_circuit_opened
-  end
-
-  def test_after_error_timeout_is_elapsed_requests_are_attempted_again
-    half_open_cicuit!
-    assert_circuit_closed
-  end
-
-  def test_until_success_threshold_is_reached_a_single_error_will_reopen_the_circuit
-    half_open_cicuit!
-    trigger_error!
-    assert_circuit_opened
-  end
-
-  def test_once_success_threshold_is_reached_only_error_threshold_will_open_the_circuit_again
-    half_open_cicuit!
-    assert_circuit_closed
-    trigger_error!
-    assert_circuit_closed
-    trigger_error!
-    assert_circuit_opened
-  end
-
-  def test_reset_allow_to_close_the_circuit_and_forget_errors
-    open_circuit!
-    @resource.reset
-    assert_circuit_closed
-  end
-
-  def test_errors_more_than_duration_apart_doesnt_open_circuit
-    Timecop.travel(Time.now - 6) do
-      trigger_error!
-      assert_circuit_closed
-    end
-
-    trigger_error!
-    assert_circuit_closed
-  end
-
-  def test_sparse_errors_dont_open_circuit
-    resource = Semian.register(:three, tickets: 1, exceptions: [SomeError], error_threshold: 3, error_timeout: 5, success_threshold: 1)
-
-    Timecop.travel(-6) do
-      trigger_error!(resource)
-      assert_circuit_closed(resource)
-    end
-
-    Timecop.travel(-1) do
-      trigger_error!(resource)
-      assert_circuit_closed(resource)
-    end
-
-    trigger_error!(resource)
-    assert_circuit_closed(resource)
-  ensure
-    Semian.destroy(:three)
-  end
-
-  def test_request_allowed_query_doesnt_trigger_transitions
-    Timecop.travel(Time.now - 6) do
-      open_circuit!
-
-      refute_predicate @resource, :request_allowed?
-      assert_predicate @resource, :open?
-    end
-
-    assert_predicate @resource, :request_allowed?
-    assert_predicate @resource, :open?
-  end
-
-  private
-
-  def open_circuit!(resource = @resource)
-    2.times { trigger_error!(resource) }
-  end
-
-  def half_open_cicuit!(resource = @resource)
-    Timecop.travel(Time.now - 10) do
-      open_circuit!(resource)
-    end
-  end
-
-  def trigger_error!(resource = @resource)
-    resource.acquire { raise SomeError }
-  rescue SomeError
-  end
-
-  def assert_circuit_closed(resource = @resource)
-    block_called = false
-    resource.acquire { block_called = true }
-    assert block_called, 'Expected the circuit to be closed, but it was open'
-  end
-
-  def assert_circuit_opened(resource = @resource)
-    open = false
-    begin
-      resource.acquire {}
-    rescue Semian::OpenCircuitError
-      open = true
-    end
-    assert open, 'Expected the circuit to be open, but it was closed'
-  end
-end

data/test/fixtures/binary.sql

@@ -1 +0,0 @@
-INSERT IGNORE INTO `theme_template_bodies` (`cityhash`, `body`, `created_at`) VALUES ('716374049952273167', '�
�{\"current\":{\"bg_color\":\"#ff0000\"},\"presets\":{\"sandbox>,\0\07

, grey_bg\":6M\0\06

!blueJ!\0
lff
!redJ \0$ff0000\"}}}', '2015-11-06 19:08:03.498432')

data/test/helpers/background_helper.rb

@@ -1,25 +0,0 @@
-module BackgroundHelper
-  attr_writer :threads
-
-  def teardown
-    threads.each(&:kill)
-    self.threads = []
-  end
-
-  private
-
-  def background(&block)
-    thread = Thread.new(&block)
-    threads << thread
-    thread.join(0.1)
-    thread
-  end
-
-  def threads
-    @threads ||= []
-  end
-
-  def yield_to_background
-    threads.each(&:join)
-  end
-end

data/test/instrumentation_test.rb

@@ -1,61 +0,0 @@
-require 'test_helper'
-
-class TestInstrumentation < Minitest::Test
-  def setup
-    Semian.destroy(:testing) if Semian[:testing]
-    Semian.register(:testing, tickets: 1, error_threshold: 1, error_timeout: 5, success_threshold: 1)
-  end
-
-  def test_busy_instrumentation
-    assert_notify(:success, :busy) do
-      Semian[:testing].acquire do
-        assert_raises Semian::TimeoutError do
-          Semian[:testing].acquire {}
-        end
-      end
-    end
-  end
-
-  def test_circuit_open_instrumentation
-    assert_notify(:success, :busy) do
-      Semian[:testing].acquire do
-        assert_raises Semian::TimeoutError do
-          Semian[:testing].acquire {}
-        end
-      end
-    end
-
-    assert_notify(:circuit_open) do
-      assert_raises Semian::OpenCircuitError do
-        Semian[:testing].acquire {}
-      end
-    end
-  end
-
-  def test_success_instrumentation
-    assert_notify(:success) do
-      Semian[:testing].acquire {}
-    end
-  end
-
-  def test_success_instrumentation_when_unknown_exceptions_occur
-    assert_notify(:success) do
-      assert_raises RuntimeError do
-        Semian[:testing].acquire { raise "Some error" }
-      end
-    end
-  end
-
-  private
-
-  def assert_notify(*expected_events)
-    events = []
-    subscription = Semian.subscribe do |event, _resource|
-      events << event
-    end
-    yield
-    assert_equal expected_events, events, "The timeline of events was not as expected"
-  ensure
-    Semian.unsubscribe(subscription)
-  end
-end

data/test/mysql2_test.rb

@@ -1,296 +0,0 @@
-require 'test_helper'
-
-class TestMysql2 < Minitest::Test
-  ERROR_TIMEOUT = 5
-  ERROR_THRESHOLD = 1
-  SEMIAN_OPTIONS = {
-    name: :testing,
-    tickets: 1,
-    timeout: 0,
-    error_threshold: ERROR_THRESHOLD,
-    success_threshold: 2,
-    error_timeout: ERROR_TIMEOUT,
-  }
-
-  def setup
-    @proxy = Toxiproxy[:semian_test_mysql]
-    Semian.destroy(:mysql_testing)
-  end
-
-  def test_semian_identifier
-    assert_equal :mysql_foo, FakeMysql.new(semian: {name: 'foo'}).semian_identifier
-    assert_equal :'mysql_localhost:3306', FakeMysql.new.semian_identifier
-    assert_equal :'mysql_127.0.0.1:3306', FakeMysql.new(host: '127.0.0.1').semian_identifier
-    assert_equal :'mysql_example.com:42', FakeMysql.new(host: 'example.com', port: 42).semian_identifier
-  end
-
-  def test_semian_can_be_disabled
-    resource = Mysql2::Client.new(semian: false).semian_resource
-    assert_instance_of Semian::UnprotectedResource, resource
-  end
-
-  def test_connection_errors_open_the_circuit
-    @proxy.downstream(:latency, latency: 1200).apply do
-      ERROR_THRESHOLD.times do
-        assert_raises ::Mysql2::Error do
-          connect_to_mysql!
-        end
-      end
-
-      assert_raises ::Mysql2::CircuitOpenError do
-        connect_to_mysql!
-      end
-    end
-  end
-
-  def test_query_errors_does_not_open_the_circuit
-    client = connect_to_mysql!
-    (ERROR_THRESHOLD * 2).times do
-      assert_raises ::Mysql2::Error do
-        client.query('ERROR!')
-      end
-    end
-  end
-
-  def test_connect_instrumentation
-    notified = false
-    subscriber = Semian.subscribe do |event, resource, scope, adapter|
-      notified = true
-      assert_equal :success, event
-      assert_equal Semian[:mysql_testing], resource
-      assert_equal :connection, scope
-      assert_equal :mysql, adapter
-    end
-
-    connect_to_mysql!
-
-    assert notified, 'No notifications has been emitted'
-  ensure
-    Semian.unsubscribe(subscriber)
-  end
-
-  def test_resource_acquisition_for_connect
-    connect_to_mysql!
-
-    Semian[:mysql_testing].acquire do
-      error = assert_raises Mysql2::ResourceBusyError do
-        connect_to_mysql!
-      end
-      assert_equal :mysql_testing, error.semian_identifier
-    end
-  end
-
-  def test_network_errors_are_tagged_with_the_resource_identifier
-    client = connect_to_mysql!
-    @proxy.down do
-      error = assert_raises ::Mysql2::Error do
-        client.query('SELECT 1 + 1;')
-      end
-      assert_equal client.semian_identifier, error.semian_identifier
-    end
-  end
-
-  def test_other_mysql_errors_are_not_tagged_with_the_resource_identifier
-    client = connect_to_mysql!
-
-    error = assert_raises Mysql2::Error do
-      client.query('SYNTAX ERROR!')
-    end
-    assert_nil error.semian_identifier
-  end
-
-  def test_resource_timeout_on_connect
-    @proxy.downstream(:latency, latency: 500).apply do
-      background { connect_to_mysql! }
-
-      assert_raises Mysql2::ResourceBusyError do
-        connect_to_mysql!
-      end
-    end
-  end
-
-  def test_circuit_breaker_on_connect
-    @proxy.downstream(:latency, latency: 500).apply do
-      background { connect_to_mysql! }
-
-      ERROR_THRESHOLD.times do
-        assert_raises Mysql2::ResourceBusyError do
-          connect_to_mysql!
-        end
-      end
-    end
-
-    yield_to_background
-
-    assert_raises Mysql2::CircuitOpenError do
-      connect_to_mysql!
-    end
-
-    Timecop.travel(ERROR_TIMEOUT + 1) do
-      connect_to_mysql!
-    end
-  end
-
-  def test_query_instrumentation
-    client = connect_to_mysql!
-
-    notified = false
-    subscriber = Semian.subscribe do |event, resource, scope, adapter|
-      notified = true
-      assert_equal :success, event
-      assert_equal Semian[:mysql_testing], resource
-      assert_equal :query, scope
-      assert_equal :mysql, adapter
-    end
-
-    client.query('SELECT 1 + 1;')
-
-    assert notified, 'No notifications has been emitted'
-  ensure
-    Semian.unsubscribe(subscriber)
-  end
-
-  def test_resource_acquisition_for_query
-    client = connect_to_mysql!
-
-    Semian[:mysql_testing].acquire do
-      assert_raises Mysql2::ResourceBusyError do
-        client.query('SELECT 1 + 1;')
-      end
-    end
-  end
-
-  def test_semian_allows_rollback
-    client = connect_to_mysql!
-
-    client.query('START TRANSACTION;')
-
-    Semian[:mysql_testing].acquire do
-      client.query('ROLLBACK;')
-    end
-  end
-
-  def test_semian_allows_commit
-    client = connect_to_mysql!
-
-    client.query('START TRANSACTION;')
-
-    Semian[:mysql_testing].acquire do
-      client.query('COMMIT;')
-    end
-  end
-
-  def test_query_whitelisted_returns_false_for_binary_sql
-    binary_query = File.read(File.expand_path('../fixtures/binary.sql', __FILE__))
-    client = connect_to_mysql!
-    refute client.send(:query_whitelisted?, binary_query)
-  end
-
-  def test_semian_allows_rollback_to_safepoint
-    client = connect_to_mysql!
-
-    client.query('START TRANSACTION;')
-    client.query('SAVEPOINT foobar;')
-
-    Semian[:mysql_testing].acquire do
-      client.query('ROLLBACK TO foobar;')
-    end
-
-    client.query('ROLLBACK;')
-  end
-
-  def test_semian_allows_release_savepoint
-    client = connect_to_mysql!
-
-    client.query('START TRANSACTION;')
-    client.query('SAVEPOINT foobar;')
-
-    Semian[:mysql_testing].acquire do
-      client.query('RELEASE SAVEPOINT foobar;')
-    end
-
-    client.query('ROLLBACK;')
-  end
-
-  def test_resource_timeout_on_query
-    client = connect_to_mysql!
-    client2 = connect_to_mysql!
-
-    @proxy.downstream(:latency, latency: 500).apply do
-      background { client2.query('SELECT 1 + 1;') }
-
-      assert_raises Mysql2::ResourceBusyError do
-        client.query('SELECT 1 + 1;')
-      end
-    end
-  end
-
-  def test_circuit_breaker_on_query
-    client = connect_to_mysql!
-    client2 = connect_to_mysql!
-
-    @proxy.downstream(:latency, latency: 1000).apply do
-      background { client2.query('SELECT 1 + 1;') }
-
-      ERROR_THRESHOLD.times do
-        assert_raises Mysql2::ResourceBusyError do
-          client.query('SELECT 1 + 1;')
-        end
-      end
-    end
-
-    yield_to_background
-
-    assert_raises Mysql2::CircuitOpenError do
-      client.query('SELECT 1 + 1;')
-    end
-
-    Timecop.travel(ERROR_TIMEOUT + 1) do
-      assert_equal 2, client.query('SELECT 1 + 1 as sum;').to_a.first['sum']
-    end
-  end
-
-  def test_unconfigured
-    client = Mysql2::Client.new(host: '127.0.0.1', port: '13306')
-    assert_equal 2, client.query('SELECT 1 + 1 as sum;').to_a.first['sum']
-  end
-
-  def test_pings_are_circuit_broken
-    client = connect_to_mysql!
-
-    def client.raw_ping
-      @real_pings ||= 0
-      @real_pings += 1
-      super
-    end
-
-    @proxy.downstream(:latency, latency: 1200).apply do
-      ERROR_THRESHOLD.times do
-        client.ping
-      end
-
-      assert_equal false, client.ping
-    end
-
-    assert_equal ERROR_THRESHOLD, client.instance_variable_get(:@real_pings)
-  end
-
-  private
-
-  def connect_to_mysql!(semian_options = {})
-    Mysql2::Client.new(
-      connect_timeout: 1,
-      read_timeout: 1,
-      host: '127.0.0.1',
-      port: '13306',
-      semian: SEMIAN_OPTIONS.merge(semian_options),
-    )
-  end
-
-  class FakeMysql < Mysql2::Client
-    private
-
-    def connect(*)
-    end
-  end
-end