File Manager

Viewing File: cookbook_metadata.rb

#
# 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_relative "../cookbook_loader"
        require_relative "../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.exists?(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