motherbrain 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acc003650c5db20ee4a4198443bfc04339a538e9
-  data.tar.gz: ec7dbd88bac26101aa0029882106b775352025f2
+  metadata.gz: dfdaf1022206cdd6053520eed112b1fedc5c25a8
+  data.tar.gz: 5b86141638b4849c04c864759e9a0546cca56ff4
 SHA512:
-  metadata.gz: c55553d715c7e67ac0a8627f3bffec8ce9ae47577c1601aa32242f75dade46acbb1d8614840df5ce8fddba26a028c91d91921fc88e0856aa5d98336e4811a0d6
-  data.tar.gz: 3f7d389d0ddcf5e067c417ada1412ff825710a3219bf83283808ff62bdf48ccf130ff0a5d8d6d97470b3a53e9c03eb1f0d8f9fffe17f8b606ce2bcc5ec233389
+  metadata.gz: d3be6473cedd6894ac603158363ddfb0249fa9bea09c747d8ef1957cdb5a82cd0976f56cb5a6857a692929656a2d51aa3128438ff766e1116d61d00b522debda
+  data.tar.gz: 2017c5767c5f3aa705fd9dd991b65b76f4f7b5dd113192702a7eb03911d3c1b8a5a7ca6fd47bac11c3f6a5c2d6157d6c098a376d233f5d87390ef41ff1a1e794

data/lib/mb/api/v1.rb

@@ -7,18 +7,21 @@ module MotherBrain::API
     require_relative 'v1/jobs_endpoint'
     require_relative 'v1/plugins_endpoint'
     require_relative 'v1/chef_endpoint'
+    require_relative 'v1/server_control_endpoint'
 
     version 'v1', using: :header, vendor: 'motherbrain'
     format :json
     default_format :json
 
-    rescue_from Grape::Exceptions::Validation do |e|
+    JSON_CONTENT_TYPE = {"Content-type" => "application/json"}
+
+    rescue_from Grape::Exceptions::Validation do |ex|
       body = MultiJson.encode(
-        status: e.status,
-        message: e.message,
-        param: e.param
+        status: ex.status,
+        message: ex.message,
+        param: ex.param
       )
-      rack_response(body, e.status, "Content-type" => "application/json")
+      rack_response(body, ex.status, JSON_CONTENT_TYPE)
     end
 
     rescue_from :all do |ex|
@@ -29,13 +32,31 @@ module MotherBrain::API
         MultiJson.encode(code: -1, message: ex.message)
       end
 
-      rack_response(body, 500, "Content-type" => "application/json")
+      http_status_code = if ex.is_a?(MB::APIError)
+        ex.http_status_code
+      else
+        500
+      end
+
+      rack_response(body, http_status_code, JSON_CONTENT_TYPE)
     end
 
     before do
       header['Access-Control-Allow-Origin'] = '*'
       header['Access-Control-Request-Method'] = '*'
       header.delete('Transfer-Encoding')
+
+      server_control_endpoint = false
+      MB::API::V1::ServerControlEndpoint.endpoints.each do |endpoint|
+        endpoint.routes.each do |route|
+          if request.path =~ route.route_compiled
+            server_control_endpoint = true
+            break
+          end
+        end
+      end
+      
+      raise MB::ApplicationPaused.new if MB::Application.paused? && !server_control_endpoint
     end
 
     mount V1::ConfigEndpoint
@@ -43,6 +64,7 @@ module MotherBrain::API
     mount V1::EnvironmentsEndpoint
     mount V1::PluginsEndpoint
     mount V1::ChefEndpoint
+    mount V1::ServerControlEndpoint
     add_swagger_documentation
 
     if MB.testing?

data/lib/mb/api/v1/server_control_endpoint.rb

@@ -0,0 +1,37 @@
+module MotherBrain::API
+  class V1
+    class ServerControlEndpoint < MB::API::Endpoint
+      helpers MB::Mixin::Services
+
+      desc "resume the server, preventing new requests from being processed"
+      put 'resume' do
+        MB::Application.resume
+        server_status
+      end
+
+      desc "pause the server, preventing new requests from being processed"
+      put 'pause' do
+        MB::Application.pause
+        server_status
+      end
+
+      desc "stop the server"
+      put 'stop' do
+        MB::Application.stop
+        status(202)
+        server_status
+      end
+
+      desc "get the server status"
+      get 'status' do
+        server_status
+      end
+
+      helpers do
+        def server_status
+          {server_status: MB::Application.status}
+        end
+      end
+    end
+  end
+end

data/lib/mb/application.rb

@@ -28,6 +28,12 @@ module MotherBrain
   # @example running the application in the background
   #   MB::Application.run!(config)
   module Application
