spiceweasel 2.6.0 → 2.8.0

data/lib/spiceweasel/roles.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,107 +17,137 @@
 # limitations under the License.
 #
 
-require 'yajl/json_gem'
+require 'ffi_yajl'
 require 'chef'
+require 'spiceweasel/command_helper'
 
 module Spiceweasel
+  # manages parsing of Roles
   class Roles
-
     include CommandHelper
 
     attr_reader :role_list, :create, :delete
 
-    def initialize(roles = {}, environments = [], cookbooks = {})
-      @create = Array.new
-      @delete = Array.new
-      @role_list = Array.new
-      if roles
-        Spiceweasel::Log.debug("roles: #{roles}")
-        flatroles = roles.collect {|x| x.keys}.flatten
-        rolefiles = []
-        flatroles.each do |role|
-          Spiceweasel::Log.debug("role: #{role}")
-          if File.directory?("roles")
-            #expand wildcards and push into flatroles
-            if role =~ /\*/ #wildcard support
-              wildroles = Dir.glob("roles/#{role}")
-              #remove anything not ending in .json or .rb
-              wildroles.delete_if {|x| !x.end_with?(".rb", ".json")}
-              Spiceweasel::Log.debug("found roles '#{wildroles}' for wildcard: #{role}")
-              flatroles.concat(wildroles.collect {|x| x[x.rindex('/')+1..x.rindex('.')-1]})
-              next
-            end
-            validate(role, environments, cookbooks, flatroles) unless Spiceweasel::Config[:novalidation]
-          elsif !Spiceweasel::Config[:novalidation]
-            STDERR.puts "ERROR: 'roles' directory not found, unable to validate or load roles"
-            exit(-1)
-          end
-          if File.exists?("roles/#{role}.json")
-            rolefiles.push("#{role}.json")
-          else #assume no .json means they want .rb and catchall for misssing dir
-            rolefiles.push("#{role}.rb")
+    def initialize(roles = {}, environments = [], cookbooks = {}) # rubocop:disable CyclomaticComplexity
+      @create = []
+      @delete = []
+      @role_list = []
+
+      return if roles.nil? || roles.empty?
+
+      Spiceweasel::Log.debug("roles: #{roles}")
+      rolefiles = identify_role_files(cookbooks, environments, roles)
+      create_command("knife role#{Spiceweasel::Config[:knife_options]} from file #{rolefiles.uniq.sort.join(' ')}")
+    end
+
+    def identify_role_files(cookbooks, environments, roles)
+      flatroles = roles.map(&:keys).flatten
+      rolefiles = []
+      unwind_roles(cookbooks, environments, flatroles, rolefiles)
+      rolefiles
+    end
+
+    def unwind_roles(cookbooks, environments, flatroles, rolefiles)
+      flatroles.each do |role|
+        Spiceweasel::Log.debug("role: #{role}")
+        if File.directory?('roles')
+          # expand wildcards and push into flatroles
+          if role =~ /\*/ # wildcard support
+            wildroles = Dir.glob("roles/#{role}")
+            # remove anything not ending in .json or .rb
+            wildroles.delete_if { |x| !x.end_with?('.rb', '.json') }
+            Spiceweasel::Log.debug("found roles '#{wildroles}' for wildcard: #{role}")
+            flatroles.concat(wildroles.map { |x| x[x.rindex('/') + 1..x.rindex('.') - 1] })
+            next
           end
-          delete_command("knife role#{Spiceweasel::Config[:knife_options]} delete #{role} -y")
-          @role_list.push(role)
+          validate(role, environments, cookbooks, flatroles) unless Spiceweasel::Config[:novalidation]
+        elsif !Spiceweasel::Config[:novalidation]
+          STDERR.puts "ERROR: 'roles' directory not found, unable to validate or load roles"
+          exit(-1)
         end
-        create_command("knife role#{Spiceweasel::Config[:knife_options]} from file #{rolefiles.uniq.sort.join(' ')}")
+        determine_role_file_type(role, rolefiles)
       end
     end
 
