phantom-manager 0.0.2

data/lib/utils/limited_array.rb

@@ -0,0 +1,31 @@
+class LimitedArray < Array
+
+  attr_accessor :limit
+
+  def initialize(limit)
+    @limit = limit
+    super()
+  end
+
+  def full?
+    size == limit
+  end
+
+  def <<(val)
+    if full?
+      self.rotate!
+      self[limit-1] = val
+    else
+      super
+    end
+  end
+  
+  def average
+    sum.to_f / size
+  end
+
+  def sum
+    inject(:+)
+  end
+ 
+end

data/lib/utils/lock.rb

@@ -0,0 +1,29 @@
+module Utils
+  class Lock
+    def initialize
+      @locked=false
+    end
+
+    def acquire
+      if !locked?
+        lock
+        yield
+        unlock
+      end
+    end
+
+    def lock
+      @locked = true
+      self
+    end
+
+    def unlock
+      @locked = false
+      self
+    end
+
+    def locked?
+      @locked
+    end
+  end
+end

data/lib/utils/logger.rb

@@ -0,0 +1,3 @@
+require 'logger'
+$logger = Logger.new(STDOUT)
+$logger.level = Logger::INFO

data/lib/utils/shell.rb

@@ -0,0 +1,12 @@
+require 'utils/logger'
+require 'utils/cfg'
+
+module Utils
+  class Shell
+    class << self
+      def execute(cmd)
+        return system cmd
+      end
+    end
+  end
+end

data/phantom-manager.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phantom/manager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "phantom-manager"
+  spec.version       = Phantom::Manager::VERSION
+  spec.authors       = ["Erez Rabih"]
+  spec.email         = ["erez.rabih@gmail.com"]
+  spec.description   = %q{Uses Nginx as multiple phantomjs workers load balancer}
+  spec.summary       = %q{Write a gem summary}
+  spec.homepage      = "https://github.com/FTBpro/phantom-manager"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/files/config.yml

@@ -0,0 +1,12 @@
+test:
+  phantom_termination_grace: 10
+  phantom_processes_number: 10
+  phantom_base_port: 8002
+  memory_limit: 150000
+  rails_root: ""
+  nginx_conf: ""
+  phantom_log_path: ""
+  memory_retries: 5
+  memory_check_interval: 5
+  processes_check_retries: 3
+  processes_check_interval: 15

data/spec/files/nginx.conf

@@ -0,0 +1,26 @@
+upstream unicorn {
+  server 127.0.0.1:8001;
+}
+
+upstream phantomjs {
+  server 127.0.0.1:8002;
+  server 127.0.0.1:8004;
+  server 127.0.0.1:8005;
+  server 127.0.0.1:8006;
+  server 127.0.0.1:8007;
+  server 127.0.0.1:8008;
+  server 127.0.0.1:8009;
+  server 127.0.0.1:8010;
+  server 127.0.0.1:8011;
+}
+
+server {
+  server_name _
+
+  location / {
+    proxy_pass http://phantomjs;
+  }
+  blah
+  bli
+  omo
+}

data/spec/lib/monitors/base_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'monitors/base'
+
+module Monitors
+  describe Base do
+    context "perform_check not implemented" do
+      it "should raise NotImplementedError" do
+        expect {
+          Base.run
+        }.to raise_exception(NotImplementedError)
+      end
+    end
+  end
+end

data/spec/lib/monitors/memory_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'monitors/memory'
+
+module Monitors
+
+  describe Memory do
+
+    subject {Memory}
+
+    before do
+      Phantom::Collector.stub(:running_phantoms_shell_output).and_return(phantoms_ps_shell_output)
+      $cfg.memory_limit = 110000
+      $cfg.memory_retries = 3
+    end
+
+    describe :perform_check do
+      context "below memory_retries" do
+        it "should not restart processes" do
+          Phantom::Manager.should_not_receive(:restart)
+          ( $cfg.memory_retries - 1 ).times { subject.perform_check }
+        end
+      end
+
+      context "at memory_retries" do
+        it "should restart process" do
+          Phantom::Manager.should_receive(:restart).once
+          $cfg.memory_retries.times { subject.perform_check }
+        end
+      end
+    end
+
+  end
+end

