chef-ab 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77e4fcce2dd285b43e963bd9263688cf959bdd3d
+  data.tar.gz: c2f1e74f7cce4626153a1d720d23782b387a64e5
+SHA512:
+  metadata.gz: 8d344eb8da2aead1961311b03c11246c3a965863421b3be4f742fb710a79ab4818241fbb1932451e06de533a1cc46043ec238e19869ac1e575a6f3fce51ddb6c
+  data.tar.gz: 4d4dfd04542bac1e1623946a864badb28d2a8d4893b50bb04009a6aa906e40145f4b0bd4e26c3400370306819dd885b75b9955f34a00bdf7cc969f6282b86c0c

data/README.md

@@ -0,0 +1,69 @@
+Chef AB
+=======
+
+chef-ab is a small library to activate code in cookbooks progressively in a cluster.
+
+It works like an AB test with increasing population.
+
+
+Usage
+----------
+
+Very simple example in attribute file of :
+
+```ruby
+# value before upgrade
+default[:a_cookbook][:activate_experimental_feature] = false
+
+# plumbing
+one_week_in_secs = 7 * 86400
+start_time = Time.new(2014, 02, 11, 8, 30, 00, "+01:00")
+end_time = start_time + one_week_in_secs
+
+upgrade = ChefAB::TimeLinearUpgrader.new(
+  node['fqdn'], # we use fqdn as id for the migration
+  start_time,
+  end_time
+)
+
+upgrade.execute do
+  # value after upgrade
+  default[:a_cookbook][:activate_experimental_feature] = true
+end
+
+# sugar for easy status collect
+default[:chef_ab][:experimental_feature_activation] = Time.at(upgrade.expected_activation)
+default[:chef_ab][:experimental_feature_activated] = node[:a_cookbook][:activate_experimental_feature]
+```
+
+Another example, upgrading nodes exponentially depending on distance to a given ip address:
+
+```ruby
+# value before upgrade
+default[:a_cookbook][:activate_experimental_feature] = false
+
+# plumbing
+start_time = Time.new(2014, 02, 11, 8, 30, 00, "+01:00")
+period = 3600 # going larger every hour
+first_node = "10.11.12.13"
+
+upgrade = ChefAB::TimeIPBasedUpgrader.new node['ipaddress'],
+  start_time,
+  period,
+  first_node
+
+upgrade.execute do
+  # value after upgrade
+  default[:a_cookbook][:activate_experimental_feature] = true
+end
+```
+
+
+Warning
+----------
+
+
+
+- This lib is **not** a substitute to release management, it will solve only the issue of progressive update.
+- It is meant to replace the ssh loop that many uses to upgrades server farms.
+- This library does not give strong garantees on the number of servers that will activate code at the same time (see chef_throttle for that).

data/chef_ab.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "chef-ab"
+  s.version     = '0.1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Grégoire Seux"]
+  s.license     = "Apache License v2"
+  s.summary     = %q{AB test like chef conf deployement}
+  s.homepage    = "http://github.com/kamaradclimber/chef-ab"
+  s.description = %q{}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_development_dependency 'rspec'
+end

data/lib/chef-ab.rb

@@ -0,0 +1,4 @@
+require 'chef-ab/base_upgrader'
+require 'chef-ab/time_linear_upgrader'
+require 'chef-ab/ip_metric'
+require 'chef-ab/time_ipbased_upgrader'

data/lib/chef-ab/base_upgrader.rb

@@ -0,0 +1,26 @@
+require 'zlib'
+
+module ChefAB
+  class BaseUpgrader
+    attr_accessor :node_id, :hash
+
+    def initialize(node_id)
+      @node_id = node_id
+      if node_id.is_a? Integer
+        @hash = node_id
+      else
+        @hash = Zlib.crc32 (node_id.to_s)
+      end
+    end
+
+    def should_execute?(threshold)
+      @hash < threshold
+    end
+
+    def execute(&block)
+      if block_given? && should_execute?
+        block.call
+      end
+    end
+  end
+end

data/lib/chef-ab/ip_metric.rb

