chef-zero 4.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9303597115a96be3764f56348da326bd663b4950
-  data.tar.gz: 0d6db19f14312ea7cad130819512153ec56eb9b8
+  metadata.gz: 960c8c81923f89a55fd64b0de21517f5c2fde8e5
+  data.tar.gz: ace9ada169514cdf654d7f359131c2103367da2d
 SHA512:
-  metadata.gz: 9591446989226c5792ffe7c7bb9e0b3489b2601d1829d1dfdce7f6081fd3c8a11f68524ef7c59775ff35193ba82f3d13655c65360b95aa4b3326831acac520cf
-  data.tar.gz: 878fcd44f84e77c8ba2906336d6a9f1a101cbdf0b9476670baf2be8f7bef3c6ca7effc886119ffc936995680a197ec4c384dd1dad4c87c77dbf81d56c1fb7122
+  metadata.gz: 07af5a8a644ac4476ae551d4512e51ca5ba3a069bce3dae3afcbbf4299c9ef8b593113acbe15699da3fa7a991a7c0689606099642ff7c3773386bd279a024f86
+  data.tar.gz: 92f6a384a72be04439eeb29f1046217a835b26741336dfad4a6d3dd6e1cb88e8860f234d55d2e2daca36a6a822f2792d89d4a267666412d9ce18fff17ee53a16

data/README.md

