mtncloud-cli 1.0.0

data/test/api/clouds_interface_test.rb

@@ -0,0 +1,67 @@
+require 'test/unit'
+$LOAD_PATH.unshift(File.expand_path('../../lib', __dir__))
+require 'mtncloud/api/clouds_interface'
+
+class CloudsInterfaceTest < Test::Unit::TestCase
+
+  def setup
+    @clouds_interface = MtnCloud::CloudsInterface.new(access_token: 'token', url: 'https://example.test', verify_ssl: false)
+  end
+
+  def test_affinity_group_form_options_builds_bearer_authorization_header
+    request = @clouds_interface.dry.affinity_group_form_options(59, phase: 'create')
+    assert_equal :get, request[:method]
+    assert_equal 'https://example.test/api/zones/59/affinity-groups/form-options', request[:url]
+    assert_equal({phase: 'create'}, request[:headers][:params])
+    assert_equal 'Bearer token', request[:headers][:authorization]
+  end
+
+  def test_list_host_vm_groups_builds_bearer_authorization_header
+    request = @clouds_interface.dry.list_host_vm_groups(59, phrase: 'group')
+    assert_equal :get, request[:method]
+    assert_equal 'https://example.test/api/zones/59/host-vm-groups', request[:url]
+    assert_equal({phrase: 'group'}, request[:headers][:params])
+    assert_equal 'Bearer token', request[:headers][:authorization]
+  end
+
+  def test_get_host_vm_group_builds_bearer_authorization_header
+    request = @clouds_interface.dry.get_host_vm_group(59, 415, details: true)
+    assert_equal :get, request[:method]
+    assert_equal 'https://example.test/api/zones/59/host-vm-groups/415', request[:url]
+    assert_equal({details: true}, request[:headers][:params])
+    assert_equal 'Bearer token', request[:headers][:authorization]
+  end
+
+  def test_create_host_vm_group_builds_bearer_authorization_header
+    request = @clouds_interface.dry.create_host_vm_group(59, {name: 'group-a'})
+    assert_equal :post, request[:method]
+    assert_equal 'https://example.test/api/zones/59/host-vm-groups', request[:url]
+    assert_equal({name: 'group-a'}.to_json, request[:payload])
+    assert_equal 'Bearer token', request[:headers][:authorization]
+  end
+
+  def test_update_host_vm_group_builds_bearer_authorization_header
+    request = @clouds_interface.dry.update_host_vm_group(59, 415, {name: 'group-b'})
+    assert_equal :put, request[:method]
+    assert_equal 'https://example.test/api/zones/59/host-vm-groups/415', request[:url]
+    assert_equal({name: 'group-b'}.to_json, request[:payload])
+    assert_equal 'Bearer token', request[:headers][:authorization]
+  end
+
+  def test_destroy_host_vm_group_builds_bearer_authorization_header
+    request = @clouds_interface.dry.destroy_host_vm_group(59, 415, force: true)
+    assert_equal :delete, request[:method]
+    assert_equal 'https://example.test/api/zones/59/host-vm-groups/415', request[:url]
+    assert_equal({force: true}, request[:headers][:params])
+    assert_equal 'Bearer token', request[:headers][:authorization]
+  end
+
+  def test_host_vm_group_form_options_builds_bearer_authorization_header
+    request = @clouds_interface.dry.host_vm_group_form_options(59, scope: 'qa')
+    assert_equal :get, request[:method]
+    assert_equal 'https://example.test/api/zones/59/host-vm-groups/form-options', request[:url]
+    assert_equal({scope: 'qa'}, request[:headers][:params])
+    assert_equal 'Bearer token', request[:headers][:authorization]
+  end
+
+end

data/test/api/containers_interface_test.rb

