Class: Chef::Knife::UserEdit

Inherits:
Chef::Knife show all
Defined in:
lib/chef/knife/user_edit.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

#osc_11_warning ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/chef/knife/user_edit.rb', line 32

def osc_11_warning
  <<-EOF
The Chef Server you are using does not support the username field.
This means it is an Open Source 11 Server.
knife user edit for Open Source 11 Server is being deprecated.
Open Source 11 Server user commands now live under the knife oc_user namespace.
For backwards compatibility, we will forward this request to knife osc_user edit.
If you are using an Open Source 11 Server, please use that command to avoid this warning.
NOTE: Backwards compatibility for Open Source 11 Server in these commands will be removed
in Chef 15 which will be released April 2019.
EOF
end

#run ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/chef/knife/user_edit.rb', line 52

def run
  @user_name = @name_args[0]

  if @user_name.nil?
    show_usage
    ui.fatal("You must specify a user name")
    exit 1
  end

  original_user = Chef::UserV1.load(@user_name).to_hash
  # DEPRECATION NOTE
  # Remove this if statement and corrosponding code post OSC 11 support.
  #
  # if username is nil, we are in the OSC 11 case,
  # forward to deprecated command
  if original_user["username"].nil?
    ui.warn(osc_11_warning)
    run_osc_11_user_edit
  else # EC / CS 12 user create
    edited_user = edit_hash(original_user)
    if original_user != edited_user
      user = Chef::UserV1.from_hash(edited_user)
      user.update
      ui.msg("Saved #{user}.")
    else
      ui.msg("User unchanged, not saving.")
    end
  end
end

#run_osc_11_user_edit ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/chef/knife/user_edit.rb', line 45

def run_osc_11_user_edit
  # run osc_user_create with our input
  ARGV.delete("user")
  ARGV.unshift("osc_user")
  Chef::Knife.run(ARGV, Chef::Application::Knife.options)
end