chef-dk 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 860c091ba42d4860904fc388511cf64813b1d77f
-  data.tar.gz: 7499f52d7e0f394607436c2cdb66ecfb578183fa
+  metadata.gz: ee32c7f8bf0ecdab62b80de5ea8a4464b51c6838
+  data.tar.gz: 2e111a49b664088c4111f0b66fd07b17ed0c5eaa
 SHA512:
-  metadata.gz: e4ad98327039f2edee2b6ea3c57c7ee8797060831480ef34b8202ec16ffc2beeb95215188c813af32002f0ba7235835842cdbb1b142d954324380e77a513b6dc
-  data.tar.gz: 0ab0237034a7edaeb6b6ee38274d195c492e2f268acc078fe87547c1a8d0349aeee0717c8708f1a3879eaaf0bf60808901a998ea8184e68643c50fb82352e60f
+  metadata.gz: ebe65296faf1e24202b4f577422a0956feb1feb722d623b9c74b9894f64d43afc55aac6fdd87ea3e659c2be85fa97a80af44b05a5e7866d1d5deaed2f2ead062
+  data.tar.gz: 713d6cca6c4fc3cc510e6f402bee5a8c81e7df06cf8be0423e911267b8419df6c6568f6e7b348f54959ff27f997acd44b0b824700653f3335c99c2ba5c86390e

data/README.md

@@ -23,6 +23,10 @@ Once you install the package, the `chef-client` suite, `berks`,
 `kitchen`, and this application (`chef`) will be symlinked into your
 system bin directory, ready to use.
 
+### Pre-release Candiates
+
+You can run `curl -LO https://www.chef.io/chef/install.sh && sudo bash ./install.sh -P chefdk -p && rm install.sh` to download and install the latest pre-release candidate.  If you want to specify a different version replace `-p` with `-v <version>`
+
 ## Usage
 
 For help with [Berkshelf][], [Test Kitchen][], [ChefSpec][] or [Foodcritic][],

data/lib/chef-dk/builtin_commands.rb

@@ -20,6 +20,9 @@ ChefDK.commands do |c|
   c.builtin "exec", :Exec, require_path: "chef-dk/command/exec",
     desc: "Runs the command in context of the embedded ruby"
 
+  c.builtin "env", :Env, require_path: "chef-dk/command/env",
+    desc: "Prints environment variables used by ChefDK"
+
   c.builtin "gem", :GemForwarder, require_path: "chef-dk/command/gem",
     desc: "Runs the `gem` command in context of the embedded ruby"
 
@@ -33,6 +36,10 @@ ChefDK.commands do |c|
 
   c.builtin "push", :Push, desc: "Push a local policy lock to a policy group on the server"
 
+  c.builtin "push-archive", :PushArchive, desc: "Push a policy archive to a policy group on the server"
+
+  c.builtin "show-policy", :ShowPolicy, desc: "Show policyfile objects on you Chef Server"
+
   c.builtin "diff", :Diff, desc: "Generate an itemized diff of two Policyfile lock documents"
 
   c.builtin "provision", :Provision, desc: "Provision VMs and clusters via cookbook"

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

@@ -0,0 +1,90 @@
+#
+# Copyright:: Copyright (c) 2015 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/cookbook_omnifetch'
+require 'chef-dk/ui'
+require 'chef-dk/version'
+require 'mixlib/shellout'
+require 'yaml'
+
+module ChefDK
+  module Command
+    class Env < ChefDK::Command::Base
+      banner "Usage: chef env"
+
+      attr_accessor :ui
+
+      def initialize(*args)
+        super
+        @ui = UI.new
+      end
+
+      def run(params)
+        info = {}
+        info['Chef Development Kit'] = Hash.new.tap do |chefdk_env|
+          chefdk_env['ChefDK'] = chefdk_info
+          chefdk_env['Ruby'] = ruby_info
+          chefdk_env['Path'] = paths
+        end
+        ui.msg info.to_yaml
+      end
+
+      def chefdk_info
+        Hash.new.tap do |chefdk|
+          chefdk['ChefDK Version'] = ChefDK::VERSION
+          chefdk['ChefDK Home'] = chefdk_home
+          chefdk['ChefDK Install Directory'] = omnibus_root
+          chefdk['Policyfile Config'] = policyfile_config
+        end
+      end
+
+      def ruby_info
+        Hash.new.tap do |ruby|
+          ruby['Ruby Executable'] = Gem.ruby
+          ruby['Ruby Version'] = RUBY_VERSION
+          ruby['RubyGems'] = Hash.new.tap do |rubygems|
+            rubygems['RubyGems Version'] = Gem::VERSION
+            rubygems['RubyGems Platforms'] = Gem.platforms.map(&:to_s)
+            rubygems['Gem Environment'] = gem_environment
+          end
+        end
+      end
+
+      def gem_environment
+        Hash.new.tap do |h|
+          h['GEM ROOT'] = omnibus_env['GEM_ROOT']
+          h['GEM HOME'] = omnibus_env['GEM_HOME']
+          h['GEM PATHS'] = omnibus_env['GEM_PATH'].split(File::PATH_SEPARATOR)
+        end
+      end
+
+      def paths
+        omnibus_env['PATH'].split(File::PATH_SEPARATOR)
+      end
+
+      def policyfile_config
+        Hash.new.tap do |h|
+          h['Cache Path'] = CookbookOmnifetch.cache_path
+          h['Storage Path'] = CookbookOmnifetch.storage_path.to_s
+        end
+      end
+
+    end
+  end
+end
+

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