@@ -0,0 +1,68 @@
+require 'mtncloud_test'
+
+# Tests for MtnCloud::ContainersInterface
+class MtnCloudTest::ContainersInterfaceTest < MtnCloudTest::TestCase
+
+  include MtnCloudTest::TestDataHelper  
+
+  def setup()
+    super
+    #load_container_test_data()
+  end
+
+  def test_get
+    container_id = find_first_container_id()
+    response = client.containers.get(container_id)
+    assert response['container'].is_a?(Hash)
+    assert_equal response['container']['id'], container_id
+  end
+
+  # todo: need to wait and refresh status for this to work well
+  
+=begin  
+  def test_stop
+    response = client.containers.stop(@id, {})
+    assert_equal response['success'], true
+  end
+
+  def test_start
+    response = client.containers.start(@id, {})
+    assert_equal response['success'], true
+  end
+
+  def test_restart
+    response = client.containers.restart(@id, {})
+    assert_equal response['success'], true
+  end
+
+  def test_suspend
+    response = client.containers.suspend(@id, {})
+    assert_equal response['success'], true
+  end
+
+  def test_eject
+    response = client.containers.eject(@id, {})
+    assert_equal response['success'], true
+  end
+
+  def test_available_actions
+    response = client.containers.available_actions(@id)
+    assert response['actions'].is_a?(Array)
+  end
+
+  def test_action
+    response = client.containers.action(@id, {})
+    assert_equal response['success'], true
+  end
+
+  def test_import
+    response = client.containers.import(@id, {})
+    assert_equal response['success'], true
+  end
+
+  def test_clone_image
+    response = client.containers.clone_image(@id, {})
+    assert_equal response['success'], true
+  end
+=end
+end

data/test/api/host_vm_groups_interface_test.rb

@@ -0,0 +1,35 @@
+require 'test/unit'
+$LOAD_PATH.unshift(File.expand_path('../../lib', __dir__))
+require 'mtncloud/api/host_vm_groups_interface'
+
+class HostVmGroupsInterfaceTest < Test::Unit::TestCase
+
+  def setup
+    @host_vm_groups_interface = MtnCloud::HostVmGroupsInterface.new(access_token: 'token', url: 'https://example.test', verify_ssl: false)
+  end
+
+  def test_get_builds_bearer_authorization_header
+    request = @host_vm_groups_interface.dry.get(415, details: true)
+    assert_equal :get, request[:method]
+    assert_equal 'https://example.test/api/host-vm-groups/415', request[:url]
+    assert_equal({details: true}, request[:headers][:params])
+    assert_equal 'Bearer token', request[:headers][:authorization]
+  end
+
+  def test_update_builds_bearer_authorization_header
+    request = @host_vm_groups_interface.dry.update(415, {name: 'group-a'})
+    assert_equal :put, request[:method]
+    assert_equal 'https://example.test/api/host-vm-groups/415', request[:url]
+    assert_equal({name: 'group-a'}.to_json, request[:payload])
+    assert_equal 'Bearer token', request[:headers][:authorization]
+  end
+
+  def test_destroy_builds_bearer_authorization_header
+    request = @host_vm_groups_interface.dry.destroy(415, force: true)
+    assert_equal :delete, request[:method]
+    assert_equal 'https://example.test/api/host-vm-groups/415', request[:url]
+    assert_equal({force: true}, request[:headers][:params])
+    assert_equal 'Bearer token', request[:headers][:authorization]
+  end
+
+end

data/test/api/instances_interface_test.rb

@@ -0,0 +1,22 @@
+require 'mtncloud_test'
+
+# Tests for MtnCloud::InstancesInterface
+class MtnCloudTest::InstancesInterfaceTest < MtnCloudTest::TestCase
+  
+  def test_instances_interface
+    @instances_interface = client.instances
+    response = @instances_interface.list()
+    instances = response['instances']
+    assert instances.is_a?(Array)
+    if !instances.empty?
+      response = @instances_interface.get(instances[0]['id'])
+      instance = response['instance']
+      assert instance.is_a?(Hash)
+      assert_equal instance['id'], instances[0]['id']
+    else
+      #puts "No instances found in this environment"
+    end
+    #todo: create and delete  
+  end
+
+end

