mtncloud-cli 1.0.0 → 1.0.2

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

@@ -25,7 +25,7 @@ class MtnCloud::Cli::Login
     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|
+      opts.on( '-u', '--username USERNAME', "Username. Sub-tenant users prefix it with their subdomain or account ID: {subdomain}\\{username} or {accountID}\\{username}" ) do |val|
         username = val
       end
       opts.on( '-p', '--password PASSWORD', "Password" ) do |val|
@@ -54,8 +54,13 @@ Login to a remote appliance with a username and password or using an access toke
 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
+Username format:
+  Master tenant users enter only their username. Example: neo
+  Sub-tenant users prefix their username with their tenant's subdomain or account ID:
+    {subdomain}\\{username}   Example: acme\\neo
+    {accountID}\\{username}   Example: 2\\neo
+  A tenant's subdomain is its account ID unless a custom subdomain is set.
+  In bash or zsh, quote a username that contains a backslash: '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.

data/lib/mtncloud/cli/credentials.rb

@@ -11,6 +11,10 @@ module MtnCloud
     class Credentials
       include MtnCloud::Cli::PrintHelper
 
+      # How sub-tenant users format their username, shown in the login prompt.
+      # login --help explains the same formats in more detail.
+      USERNAME_FORMAT = "sub-tenant users: subdomain\\username or accountID\\username"
+
       @@appliance_credentials_map = nil
 
       def initialize(appliance_name, appliance_url)
@@ -118,7 +122,7 @@ module MtnCloud
                 Readline.basic_word_break_characters = ''
                 Readline.completer_word_break_characters = '' rescue nil
                 Readline.completion_proc = nil
-                username = Readline.readline("Username: #{required_blue_prompt} ", false).to_s.chomp
+                username = Readline.readline("Username (#{USERNAME_FORMAT}): #{required_blue_prompt} ", false).to_s.chomp
               else
                 print "Username: #{required_blue_prompt} #{username}\n"
               end

data/lib/mtncloud/cli/version.rb

@@ -1,6 +1,6 @@
 
 module MtnCloud
   module Cli
-    VERSION = "1.0.0"
+    VERSION = "1.0.2"
   end
 end

data/lib/mtncloud/ext/hash.rb