@@ -38,6 +38,7 @@ to the target machine, you can apply the policy to the machine with
     use_policyfile true
     deployment_group '$POLICY_NAME-local'
     versioned_cookbooks true
+    policy_document_native_api false
 
 The Policyfile feature is incomplete and beta quality. See our detailed README
 for more information.
@@ -48,6 +49,13 @@ Options:
 
 E
 
+      option :archive,
+        short:       "-a",
+        long:        "--archive",
+        description: "Export as a tarball archive rather than a directory",
+        default:     false,
+        boolean:     true
+
       option :force,
         short:       "-f",
         long:        "--force",
@@ -79,7 +87,7 @@ E
       def run(params = [])
         return 1 unless apply_params!(params)
         export_service.run
-        ui.msg("Exported policy '#{export_service.policyfile_lock.name}' to #{export_dir}")
+        ui.msg("Exported policy '#{export_service.policyfile_lock.name}' to #{export_target}")
         0
       rescue ExportDirNotEmpty => e
         ui.err("ERROR: " + e.message)
@@ -90,14 +98,27 @@ E
         1
       end
 
+      def export_target
+        if archive?
+          export_service.archive_file_location
+        else
+          export_dir
+        end
+      end
+
       def debug?
         !!config[:debug]
       end
 
+      def archive?
+        !!config[:archive]
+      end
+
       def export_service
         @export_service ||= PolicyfileServices::ExportRepo.new(policyfile: policyfile_relative_path,
                                                        export_dir: export_dir,
                                                        root_dir: Dir.pwd,
+                                                       archive: archive?,
                                                        force: config[:force])
       end
 

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

@@ -50,7 +50,7 @@ module ChefDK
       generator(:template, :Template, "Generate a file template")
       generator(:file, :CookbookFile, "Generate a cookbook file")
       generator(:lwrp, :LWRP, "Generate a lightweight resource/provider")
-      generator(:repo, :Repo, "Generate a Chef policy repository")
+      generator(:repo, :Repo, "Generate a Chef code repository")
       generator(:policyfile, :Policyfile, "Generate a Policyfile for use with the install/push commands (experimental)")
 
       def self.banner_headline

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

@@ -15,6 +15,8 @@
 # limitations under the License.
 #
 
+require 'ostruct'
+
 require 'chef-dk/command/base'
 require 'chef-dk/configurable'
 require 'chef-dk/chef_runner'
@@ -40,6 +42,8 @@ module ChefDK
 
       attr_accessor :node_name
 
+      attr_accessor :target
+
       attr_accessor :enable_policyfile
 
       attr_accessor :policy_group
@@ -48,8 +52,15 @@ module ChefDK
 
       attr_accessor :extra_chef_config
 
+      attr_accessor :opts
+
       def initialize
         @extra_chef_config = ""
+        @opts = nil
+      end
+
+      def set_user_opts(hash)
+        @opts = OpenStruct.new(hash)
       end
 
       def convergence_options
@@ -173,6 +184,27 @@ E
         long:         "--node-name NODE_NAME",
         description:  "Set default node name (may be overriden by provisioning cookbook)"
 
+      option :target,
+        short:        "-t REMOTE_HOST",
+        long:         "--target REMOTE_HOST",
+        description:  "Set hostname or IP of the host to converge (may be overriden by provisioning cookbook)"
+
+      OPT_SEPARATOR = /[=\s]+/.freeze
+
+      def self.split_opt(key_value)
+        key, _separator, value = key_value.partition(OPT_SEPARATOR)
+        [key, value]
+      end
+
+      opts={}
+
+      option :opts,
+        short:        "-o OPT=VALUE",
+        long:         "--opt OPT=VALUE",
+        description:  "Set arbitrary option OPT on the provisioning context",
+        proc:         lambda { |arg| key, value = split_opt(arg); opts[key] = value; opts },
+        default:      {}
+
       option :debug,
         short:       "-D",
         long:        "--debug",
@@ -238,6 +270,9 @@ E
 
           c.action = default_action
           c.node_name = node_name
+          c.target = target
+
+          c.set_user_opts(user_opts)
 
           c.enable_policyfile = enable_policyfile?
 
@@ -269,6 +304,14 @@ E
         config[:node_name]
       end
 
+      def target
+        config[:target]
+      end
+
+      def user_opts
+        config[:opts]
+      end
+
       def recipe
         config[:machine_recipe]
       end

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

