chef 0.7.10 → 0.7.12

data/lib/chef/resource.rb

@@ -1,5 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: Christopher Walters (<cw@opscode.com>)
 # Copyright:: Copyright (c) 2008 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -19,6 +20,7 @@
 require 'chef/mixin/params_validate'
 require 'chef/mixin/check_helper'
 require 'chef/mixin/language'
+require 'chef/mixin/convert_to_class_name'
 require 'chef/resource_collection'
 require 'chef/node'
 
@@ -28,8 +30,9 @@ class Chef
     include Chef::Mixin::CheckHelper
     include Chef::Mixin::ParamsValidate
     include Chef::Mixin::Language
+    include Chef::Mixin::ConvertToClassName
     
-    attr_accessor :actions, :params, :provider, :updated, :allowed_actions, :collection, :cookbook_name, :recipe_name
+    attr_accessor :actions, :params, :provider, :updated, :allowed_actions, :collection, :cookbook_name, :recipe_name, :enclosing_provider
     attr_reader :resource_name, :source_line, :node
     
     def initialize(name, collection=nil, node=nil)
@@ -58,6 +61,17 @@ class Chef
         @source_line = ::File.expand_path(@source_line) if @source_line
       end
     end
+
+    # If an unknown method is invoked, determine whether the enclosing Provider's
+    # lexical scope can fulfill the request. E.g. This happens when the Resource's
+    # block invokes new_resource.
+    def method_missing(method_symbol, *args, &block)
+      if enclosing_provider && enclosing_provider.respond_to?(method_symbol)
+        enclosing_provider.send(method_symbol, *args, &block)
+      else
+        raise NoMethodError, "undefined method `#{method_symbol.to_s}' for #{self.class.to_s}"
+      end
+    end
     
     def load_prior_resource
       begin
@@ -83,9 +97,14 @@ class Chef
     end
     
     def provider(arg=nil)
+      klass = if arg.kind_of?(String) || arg.kind_of?(Symbol)
+                lookup_provider_constant(arg)
+              else
+                arg
+              end
       set_or_return(
         :provider,
-        arg,
+        klass,
         :kind_of => [ Class ]
       )
     end
@@ -192,12 +211,12 @@ class Chef
       results.to_json(*a)
     end
     
-    def self.json_create(o)
-      resource = self.new(o["instance_vars"]["@name"])
-      o["instance_vars"].each do |k,v|
-        resource.instance_variable_set(k.to_sym, v)
+    def to_hash
+      instance_vars = Hash.new
+      self.instance_variables.each do |iv|
+        instance_vars[iv.sub(/^@/,'').to_sym] = self.instance_variable_get(iv) unless iv == "@collection"
       end
-      resource
+      instance_vars
     end
     
     def only_if(arg=nil, &blk)
@@ -224,7 +243,112 @@ class Chef
       provider.send("action_#{action}")
     end
     
