small_wonder 0.1.6 → 0.1.7

data/README.md

@@ -23,11 +23,12 @@ Apache License Version 2.0
     chef_repo_path                      "/path/to/chef-repo" # the path to your chef-repo
     ssh_user                            "user" # the ssh user you want Small Wonder and Salticid to use
     application_deployment_attribute    "deployed_applications" # the attribute Small Wonder will save data back to chef using
-    config_template_working_directory   "/tmp/small_wonder" # the local directory temporary template work will be done in
-    remote_working_dir                  "/tmp/small_wonder_#{Time.now.to_i}" # the remote directory temporary template work will be done in
     application_deployments_dir         "/path/to/chef-repo/application_deployments" # path to your role files
     application_templates_dir           "/path/to/chef-repo/application_templates" # path to your template files
     databag                             "apps" # the databag that contains application configuration data items
+    default_metadata                     Hash["timestamp" => Time.now.to_i, "deploy_by" => ENV['USER']] # metadata saved to chef with each deploy
+    pre_deploy_hooks ["/path/to/a/hook/example.rb"]
+    post_deploy_hooks ["/path/to/a/hook/example.rb"]
 
 In addition to a Small Wonder config, you need a working Knife configuration file.
 

data/lib/small_wonder.rb

@@ -11,6 +11,7 @@ require 'chef'
 require 'highline/import'
 require 'erb'
 require 'net/scp'
+require 'tmpdir'
 
 __DIR__ = File.dirname(__FILE__)
 
@@ -77,16 +78,6 @@ module SmallWonder
 
     def main()
 
-      unless SmallWonder::Utils.sane_working_dir?(SmallWonder::Config.remote_working_dir)
-        SmallWonder::Log.error("Your remote working dir looks strange (#{SmallWonder::Config.remote_working_dir})")
-        exit(1)
-      end
-
-      unless SmallWonder::Utils.sane_working_dir?(SmallWonder::Config.config_template_working_directory)
-        SmallWonder::Log.error("Your local working dir looks strange (#{SmallWonder::Config.config_template_working_directory})")
-        exit(1)
-      end
-
       # inintialize chef/knife config
       Chef::Config[:node_name] = SmallWonder::Config.node_name
       Chef::Config[:client_key] = SmallWonder::Config.client_key

data/lib/small_wonder/application.rb

@@ -42,6 +42,11 @@ module SmallWonder
 
       # save the data back to the chef node
       update_application_data(node_name, application_name, "status", "initialized")
+
+      # save metadata back to chef
+      if opts[:metadata]
+        update_application_data(node_name, application_name, "data", opts[:metadata])
+      end
     end
 
     def version=(version)
@@ -56,16 +61,6 @@ module SmallWonder
 
     private
 
-    def get_existing_version(node, application)
-      version = get_chef_data_value(node, application, "version")
-
-      unless version
-        version = "0"
-      end
-
-      version
-    end
-
     def set_version(node, application, version)
       update_application_data(node, application, "version", version)
     end

data/lib/small_wonder/cli.rb

@@ -51,6 +51,24 @@ module SmallWonder
       :default => :info,
       :proc => Proc.new { |l| l.to_sym }
 
+    option :config_template_working_directory,
+      :short => "-D",
+      :long  => "--working-dir",
+      :description => "local config template working directory",
+      :default => Dir.mktmpdir
+
+    option :remote_working_dir,
+      :short => "-R",
+      :long  => "--remote-working-dir",
+      :description => "remote config template working directory",
+      :default => "/tmp/small_wonder_#{Time.now.to_i}"
+
+    option :dynamic_metadata,
+      :short => "-M JSON",
+      :long  => "--metadata JSON",
+      :description => "Metadata JSON",
+      :default => nil
+
     help = <<-EOH
 
       Examples:

data/lib/small_wonder/configuratorator.rb

@@ -2,6 +2,13 @@ module SmallWonder
   class Configuratorator
 
     def self.generate_and_upload_files(application, path, opts = {})
+      file_list = generate_files(application, path, opts)
+      upload_files(application)
+      apply_files(application, path, opts)
+      file_list
+    end
+
+    def self.generate_files(application, path, opts = {})
       config_template_dir = "#{SmallWonder::Config.application_templates_dir}/#{application.application_name}"
 
       templates = Dir["#{config_template_dir}/**/*.erb"]