-    #validate the content of the role file
-    def validate(role, environments, cookbooks, roles)
-      #validate the role passed in match the name of either the .rb or .json
-      file = %W(roles/#{role}.rb roles/#{role}.json).detect{|f| File.exists?(f)}
-      if role =~ /\// #pull out directories
-        role = role.split('/').last
+    def determine_role_file_type(role, rolefiles)
+      if File.exist?("roles/#{role}.json")
+        rolefiles.push("#{role}.json")
+      else # assume no .json means they want .rb and catchall for misssing dir
+        rolefiles.push("#{role}.rb")
       end
+      delete_command("knife role#{Spiceweasel::Config[:knife_options]} delete #{role} -y")
+      @role_list.push(role)
+    end
+
+    # validate the content of the role file
+    def validate(role, _environments, cookbooks, roles) # rubocop:disable CyclomaticComplexity
+      # validate the role passed in match the name of either the .rb or .json
+      file = %W(roles/#{role}.rb roles/#{role}.json).find { |f| File.exist?(f) }
+      role = role.split('/').last if role =~ /\// # pull out directories
       if file
-        case file
-        when /\.json$/
-          c_role = Chef::JSONCompat.from_json(IO.read(file))
-        when /\.rb$/
-          if (Chef::VERSION.split('.')[0].to_i < 11)
-            c_role = Chef::Role.new(true)
-          else
-            c_role = Chef::Role.new
-          end
-          c_role.from_file(file)
-        end
+        c_role = evaluate_c_role(file)
         Spiceweasel::Log.debug("role: '#{role}' name: '#{c_role.name}'")
-        if !role.eql?(c_role.name)
+        unless role.eql?(c_role.name)
           STDERR.puts "ERROR: Role '#{role}' listed in the manifest does not match the name '#{c_role.name}' within the #{file} file."
           exit(-1)
         end
-        c_role.run_list.each do |runlist_item|
-          if(runlist_item.recipe?)
-            Spiceweasel::Log.debug("recipe: #{runlist_item.name}")
-            cookbook,recipe = runlist_item.name.split('::')
-            Spiceweasel::Log.debug("role: '#{role}' cookbook: '#{cookbook}' dep: '#{runlist_item}'")
-            unless(cookbooks.member?(cookbook))
-              STDERR.puts "ERROR: Cookbook dependency '#{runlist_item}' from role '#{role}' is missing from the list of cookbooks in the manifest."
-              exit(-1)
-            end
-          elsif(runlist_item.role?)
-            Spiceweasel::Log.debug("role: '#{role}' role: '#{runlist_item}': dep: '#{runlist_item.name}'")
-            unless(roles.member?(runlist_item.name))
-              STDERR.puts "ERROR: Role dependency '#{runlist_item.name}' from role '#{role}' is missing from the list of roles in the manifest."
-              exit(-1)
-            end
-          else
-            STDERR.puts "ERROR: Unknown item in runlist: #{runlist_item.name}"
+        role_run_list(c_role, cookbooks, role, roles)
+      else # role is not here
+        STDERR.puts "ERROR: Invalid Role '#{role}' listed in the manifest but not found in the roles directory."
+        exit(-1)
+      end
+    end
+
+    def evaluate_c_role(file)
+      c_role = nil
+      case file
+      when /\.json$/
+        c_role = Chef::JSONCompat.from_json(IO.read(file))
+      when /\.rb$/
+        if Chef::VERSION.split('.')[0].to_i < 11
+          c_role = Chef::Role.new(true)
+        else
+          c_role = Chef::Role.new
+        end
+        begin
+          c_role.from_file(file)
+        rescue SyntaxError => e
+          STDERR.puts "ERROR: Role '#{file}' has syntax errors."
+          STDERR.puts e.message
+          exit(-1)
+        end
+      else
+        STDERR.puts "ERROR: Role unreacable else block of 'case file' entered"
+        exit(-1)
+      end
+      c_role
+    end
+
+    def role_run_list(c_role, cookbooks, role, roles)
+      c_role.run_list.each do |runlist_item|
+        if runlist_item.recipe?
+          Spiceweasel::Log.debug("recipe: #{runlist_item.name}")
+          cookbook, _recipe = runlist_item.name.split('::')
+          Spiceweasel::Log.debug("role: '#{role}' cookbook: '#{cookbook}' dep: '#{runlist_item}'")
+          unless cookbooks.member?(cookbook)
+            STDERR.puts "ERROR: Cookbook dependency '#{runlist_item}' from role '#{role}' is missing from the list of cookbooks in the manifest."
+            exit(-1)
+          end
+        elsif runlist_item.role?
+          Spiceweasel::Log.debug("role: '#{role}' role: '#{runlist_item}': dep: '#{runlist_item.name}'")
+          unless roles.member?(runlist_item.name)
+            STDERR.puts "ERROR: Role dependency '#{runlist_item.name}' from role '#{role}' is missing from the list of roles in the manifest."
             exit(-1)
           end
+        else
+          STDERR.puts "ERROR: Unknown item in runlist: #{runlist_item.name}"
+          exit(-1)
         end
-        #TODO validate any environment-specific runlists
-      else #role is not here
-        STDERR.puts "ERROR: Invalid Role '#{role}' listed in the manifest but not found in the roles directory."
-        exit(-1)
       end
     end
 
     def member?(role)
       role_list.include?(role)
     end
-
   end
 end

data/lib/spiceweasel/version.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,6 +17,7 @@
 # limitations under the License.
 #
 
+# Spiceweasel version
 module Spiceweasel
-  VERSION = '2.6.0'
+  VERSION = '2.8.0'
 end

data/test/chef-repo/Berksfile

@@ -0,0 +1,4 @@
+source 'https://api.berkshelf.com'
+
+cookbook 'chef-pry', '0.2.0'
+cookbook 'def', path: 'cookbooks/def'

data/test/chef-repo/Berksfile.lock

@@ -0,0 +1,10 @@
+DEPENDENCIES
+  chef-pry (= 0.2.0)
+  def
+    path: cookbooks/def
+
+GRAPH
+  build-essential (2.0.2)
+  chef-pry (0.2.0)
+    build-essential (>= 0.0.0)
+  def (0.1.0)

data/test/chef-repo/PASSWORD

@@ -0,0 +1 @@
+SECRET!

data/test/chef-repo/cookbooks/abc/CHANGELOG.md

@@ -0,0 +1,13 @@
+abc CHANGELOG
+=============
+
+This file is used to list changes made in each version of the abc cookbook.
+
+0.1.0
+-----
+- [your_name] - Initial release of abc
+
+- - -
+Check the [Markdown Syntax Guide](http://daringfireball.net/projects/markdown/syntax) for help with Markdown.
+
+The [Github Flavored Markdown page](http://github.github.com/github-flavored-markdown/) describes the differences between markdown on github and standard markdown.

data/test/chef-repo/cookbooks/abc/README.md

@@ -0,0 +1,68 @@
+abc Cookbook
+============
+TODO: Enter the cookbook description here.
+
+e.g.
+This cookbook makes your favorite breakfast sandwich.
+
+Requirements
+------------
+TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
+
+e.g.
+#### packages
+- `toaster` - abc needs toaster to brown your bagel.
+
+Attributes
+----------
+TODO: List your cookbook attributes here.
+
+e.g.
+#### abc::default
+<table>
+  <tr>
+    <th>Key</th>
+    <th>Type</th>
+    <th>Description</th>
+    <th>Default</th>
+  </tr>
+  <tr>
+    <td><tt>['abc']['bacon']</tt></td>
+    <td>Boolean</td>
+    <td>whether to include bacon</td>
+    <td><tt>true</tt></td>
+  </tr>
+</table>
+
+Usage
+-----
+#### abc::default
+TODO: Write usage instructions for each cookbook.
+
+e.g.
+Just include `abc` in your node's `run_list`:
+
+```json
+{
+  "name":"my_node",
+  "run_list": [
+    "recipe[abc]"
+  ]
+}
+```
+
+Contributing
+------------
+TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
+
+e.g.
+1. Fork the repository on Github
+2. Create a named feature branch (like `add_component_x`)
+3. Write your change
+4. Write tests for your change (if applicable)
+5. Run the tests, ensuring they all pass
+6. Submit a Pull Request using Github
+
+License and Authors
+-------------------
+Authors: TODO: List authors

data/test/chef-repo/cookbooks/abc/metadata.rb

@@ -0,0 +1,7 @@
+name             'abc'
+maintainer       'YOUR_COMPANY_NAME'
+maintainer_email 'YOUR_EMAIL'
+license          'All rights reserved'
+description      'Installs/Configures abc'
+long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
+version          '0.1.0'

data/test/chef-repo/cookbooks/abc/recipes/default.rb

@@ -0,0 +1,8 @@
+#
+# Cookbook Name:: abc
+# Recipe:: default
+#
+# Copyright 2014, YOUR_COMPANY_NAME
+#
+# All rights reserved - Do Not Redistribute
+#

data/test/chef-repo/cookbooks/def/CHANGELOG.md

@@ -0,0 +1,13 @@
+def CHANGELOG
+=============
+
+This file is used to list changes made in each version of the def cookbook.
+
+0.1.0
+-----
+- [your_name] - Initial release of def
+
+- - -
+Check the [Markdown Syntax Guide](http://daringfireball.net/projects/markdown/syntax) for help with Markdown.
+
+The [Github Flavored Markdown page](http://github.github.com/github-flavored-markdown/) describes the differences between markdown on github and standard markdown.

data/test/chef-repo/cookbooks/def/README.md

@@ -0,0 +1,68 @@
+def Cookbook
+============
+TODO: Enter the cookbook description here.
+
+e.g.
+This cookbook makes your favorite breakfast sandwich.
+
+Requirements
+------------
+TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
+
+e.g.
+#### packages
+- `toaster` - def needs toaster to brown your bagel.
+
+Attributes
+----------
+TODO: List your cookbook attributes here.
+
+e.g.
+#### def::default
+<table>
+  <tr>
+    <th>Key</th>
+    <th>Type</th>
+    <th>Description</th>
+    <th>Default</th>
+  </tr>
+  <tr>
+    <td><tt>['def']['bacon']</tt></td>
+    <td>Boolean</td>
+    <td>whether to include bacon</td>
+    <td><tt>true</tt></td>
+  </tr>
+</table>
+
+Usage
+-----
+#### def::default
+TODO: Write usage instructions for each cookbook.
+
+e.g.
+Just include `def` in your node's `run_list`:
+
+```json
+{
+  "name":"my_node",
+  "run_list": [
+    "recipe[def]"
+  ]
+}
+```
+
+Contributing
+------------
+TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
+
+e.g.
+1. Fork the repository on Github
+2. Create a named feature branch (like `add_component_x`)
+3. Write your change
+4. Write tests for your change (if applicable)
+5. Run the tests, ensuring they all pass
+6. Submit a Pull Request using Github
+
+License and Authors
+-------------------
+Authors: TODO: List authors