data/test/api/network_routers_interface_test.rb

@@ -0,0 +1,22 @@
+require 'mtncloud_test'
+
+# Tests for MtnCloud::InstancesInterface
+class MtnCloudTest::NetworkRoutersInterfaceTest < MtnCloudTest::TestCase
+  
+  def test_network_routers_interface
+    @network_routers_interface = client.network_routers
+    response = @network_routers_interface.list()
+    network_routers = response['networkRouters']
+    assert network_routers.is_a?(Array)
+    if !network_routers.empty?
+      response = @network_routers_interface.get(network_routers[0]['id'])
+      network_router = response['networkRouter']
+      assert network_router.is_a?(Hash)
+      assert_equal network_router['id'], network_routers[0]['id']
+    else
+      #puts "No network routers found in this environment"
+    end
+    #todo: create and delete  
+  end
+
+end

data/test/api/systems_interface_test.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+$LOAD_PATH.unshift(File.expand_path('../../lib', __dir__))
+require 'mtncloud/api/systems_interface'
+
+class SystemsInterfaceTest < Test::Unit::TestCase
+
+  def setup
+    @systems_interface = MtnCloud::SystemsInterface.new(access_token: 'token', url: 'https://example.test', verify_ssl: false)
+  end
+
+  def test_list_network_server_update_definitions_builds_expected_request
+    request = @systems_interface.dry.list_network_server_update_definitions(2, 3, {phrase: 'fw'})
+    assert_equal :get, request[:method]
+    assert_equal 'https://example.test/api/infrastructure/systems/2/network-servers/3/update-definitions', request[:url]
+    assert_equal({phrase: 'fw'}, request[:params])
+  end
+
+  def test_apply_network_server_update_definition_builds_expected_request
+    request = @systems_interface.dry.apply_network_server_update_definition(2, 3, 4, {dryRun: true}, {foo: 'bar'})
+    assert_equal :post, request[:method]
+    assert_equal 'https://example.test/api/infrastructure/systems/2/network-servers/3/update-definitions/4', request[:url]
+    assert_equal({foo: 'bar'}, request[:params])
+    assert_equal({dryRun: true}.to_json, request[:payload])
+  end
+
+end

data/test/api/whoami_interface_test.rb

@@ -0,0 +1,14 @@
+require 'mtncloud_test'
+
+# Tests for MtnCloud::WhoamiInterface
+class MtnCloudTest::WhoamiInterfaceTest < MtnCloudTest::TestCase
+  
+  def test_whoami_interface
+    @whoami_interface = client.whoami
+    response = @whoami_interface.get()
+    assert_equal response['user']['username'], @config.username
+    # todo: fix this, can be cached and fail
+    #assert_equal response['appliance']['buildVersion'], MtnCloud::Cli::Remote.load_remote(@config.remote_name)[:build_version]
+  end
+
+end

data/test/branding_test.rb

