mtncloud-cli 1.0.0

data/test/cli/infrastructure_helper_cluster_resolver_test.rb

@@ -0,0 +1,250 @@
+require 'test/unit'
+require 'stringio'
+require 'json'
+require 'mtncloud'
+
+# Unit tests for the MORPH-17279 cloud-owned vSphere cluster resolver added to
+# MtnCloud::Cli::InfrastructureHelper:
+#   find_resource_pool_cluster_by_name_or_id / _by_id / _by_name
+#
+# These are pure unit tests against a fake CloudResourcePoolsInterface. They
+# deliberately do NOT extend MtnCloudTest::TestCase because they require no
+# appliance, no remote and no authentication - they must always be runnable.
+# See test/cli/affinity_helper_test.rb for the established pattern this
+# follows.
+#
+# Bug context: --cloud CLOUD --cluster CLUSTER must resolve CLUSTER as a
+# ComputeZonePool(type='Cluster') owned by CLOUD, distinct from the managed
+# cluster (ComputeServerGroup) namespace resolved via ClustersInterface. A
+# name lookup that traverses ambiguous, wrong-cloud or wrong-type pools must
+# fail loudly instead of returning nil silently or the wrong pool.
+class InfrastructureHelperClusterResolverTest < Test::Unit::TestCase
+
+  # Fake standing in for MtnCloud::CloudResourcePoolsInterface. Records every
+  # call so tests can assert exactly what was requested, mirroring the
+  # dry-run request assertions used elsewhere in this suite.
+  class FakeResourcePoolsInterface
+    attr_reader :get_calls, :list_calls
+
+    def initialize(get_result: nil, get_error: nil, list_result: nil)
+      @get_result = get_result
+      @get_error = get_error
+      @list_result = list_result
+      @get_calls = []
+      @list_calls = []
+    end
+
+    def get(cloud_id, id, params = {})
+      @get_calls << [cloud_id, id, params]
+      raise @get_error if @get_error
+      @get_result
+    end
+
+    def list(cloud_id, params = {})
+      @list_calls << [cloud_id, params]
+      @list_result
+    end
+  end
+
+  class FakeClustersInterface
+    def initialize(get_result: nil, get_error: nil, list_result: nil)
+      @get_result = get_result
+      @get_error = get_error
+      @list_result = list_result || {'clusters' => []}
+    end
+
+    def get(id)
+      raise @get_error if @get_error
+      @get_result
+    end
+
+    def list(params = {})
+      @list_result
+    end
+  end
+
+  # Bare host for the mixin under test.
+  class HelperHost
+    include MtnCloud::Cli::InfrastructureHelper
+
+    def initialize(fake_interface, clusters_interface=nil)
+      @cloud_resource_pools_interface = fake_interface
+      @clusters_interface = clusters_interface if clusters_interface
+    end
+  end
+
+  def fake_not_found_error
+    response = Object.new
+    def response.code; 404; end
+    RestClient::Exception.new(response)
+  end
+
+  def fake_server_error
+    response = Object.new
+    def response.code; 500; end
+    RestClient::Exception.new(response)
+  end
+
+  def cloud
+    {'id' => 59, 'name' => 'vCenter Cloud'}
+  end
+
+  # print_red_alert writes straight to $stderr (print_helper.rb) - capture it.
+  def capture_stderr
+    original = $stderr
+    $stderr = StringIO.new
+    yield
+    $stderr.string
+  ensure
+    $stderr = original
+  end
+
+  ## find_resource_pool_cluster_by_id
+
+  def test_find_by_id_returns_the_pool_when_it_is_a_cluster_in_the_cloud
+    fake = FakeResourcePoolsInterface.new(get_result: {
+      'resourcePool' => {'id' => 501, 'name' => 'QA', 'type' => 'Cluster', 'zone' => {'id' => 59, 'name' => 'vCenter Cloud'}}
+    })
+    helper = HelperHost.new(fake)
+    pool = helper.find_resource_pool_cluster_by_id(cloud, 501)
+    assert_not_nil pool
+    assert_equal 501, pool['id']
+    assert_equal 'QA', pool['name']
+    # Scoped to the cloud -- the server itself enforces ownership.
+    assert_equal [[59, 501, {}]], fake.get_calls
+  end
+
+  # ZoneResourcePoolsController#show 404s when the pool's zone does not match
+  # the requested cloud -- this is the server-side cloud-ownership check.
+  def test_find_by_id_reports_not_found_on_404_without_raising
+    fake = FakeResourcePoolsInterface.new(get_error: fake_not_found_error)
+    helper = HelperHost.new(fake)
+    pool = nil
+    output = capture_stderr { pool = helper.find_resource_pool_cluster_by_id(cloud, 999) }
+    assert_nil pool
+    assert_match(/not found by id 999/i, output)
+    assert_match(/vCenter Cloud/, output)
+  end
+
+  # A non-404 failure (auth, server error, etc.) must not be swallowed as a
+  # not-found -- that would hide a real problem behind a wrong error message.
+  def test_find_by_id_reraises_non_404_errors
+    fake = FakeResourcePoolsInterface.new(get_error: fake_server_error)
+    helper = HelperHost.new(fake)
+    assert_raise(RestClient::Exception) { helper.find_resource_pool_cluster_by_id(cloud, 501) }
+  end
+
+  def test_find_by_id_rejects_a_non_cluster_resource_pool
+    fake = FakeResourcePoolsInterface.new(get_result: {
+      'resourcePool' => {'id' => 501, 'name' => 'Folder A', 'type' => 'ResourcePool', 'zone' => {'id' => 59, 'name' => 'vCenter Cloud'}}
+    })
+    helper = HelperHost.new(fake)
+    pool = nil
+    output = capture_stderr { pool = helper.find_resource_pool_cluster_by_id(cloud, 501) }
+    assert_nil pool
+    assert_match(/not a Cluster/i, output)
+    assert_match(/ResourcePool/, output)
+  end
+
+  ## find_resource_pool_cluster_by_name
+
+  def test_find_by_name_returns_the_single_match
+    fake = FakeResourcePoolsInterface.new(list_result: {
+      'resourcePools' => [
+        {'id' => 501, 'name' => 'QA', 'type' => 'Cluster'},
+      ]
+    })
+    helper = HelperHost.new(fake)
+    pool = helper.find_resource_pool_cluster_by_name(cloud, 'QA')
+    assert_not_nil pool
+    assert_equal 501, pool['id']
+    assert_equal [[59, {name: 'QA', type: 'Cluster'}]], fake.list_calls
+  end
+
+  def test_find_by_name_matches_on_display_name
+    fake = FakeResourcePoolsInterface.new(list_result: {
+      'resourcePools' => [
+        {'id' => 501, 'name' => 'internal-qa-01', 'displayName' => 'QA', 'type' => 'Cluster'},
+      ]
+    })
+    helper = HelperHost.new(fake)
+    pool = helper.find_resource_pool_cluster_by_name(cloud, 'QA')
+    assert_not_nil pool
+    assert_equal 501, pool['id']
+  end
+
+  def test_find_by_name_reports_not_found_with_a_managed_cluster_hint
+    fake = FakeResourcePoolsInterface.new(list_result: {'resourcePools' => []})
+    helper = HelperHost.new(fake)
+    pool = nil
+    output = capture_stderr { pool = helper.find_resource_pool_cluster_by_name(cloud, 'QA') }
+    assert_nil pool
+    assert_match(/not found by name 'QA'/i, output)
+    assert_match(/vCenter Cloud/, output)
+    assert_match(/--cluster 'QA' without --cloud/, output)
+  end
+
+  # The cloud-scoped resource-pools endpoint returns a pool *tree*: when the
+  # matched pool has a parent folder, ancestor entries are backfilled into the
+  # result so the hierarchy renders, even though they do not match the
+  # name/type filter. The resolver must not misreport this as ambiguity.
+  def test_find_by_name_ignores_ancestor_tree_padding
+    fake = FakeResourcePoolsInterface.new(list_result: {
+      'resourcePools' => [
+        {'id' => 10, 'name' => 'Datacenter Folder', 'type' => 'Folder', 'depth' => 0},
+        {'id' => 501, 'name' => 'QA', 'type' => 'Cluster', 'depth' => 1},
+      ]
+    })
+    helper = HelperHost.new(fake)
+    pool = helper.find_resource_pool_cluster_by_name(cloud, 'QA')
+    assert_not_nil pool, "the ancestor folder must not be counted as a second match"
+    assert_equal 501, pool['id']
+  end
+
+  def test_find_by_name_reports_ambiguity_with_candidates_and_requires_numeric_id
+    fake = FakeResourcePoolsInterface.new(list_result: {
+      'resourcePools' => [
+        {'id' => 501, 'name' => 'QA', 'type' => 'Cluster'},
+        {'id' => 502, 'name' => 'QA', 'type' => 'Cluster'},
+      ]
+    })
+    helper = HelperHost.new(fake)
+    pool = nil
+    output = capture_stderr { pool = helper.find_resource_pool_cluster_by_name(cloud, 'QA') }
+    assert_nil pool
+    assert_match(/2 clusters found by name 'QA'/i, output)
+    assert_match(/numeric cluster id/i, output)
+  end
+
+  ## find_resource_pool_cluster_by_name_or_id dispatch
+
+  def test_find_by_name_or_id_dispatches_numeric_strings_to_by_id
+    fake = FakeResourcePoolsInterface.new(get_result: {
+      'resourcePool' => {'id' => 501, 'name' => 'QA', 'type' => 'Cluster', 'zone' => {'id' => 59}}
+    })
+    helper = HelperHost.new(fake)
+    pool = helper.find_resource_pool_cluster_by_name_or_id(cloud, '501')
+    assert_not_nil pool
+    assert_equal 1, fake.get_calls.size
+    assert_equal 0, fake.list_calls.size
+  end
+
+  def test_find_by_name_or_id_dispatches_non_numeric_strings_to_by_name
+    fake = FakeResourcePoolsInterface.new(list_result: {
+      'resourcePools' => [{'id' => 501, 'name' => 'QA', 'type' => 'Cluster'}]
+    })
+    helper = HelperHost.new(fake)
+    pool = helper.find_resource_pool_cluster_by_name_or_id(cloud, 'QA')
+    assert_not_nil pool
+    assert_equal 0, fake.get_calls.size
+    assert_equal 1, fake.list_calls.size
+  end
+
+  def test_managed_cluster_lookup_reraises_non_404_errors
+    pools = FakeResourcePoolsInterface.new
+    clusters = FakeClustersInterface.new(get_error: fake_server_error)
+    helper = HelperHost.new(pools, clusters)
+    assert_raise(RestClient::Exception) { helper.find_managed_cluster_by_name_or_id('8') }
+  end
+
+end

