Class: Chef::Knife::Rehash

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

Constant Summary

Constants inherited from Chef::Knife

OFFICIAL_PLUGINS

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, #cli_keys, common_name, #config_file_settings, config_loader, #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, 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

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #normalize_snake_case_name, #snake_case_basename

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Constructor Details

This class inherits a constructor from Chef::Knife

Instance Method Details

#generate_hashObject


44
45
46
47
48
49
50
51
52
53
# File 'lib/chef/knife/rehash.rb', line 44

def generate_hash
  output = if Chef::Knife::SubcommandLoader.plugin_manifest?
             Chef::Knife::SubcommandLoader.plugin_manifest
           else
             { Chef::Knife::SubcommandLoader::HashedCommandLoader::KEY => {} }
           end
  output[Chef::Knife::SubcommandLoader::HashedCommandLoader::KEY]["plugins_paths"] = Chef::Knife.subcommand_files
  output[Chef::Knife::SubcommandLoader::HashedCommandLoader::KEY]["plugins_by_category"] = Chef::Knife.subcommands_by_category
  output
end

#reload_pluginsObject


37
38
39
40
41
42
# File 'lib/chef/knife/rehash.rb', line 37

def reload_plugins
  # The subcommand_loader for this knife command should _always_ be the GemGlobLoader.  The GemGlobLoader loads
  # plugins from disc and ensures the hash we write is always correct.  By this point it should also already have
  # loaded plugins and `load_commands` shouldn't have an effect.
  Chef::Knife.subcommand_loader.load_commands
end

#runObject


27
28
29
30
31
32
33
34
35
# File 'lib/chef/knife/rehash.rb', line 27

def run
  if ! Chef::Knife::SubcommandLoader.autogenerated_manifest?
    ui.msg "Using knife-rehash will speed up knife's load time by caching the location of subcommands on disk."
    ui.msg "However, you will need to update the cache by running `knife rehash` anytime you install a new knife plugin."
  else
    reload_plugins
  end
  write_hash(generate_hash)
end

#write_hash(data) ⇒ Object


55
56
57
58
59
60
61
62
# File 'lib/chef/knife/rehash.rb', line 55

def write_hash(data)
  plugin_manifest_dir = File.expand_path("..", Chef::Knife::SubcommandLoader.plugin_manifest_path)
  FileUtils.mkdir_p(plugin_manifest_dir) unless File.directory?(plugin_manifest_dir)
  File.open(Chef::Knife::SubcommandLoader.plugin_manifest_path, "w") do |f|
    f.write(Chef::JSONCompat.to_json_pretty(data))
    ui.msg "Knife subcommands are cached in #{Chef::Knife::SubcommandLoader.plugin_manifest_path}. Delete this file to disable the caching."
  end
end