@@ -1,4 +1,4 @@
-[![Stories in Ready](https://badge.waffle.io/opscode/chef-zero.png?label=ready&title=Ready)](https://waffle.io/opscode/chef-zero)[![Stories in Progress](https://badge.waffle.io/opscode/chef-zero.png?label=in+progress&title=In+Progress)](https://waffle.io/opscode/chef-zero)
+[![Stories in Ready](https://badge.waffle.io/chef/chef-zero.png?label=ready&title=Ready)](https://waffle.io/chef/chef-zero)[![Stories in Progress](https://badge.waffle.io/chef/chef-zero.png?label=in+progress&title=In+Progress)](https://waffle.io/chef/chef-zero)
 
 Chef Zero
 =========

data/lib/chef_zero/endpoints/policies_endpoint.rb

@@ -1,4 +1,8 @@
 require 'ffi_yajl'
+
+require 'chef/version_class'
+require 'chef/exceptions'
+
 require 'chef_zero/endpoints/rest_object_endpoint'
 require 'chef_zero/chef_data/data_normalizer'
 
@@ -41,7 +45,8 @@ module ChefZero
 
       def validate(request)
         req_object = validate_json(request.body)
-        validate_name(request, req_object) ||
+        validate_revision_id(request, req_object) ||
+          validate_name(request, req_object) ||
           validate_run_list(req_object) ||
           validate_each_run_list_item(req_object) ||
           validate_cookbook_locks_collection(req_object) ||
@@ -54,23 +59,35 @@ module ChefZero
         # error(400, "Must specify #{identity_keys.map { |k| k.inspect }.join(' or ')} in JSON")
       end
 
+      def validate_revision_id(request, req_object)
+        if !req_object.key?("revision_id")
+          error(400, "Field 'revision_id' missing")
+        elsif req_object["revision_id"].empty?
+          error(400, "Field 'revision_id' invalid")
+        elsif req_object["revision_id"].size > 255
+          error(400, "Field 'revision_id' invalid")
+        elsif req_object["revision_id"] !~ /^[\-[:alnum:]_\.\:]+$/
+          error(400, "Field 'revision_id' invalid")
+        end
+      end
+
       def validate_name(request, req_object)
         if !req_object.key?("name")
-          error(400, "Must specify 'name' in JSON")
-        elsif req_object["name"] != URI.decode(request.rest_path[4])
-          error(400, "'name' field in JSON must match the policy name in the URL")
+          error(400, "Field 'name' missing")
+        elsif req_object["name"] != (uri_policy_name = URI.decode(request.rest_path[4]))
+          error(400, "Field 'name' invalid : #{uri_policy_name} does not match #{req_object["name"]}")
         elsif req_object["name"].size > 255
-          error(400, "'name' field in JSON must be 255 characters or fewer")
+          error(400, "Field 'name' invalid")
         elsif req_object["name"] !~ /^[\-[:alnum:]_\.\:]+$/
-          error(400, "'name' field in JSON must be contain only alphanumeric, hypen, underscore, and dot characters")
+          error(400, "Field 'name' invalid")
         end
       end
 
       def validate_run_list(req_object)
         if !req_object.key?("run_list")
-          error(400, "Must specify 'run_list' in JSON")
+          error(400, "Field 'run_list' missing")
         elsif !req_object["run_list"].kind_of?(Array)
-          error(400, "'run_list' must be an Array of run list items")
+          error(400, "Field 'run_list' is not a valid run list")
         end
       end
 
@@ -85,17 +102,17 @@ module ChefZero
 
       def validate_run_list_item(run_list_item)
         if !run_list_item.kind_of?(String)
-          error(400, "Items in run_list must be strings in fully qualified recipe format, like recipe[cookbook::recipe]")
+          error(400, "Field 'run_list' is not a valid run list")
         elsif run_list_item !~ /\Arecipe\[[^\s]+::[^\s]+\]\Z/
-          error(400, "Items in run_list must be strings in fully qualified recipe format, like recipe[cookbook::recipe]")
+          error(400, "Field 'run_list' is not a valid run list")
         end
       end
 
       def validate_cookbook_locks_collection(req_object)
         if !req_object.key?("cookbook_locks")
-          error(400, "Must specify 'cookbook_locks' in JSON")
+          error(400, "Field 'cookbook_locks' missing")
         elsif !req_object["cookbook_locks"].kind_of?(Hash)
-          error(400, "'cookbook_locks' must be a JSON object of cookbook_name: lock_data pairs")
+          error(400, "Field 'cookbook_locks' invalid")
         end
       end
 
@@ -112,14 +129,25 @@ module ChefZero
         if !lock.kind_of?(Hash)
           error(400, "cookbook_lock entries must be a JSON object")
         elsif !lock.key?("identifier")
-          error(400, "cookbook_lock entries must contain an 'identifier' field")
-        elsif !lock.key?("dotted_decimal_identifier")
-          error(400, "cookbook_lock entries must contain an 'dotted_decimal_identifier' field")
+          error(400, "Field 'identifier' missing")
         elsif lock["identifier"].size > 255
-          error(400, "cookbook_lock entries 'identifier' field must be 255 or fewer characters")
+          error(400, "Field 'identifier' invalid")
+        elsif !lock.key?("version")
+          error(400, "Field 'version' missing")
+        elsif lock.key?("dotted_decimal_identifier")
+          unless valid_version?(lock["dotted_decimal_identifier"])
+            error(400, "Field 'dotted_decimal_identifier' is not a valid version")
+          end
         end
       end
 
+      def valid_version?(version_string)
+        Chef::Version.new(version_string)
+        true
+      rescue Chef::Exceptions::InvalidCookbookVersion
+        false
+      end
+
     end
   end
 end

data/lib/chef_zero/endpoints/version_endpoint.rb

@@ -0,0 +1,12 @@
+require 'chef_zero/rest_base'
+
+module ChefZero
+  module Endpoints
+    # /version
+    class VersionEndpoint < RestBase
+      def get(request)
+        text_response(200, "chef-zero #{ChefZero::VERSION}\n")
+      end
+    end
+  end
+end

data/lib/chef_zero/rest_base.rb

@@ -181,6 +181,10 @@ module ChefZero
       already_json_response(response_code, FFI_Yajl::Encoder.encode(json, :pretty => true))
     end
 
+    def text_response(response_code, text)
+      [response_code, {"Content-Type" => "text/plain"}, text]
+    end
+
     def already_json_response(response_code, json_text)
       [response_code, {"Content-Type" => "application/json"}, json_text]
     end
@@ -191,8 +195,9 @@ module ChefZero
         # Strip off /organizations/chef if we are in single org mode
         if rest_path[0..1] != [ 'organizations', server.options[:single_org] ]
           raise "Unexpected URL #{rest_path[0..1]} passed to build_uri in single org mode"
+        else
+          "#{base_uri}/#{rest_path[2..-1].join('/')}"
         end
-        "#{base_uri}/#{rest_path[2..-1].join('/')}"
       else
         "#{base_uri}/#{rest_path.join('/')}"
       end

data/lib/chef_zero/server.rb

@@ -27,6 +27,7 @@ require 'webrick'
 require 'webrick/https'
 
 require 'chef_zero'
+require 'chef_zero/socketless_server_map'
 require 'chef_zero/chef_data/cookbook_data'
 require 'chef_zero/chef_data/acl_path'
 require 'chef_zero/rest_router'
@@ -83,9 +84,11 @@ require 'chef_zero/endpoints/user_association_request_endpoint'
 require 'chef_zero/endpoints/user_organizations_endpoint'
 require 'chef_zero/endpoints/file_store_file_endpoint'
 require 'chef_zero/endpoints/not_found_endpoint'
+require 'chef_zero/endpoints/version_endpoint'
 
 module ChefZero
   class Server
+
     DEFAULT_OPTIONS = {
       :host => '127.0.0.1',
       :port => 8889,
@@ -95,6 +98,11 @@ module ChefZero
       :ssl => false
     }.freeze
 
+    GLOBAL_ENDPOINTS = [
+      '/license',
+      '/version',
+    ]
+
     def initialize(options = {})
       @options = DEFAULT_OPTIONS.merge(options)
       if @options[:single_org] && !@options.has_key?(:osc_compat)
@@ -102,6 +110,7 @@ module ChefZero
       end
       @options.freeze
       ChefZero::Log.level = @options[:log_level].to_sym
+      @app = nil
     end
 
     # @return [Hash]
@@ -140,6 +149,12 @@ module ChefZero
                end
     end
 
+    def local_mode_url
+      raise "Port not yet set, cannot generate URL" unless port.kind_of?(Integer)
+      "chefzero://localhost:#{port}"
+    end
+
+
     #
     # The data store for this server (default is in-memory).
     #
@@ -218,7 +233,6 @@ module ChefZero
       thread.join
     end
 
-
     #
     # Start a Chef Zero server in a forked process. This method returns the PID
     # to the forked process.
@@ -278,9 +292,19 @@ module ChefZero
         sleep(0.01)
       end
 
+      SocketlessServerMap.instance.register_port(@port, self)
+
       @thread
     end
 
+    def start_socketless
+      @port = SocketlessServerMap.instance.register_no_listen_server(self)
+    end
+
+    def handle_socketless_request(request_env)
+      app.call(request_env)
+    end
+
     #
     # Boolean method to determine if the server is currently ready to accept
     # requests. This method will attempt to make an HTTP request against the
@@ -309,6 +333,7 @@ module ChefZero
       if @thread
         ChefZero::Log.error("Chef Zero did not stop within #{wait} seconds! Killing...")
         @thread.kill
+        SocketlessServerMap.deregister(port)
       end
     ensure
       @server = nil
@@ -495,8 +520,7 @@ module ChefZero
           [ "/organizations/*/*/*/_acl/*", AclEndpoint.new(self) ]
         ]
       end
-      result +
-      [
+      result + [
         # Both
         [ "/organizations/*/clients", ActorsEndpoint.new(self) ],
         [ "/organizations/*/clients/*", ActorEndpoint.new(self) ],
@@ -526,13 +550,21 @@ module ChefZero
         [ "/organizations/*/sandboxes/*", SandboxEndpoint.new(self) ],
         [ "/organizations/*/search", SearchesEndpoint.new(self) ],
         [ "/organizations/*/search/*", SearchEndpoint.new(self) ],
+        [ "/version", VersionEndpoint.new(self) ],
 
         # Internal
         [ "/organizations/*/file_store/**", FileStoreFileEndpoint.new(self) ]
       ]
     end
 
+    def global_endpoint?(ep)
+      GLOBAL_ENDPOINTS.any? do |g_ep|
+        ep.start_with?(g_ep)
+      end
+    end
+
     def app
+      return @app if @app
       router = RestRouter.new(open_source_endpoints)
       router.not_found = NotFoundEndpoint.new
 
@@ -541,9 +573,11 @@ module ChefZero
       else
         rest_base_prefix = []
       end
-      return proc do |env|
+      @app = proc do |env|
         begin
-          request = RestRequest.new(env, rest_base_prefix)
+          prefix = global_endpoint?(env['PATH_INFO']) ? [] : rest_base_prefix
+
+          request = RestRequest.new(env, prefix)
           if @on_request_proc
             @on_request_proc.call(request)
           end
@@ -577,6 +611,7 @@ module ChefZero
           end
         end
       end
+      @app
     end
 
     def dejsonize_children(hash)

data/lib/chef_zero/socketless_server_map.rb

@@ -0,0 +1,84 @@
+#
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'thread'
+require 'singleton'
+
+module ChefZero
+
+  class ServerNotFound < StandardError
+  end
+
+  class NoSocketlessPortAvailable < StandardError
+  end
+
+  class SocketlessServerMap
+
+    def self.request(port, request_env)
+      instance.request(port, request_env)
+    end
+
+    MUTEX = Mutex.new
+
+    include Singleton
+
+    def initialize()
+      reset!
+    end
+
+    def reset!
+      @servers_by_port = {}
+    end
+
+    def register_port(port, server)
+      MUTEX.synchronize do
+        @servers_by_port[port] = server
+      end
+    end
+
+    def register_no_listen_server(server)
+      MUTEX.synchronize do
+        1.upto(1000) do |port|
+          unless @servers_by_port.key?(port)
+            @servers_by_port[port] = server
+            return port
+          end
+        end
+        raise NoSocketlessPortAvailable, "No socketless ports left to register"
+      end
+    end
+
+    def has_server_on_port?(port)
+      @servers_by_port.key?(port)
+    end
+
+    def deregister(port)
+      MUTEX.synchronize do
+        @servers_by_port.delete(port)
+      end
+    end
+
+    def request(port, request_env)
+      server = @servers_by_port[port]
+      raise ServerNotFound, "No socketless chef-zero server on given port #{port.inspect}" unless server
+      server.handle_socketless_request(request_env)
+    end
+
+  end
+end
+

data/lib/chef_zero/version.rb

@@ -1,3 +1,3 @@
 module ChefZero
-  VERSION = '4.0'
+  VERSION = '4.1.0'
 end

data/spec/run_pedant.rb

@@ -79,7 +79,8 @@ begin
       '--skip-authentication',
       '--skip-authorization',
       '--skip-keys',
-      '--skip-omnibus'
+      '--skip-omnibus',
+      '--skip-cookbook_artifacts'
     ])
 
     result = RSpec::Core::Runner.run(Pedant.config.rspec_args)

data/spec/server_spec.rb

@@ -33,6 +33,12 @@ describe ChefZero::Server do
         httpcall.get('/nodes', 'Accept' => accepts)
       end
 
+      def get_version
+        uri = URI(@server.url)
+        httpcall = Net::HTTP.new(uri.host, uri.port)
+        httpcall.get('/version', 'Accept' => 'text/plain, application/json')
+      end
+
       it 'accepts requests with no accept header' do
         request = Net::HTTP::Get.new('/nodes')
         request.delete('Accept')
@@ -77,6 +83,9 @@ describe ChefZero::Server do
         expect(get_nodes('a/b;a=b;c=d, application/json;a=b, application/xml;a=b').code).to eq '200'
       end
 
+      it 'accepts /version' do
+        expect(get_version.body.start_with?('chef-zero')).to be true
+      end
     end
   end
 end

data/spec/socketless_server_map_spec.rb

@@ -0,0 +1,71 @@
+require 'chef_zero/socketless_server_map'
+
+
+describe "Socketless Mode" do
+
+  let(:server_map) { ChefZero::SocketlessServerMap.instance.tap { |i| i.reset! } }
+
+  let(:server) { instance_double("ChefZero::Server") }
+
+  let(:second_server) { instance_double("ChefZero::Server") }
+
+  it "registers a socketful server" do
+    server_map.register_port(8889, server)
+    expect(server_map).to have_server_on_port(8889)
+  end
+
+  context "when a no-listen server is registered" do
+
+    let!(:port) { server_map.register_no_listen_server(server) }
+
+    it "assigns the server a low port number" do
+      expect(port).to eq(1)
+    end
+
+    context "and another server is registered" do
+
+      let!(:next_port) { server_map.register_no_listen_server(second_server) }
+
+      it "assigns another port when another server is registered" do
+        expect(next_port).to eq(2)
+      end
+
+      it "raises NoSocketlessPortAvailable when too many servers are registered" do
+        expect { 1000.times { server_map.register_no_listen_server(server) } }.to raise_error(ChefZero::NoSocketlessPortAvailable)
+      end
+
+      it "deregisters a server" do
+        expect(server_map).to have_server_on_port(1)
+        server_map.deregister(1)
+        expect(server_map).to_not have_server_on_port(1)
+      end
+
+      describe "routing requests to a server" do
+
+        let(:rack_req) do
+          r = {}
+          r["REQUEST_METHOD"] = "GET"
+          r["SCRIPT_NAME"] = ""
+          r["PATH_INFO"] = "/clients"
+          r["QUERY_STRING"] = ""
+          r["rack.input"] = StringIO.new("")
+          r
+        end
+
+        let(:rack_response) { [200, {}, ["this is the response body"] ] }
+
+        it "routes a request to the registered port" do
+          expect(server).to receive(:handle_socketless_request).with(rack_req).and_return(rack_response)
+          response = server_map.request(1, rack_req)
+          expect(response).to eq(rack_response)
+        end
+
+        it "raises ServerNotFound when a request is sent to an unregistered port" do
+          expect { server_map.request(99, rack_req) }.to raise_error(ChefZero::ServerNotFound)
+        end
+      end
+    end
+  end
+
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-zero
 version: !ruby/object:Gem::Version
-  version: '4.0'
+  version: 4.1.0
 platform: ruby
 authors:
 - John Keiser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -186,6 +186,7 @@ files:
 - lib/chef_zero/endpoints/user_association_requests_count_endpoint.rb
 - lib/chef_zero/endpoints/user_association_requests_endpoint.rb
 - lib/chef_zero/endpoints/user_organizations_endpoint.rb
+- lib/chef_zero/endpoints/version_endpoint.rb
 - lib/chef_zero/log.rb
 - lib/chef_zero/rest_base.rb
 - lib/chef_zero/rest_error_response.rb
@@ -193,6 +194,7 @@ files:
 - lib/chef_zero/rest_router.rb
 - lib/chef_zero/rspec.rb
 - lib/chef_zero/server.rb
+- lib/chef_zero/socketless_server_map.rb
 - lib/chef_zero/solr/query/binary_operator.rb
 - lib/chef_zero/solr/query/phrase.rb
 - lib/chef_zero/solr/query/range_query.rb
@@ -207,6 +209,7 @@ files:
 - spec/run_pedant.rb
 - spec/search_spec.rb
 - spec/server_spec.rb
+- spec/socketless_server_map_spec.rb
 - spec/support/oc_pedant.rb
 - spec/support/pedant.rb
 - spec/support/stickywicket.pem
@@ -236,4 +239,3 @@ specification_version: 4
 summary: Self-contained, easy-setup, fast-start in-memory Chef server for testing
   and solo setup purposes
 test_files: []
-has_rdoc: