mtncloud-cli 1.0.0

data/lib/mtncloud/cli/commands/log_settings_command.rb

@@ -0,0 +1,443 @@
+require 'mtncloud/cli/cli_command'
+
+class MtnCloud::Cli::LogSettingsCommand
+  include MtnCloud::Cli::CliCommand
+  include MtnCloud::Cli::AccountsHelper
+
+  set_command_name :'log-settings'
+
+  register_subcommands :get, :update  
+  register_subcommands :add_syslog_rule, :remove_syslog_rule
+  
+  # these command are deprecated in 5.3.3 and can be removed
+  register_subcommands :enable_integration, :disable_integration, :remove_integration
+  set_subcommands_hidden :enable_integration, :disable_integration, :remove_integration
+
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @log_settings_interface = @api_client.log_settings
+  end
+
+  def handle(args)
+    handle_subcommand(args)
+  end
+
+  def get(args)
+    options = {}
+    optparse = MtnCloud::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage()
+      build_common_options(opts, options, [:query, :json, :yaml, :csv, :fields, :dry_run, :remote])
+      opts.footer = "Get log settings."
+    end
+    optparse.parse!(args)
+    connect(options)
+    if args.count != 0
+      raise_command_error "wrong number of arguments, expected 0 and got (#{args.count}) #{args}\n#{optparse}"
+      return 1
+    end
+    
+    begin
+      @log_settings_interface.setopts(options)
+
+      if options[:dry_run]
+        print_dry_run @log_settings_interface.dry.get()
+        return
+      end
+      json_response = @log_settings_interface.get()
+      if options[:json]
+        puts as_json(json_response, options, "logSettings")
+        return 0
+      elsif options[:yaml]
+        puts as_yaml(json_response, options, "logSettings")
+        return 0
+      elsif options[:csv]
+        puts records_as_csv([json_response['logSettings']], options)
+        return 0
+      end
+
+      log_settings = json_response['logSettings']
+
+      print_h1 "Log Settings"
+      print cyan
+      description_cols = {
+        "Logs Enabled" => lambda {|it| format_boolean(it['enabled']) },
+        "Availability Time Frame" => lambda {|it| it['retentionDays'] }
+      }
+      print_description_list(description_cols, log_settings)
+
+      # Syslog Forwarding Rules
+      if !log_settings['syslogRules'].empty?
+        print_h2 "Syslog Forwarding Rules"
+        print cyan
+        print as_pretty_table(log_settings['syslogRules'], [:id, :name, :rule])
+      end
+
+      # Integrations
+      if !log_settings['integrations'].empty?
+        print_h2 "Integrations"
+        print cyan
+        print as_pretty_table(log_settings['integrations'], [:name, :enabled, :host, :port])
+      end
+      print reset, "\n"
+      return 0
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      return 1
+    end
+  end
+
+  def update(args)
+    options = {}
+    params = {}
+
+    optparse = MtnCloud::Cli::OptionParser.new do |opts|
+      opts.banner = opts.banner = subcommand_usage()
+      opts.on("--enabled [on|off]", ['on','off'], "Logs enabled") do |val|
+        params['enabled'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == '1' || val.to_s == ''
+      end
+      opts.on("-R", "--retention NUMBER", Integer, "Availability time frame in days") do |val|
+        params['retentionDays'] = val.to_i
+      end
+      opts.on("-s", "--syslog JSON", String, "Syslog rules JSON") do |val|
+        begin
+          syslog_rules = JSON.parse(val.to_s)
+          options[:syslogRules] = syslog_rules.kind_of?(Array) ? syslog_rules : [syslog_rules]
+        rescue JSON::ParserError => e
+          print_red_alert "Unable to parse syslog rules JSON"
+          exit 1
+        end
+      end
+      opts.on('--syslog-list LIST', Array, "Syslog rules list in form of name value pairs: name1=rule1,name2=rule2") do |val|
+        options[:syslogRules] = val.collect { |nv|
+          parts = nv.split('=')
+          {'name' => parts[0].strip, 'rule' => (parts.count > 1 ? parts[1].strip : '')}
+        }
+      end
+      opts.on( '-i', '--integrations JSON', "Integrations") do |val|
+        begin
+          ints = JSON.parse(val.to_s)
+          options[:integrations] = ints.kind_of?(Array) ? ints : [ints]
+        rescue JSON::ParserError => e
+          print_red_alert "Unable to parse integrations JSON"
+          exit 1
+        end
+      end
+      build_common_options(opts, options, [:json, :payload, :dry_run, :quiet, :remote])
+      opts.footer = "Update your log settings."
+    end
+
+    optparse.parse!(args)
+    connect(options)
+    if args.count != 0
+      raise_command_error "wrong number of arguments, expected 0 and got (#{args.count}) #{args}\n#{optparse}"
+      return 1
+    end
+
+    begin
+      payload = parse_payload(options)
+
+      if !payload
+        payload = {'logSettings' => params}
+
+        if !options[:syslogRules].nil?
+          if options[:syslogRules].reject { |rule| rule['name'] }.count > 0
+            print_red_alert "Invalid forwarding rule(s), name is required"
+            return 1
+          end
+          payload['logSettings']['syslogRules'] = options[:syslogRules]
+        end
+
+        if !options[:integrations].nil?
+          if options[:integrations].reject { |rule| rule['name'] }.count > 0
+            print_red_alert "Invalid integration: name is required"
+            return 1
+          end
+          payload['logSettings']['integrations'] = options[:integrations]
+        end
+      end
+
+      if payload['logSettings'].empty?
+        print_green_success "Nothing to update"
+        exit 1
+      end
+
+      @log_settings_interface.setopts(options)
+      if options[:dry_run]
+        print_dry_run @log_settings_interface.dry.update(payload)
+        return
+      end
+      json_response = @log_settings_interface.update(payload)
+
+      if options[:json]
+        puts as_json(json_response, options)
+      elsif !options[:quiet]
+        if json_response['success']
+          print_green_success  "Updated log settings"
+          get([] + (options[:remote] ? ["-r",options[:remote]] : []))
+        else
+          print_red_alert "Error updating log settings: #{json_response['msg'] || json_response['errors']}"
+        end
+      end
+      return 0
+
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
+  def enable_integration(args)
+    print_error yellow,"[DEPRECATED] The command `#{command_name} enable-integration` is deprecated.",reset,"\n"
+    options = {}
+
+    optparse = MtnCloud::Cli::OptionParser.new do |opts|
+      opts.banner = opts.banner = subcommand_usage("[name] [host] [port]")
+      build_common_options(opts, options, [:json, :payload, :dry_run, :quiet, :remote])
+      opts.footer = "Enables specifed integration.\n" +
+          "[name] is required. Currently supports splunk and logrhythm integrations.\n" +
+          "[host] is required. Host of the integration.\n" +
+          "[port] is required. Port of the integration."
+    end
+
+    optparse.parse!(args)
+    connect(options)
+    if args.count != 3
+      raise_command_error "wrong number of arguments, expected 3 and got (#{args.count}) #{args}\n#{optparse}"
+      return 1
+    end
+    if !args[2].to_i
+      raise_command_error "port argument must be a number"
+    end
+
+    begin
+      payload = parse_payload(options)
+
+      if !payload
+        payload = {'integration' => {'enabled' => true, 'host' => args[1], 'port' => args[2]}}
+      end
+
+      @log_settings_interface.setopts(options)
+      if options[:dry_run]
+        print_dry_run @log_settings_interface.dry.update_integration(args[0], payload)
+        return
+      end
+      json_response = @log_settings_interface.update_integration(args[0], payload)
+
+      if options[:json]
+        puts as_json(json_response, options)
+      elsif !options[:quiet]
+        if json_response['success']
+          print_green_success  "Integration added"
+          get([] + (options[:remote] ? ["-r",options[:remote]] : []))
+        else
+          print_red_alert "Error enabling integration: #{json_response['msg'] || json_response['errors']}"
+        end
+      end
+      return 0
+
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
+  def disable_integration(args)
+    print_error yellow,"[DEPRECATED] The command `#{command_name} disable-integration` is deprecated.",reset,"\n"
+    options = {}
+
+    optparse = MtnCloud::Cli::OptionParser.new do |opts|
+      opts.banner = opts.banner = subcommand_usage("[name]")
+      build_common_options(opts, options, [:json, :dry_run, :quiet, :remote])
+      opts.footer = "Disabled specifed integration.\n" +
+          "[name] is required. Currently supports splunk and logrhythm integrations."
+    end
+
+    optparse.parse!(args)
+    connect(options)
+    if args.count != 1
+      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args}\n#{optparse}"
+      return 1
+    end
+
+    begin
+      payload = {'integration' => {'enabled' => false}}
+
+      @log_settings_interface.setopts(options)
+      if options[:dry_run]
+        print_dry_run @log_settings_interface.dry.update_integration(args[0], payload)
+        return
+      end
+      json_response = @log_settings_interface.update_integration(args[0], payload)
+
+      if options[:json]
+        puts as_json(json_response, options)
+      elsif !options[:quiet]
+        if json_response['success']
+          print_green_success  "Integration removed"
+          get([] + (options[:remote] ? ["-r",options[:remote]] : []))
+        else
+          print_red_alert "Error disabling integration: #{json_response['msg'] || json_response['errors']}"
+        end
+      end
+      return 0
+
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
+  def remove_integration(args)
+    print_error yellow,"[DEPRECATED] The command `#{command_name } remove-integration` is deprecated.",reset,"\n"
+    options = {}
+
+    optparse = MtnCloud::Cli::OptionParser.new do |opts|
+      opts.banner = opts.banner = subcommand_usage("[name]")
+      build_common_options(opts, options, [:json, :dry_run, :quiet, :remote])
+      opts.footer = "Deletes specifed integration.\n" +
+          "[name] is required. Currently supports splunk and logrhythm integrations."
+    end
+
+    optparse.parse!(args)
+    connect(options)
+    if args.count != 1
+      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args}\n#{optparse}"
+      return 1
+    end
+
+    begin
+      @log_settings_interface.setopts(options)
+      if options[:dry_run]
+        print_dry_run @log_settings_interface.dry.destroy_integration(args[0])
+        return
+      end
+      json_response = @log_settings_interface.destroy_integration(args[0])
+
+      if options[:json]
+        puts as_json(json_response, options)
+      elsif !options[:quiet]
+        if json_response['success']
+          print_green_success  "Integration removed"
+          get([] + (options[:remote] ? ["-r",options[:remote]] : []))
+        else
+          print_red_alert "Error removing integration: #{json_response['msg'] || json_response['errors']}"
+        end
+      end
+      return 0
+
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
+  def add_syslog_rule(args)
+    options = {}
+
+    optparse = MtnCloud::Cli::OptionParser.new do |opts|
+      opts.banner = opts.banner = subcommand_usage("[name] [rule]")
+      build_common_options(opts, options, [:json, :payload, :dry_run, :quiet, :remote])
+      opts.footer = "Add syslog rule.\n" +
+          "[name] is required. If syslog already exists, the specified rule will be updated\n" +
+          "[rule] is required"
+    end
+
+    optparse.parse!(args)
+    connect(options)
+    if args.count != 2
+      raise_command_error "wrong number of arguments, expected 2 and got (#{args.count}) #{args}\n#{optparse}"
+      return 1
+    end
+
+    begin
+      payload = parse_payload(options)
+
+      if !payload
+        payload = {'syslogRule' => {'name' => args[0], 'rule' => args[1]}}
+      end
+
+      @log_settings_interface.setopts(options)
+      if options[:dry_run]
+        print_dry_run @log_settings_interface.dry.add_syslog_rule(payload)
+        return
+      end
+      json_response = @log_settings_interface.add_syslog_rule(payload)
+
+      if options[:json]
+        puts as_json(json_response, options)
+      elsif !options[:quiet]
+        if json_response['success']
+          print_green_success  "Syslog rule added"
+          get([] + (options[:remote] ? ["-r",options[:remote]] : []))
+        else
+          print_red_alert "Error adding syslog rule: #{json_response['msg'] || json_response['errors']}"
+        end
+      end
+      return 0
+
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
+  def remove_syslog_rule(args)
+    options = {}
+
+    optparse = MtnCloud::Cli::OptionParser.new do |opts|
+      opts.banner = opts.banner = subcommand_usage("[syslog-rule]")
+      build_common_options(opts, options, [:json, :dry_run, :quiet, :remote])
+      opts.footer = "Delete a syslog rule.\n" +
+          "[syslog-rule] is required. This is the name or id of an syslog rule."
+    end
+
+    optparse.parse!(args)
+    connect(options)
+    if args.count != 1
+      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args}\n#{optparse}"
+      return 1
+    end
+
+    begin
+      syslog_rule = find_syslog_rule_by_name_or_id(args[0])
+
+      if syslog_rule.nil?
+        print_red_alert "Syslog rule not found for: #{args[0]}"
+        return 1
+      end
+
+      @log_settings_interface.setopts(options)
+      if options[:dry_run]
+        print_dry_run @log_settings_interface.dry.destroy_syslog_rule(syslog_rule['id'])
+        return
+      end
+      json_response = @log_settings_interface.destroy_syslog_rule(syslog_rule['id'])
+
+      if options[:json]
+        puts as_json(json_response, options)
+      elsif !options[:quiet]
+        if json_response['success']
+          print_green_success  "Syslog rule removed"
+          get([] + (options[:remote] ? ["-r",options[:remote]] : []))
+        else
+          print_red_alert "Error removing syslog rule: #{json_response['msg'] || json_response['errors']}"
+        end
+      end
+      return 0
+
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
+  private
+
+  def find_syslog_rule_by_name_or_id(val)
+    log_settings = @log_settings_interface.get()['logSettings']
+    log_settings['syslogRules'].find do |rule|
+      val.casecmp(rule['name']) == 0 || rule['id'] == val.to_i
+    end
+  end
+
+end

