ridley 0.7.0.rc4 → 0.7.0

data/lib/ridley/chef/cookbook/syntax_check.rb

@@ -0,0 +1,162 @@
+module Ridley::Chef
+  class Cookbook
+    # @author Jamie Winsor <jamie@vialstudios.com>
+    #
+    # Encapsulates the process of validating the ruby syntax of files in Chef
+    # cookbooks.
+    #
+    # Borrowed and modified from: {https://github.com/opscode/chef/blob/11.4.0/lib/chef/cookbook/syntax_check.rb}
+    #
+    # Copyright:: Copyright (c) 2010 Opscode, Inc.
+    #
+    # 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.
+    class SyntaxCheck
+      # Implements set behavior with disk-based persistence. Objects in the set
+      # are expected to be strings containing only characters that are valid in
+      # filenames.
+      #
+      # This class is used to track which files have been syntax checked so
+      # that known good files are not rechecked.
+      class PersistentSet
+        attr_reader :cache_path
+
+        # Create a new PersistentSet. Values in the set are persisted by
+        # creating a file in the +cache_path+ directory. If not given, the
+        # value of Chef::Config[:syntax_check_cache_path] is used; if that
+        # value is not configured, the value of
+        # Chef::Config[:cache_options][:path] is used.
+        #--
+        # history: prior to Chef 11, the cache implementation was based on
+        # moneta and configured via cache_options[:path]. Knife configs
+        # generated with Chef 11 will have `syntax_check_cache_path`, but older
+        # configs will have `cache_options[:path]`. `cache_options` is marked
+        # deprecated in chef/config.rb but doesn't currently trigger a warning.
+        # See also: CHEF-3715
+        def initialize(cache_path = nil)
+          @cache_path = cache_path || Dir.mktmpdir
+          @cache_path_created = false
+        end
+
+        # Adds +value+ to the set's collection.
+        def add(value)
+          ensure_cache_path_created
+          FileUtils.touch(File.join(cache_path, value))
+        end
+
+        # Returns true if the set includes +value+
+        def include?(value)
+          File.exist?(File.join(cache_path, value))
+        end
+
+        private
+
+          def ensure_cache_path_created
+            return true if @cache_path_created
+            FileUtils.mkdir_p(cache_path)
+            @cache_path_created = true
+          end
+      end
+
+      include Ridley::Logging
+      include Ridley::Mixin::ShellOut
+      include Ridley::Mixin::Checksum
+
+      attr_reader :cookbook_path
+
+      # A PersistentSet object that tracks which files have already been
+      # validated.
+      attr_reader :validated_files
+
+      # Create a new SyntaxCheck object
+      #
+      # @param [String] cookbook_path
+      #   the (on disk) path to the cookbook
+      def initialize(cookbook_path)
+        @cookbook_path   = cookbook_path
+        @validated_files = PersistentSet.new
+      end
+
+      def ruby_files
+        Dir[File.join(cookbook_path, '**', '*.rb')]
+      end
+
+      def untested_ruby_files
+        ruby_files.reject do |file|
+          if validated?(file)
+            true
+          else
+            false
+          end
+        end
+      end
+
+      def template_files
+        Dir[File.join(cookbook_path, '**', '*.erb')]
+      end
+
+      def untested_template_files
+        template_files.reject do |file| 
+          if validated?(file)
+            true
+          else
+            false
+          end
+        end
+      end
+
+      def validated?(file)
+        validated_files.include?(checksum(file))
+      end
+
+      def validated(file)
+        validated_files.add(checksum(file))
+      end
+
+      def validate_ruby_files
+        untested_ruby_files.each do |ruby_file|
+          return false unless validate_ruby_file(ruby_file)
+          validated(ruby_file)
+        end
+      end
+
+      def validate_templates
+        untested_template_files.each do |template|
+          return false unless validate_template(template)
+          validated(template)
+        end
+      end
+
+      def validate_template(erb_file)
+        result = shell_out("erubis -x #{erb_file} | ruby -c")
+        result.error!
+        true
+      rescue Mixlib::ShellOut::ShellCommandFailed
+        file_relative_path = erb_file[/^#{Regexp.escape(cookbook_path+File::Separator)}(.*)/, 1]
+        log.error { "Erb template #{file_relative_path} has a syntax error:" }
+        result.stderr.each_line { |l| Ridley.log..fatal(l.chomp) }
+        false
+      end
+
+      def validate_ruby_file(ruby_file)
+        result = shell_out("ruby -c #{ruby_file}")
+        result.error!
+        true
+      rescue Mixlib::ShellOut::ShellCommandFailed
+        file_relative_path = ruby_file[/^#{Regexp.escape(cookbook_path+File::Separator)}(.*)/, 1]
+        log.error { "Cookbook file #{file_relative_path} has a ruby syntax error:" }
+        result.stderr.each_line { |l| Ridley.log.error(l.chomp) }
+        false
+      end
+    end
+  end
+end

data/lib/ridley/chef/digester.rb

@@ -0,0 +1,55 @@
+require 'digest'
+
+module Ridley::Chef
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  #
+  # Borrowed and modified from: {https://github.com/opscode/chef/blob/11.4.0/lib/chef/digester.rb}
+  class Digester
+    class << self
+      def instance
+        @instance ||= new
+      end
+
+      def checksum_for_file(*args)
+        instance.checksum_for_file(*args)
+      end
+
+      def md5_checksum_for_file(*args)
+        instance.generate_md5_checksum_for_file(*args)
+      end
+    end
+
+    def validate_checksum(*args)
+      self.class.validate_checksum(*args)
+    end
+
+    def checksum_for_file(file)
+      generate_checksum(file)
+    end
+
+    def generate_checksum(file)
+      checksum_file(file, Digest::SHA256.new)
+    end
+
+    def generate_md5_checksum_for_file(file)
+      checksum_file(file, Digest::MD5.new)
+    end
+
+    def generate_md5_checksum(io)
+      checksum_io(io, Digest::MD5.new)
+    end
+
+    private
+
+      def checksum_file(file, digest)
+        File.open(file, 'rb') { |f| checksum_io(f, digest) }
+      end
+
+      def checksum_io(io, digest)
+        while chunk = io.read(1024 * 8)
+          digest.update(chunk)
+        end
+        digest.hexdigest
+      end
+  end
+end

data/lib/ridley/errors.rb

@@ -33,6 +33,8 @@ module Ridley
       end
     end
 
+    class CookbookSyntaxError < RidleyError; end
+
     class BootstrapError < RidleyError; end
     class ClientKeyFileNotFound < BootstrapError; end
     class EncryptedDataBagSecretNotFound < BootstrapError; end

data/lib/ridley/mixin.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/mixin/*.rb"].sort.each do |path|
+  require "ridley/mixin/#{File.basename(path, '.rb')}"
+end

data/lib/ridley/mixin/checksum.rb

@@ -0,0 +1,14 @@
+module Ridley::Mixin
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  #
+  # Inspired by and dependency-free replacement for
+  # {https://github.com/opscode/chef/blob/11.4.0/lib/chef/mixin/checksum.rb}
+  module Checksum
+    # @param [String] file
+    #
+    # @return [String]
+    def checksum(file)
+      Ridley::Chef::Digester.checksum_for_file(file)
+    end
+  end
+end

data/lib/ridley/mixin/shell_out.rb

@@ -0,0 +1,23 @@
+require 'mixlib/shellout'
+
+module Ridley::Mixin
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  module ShellOut
+    # @return [Mixlib::ShellOut]
+    def shell_out(*command_args)
+      cmd = Mixlib::ShellOut.new(*command_args)
+      if STDOUT.tty?
+        cmd.live_stream = STDOUT
+      end
+      cmd.run_command
+      cmd
+    end
+
+    # @return [Mixlib::ShellOut]
+    def shell_out!(*command_args)
+      cmd = shell_out(*command_args)
+      cmd.error!
+      cmd
+    end
+  end
+end

data/lib/ridley/resources/cookbook_resource.rb

@@ -150,16 +150,19 @@ module Ridley
       #   a JSON blob containing file names, file paths, and checksums for each
       #   that describe the cookbook version being uploaded.
       #
-      # @option options [Boolean] :freeze
       # @option options [Boolean] :force
+      #   Upload the Cookbook even if the version already exists and is frozen on
+      #   the target Chef Server
+      # @option options [Boolean] :freeze
+      #   Freeze the uploaded Cookbook on the Chef Server so that it cannot be
+      #   overwritten
       #
       # @return [Hash]
       def save(client, name, version, manifest, options = {})
-        freeze = options.fetch(:freeze, false)
-        force  = options.fetch(:force, false)
+        options.reverse_merge(force: false, freeze: false)
 
         url = "cookbooks/#{name}/#{version}"
-        url << "?force=true" if force
+        url << "?force=true" if options[:force]
 
         client.connection.put(url, manifest)
       end
@@ -168,6 +171,43 @@ module Ridley
         raise NotImplementedError
       end
 
+      # Uploads a cookbook to the remote Chef server from the contents of a filepath
+      #
+      # @param [Ridley::Client] client
+      # @param [String] path
+      #   path to a cookbook on local disk
+      #
+      # @option options [String] :name
+      #   automatically populated by the metadata of the cookbook at the given path, but
+      #   in the event that the metadata does not contain a name it can be specified with
+      #   this option
+      # @option options [Boolean] :force (false)
+      #   Upload the Cookbook even if the version already exists and is frozen on
+      #   the target Chef Server
+      # @option options [Boolean] :freeze (false)
+      #   Freeze the uploaded Cookbook on the Chef Server so that it cannot be
+      #   overwritten
+      # @option options [Boolean] :validate (true)
+      #   Validate the contents of the cookbook before uploading
+      #
+      # @return [Hash]
+      def upload(client, path, options = {})
+        options   = options.reverse_merge(validate: true, force: false, freeze: false)
+        cookbook  = Ridley::Chef::Cookbook.from_path(path, options.slice(:name))
+
+        if options[:validate]
+          cookbook.validate
+        end
+
+        name      = options[:name] || cookbook.name
+        checksums = cookbook.checksums.dup
+        sandbox   = client.sandbox.create(checksums.keys)
+
+        sandbox.upload(checksums)
+        sandbox.commit
+        save(client, name, cookbook.version, cookbook.to_json, options.slice(:force, :freeze))
+      end
+
       # Return a list of versions for the given cookbook present on the remote Chef server
       #
       # @param [Ridley::Client] client

data/lib/ridley/version.rb

@@ -1,3 +1,3 @@
 module Ridley
-  VERSION = "0.7.0.rc4"
+  VERSION = "0.7.0"
 end

data/ridley.gemspec

@@ -19,8 +19,10 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'json', '>= 1.5.0'
   s.add_runtime_dependency 'multi_json', '>= 1.0.4'
-  s.add_runtime_dependency 'chozo', '>= 0.5.0'
+  s.add_runtime_dependency 'chozo', '>= 0.6.0'
   s.add_runtime_dependency 'mixlib-log', '>= 1.3.0'
+  s.add_runtime_dependency 'mixlib-shellout', '>= 1.1.0'
+  s.add_runtime_dependency 'mixlib-config', '>= 1.1.0'
   s.add_runtime_dependency 'mixlib-authentication', '>= 1.3.0'
   s.add_runtime_dependency 'addressable'
   s.add_runtime_dependency 'faraday', '>= 0.8.4'

data/spec/fixtures/example_cookbook/README.md

@@ -0,0 +1,11 @@
+Description
+===========
+
+Requirements
+============
+
+Attributes
+==========
+
+Usage
+=====

data/spec/fixtures/example_cookbook/attributes/default.rb

@@ -0,0 +1,6 @@
+# Attribute:: default
+#
+# Copyright 2012, YOUR_COMPANY_NAME
+#
+# All rights reserved - Do Not Redistribute
+#

data/spec/fixtures/example_cookbook/definitions/bad_def.rb

@@ -0,0 +1,6 @@
+# Definition: bad_def
+#
+# Copyright 2012, YOUR_COMPANY_NAME
+#
+# All rights reserved - Do Not Redistribute
+#

data/spec/fixtures/example_cookbook/files/default/file.h

@@ -0,0 +1,2 @@
+# file.h
+hello

data/spec/fixtures/example_cookbook/files/ubuntu/file.h

@@ -0,0 +1,2 @@
+# file.h
+hello, ubuntu

data/spec/fixtures/example_cookbook/libraries/my_lib.rb

@@ -0,0 +1,6 @@
+# Library: my_lib
+#
+# Copyright 2012, YOUR_COMPANY_NAME
+#
+# All rights reserved - Do Not Redistribute
+#

data/spec/fixtures/example_cookbook/metadata.rb

@@ -0,0 +1,7 @@
+name             "example_cookbook"
+maintainer       "Jamie Winsor"
+maintainer_email "jamie@vialstudios.com"
+license          "Apache 2.0"
+description      "Installs/Configures example_cookbook"
+long_description IO.read(File.join(File.dirname(__FILE__), "README.md"))
+version          "0.1.0"

data/spec/fixtures/example_cookbook/providers/defprovider.rb

@@ -0,0 +1,6 @@
+# Provider: defprovider
+#
+# Copyright 2012, YOUR_COMPANY_NAME
+#
+# All rights reserved - Do Not Redistribute
+#

data/spec/fixtures/example_cookbook/recipes/default.rb

@@ -0,0 +1,6 @@
+# Recipe: default
+#
+# Copyright 2012, YOUR_COMPANY_NAME
+#
+# All rights reserved - Do Not Redistribute
+#

data/spec/fixtures/example_cookbook/resources/defresource.rb

@@ -0,0 +1,6 @@
+# Resource: defresource
+#
+# Copyright 2012, YOUR_COMPANY_NAME
+#
+# All rights reserved - Do Not Redistribute
+#

data/spec/fixtures/example_cookbook/templates/default/temp.txt.erb

@@ -0,0 +1 @@
+<%= 'hello' %>