data/test/cli/instances_test.rb

@@ -0,0 +1,37 @@
+require 'mtncloud_test'
+
+# Tests for MtnCloud::Cli::Instances
+class MtnCloudTest::InstancesTest < MtnCloudTest::TestCase
+
+  def test_instances_list
+    assert_execute %(instances list)
+  end
+
+  def test_instances_get
+    instance = client.instances.list({})['instances'][0]
+    if instance
+      assert_execute %(instances get "#{instance['id']}")
+      name_arg = instance['displayName'] || instance['name']
+      assert_execute %(instances get "#{escape_arg name_arg}")
+    else
+      puts "No instance found, unable to execute test `#{__method__}`"
+    end
+  end
+
+  # def test_instances_add
+  #   warn "Skipped test test_instances_add() because it is not implemented"
+  # end
+
+  # def test_instances_update
+  #   warn "Skipped test test_instances_update() because it is not implemented"
+  # end
+
+  # def test_instances_delete
+  #   warn "Skipped test test_instances_remove() because it is not implemented"
+  # end
+
+  # todo: many more instance commands to add
+
+  protected
+
+end

data/test/cli/man_test.rb

@@ -0,0 +1,14 @@
+require 'mtncloud_test'
+
+class MtnCloudTest::ManTest < MtnCloudTest::TestCase
+  
+  def test_man
+    # need to use -q to avoid interactive right now...
+    assert_execute("man -q")
+    assert_execute("man -g -q")
+    assert_execute("man -q")
+    man_file_path = MtnCloud::Cli::ManCommand.man_file_path
+    assert(File.exist?(man_file_path), "File #{man_file_path} should have been created.")
+  end
+
+end