@@ -0,0 +1,13 @@
+require 'ipaddress'
+
+module IPmetric
+  def ip_metric(ip_ref, ip)
+    ip1 = IPAddress.parse(ip_ref)
+    ip2 = IPAddress.parse(ip)
+    dist = (0..32).to_a.reverse.bsearch do |mask|
+      ip1.prefix = mask
+      ip1.include?(ip2)
+    end
+    32 - dist
+  end
+end

data/lib/chef-ab/time_ipbased_upgrader.rb

@@ -0,0 +1,36 @@
+require 'ipaddress'
+
+module ChefAB
+  class TimeIPBasedUpgrader < BaseUpgrader
+
+    include IPmetric
+
+    attr_accessor :start_time, :period
+    attr_accessor :initial_ip
+
+    def initialize(node_ip, start_time, period, initial_ip)
+      super(ip_metric(initial_ip, node_ip))
+      @start_time = start_time.to_i
+      @period = period
+      @end_time = 31 * period + @start_time
+    end
+
+    def should_execute?(time = nil)
+      time ||= current_time
+      threshold    = (time - start_time) / @period + 1
+      super(threshold)
+    end
+
+    def expected_activation
+      (@start_time..@end_time).to_a.bsearch do |fake_time|
+        should_execute?(fake_time)
+      end
+    end
+
+    private
+
+    def current_time
+      Time.now.to_i
+    end
+  end
+end

data/lib/chef-ab/time_linear_upgrader.rb

@@ -0,0 +1,33 @@
+module ChefAB
+  class TimeLinearUpgrader < BaseUpgrader
+
+    attr_accessor :start_time, :end_time
+
+    def initialize(node_id, start_time, end_time)
+      super(node_id)
+      @start_time = start_time.to_i
+      @end_time = end_time.to_i
+      upgrade_span = end_time - start_time
+      @hash = @hash % upgrade_span
+    end
+
+    def should_execute?(time = nil)
+      time ||= current_time
+      threshold    = time - start_time
+      super(threshold)
+    end
+
+    def expected_activation
+      (@start_time..@end_time).to_a.bsearch do |fake_time|
+        should_execute?(fake_time)
+      end
+    end
+
+    private
+
+    def current_time
+      Time.now.to_i
+    end
+
+  end
+end

data/spec/base_upgrader_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require_relative '../lib/chef-ab.rb'
+
+describe ChefAB::BaseUpgrader do
+  it 'should have an integer hash' do
+    up = ChefAB::BaseUpgrader.new 5
+    expect(up.hash).to be_a_kind_of(Integer)
+  end
+  it 'should have an integer hash in any case' do
+    up = ChefAB::BaseUpgrader.new "testing node"
+    expect(up.hash).to be_a_kind_of(Integer)
+  end
+end

data/spec/ip_distance.rb

@@ -0,0 +1,23 @@
+require 'rspec'
+
+require_relative '../lib/chef-ab.rb'
+
+describe IPMetric do
+  include IPMetric
+  it 'should give metric zero between an address and itself' do
+    dist = ip_metric("192.168.0.34", "192.168.0.34")
+    expect(dist).to eq(0)
+  end
+  it 'should give metric 1 between an address and neighbour' do
+    dist = ip_metric("192.168.0.34", "192.168.0.35")
+    expect(dist).to eq(1)
+  end
+  it 'should give metric 8 between an address and next block' do
+    dist = ip_metric("192.168.0.34", "192.168.1.35")
+    expect(dist).to eq(9)
+  end
+  it 'should give metric 32 between lowest and highest' do
+    dist = ip_metric("0.0.0.0", "255.255.255.255")
+    expect(dist).to eq(32)
+  end
+end

data/spec/time_ipbased_spec.rb