data/lib/mtncloud/cli/commands/login.rb

@@ -0,0 +1,148 @@
+require 'mtncloud/cli/cli_command'
+
+class MtnCloud::Cli::Login
+  include MtnCloud::Cli::CliCommand
+  # include MtnCloud::Cli::WhoamiHelper
+  # include MtnCloud::Cli::AccountsHelper
+  def initialize()
+    
+  end
+
+  def connect(opts)
+    # @api_client = establish_remote_appliance_connection({:skip_verify_access_token => true, :skip_login => true}.merge(opts))
+  end
+
+  def usage
+    "Usage: #{prog_name} login [username] [password]"
+  end
+
+  def handle(args)
+    login(args)
+  end
+
+  def login(args)
+    options = {}
+    username, password = nil, nil
+    optparse = MtnCloud::Cli::OptionParser.new do |opts|
+      opts.banner = usage
+      opts.on( '-u', '--username USERNAME', "Username. Sub-tenant users must format their username with a prefix like {subdomain}\\{username}" ) do |val|
+        username = val
+      end
+      opts.on( '-p', '--password PASSWORD', "Password" ) do |val|
+        password = val
+      end
+      opts.on( '--password-file FILE', String, "Password File, read a file containing the password." ) do |val|
+        password_file = File.expand_path(val)
+        if !File.exist?(password_file) || !File.file?(password_file) # check readable too
+          raise ::OptionParser::InvalidOption.new("File not found: #{password_file}")
+        end
+        password = File.read(password_file) #.to_s.split("\n").first.strip
+      end
+      opts.on( '-t', '--test', "Test credentials only, does not update stored credentials for the appliance." ) do
+        options[:test_only] = true
+      end
+      opts.on( '--client-id CLIENT', "Used to test authentication with a client_id other than #{MtnCloud::APIClient::CLIENT_ID}. Currently behaves like --test, credentials are not stored." ) do |val|
+        options[:client_id] = val.to_s
+        options[:test_only] = true
+      end
+      opts.on( '-T', '--token ACCESS_TOKEN', "Use an existing access token to login instead of authenticating with a username and password." ) do |val|
+        options[:remote_token] = val
+      end
+      build_common_options(opts, options, [:json, :dry_run, :remote, :quiet], [:remote_username, :remote_password, :remote_token])
+      opts.footer = <<-EOT
+Login to a remote appliance with a username and password or using an access token.
+Logging in with username and password will make an authentication api request to obtain an access token.
+[username] is required, this is the username of the MTN Cloud user
+[password] is required, this is the password of the MTN Cloud user
+Sub-tenant users will need to pass their tenant subdomain prefix. ie. {subdomain}\\{username}
+By default, the subdomain is the tenant account ID. Example: 2\\neo
+The --token option can be used to login with a valid access token instead of username and password.
+The specified token will be verified by making a whoami api request
+If successful, the access token will be saved with the active session for the remote appliance.
+This command will first logout any active session before attempting authentication.
+The --test option can be used to test credentials without updating the stored credentials for the appliance, neither logging you in or out.
+EOT
+                    
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, max:2, optparse:optparse)
+    username = args[0] if args[0]
+    password = args[1] if args[1]
+    
+    # connect(options)
+    @api_client = establish_remote_appliance_connection(options.merge({:no_prompt => true, :skip_verify_access_token => true, :skip_login => true}))
+    
+    if options[:test_only]
+      puts "Testing credentials, your current session will not be modified."
+    elsif @remote_appliance[:authenticated]
+      puts "You will be automatically logged out of your current session as '#{@remote_appliance[:username]}'"
+    end
+
+    begin
+      if (options[:quiet] && (!options[:remote_token]) && !(username && password))
+        print_error yellow,"Please specify username and password, or token.", reset, "\n"
+        return 1
+      end
+
+      options[:username] = username if username
+      options[:password] = password if password
+
+      do_save = true
+      if options[:test_only] || options[:remote_url]
+        do_save = false
+      end
+      #old_wallet = MtnCloud::Cli::Credentials.new(@appliance_name, @appliance_url).load_saved_credentials()
+      
+      login_result = MtnCloud::Cli::Credentials.new(@appliance_name, @appliance_url).login(options, do_save)
+      if options[:dry_run]
+        return 0
+      end
+      wallet = login_result
+
+      # needed here too?
+      ::MtnCloud::Cli::Remote.recalculate_variable_map()
+
+      # should happen here, not in Credentials.login()
+      # if options[:json]
+      #   puts as_json(login_result)
+      #   return (login_result && login_result['access_token']) ? 0 : 1
+      # end
+
+      if wallet && wallet['access_token']
+        # Login Success!
+        if !options[:quiet]
+          if options[:test_only]
+            print green,"Success! Test Credentials verified for #{wallet['username']}", reset, "\n"
+          else
+            # clear whoami cache, it will be lazily load_saved_credentials
+            ::MtnCloud::Cli::Whoami.clear_whoami(@appliance_name, wallet['username'])
+            print green,"Success! Logged in as #{wallet['username']}", reset, "\n"
+          end
+        end
+        return 0 # ,  nil
+      else
+        # Login Failed
+        # so login() already prints 'Bad Credentials' (deprecate class Credentials plz)
+        # tell them if they're logged out now.
+        if !options[:quiet]
+          if options[:test_only]
+            # you are fine, nothing has changed
+          else
+            # if old_wallet && old_wallet['access_token']
+            #   #print reset,"You are no longer logged in. Goodbye #{old_wallet['username']}!", reset, "\n"
+            #    # todo: prompt to recover wallet ?
+            # end
+          end
+        end
+        return 1, "Login failed"
+      end
+
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      return 1
+    end
+
+  end
+
+
+end

