Class: Chef::Knife::YamlConvert

Inherits:
Chef::Knife show all
Defined in:
lib/chef/knife/yaml_convert.rb

Constant Summary

Constants inherited from Chef::Knife

CHEF_ORGANIZATION_MANAGEMENT, KNIFE_ROOT, OFFICIAL_PLUGINS, OPSCODE_HOSTED_CHEF_ACCESS_CONTROL, VERSION

Instance Attribute Summary

Attributes inherited from Chef::Knife

#name_args, #ui

Instance Method Summary collapse

Methods inherited from Chef::Knife

#api_key, #apply_computed_config, category, chef_config_dir, common_name, #config_file_defaults, #config_file_settings, config_loader, #config_source, #configure_chef, #create_object, #delete_object, dependency_loaders, deps, #format_rest_error, guess_category, #humanize_exception, #humanize_http_exception, inherited, #initialize, list_commands, load_commands, load_config, load_deps, #maybe_setup_fips, #merge_configs, msg, #noauth_rest, #parse_options, reset_config_loader!, reset_subcommands!, #rest, #root_rest, run, #run_with_pretty_exceptions, #server_url, #show_usage, snake_case_name, subcommand_category, subcommand_class_from, subcommand_files, subcommand_loader, subcommands, subcommands_by_category, #test_mandatory_field, ui, unnamed?, use_separate_defaults?, #username

Constructor Details

This class inherits a constructor from Chef::Knife

Instance Method Details

#resource_hash_to_string(resource_hash, filename) ⇒ Object

Converts a Hash of resources to a Ruby recipe returns a string ready to be written to a file or stdout



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/chef/knife/yaml_convert.rb', line 74

def resource_hash_to_string(resource_hash, filename)
  ruby_contents = []
  ruby_contents << "# Autoconverted recipe from #{filename}\n"

  resource_hash.each do |r|
    type = r.delete("type")
    name = r.delete("name")

    ruby_contents << "#{type} \"#{name}\" do"
    r.each do |k, v|
      ruby_contents << "  #{k} #{v.inspect}"
    end
    ruby_contents << "end\n"
  end

  ruby_contents.join("\n")
end

#run ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/chef/knife/yaml_convert.rb', line 25

def run
  if name_args.empty?
    ui.fatal!("Please specify the file name of a YAML recipe to convert to Ruby")
  elsif name_args.size >= 3
    ui.fatal!("knife yaml convert YAML_FILENAME [RUBY_FILENAME]")
  end

  yaml_file = @name_args[0]
  unless ::File.exist?(yaml_file) && ::File.readable?(yaml_file)
    ui.fatal("Input YAML file '#{yaml_file}' does not exist or is unreadable")
  end

  ruby_file = if @name_args[1]
                @name_args[1] # use the specified output filename if provided
              else
                if ::File.extname(yaml_file) == ".yml" || ::File.extname(yaml_file) == ".yaml"
                  yaml_file.gsub(/\.(yml|yaml)$/, ".rb")
                else
                  yaml_file + ".rb" # fall back to putting .rb on the end of whatever the yaml file was named
                end
              end

  if ::File.exist?(ruby_file)
    ui.fatal!("Output Ruby file '#{ruby_file}' already exists")
  end

  yaml_contents = IO.read(yaml_file)

  # YAML can contain multiple documents (--- is the separator), let's not support that.
  if ::YAML.load_stream(yaml_contents).length > 1
    ui.fatal!("YAML recipe '#{yaml_file}' contains multiple documents, only one is supported")
  end

  # Unfortunately, per the YAML spec, comments are stripped when we load, so we lose them on conversion
  yaml_hash = ::YAML.safe_load(yaml_contents, permitted_classes: [Symbol])
  unless yaml_hash.is_a?(Hash) && yaml_hash.key?("resources")
    ui.fatal!("YAML recipe '#{source_file}' must contain a top-level 'resources' hash (YAML sequence), i.e. 'resources:'")
  end

  ui.warn("No resources found in '#{yaml_file}'") if yaml_hash["resources"].size == 0

  ::File.open(ruby_file, "w") do |file|
    file.write(resource_hash_to_string(yaml_hash["resources"], yaml_file))
  end
  ui.info("Converted '#{yaml_file}' to '#{ruby_file}'")
end