spiceweasel 2.6.0 → 2.8.0

data/lib/spiceweasel/environments.rb

@@ -1,7 +1,8 @@
+# encoding: UTF-8
 #
-# Author:: Matt Ray (<matt@opscode.com>)
+# Author:: Matt Ray (<matt@getchef.com>)
 #
-# Copyright:: 2011-2013, Opscode, Inc <legal@opscode.com>
+# Copyright:: 2011-2014, Chef Software, Inc <legal@getchef.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,90 +17,111 @@
 # limitations under the License.
 #
 
-require 'yajl/json_gem'
+require 'ffi_yajl'
+require 'spiceweasel/command_helper'
 
 module Spiceweasel
+  # manages parsing of Environments
   class Environments
-
     include CommandHelper
 
     attr_reader :environment_list, :create, :delete
 
-    def initialize(environments = [], cookbooks = {})
-      @create = Array.new
-      @delete = Array.new
-      @environment_list = Array.new
-      if environments
-        Spiceweasel::Log.debug("environments: #{environments}")
-        flatenvs = environments.collect {|x| x.keys}.flatten
-        envfiles = []
-        flatenvs.each do |env|
-          Spiceweasel::Log.debug("environment: #{env}")
-          if File.directory?("environments")
-            #expand wildcards and push into environments
-            if env =~ /\*/ #wildcard support
-              wildenvs = Dir.glob("environments/#{env}")
-              #remove anything not ending in .json or .rb
-              wildenvs.delete_if {|x| !x.end_with?(".rb", ".json")}
-              Spiceweasel::Log.debug("found environments '#{wildenvs}' for wildcard: #{env}")
-              flatenvs.concat(wildenvs.collect {|x| x[x.rindex('/')+1..x.rindex('.')-1]})
-              next
-            end
-            validate(env, cookbooks) unless Spiceweasel::Config[:novalidation]
-          elsif !Spiceweasel::Config[:novalidation]
-            STDERR.puts "'environments' directory not found, unable to validate or load environments"
-            exit(-1)
-          end
-          if File.exists?("environments/#{env}.json")
-            envfiles.push("#{env}.json")
-          else #assume no .json means they want .rb and catchall for misssing dir
-            envfiles.push("#{env}.rb")
+    def initialize(environments = [], cookbooks = {}) # rubocop:disable CyclomaticComplexity
+      @create = []
+      @delete = []
+      @environment_list = []
+
+      return unless environments
+
+      Spiceweasel::Log.debug("environments: #{environments}")
+      envfiles = do_flattened_environments(cookbooks, environments)
+      create_command("knife environment#{Spiceweasel::Config[:knife_options]} from file #{envfiles.uniq.sort.join(' ')}")
+    end
+
+    def do_flattened_environments(cookbooks, environments)
+      flatenvs = environments.map(&:keys).flatten
+      envfiles = []
+      flatenvs.each do |env|
+        Spiceweasel::Log.debug("environment: #{env}")
+        if File.directory?('environments')
+          # expand wildcards and push into environments
+          if env =~ /\*/ # wildcard support
+            wildenvs = Dir.glob("environments/#{env}")
+            # remove anything not ending in .json or .rb
+            wildenvs.delete_if { |x| !x.end_with?('.rb', '.json') }
+            Spiceweasel::Log.debug("found environments '#{wildenvs}' for wildcard: #{env}")
+            flatenvs.concat(wildenvs.map { |x| x[x.rindex('/') + 1..x.rindex('.') - 1] })
+            next
           end
-          delete_command("knife environment#{Spiceweasel::Config[:knife_options]} delete #{env} -y")
-          @environment_list.push(env)
+          validate(env, cookbooks) unless Spiceweasel::Config[:novalidation]
+        elsif !Spiceweasel::Config[:novalidation]
+          STDERR.puts "'environments' directory not found, unable to validate or load environments"
+          exit(-1)
+        end
+        if File.exist?("environments/#{env}.json")
+          envfiles.push("#{env}.json")
+        else # assume no .json means they want .rb and catchall for misssing dir
+          envfiles.push("#{env}.rb")
         end
-        create_command("knife environment#{Spiceweasel::Config[:knife_options]} from file #{envfiles.uniq.sort.join(' ')}")
+        delete_command("knife environment#{Spiceweasel::Config[:knife_options]} delete #{env} -y")
+        @environment_list.push(env)
       end
+      envfiles
     end
 