+    module Status
+      RUNNING = :running
+      PAUSED = :paused
+      STOPPING = :stopping
+    end
+    
     class << self
       extend Forwardable
       include MB::Mixin::Services
@@ -95,7 +101,29 @@ module MotherBrain
 
       # Stop the running application
       def stop
-        instance.terminate
+        instance.async_interrupt(3)
+        @status = Status::STOPPING
+      end
+
+      # Set the application state to paused. This allows actors to
+      # continue processing, but causes the RestGateway not to accept
+      # new requests.
+      #
+      # See: MotherBrain::API::V1 L51, 'before' block
+      def pause
+        @status = Status::PAUSED
+      end
+
+      def resume
+        @status = Status::RUNNING
+      end
+
+      def paused?
+        status == Status::PAUSED
+      end
+
+      def status
+        @status ||= Status::RUNNING
       end
     end
 
@@ -135,7 +163,12 @@ module MotherBrain
         @registry[:ridley].async.configure(new_config.to_ridley)
       end
 
-      def interrupt
+      def async_interrupt(delay = 0)
+        future.interrupt(delay)
+      end
+
+      def interrupt(delay = 0)
+        Celluloid.sleep(delay) if delay > 0
         interrupt_mutex.synchronize do
           unless interrupted
             @interrupted = true

data/lib/mb/berkshelf.rb

@@ -63,6 +63,8 @@ module MotherBrain
 
       def initialize(berksfile_lock_path)
         @berksfile_lock = ::Berkshelf::Lockfile.from_file(berksfile_lock_path)
+      rescue ::Berkshelf::LockfileParserError
+        log.warn "Unable to parse Berksfile.lock - maybe it's an old format?"
       end
 
       # Return a hash of all of the cookbook versions found in the Berksfile.lock

data/lib/mb/errors.rb

@@ -89,6 +89,23 @@ module MotherBrain
     end
   end
 
+  class APIError < MBError
+    DEFAULT_HTTP_STATUS_CODE = 500
+
+    class << self
+      # @param [Integer] code
+      #
+      # @return [Integer]
+      def http_status_code(code = DEFAULT_HTTP_STATUS_CODE)
+        @exit_code ||= code
+      end
+    end
+
+    def http_status_code
+      self.class.http_status_code
+    end
+  end
+
   # Internal errors
   class InternalError < MBError
     exit_code(99)
@@ -695,4 +712,13 @@ module MotherBrain
     exit_code(25)
     error_code(3029)
   end
+
+  class ApplicationPaused < APIError
+    error_code(3330)
+    http_status_code(503)
+
+    def message
+      "MotherBrain is paused. It will not accept new requests until it is resumed."
+    end
+  end
 end

data/lib/mb/plugin_manager.rb

@@ -322,6 +322,7 @@ module MotherBrain
         scratch_dir   = FileSystem.tmpdir("cbplugin")
         metadata_path = File.join(scratch_dir, CookbookMetadata::JSON_FILENAME)
         plugin_path   = File.join(scratch_dir, Plugin::PLUGIN_FILENAME)
+        lockfile_path = File.join(scratch_dir, Berkshelf::Lockfile::BERKSFILE_LOCK)
 
         File.write(metadata_path, resource.metadata.to_json)
 
@@ -329,6 +330,10 @@ module MotherBrain
           raise PluginLoadError, "failure downloading plugin file for #{resource.name}"
         end
 
+        unless resource.download_file(:root_file, Berkshelf::Lockfile::BERKSFILE_LOCK, lockfile_path)
+          log.info "No Berksfile.lock found for #{resource.name} - won't be able to use cookbook versions from lockfile"
+        end
+
         load_file(scratch_dir, options)
       rescue PluginSyntaxError, PluginLoadError => ex
         err_msg = "could not load remote plugin #{name} (#{version}): #{ex.message}"

data/lib/mb/rest_gateway.rb

@@ -29,7 +29,7 @@ module MotherBrain
 
     include MB::Logging
 
