chef-dk 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71929ebb4b2845757688d9de6a8519e2984de9e3
-  data.tar.gz: cbf10aabf6125995c29fe7199ca37e22a5b1d5a8
+  metadata.gz: f843be984f4748b386cfc76d5b13fc53a015ffeb
+  data.tar.gz: ff6284980c5d4db06395d5264fae6de79dd858f3
 SHA512:
-  metadata.gz: 93381f6a0deb08de22ef67c5605adf8221f470523de25b6ae5f6207daddaf4cb8d4414cfc5f2bbd597085fc2e39dc29d11539d1fe8e2f250c131e2fff48eb83a
-  data.tar.gz: a90008e558fb76709c8ca8159532e7132416c24af750538aff94855201479fd7a876a467c3732cbaf5eb66e3cb7f2e99df00d6ecf795c762b3fdb2353c773c8d
+  metadata.gz: 2c7ebbe3baf7bae4ca25072f6f62da8ee3c6cf14aa38d4bf7af8632338bed6f3b9949c06ee0e7283b958b1a61e38178a9bec9bbf9f04b3e0ad672e1c18bf99bf
+  data.tar.gz: 0d0c18793a5a724ba719d4237a3f8e58ae1a6ed9bb07020277df9c9ce96caac5ba5632728004d6e91caa2a080fc0b150ef32906a305c2326d697889d202a6fd7

data/CONTRIBUTING.md

@@ -23,8 +23,8 @@ Chef is built to last. We strive to ensure high quality throughout the Chef expe
   this, we require a couple of things for all pull requests to Chef:
 
 1. **Tests:** To ensure high quality code and protect against future regressions, we require all the