-    #validate the content of the environment file
-    def validate(environment, cookbooks)
-      file = %W(environments/#{environment}.rb environments/#{environment}.json).detect{|f| File.exists?(f)}
-      if environment =~ /\// #pull out directories
-        environment = environment.split('/').last
-      end
+    # validate the content of the environment file
+    def validate(environment, cookbooks) # rubocop:disable CyclomaticComplexity
+      env = nil
+      file = %W(environments/#{environment}.rb environments/#{environment}.json).find { |f| File.exist?(f) }
+      environment = environment.split('/').last if environment =~ /\// # pull out directories
       if file
         case file
         when /\.json$/
           env = Chef::JSONCompat.from_json(IO.read(file))
         when /\.rb$/
-          if (Chef::VERSION.split('.')[0].to_i < 11)
-            env = Chef::Environment.new(false)
-          else
-            env = Chef::Environment.new
-          end
-          env.from_file(file)
+          env = do_ruby_environment_file(file)
         end
-        if(env.name != environment)
+        if env.name != environment
           STDERR.puts "ERROR: Environment '#{environment}' listed in the manifest does not match the name '#{env.name}' within the #{file} file."
           exit(-1)
         end
         env.cookbook_versions.keys.each do |dep|
-          Spiceweasel::Log.debug("environment: '#{environment}' cookbook: '#{dep}'")
-          unless cookbooks.member?(dep)
-            STDERR.puts "ERROR: Cookbook dependency '#{dep}' from environment '#{environment}' is missing from the list of cookbooks in the manifest."
-            exit(-1)
-          end
+          do_cookbook_version(cookbooks, dep, environment)
         end
-      else #environment is not here
+      else # environment is not here
         STDERR.puts "ERROR: Invalid Environment '#{environment}' listed in the manifest but not found in the environments directory."
         exit(-1)
       end
     end
 
+    def do_cookbook_version(cookbooks, dep, environment)
+      Spiceweasel::Log.debug("environment: '#{environment}' cookbook: '#{dep}'")
+
+      return if cookbooks.member?(dep)
+
+      STDERR.puts "ERROR: Cookbook dependency '#{dep}' from environment '#{environment}' is missing from the list of cookbooks in the manifest."
+      exit(-1)
+    end
+
+    def do_ruby_environment_file(file)
+      if Chef::VERSION.split('.')[0].to_i < 11
+        env = Chef::Environment.new(false)
+      else
+        env = Chef::Environment.new
+      end
+      begin
+        env.from_file(file)
+      rescue SyntaxError => e
+        STDERR.puts "ERROR: Environment '#{file}' has syntax errors."
+        STDERR.puts e.message
+        exit(-1)
+      end
+      env
+    end
+
     def member?(environment)
       environment_list.include?(environment)
     end
-
   end
 end

data/lib/spiceweasel/execute.rb

@@ -1,7 +1,8 @@
+# encoding: UTF-8
 #
-# Author:: Matt Ray (<matt@opscode.com>)
+# Author:: Matt Ray (<matt@getchef.com>)
 #
-# Copyright:: 2012-2013, Opscode, Inc <legal@opscode.com>
+# Copyright:: 2012-2014, Chef Software, Inc <legal@getchef.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -19,24 +20,22 @@
 require 'mixlib/shellout'
 
 module Spiceweasel
+  # executes the knife commands from parsing manifests
   class Execute
-
     # run the commands passed in
     def initialize(commands)
       # for now we're shelling out
       commands.each do | cmd |
         Spiceweasel::Log.debug("Command will timeout after #{Spiceweasel::Config[:cmd_timeout]} seconds.")
-        knife = Mixlib::ShellOut.new(cmd.command, cmd.shellout_opts.merge(:live_stream => STDOUT, :timeout => Spiceweasel::Config[:timeout].to_i))
+        knife = Mixlib::ShellOut.new(cmd.command, cmd.shellout_opts.merge(live_stream: STDOUT, timeout: Spiceweasel::Config[:timeout].to_i))
         # check for parallel? and eventually use threads
         knife.run_command
         puts knife.stderr
         Spiceweasel::Log.debug(cmd)
         Spiceweasel::Log.debug(knife.stdout)
-        Spiceweasel::Log.fatal(knife.stderr) if !knife.stderr.empty?
+        Spiceweasel::Log.fatal(knife.stderr) unless knife.stderr.empty?
         find.error! unless cmd.allow_failure?
       end
     end
-
   end
 end
-

data/lib/spiceweasel/extract_local.rb

@@ -1,8 +1,9 @@
+# encoding: UTF-8
 #
 # Author:: Geoff Meakin
-# Author:: Matt Ray (<matt@opscode.com>)
+# Author:: Matt Ray (<matt@getchef.com>)
 #
-# Copyright:: 2012-2013, Opscode, Inc <legal@opscode.com>
+# Copyright:: 2012-2014, Chef Software, Inc <legal@getchef.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,53 +21,33 @@
 require 'chef'
 
 module Spiceweasel
+  # models the existing Chef repository as a manifest
   class ExtractLocal
-
-    def self.parse_objects
+    def self.parse_objects # rubocop:disable CyclomaticComplexity
       objects = {}
 
       # BERKSHELF
-      if File.file?('./Berksfile')
-        objects['berksfile'] = nil
-        berksfile = Berksfile.new(objects['berksfile'])
-      end
+      berksfile = parse_berkshelf(objects)
 
       # COOKBOOKS
-      cookbooks = berksfile ? self.resolve_cookbooks(berksfile.cookbook_list) : self.resolve_cookbooks
-
-      objects['cookbooks'] = cookbooks unless cookbooks.empty?
+      cookbooks = berksfile ? resolve_cookbooks(berksfile.cookbook_list) : resolve_cookbooks
+      objects['cookbooks'] = cookbooks.sort_by { |c| [c.keys[0]] } unless cookbooks.empty?
 
       # ROLES
-      roles = []
-      Dir.glob("roles/*.{rb,json}").each do |role_full_path|
-        role = self.grab_name_from_path(role_full_path)
-        Spiceweasel::Log.debug("dir_ext: role: '#{role}'")
-        roles << {role => nil}
-      end
-      objects['roles'] = roles unless roles.nil?
+      parse_roles(objects)
 
       # ENVIRONMENTS
       environments = []
-      Dir.glob("environments/*.{rb,json}").each do |environment_full_path|
-        environment = self.grab_name_from_path(environment_full_path)
+      Dir.glob('environments/*.{rb,json}').each do |environment_full_path|
+        environment = grab_name_from_path(environment_full_path)
         Spiceweasel::Log.debug("dir_ext: environment: '#{environment}'")
-        environments << {environment => nil}
+        environments << { environment => nil }
       end
-      objects['environments'] = environments unless environments.empty?
+      objects['environments'] = environments.sort_by { |e| [e.keys[0]] } unless environments.empty?
 
       # DATA BAGS
-      data_bags = []
-      Dir.glob('data_bags/*').each do |data_bag_full_path|
-        data_bag = data_bag_full_path.split('/').last
-        Spiceweasel::Log.debug("dir_ext: data_bag: '#{data_bag}'")
-        data_bag_items = []
-        Dir.glob("#{data_bag_full_path}/*.{rb,json}").each do |data_bag_item_full_path|
-          Spiceweasel::Log.debug("dir_ext: data_bag: '#{data_bag}':'#{data_bag_item_full_path}'")
-          data_bag_items << self.grab_name_from_path(data_bag_item_full_path)
-        end if File.directory?(data_bag_full_path)
-        data_bags << {data_bag => {'items' => data_bag_items}}
-      end
-      objects['data bags'] = data_bags unless data_bags.empty?
+      data_bags = parse_data_bags
+      objects['data bags'] = data_bags.sort_by { |d| [d.keys[0]] } unless data_bags.empty?
 
       # NODES
       # TODO: Cant use this yet as node_list.rb doesnt support node from file syntax but expects the node info to be part of the objects passed in
@@ -79,11 +60,43 @@ module Spiceweasel
       objects
     end
 
+    def self.parse_data_bags
+      data_bags = []
+      Dir.glob('data_bags/*').each do |data_bag_full_path|
+        next unless File.directory?(data_bag_full_path)
+        data_bag = data_bag_full_path.split('/').last
+        Spiceweasel::Log.debug("dir_ext: data_bag: '#{data_bag}'")
+        data_bag_items = []
+        Dir.glob("#{data_bag_full_path}/*.{rb,json}").each do |data_bag_item_full_path|
+          Spiceweasel::Log.debug("dir_ext: data_bag: '#{data_bag}':'#{data_bag_item_full_path}'")
+          data_bag_items << grab_name_from_path(data_bag_item_full_path)
+        end if File.directory?(data_bag_full_path)
+        data_bags << { data_bag => { 'items' => data_bag_items.sort } }
+      end
+      data_bags
+    end
+
+    def self.parse_roles(objects)
+      roles = []
+      Dir.glob('roles/*.{rb,json}').each do |role_full_path|
+        role = grab_name_from_path(role_full_path)
+        Spiceweasel::Log.debug("dir_ext: role: '#{role}'")
+        roles << { role => nil }
+      end
+      objects['roles'] = roles.sort_by { |r| [r.keys[0]] } unless roles.nil? || roles.empty?
+    end
+
+    def self.parse_berkshelf(objects)
+      if File.file?('./Berksfile')
+        objects['berksfile'] = nil
+        berksfile = Berksfile.new(objects['berksfile'])
+      end
+      berksfile
+    end
+
     def self.grab_name_from_path(path)
       name = path.split('/').last.split('.')
-      if name.length > 1
-        name.pop
-      end
+      name.pop if name.length > 1
       name.join('.')
     end
 
@@ -94,29 +107,29 @@ module Spiceweasel
       books = loader.cookbooks_by_name
       graph = Solve::Graph.new
       cblist = []
-      #push in the berkshelf cookbooks to cover any other deps
+      # push in the berkshelf cookbooks to cover any other deps
       berkshelf_cookbooks.each do |name, version|
         Spiceweasel::Log.debug("dir_ext:berks: #{name} #{version}")
-        graph.artifacts(name, version)
+        graph.artifact(name, version)
       end
       books.each do |name, cb|
         Spiceweasel::Log.debug("dir_ext: #{name} #{cb.version}")
-        artifact = graph.artifacts(name, cb.version)
+        artifact = graph.artifact(name, cb.version)
         cblist.push([name, cb.version])
         cb.metadata.dependencies.each do |dep_name, dep_version|
           artifact.depends(dep_name, dep_version)
         end
       end
-      #get the cookbooks and their versions, map to cookbook hash format
+      # get the cookbooks and their versions, map to cookbook hash format
       begin
         cookbooks = []
-        Solve.it!(graph, cblist).each {|k,v| cookbooks.push({k => {'version' => v}})}
-      rescue Solve::Errors::NoSolutionError => e
-        STDERR.puts "ERROR: There are missing cookbook dependencies, please check your metadata.rb files."
+        Solve.it!(graph, cblist).each { |k, v| cookbooks.push(k => { 'version' => v  }) }
+      rescue Solve::Errors::NoSolutionError
+        STDERR.puts 'ERROR: There are missing cookbook dependencies, please check your metadata.rb files.'
         exit(-1)
       end
-      #remove any cookbooks managed by berkshelf
-      cookbooks.delete_if {|x| berkshelf_cookbooks.keys.member?(x.keys[0])}
+      # remove any cookbooks managed by berkshelf
+      cookbooks.delete_if { |x| berkshelf_cookbooks.keys.member?(x.keys[0]) }
     end
   end
 end

data/lib/spiceweasel/knife.rb

@@ -1,7 +1,8 @@
+# encoding: UTF-8
 #
-# Author:: Matt Ray (<matt@opscode.com>)
+# Author:: Matt Ray (<matt@getchef.com>)
 #
-# Copyright:: 2013, Opscode, Inc <legal@opscode.com>
+# Copyright:: 2013-2014, Chef Software, Inc <legal@getchef.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,26 +18,27 @@
 #
 
 module Spiceweasel
+  # create knife commands from the manifest
   class Knife
-
     include CommandHelper
 
     attr_reader :knife_list, :create
 
     def initialize(knives = {}, allknifes = [])
-      @create = Array.new
-      if knives
-        knives.each do |knife|
-          Spiceweasel::Log.debug("knife: #{knife}")
-          knife.keys.each do |knf|
-            validate(knf, allknifes) unless Spiceweasel::Config[:novalidation]
-            if knife[knf]
-              knife[knf].each do |options|
-                create_command("knife #{knf} #{options}")
-              end
-            else
-              create_command("knife #{knf}")
+      @create = []
+
+      return unless knives
+
+      knives.each do |knife|
+        Spiceweasel::Log.debug("knife: #{knife}")
+        knife.keys.each do |knf|
+          validate(knf, allknifes) unless Spiceweasel::Config[:novalidation]
+          if knife[knf]
+            knife[knf].each do |options|
+              create_command("knife #{knf} #{options}")
             end
+          else
+            create_command("knife #{knf}")
           end
         end
       end
@@ -44,11 +46,10 @@ module Spiceweasel
 
     # test that the knife command exists
     def validate(command, allknifes)
-      unless allknifes.index {|x| x.start_with?("knife #{command}")}
-        STDERR.puts "ERROR: 'knife #{command}' is not a currently supported command for knife."
-        exit(-1)
-      end
-    end
+      return if  allknifes.index { |x| x.start_with?("knife #{command}") }
 
+      STDERR.puts "ERROR: 'knife #{command}' is not a currently supported command for knife."
+      exit(-1)
+    end
   end
 end

data/lib/spiceweasel/log.rb

@@ -1,7 +1,8 @@
+# encoding: UTF-8
 #
-# Author:: Matt Ray (<matt@opscode.com>)
+# Author:: Matt Ray (<matt@getchef.com>)
 #
-# Copyright:: 2012, Opscode, Inc <legal@opscode.com>
+# Copyright:: 2012-2014, Chef Software, Inc <legal@getchef.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -19,12 +20,11 @@
 require 'mixlib/log'
 
 module Spiceweasel
+  # configure logging
   class Log
     extend Mixlib::Log
 
-    #not quite ready for timestamps
+    # not quite ready for timestamps
     Mixlib::Log::Formatter.show_time = false
-
   end
 end
-