mtncloud-cli 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c74ca2c70a2b0a12b972e2c0d9837321807c6c50e083850f7750cb8d236af074
-  data.tar.gz: 4ea3f71ff8652b53c20c067f08e4fe7ce3cf4729a4716b8246a279312d6b721c
+  metadata.gz: b3a5dc76695dc9b45484493d57dc18f76a6421b860734528495d877ac6d19d4a
+  data.tar.gz: e8c2396dc112b8cd25ba5887caf3bbc259a9ab77b04f3f828d546918dbaf111c
 SHA512:
-  metadata.gz: 3c9c7c54b4ab29be0a10e94371819b762e8620d0f54c04225ac501c31c72dd182f70b3796e3da7e11d0a0f8a38f18920464c64f997c21638a6176aea8fc1d081
-  data.tar.gz: 992d76ed72f096181b68682f01926dc88c3742754426efb5ffa8f08a785181e8e59ac46c6f1ab7bb886d1ba312fc0de96620ad0c1372cbe26ff6be39df50473a
+  metadata.gz: 322918f434dfde44a63ce4e5dbfc430cb0d8a1a78fe41ecaafc67c2c44269012f39f43edbcec799b26e9b5b1236b545eeb5a70602236ce3e0bd61ffe0e723f9e
+  data.tar.gz: bf2e4aaa891fa291376f7c0bd03106ab12fa5ec90b6bf773b9a8a957043a5de02b6f29716b5b008e6c5a8363f65d2a0d8f62499dbac976b5e0ad5c9b21a84983

data/README.md

@@ -65,6 +65,13 @@ mtncloud remote add mtncloud https://console.cloud.mtn.ng
 mtncloud login
 ```
 
+When prompted for your username:
+
+- Master tenant users enter only their username, for example `neo`.
+- Sub-tenant users prefix it with their tenant's subdomain or account ID: `subdomain\username` or `accountID\username`, for example `acme\neo` or `2\neo`.
+
+Your password is not saved. The CLI saves an access token in `~/.mtncloud/credentials` and refreshes it when it expires. To log in from a script without a prompt, use `--password-file FILE` or `--token ACCESS_TOKEN`. See `mtncloud login --help`.
+
 Then run commands, for example:
 
 ```shell
@@ -152,7 +159,7 @@ The other tests run against a live appliance. Create a `test_config.yaml` in the
 
 ```yaml
 url: 'https://console.cloud.mtn.ng'
-username: (accountID/Subdomain)\testrunner
+username: (accountID/subdomain)\testrunner
 password: 'SecretPassword123$'
 ```
 

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.1"
+    VERSION = "1.0.2"
   end
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mtncloud-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Joseph Henry
@@ -728,6 +728,7 @@ files:
 - test/cli/host_vm_groups_test.rb
 - test/cli/infrastructure_helper_cluster_resolver_test.rb
 - test/cli/instances_test.rb
+- test/cli/login_help_test.rb
 - test/cli/man_test.rb
 - test/cli/migrations_test.rb
 - test/cli/network_routers_test.rb
@@ -795,6 +796,7 @@ test_files:
 - test/cli/host_vm_groups_test.rb
 - test/cli/infrastructure_helper_cluster_resolver_test.rb
 - test/cli/instances_test.rb
+- test/cli/login_help_test.rb
 - test/cli/man_test.rb
 - test/cli/migrations_test.rb
 - test/cli/network_routers_test.rb