-    DEFAULT_PORT = ENV["PORT"].to_i || 26100
+    DEFAULT_PORT = ENV["PORT"] ? ENV["PORT"].to_i : 26100
 
     DEFAULT_OPTIONS = {
       host: '0.0.0.0',
@@ -59,7 +59,12 @@ module MotherBrain
       options[:Port] = options[:port]
 
       log.info { "REST Gateway listening on #{options[:host]}:#{options[:port]}" }
-      super(app, options)
+      
+      begin
+        super(app, options)
+      rescue Errno::EADDRINUSE
+        log.fatal { "Port #{options[:port]} is already in use. Unable to start rest gateway." }
+      end
     end
 
     private

data/lib/mb/version.rb

@@ -1,3 +1,3 @@
 module MotherBrain
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/spec/unit/mb/api/v1/server_control_endpoint_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe MB::API::V1::ServerControlEndpoint do
+  include Rack::Test::Methods
+
+  before(:all) { MB::RestGateway.start(port: 26101) }
+  after(:all) { MB::RestGateway.stop }
+  after(:each) { MB::Application.resume }
+  let(:app) { MB::RestGateway.instance.app }
+
+  describe "PUT /pause" do
+    it "pauses the server" do
+      put '/pause'
+      last_response.status.should == 200
+      JSON.parse(last_response.body).should eq("server_status" => "paused")
+    end
+
+    it "prevents actions while the server is paused" do
+      put '/pause'
+      json_post "/environments/environmentname/upgrade",
+        MultiJson.dump(plugin: { name: 'pluginname', version: '1.0.0' })
+      last_response.status.should == 503
+      JSON.parse(last_response.body).should eq("code"=>3330, "message"=>"MotherBrain is paused. It will not accept new requests until it is resumed.")
+    end
+  end
+
+  describe "PUT /resume" do
+    before do
+      MB::Application.pause
+    end
+    
+    it "resumes the server" do
+      put '/resume'
+      last_response.status.should == 200
+      JSON.parse(last_response.body).should eq("server_status" => "running")
+    end
+
+    it "allows actions while the server is resumed" do
+      put '/resume'
+      json_post "/environments/environmentname/upgrade",
+        MultiJson.dump(plugin: { name: 'pluginname', version: '1.0.0' })
+      last_response.status.should == 201
+    end
+  end
+
+  describe "PUT /stop" do
+    it "stops the server" do
+      MB::Application.instance.should_receive(:async_interrupt).with(3)
+      put '/stop'
+      last_response.status.should == 202
+      JSON.parse(last_response.body).should eq("server_status" => "stopping")
+    end
+  end
+end

data/spec/unit/mb/application_spec.rb

@@ -15,5 +15,19 @@ describe MB::Application do
         subject.config.should be_a(MB::Config)
       end
     end
+
+    describe "::pause" do
+      it "should pause" do
+        subject.pause
+        expect(subject.paused?).to eq(true)
+      end
+    end
+
+    describe "::resume" do
+      it "should resume" do
+        subject.resume
+        expect(subject.paused?).to eq(false)
+      end
+    end
   end
 end

data/spec/unit/mb/rest_gateway_spec.rb

@@ -10,4 +10,19 @@ describe MB::RestGateway do
       subject.app.should be_a(MB::API::Application)
     end
   end
+
+  describe "constants" do
+    it "should set DEFAULT_PORT to $PORT" do
+      p = 12345
+      ENV["PORT"] = p.to_s
+      load File.join(MB.app_root, "lib", "mb", "rest_gateway.rb")
+      expect(MB::RestGateway::DEFAULT_PORT).to eq(p)
+    end
+
+    it "should set DEFAULT_PORT to 26100 if $PORT is not set" do
+      ENV.delete("PORT")
+      load File.join(MB.app_root, "lib", "mb", "rest_gateway.rb")
+      expect(MB::RestGateway::DEFAULT_PORT).to eq(26100)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motherbrain
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jamie Winsor
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -393,6 +393,7 @@ files:
 - lib/mb/api/v1/environments_endpoint.rb
 - lib/mb/api/v1/jobs_endpoint.rb
 - lib/mb/api/v1/plugins_endpoint.rb
+- lib/mb/api/v1/server_control_endpoint.rb
 - lib/mb/api/validators.rb
 - lib/mb/api/validators/sem_ver.rb
 - lib/mb/application.rb
@@ -523,6 +524,7 @@ files:
 - spec/unit/mb/api/v1/environments_endpoint_spec.rb
 - spec/unit/mb/api/v1/jobs_endpoint_spec.rb
 - spec/unit/mb/api/v1/plugins_endpoint_spec.rb
+- spec/unit/mb/api/v1/server_control_endpoint_spec.rb
 - spec/unit/mb/api/v1_spec.rb
 - spec/unit/mb/api/validators/sem_ver_spec.rb
 - spec/unit/mb/application_spec.rb
@@ -622,7 +624,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: An orchestrator for Chef
@@ -673,6 +675,7 @@ test_files:
 - spec/unit/mb/api/v1/environments_endpoint_spec.rb
 - spec/unit/mb/api/v1/jobs_endpoint_spec.rb
 - spec/unit/mb/api/v1/plugins_endpoint_spec.rb
+- spec/unit/mb/api/v1/server_control_endpoint_spec.rb
 - spec/unit/mb/api/v1_spec.rb
 - spec/unit/mb/api/validators/sem_ver_spec.rb
 - spec/unit/mb/application_spec.rb