data/test/cli/migrations_test.rb

@@ -0,0 +1,39 @@
+require 'mtncloud_test'
+
+class MtnCloudTest::MigrationsTest < MtnCloudTest::TestCase
+  
+  def test_migrations_list
+    assert_execute %(migrations list)
+    assert_execute %(migrations list "apitest")
+  end
+
+  def test_migrations_get
+    # migration = client.migrations.list({})['migrations'][0]
+    migration = client.migrations.list({})['migrations'].find {|r| r['authority'] !~ /\A\d+\Z/}
+    if migration
+      assert_execute %(migrations get "#{migration['id']}")
+      # beware that duplicates may exist
+      name_arg = migration['name']
+      assert_execute %(migrations get "#{escape_arg name_arg}")
+    else
+      puts "No migration found, unable to execute test `#{__method__}`"
+    end
+  end
+
+
+  # todo: test all the other commands
+
+  # def test_migrations_add
+  #   assert_execute %(migrations add "test_migration_#{random_id}" -N)
+  # end
+
+  # def test_migrations_update
+  #   #skip "Test needs to be added"
+  #   assert_execute %(migrations update "test_migration_#{random_id}" --description "neat")
+  # end
+
+  # def test_migrations_remove
+  #   assert_execute %(migrations remove "test_migration_#{random_id}" -y")
+  # end
+
+end

