knife 18.2.7 → 18.3.0

data/lib/chef/knife/configure.rb

@@ -1,150 +1,150 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) 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_relative "../knife"
-require "chef-utils/dist" unless defined?(ChefUtils::Dist)
-
-class Chef
-  class Knife
-    class Configure < Knife
-      attr_reader :chef_server, :new_client_name, :admin_client_name, :admin_client_key
-      attr_reader :chef_repo, :new_client_key, :validation_client_name, :validation_key
-
-      deps do
-        require "chef-config/path_helper" unless defined?(ChefConfig::PathHelper)
-        require_relative "client_create"
-        require_relative "user_create"
-        Chef::Knife::ClientCreate.load_deps
-        Chef::Knife::UserCreate.load_deps
-      end
-
-      banner "knife configure (options)"
-
-      option :repository,
-        short: "-r REPO",
-        long: "--repository REPO",
-        description: "The path to the chef-repo."
-
-      option :initial,
-        short: "-i",
-        long: "--initial",
-        boolean: true,
-        description: "Use to create a API client, typically an administrator client on a freshly-installed server."
-
-      option :admin_client_name,
-        long: "--admin-client-name NAME",
-        description: "The name of the client, typically the name of the admin client."
-
-      option :admin_client_key,
-        long: "--admin-client-key PATH",
-        description: "The path to the private key used by the client, typically a file named admin.pem."
-
-      option :validation_client_name,
-        long: "--validation-client-name NAME",
-        description: "The name of the validation client, typically a client named chef-validator."
-
-      option :validation_key,
-        long: "--validation-key PATH",
-        description: "The path to the validation key used by the client, typically a file named validation.pem."
-
-      def configure_chef
-        # We are just faking out the system so that you can do this without a key specified
-        Chef::Config[:node_name] = "woot"
-        super
-        Chef::Config[:node_name] = nil
-      end
-
-      def run
-        FileUtils.mkdir_p(chef_config_path)
-
-        ask_user_for_config
-
-        confirm("Overwrite #{config_file_path}") if ::File.exist?(config_file_path)
-
-        ::File.open(config_file_path, "w") do |f|
-          f.puts <<~EOH
-            [default]
-            client_name     = '#{new_client_name}'
-            client_key      = '#{new_client_key}'
-            chef_server_url = '#{chef_server}'
-          EOH
-        end
-
-        if config[:initial]
-          ui.msg("Creating initial API user...")
-          Chef::Config[:chef_server_url] = chef_server
-          Chef::Config[:node_name] = admin_client_name
-          Chef::Config[:client_key] = admin_client_key
-          user_create = Chef::Knife::UserCreate.new
-          user_create.name_args = [ new_client_name ]
-          user_create.config[:user_password] = config[:user_password] ||
-            ui.ask("Please enter a password for the new user: ", echo: false)
-          user_create.config[:admin] = true
-          user_create.config[:file] = new_client_key
-          user_create.config[:yes] = true
-          user_create.config[:disable_editing] = true
-          user_create.run
-        else
-          ui.msg("*****")
-          ui.msg("")
-          ui.msg("You must place your client key in:")
-          ui.msg("  #{new_client_key}")
-          ui.msg("Before running commands with Knife")
-          ui.msg("")
-          ui.msg("*****")
-        end
-
-        ui.msg("Knife configuration file written to #{config_file_path}")
-      end
-
-      def ask_user_for_config
-        server_name = guess_servername
-        @chef_server = config[:chef_server_url] || ask_question("Please enter the chef server URL: ", default: "https://#{server_name}/organizations/myorg")
-        if config[:initial]
-          @new_client_name        = config[:node_name] || ask_question("Please enter a name for the new user: ", default: Etc.getlogin)
-          @admin_client_name      = config[:admin_client_name] || ask_question("Please enter the existing admin name: ", default: "admin")
-          @admin_client_key       = config[:admin_client_key] || ask_question("Please enter the location of the existing admin's private key: ", default: "#{ChefUtils::Dist::Server::CONF_DIR}/admin.pem")
-          @admin_client_key       = File.expand_path(@admin_client_key)
-        else
-          @new_client_name = config[:node_name] || ask_question("Please enter an existing username or clientname for the API: ", default: Etc.getlogin)
-        end
-
-        @new_client_key = config[:client_key] || File.join(chef_config_path, "#{@new_client_name}.pem")
-        @new_client_key = File.expand_path(@new_client_key)
-      end
-
-      # @return [String] our best guess at what the servername should be using Ohai data and falling back to localhost
-      def guess_servername
-        require "ohai" unless defined?(Ohai::System)
-        o = Ohai::System.new
-        o.all_plugins(%w{ os hostname fqdn })
-        o[:fqdn] || o[:machinename] || o[:hostname] || "localhost"
-      end
-
-      # @return [String] the path to the user's .chef directory
-      def chef_config_path
-        @chef_config_path ||= ChefConfig::PathHelper.home(ChefUtils::Dist::Infra::USER_CONF_DIR)
-      end
-
-      # @return [String] the full path to the config file (credential file)
-      def config_file_path
-        @config_file_path ||= ::File.expand_path(::File.join(chef_config_path, "credentials"))
-      end
-    end
-  end
-end
+#
+# Author:: Adam Jacob (<adam@chef.io>)
+# Copyright:: Copyright (c) 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_relative "../knife"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
+
+class Chef
+  class Knife
+    class Configure < Knife
+      attr_reader :chef_server, :new_client_name, :admin_client_name, :admin_client_key
+      attr_reader :chef_repo, :new_client_key, :validation_client_name, :validation_key
+
+      deps do
+        require "chef-config/path_helper" unless defined?(ChefConfig::PathHelper)
+        require_relative "client_create"
+        require_relative "user_create"
+        Chef::Knife::ClientCreate.load_deps
+        Chef::Knife::UserCreate.load_deps
+      end
+
+      banner "knife configure (options)"
+
+      option :repository,
+        short: "-r REPO",
+        long: "--repository REPO",
+        description: "The path to the chef-repo."
+
+      option :initial,
+        short: "-i",
+        long: "--initial",
+        boolean: true,
+        description: "Use to create a API client, typically an administrator client on a freshly-installed server."
+
+      option :admin_client_name,
+        long: "--admin-client-name NAME",
+        description: "The name of the client, typically the name of the admin client."
+
+      option :admin_client_key,
+        long: "--admin-client-key PATH",
+        description: "The path to the private key used by the client, typically a file named admin.pem."
+
+      option :validation_client_name,
+        long: "--validation-client-name NAME",
+        description: "The name of the validation client, typically a client named chef-validator."
+
+      option :validation_key,
+        long: "--validation-key PATH",
+        description: "The path to the validation key used by the client, typically a file named validation.pem."
+
+      def configure_chef
+        # We are just faking out the system so that you can do this without a key specified
+        Chef::Config[:node_name] = "woot"
+        super
+        Chef::Config[:node_name] = nil
+      end
+
+      def run
+        FileUtils.mkdir_p(chef_config_path)
+
+        ask_user_for_config
+
+        confirm("Overwrite #{config_file_path}") if ::File.exist?(config_file_path)
+
+        ::File.open(config_file_path, "w") do |f|
+          f.puts <<~EOH
+            [default]
+            client_name     = '#{new_client_name}'
+            client_key      = '#{new_client_key}'
+            chef_server_url = '#{chef_server}'
+          EOH
+        end
+
+        if config[:initial]
+          ui.msg("Creating initial API user...")
+          Chef::Config[:chef_server_url] = chef_server
+          Chef::Config[:node_name] = admin_client_name
+          Chef::Config[:client_key] = admin_client_key
+          user_create = Chef::Knife::UserCreate.new
+          user_create.name_args = [ new_client_name ]
+          user_create.config[:user_password] = config[:user_password] ||
+            ui.ask("Please enter a password for the new user: ", echo: false)
+          user_create.config[:admin] = true
+          user_create.config[:file] = new_client_key
+          user_create.config[:yes] = true
+          user_create.config[:disable_editing] = true
+          user_create.run
+        else
+          ui.msg("*****")
+          ui.msg("")
+          ui.msg("You must place your client key in:")
+          ui.msg("  #{new_client_key}")
+          ui.msg("Before running commands with Knife")
+          ui.msg("")
+          ui.msg("*****")
+        end
+
+        ui.msg("Knife configuration file written to #{config_file_path}")
+      end
+
+      def ask_user_for_config
+        server_name = guess_servername
+        @chef_server = config[:chef_server_url] || ask_question("Please enter the chef server URL: ", default: "https://#{server_name}/organizations/myorg")
+        if config[:initial]
+          @new_client_name        = config[:node_name] || ask_question("Please enter a name for the new user: ", default: Etc.getlogin)
+          @admin_client_name      = config[:admin_client_name] || ask_question("Please enter the existing admin name: ", default: "admin")
+          @admin_client_key       = config[:admin_client_key] || ask_question("Please enter the location of the existing admin's private key: ", default: "#{ChefUtils::Dist::Server::CONF_DIR}/admin.pem")
+          @admin_client_key       = File.expand_path(@admin_client_key)
+        else
+          @new_client_name = config[:node_name] || ask_question("Please enter an existing username or clientname for the API: ", default: Etc.getlogin)
+        end
+
+        @new_client_key = config[:client_key] || File.join(chef_config_path, "#{@new_client_name}.pem")
+        @new_client_key = File.expand_path(@new_client_key)
+      end
+
+      # @return [String] our best guess at what the servername should be using Ohai data and falling back to localhost
+      def guess_servername
+        require "ohai" unless defined?(Ohai::System)
+        o = Ohai::System.new
+        o.all_plugins(%w{ os hostname fqdn })
+        o[:fqdn] || o[:machinename] || o[:hostname] || "localhost"
+      end
+
+      # @return [String] the path to the user's .chef directory
+      def chef_config_path
+        @chef_config_path ||= ChefConfig::PathHelper.home(ChefUtils::Dist::Infra::USER_CONF_DIR)
+      end
+
+      # @return [String] the full path to the config file (credential file)
+      def config_file_path
+        @config_file_path ||= ::File.expand_path(::File.join(chef_config_path, "credentials"))
+      end
+    end
+  end
+end