@@ -0,0 +1,126 @@
+#
+# Copyright:: Copyright (c) 2015 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_archive'
+require 'chef-dk/configurable'
+
+module ChefDK
+  module Command
+
+    class PushArchive < Base
+
+      include Configurable
+
+      banner(<<-E)
+Usage: chef push-archive POLICY_GROUP ARCHIVE_FILE [options]
+
+`chef push-archive` publishes a policy archive to a Chef Server. Policy
+archives can be created with `chef export -a`. The policy will be applied to
+the given POLICY_GROUP, which is a set of nodes that share the same
+run_list and cookbooks.
+
+For more information about Policyfiles, see our detailed README:
+
+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_accessor :ui
+
+      attr_reader :policy_group
+
+      attr_reader :archive_path
+
+      def initialize(*args)
+        super
+        @policy_group = nil
+        @archive_path = nil
+        @chef_config = nil
+        @ui = UI.new
+      end
+
+      def run(params)
+        return 1 unless apply_params!(params)
+
+        push_archive_service.run
+
+        0
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      # @api private
+      def handle_error(error)
+        ui.err("Error: #{error.message}")
+        if error.respond_to?(:reason)
+          ui.err("Reason: #{error.reason}")
+          ui.err("")
+          ui.err(error.extended_error_info) if debug?
+          ui.err(error.cause.backtrace.join("\n")) if debug?
+        end
+      end
+
+      # @api private
+      def push_archive_service
+        @push_archive_service ||=
+          ChefDK::PolicyfileServices::PushArchive.new(
+            archive_file: archive_file,
+            policy_group: policy_group,
+            ui: ui,
+            config: chef_config
+        )
+      end
+
+      def archive_file
+        File.expand_path(archive_path)
+      end
+
+      # @api private
+      def debug?
+        !!config[:debug]
+      end
+
+      # @api private
+      def apply_params!(params)
+        remaining_args = parse_options(params)
+        if remaining_args.size != 2
+          ui.err(opt_parser)
+          return false
+        end
+
+        @policy_group, @archive_path = remaining_args
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,166 @@
+#
+# Copyright:: Copyright (c) 2015 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/configurable'
+require 'chef-dk/policyfile/lister'
+require 'chef-dk/policyfile_services/show_policy'
+
+module ChefDK
+  module Command
+
+
+    class ShowPolicy < Base
+
+      banner(<<-BANNER)
+Usage: chef show-policy [POLICY_NAME [POLICY_GROUP]] [options]
+
+`chef show-policy` Displays the revisions of policyfiles on the server. By
+default, only active policy revisions are shown. Use the `--orphans` options to
+show policy revisions that are not assigned to any policy group.
+
+When both POLICY_NAME and POLICY_GROUP are given, the command shows the content
+of a the active policyfile lock for the given POLICY_GROUP. See also the `diff`
+command.
+
+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:
+
+BANNER
+
+      option :show_orphans,
+        short:        "-o",
+        long:         "--orphans",
+        description:  "Show policy revisions that are unassigned",
+        default:      false
+
+      option :pager,
+        long:        "--[no-]pager",
+        description: "Enable/disable paged policyfile lock ouput (default: enabled)",
+        default:     true,
+        boolean:     true
+
+      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
+
+      include Configurable
+
+      attr_accessor :ui
+
+      attr_reader :policy_name
+
+      attr_reader :policy_group
+
+      def initialize(*args)
+        super
+        @show_all_policies = nil
+        @policy_name = nil
+        @policy_group = nil
+        @ui = UI.new
+      end
+
+      def run(params)
+        return 1 unless apply_params!(params)
+        show_policy_service.run
+        0
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def show_policy_service
+        @policy_list_service ||=
+          PolicyfileServices::ShowPolicy.new(config: chef_config,
+                                             ui: ui,
+                                             policy_name: policy_name,
+                                             policy_group: policy_group,
+                                             show_orphans: show_orphans?,
+                                             summary_diff: show_summary_diff?,
+                                             pager: enable_pager?)
+      end
+
+      def debug?
+        !!config[:debug]
+      end
+
+      def show_summary_diff?
+        false
+      end
+
+      def show_orphans?
+        config[:show_orphans]
+      end
+
+      def enable_pager?
+        config[:pager]
+      end
+
+      def handle_error(error)
+        ui.err("Error: #{error.message}")
+        if error.respond_to?(:reason)
+          ui.err("Reason: #{error.reason}")
+          ui.err("")
+          ui.err(error.extended_error_info) if debug?
+          ui.err(error.cause.backtrace.join("\n")) if debug?
+        end
+      end
+
+      def apply_params!(params)
+        remaining_args = parse_options(params)
+
+        if remaining_args.empty? && show_summary_diff?
+          ui.err("The --summary-diff option can only be used when showing a single policy")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        elsif remaining_args.empty?
+          @show_all_policies = true
+          true
+        elsif remaining_args.size == 1
+          @policy_name = remaining_args.first
+          @show_all_policies = false
+          true
+        elsif remaining_args.size == 2
+          @policy_name = remaining_args[0]
+          @policy_group = remaining_args[1]
+          @show_all_policies = false
+          true
+        else
+          ui.err("Too many arguments")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        end
+      end
+
+    end
+  end
+end
+