data/lib/mtncloud/cli/commands/logout.rb

@@ -0,0 +1,63 @@
+require 'mtncloud/cli/cli_command'
+
+class MtnCloud::Cli::Logout
+  include MtnCloud::Cli::CliCommand
+
+  def connect(options)
+    @api_client = establish_remote_appliance_connection(options.merge({:no_prompt => true, :skip_verify_access_token => true, :skip_login => true}))
+  end
+
+  def usage
+    "Usage: #{prog_name} logout"
+  end
+
+  def handle(args)
+    logout(args)
+  end
+
+  def logout(args)
+    options = {}
+    optparse = MtnCloud::Cli::OptionParser.new do |opts|
+      opts.banner = usage
+      build_common_options(opts, options, [:remote, :quiet])
+      opts.footer = <<-EOT
+Logout of a remote appliance.
+This clears your credentials so that you will need to login again.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args,count:0,optpare:optparse)
+    connect(options)
+
+    if !@appliance_name
+      print_error MtnCloud::Terminal.angry_prompt
+      puts_error "Please specify an MTN Cloud appliance to logout of with -r or see the command `remote use`"
+      return 1
+    end
+    wallet = MtnCloud::Cli::Credentials.new(@appliance_name, @appliance_url).load_saved_credentials
+    token = wallet ? wallet['access_token'] : nil
+    if !token
+      if !options[:quiet]
+        puts "You are not currently logged in to #{display_appliance(@appliance_name, @appliance_url)}"
+      end
+    else
+      # todo: need to tell the server to delete the token too..
+      # delete token from credentials file
+      # note: this also handles updating appliance session info
+      MtnCloud::Cli::Credentials.new(@appliance_name, @appliance_url).logout()
+      if !options[:quiet]
+        puts "#{cyan}Logged out of #{@appliance_name}. Goodbye #{wallet['username']}!#{reset}"
+      end
+    end
+    # recalcuate echo vars
+    MtnCloud::Cli::Echo.recalculate_variable_map()
+    # recalculate shell prompt after this change
+    if MtnCloud::Cli::Shell.has_instance?
+      MtnCloud::Cli::Shell.instance.reinitialize()
+    end
+    return 0
+
+  end
+
+
+end