@@ -0,0 +1,160 @@
+require 'test/unit'
+require 'stringio'
+require 'timeout'
+require 'tmpdir'
+require 'fileutils'
+require 'mtncloud'
+
+# Offline branding checks for the MTN Cloud CLI, no appliance needed.
+#
+# Renders --help for every command and subcommand and fails if any line still
+# mentions morpheus (other than approved server-side values), or if any help
+# screen raises a Ruby error.
+#
+#   bundle exec ruby -Ilib -Itest test/branding_test.rb
+class BrandingTest < Test::Unit::TestCase
+
+  # Approved keep-list. These are values the appliance or API depends on,
+  # or names of external services, so they must not be rebranded.
+  ALLOWED = [
+    /morph-(cli|api)/,                       # OAuth client IDs
+    /X-Morpheus-(Token|Lease)/,              # API headers
+    /\$?MORPHEUS_LEASE_TOKEN/,               # set by the appliance
+    /morpheus\.(task|workflow|securityScan)/, # job type codes
+    /Default is morpheus\./,                 # blueprint type value, marketplace organization
+    /Morpheus Hub/,                          # HPE's external service
+    /\.morpkg/,                              # package file format
+    /morpheus\.yml/,                         # deploy file fallback
+  ]
+
+  # Known lines still to be rebranded, keyed by the step that removes them.
+  # Remove an entry in the same commit that fixes it, the test fails if an entry no longer appears.
+  PENDING = {
+  }
+
+  class << self
+    attr_reader :screens, :errors
+
+    def startup
+      @screens = {}
+      @errors = []
+      saved_terminal = MtnCloud::Terminal.instance_variable_get(:@morphterm)
+      saved_home = MtnCloud::Cli.home_directory
+      home = Dir.mktmpdir("mtncloud_branding_test")
+      out, err = StringIO.new, StringIO.new
+      # commands print through MtnCloud::Terminal.instance, so point a terminal at StringIOs
+      MtnCloud::Terminal.new(stdin: StringIO.new(""), stdout: out, stderr: err, homedir: home)
+      # include hidden commands, they can still be invoked
+      commands = MtnCloud::Cli::CliRegistry.instance.instance_variable_get(:@commands)
+      commands.sort_by {|name, _| name.to_s }.each do |name, klass|
+        invocations = [["--help"]] + klass.subcommands.keys.map {|sub| [sub.to_s, "--help"] }
+        invocations.each do |args|
+          label = ([name] + args[0..-2]).join(" ")
+          @screens[label] = capture(out, err, label) { klass.new.handle(args.dup) }
+        end
+      end
+    ensure
+      MtnCloud::Terminal.instance_variable_set(:@morphterm, saved_terminal)
+      MtnCloud::Cli.home_directory = saved_home
+      FileUtils.rm_rf(home) if home
+    end
+
+    def capture(out, err, label)
+      [out, err].each {|io| io.truncate(0); io.rewind }
+      old_stdout, old_stderr, old_stdin = $stdout, $stderr, $stdin
+      $stdout, $stderr, $stdin = out, err, StringIO.new("")
+      begin
+        Timeout.timeout(15) { yield }
+      rescue SystemExit
+        # --help exits after printing
+      rescue Timeout::Error
+        @errors << "#{label}: timed out"
+      rescue NameError, NoMethodError, ArgumentError, TypeError => e
+        @errors << "#{label}: #{e.class}: #{e.message.lines.first.strip}"
+      rescue StandardError
+        # other errors, such as no remote configured, are expected offline
+      ensure
+        $stdout, $stderr, $stdin = old_stdout, old_stderr, old_stdin
+      end
+      out.string + err.string
+    end
+  end
+
+  def morpheus_lines
+    lines = []
+    self.class.screens.each do |label, text|
+      text.each_line do |line|
+        line = line.strip
+        next unless line =~ /morpheus/i
+        next if ALLOWED.any? {|re| line =~ re }
+        lines << [label, line]
+      end
+    end
+    lines
+  end
+
+  def test_help_screens_were_rendered
+    assert_operator self.class.screens.size, :>, 1000, "expected to render help for every command and subcommand"
+  end
+
+  def test_help_screens_raise_no_errors
+    assert_empty self.class.errors, "help screens raised errors:\n" + self.class.errors.join("\n")
+  end
+
+  def test_help_has_no_unapproved_morpheus
+    unexpected = morpheus_lines.reject {|_, line| PENDING.keys.any? {|re| line =~ re } }
+    assert_empty unexpected, "help text still mentions morpheus:\n" +
+      unexpected.map {|label, line| "  #{label}: #{line}" }.join("\n")
+  end
+
+  def test_pending_lines_still_exist
+    lines = morpheus_lines.map(&:last)
+    stale = PENDING.reject {|re, _| lines.any? {|line| line =~ re } }
+    assert_empty stale, "these PENDING entries are fixed, remove them from the list:\n" +
+      stale.map {|re, step| "  (#{step}) #{re.inspect}" }.join("\n")
+  end
+
+  def test_version_banner_is_mtn_cloud
+    out = StringIO.new
+    saved_terminal = MtnCloud::Terminal.instance_variable_get(:@morphterm)
+    saved_home = MtnCloud::Cli.home_directory
+    MtnCloud::Terminal.new(stdin: StringIO.new(""), stdout: out, stderr: StringIO.new, homedir: Dir.tmpdir)
+    MtnCloud::Cli::VersionCommand.new.handle([])
+    assert_include out.string, "MTN Cloud CLI"
+    assert_include out.string, "Client Version: #{MtnCloud::Cli::VERSION}"
+    # the old banner spelled Morpheus in ASCII art, which a text search cannot see
+    assert_not_match(/__  ___/, out.string)
+  ensure
+    MtnCloud::Terminal.instance_variable_set(:@morphterm, saved_terminal)
+    MtnCloud::Cli.home_directory = saved_home
+  end
+
+  # update must not make network requests, it only prints the update command
+  def test_update_prints_manual_instructions_without_network
+    out = StringIO.new
+    saved_terminal = MtnCloud::Terminal.instance_variable_get(:@morphterm)
+    saved_home = MtnCloud::Cli.home_directory
+    MtnCloud::Terminal.new(stdin: StringIO.new(""), stdout: out, stderr: StringIO.new, homedir: Dir.tmpdir)
+    HTTP.define_singleton_method(:get) {|*args| raise "update must not make HTTP requests" }
+    # -f and -y are ignored but still accepted
+    exit_code, err = MtnCloud::Cli::UpdateCommand.new.handle(["-f", "-y"])
+    assert_equal 0, exit_code
+    assert_include out.string, "Installed version: #{MtnCloud::Cli::VERSION}"
+    assert_include out.string, "gem update mtncloud-cli"
+  ensure
+    HTTP.singleton_class.send(:remove_method, :get) if HTTP.singleton_methods(false).include?(:get)
+    MtnCloud::Terminal.instance_variable_set(:@morphterm, saved_terminal)
+    MtnCloud::Cli.home_directory = saved_home
+  end
+
+  def test_prog_name_follows_invoked_name
+    original = $0
+    { "/usr/local/bin/mcs" => "mcs", "C:/Ruby33-x64/bin/mcs" => "mcs", "bin/mtncloud" => "mtncloud",
+      "rake" => "mtncloud", "/usr/bin/morpheus" => "mtncloud" }.each do |program, expected|
+      $0 = program
+      assert_equal expected, MtnCloud::Cli.prog_name, "prog_name when invoked as #{program}"
+    end
+  ensure
+    $0 = original
+  end
+end

data/test/cli/access_token_test.rb

@@ -0,0 +1,36 @@
+require 'mtncloud_test'
+
+# Tests for MtnCloud::Cli::AccessTokenCommand
+class MtnCloudTest::AccessTokenTest < MtnCloudTest::TestCase
+  
+  def test_access_token
+    assert_execute("access-token")
+    assert_execute("access-token get")
+    assert_equal(is_logged_in(), true, "is_logged_in() should be true after access-token refresh")
+  end
+
+  def test_access_token_details
+    assert_execute("access-token details")
+  end
+
+  def test_access_token_refresh
+    previous_token = get_access_token()
+    without_authentication do 
+      login()
+      assert_execute("access-token refresh -y")
+      assert_equal(is_logged_in(), true, "is_logged_in() should be true after access-token refresh")
+      new_token = get_access_token()
+      assert_not_equal(previous_token, new_token, "Access token should have changed")
+      assert_error("login --test --token #{previous_token} ", "Old token should no longer be valid after refresh")
+      assert_execute("login --token #{new_token} ", "New token should be valid after refresh")
+    end
+  end
+
+  def test_access_token_unauthenticated
+    without_authentication do 
+      assert_error("access-token")
+      assert_error("access-token get")
+    end
+  end
+
+end