data/test/cli/network_routers_test.rb

@@ -0,0 +1,65 @@
+require 'mtncloud_test'
+
+# Tests for MtnCloud::Cli::NetworkRouters
+class MtnCloudTest::NetworkRoutersTest < MtnCloudTest::TestCase
+
+  def test_network_routers_list
+    assert_execute %(network-routers list)
+  end
+
+  def test_network_routers_get
+    # find one that does not have a duplicate name..so we can get it by name
+    #network_router = client.network_routers.list({})['networkRouters'][0]
+    network_routers = client.network_routers.list({})['networkRouters']
+    network_router = network_routers.find {|it| !(network_routers.find {|other| other['name'] == it['name'] }) }
+    if network_router
+      assert_execute %(network-routers get "#{network_router['id']}")
+      assert_execute %(network-routers get "#{escape_arg network_router['name']}")
+    else
+      puts "No network routers found, unable to execute test `#{__method__}`"
+    end
+  end
+
+  def test_network_routers_firewall_rules
+    network_router = client.network_routers.list({})['networkRouters'].find {|it| it['firewall'] }
+    if network_router
+      assert_execute %(network-routers firewall-rules "#{network_router['id']}")
+    else
+      puts "No network routers found with a firewall, unable to execute test `#{__method__}`"
+    end
+  end
+
+  def test_network_routers_firewall_rules_get
+    network_router = client.network_routers.list({})['networkRouters'].find {|it| it['firewall'] }
+    if network_router
+      # need to get by id to get the firewall rules
+      network_router = client.network_routers.get(network_router['id'])['networkRouter']
+      rules = network_router['type']['hasFirewallGroups'] ? (network_router['firewall']['ruleGroups'] || []).collect {|it| it['rules']}.flatten : network_router['firewall']['rules']
+      rule = rules[0]
+      if rule
+        assert_execute %(network-routers firewall-rule "#{network_router['id']}" "#{rule['id']}")
+      else
+        puts "No network router firewall rules found, unable to execute test `#{__method__}`"
+      end
+    else
+      puts "No network routers found with a firewall, unable to execute test `#{__method__}`"
+    end
+  end
+
+  # def test_network_routers_add
+  #   warn "Skipped test test_network_routers_add() because it is not implemented"
+  # end
+
+  # def test_network_routers_update
+  #   warn "Skipped test test_network_routers_update() because it is not implemented"
+  # end
+
+  # def test_network_routers_delete
+  #   warn "Skipped test test_network_routers_remove() because it is not implemented"
+  # end
+
+  # todo: many more network-routers commands to add
+
+  protected
+
+end