data/spec/lib/monitors/processes_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'monitors/processes'
+
+module Monitors
+  describe Processes do
+
+    subject {Processes}
+
+    describe :perform_check do
+
+      before do
+        ViolationsRecorders::Processes.reset
+      end
+
+      context "no missing ports" do
+        before do
+          Phantom::Collector.stub(:missing_ports).and_return([])
+        end
+
+        it "should not create instances" do
+          Phantom::Manager.should_not_receive(:start)
+          subject.perform_check
+        end
+      end
+      
+      context "two missing ports" do
+
+        before do
+          @p1 = Phantom::Process.new
+          @p1.port = 8004
+          @p2 = Phantom::Process.new
+          @p2.port = 8005
+          Phantom::Collector.stub(:missing_ports).and_return([@p1, @p2].map(&:port))
+        end
+
+        it "should create two new instances" do
+          Phantom::Manager.should_receive(:start).twice
+          $cfg.processes_check_retries.times {subject.perform_check}
+        end
+      end
+
+    end
+
+  end
+end

data/spec/lib/monitors/restart_listener_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'monitors/restart_listener'
+
+module Monitors
+  describe RestartListener do
+
+    subject {RestartListener}
+
+    describe :respond_to_signal do
+      before do
+        subject.stub :sleep
+        Phantom::Collector.stub(:running_phantoms_shell_output).and_return(phantoms_ps_shell_output)
+      end
+
+      it "should restart each phantom" do
+        instances = Phantom::Collector.get_running_instances
+        Phantom::Collector.stub get_running_instances: instances
+
+        instances.each {|i| Phantom::Manager.should_receive(:restart).with(i).once }
+
+        subject.respond_to_signal
+      end
+
+    end
+
+  end
+end

