chef-dk 0.6.2 → 0.7.0

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

@@ -0,0 +1,237 @@
+#
+# 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/policyfile/comparison_base'
+require 'chef-dk/policyfile/lister'
+require 'chef-dk/pager'
+
+module ChefDK
+  module PolicyfileServices
+    class ShowPolicy
+      class ReportPrinter
+
+        attr_reader :ui
+
+        def initialize(ui)
+          @ui = ui
+        end
+
+        def h1(heading)
+          ui.msg(heading)
+          ui.msg("=" * heading.size)
+          ui.msg("")
+        end
+
+        def h2(heading)
+          ui.msg(heading)
+          ui.msg("-" * heading.size)
+          ui.msg("")
+        end
+
+        def table_list(items)
+          left_justify_size = items.keys.map(&:size).max.to_i + 2
+          items.each do |name, value|
+            justified_name = "#{name}:".ljust(left_justify_size)
+            ui.msg("* #{justified_name} #{value}")
+          end
+
+          ui.msg("")
+        end
+
+        def list(items)
+          items.each { |item| ui.msg("* #{item}") }
+          ui.msg("")
+        end
+      end
+
+      attr_reader :policy_lister
+
+      attr_reader :ui
+
+      attr_reader :policy_name
+
+      attr_reader :chef_config
+
+      attr_reader :policy_group
+
+      def initialize(config: nil, ui: nil, policy_name: nil, policy_group: nil, show_orphans: false, summary_diff: false, pager: false)
+        @chef_config = config
+        @ui = ui
+        @policy_name = policy_name
+        @policy_group = policy_group
+        @show_orphans = show_orphans
+        @summary_diff = summary_diff
+        @enable_pager = pager
+      end
+
+      def run
+        if show_policy_revision?
+          display_policy_revision
+        elsif show_all_policies?
+          display_all_policies
+        else
+          display_single_policy
+        end
+        true
+      rescue PolicyfileNestedException
+        raise
+      rescue => e
+        raise PolicyfileListError.new("Failed to list policyfile data from the server", e)
+      end
+
+      def show_policy_revision?
+        !!policy_group
+      end
+
+      def show_all_policies?
+        !policy_name
+      end
+
+      def show_orphans?
+        @show_orphans
+      end
+
+      def show_summary_diff?
+        @summary_diff
+      end
+
+      def enable_pager?
+        @enable_pager
+      end
+
+      def report
+        @report ||= ReportPrinter.new(ui)
+      end
+
+      def policy_lister
+        @policy_info_fetcher ||= Policyfile::Lister.new(config: chef_config)
+      end
+
+      def display_policy_revision
+        lock = Policyfile::ComparisonBase::PolicyGroup.new(policy_group, policy_name, http_client).lock
+        pager = Pager.new(enable_pager: enable_pager?)
+        pager.with_pager { |p| p.ui.msg(FFI_Yajl::Encoder.encode(lock, pretty: true)) }
+      end
+
+      def display_all_policies
+        if policy_lister.empty?
+          ui.err("No policies or policy groups exist on the server")
+          return
+        end
+        if policy_lister.policies_by_name.empty?
+          ui.err("No policies exist on the server")
+          return
+        end
+        policy_lister.revision_ids_by_group_for_each_policy do |policy_name, rev_id_by_group|
+          report.h1(policy_name)
+
+          if rev_id_by_group.empty?
+            ui.err("Policy #{policy_name} is not assigned to any groups")
+            ui.err("")
+          else
+            rev_ids_for_report = format_rev_ids_for_report(rev_id_by_group)
+            report.table_list(rev_ids_for_report)
+          end
+
+          if show_orphans?
+            orphans = policy_lister.orphaned_revisions(policy_name)
+
+            unless orphans.empty?
+              report.h2("Orphaned:")
+              formatted_orphans = orphans.map { |id| shorten_rev_id(id) }
+              report.list(formatted_orphans)
+            end
+          end
+        end
+      end
+
+      def display_single_policy
+        report.h1(policy_name)
+        rev_id_by_group = policy_lister.revision_ids_by_group_for(policy_name)
+
+        if rev_id_by_group.empty?
+          ui.err("No policies named '#{policy_name}' are associated with a policy group")
+          ui.err("")
+        elsif show_summary_diff?
+          unique_rev_ids = rev_id_by_group.unique_revision_ids
+          revision_info = policy_lister.revision_info_for(policy_name, unique_rev_ids)
+
+          ljust_size = rev_id_by_group.max_group_name_length + 2
+
+          cbs_with_differing_ids = revision_info.cbs_with_differing_ids
+
+          rev_id_by_group.each do |group_name, rev_id|
+            heading = "#{group_name}:".ljust(ljust_size) + shorten_rev_id(rev_id)
+            report.h2(heading)
+
+            differing_cbs_version_info = cbs_with_differing_ids.inject({}) do |cb_version_info, cb_name|
+
+              version, identifier = revision_info.cb_info_for(rev_id, cb_name)
+
+              cb_info_for_report =
+                if !version.nil?
+                  "#{version} (#{shorten_rev_id(identifier)})"
+                else
+                  "*NONE*"
+                end
+
+              cb_version_info[cb_name] = cb_info_for_report
+
+              cb_version_info
+            end
+
+            report.table_list(differing_cbs_version_info)
+          end
+
+        else
+          rev_ids_for_report = format_rev_ids_for_report(rev_id_by_group)
+          report.table_list(rev_ids_for_report)
+        end
+
+        if show_orphans?
+          orphans = policy_lister.orphaned_revisions(policy_name)
+
+          unless orphans.empty?
+            report.h2("Orphaned:")
+            formatted_orphans = orphans.map { |id| shorten_rev_id(id) }
+            report.list(formatted_orphans)
+          end
+        end
+      end
+
+      def shorten_rev_id(revision_id)
+        revision_id[0,10]
+      end
+
+      def http_client
+        @http_client ||= ChefDK::AuthenticatedHTTP.new(chef_config.chef_server_url,
+                                                       signing_key_filename: chef_config.client_key,
+                                                       client_name: chef_config.node_name)
+      end
+
+      private
+
+      def format_rev_ids_for_report(rev_id_by_group)
+        rev_id_by_group.format_revision_ids do |rev_id|
+          rev_id ? rev_id[0,10] : "*NOT APPLIED*"
+        end
+      end
+
+
+    end
+  end
+end

