chef-dk 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee32c7f8bf0ecdab62b80de5ea8a4464b51c6838
-  data.tar.gz: 2e111a49b664088c4111f0b66fd07b17ed0c5eaa
+  metadata.gz: 860e0ce1331356dc81adf225d0c041d3917eee74
+  data.tar.gz: 9356d799cc078070b9671c2f189032bc95f3d3ac
 SHA512:
-  metadata.gz: ebe65296faf1e24202b4f577422a0956feb1feb722d623b9c74b9894f64d43afc55aac6fdd87ea3e659c2be85fa97a80af44b05a5e7866d1d5deaed2f2ead062
-  data.tar.gz: 713d6cca6c4fc3cc510e6f402bee5a8c81e7df06cf8be0423e911267b8419df6c6568f6e7b348f54959ff27f997acd44b0b824700653f3335c99c2ba5c86390e
+  metadata.gz: ef5d1c817016b7d92dd47d0eca0090cc78da9dab98320099093807ff802bbbb87f5bc99c55aae143d6bc0da16e381549b503a6ef0d79144989f67764771afb75
+  data.tar.gz: 1dfcfbcc52339443436eb7a9653d2ba161bb7ee3c8bca649b82d17a681083cf251964c1c883874e64aa84f229f9823ab733ff772c2b7548ee4314b1503bb4934

data/README.md

@@ -269,8 +269,8 @@ dpkg -P chefdk
 [Berkshelf]: http://berkshelf.com "Berkshelf"
 [Chef]: https://www.chef.io "Chef"
 [ChefDK]: https://downloads.chef.io/chef-dk "Chef Development Kit"
-[Chef Documentation]: http://docs.chef.io "Chef Documentation"
+[Chef Documentation]: https://docs.chef.io "Chef Documentation"
 [ChefSpec]: http://chefspec.org "ChefSpec"
 [Foodcritic]: http://foodcritic.io "Foodcritic"
-[Learn Chef]: http://learn.chef.io "Learn Chef"
+[Learn Chef]: https://learn.chef.io "Learn Chef"
 [Test Kitchen]: http://kitchen.ci "Test Kitchen"

data/lib/chef-dk/builtin_commands.rb

@@ -46,5 +46,15 @@ ChefDK.commands do |c|
 
   c.builtin "export", :Export, desc: "Export a policy lock as a Chef Zero code repo"
 
+  c.builtin "clean-policy-revisions", :CleanPolicyRevisions, desc: "Delete unused policy revisions on the server"
+
+  c.builtin "clean-policy-cookbooks", :CleanPolicyCookbooks, desc: "Delete unused policyfile cookbooks on the server"
+
+  c.builtin "delete-policy-group", :DeletePolicyGroup, desc: "Delete a policy group on the server"
+
+  c.builtin "delete-policy", :DeletePolicy, desc: "Delete all revisions of a policy on the server"
+
+  c.builtin "undelete", :Undelete, desc: "Undo a delete command"
+
   c.builtin "verify", :Verify, desc: "Test the embedded ChefDK applications"
 end

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

@@ -56,8 +56,8 @@ module ChefDK
         else
           run(params)
         end
-      rescue OptionParser::InvalidOption => e
-        err(e.message)
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        err("ERROR: #{e.message}\n")
         msg(opt_parser)
         1
       end

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

