knife 18.2.7 → 18.3.0

data/lib/chef/knife/cookbook_list.rb

@@ -1,47 +1,47 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Author:: Nuo Yan (<nuo@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 CookbookList < Knife
-
-      banner "knife cookbook list (options)"
-
-      option :with_uri,
-        short: "-w",
-        long: "--with-uri",
-        description: "Show corresponding URIs."
-
-      option :all_versions,
-        short: "-a",
-        long: "--all",
-        description: "Show all available versions."
-
-      def run
-        env          = config[:environment]
-        num_versions = config[:all_versions] ? "num_versions=all" : "num_versions=1"
-        api_endpoint = env ? "/environments/#{env}/cookbooks?#{num_versions}" : "/cookbooks?#{num_versions}"
-        cookbook_versions = rest.get(api_endpoint)
-        ui.output(format_cookbook_list_for_display(cookbook_versions))
-      end
-    end
-  end
-end
+#
+# Author:: Adam Jacob (<adam@chef.io>)
+# Author:: Nuo Yan (<nuo@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 CookbookList < Knife
+
+      banner "knife cookbook list (options)"
+
+      option :with_uri,
+        short: "-w",
+        long: "--with-uri",
+        description: "Show corresponding URIs."
+
+      option :all_versions,
+        short: "-a",
+        long: "--all",
+        description: "Show all available versions."
+
+      def run
+        env          = config[:environment]
+        num_versions = config[:all_versions] ? "num_versions=all" : "num_versions=1"
+        api_endpoint = env ? "/environments/#{env}/cookbooks?#{num_versions}" : "/cookbooks?#{num_versions}"
+        cookbook_versions = rest.get(api_endpoint)
+        ui.output(format_cookbook_list_for_display(cookbook_versions))
+      end
+    end
+  end
+end

data/lib/chef/knife/cookbook_metadata.rb

@@ -1,106 +1,106 @@
-#
-# 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 CookbookMetadata < Knife
-
-      deps do
-        require "chef/cookbook_loader" unless defined?(Chef::CookbookLoader)
-        require "chef/cookbook/metadata" unless defined?(Chef::Cookbook::Metadata)
-      end
-
-      banner "knife cookbook metadata COOKBOOK (options)"
-
-      option :cookbook_path,
-        short: "-o PATH:PATH",
-        long: "--cookbook-path PATH:PATH",
-        description: "A colon-separated path to look for cookbooks in.",
-        proc: lambda { |o| o.split(":") }
-
-      option :all,
-        short: "-a",
-        long: "--all",
-        description: "Generate metadata for all cookbooks, rather than just a single cookbook."
-
-      def run
-        config[:cookbook_path] ||= Chef::Config[:cookbook_path]
-
-        if config[:all]
-          cl = Chef::CookbookLoader.new(config[:cookbook_path])
-          cl.load_cookbooks
-          cl.each_key do |cname|
-            generate_metadata(cname.to_s)
-          end
-        else
-          cookbook_name = @name_args[0]
-          if cookbook_name.nil? || cookbook_name.empty?
-            ui.error "You must specify the cookbook to generate metadata for, or use the --all option."
-            exit 1
-          end
-          generate_metadata(cookbook_name)
-        end
-      end
-
-      def generate_metadata(cookbook)
-        Array(config[:cookbook_path]).reverse_each do |path|
-          file = File.expand_path(File.join(path, cookbook, "metadata.rb"))
-          if File.exist?(file)
-            generate_metadata_from_file(cookbook, file)
-          else
-            validate_metadata_json(path, cookbook)
-          end
-        end
-      end
-
-      def generate_metadata_from_file(cookbook, file)
-        ui.info("Generating metadata for #{cookbook} from #{file}")
-        md = Chef::Cookbook::Metadata.new
-        md.name(cookbook)
-        md.from_file(file)
-        json_file = File.join(File.dirname(file), "metadata.json")
-        File.open(json_file, "w") do |f|
-          f.write(Chef::JSONCompat.to_json_pretty(md))
-        end
-        Chef::Log.trace("Generated #{json_file}")
-      rescue Exceptions::ObsoleteDependencySyntax, Exceptions::InvalidVersionConstraint => e
-        ui.stderr.puts "ERROR: The cookbook '#{cookbook}' contains invalid or obsolete metadata syntax."
-        ui.stderr.puts "in #{file}:"
-        ui.stderr.puts
-        ui.stderr.puts e.message
-        exit 1
-      end
-
-      def validate_metadata_json(path, cookbook)
-        json_file = File.join(path, cookbook, "metadata.json")
-        if File.exist?(json_file)
-          Chef::Cookbook::Metadata.validate_json(IO.read(json_file))
-        end
-      rescue Exceptions::ObsoleteDependencySyntax, Exceptions::InvalidVersionConstraint => e
-        ui.stderr.puts "ERROR: The cookbook '#{cookbook}' contains invalid or obsolete metadata syntax."
-        ui.stderr.puts "in #{json_file}:"
-        ui.stderr.puts
-        ui.stderr.puts e.message
-        exit 1
-      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 CookbookMetadata < Knife
+
+      deps do
+        require "chef/cookbook_loader" unless defined?(Chef::CookbookLoader)
+        require "chef/cookbook/metadata" unless defined?(Chef::Cookbook::Metadata)
+      end
+
+      banner "knife cookbook metadata COOKBOOK (options)"
+
+      option :cookbook_path,
+        short: "-o PATH:PATH",
+        long: "--cookbook-path PATH:PATH",
+        description: "A colon-separated path to look for cookbooks in.",
+        proc: lambda { |o| o.split(":") }
+
+      option :all,
+        short: "-a",
+        long: "--all",
+        description: "Generate metadata for all cookbooks, rather than just a single cookbook."
+
+      def run
+        config[:cookbook_path] ||= Chef::Config[:cookbook_path]
+
+        if config[:all]
+          cl = Chef::CookbookLoader.new(config[:cookbook_path])
+          cl.load_cookbooks
+          cl.each_key do |cname|
+            generate_metadata(cname.to_s)
+          end
+        else
+          cookbook_name = @name_args[0]
+          if cookbook_name.nil? || cookbook_name.empty?
+            ui.error "You must specify the cookbook to generate metadata for, or use the --all option."
+            exit 1
+          end
+          generate_metadata(cookbook_name)
+        end
+      end
+
+      def generate_metadata(cookbook)
+        Array(config[:cookbook_path]).reverse_each do |path|
+          file = File.expand_path(File.join(path, cookbook, "metadata.rb"))
+          if File.exist?(file)
+            generate_metadata_from_file(cookbook, file)
+          else
+            validate_metadata_json(path, cookbook)
+          end
+        end
+      end
+
+      def generate_metadata_from_file(cookbook, file)
+        ui.info("Generating metadata for #{cookbook} from #{file}")
+        md = Chef::Cookbook::Metadata.new
+        md.name(cookbook)
+        md.from_file(file)
+        json_file = File.join(File.dirname(file), "metadata.json")
+        File.open(json_file, "w") do |f|
+          f.write(Chef::JSONCompat.to_json_pretty(md))
+        end
+        Chef::Log.trace("Generated #{json_file}")
+      rescue Exceptions::ObsoleteDependencySyntax, Exceptions::InvalidVersionConstraint => e
+        ui.stderr.puts "ERROR: The cookbook '#{cookbook}' contains invalid or obsolete metadata syntax."
+        ui.stderr.puts "in #{file}:"
+        ui.stderr.puts
+        ui.stderr.puts e.message
+        exit 1
+      end
+
+      def validate_metadata_json(path, cookbook)
+        json_file = File.join(path, cookbook, "metadata.json")
+        if File.exist?(json_file)
+          Chef::Cookbook::Metadata.validate_json(IO.read(json_file))
+        end
+      rescue Exceptions::ObsoleteDependencySyntax, Exceptions::InvalidVersionConstraint => e
+        ui.stderr.puts "ERROR: The cookbook '#{cookbook}' contains invalid or obsolete metadata syntax."
+        ui.stderr.puts "in #{json_file}:"
+        ui.stderr.puts
+        ui.stderr.puts e.message
+        exit 1
+      end
+
+    end
+  end
+end

data/lib/chef/knife/cookbook_metadata_from_file.rb

@@ -1,49 +1,49 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Author:: Matthew Kent (<mkent@magoazul.com>)
-# Copyright:: Copyright (c) Chef Software Inc.
-# Copyright:: Copyright 2010-2016, Matthew Kent
-# 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 CookbookMetadataFromFile < Knife
-
-      deps do
-        require "chef/cookbook/metadata" unless defined?(Chef::Cookbook::Metadata)
-      end
-
-      banner "knife cookbook metadata from file FILE (options)"
-
-      def run
-        if @name_args.length < 1
-          show_usage
-          ui.fatal("You must specify the FILE.")
-          exit(1)
-        end
-
-        file = @name_args[0]
-        cookbook = File.basename(File.dirname(file))
-
-        @metadata = Chef::Knife::CookbookMetadata.new
-        @metadata.generate_metadata_from_file(cookbook, file)
-      end
-
-    end
-  end
-end
+#
+# Author:: Adam Jacob (<adam@chef.io>)
+# Author:: Matthew Kent (<mkent@magoazul.com>)
+# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright 2010-2016, Matthew Kent
+# 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 CookbookMetadataFromFile < Knife
+
+      deps do
+        require "chef/cookbook/metadata" unless defined?(Chef::Cookbook::Metadata)
+      end
+
+      banner "knife cookbook metadata from file FILE (options)"
+
+      def run
+        if @name_args.length < 1
+          show_usage
+          ui.fatal("You must specify the FILE.")
+          exit(1)
+        end
+
+        file = @name_args[0]
+        cookbook = File.basename(File.dirname(file))
+
+        @metadata = Chef::Knife::CookbookMetadata.new
+        @metadata.generate_metadata_from_file(cookbook, file)
+      end
+
+    end
+  end
+end

data/lib/chef/knife/cookbook_show.rb

@@ -1,98 +1,98 @@
-#
-# 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 CookbookShow < Knife
-
-      deps do
-        require "chef/json_compat" unless defined?(Chef::JSONCompat)
-        require "uri" unless defined?(URI)
-        require "chef/cookbook_version" unless defined?(Chef::CookbookVersion)
-      end
-
-      banner "knife cookbook show COOKBOOK [VERSION] [PART] [FILENAME] (options)"
-
-      option :fqdn,
-        short: "-f FQDN",
-        long: "--fqdn FQDN",
-        description: "The FQDN of the host to see the file for."
-
-      option :platform,
-        short: "-p PLATFORM",
-        long: "--platform PLATFORM",
-        description: "The platform to see the file for."
-
-      option :platform_version,
-        short: "-V VERSION",
-        long: "--platform-version VERSION",
-        description: "The platform version to see the file for."
-
-      option :with_uri,
-        short: "-w",
-        long: "--with-uri",
-        description: "Show corresponding URIs."
-
-      def run
-        cookbook_name, cookbook_version, segment, filename = @name_args
-
-        cookbook = Chef::CookbookVersion.load(cookbook_name, cookbook_version) unless cookbook_version.nil?
-
-        case @name_args.length
-        when 4 # We are showing a specific file
-          node = {}
-          node[:fqdn] = config[:fqdn] if config.key?(:fqdn)
-          node[:platform] = config[:platform] if config.key?(:platform)
-          node[:platform_version] = config[:platform_version] if config.key?(:platform_version)
-
-          class << node
-            def attribute?(name) # rubocop:disable Lint/NestedMethodDefinition
-              key?(name)
-            end
-          end
-
-          manifest_entry = cookbook.preferred_manifest_record(node, segment, filename)
-          temp_file = rest.streaming_request(manifest_entry[:url])
-
-          # the temp file is cleaned up elsewhere
-          temp_file.open if temp_file.closed?
-          pretty_print(temp_file.read)
-
-        when 3 # We are showing a specific part of the cookbook
-          if segment == "metadata"
-            output(cookbook.metadata)
-          else
-            output(cookbook.files_for(segment))
-          end
-        when 2 # We are showing the whole cookbook
-          output(cookbook.display)
-        when 1 # We are showing the cookbook versions (all of them)
-          env           = config[:environment]
-          api_endpoint  = env ? "environments/#{env}/cookbooks/#{cookbook_name}" : "cookbooks/#{cookbook_name}"
-          output(format_cookbook_list_for_display(rest.get(api_endpoint)))
-        when 0
-          show_usage
-          ui.fatal("You must specify a cookbook name")
-          exit 1
-        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 CookbookShow < Knife
+
+      deps do
+        require "chef/json_compat" unless defined?(Chef::JSONCompat)
+        require "uri" unless defined?(URI)
+        require "chef/cookbook_version" unless defined?(Chef::CookbookVersion)
+      end
+
+      banner "knife cookbook show COOKBOOK [VERSION] [PART] [FILENAME] (options)"
+
+      option :fqdn,
+        short: "-f FQDN",
+        long: "--fqdn FQDN",
+        description: "The FQDN of the host to see the file for."
+
+      option :platform,
+        short: "-p PLATFORM",
+        long: "--platform PLATFORM",
+        description: "The platform to see the file for."
+
+      option :platform_version,
+        short: "-V VERSION",
+        long: "--platform-version VERSION",
+        description: "The platform version to see the file for."
+
+      option :with_uri,
+        short: "-w",
+        long: "--with-uri",
+        description: "Show corresponding URIs."
+
+      def run
+        cookbook_name, cookbook_version, segment, filename = @name_args
+
+        cookbook = Chef::CookbookVersion.load(cookbook_name, cookbook_version) unless cookbook_version.nil?
+
+        case @name_args.length
+        when 4 # We are showing a specific file
+          node = {}
+          node[:fqdn] = config[:fqdn] if config.key?(:fqdn)
+          node[:platform] = config[:platform] if config.key?(:platform)
+          node[:platform_version] = config[:platform_version] if config.key?(:platform_version)
+
+          class << node
+            def attribute?(name) # rubocop:disable Lint/NestedMethodDefinition
+              key?(name)
+            end
+          end
+
+          manifest_entry = cookbook.preferred_manifest_record(node, segment, filename)
+          temp_file = rest.streaming_request(manifest_entry[:url])
+
+          # the temp file is cleaned up elsewhere
+          temp_file.open if temp_file.closed?
+          pretty_print(temp_file.read)
+
+        when 3 # We are showing a specific part of the cookbook
+          if segment == "metadata"
+            output(cookbook.metadata)
+          else
+            output(cookbook.files_for(segment))
+          end
+        when 2 # We are showing the whole cookbook
+          output(cookbook.display)
+        when 1 # We are showing the cookbook versions (all of them)
+          env           = config[:environment]
+          api_endpoint  = env ? "environments/#{env}/cookbooks/#{cookbook_name}" : "cookbooks/#{cookbook_name}"
+          output(format_cookbook_list_for_display(rest.get(api_endpoint)))
+        when 0
+          show_usage
+          ui.fatal("You must specify a cookbook name")
+          exit 1
+        end
+      end
+    end
+  end
+end