data/spec/lib/monitors/violations_recorders/base_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'monitors/violations_recorders/base'
+
+module Monitors
+  module ViolationsRecorders
+    describe Base do
+
+      subject {Base}
+
+      describe "abstract methods" do
+        [:retries_limit, :process_attr].each do |method|
+          it "should raise NotImplementedError on #{method}" do
+            expect {subject.send(method)}.to raise_exception(NotImplementedError)
+          end
+        end
+
+        it "should raise NotImplementedError on process_is_violating?" do
+          expect {subject.send(:process_is_violating?,nil)}.to raise_exception(NotImplementedError)
+        end
+      end
+
+      context "inheriting recorder" do
+
+        RETRIES = 3
+        PROCESS_ATTR = :attr
+        VALUE_ATTR = :val
+        VIOLATING_VALUE = 5
+
+        class DummyRecorder < Base
+          class << self
+            def retries_limit
+              RETRIES
+            end
+
+            def process_attr
+              PROCESS_ATTR
+            end
+
+            def process_is_violating?(process)
+              process.send(VALUE_ATTR) > VIOLATING_VALUE
+            end
+          end
+        end
+
+        describe :is_violating? do
+
+          before do
+            DummyRecorder.reset
+            @p = Object.new
+            @p.stub(PROCESS_ATTR).and_return(1)
+          end
+
+
+          context "non violating process" do
+
+            before do
+              @p.stub(VALUE_ATTR).and_return(VIOLATING_VALUE - 1)
+            end
+
+            it "should indicate not violating" do
+              RETRIES.times do
+                DummyRecorder.is_violating?(@p).should be_false
+              end
+            end
+          end
+
+          context "violating process" do
+
+            before do
+              @p.stub(VALUE_ATTR).and_return(VIOLATING_VALUE + 1)
+            end
+
+            context "below retry limit" do
+
+              it "should indicate not violating" do
+                (RETRIES-1).times do
+                  DummyRecorder.is_violating?(@p).should be_false
+                end
+              end
+            end
+
+            context "equals retry limit" do
+
+              it "should indicate violating" do
+                (RETRIES-1).times do
+                  DummyRecorder.is_violating?(@p)
+                end
+                DummyRecorder.is_violating?(@p).should be_true
+              end
+
+              it "should reset count after violation" do
+                (RETRIES-1).times do
+                  DummyRecorder.is_violating?(@p)
+                end
+                DummyRecorder.is_violating?(@p).should be_true
+                (RETRIES-1).times do
+                  DummyRecorder.is_violating?(@p).should be_false
+                end
+                DummyRecorder.is_violating?(@p).should be_true
+              end
+            end
+
+            describe "count after check passed" do
+              it "should be reset" do
+                (RETRIES-1).times do
+                  DummyRecorder.is_violating?(@p)
+                end
+
+                @p.stub(VALUE_ATTR).and_return(VIOLATING_VALUE-1)
+                DummyRecorder.is_violating?(@p)
+
+                @p.stub(VALUE_ATTR).and_return(VIOLATING_VALUE+1)
+
+                (RETRIES-1).times do
+                  DummyRecorder.is_violating?(@p).should be_false
+                end
+
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/lib/monitors/violations_recorders/memory_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'monitors/violations_recorders/memory'
+
+module Monitors
+  module ViolationsRecorders
+  describe Memory do
+
+      subject {Memory}
+
+      before :each do
+        subject.reset
+      end
+
+      describe :is_violating? do
+
+        let(:violating_memory) { $cfg.memory_limit + 10}
+        let(:valid_memory) { $cfg.memory_limit - 10}
+
+        context "violating process" do
+
+          before do
+            @p = generate_process
+            @p.memory_usage = violating_memory
+          end
+
+          it "should return true" do
+            ($cfg.memory_retries-1).times do
+              subject.is_violating?(@p).should be_false
+            end
+
+            subject.is_violating?(@p).should be_true
+          end
+        end
+
+        context "not violating process" do
+
+          before do
+            @p = generate_process
+            @p.memory_usage = valid_memory
+          end
+
+          it "should return false" do
+            $cfg.memory_retries.times do
+              subject.is_violating?(@p).should be_false
+            end
+          end
+
+          describe "violations reset" do
+
+            it "reset violations if valid memory detected one" do
+              @p.memory_usage = violating_memory
+              ($cfg.memory_retries-1).times do
+                subject.is_violating?(@p).should be_false
+              end
+
+              @p.memory_usage = valid_memory
+
+              subject.is_violating?(@p).should be_false
+
+              @p.memory_usage = violating_memory
+              ($cfg.memory_retries-1).times do
+                subject.is_violating?(@p).should be_false
+              end
+              subject.is_violating?(@p).should be_true
+            end
+
+          end
+
+        end
+      end
+  end
+  end
+end