@@ -9,11 +16,16 @@ module SmallWonder
       file_list = []
 
       templates.each do |file|
-        filename = File.basename(file, '.*')
-        filename.gsub!("VERSION", application.version)
+        begin
+          filename = File.basename(file, '.*')
+          filename.gsub!("VERSION", application.version)
 
-        reldir = File.dirname(file).gsub("#{config_template_dir}", ".")
-        reldir.gsub!("VERSION", application.version)
+          reldir = File.dirname(file).gsub("#{config_template_dir}", ".")
+          reldir.gsub!("VERSION", application.version)
+        rescue Exception => e
+          SmallWonder::Log.fatal("Something went badly attempting to replace VERSION with the version number, likely missing version data.\nerror: #{e}")
+          exit(1)
+        end
 
         file_list << "#{reldir}/#{filename}"
 
@@ -21,18 +33,32 @@ module SmallWonder
 
         generated_file = generate_file(file, application, config_template_dir, opts)
 
-        file_dir = "#{SmallWonder::Config.config_template_working_directory}/#{application.application_name}/#{reldir}"
+        file_dir = "#{SmallWonder::Config.config_template_working_directory}/#{application.node_name}/#{application.application_name}/#{reldir}"
 
         FileUtils.mkdir_p(file_dir)
 
         SmallWonder::Utils.write_file(generated_file, "#{file_dir}/#{filename}")
       end
 
-      upload_files(application.node_name, application.application_name)
+      file_list
+    end
+
+    def self.upload_files(application)
+      Net::SSH.start(application.node_name, SmallWonder::Config.ssh_user) do |ssh|
+        ssh.exec!("mkdir -p #{SmallWonder::Config.remote_working_dir}")
+      end
+
+      Net::SCP.start(application.node_name, SmallWonder::Config.ssh_user) do |scp|
+        scp.upload!("#{SmallWonder::Config.config_template_working_directory}/#{application.node_name}/#{application.application_name}", SmallWonder::Config.remote_working_dir, {:recursive => true})
+      end
+    end
+
+    def self.apply_files(application, path, opts = {})
       copy_files_to_install_dir(application.node_name, application.application_name, path)
-      cleanup_working_directories(application.node_name, application.application_name)
 
-      file_list
+      if opts[:no_cleanup]
+        cleanup_working_directories(application.node_name, application.application_name)
+      end
     end
 
     private
@@ -60,16 +86,6 @@ module SmallWonder
       template.result(binding)
     end
 
-    def self.upload_files(node_name, application)
-      Net::SSH.start(node_name, SmallWonder::Config.ssh_user) do |ssh|
-        ssh.exec!("mkdir -p #{SmallWonder::Config.remote_working_dir}")
-      end
-
-      Net::SCP.start(node_name, SmallWonder::Config.ssh_user) do |scp|
-        scp.upload!("#{SmallWonder::Config.config_template_working_directory}/#{application}", SmallWonder::Config.remote_working_dir, {:recursive => true})
-      end
-    end
-
     def self.copy_files_to_install_dir(node_name, application, path)
       Net::SSH.start(node_name, SmallWonder::Config.ssh_user) do |ssh|
         ssh.exec!("echo \"#{@sudo_password}\n\" | sudo -S cp -Rf #{SmallWonder::Config.remote_working_dir}/#{application}/* /#{path}/")
@@ -77,7 +93,7 @@ module SmallWonder
     end
 
     def self.cleanup_working_directories(node_name, application)
-      FileUtils.rm_rf("#{SmallWonder::Config.config_template_working_directory}/#{application}")
+      FileUtils.rm_rf("#{SmallWonder::Config.config_template_working_directory}/#{node_name}/#{application}")
 
       Net::SSH.start(node_name, SmallWonder::Config.ssh_user) do |ssh|
         ssh.exec!("rm -rf #{SmallWonder::Config.remote_working_dir}")

data/lib/small_wonder/deploy.rb