@@ -1,109 +1,109 @@
-# Provide deep_merge.
-# Borrowed from rails active_support
-# https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
-#
-class Hash
-  # Returns a new hash with +self+ and +other_hash+ merged recursively.
-  #
-  #   h1 = { a: true, b: { c: [1, 2, 3] } }
-  #   h2 = { a: false, b: { x: [3, 4, 5] } }
-  #
-  #   h1.deep_merge(h2) # => { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
-  #
-  # Like with Hash#merge in the standard library, a block can be provided
-  # to merge values:
-  #
-  #   h1 = { a: 100, b: 200, c: { c1: 100 } }
-  #   h2 = { b: 250, c: { c1: 200 } }
-  #   h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val }
-  #   # => { a: 100, b: 450, c: { c1: 300 } }
-  def deep_merge(other_hash, &block)
-    dup.deep_merge!(other_hash, &block)
-  end
-
-  # Same as +deep_merge+, but modifies +self+.
-  def deep_merge!(other_hash, &block)
-    other_hash.each_pair do |current_key, other_value|
-      this_value = self[current_key]
-
-      self[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
-        this_value.deep_merge(other_value, &block)
-      else
-        if block_given? && key?(current_key)
-          block.call(current_key, this_value, other_value)
-        else
-          other_value
-        end
-      end
-    end
-
-    self
-  end
-
-  def deep_compact!
-    self.each_pair do |k, v|
-      if v.is_a?(Hash)
-        self[k].deep_compact!
-      elsif v.is_a?(Array)
-        self[k].each do |it|
-          if it.is_a?(Hash)
-            it.deep_compact!
-          elsif self[k] == nil || self[k] == ''
-            # meh, preserve 'empty' array elements
-          end
-        end
-      else
-        if self[k] == nil || self[k] == ''
-          self.delete(k)
-        end
-      end
-    end
-    self
-  end
-
-  # convert recognizable strings to booleans
-  def booleanize!(true_values=['true','on'], false_values=['false','off'])
-    self.each_pair do |k, v|
-      if v.is_a?(Hash)
-        self[k].booleanize!
-      elsif v.is_a?(Array)
-        self[k].each do |it|
-          if it.is_a?(Hash)
-            it.booleanize!
-          elsif self[k] == nil || self[k] == ''
-            # meh, preserve 'empty' array elements
-          end
-        end
-      else
-        if true_values.include?(v)
-          self[k] = true
-        elsif false_values.include?(v)
-          self[k] = false
-        end
-      end
-    end
-    self
-  end
-
-  def upcase_keys!
-    self.keys.each do |k| 
-      self[k.to_s.upcase] = self.delete(k)
-    end
-    self
-  end
-
-  def downcase_keys!
-    self.keys.each do |k|
-      self[k.to_s.downcase] = self.delete(k)
-    end
-    self
-  end
-
-  def capitalize_keys!
-    self.keys.each do |k|
-      self[k.to_s.capitalize] = self.delete(k)
-    end
-    self
-  end
-
-end
+# Provide deep_merge.
+# Borrowed from rails active_support
+# https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+#
+class Hash
+  # Returns a new hash with +self+ and +other_hash+ merged recursively.
+  #
+  #   h1 = { a: true, b: { c: [1, 2, 3] } }
+  #   h2 = { a: false, b: { x: [3, 4, 5] } }
+  #
+  #   h1.deep_merge(h2) # => { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
+  #
+  # Like with Hash#merge in the standard library, a block can be provided
+  # to merge values:
+  #
+  #   h1 = { a: 100, b: 200, c: { c1: 100 } }
+  #   h2 = { b: 250, c: { c1: 200 } }
+  #   h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val }
+  #   # => { a: 100, b: 450, c: { c1: 300 } }
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash, &block)
+  end
+
+  # Same as +deep_merge+, but modifies +self+.
+  def deep_merge!(other_hash, &block)
+    other_hash.each_pair do |current_key, other_value|
+      this_value = self[current_key]
+
+      self[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
+        this_value.deep_merge(other_value, &block)
+      else
+        if block_given? && key?(current_key)
+          block.call(current_key, this_value, other_value)
+        else
+          other_value
+        end
+      end
+    end
+
+    self
+  end
+
+  def deep_compact!
+    self.each_pair do |k, v|
+      if v.is_a?(Hash)
+        self[k].deep_compact!
+      elsif v.is_a?(Array)
+        self[k].each do |it|
+          if it.is_a?(Hash)
+            it.deep_compact!
+          elsif self[k] == nil || self[k] == ''
+            # meh, preserve 'empty' array elements
+          end
+        end
+      else
+        if self[k] == nil || self[k] == ''
+          self.delete(k)
+        end
+      end
+    end
+    self
+  end
+
+  # convert recognizable strings to booleans
+  def booleanize!(true_values=['true','on'], false_values=['false','off'])
+    self.each_pair do |k, v|
+      if v.is_a?(Hash)
+        self[k].booleanize!
+      elsif v.is_a?(Array)
+        self[k].each do |it|
+          if it.is_a?(Hash)
+            it.booleanize!
+          elsif self[k] == nil || self[k] == ''
+            # meh, preserve 'empty' array elements
+          end
+        end
+      else
+        if true_values.include?(v)
+          self[k] = true
+        elsif false_values.include?(v)
+          self[k] = false
+        end
+      end
+    end
+    self
+  end
+
+  def upcase_keys!
+    self.keys.each do |k| 
+      self[k.to_s.upcase] = self.delete(k)
+    end
+    self
+  end
+
+  def downcase_keys!
+    self.keys.each do |k|
+      self[k.to_s.downcase] = self.delete(k)
+    end
+    self
+  end
+
+  def capitalize_keys!
+    self.keys.each do |k|
+      self[k.to_s.capitalize] = self.delete(k)
+    end
+    self
+  end
+
+end

data/lib/mtncloud/ext/nil_class.rb

@@ -1,5 +1,5 @@
-class NilClass
-  def empty?
-    true
-  end
-end
+class NilClass
+  def empty?
+    true
+  end
+end

data/lib/mtncloud/ext/rest_client.rb

@@ -1,37 +1,37 @@
-# this does some monkey patching of third party RestClient
-# to modify the logging output a bit
-require 'rest-client'
-
-module RestClient  
-  class Request
-
-    alias_method :original_log_request, :log_request
-    def log_request
-      begin
-        return unless RestClient.log
-        out = []
-        # out << "RestClient.#{method} #{redacted_url.inspect}"
-        out << "#{method.to_s.upcase} #{redacted_url.inspect}"
-        out << payload.short_inspect if payload
-        out << processed_headers.to_a.sort.map { |(k, v)| [k.inspect, v.inspect].join("=>") }.join(", ")
-        RestClient.log << out.join(', ') + "\n"
-      rescue
-        # something went wrong, wrong gem version maybe...above is from rest-client 2.0.2
-        # do it the old way
-        original_log_request()
-      end
-    end
-=begin
-    def log_response res
-      return unless RestClient.log
-      size = if @raw_response
-               File.size(@tf.path)
-             else
-               res.body.nil? ? 0 : res.body.size
-             end
-
-      RestClient.log << "# => #{res.code} #{res.class.to_s.gsub(/^Net::HTTP/, '')} | #{(res['Content-type'] || '').gsub(/;.*$/, '')} #{size} bytes\n"
-    end
-=end
-  end
-end
+# this does some monkey patching of third party RestClient
+# to modify the logging output a bit
+require 'rest-client'
+
+module RestClient  
+  class Request
+
+    alias_method :original_log_request, :log_request
+    def log_request
+      begin
+        return unless RestClient.log
+        out = []
+        # out << "RestClient.#{method} #{redacted_url.inspect}"
+        out << "#{method.to_s.upcase} #{redacted_url.inspect}"
+        out << payload.short_inspect if payload
+        out << processed_headers.to_a.sort.map { |(k, v)| [k.inspect, v.inspect].join("=>") }.join(", ")
+        RestClient.log << out.join(', ') + "\n"
+      rescue
+        # something went wrong, wrong gem version maybe...above is from rest-client 2.0.2
+        # do it the old way
+        original_log_request()
+      end
+    end
+=begin
+    def log_response res
+      return unless RestClient.log
+      size = if @raw_response
+               File.size(@tf.path)
+             else
+               res.body.nil? ? 0 : res.body.size
+             end
+
+      RestClient.log << "# => #{res.code} #{res.class.to_s.gsub(/^Net::HTTP/, '')} | #{(res['Content-type'] || '').gsub(/;.*$/, '')} #{size} bytes\n"
+    end
+=end
+  end
+end

data/lib/mtncloud/ext/string.rb

@@ -1,66 +1,66 @@
-class String
-  
-  def pluralize
-    # hacky version of this until we want to depend on ActiveSupport
-    value = self.dup
-    if value == ""
-      value
-    elsif value[-1].chr == "y"
-      value[0..-2] + "ies"
-    elsif value[-1].chr == "s"
-      if value[-2..-1] == "ss"
-        value + "es"
-      else
-        value
-      end
-    else
-      value + "s"
-    end
-  end
-
-  def singularize
-    # hacky version of this until we want to depend on ActiveSupport
-    value = self.dup
-    if value == ""
-      value
-    elsif value.size > 3 && value[-3..-1] == "ies"
-      value[0..-4] + "y"
-    elsif value.size > 2 && value[-3..-1] == "ses"
-      value[0..-2]
-    elsif value[-1] == "s"
-      value[0..-2]
-    else
-      value
-    end
-  end
-
-  def underscore
-    value = self.dup
-    value.gsub!(/::/, '/')
-    value.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-    value.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-    value.tr!("-", "_")
-    value.tr!(" ", "_")
-    value.downcase!
-    value
-  end
-
-  def camelcase
-    value = self.underscore.gsub(/\_([a-z])/) do $1.upcase end
-    value = value[0, 1].downcase + value[1..-1]
-    value
-  end
-
-  def upcamelcase
-    self.camelcase.capitalize
-  end
-
-  def titleize
-    self.underscore.split("_").map(&:capitalize).join(" ")
-  end
-
-  def dasherize
-    self.underscore.gsub("_", "-")
-  end
-
-end
+class String
+  
+  def pluralize
+    # hacky version of this until we want to depend on ActiveSupport
+    value = self.dup
+    if value == ""
+      value
+    elsif value[-1].chr == "y"
+      value[0..-2] + "ies"
+    elsif value[-1].chr == "s"
+      if value[-2..-1] == "ss"
+        value + "es"
+      else
+        value
+      end
+    else
+      value + "s"
+    end
+  end
+
+  def singularize
+    # hacky version of this until we want to depend on ActiveSupport
+    value = self.dup
+    if value == ""
+      value
+    elsif value.size > 3 && value[-3..-1] == "ies"
+      value[0..-4] + "y"
+    elsif value.size > 2 && value[-3..-1] == "ses"
+      value[0..-2]
+    elsif value[-1] == "s"
+      value[0..-2]
+    else
+      value
+    end
+  end
+
+  def underscore
+    value = self.dup
+    value.gsub!(/::/, '/')
+    value.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+    value.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    value.tr!("-", "_")
+    value.tr!(" ", "_")
+    value.downcase!
+    value
+  end
+
+  def camelcase
+    value = self.underscore.gsub(/\_([a-z])/) do $1.upcase end
+    value = value[0, 1].downcase + value[1..-1]
+    value
+  end
+
+  def upcamelcase
+    self.camelcase.capitalize
+  end
+
+  def titleize
+    self.underscore.split("_").map(&:capitalize).join(" ")
+  end
+
+  def dasherize
+    self.underscore.gsub("_", "-")
+  end
+
+end

data/mtncloud-cli.gemspec

@@ -1,38 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mtncloud/cli/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "mtncloud-cli"
-  spec.version       = MtnCloud::Cli::VERSION
-  spec.authors       = ["Joshua Ukpozi", "Joseph Henry", "MTN Cloud"]
-  spec.summary       = "Provides CLI Interface to MTN Cloud"
-  spec.description   = "Cloud application management & orchestration CLI for MTN Cloud. Easily manage and orchestrate VMs on private or public infrastructure and containerized architectures."
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = '>= 2.5.1' # according to http.rb doc
-  spec.add_dependency "tins", '~> 1.43.0'
-  spec.add_dependency "public_suffix", "4.0.7" # https://github.com/weppos/publicsuffix-ruby/blob/main/CHANGELOG.md
-  spec.add_dependency "ffi", "1.15.5" # Fix for mismatched deps: https://github.com/ffi/ffi/issues/1103
-  spec.add_development_dependency "bundler", ">= 2.2"
-  spec.add_development_dependency "rake"
-  spec.add_dependency 'term-ansicolor', '~> 1.3.0'
-  spec.add_dependency "rest-client", "2.0.2"
-  spec.add_dependency 'multipart-post'
-  spec.add_dependency "filesize"
-  spec.add_dependency 'mime-types'
-  spec.add_dependency "http", "5.3.1"
-  spec.add_dependency "rubyzip", '~> 2.3.2'
-  spec.add_dependency "test-unit"
-  # No longer part of Ruby's default libraries as of Ruby 4.0
-  spec.add_dependency "readline"
-  spec.add_dependency "logger"
-  spec.add_dependency "ostruct"
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mtncloud/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mtncloud-cli"
+  spec.version       = MtnCloud::Cli::VERSION
+  spec.authors       = ["Joseph Henry", "Joshua Ukpozi", "MTN Cloud"]
+  spec.summary       = "Provides CLI Interface to MTN Cloud"
+  spec.description   = "Cloud application management & orchestration CLI for MTN Cloud. Easily manage and orchestrate VMs on private or public infrastructure and containerized architectures."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.5.1' # according to http.rb doc
+  spec.add_dependency "tins", '~> 1.43.0'
+  spec.add_dependency "public_suffix", "4.0.7" # https://github.com/weppos/publicsuffix-ruby/blob/main/CHANGELOG.md
+  spec.add_dependency "ffi", "1.15.5" # Fix for mismatched deps: https://github.com/ffi/ffi/issues/1103
+  spec.add_development_dependency "bundler", ">= 2.2"
+  spec.add_development_dependency "rake"
+  spec.add_dependency 'term-ansicolor', '~> 1.3.0'
+  spec.add_dependency "rest-client", "2.0.2"
+  spec.add_dependency 'multipart-post'
+  spec.add_dependency "filesize"
+  spec.add_dependency 'mime-types'
+  spec.add_dependency "http", "5.3.1"
+  spec.add_dependency "rubyzip", '~> 2.3.2'
+  spec.add_dependency "test-unit"
+  # No longer part of Ruby's default libraries as of Ruby 4.0
+  spec.add_dependency "readline"
+  spec.add_dependency "logger"
+  spec.add_dependency "ostruct"
+end

data/test/cli/login_help_test.rb

@@ -0,0 +1,47 @@
+require 'test/unit'
+require 'stringio'
+require 'mtncloud'
+
+# Offline tests for how login explains the username format.
+# Sub-tenant users log in as {subdomain}\{username} or {accountID}\{username}.
+class LoginHelpTest < Test::Unit::TestCase
+
+  def capture_stdout
+    saved = $stdout
+    $stdout = StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = saved
+  end
+
+  # Captured once: the CLI keeps the stdout it first printed to, so a second
+  # --help in the same process would print to the first test's StringIO.
+  def login_help
+    @@login_help ||= capture_stdout do
+      error = assert_raise(SystemExit) { MtnCloud::Cli::Login.new.handle(['--help']) }
+      assert_equal 0, error.status
+    end
+  end
+
+  def test_help_documents_both_sub_tenant_username_formats
+    output = login_help
+    assert_include output, '{subdomain}\\{username}'
+    assert_include output, '{accountID}\\{username}'
+    assert_include output, 'Example: acme\\neo'
+    assert_include output, 'Example: 2\\neo'
+    assert_include output, 'Master tenant users enter only their username.'
+  end
+
+  def test_username_option_mentions_subdomain_and_account_id
+    output = login_help
+    assert_include output, '--username USERNAME'
+    assert_include output, 'Sub-tenant users prefix it with their subdomain or account ID'
+  end
+
+  def test_prompt_hint_names_both_formats
+    hint = MtnCloud::Cli::Credentials::USERNAME_FORMAT
+    assert_include hint, 'subdomain\\username'
+    assert_include hint, 'accountID\\username'
+  end
+end