data/test/cli/remote_test.rb

@@ -0,0 +1,89 @@
+require 'mtncloud_test'
+
+# Tests for MtnCloud::Cli::Remote
+class MtnCloudTest::RemoteTest < MtnCloudTest::TestCase
+
+  def requires_remote
+    false
+  end
+
+  def requires_authentication
+    false
+  end
+
+  def setup
+    super()
+    @@test_remote_name ||= "test_remote_#{SecureRandom.hex(10)}"
+  end
+
+  def teardown
+    # switch back aftwards
+    assert_execute %(remote use "#{escape_arg @config.remote_name}")
+  end
+
+  def test_remote_add
+    assert_execute %(remote add "#{@@test_remote_name}" "#{escape_arg @config.url}" --insecure --use -N)
+  end
+
+  def test_remote_list
+    assert_execute %(remote list)
+    assert_execute %(remote list "#{@@test_remote_name}")
+  end
+
+  def test_remote_get
+    assert_execute %(remote get)
+    assert_execute %(remote get current)
+    assert_execute %(remote get "#{@@test_remote_name}")
+    assert_execute %(remote get "#{@@test_remote_name}" --offline)
+  end
+
+  def test_remote_current
+    assert_execute %(remote current)
+  end
+
+  def test_remote_version
+    assert_execute %(remote version)
+    #assert_execute %(remote version "#{@@test_remote_name}")
+  end
+
+  def test_remote_check
+    assert_execute %(remote check)
+    assert_execute %(remote check "#{@@test_remote_name}")
+  end
+
+  def test_remote_check_all
+    assert_execute %(remote check-all)
+  end
+
+  def test_remote_update
+    assert_execute %(remote update "#{@@test_remote_name}" --url "#{escape_arg @config.url}" --insecure)
+    #assert_execute %(remote update "#{@@test_remote_name}" --name "#{@@test_remote_name}_updated")
+    #assert_execute %(remote update "#{@@test_remote_name}_updated" --name "#{@@test_remote_name}")
+  end
+
+  def test_remote_rename
+    assert_execute %(remote rename "#{@@test_remote_name}" "#{@@test_remote_name}_renamed" -y)
+    assert_execute %(remote rename "#{@@test_remote_name}_renamed" "#{@@test_remote_name}" -y)
+  end
+
+  def test_remote_use
+    assert_error %(remote use)
+    assert_error %(remote use unknown_remote)
+    assert_execute %(remote use "#{@@test_remote_name}")
+    assert_execute %(remote use "#{@@test_remote_name}")
+    assert_execute %(remote get current)
+    assert_execute %(remote unuse)
+    assert_error %(remote get current)
+    assert_execute %(remote use "#{@@test_remote_name}"  -q)
+  end
+
+  def test_remote_remove
+    # test remove confirmation reploy of n or no
+    with_input(["n", "No"]) do
+      assert_error %(remote remove "#{@@test_remote_name}")
+      assert_error %(remote remove "#{@@test_remote_name}")
+    end
+    assert_execute %(remote remove "#{@@test_remote_name}" -y)
+  end
+
+end

