chef-api 0.2.0

data/spec/support/chef_server.rb

@@ -0,0 +1,115 @@
+require 'chef_zero/server'
+
+module RSpec
+  class ChefServer
+    module DSL
+      def chef_server
+        RSpec::ChefServer
+      end
+    end
+
+    class << self
+      def method_missing(m, *args, &block)
+        instance.send(m, *args, &block)
+      end
+    end
+
+    require 'singleton'
+    include Singleton
+
+    #
+    #
+    #
+    def initialize
+      @server = ChefZero::Server.new({
+        port: port,
+        log_level: :fatal,
+        generate_real_keys: false,
+      })
+
+      ChefAPI.endpoint = @server.url
+      ChefAPI.key      = ChefZero::PRIVATE_KEY
+    end
+
+    #
+    #
+    #
+    def start
+      @server.start_background(1)
+    end
+
+    #
+    # Clear all the information in the server. This hook is run after each
+    # example group, giving the appearance of an "empty" Chef Server for
+    # each test.
+    #
+    def clear
+      @server.clear_data
+    end
+
+    #
+    # Stop the server (since it might not be running)
+    #
+    def stop
+      @server.stop if @server.running?
+    end
+
+    #
+    #
+    #
+    def load_data(key, id, data = {})
+      @server.load_data({ key.to_s => { id => JSON.fast_generate(data) } })
+    end
+
+    #
+    #
+    #
+    [
+      ['clients', 'client'],
+      ['cookbooks', 'cookbook'],
+      ['environments', 'environment'],
+      ['nodes', 'node'],
+      ['roles', 'role'],
+    ].each do |plural, singular|
+      define_method(plural) do
+        @server.data_store.list([plural])
+      end
+
+      define_method(singular) do |id|
+        JSON.parse(@server.data_store.get([plural, id]))
+      end
+
+      define_method("create_#{singular}") do |id, data = {}|
+        load_data(plural, id, data)
+      end
+
+      define_method("has_#{singular}?") do |id|
+        send(plural).include?(id)
+      end
+    end
+
+    private
+
+      #
+      # A randomly assigned, open port for run the Chef Zero server.
+      #
+      # @return [Fixnum]
+      #
+      def port
+        return @port if @port
+
+        @server = TCPServer.new('127.0.0.1', 0)
+        @port   = @server.addr[1].to_i
+        @server.close
+
+        return @port
+      end
+  end
+end
+
+
+RSpec.configure do |config|
+  config.before(:suite) { RSpec::ChefServer.start }
+  config.after(:each)   { RSpec::ChefServer.clear }
+  config.after(:suite)  { RSpec::ChefServer.stop }
+end

data/spec/support/shared/chef_api_resource.rb

@@ -0,0 +1,91 @@
+shared_examples_for 'a Chef API resource' do |type, options = {}|
+  let(:resource_id) { "my_#{type}" }
+
+  describe '.fetch' do
+    it 'returns nil when the resource does not exist' do
+      expect(described_class.fetch('not_real')).to be_nil
+    end
+
+    it 'returns the resource' do
+      chef_server.send("create_#{type}", resource_id)
+      expect(described_class.fetch(resource_id).name).to eq(resource_id)
+    end
+  end
+
+  describe '.build' do
+    it 'builds a resource' do
+      instance = described_class.build(name: resource_id)
+      expect(instance).to be_a(described_class)
+    end
+
+    it 'does not create a remote resource' do
+      described_class.build(name: resource_id)
+      expect(chef_server).to_not send("have_#{type}", resource_id)
+    end
+  end
+
+  describe '.create' do
+    it 'creates a new remote resource' do
+      described_class.create(name: resource_id)
+      expect(chef_server).to send("have_#{type}", resource_id)
+    end
+
+    it 'raises an exception when the resource already exists' do
+      chef_server.send("create_#{type}", resource_id)
+      expect {
+        described_class.create(name: resource_id)
+      }.to raise_error(ChefAPI::Error::ResourceAlreadyExists)
+    end
+  end
+
+  describe '.exists?' do
+    it 'returns false when the resource does not exist' do
+      expect(described_class.exists?(resource_id)).to be_false
+    end
+
+    it 'returns true when the resource exists' do
+      chef_server.send("create_#{type}", resource_id)
+      expect(described_class.exists?(resource_id)).to be_true
+    end
+  end
+
+  describe '.destroy' do
+    it "destroys the #{type} with the given ID" do
+      chef_server.send("create_#{type}", resource_id)
+      described_class.delete(resource_id)
+
+      expect(chef_server).to_not send("have_#{type}", resource_id)
+    end
+
+    it 'does not raise an exception if the record does not exist' do
+      expect { described_class.delete(resource_id) }.to_not raise_error
+    end
+  end
+
+  describe '.update' do
+    it 'updates an existing resource' do
+      chef_server.send("create_#{type}", resource_id)
+
+      options[:update].each do |key, value|
+        described_class.update(resource_id, key => value)
+        expect(chef_server.send(type, resource_id)[key.to_s]).to eq(value)
+      end
+    end
+
+    it 'raises an exception when the resource does not exist' do
+      expect {
+        described_class.update(resource_id)
+      }.to raise_error(ChefAPI::Error::ResourceNotFound)
+    end
+  end
+
+  describe '.count' do
+    it 'returns the total number of resources' do
+      5.times do |i|
+        chef_server.send("create_#{type}", "#{resource_id}_#{i}")
+      end
+
+      expect(described_class.count).to be >= 5
+    end
+  end
+end