data/lib/chef-dk/service_exceptions.rb

@@ -31,6 +31,7 @@ module ChefDK
 
     def initialize(message, cause)
       super(message)
+      @message = message
       @inspector = inspector_for(cause)
       @cause = cause
     end
@@ -43,6 +44,14 @@ module ChefDK
       inspector.extended_error_info
     end
 
+    def message
+      @message
+    end
+
+    def to_s
+      "#{message}\nCaused by: #{reason}"
+    end
+
     private
 
     def inspector_for(exception)
@@ -76,6 +85,9 @@ module ChefDK
   class ExportDirNotEmpty < PolicyfileServiceError
   end
 
+  class InvalidPolicyArchive < PolicyfileServiceError
+  end
+
   class PolicyfileNestedException < PolicyfileServiceError
 
     include NestedExceptionWithInspector
@@ -91,12 +103,21 @@ module ChefDK
   class PolicyfileUpdateError < PolicyfileNestedException
   end
 
+  class PolicyfilePushArchiveError < PolicyfileNestedException
+  end
+
   class PolicyfilePushError < PolicyfileNestedException
   end
 
   class PolicyfileExportRepoError < PolicyfileNestedException
   end
 
+  class PolicyfileListError < PolicyfileNestedException
+  end
+
+  class PolicyfileCleanError < PolicyfileNestedException
+  end
+
   class ChefRunnerError < StandardError
 
     include NestedExceptionWithInspector

data/lib/chef-dk/skeletons/code_generator/files/default/chefignore