@@ -48,15 +48,25 @@ module SmallWonder
             SmallWonder::Log.info("Did not get a app version to deploy on the command line, assuming you will set it during the deploy.")
           end
 
+          metadata = build_metadata(SmallWonder::Config.default_metadata, SmallWonder::Config.dynamic_metadata)
+
+          execute_pre_deploy_hooks(action, application_name, metadata, nodes, SmallWonder::Config.version)
+
+          application_objects = []
+
           nodes.each do |node|
             if SmallWonder::Config.version
-              application = SmallWonder::Application.new(node, application_name, {:version => SmallWonder::Config.version})
+              application = SmallWonder::Application.new(node, application_name, {:version => SmallWonder::Config.version, :metadata => metadata})
             else
-              application = SmallWonder::Application.new(node, application_name)
+              application = SmallWonder::Application.new(node, application_name, {:metadata => metadata})
             end
 
             deploy_application(action, application, sudo_password)
+            application_objects << application
           end
+
+          execute_post_deploy_hooks(action, application_name, metadata, nodes, application_objects, SmallWonder::Config.version)
+
         end
       else
         SmallWonder::Log.info("No nodes found for your search.")
@@ -71,6 +81,80 @@ module SmallWonder
       end
     end
 
+    def self.build_metadata(default = nil, dynamic = nil)
+      metadata = Hash.new
+
+      if default
+        metadata.store("default", default)
+      end
+
+      if dynamic
+        metadata.store("dynamic", JSON.parse(dynamic))
+      end
+
+      metadata
+    end
+
+    def self.build_hook_data(action, application_name, metadata, nodes, application_objects = nil, version = nil)
+      if application_objects
+        objs = []
+
+        application_objects.each do |obj|
+          hash = {}
+
+          obj.instance_variables.each do |var|
+            hash.store(var.to_s.delete("@"), obj.instance_variable_get(var))
+          end
+
+          objs << hash
+        end
+      end
+
+      {
+        "action" => action,
+        "application_name" => application_name,
+        "metadata" => metadata,
+        "nodes" => nodes,
+        "version" => version,
+        "application" => objs
+      }
+    end
+
+    def self.execute_pre_deploy_hooks(action, application_name, metadata, nodes, version)
+      data = build_hook_data(action, application_name, metadata, nodes, version)
+      execute_hooks(:pre, data)
+    end
+
+    def self.execute_post_deploy_hooks(action, application_name, metadata, nodes, application_objects, version)
+      data = build_hook_data(action, application_name, metadata, nodes, application_objects, version)
+      execute_hooks(:post, data)
+    end
+
+    def self.execute_hooks(type, data)
+      data_json = data.to_json
+
+      case type
+      when :pre
+        hooks = SmallWonder::Config.pre_deploy_hooks
+      when :post
+        hooks = SmallWonder::Config.post_deploy_hooks
+      end
+
+      if hooks
+        hooks.each do |cmd|
+          begin
+            SmallWonder::Log.info("Running #{type} deploy hook, command: #{cmd}")
+            output = `#{cmd} \'#{data_json}\'`
+            SmallWonder::Log.debug("#{type} deploy hook output:")
+            SmallWonder::Log.debug(output)
+          rescue Exception => e
+            SmallWonder::Log.fatal("#{type} deploy hook failed, command: #{cmd}, data: #{data_json}")
+          end
+        end
+      end
+
+    end
+
     ## deploy step
     # Creates a new salticid host for node, and calls <app>.deploy on it.
     def self.run_salticid_task(action, application, sudo_password)

data/lib/small_wonder/utils.rb

@@ -36,27 +36,5 @@ module SmallWonder
       end
     end
 
-    def self.sane_working_dir?(dir)
-      sane = []
-      sane << starts_with?(dir, "/tmp/small_wonder")
-
-      if dir.include?("..")
-        sane << false
-      else
-        sane << true
-      end
-
-      if sane.include?(false)
-        false
-      else
-        true
-      end
-    end
-
-    def self.starts_with?(string, prefix)
-      prefix = prefix.to_s
-      string[0, prefix.length] == prefix
-    end
-
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: small_wonder
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - Joe Williams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-20 00:00:00 Z
+date: 2012-10-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mixlib-config