data/spec/lib/monitors/violations_recorders/processes_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'monitors/violations_recorders/processes'
+
+module Monitors
+  module ViolationsRecorders
+
+    describe Processes do
+
+      subject {Processes}
+
+      before :each do
+        subject.reset
+      end
+
+      describe :is_violating? do
+
+        before do
+          Phantom::Collector.stub(:missing_ports).and_return([8004])
+          @p = Phantom::Process.new
+          @p.port = 8004
+          $cfg.processes_check_retries = 3
+        end
+
+        context "below retries limit" do
+          let(:retries) {$cfg.processes_check_retries - 1}
+
+          it "should return false" do
+            retries.times do
+              subject.is_violating?(@p).should be_false
+            end
+          end
+
+        end
+
+        context "equals retries limit" do
+
+          let(:retries) {$cfg.processes_check_retries}
+
+          it "should return false" do
+            (retries-1).times do
+              subject.is_violating?(@p).should be_false
+            end
+            subject.is_violating?(@p).should be_true
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/spec/lib/nginx/manager_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'nginx/manager'
+
+INITIAL_CONF=<<-CONF
+upstream unicorn {
+  server 127.0.0.1:8001;
+}
+
+upstream phantomjs {
+  server 127.0.0.1:8002;
+  server 127.0.0.1:8003;
+  server 127.0.0.1:8004;
+  server 127.0.0.1:8005;
+  server 127.0.0.1:8006;
+  server 127.0.0.1:8007;
+  server 127.0.0.1:8008;
+  server 127.0.0.1:8009;
+  server 127.0.0.1:8010;
+  server 127.0.0.1:8011;
+}
+
+server {
+  server_name _
+
+  location / {
+    proxy_pass http://phantomjs;
+  }
+  blah
+  bli
+  omo
+}
+CONF
+
+module Nginx
+  describe Manager do
+    subject {Manager}
+
+    def port_defined?(port)
+      File.readlines($cfg.nginx_conf).grep(/#{port}/).size > 0
+    end
+
+    before do
+      File.open($cfg.nginx_conf, "w") do |f|
+        f.puts(INITIAL_CONF)
+      end
+
+      subject.stub :reload_nginx
+    end
+
+
+
+    describe :remove do
+      context "existing port" do
+        it "should be removed" do
+          expect {
+            subject.remove(8003)
+          }.to change{port_defined?(8003)}.from(true).to(false)
+        end
+      end
+    end
+
+    describe :add do
+      context "not - existing port" do
+        it "should be added" do
+          expect {
+            subject.add(8020)
+          }.to change{port_defined?(8020)}.from(false).to(true)
+        end
+      end
+
+      context "existing port" do
+        it "should not be added" do
+          expect {
+            subject.add(8003)
+          }.not_to change{port_defined?(8003)}
+        end
+      end
+    end
+  end
+end

data/spec/lib/phantom/collector_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'phantom/collector'
+
+module Phantom
+  describe Collector do
+    subject {Collector}
+
+    before do
+      $cfg.phantom_processes_number = 5
+      $cfg.phantom_base_port = 8002
+      subject.stub(:running_phantoms_shell_output).and_return(phantoms_ps_shell_output)
+    end
+
+    describe :get_running_instances do
+
+      it "should generate correct instances" do
+        generated_phantoms = subject.get_running_instances
+        
+        generated_phantoms.size.should eq 3
+        generated_phantoms.all? {|p| p.instance_of? Phantom::Process}.should be_true
+
+        phantoms_data.each_with_index do |data, i|
+          data.each do |attr, val|
+            generated_phantoms[i].send(attr).should eq val
+          end
+        end
+
+      end
+    end
+
+    describe :missing_ports do
+      it "should return required ports which phantoms do not run at" do
+        subject.missing_ports.should =~ [8004, 8005]
+      end
+    end
+
+    describe :required_ports do
+      it "should return all ports from configuration as array" do
+        subject.required_ports.should =~ [8002, 8003, 8004, 8005, 8006]
+      end
+    end
+
+    describe :on_port do
+      before do
+        subject.stub(:running_phantoms_shell_output).and_return(phantoms_ps_shell_output)
+        @data = phantoms_data.first
+      end
+
+      it "should return right process" do
+        p = subject.on_port(@data[:port])
+        @data.each do |attr, val|
+          p.send(attr).should eq val
+        end
+      end
+    end
+
+
+  end
+end

data/spec/lib/phantom/manager_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'phantom/manager'
+
+module Phantom
+  describe Manager do
+
+    subject {Manager}
+
+    describe :start do
+
+      let(:p) {generate_process}
+
+      it "should start new phantom process" do
+        p.should_receive :start
+        subject.start(p)
+      end
+
+      it "should add port to nginx conf" do
+        Nginx::Manager.should_receive(:add).with(p.port).once
+        subject.start(p)
+      end
+    end
+
+  end
+end