data/lib/chef/knife/configure_client.rb

@@ -1,48 +1,48 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) 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_relative "../knife"
-
-class Chef
-  class Knife
-    class ConfigureClient < Knife
-      banner "knife configure client DIRECTORY"
-
-      def run
-        unless @config_dir = @name_args[0]
-          ui.fatal "You must provide the directory to put the files in"
-          show_usage
-          exit(1)
-        end
-
-        ui.info("Creating client configuration")
-        FileUtils.mkdir_p(@config_dir)
-        ui.info("Writing client.rb")
-        File.open(File.join(@config_dir, "client.rb"), "w") do |file|
-          file.puts("chef_server_url  '#{Chef::Config[:chef_server_url]}'")
-          file.puts("validation_client_name '#{Chef::Config[:validation_client_name]}'")
-        end
-        ui.info("Writing validation.pem")
-        File.open(File.join(@config_dir, "validation.pem"), "w") do |validation|
-          validation.puts(IO.read(Chef::Config[:validation_key]))
-        end
-      end
-
-    end
-  end
-end
+#
+# Author:: Adam Jacob (<adam@chef.io>)
+# Copyright:: Copyright (c) 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_relative "../knife"
+
+class Chef
+  class Knife
+    class ConfigureClient < Knife
+      banner "knife configure client DIRECTORY"
+
+      def run
+        unless @config_dir = @name_args[0]
+          ui.fatal "You must provide the directory to put the files in"
+          show_usage
+          exit(1)
+        end
+
+        ui.info("Creating client configuration")
+        FileUtils.mkdir_p(@config_dir)
+        ui.info("Writing client.rb")
+        File.open(File.join(@config_dir, "client.rb"), "w") do |file|
+          file.puts("chef_server_url  '#{Chef::Config[:chef_server_url]}'")
+          file.puts("validation_client_name '#{Chef::Config[:validation_client_name]}'")
+        end
+        ui.info("Writing validation.pem")
+        File.open(File.join(@config_dir, "validation.pem"), "w") do |validation|
+          validation.puts(IO.read(Chef::Config[:validation_key]))
+        end
+      end
+
+    end
+  end
+end