data/test/cli/roles_test.rb

@@ -0,0 +1,47 @@
+require 'mtncloud_test'
+
+class MtnCloudTest::RolesTest < MtnCloudTest::TestCase
+  
+  def test_roles_list
+    assert_execute %(roles list)
+    assert_execute %(roles list "System Admin")
+  end
+
+  # def test_roles_get_system_admin
+  #   assert_execute %(roles get "System Admin")
+  #   assert_execute %(roles get "System Admin" --permissions)
+  # end
+
+  def test_roles_get
+    # role = client.roles.list({})['roles'][0]
+    role = client.roles.list({})['roles'].find {|r| r['authority'] !~ /\A\d+\Z/}
+    if role
+      assert_execute %(roles get "#{role['id']}")
+      name_arg = role['authority']
+      assert_execute %(roles get "#{escape_arg name_arg}")
+      assert_execute %(roles get "#{escape_arg name_arg}" --permissions)
+    else
+      puts "No role found, unable to execute test `#{__method__}`"
+    end
+  end
+
+  def test_roles_list_permissions
+    assert_execute %(roles list-permissions "System Admin")
+  end
+
+  # todo: test all the other commands
+
+  # def test_roles_add
+  #   assert_execute %(roles add "test_role_#{random_id}" -N)
+  # end
+
+  # def test_roles_update
+  #   #skip "Test needs to be added"
+  #   assert_execute %(roles update "test_role_#{random_id}" --description "neat")
+  # end
+
+  # def test_roles_remove
+  #   assert_execute %(roles remove "test_role_#{random_id}" -y")
+  # end
+
+end

data/test/cli/shell_test.rb

@@ -0,0 +1,81 @@
+require 'mtncloud_test'
+
+class MtnCloudTest::ShellTest < MtnCloudTest::TestCase
+
+  def requires_remote
+    false
+  end
+
+  def requires_authentication
+    false
+  end
+
+  # class << self
+  #   def startup
+  #     # one time use remote and login at beginning of testsuite, not each method
+  #     use_remote()
+  #     login()
+  #   end
+  # end
+
+  # def test_remote_use
+  #   # use remote needed for all except test_shell_clean() , todo: exclude paradigm that yet..
+  #   use_remote()
+  # end
+
+  def test_shell
+    with_input "exit"  do
+      assert_execute "shell"
+    end
+  end
+
+  def test_shell_verbose
+    login_if_needed()
+    with_input "whoami", "exit" do
+      assert_execute "shell -V"
+    end
+  end
+
+  def test_shell_history
+    with_input "history", "exit" do
+      assert_execute "shell"
+    end
+  end
+
+  def test_shell_sleep
+    with_input "echo \"It is time for a rest.\"", "sleep 0.5", "echo \"OK, let's keep testing\"", "exit" do
+      assert_execute "shell -V"
+    end
+  end
+
+  def test_shell_temporary
+    with_input "remote list", "remote current", "echo this is a temporary shell with no history", "history", "exit" do
+      assert_execute "shell -Z -V"
+    end
+  end
+
+  def test_shell_confirmation
+    with_input "access-token refresh", "I'm not sure...", "no", "exit" do
+      assert_execute "shell -Z -V"
+    end
+  end
+
+# todo: fix bug where appliances are not restored after clean shell.. so remote use #{@config.remote_name}" starts failing here..
+=begin
+  def test_shell_clean
+    with_input "echo this is a clean shell with no remotes or history", "remote list", "remote current", "history", "exit" do
+      assert_execute "shell -z"
+    end
+    with_input "echo this is another clean shell", "exit" do
+      assert_execute "shell --clean"
+    end
+  end
+
+  def test_shell_history_again
+    with_input "echo back in test shell again with our remote and history", "remote get #{@config.remote_name}", "history", "exit" do
+      assert_execute "shell"
+    end
+  end
+=end
+
+end