+    class << self
+      
+      def json_create(o)
+        resource = self.new(o["instance_vars"]["@name"])
+        o["instance_vars"].each do |k,v|
+          resource.instance_variable_set(k.to_sym, v)
+        end
+        resource
+      end
+      
+      include Chef::Mixin::ConvertToClassName
+      
+      def attribute(attr_name, validation_opts={})
+        # This atrocity is the only way to support 1.8 and 1.9 at the same time
+        # When you're ready to drop 1.8 support, do this:
+        # define_method attr_name.to_sym do |arg=nil|
+        # etc.
+        shim_method=<<-SHIM
+        def #{attr_name}(arg=nil)
+          _set_or_return_#{attr_name}(arg)
+        end
+        SHIM
+        class_eval(shim_method)
+        
+        define_method("_set_or_return_#{attr_name.to_s}".to_sym) do |arg|
+          set_or_return(attr_name.to_sym, arg, validation_opts)
+        end
+      end
+      
+      def build_from_file(cookbook_name, filename)
+        rname = filename_to_qualified_string(cookbook_name, filename)
+          
+        new_resource_class = Class.new self do |cls|
+          
+          # default initialize method that ensures that when initialize is finally
+          # wrapped (see below), super is called in the event that the resource
+          # definer does not implement initialize
+          def initialize(name, collection=nil, node=nil)
+            super(name, collection, node)
+          end
+          
+          @actions_to_create = []
+          
+          class << cls
+            include Chef::Mixin::FromFile
+            
+            def actions_to_create
+              @actions_to_create
+            end
+            
+            define_method(:actions) do |*action_names|
+              actions_to_create.push(*action_names)
+            end
+          end
+          
+          # load resource definition from file
+          cls.class_from_file(filename)
+          
+          # create a new constructor that wraps the old one and adds the actions
+          # specified in the DSL
+          old_init = instance_method(:initialize)
+
+          define_method(:initialize) do |name, *optional_args|
+            collection = optional_args.shift
+            node = optional_args.shift
+            @resource_name = rname.to_sym
+            old_init.bind(self).call(name, collection, node)
+            allowed_actions.push(self.class.actions_to_create).flatten!
+          end
+        end
+        
+        # register new class as a Chef::Resource
+        class_name = convert_to_class_name(rname)
+        Chef::Resource.const_set(class_name, new_resource_class)
+        Chef::Log.debug("Loaded contents of #{filename} into a resource named #{rname} defined in Chef::Resource::#{class_name}")
+        
+        new_resource_class
+      end
+      
+      # Resources that want providers namespaced somewhere other than 
+      # Chef::Provider can set the namespace with +provider_base+
+      # Ex:
+      #   class MyResource < Chef::Resource
+      #     provider_base Chef::Provider::Deploy
+      #     # ...other stuff
+      #   end
+      def provider_base(arg=nil)
+        @provider_base ||= arg
+        @provider_base ||= Chef::Provider
+      end
+      
+    end
+    
     private
+    
+      def lookup_provider_constant(name)
+        begin
+          self.class.provider_base.const_get(convert_to_class_name(name.to_s))
+        rescue NameError => e
+          if e.to_s =~ /#{self.class.provider_base.to_s}/
+            raise ArgumentError, "No provider found to match '#{name}'"
+          else
+            raise e
+          end
+        end
+      end
       
       def check_timing(timing)
         unless timing == :delayed || timing == :immediate || timing == :immediately

data/lib/chef/resource/cron.rb

@@ -34,6 +34,10 @@ class Chef
         @weekday = "*"
         @command = nil
         @user = "root"
+        @mailto = nil
+        @path = nil
+        @shell = nil
+        @home = nil
       end
 
       def minute(arg=nil)
@@ -121,6 +125,38 @@ class Chef
         )
       end
 