@@ -0,0 +1,66 @@
+require 'rspec'
+
+require_relative '../lib/chef-ab.rb'
+
+module ChefAB
+  class TimeIPBasedUpgrader
+    attr_accessor :current_timer
+    def current_time
+      @current_timer || Time.now.to_i
+    end
+  end
+end
+
+describe ChefAB::TimeIPBasedUpgrader do
+
+  def future_upgrade
+    ChefAB::TimeIPBasedUpgrader.new "192.168.17.1",
+      (Time.now + 10),
+      3600,
+      "192.168.17.1"
+  end
+  def past_upgrade
+    ChefAB::TimeIPBasedUpgrader.new "192.168.17.1",
+      (Time.now - 10),
+      3600,
+      "192.168.17.1"
+  end
+
+  it 'should not execute before start of upgrade' do
+    expect(future_upgrade.should_execute?).to be_false
+  end
+
+  it 'should always execute after end of upgrade' do
+    expect(past_upgrade.should_execute?).to be_true
+  end
+
+  it 'should not call block before start of upgrade' do
+    expect { |b| future_upgrade.execute(&b) }.not_to yield_control
+  end
+
+  it 'should always call block after end of upgrade' do
+    expect { |b| past_upgrade.execute(&b) }.to yield_control
+  end
+
+  it 'should not call block before expected_activation and should always do after' do
+    start_time = 42 #any timestamp
+    period = 10
+    up = ChefAB::TimeIPBasedUpgrader.new "192.168.18.23",
+      start_time,
+      period,
+      "192.168.17.1"
+
+    end_time = 42 + 32 * period
+
+    first_execute_time = up.expected_activation
+
+    (start_time..first_execute_time-1).each do |fake_time|
+      up.current_timer = fake_time
+      expect { |b| up.execute(&b) }.not_to yield_control
+    end
+    (first_execute_time..end_time).each do |fake_time|
+      up.current_timer = fake_time
+      expect { |b| up.execute(&b) }.to yield_control
+    end
+  end
+end

data/spec/time_linear_spec.rb

@@ -0,0 +1,62 @@
+require 'rspec'
+
+require_relative '../lib/chef-ab.rb'
+
+module ChefAB
+  class TimeLinearUpgrader
+    attr_accessor :current_timer
+    def current_time
+      @current_timer || Time.now.to_i
+    end
+  end
+end
+
+describe ChefAB::TimeLinearUpgrader do
+
+  def future_upgrade
+    ChefAB::TimeLinearUpgrader.new "testing node", (Time.now + 10), (Time.now + 3600)
+  end
+  def past_upgrade
+    ChefAB::TimeLinearUpgrader.new "testing node", (Time.now - 10), (Time.now - 5)
+  end
+
+  it 'should not execute before start of upgrade' do
+    expect(future_upgrade.should_execute?).to be_false
+  end
+
+  it 'should always execute after end of upgrade' do
+    expect(past_upgrade.should_execute?).to be_true
+  end
+
+  it 'should not call block before start of upgrade' do
+    expect { |b| future_upgrade.execute(&b) }.not_to yield_control
+  end
+
+  it 'should always call block after end of upgrade' do
+    expect { |b| past_upgrade.execute(&b) }.to yield_control
+  end
+
+  it 'should not call block before expected_activation and should always do after' do
+    start_time = 42 #any timestamp
+    end_time = 60
+    up = ChefAB::TimeLinearUpgrader.new "testing node", start_time, end_time
+
+    first_execute_time = up.expected_activation
+
+    (start_time..first_execute_time-1).each do |fake_time|
+      up.current_timer = fake_time
+      expect { |b| up.execute(&b) }.not_to yield_control
+    end
+    (first_execute_time..end_time).each do |fake_time|
+      up.current_timer = fake_time
+      expect { |b| up.execute(&b) }.to yield_control
+    end
+  end
+
+  it 'should return correct expected_activation' do
+    start_time = 42 #any timestamp
+    end_time = 50
+    up = ChefAB::TimeLinearUpgrader.new 5, start_time, end_time
+    expect(up.expected_activation).to eq(42 + 5 +1)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: chef-ab
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grégoire Seux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- chef_ab.gemspec
+- lib/chef-ab.rb
+- lib/chef-ab/base_upgrader.rb
+- lib/chef-ab/ip_metric.rb
+- lib/chef-ab/time_ipbased_upgrader.rb
+- lib/chef-ab/time_linear_upgrader.rb
+- spec/base_upgrader_spec.rb
+- spec/ip_distance.rb
+- spec/time_ipbased_spec.rb
+- spec/time_linear_spec.rb
+homepage: http://github.com/kamaradclimber/chef-ab
+licenses:
+- Apache License v2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: AB test like chef conf deployement
+test_files:
+- spec/base_upgrader_spec.rb
+- spec/ip_distance.rb
+- spec/time_ipbased_spec.rb
+- spec/time_linear_spec.rb