Class: Chef::Knife::UserDelete

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

#delete_object(user_name) ⇒ Object

DEPRECATION NOTE Delete this override method after OSC 11 support is dropped



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/chef/knife/user_delete.rb', line 54

def delete_object(user_name)
  confirm("Do you really want to delete #{user_name}")

  if Kernel.block_given?
    object = block.call
  else
    object = Chef::UserV1.load(user_name)
    object.destroy
  end

  output(format_for_display(object)) if config[:print_after]
  msg("Deleted #{user_name}")
end

#osc_11_warning ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/chef/knife/user_delete.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 delete for Open Source 11 Server is being deprecated.
Open Source 11 Server user commands now live under the knife osc_user namespace.
For backwards compatibility, we will forward this request to knife osc_user delete.
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 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/chef/knife/user_delete.rb', line 68

def run
  @user_name = @name_args[0]

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

  # DEPRECATION NOTE
  #
  # Below is modification of Chef::Knife.delete_object to detect OSC 11 server.
  # When OSC 11 is deprecated, simply delete all this and go back to:
  #
  # delete_object(Chef::UserV1, @user_name)
  #
  # Also delete our override of delete_object above
  object = Chef::UserV1.load(@user_name)

  # OSC 11 case
  if object.username.nil?
    ui.warn(osc_11_warning)
    run_osc_11_user_delete
  else # proceed with EC / CS delete
    delete_object(@user_name)
  end
end

#run_osc_11_user_delete ⇒ Object 



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

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