+      def mailto(arg=nil)
+        set_or_return(
+          :mailto,
+          arg,
+          :kind_of => String
+        )
+      end
+
+      def path(arg=nil)
+        set_or_return(
+          :path,
+          arg,
+          :kind_of => String
+        )
+      end
+
+      def home(arg=nil)
+        set_or_return(
+          :home,
+          arg,
+          :kind_of => String
+        )
+      end
+
+      def shell(arg=nil)
+        set_or_return(
+          :shell,
+          arg,
+          :kind_of => String
+        )
+      end
+
       def command(arg=nil)
         set_or_return(
           :command,

data/lib/chef/resource/deploy.rb

@@ -0,0 +1,360 @@
+#
+# Author:: Daniel DeLeo (<dan@kallistec.com>)
+# Copyright:: Copyright (c) 2008 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.
+#
+
+# EX:
+# deploy "/my/deploy/dir" do
+#   repo "git@github.com/whoami/project"
+#   revision "abc123" # or "HEAD" or "TAG_for_1.0" or (subversion) "1234"
+#   user "deploy_ninja"
+#   enable_submodules true
+#   migrate true
+#   migration_command "rake db:migrate"
+#   environment "RAILS_ENV" => "production", "OTHER_ENV" => "foo"
+#   shallow_clone true
+#   action :deploy # or :rollback
+#   restart_command "touch tmp/restart.txt"
+#   git_ssh_wrapper "wrap-ssh4git.sh"
+#   scm_provider Chef::Provider::Git # is the default, for svn: Chef::Provider::Subversion
+#   svn_username "whoami"
+#   svn_password "supersecret"
+# end
+
+require "chef/resource/scm"
+
+class Chef
+  class Resource
+    
+    # Deploy: Deploy apps from a source control repository.
+    #
+    # Callbacks:
+    # Callbacks can be a block or a string. If given a block, the code
+    # is evaluated as an embedded recipe, and run at the specified
+    # point in the deploy process. If given a string, the string is taken as
+    # a path to a callback file/recipe. Paths are evaluated relative to the 
+    # release directory. Callback files can contain chef code (resources, etc.)
+    #
+    class Deploy < Chef::Resource
+      
+      provider_base Chef::Provider::Deploy
+      
+      def initialize(name, collection=nil, node=nil)
+        super(name, collection, node)
+        @resource_name = :deploy
+        @deploy_to = name
+        @environment = nil
+        @repository_cache = 'cached-copy'
+        @copy_exclude = []
+        @purge_before_symlink = %w{log tmp/pids public/system}
+        @create_dirs_before_symlink = %w{tmp public config}
+        @symlink_before_migrate = {"config/database.yml" => "config/database.yml"}
+        @symlinks = {"system" => "public/system", "pids" => "tmp/pids", "log" => "log"}
+        @revision = 'HEAD'
+        @action = :deploy
+        @migrate = false
+        @remote = "origin"
+        @enable_submodules = false
+        @shallow_clone = false
+        @force_deploy = false
+        @scm_provider = Chef::Provider::Git
+        @provider = Chef::Provider::Deploy::Timestamped
+        @allowed_actions.push(:deploy, :rollback)
+      end
+      
+      # where the checked out/cloned code goes
+      def destination
+        @destination ||= shared_path + "/#{@repository_cache}/"
+      end
+      
+      # where shared stuff goes, i.e., logs, tmp, etc. goes here
+      def shared_path
+        @shared_path ||= @deploy_to + "/shared"
+      end
+      
+      # where the deployed version of your code goes
+      def current_path
+        @current_path ||= @deploy_to + "/current"
+      end
+      
+      def depth
+        @shallow_clone ? "5" : nil
+      end
+      
+      # note: deploy_to is your application "meta-root."
+      def deploy_to(arg=nil)
+        set_or_return(
+          :deploy_to,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      
+      def repo(arg=nil)
+        set_or_return(
+          :repo,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      alias :repository :repo
+      
+      def remote(arg=nil)
+        set_or_return(
+          :remote,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      
+      def role(arg=nil)
+        set_or_return(
+          :role,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      
+      def restart_command(arg=nil, &block)
+        arg ||= block
+        set_or_return(
+          :restart_command,
+          arg,
+          :kind_of => [ String, Proc ]
+        )
+      end
+      alias :restart :restart_command
+      
+      def migrate(arg=nil)
+        set_or_return(
+          :migrate,
+          arg,
+          :kind_of => [ TrueClass, FalseClass ]
+        )
+      end
+      
+      def migration_command(arg=nil)
+        set_or_return(
+          :migration_command,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      
+      def user(arg=nil)
+        set_or_return(
+          :user,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      
+      def group(arg=nil)
+        set_or_return(
+          :group,
+          arg,
+          :kind_of => [ String ]
+        )
+      end      
+      
+      def enable_submodules(arg=nil)
+        set_or_return(
+          :enable_submodules,
+          arg,
+          :kind_of => [ TrueClass, FalseClass ]
+        )
+      end
+      
+      def shallow_clone(arg=nil)
+        set_or_return(
+          :shallow_clone,
+          arg,
+          :kind_of => [ TrueClass, FalseClass ]
+        )
+      end
+
+      def repository_cache(arg=nil)
+        set_or_return(
+          :repository_cache,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      
+      def copy_exclude(arg=nil)
+        set_or_return(
+          :copy_exclude,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      
+      def revision(arg=nil)
+        set_or_return(
+          :revision,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      alias :branch :revision
+            
+      def git_ssh_wrapper(arg=nil)
+        set_or_return(
+          :git_ssh_wrapper,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      alias :ssh_wrapper :git_ssh_wrapper
+      
+      def svn_username(arg=nil)
+        set_or_return(
+          :svn_username,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+ 
+      def svn_password(arg=nil)
+        set_or_return(
+          :svn_password,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      
+      def svn_arguments(arg=nil)
+        set_or_return(
+          :svn_arguments,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+      
+      # Shall we run the deploy even if the code has not changed?
+      def force_deploy(arg=nil)
+        set_or_return(
+          :force_deploy,
+          arg,
+          :kind_of => [ TrueClass, FalseClass ]
+        )
+      end
+      
+      def scm_provider(arg=nil)
+        set_or_return(
+          :scm_provider,
+          arg,
+          :kind_of => [ Class ]
+        )
+      end
+      
+      def environment(arg=nil)
+        if arg.is_a?(String)
+          Chef::Log.info "Setting RAILS_ENV, RACK_ENV, and MERB_ENV to `#{arg}'"
+          Chef::Log.warn "[DEPRECATED] please modify your deploy recipe or attributes to set the environment using a hash"
+          arg = {"RAILS_ENV"=>arg,"MERB_ENV"=>arg,"RACK_ENV"=>arg}
+        end
+        set_or_return(
+          :environment,
+          arg,
+          :kind_of => [ Hash ]
+        )
+      end
+      
+      # An array of paths, relative to your app's root, to be purged from a 
+      # SCM clone/checkout before symlinking. Use this to get rid of files and
+      # directories you want to be shared between releases.
+      # Default: ["log", "tmp/pids", "public/system"]
+      def purge_before_symlink(arg=nil)
+        set_or_return(
+          :purge_before_symlink,
+          arg,
+          :kind_of => Array
+        )
+      end
+      
+      # An array of paths, relative to your app's root, where you expect dirs to
+      # exist before symlinking. This runs after #purge_before_symlink, so you
+      # can use this to recreate dirs that you had previously purged.
+      # For example, if you plan to use a shared directory for pids, and you 
+      # want it to be located in $APP_ROOT/tmp/pids, you could purge tmp, 
+      # then specify tmp here so that the tmp directory will exist when you
+      # symlink the pids directory in to the current release.
+      # Default: ["tmp", "public", "config"]
+      def create_dirs_before_symlink(arg=nil)
+        set_or_return(
+          :create_dirs_before_symlink,
+          arg,
+          :kind_of => Array
+        )
+      end
+      
+      # A Hash of shared/dir/path => release/dir/path. This attribute determines
+      # which files and dirs in the shared directory get symlinked to the current
+      # release directory, and where they go. If you have a directory 
+      # $shared/pids that you would like to symlink as $current_release/tmp/pids
+      # you specify it as "pids" => "tmp/pids"
+      # Default {"system" => "public/system", "pids" => "tmp/pids", "log" => "log"}
+      def symlinks(arg=nil)
+        set_or_return(
+          :symlinks,
+          arg,
+          :kind_of => Hash
+        )
+      end
+      
+      # A Hash of shared/dir/path => release/dir/path. This attribute determines 
+      # which files in the shared directory get symlinked to the current release
+      # directory and where they go. Unlike map_shared_files, these are symlinked
+      # *before* any migration is run.
+      # For a rails/merb app, this is used to link in a known good database.yml
+      # (with the production db password) before running migrate.
+      # Default {"config/database.yml" => "config/database.yml"}
+      def symlink_before_migrate(arg=nil)
+        set_or_return(
+          :symlink_before_migrate,
+          arg,
+          :kind_of => Hash
+        )
+      end
+      
+      # Callback fires before migration is run.
+      def before_migrate(arg=nil, &block)
+        arg ||= block
+        set_or_return(:before_migrate, arg, :kind_of => [Proc, String])
+      end
+      
+      # Callback fires before symlinking
+      def before_symlink(arg=nil, &block)
+        arg ||= block
+        set_or_return(:before_symlink, arg, :kind_of => [Proc, String])
+      end
+      
+      # Callback fires before restart
+      def before_restart(arg=nil, &block)
+        arg ||= block
+        set_or_return(:before_restart, arg, :kind_of => [Proc, String])
+      end
+      
+      # Callback fires after restart
+      def after_restart(arg=nil, &block)
+        arg ||= block
+        set_or_return(:after_restart, arg, :kind_of => [Proc, String])
+      end
+      
+    end
+  end
+end