@@ -0,0 +1,116 @@
+#
+# 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_services/clean_policy_cookbooks'
+
+module ChefDK
+  module Command
+
+
+    class CleanPolicyCookbooks < Base
+
+      banner(<<-BANNER)
+Usage: chef clean-policy-cookbooks [options]
+
+`chef clean-policy-cookbooks` deletes unused policyfile cookbooks. Cookbooks
+are considered unused when they are not referenced by any policyfile revision
+on the server. Note that cookbooks which are referenced by "orphaned" policy
+revisions are not removed, so you may wish to run `chef clean-policy-revisions`
+to remove orphaned policies before running this command.
+
+See our detailed README for more information:
+
+https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
+
+Options:
+
+BANNER
+
+      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
+        @ui = UI.new
+
+        @clean_policy_cookbooks_service = nil
+      end
+
+      def run(params)
+        return 1 unless apply_params!(params)
+        clean_policy_cookbooks_service.run
+        0
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def clean_policy_cookbooks_service
+        @clean_policy_cookbooks_service ||=
+          PolicyfileServices::CleanPolicyCookbooks.new(config: chef_config, ui: ui)
+      end
+
+      def debug?
+        !!config[:debug]
+      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?
+          ui.err("Too many arguments")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        else
+          true
+        end
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,113 @@
+#
+# 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_services/clean_policies'
+
+module ChefDK
+  module Command
+
+
+    class CleanPolicyRevisions < Base
+
+      banner(<<-BANNER)
+Usage: chef clean-policy-revisions [options]
+
+`chef clean-policy-revisions` deletes orphaned policyfile revisions from the Chef
+Server. Orphaned policyfile revisions are not associated to any group, and
+therefore not in active use by any nodes. To list orphaned policyfile revisions
+before deleting them, use `chef show-policy --orphans`.
+
+See our detailed README for more information:
+
+https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
+
+Options:
+
+BANNER
+
+      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
+        @ui = UI.new
+      end
+
+      def run(params)
+        return 1 unless apply_params!(params)
+        clean_policies_service.run
+        0
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def clean_policies_service
+        @policy_list_service ||=
+          PolicyfileServices::CleanPolicies.new(config: chef_config, ui: ui)
+      end
+
+      def debug?
+        !!config[:debug]
+      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?
+          ui.err("Too many arguments")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        else
+          true
+        end
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,122 @@
+#
+# 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_services/rm_policy'
+
+module ChefDK
+  module Command
+
+
+    class DeletePolicy < Base
+
+      banner(<<-BANNER)
+Usage: chef delete-policy POLICY_NAME [options]
+
+`chef delete-policy POLICY_NAME` deletes all revisions of the policy
+`POLICY_NAME` on the configured Chef Server. All policy revisions will be
+backed up locally, allowing you to undo this operation via the `chef undelete`
+command.
+
+See our detailed README for more information:
+
+https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
+
+Options:
+
+BANNER
+
+      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
+
+      def initialize(*args)
+        super
+        @policy_name = nil
+        @rm_policy_service = nil
+        @ui = UI.new
+      end
+
+      def run(params)
+        return 1 unless apply_params!(params)
+        rm_policy_service.run
+        ui.msg("This operation can be reversed by running `chef undelete --last`.")
+        0
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def rm_policy_service
+        @rm_policy_service ||=
+          PolicyfileServices::RmPolicy.new(config: chef_config,
+                                           ui: ui,
+                                           policy_name: policy_name)
+      end
+
+      def debug?
+        !!config[:debug]
+      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.size == 1
+          @policy_name = remaining_args.first
+          true
+        elsif remaining_args.empty?
+          ui.err("You must specify the POLICY_NAME to delete.")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        else
+          ui.err("Too many arguments")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        end
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,122 @@
+#
+# 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_services/rm_policy_group'
+
+module ChefDK
+  module Command
+
+
+    class DeletePolicyGroup < Base
+
+      banner(<<-BANNER)
+Usage: chef delete-policy-group POLICY_GROUP [options]
+
+`chef delete-policy-group POLICY_GROUP` deletes the policy group POLICY_GROUP on
+the configured Chef Server. Policy Revisions associated to the policy group are
+not deleted. The state of the policy group will be backed up locally, allowing
+you to undo this operation via the `chef undelete` command.
+
+See our detailed README for more information:
+
+https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
+
+Options:
+
+BANNER
+
+      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_group
+
+      def initialize(*args)
+        super
+        @policy_group = nil
+        @rm_policy_group_service = nil
+        @ui = UI.new
+      end
+
+      def run(params)
+        return 1 unless apply_params!(params)
+        rm_policy_group_service.run
+        ui.msg("This operation can be reversed by running `chef undelete --last`.")
+        0
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def rm_policy_group_service
+        @rm_policy_group_service ||=
+          PolicyfileServices::RmPolicyGroup.new(config: chef_config,
+                                             ui: ui,
+                                             policy_group: policy_group)
+      end
+
+      def debug?
+        !!config[:debug]
+      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.size == 1
+          @policy_group = remaining_args.first
+          true
+        elsif remaining_args.empty?
+          ui.err("You must specify the POLICY_GROUP to delete.")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        else
+          ui.err("Too many arguments")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        end
+      end
+
+    end
+  end
+end
+