@@ -53,6 +53,7 @@ test/*
 features/*
 Guardfile
 Procfile
+.kitchen
 
 # SCM #
 #######

data/lib/chef-dk/skeletons/code_generator/files/default/repo/README.md

@@ -10,53 +10,15 @@ Repository Directories
 
 This repository contains several directories, and each directory contains a README file that describes what it is for in greater detail, and how to use it for managing your systems with Chef.
 
-* `certificates/` - SSL certificates generated by `rake ssl_cert` live here.
-* `config/` - Contains the Rake configuration file, `rake.rb`.
 * `cookbooks/` - Cookbooks you download or create.
 * `data_bags/` - Store data bags and items in .json in the repository.
 * `roles/` - Store roles in .rb or .json in the repository.
-
-Rake Tasks
-==========
-
-The repository contains a `Rakefile` that includes tasks that are installed with the Chef libraries. To view the tasks available with in the repository with a brief description, run `rake -T`.
-
-The default task (`default`) is run when executing `rake` with no arguments. It will call the task `test_cookbooks`.
-
-The following tasks are not directly replaced by knife sub-commands.
-
-* `bundle_cookbook[cookbook]` - Creates cookbook tarballs in the `pkgs/` dir.
-* `install` - Calls `update`, `roles` and `upload_cookbooks` Rake tasks.
-* `ssl_cert` - Create self-signed SSL certificates in `certificates/` dir.
-* `update` - Update the repository from source control server, understands git and svn.
-
-The following tasks duplicate functionality from knife and may be removed in a future version of Chef.
-
-* `metadata` - replaced by `knife cookbook metadata -a`.
-* `new_cookbook` - replaced by `knife cookbook create`.
-* `role[role_name]` - replaced by `knife role from file`.
-* `roles` - iterates over the roles and uploads with `knife role from file`.
-* `test_cookbooks` - replaced by `knife cookbook test -a`.
-* `test_cookbook[cookbook]` - replaced by `knife cookbook test COOKBOOK`.
-* `upload_cookbooks` - replaced by `knife cookbook upload -a`.
-* `upload_cookbook[cookbook]` - replaced by `knife cookbook upload COOKBOOK`.
+* `environments/` - Store environments in .rb or .json in the repository.
 
 Configuration
 =============
 
-The repository uses two configuration files.
-
-* config/rake.rb
-* .chef/knife.rb
-
-The first, `config/rake.rb` configures the Rakefile in two sections.
-
-* Constants used in the `ssl_cert` task for creating the certificates.
-* Constants that set the directory locations used in various tasks.
-
-If you use the `ssl_cert` task, change the values in the `config/rake.rb` file appropriately. These values were also used in the `new_cookbook` task, but that task is replaced by the `knife cookbook create` command which can be configured below.
-
-The second config file, `.chef/knife.rb` is a repository specific configuration file for knife. If you're using the Opscode Platform, you can download one for your organization from the management console. If you're using the Open Source Chef Server, you can generate a new one with `knife configure`. For more information about configuring Knife, see the Knife documentation.
+The config file, `.chef/knife.rb` is a repository specific configuration file for knife. If you're using the Chef Platform, you can download one for your organization from the management console. If you're using the Open Source Chef Server, you can generate a new one with `knife configure`. For more information about configuring Knife, see the Knife documentation.
 
 http://docs.chef.io/knife.html
 

data/lib/chef-dk/skeletons/code_generator/recipes/app.rb

@@ -5,8 +5,6 @@ app_dir = File.join(context.app_root, context.app_name)
 cookbooks_dir = context.cookbook_root
 cookbook_dir = File.join(cookbooks_dir, context.cookbook_name)
 
-cookbook_dir = File.join(cookbooks_dir, context.app_name)
-
 # app root dir
 directory app_dir
 

data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen.yml.erb

@@ -6,8 +6,8 @@ provisioner:
   name: chef_zero
 
 platforms:
-  - name: ubuntu-12.04
-  - name: centos-6.5
+  - name: ubuntu-14.04
+  - name: centos-7.1
 
 suites:
   - name: default

data/lib/chef-dk/skeletons/code_generator/templates/default/recipe_spec.rb.erb

@@ -14,7 +14,7 @@ describe '<%= cookbook_name %>::<%= recipe_name %>' do
     end
 
     it 'converges successfully' do
-      chef_run # This should not raise an error
+      expect { chef_run }.to_not raise_error
     end
   end
 end

data/lib/chef-dk/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefDK
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/spec/unit/command/env_spec.rb

@@ -0,0 +1,52 @@
+#
+# 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 'spec_helper'
+require 'yaml'
+require 'chef-dk/command/env'
+
+describe ChefDK::Command::Env do
+  let(:ui) { TestHelpers::TestUI.new }
+  let(:command_instance) { ChefDK::Command::Env.new() }
+
+  let(:command_options) { [] }
+
+  let(:user_bin_dir) { File.expand_path(File.join(Gem.user_dir, 'bin')) }
+  let(:omnibus_embedded_bin_dir) { "/foo/embedded/bin" }
+  let(:omnibus_bin_dir) { "/foo/bin" }
+
+  before do
+    allow(command_instance).to receive(:omnibus_embedded_bin_dir).and_return(omnibus_embedded_bin_dir)
+    allow(command_instance).to receive(:omnibus_bin_dir).and_return(omnibus_bin_dir)
+    command_instance.ui = ui
+  end
+
+  def run_command
+    command_instance.run_with_default_options(command_options)
+  end
+
+  it "has a usage banner" do
+    expect(command_instance.banner).to eq("Usage: chef env")
+  end
+
+  describe "when running env command" do
+    it "should return valid yaml" do
+      run_command
+      expect{ YAML.load(ui.output) }.not_to raise_error
+    end
+  end
+end

data/spec/unit/command/exec_spec.rb

@@ -94,7 +94,7 @@ describe ChefDK::Command::Exec do
         expect(ENV).to receive(:[]=).with("GEM_PATH", expected_GEM_PATH)
 
         expect(command_instance).to receive(:exec).with(*command_options)
-        expect{ run_command }.to raise_error # XXX: this isn't a test we just need to swallow the exception
+        expect{ run_command }.to raise_error(RuntimeError) # XXX: this isn't a test we just need to swallow the exception
       end
 
       ['-v', '--version', '-h', '--help'].each do |switch|
@@ -108,7 +108,7 @@ describe ChefDK::Command::Exec do
             expect(ENV).to receive(:[]=).with("GEM_PATH", expected_GEM_PATH)
 
             expect(command_instance).to receive(:exec).with(*command_options)
-            expect{ run_command }.to raise_error # XXX: this isn't a test we just need to swallow the exception
+            expect{ run_command }.to raise_error(RuntimeError) # XXX: this isn't a test we just need to swallow the exception
           end
         end
       end