data/spec/unit/resources/base_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module ChefAPI
+  describe Resource::Base do
+    before do
+      # Unset all instance variables (which are actually cached on the parent
+      # class) to prevent caching.
+      described_class.instance_variables.each do |instance_variable|
+        described_class.send(:remove_instance_variable, instance_variable)
+      end
+    end
+
+    describe '.schema' do
+      it 'sets the schema for the class' do
+        block = Proc.new {}
+        described_class.schema(&block)
+        expect(described_class.schema).to be_a(Schema)
+      end
+    end
+
+    describe '.collection_path' do
+      it 'raises an exception if the collection name is not set' do
+        expect { described_class.collection_path }.to raise_error
+      end
+
+      it 'sets the collection name' do
+        described_class.collection_path('bacons')
+        expect(described_class.collection_path).to eq('bacons')
+      end
+
+      it 'converts the symbol to a string' do
+        described_class.collection_path(:bacons)
+        expect(described_class.collection_path).to eq('bacons')
+      end
+    end
+
+    describe '.build' do
+      it 'creates a new instance' do
+        described_class.stub(:new)
+        described_class.stub(:schema).and_return(double(attributes: {}))
+
+        expect(described_class).to receive(:new).with({foo: 'bar'}, {})
+        described_class.build(foo: 'bar')
+      end
+    end
+  end
+end