data/lib/chef/knife/cookbook_bulk_delete.rb

@@ -1,71 +1,71 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright (c) 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_relative "../knife"
-
-class Chef
-  class Knife
-    class CookbookBulkDelete < Knife
-
-      deps do
-        require_relative "cookbook_delete"
-        require "chef/cookbook_version" unless defined?(Chef::CookbookVersion)
-      end
-
-      option :purge, short: "-p", long: "--purge", boolean: true, description: "Permanently remove files from backing data store."
-
-      banner "knife cookbook bulk delete REGEX (options)"
-
-      def run
-        unless regex_str = @name_args.first
-          ui.fatal("You must supply a regular expression to match the results against")
-          exit 42
-        end
-
-        regex = Regexp.new(regex_str)
-
-        all_cookbooks = Chef::CookbookVersion.list
-        cookbooks_names = all_cookbooks.keys.grep(regex)
-        cookbooks_to_delete = cookbooks_names.inject({}) { |hash, name| hash[name] = all_cookbooks[name]; hash }
-        ui.msg "All versions of the following cookbooks will be deleted:"
-        ui.msg ""
-        ui.msg ui.list(cookbooks_to_delete.keys.sort, :columns_down)
-        ui.msg ""
-
-        unless config[:yes]
-          ui.confirm("Do you really want to delete these cookbooks")
-
-          if config[:purge]
-            ui.msg("Files that are common to multiple cookbooks are shared, so purging the files may break other cookbooks.")
-            ui.confirm("Are you sure you want to purge files instead of just deleting the cookbooks")
-          end
-          ui.msg ""
-        end
-
-        cookbooks_names.each do |cookbook_name|
-          versions = rest.get("cookbooks/#{cookbook_name}")[cookbook_name]["versions"].map { |v| v["version"] }.flatten
-          versions.each do |version|
-            rest.delete("cookbooks/#{cookbook_name}/#{version}#{config[:purge] ? "?purge=true" : ""}")
-            ui.info("Deleted cookbook  #{cookbook_name.ljust(25)} [#{version}]")
-          end
-        end
-      end
-    end
-  end
-end
+#
+# Author:: Adam Jacob (<adam@chef.io>)
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright (c) 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_relative "../knife"
+
+class Chef
+  class Knife
+    class CookbookBulkDelete < Knife
+
+      deps do
+        require_relative "cookbook_delete"
+        require "chef/cookbook_version" unless defined?(Chef::CookbookVersion)
+      end
+
+      option :purge, short: "-p", long: "--purge", boolean: true, description: "Permanently remove files from backing data store."
+
+      banner "knife cookbook bulk delete REGEX (options)"
+
+      def run
+        unless regex_str = @name_args.first
+          ui.fatal("You must supply a regular expression to match the results against")
+          exit 42
+        end
+
+        regex = Regexp.new(regex_str)
+
+        all_cookbooks = Chef::CookbookVersion.list
+        cookbooks_names = all_cookbooks.keys.grep(regex)
+        cookbooks_to_delete = cookbooks_names.inject({}) { |hash, name| hash[name] = all_cookbooks[name]; hash }
+        ui.msg "All versions of the following cookbooks will be deleted:"
+        ui.msg ""
+        ui.msg ui.list(cookbooks_to_delete.keys.sort, :columns_down)
+        ui.msg ""
+
+        unless config[:yes]
+          ui.confirm("Do you really want to delete these cookbooks")
+
+          if config[:purge]
+            ui.msg("Files that are common to multiple cookbooks are shared, so purging the files may break other cookbooks.")
+            ui.confirm("Are you sure you want to purge files instead of just deleting the cookbooks")
+          end
+          ui.msg ""
+        end
+
+        cookbooks_names.each do |cookbook_name|
+          versions = rest.get("cookbooks/#{cookbook_name}")[cookbook_name]["versions"].map { |v| v["version"] }.flatten
+          versions.each do |version|
+            rest.delete("cookbooks/#{cookbook_name}/#{version}#{config[:purge] ? "?purge=true" : ""}")
+            ui.info("Deleted cookbook  #{cookbook_name.ljust(25)} [#{version}]")
+          end
+        end
+      end
+    end
+  end
+end