-  code in Chef to have at least unit test coverage. See the [spec/unit](https://github.com/opscode/chef/tree/master/spec/unit)
-  directory for the existing tests and use ```bundle exec rake spec``` to run them.
+  code in Chef to have at least unit test coverage. Run ```bundle exec rspec``` from the project root
+  to execute the tests.
 2. **Green Travis Run:** We use [Travis CI](https://travis-ci.org/) in order to run our tests
   continuously on all the pull requests. We require the Travis runs to succeed on every pull
   request before being merged.

data/README.md

@@ -108,6 +108,29 @@ environment to make ChefDK your primary ruby. For more information to
 help you decide if this is desirable and instructions, see "Using ChefDK
 as Your Primary Development Environment" below.
 
+### `chef install`
+`chef install` reads a Policyfile.rb document, which contains a
+`run_list` and optional cookbook version constraints, finds a set of
+cookbooks that provide the desired recipes and meet dependency
+constraints, and emits a Policyfile.lock.json describing the expanded
+run list and locked cookbook set. The Policyfile.lock.json can be used
+to install the cookbooks on another machine. The policy lock can be
+uploaded to a Chef Server (via the `chef push` command) to apply the
+expanded run list and locked cookbook set to nodes in your
+infrastructure. The Policyfile feature is currently incomplete and of
+beta quality; changes to the Chef Server APIs will need to be
+implemented before the feature is production-ready. The feature
+currently operates in a compatibility mode. See the POLICYFILE_README.md
+for further details.
+
+### `chef push`
+`chef push POLICY_GROUP` uploads a Policyfile.lock.json along with the cookbooks it
+references to a Chef Server. The policy lock is applied to a
+`POLICY_GROUP`, which is a set of nodes that share the same run list and
+cookbook set. This command operates in compatibility mode and has the
+same caveats as `chef install`. See the POLICYFILE_README.md for further
+details.
+
 ### Using ChefDK as Your Primary Development Environment
 
 By default, ChefDK only adds a few select applications to your `PATH`
@@ -173,6 +196,8 @@ You can use `rpm` to uninstall Chef Development Kit on RHEL based systems:
 ```
 rpm -qa *chefdk*
 yum remove <package>
+rm -rf /opt/chefdk
+rm -rf ~/.chefdk
 ```
 
 ### Ubuntu

data/lib/chef-dk/builtin_commands.rb

@@ -27,5 +27,9 @@ ChefDK.commands do |c|
 
   c.builtin "shell-init", :ShellInit, desc: "Initialize your shell to use ChefDK as your primary ruby"
 
+  c.builtin "install", :Install, desc: "Install cookbooks from a Policyfile and generate a locked cookbook set"
+
+  c.builtin "push", :Push, desc: "Push a local policy lock to a policy group on the server"
+
   c.builtin "verify", :Verify, desc: "Test the embedded ChefDK applications"
 end

data/lib/chef-dk/cli.rb

@@ -20,6 +20,8 @@ require 'chef-dk/version'
 require 'chef-dk/commands_map'
 require 'chef-dk/builtin_commands'
 require 'chef-dk/helpers'
+require 'chef-dk/ui'
+require 'chef/util/path_helper'
 
 module ChefDK
   class CLI
@@ -53,6 +55,8 @@ BANNER
     end
 
     def run
+      sanity_check!
+
       subcommand_name, *subcommand_params = argv
 
       #
@@ -70,6 +74,10 @@ BANNER
         show_help
         exit 1
       end
+    rescue OptionParser::InvalidOption => e
+      err(e.message)
+      show_help
+      exit 1
     end
 
     # If no subcommand is given, then this class is handling the CLI request.
@@ -131,5 +139,43 @@ BANNER
       end
     end
 
+    # Find PATH or Path correctly if we are on Windows
+    def path_key
+      ENV.keys.grep(/\Apath\Z/i).first
+    end
+
+    # upcase drive letters for comparison since ruby has a String#capitalize function
+    def drive_upcase(path)
+      if Chef::Platform.windows? && path[0] =~ /^[A-Za-z]$/ && path[1,2] == ":\\"
+        path.capitalize
+      else
+        path
+      end
+    end
+
+    def env
+      ENV
+    end
+
+    # catch the cases where users setup only the embedded_bin_dir in their path, or
+    # when they have the embedded_bin_dir before the omnibus_bin_dir -- both of which will
+    # defeat appbundler and interact very badly with our intent.
+    def sanity_check!
+      paths = env[path_key].split(File::PATH_SEPARATOR)
+      paths.map! { |p| drive_upcase(Chef::Util::PathHelper.cleanpath(p)) }
+      embed_index = paths.index(drive_upcase(Chef::Util::PathHelper.cleanpath(omnibus_embedded_bin_dir)))
+      bin_index = paths.index(drive_upcase(Chef::Util::PathHelper.cleanpath(omnibus_bin_dir)))
+      if embed_index
+        if bin_index
+          if embed_index < bin_index
+            msg("WARN: #{omnibus_embedded_bin_dir} is before #{omnibus_bin_dir} in your #{path_key}, please reverse that order.")
+            msg("WARN: consider using the correct `chef shell-init <shell>` command to setup your environment correctly.")
+          end
+        else
+          msg("WARN: only #{omnibus_embedded_bin_dir} is present in your path, you must add #{omnibus_bin_dir} before that directory.")
+          msg("WARN: consider using the correct `chef shell-init <shell>` command to setup your environment correctly.")
+        end
+      end
+    end
   end
 end

data/lib/chef-dk/command/base.rb

@@ -56,6 +56,10 @@ module ChefDK
         else
           run(params)
         end
+      rescue OptionParser::InvalidOption => e
+        err(e.message)
+        msg(opt_parser)
+        1
       end
 
       def needs_help?(params)

data/lib/chef-dk/command/generator_commands/template.rb

@@ -23,7 +23,7 @@ module ChefDK
       # chef generate template [path/to/cookbook_root] name --source=source_file
       class Template < CookbookCodeFile
 
-        option :content_source,
+        option :source,
           :short => "-s SOURCE_FILE",
           :long  => "--source SOURCE_FILE",
           :description => "Copy content from SOURCE_FILE"
@@ -38,6 +38,7 @@ module ChefDK
 
         def setup_context
           super
+          Generator.add_attr_to_context(:content_source, config[:source])
         end
       end
     end

data/lib/chef-dk/command/install.rb

@@ -0,0 +1,105 @@
+#
+# Copyright:: Copyright (c) 2014 Chef Software 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.
+#
+
+require 'chef-dk/command/base'
+require 'chef-dk/ui'
+require 'chef-dk/policyfile_services/install'
+
+module ChefDK
+  module Command
+
+    class Install < Base
+
+      banner(<<-E)
+Usage: chef install [ POLICY_FILE ] [options]
+
+`chef install` evaluates a `Policyfile.rb` to find a compatible set of
+cookbooks for the policy's run_list and caches them locally. It emits a
+Policyfile.lock.json describing the locked cookbook set. You can use the
+lockfile to install the locked cookbooks on another machine. You can also push
+the lockfile to a "policy group" on a Chef Server and apply that exact set of
+cookbooks to nodes in your infrastructure.
+
+The Policyfile feature is incomplete and beta quality. See our detailed README
+for more information.
+
+https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
+
+Options:
+
+E
+
+      option :debug,
+        short:       "-D",
+        long:        "--debug",
+        description: "Enable stacktraces and other debug output",
+        default:     false
+
+      attr_reader :policyfile_relative_path
+
+      attr_accessor :ui
+
+      def initialize(*args)
+        super
+        @ui = UI.new
+
+        @policyfile_relative_path = nil
+        @installer = nil
+      end
+
+      def run(params = [])
+        apply_params!(params)
+        installer.run
+        0
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def installer
+        @installer ||= PolicyfileServices::Install.new(policyfile: policyfile_relative_path, ui: ui, root_dir: Dir.pwd)
+      end
+
+      def debug?
+        !!config[:debug]
+      end
+
+      def handle_error(error)
+        ui.err("Error: #{error.message}")
+        if error.respond_to?(:cause) && error.cause
+          cause = error.cause
+          ui.err("Reason: #{cause.class.name}")
+          ui.err("")
+          ui.err(cause.message)
+          ui.err(cause.backtrace.join("\n")) if debug?
+        end
+      end
+
+      def apply_params!(params)
+        remaining_args = parse_options(params)
+        if remaining_args.size > 1
+          ui.err(banner)
+          return 1
+        else
+          @policyfile_relative_path = remaining_args.first
+        end
+      end
+
+    end
+  end
+end
+

data/lib/chef-dk/command/push.rb

@@ -0,0 +1,123 @@
+#
+# Copyright:: Copyright (c) 2014 Chef Software 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.
+#
+
+require 'chef-dk/command/base'
+require 'chef-dk/ui'
+require 'chef-dk/policyfile_services/push'
+
+module ChefDK
+  module Command
+
+    class Push < Base
+
+      banner(<<-E)
+Usage: chef push POLICY_GROUP [ POLICY_FILE ] [options]
+
+`chef push` Uploads an existing Policyfile.lock.json to a Chef Server, along
+with all the cookbooks contained in the policy lock. The policy lock is applied
+to a specific POLICY_GROUP, which is a set of nodes that share the same
+run_list and cookbooks.
+
+The Policyfile feature is incomplete and beta quality. See our detailed README
+for more information.
+
+https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
+
+Options:
+
+E
+
+      option :config_file,
+        short:       "-c CONFIG_FILE",
+        long:        "--config CONFIG_FILE",
+        description: "Path to configuration file"
+
+      option :debug,
+        short:       "-D",
+        long:        "--debug",
+        description: "Enable stacktraces and other debug output",
+        default:     false
+
+      attr_reader :policyfile_relative_path
+      attr_reader :policy_group
+
+      attr_accessor :ui
+
+      def initialize(*args)
+        super
+        @push = nil
+        @ui = nil
+        @policy_group = nil
+        @policyfile_relative_path = nil
+        @chef_config = nil
+        @ui = UI.new
+      end
+
+      def run(params = [])
+        return 1 unless apply_params!(params)
+        push.run
+        0
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def debug?
+        !!config[:debug]
+      end
+
+      def chef_config
+        return @chef_config if @chef_config
+        Chef::WorkstationConfigLoader.new(config[:config_file]).load
+        @chef_config = Chef::Config
+      end
+
+      def push
+        @push ||= PolicyfileServices::Push.new(policyfile: policyfile_relative_path,
+                                               ui: ui,
+                                               policy_group: policy_group,
+                                               config: chef_config,
+                                               root_dir: Dir.pwd)
+      end
+
+      def handle_error(error)
+        ui.err("Error: #{error.message}")
+        if error.respond_to?(:cause) && error.cause
+          cause = error.cause
+          ui.err("Reason: #{cause.class.name}")
+          ui.err("")
+          ui.err(cause.message)
+          ui.err(cause.backtrace.join("\n")) if debug?
+        end
+      end
+
+      def apply_params!(params)
+        remaining_args = parse_options(params)
+        if remaining_args.size < 1 or remaining_args.size > 2
+          ui.err(banner)
+          return false
+        else
+          @policy_group = remaining_args[0]
+          @policyfile_relative_path = remaining_args[1]
+        end
+        true
+      end
+
+    end
+  end
+end
+

data/lib/chef-dk/cookbook_profiler/identifiers.rb

@@ -15,10 +15,15 @@
 # limitations under the License.
 #
 
+# TODO: Chef should require its dependency correctly.
+require 'singleton'
 require 'chef/cookbook/cookbook_version_loader'
 require 'digest/sha1'
+
 require 'chef/digester'
 
+require 'chef-dk/exceptions'
+
 module ChefDK
   module CookbookProfiler
     class Identifiers

data/lib/chef-dk/exceptions.rb

@@ -17,6 +17,40 @@
 
 module ChefDK
 
+  # Base class for errors raised by ChefDK::PolicyfileServices objects. Don't
+  # raise this directly, create a descriptively-named subclass. You can rescue
+  # this to catch all errors from PolicyfileServices objects though.
+  class PolicyfileServiceError < StandardError
+  end
+
+  class PolicyfileNotFound < PolicyfileServiceError
+  end
+
+  class LockfileNotFound < PolicyfileServiceError
+  end
+
+  class PolicyfileInstallError < PolicyfileServiceError
+
+    attr_reader :cause
+
+    def initialize(message, cause)
+      super(message)
+      @cause = cause
+    end
+
+  end
+
+  class PolicyfilePushError < PolicyfileServiceError
+
+    attr_reader :cause
+
+    def initialize(message, cause)
+      super(message)
+      @cause = cause
+    end
+
+  end
+
   class CachedCookbookNotFound < StandardError
   end
 
@@ -58,4 +92,8 @@ module ChefDK
 
   class MissingCookbookLockData < StandardError
   end
+
+  class InvalidLockfile < StandardError
+  end
+
 end