data/spec/unit/resources/client_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+module ChefAPI
+  describe Resource::Client do
+    describe '.from_file' do
+      it 'raises a permission error when Ruby cannot read the file' do
+        File.stub(:read).and_raise(Errno::EACCES)
+        expect {
+          described_class.from_file('client.pem')
+        }.to raise_error(Error::InsufficientFilePermissions)
+      end
+
+      it 'raises an error when the file does not exist' do
+        File.stub(:read).and_raise(Errno::ENOENT)
+        expect {
+          described_class.from_file('client.pem')
+        }.to raise_error(Error::FileNotFound)
+      end
+    end
+
+    describe '.initialize' do
+      it 'converts an x509 certificate to a public key' do
+        certificate = <<-EOH.gsub(/^ {10}/, '')
+          -----BEGIN CERTIFICATE-----
+          MIIDOjCCAqOgAwIBAgIEkT9umDANBgkqhkiG9w0BAQUFADCBnjELMAkGA1UEBhMC
+          VVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBgNVBAcMB1NlYXR0bGUxFjAUBgNV
+          BAoMDU9wc2NvZGUsIEluYy4xHDAaBgNVBAsME0NlcnRpZmljYXRlIFNlcnZpY2Ux
+          MjAwBgNVBAMMKW9wc2NvZGUuY29tL2VtYWlsQWRkcmVzcz1hdXRoQG9wc2NvZGUu
+          Y29tMCAXDTEzMDYwNzE3NDcxNloYDzIxMDIwNzIyMTc0NzE2WjCBnTEQMA4GA1UE
+          BxMHU2VhdHRsZTETMBEGA1UECBMKV2FzaGluZ3RvbjELMAkGA1UEBhMCVVMxHDAa
+          BgNVBAsTE0NlcnRpZmljYXRlIFNlcnZpY2UxFjAUBgNVBAoTDU9wc2NvZGUsIElu
+          Yy4xMTAvBgNVBAMUKFVSSTpodHRwOi8vb3BzY29kZS5jb20vR1VJRFMvY2xpZW50
+          X2d1aWQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCko42znqDzryvE
+          aB1DBHLFpjLZ7aWrTJQJJUvQhMFTE/1nisa+1bw8MvOYnGDSp2j6V7XJsJgZFsAW
+          7w5TTBHrYRAz0Boi+uaQ3idqfGI5na/dRt2MqFnwJYqvm7z+LeeYbGlXFNnhUInt
+          OjZD6AtrvuTGAEVdyIznsOMsLun/KWy9zG0+C+6vCnxGga+Z+xZ56JrBvWoWeIjG
+          kO0J6E3uqyzAC8FwN6xnyaHNlvODE+40MuioVJ52oLikTwaVe3T+vSJQoCu1lz7c
+          AbdszAhDW2p+GVvBBjAXLNi/w27heDQKBQOS+6tHJAX3WeFj0xgE5Bryae67E0q8
+          hM4WPL6PAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAWlBQBu8kzhSA4TuHJNyngRAJ
+          WXHus2brJZHaaZYMbzZMq+lklMbdw8NZBay+qVqN/latgQ7fjY9RSSdhCTeSITyw
+          gn8s3zeFS7C6nwrzYNAQXTRJZoSgn32hgZoD1H0LjW5vcoqiYZOHvX3EOySboS09
+          bAELUrq85D+uVns9C5A=
+          -----END CERTIFICATE-----
+        EOH
+
+        instance = described_class.new(certificate: certificate)
+        expect(instance.public_key).to eq <<-EOH.gsub(/^ {10}/, '')
+          -----BEGIN PUBLIC KEY-----
+          MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApKONs56g868rxGgdQwRy
+          xaYy2e2lq0yUCSVL0ITBUxP9Z4rGvtW8PDLzmJxg0qdo+le1ybCYGRbAFu8OU0wR
+          62EQM9AaIvrmkN4nanxiOZ2v3UbdjKhZ8CWKr5u8/i3nmGxpVxTZ4VCJ7To2Q+gL
+          a77kxgBFXciM57DjLC7p/ylsvcxtPgvurwp8RoGvmfsWeeiawb1qFniIxpDtCehN
+          7qsswAvBcDesZ8mhzZbzgxPuNDLoqFSedqC4pE8GlXt0/r0iUKArtZc+3AG3bMwI
+          Q1tqfhlbwQYwFyzYv8Nu4Xg0CgUDkvurRyQF91nhY9MYBOQa8mnuuxNKvITOFjy+
+          jwIDAQAB
+          -----END PUBLIC KEY-----
+        EOH
+      end
+    end
+
+    describe '#regenerate_keys' do
+      it 'raises an error if the client is not persisted to the server' do
+        expect {
+          described_class.new.regenerate_keys
+        }.to raise_error(Error::CannotRegenerateKey)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: chef-api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Seth Vargo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: mixlib-authentication
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: A tiny Chef API client with minimal dependencies
+email:
+- sethvargo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- chef-api.gemspec
+- lib/chef-api.rb
+- lib/chef-api/boolean.rb
+- lib/chef-api/configurable.rb
+- lib/chef-api/connection.rb
+- lib/chef-api/defaults.rb
+- lib/chef-api/error_collection.rb
+- lib/chef-api/errors.rb
+- lib/chef-api/logger.rb
+- lib/chef-api/proxy.rb
+- lib/chef-api/resource.rb
+- lib/chef-api/resources/base.rb
+- lib/chef-api/resources/client.rb
+- lib/chef-api/resources/collection_proxy.rb
+- lib/chef-api/resources/cookbook.rb
+- lib/chef-api/resources/cookbook_version.rb
+- lib/chef-api/resources/data_bag.rb
+- lib/chef-api/resources/data_bag_item.rb
+- lib/chef-api/resources/environment.rb
+- lib/chef-api/resources/node.rb
+- lib/chef-api/resources/principal.rb
+- lib/chef-api/resources/role.rb
+- lib/chef-api/resources/user.rb
+- lib/chef-api/schema.rb
+- lib/chef-api/util.rb
+- lib/chef-api/validator.rb
+- lib/chef-api/validators/base.rb
+- lib/chef-api/validators/required.rb
+- lib/chef-api/validators/type.rb
+- lib/chef-api/version.rb
+- locales/en.yml
+- spec/integration/resources/client_spec.rb
+- spec/integration/resources/environment_spec.rb
+- spec/integration/resources/node_spec.rb
+- spec/integration/resources/role_spec.rb
+- spec/spec_helper.rb
+- spec/support/chef_server.rb
+- spec/support/shared/chef_api_resource.rb
+- spec/unit/resources/base_spec.rb
+- spec/unit/resources/client_spec.rb
+homepage: https://github.com/sethvargo/chef-api
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A Chef API client in Ruby
+test_files:
+- spec/integration/resources/client_spec.rb
+- spec/integration/resources/environment_spec.rb
+- spec/integration/resources/node_spec.rb
+- spec/integration/resources/role_spec.rb
+- spec/spec_helper.rb
+- spec/support/chef_server.rb
+- spec/support/shared/chef_api_resource.rb
+- spec/unit/resources/base_spec.rb
+- spec/unit/resources/client_spec.rb
+has_rdoc: