hammer_cli_katello 1.1.3 → 1.2.0

data/test/functional/srpm/list_test.rb

@@ -0,0 +1,92 @@
+require_relative '../test_helper'
+require_relative '../repository/repository_helpers'
+require_relative '../product/product_helpers'
+require_relative '../organization/organization_helpers'
+require 'hammer_cli_katello/package'
+require 'hammer_cli_katello/srpm'
+
+module HammerCLIKatello
+  describe PackageCommand::ListCommand do
+    include OrganizationHelpers
+    include RepositoryHelpers
+    include ProductHelpers
+
+    it 'allows minimal options' do
+      api_expects(:srpms, :index)
+
+      run_cmd(%w(srpm list))
+    end
+
+    describe 'repository options' do
+      it 'may be specified by ID' do
+        api_expects(:srpms, :index).with_params('repository_id' => 1)
+
+        run_cmd(%w(srpm list --repository-id 1))
+      end
+
+      it 'require product ID when given repository name' do
+        api_expects_no_call
+
+        r = run_cmd(%w(srpm list --repository repo1))
+        assert(r.err.include?("--product-id, --product is required"), "Invalid error message")
+      end
+
+      it 'may be specified by name and product ID' do
+        expect_repository_search(2, 'repo1', 1)
+
+        api_expects(:srpms, :index).with_params('repository_id' => 1)
+
+        run_cmd(%w(srpm list --repository repo1 --product-id 2))
+      end
+    end
+
+    describe 'organization options' do
+      it 'may be specified by ID' do
+        api_expects(:srpms, :index).with_params('organization_id' => 1)
+
+        run_cmd(%w(srpm list --organization-id 1))
+      end
+
+      it 'may be specified by name' do
+        expect_organization_search('org3', 1)
+        api_expects(:srpms, :index).with_params('organization_id' => 1)
+
+        run_cmd(%w(srpm list --organization org3))
+      end
+
+      it 'may be specified by label' do
+        expect_organization_search('org3', 1, field: 'label')
+        api_expects(:srpms, :index).with_params('organization_id' => 1)
+
+        run_cmd(%w(srpm list --organization-label org3))
+      end
+    end
+
+    describe 'content-view options' do
+      it 'may be specified by ID' do
+        api_expects(:content_view_versions, :index)
+          .with_params('content_view_id' => 1, 'version' => '2.1')
+          .returns(index_response([{'id' => 5}]))
+        api_expects(:srpms, :index).with_params('content_view_version_id' => 5)
+
+        run_cmd(%w(srpm list --content-view-id 1 --content-view-version 2.1))
+      end
+
+      it 'requires organization ID when given content view name' do
+        api_expects_no_call
+
+        r = run_cmd(%w(srpm list --content-view cv1 --content-view-version 2.1))
+        expected_error = "--organization-id, --organization, --organization-label is required"
+        assert(r.err.include?(expected_error), "Invalid error message")
+      end
+
+      it 'requires content view ID when given content view version number' do
+        api_expects_no_call
+
+        r = run_cmd(%w(srpm list --content-view-version cvv1))
+        assert(r.err.include?("--content-view-id, --content-view is required"),
+               "Invalid error message")
+      end
+    end
+  end
+end

data/test/functional/subscription/list_test.rb

@@ -0,0 +1,86 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/subscription'
+
+module HammerCLIKatello
+  describe SubscriptionCommand::ListCommand do
+    before do
+      @cmd = %w(subscription list)
+    end
+
+    let(:org_id) { 1 }
+
+    it "returns the correct subscription type" do
+      cmd = SubscriptionCommand::ListCommand.new({})
+      assert_equal("Physical", cmd.get_subscription_type("virt_only" => false))
+
+      hostname = "boo.com"
+      with_hostname = cmd.get_subscription_type("virt_only" => true, "host" => {"name" => hostname})
+      assert(with_hostname.include?(hostname))
+
+      assert_equal("Temporary",
+                   cmd.get_subscription_type("virt_only" => true, "unmapper_guest" => true))
+
+      assert_equal("Virtual",
+                   cmd.get_subscription_type("virt_only" => true))
+    end
+
+    it "lists an organizations subscriptions" do
+      params = ["--organization-id=#{org_id}"]
+
+      ex = api_expects(:subscriptions, :index, 'Subscription list') do |par|
+        par['organization_id'] == org_id
+      end
+
+      ex.returns(index_response([]))
+
+      result = run_cmd(@cmd + params)
+
+      fields = ['ID', 'UUID', 'NAME', 'TYPE', 'CONTRACT', 'ACCOUNT', 'SUPPORT',
+                'START DATE', 'END DATE', 'QUANTITY', 'CONSUMED']
+      expected_result = success_result(IndexMatcher.new([fields, []]))
+      assert_cmd(expected_result, result)
+    end
+
+    it 'allows organization name' do
+      api_expects(:organizations, :index) { |par| par[:search] == "name = \"org1\"" }
+        .returns(index_response([{'id' => 1}]))
+
+      api_expects(:subscriptions, :index) { |par| par['organization_id'].to_i == 1 }
+
+      run_cmd(%w(subscription list --organization org1))
+    end
+
+    it 'allows organization label' do
+      api_expects(:organizations, :index) { |par| par[:search] == "label = \"org1\"" }
+        .returns(index_response([{'id' => 1}]))
+
+      api_expects(:subscriptions, :index) { |par| par['organization_id'].to_i == 1 }
+
+      run_cmd(%w(subscription list --organization-label org1))
+    end
+
+    it 'allows host id' do
+      api_expects(:subscriptions, :index) { |par| par['host_id'] == 1 }
+      run_cmd(%w(subscription list --organization-id 1 --host-id 1))
+    end
+
+    it 'allows host name' do
+      api_expects(:hosts, :index) { |par| par[:search] == "name = \"host1\"" }
+        .returns(index_response([{'id' => 1}]))
+      api_expects(:subscriptions, :index) { |par| par['host_id'] == 1 }
+      run_cmd(%w(subscription list --organization-id 1 --host host1))
+    end
+
+    it 'allows activation key id' do
+      api_expects(:subscriptions, :index) { |par| par['activation_key_id'] == 1 }
+      run_cmd(%w(subscription list --organization-id 1 --activation-key-id 1))
+    end
+
+    it 'allows activation key name' do
+      api_expects(:activation_keys, :index) { |par| par['name'] == "ak1" }
+        .returns(index_response([{'id' => 1}]))
+      api_expects(:subscriptions, :index) { |par| par['activation_key_id'] == 1 }
+      run_cmd(%w(subscription list --organization-id 1 --activation-key ak1))
+    end
+  end
+end

data/test/functional/sync_plan/create_test.rb

@@ -0,0 +1,60 @@
+require_relative '../test_helper'
+
+describe "create sync plan" do
+  let(:org_id) { 1 }
+  let(:name) { "sync_plan1" }
+  let(:hourly) { "hourly" }
+  let(:custom) { "custom cron" }
+  let(:cron) { "10 * * * *" }
+  let(:date) { "2018-09-08T00:00:00+00:00" }
+
+  it 'with organization ID,name,interval,date and enabled' do
+    api_expects(:sync_plans, :create, 'create a sync plan').
+      with_params('organization_id' => org_id,
+                  'name' => name,
+                  'interval' => hourly,
+                  'sync_date' => date,
+                  'enabled' => true)
+    command = %W(sync-plan create --organization-id #{org_id} --name #{name}
+                 --interval #{hourly} --enabled 1 --sync-date #{date})
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+
+  it 'with custom cron' do
+    api_expects(:sync_plans, :create, 'create a sync plan').
+      with_params('organization_id' => org_id,
+                  'name' => name,
+                  'interval' => custom,
+                  'cron_expression' => cron,
+                  'sync_date' => date,
+                  'enabled' => true)
+    # end
+    command = %W(sync-plan create --organization-id #{org_id} --name #{name} --interval #{custom}
+                 --cron-expression #{cron} --enabled 1 --sync-date #{date})
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+
+  it 'fails without organization-id' do
+    command = %w(sync-plan create --name #{name}
+                 --interval #{hourly} --enabled 1 --sync-date #{date})
+    refute_equal(0, run_cmd(command).exit_code)
+  end
+
+  it 'fails without name' do
+    command = %w(sync-plan create --organization-id #{org_id}
+                 --interval #{hourly} --enabled 1 --sync-date #{date})
+    refute_equal(0, run_cmd(command).err)
+  end
+
+  it 'fails without interval' do
+    command = %w(sync-plan create --organization-id #{org_id} --name #{name}
+                 --enabled 1 --sync-date #{date})
+    refute_equal(0, run_cmd(command).exit_code)
+  end
+
+  it 'fails without enabled' do
+    command = %w(sync-plan create --organization-id #{org_id} --name #{name}
+                 --interval #{hourly} --sync-date #{date})
+    refute_equal(0, run_cmd(command).exit_code)
+  end
+end

data/test/functional/sync_plan/delete_test.rb

@@ -0,0 +1,46 @@
+require_relative '../test_helper'
+require_relative 'sync_plan_helpers'
+require_relative '../organization/organization_helpers'
+
+describe 'delete a sync plan' do
+  include OrganizationHelpers
+  include SyncPlanHelpers
+
+  let(:org_id) { 1 }
+  let(:id) { 1 }
+  let(:name) { "sync_plan1" }
+  let(:org_name) { "org1" }
+
+  it 'by organization ID and sync plan id' do
+    api_expects(:sync_plans, :destroy, 'delete a sync plan').
+      with_params('organization_id' => org_id,
+                  'id' => id)
+    command = %W(sync-plan delete --organization-id #{org_id} --id #{id})
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+
+  it 'by organization ID and sync plan name' do
+    expect_sync_plan_search(1, 'sync_plan1', 1)
+    api_expects(:sync_plans, :destroy, 'delete a sync plan').
+      with_params('id' => id)
+    command = %W(sync-plan delete --organization-id #{org_id} --name #{name})
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+
+  it 'by organization name and sync plan name' do
+    expect_organization_search('org1', 1)
+    expect_sync_plan_search(1, 'sync_plan1', 1)
+    api_expects(:sync_plans, :destroy, 'delete a sync plan').
+      with_params('id' => id)
+    command = %W(sync-plan delete --organization #{org_name} --name #{name})
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+
+  it 'by organization name and sync plan id' do
+    expect_organization_search(org_name, org_id)
+    api_expects(:sync_plans, :destroy, 'delete a sync plan').
+      with_params('id' => id)
+    command = %W(sync-plan delete --organization #{org_name} --id #{id})
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+end

data/test/functional/sync_plan/info_test.rb

@@ -0,0 +1,37 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/sync_plan'
+require_relative 'sync_plan_helpers'
+require_relative '../organization/organization_helpers'
+module HammerCLIKatello
+  describe SyncPlan::InfoCommand do
+    include OrganizationHelpers
+    include SyncPlanHelpers
+
+    it 'allows ID' do
+      api_expects(:sync_plans, :show).with_params('id' => 1)
+
+      run_cmd(%w(sync-plan info --id 1))
+    end
+
+    it 'allows organization id and sync plan name' do
+      org_id = 1
+      name = "SyncPlan1"
+      id = 100
+      expect_sync_plan_search(org_id, name, id)
+      api_expects(:sync_plans, :show).with_params('id' => id)
+      run_cmd("sync-plan info --organization-id #{org_id} --name #{name}".split)
+    end
+
+    it 'allows organization name and sync plan name' do
+      org_id = 1
+      org_label = "org"
+      name = "SyncPlan1"
+      id = 100
+
+      expect_organization_search(org_label, org_id, field: 'label')
+      expect_sync_plan_search(org_id, name, id)
+      api_expects(:sync_plans, :show).with_params('id' => id)
+      run_cmd("sync-plan info --organization-label #{org_label} --name #{name}".split)
+    end
+  end
+end

data/test/functional/sync_plan/list_test.rb

@@ -0,0 +1,31 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/sync_plan'
+require_relative 'sync_plan_helpers'
+require_relative '../organization/organization_helpers'
+
+module HammerCLIKatello
+  describe SyncPlan::ListCommand do
+    include SyncPlanHelpers
+    include OrganizationHelpers
+
+    it 'allows minimal options' do
+      expect_sync_plan_search(1, nil, nil)
+
+      run_cmd(%w(sync-plan list --organization-id 1))
+    end
+
+    it 'allows org name' do
+      expect_organization_search('org1', 1)
+      expect_sync_plan_search(1, nil, nil)
+
+      run_cmd(%w(sync-plan list --organization org1))
+    end
+
+    it 'allows org label' do
+      expect_organization_search('org1', 1, field: 'label')
+      expect_sync_plan_search(1, nil, nil)
+
+      run_cmd(%w(sync-plan list --organization-label org1))
+    end
+  end
+end

data/test/functional/sync_plan/sync_plan_helpers.rb

@@ -0,0 +1,8 @@
+module SyncPlanHelpers
+  def expect_sync_plan_search(org_id, name, id)
+    ex = api_expects(:sync_plans, :index, 'find sync plan') do |par|
+      par['name'] == name && par['organization_id'] == org_id
+    end
+    ex.returns(index_response([{'id' => id}]))
+  end
+end

data/test/functional/sync_plan/update_test.rb

@@ -0,0 +1,44 @@
+require_relative '../test_helper'
+require_relative 'sync_plan_helpers'
+require_relative '../organization/organization_helpers'
+
+describe 'update a sync plan' do
+  include OrganizationHelpers
+  include SyncPlanHelpers
+
+  let(:org_id) { 1 }
+  let(:id) { 1 }
+  let(:name) { "sync_plan1" }
+  let(:org_name) { "org1" }
+  let(:desc) { "New Description" }
+
+  it 'with organization id and sync plan ID' do
+    api_expects(:sync_plans, :update, 'update a sync plan').
+      with_params('description' => desc,
+                  'id' => id)
+    command = %W(sync-plan update --organization-id #{org_id} --id #{id}
+                 --description #{desc})
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+
+  it 'with organization ID and sync plan name' do
+    expect_sync_plan_search(org_id, name, id)
+    api_expects(:sync_plans, :update, 'update a sync plan').
+      with_params('description' => desc,
+                  'id' => id)
+    command = %W(sync-plan update --organization-id #{org_id} --name #{name}
+                 --description #{desc})
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+
+  it 'with organization name and sync plan name' do
+    expect_organization_search(org_name, org_id)
+    expect_sync_plan_search(org_id, name, id)
+    api_expects(:sync_plans, :update, 'update a sync plan').
+      with_params('description' => desc,
+                  'id' => id)
+    command = %W(sync-plan update --organization #{org_name} --name #{name}
+                 --description #{desc})
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+end

data/test/functional/test_helper.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+require 'hammer_cli/testing/output_matchers'
+require 'hammer_cli/testing/command_assertions'
+require 'hammer_cli/testing/data_helpers'
+require 'hammer_cli_foreman/testing/api_expectations'
+
+include HammerCLI::Testing::OutputMatchers
+include HammerCLI::Testing::CommandAssertions
+include HammerCLI::Testing::DataHelpers
+include HammerCLIForeman::Testing::APIExpectations
+
+def assert_success(command_run_result)
+  assert command_run_result.exit_code.zero?,
+    "Nonzero exit code (#{command_run_result.exit_code}): #{command_run_result.err}"
+end
+
+def assert_failure(command_run_result, msg = nil)
+  assert !command_run_result.exit_code.zero?, "Success exit code (0) when expecting failure"
+  if msg
+    assert command_run_result.err[msg],
+      "Actual:\n#{command_run_result.err}\nExpected:\n#{msg.inspect}"
+  end
+end

data/test/task_helper.rb

@@ -0,0 +1,7 @@
+module ForemanTaskHelpers
+  def expect_foreman_task(task_id)
+    ex = api_expects(:foreman_tasks, :show, 'Show task')
+    ex.returns('id' => task_id, 'state' => 'stopped', 'progress' => 1,
+               'humanized' => {'output' => '', 'errors' => ''})
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+if RUBY_VERSION > "2.2"
+  # Coverage - Keep these two lines at the top of this file
+  require 'simplecov'
+  require 'coveralls'
+  SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
+  SimpleCov.start do
+    minimum_coverage 70
+    maximum_coverage_drop 0.1
+    track_files "lib/**/*.rb"
+    add_filter '/test/'
+  end
+end
+
+require File.join(File.dirname(__FILE__), './task_helper.rb')
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'mocha/minitest'
+require 'hammer_cli'
+
+KATELLO_VERSION = Gem::Version.new(ENV['TEST_API_VERSION'] || '4.1')
+
+if HammerCLI.context[:api_connection]
+  HammerCLI.context[:api_connection].create('foreman') do
+    HammerCLI::Apipie::ApiConnection.new(
+      :apidoc_cache_dir => 'test/data/' + KATELLO_VERSION.to_s,
+      :apidoc_cache_name => 'foreman_api',
+      :dry_run => true
+    )
+  end
+else
+  HammerCLIForeman.stubs(:resource_config).returns(
+    :apidoc_cache_dir => 'test/data/' + KATELLO_VERSION.to_s,
+    :apidoc_cache_name => 'foreman_api',
+    :dry_run => true
+  )
+end
+
+require 'hammer_cli_katello'

data/test/unit/id_name_options_validator_test.rb

@@ -0,0 +1,96 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/id_name_options_validator'
+
+module HammerCLIKatello
+  describe IdNameOptionsValidator do
+    before(:each) do
+      @cmd = Object.new
+      @cmd.extend(IdNameOptionsValidator)
+      @cmd.class.send(:define_method, :validate_options) do |*_args, &block|
+        block.call
+      end
+    end
+
+    describe '#validate_id_or_name_with_parent' do
+      it 'accepts no record name and validates id, name, and parent opts' do
+        any_stub = stub(:required => true)
+        option_stub = stub(:exist? => true)
+        @cmd.stubs(:option).returns(option_stub)
+
+        @cmd.expects(:any).with('option_id', 'option_name').returns(any_stub)
+        @cmd.expects(:any).with('option_organization_id',
+                                'option_organization_name',
+                                'option_organization_label'
+                               ).returns(any_stub)
+
+        @cmd.validate_id_or_name_with_parent
+      end
+
+      it 'accepts content view as a record name' do
+        any_stub = stub(:required => true)
+        option_stub = stub(:exist? => true)
+        @cmd.stubs(:option).returns(option_stub)
+
+        @cmd.expects(:any).with('option_content_view_id',
+                                'option_content_view_name'
+                               ).returns(any_stub)
+        @cmd.expects(:any).with('option_organization_id',
+                                'option_organization_name',
+                                'option_organization_label'
+                               ).returns(any_stub)
+
+        @cmd.validate_id_or_name_with_parent(:content_view)
+      end
+
+      it 'does not validate org options if the name opt is not used' do
+        any_stub = stub(:required => true)
+        option_stub = stub(:exist? => false) # --name was not supplied
+        @cmd.stubs(:option).returns(option_stub)
+
+        @cmd.expects(:any).at_most_once.returns(any_stub)
+
+        @cmd.validate_id_or_name_with_parent
+      end
+
+      it 'does not validate name or id if required is false' do
+        any_stub = stub(:required => true)
+        option_stub = stub(:exist? => true)
+        @cmd.stubs(:option).returns(option_stub)
+
+        @cmd.expects(:any).with('option_organization_id',
+                                'option_organization_name',
+                                'option_organization_label'
+                               ).returns(any_stub)
+
+        @cmd.validate_id_or_name_with_parent(required: false)
+      end
+
+      it 'accepts a hash of fields for the parent' do
+        any_stub = stub(:required => true)
+        option_stub = stub(:exist? => true)
+        @cmd.stubs(:option).returns(option_stub)
+
+        @cmd.expects(:any).with('option_id', 'option_name').returns(any_stub)
+        @cmd.expects(:any).with('option_product_test').returns(any_stub)
+
+        @cmd.validate_id_or_name_with_parent(parent: {:product => ['test']})
+      end
+    end
+
+    describe '#validate_id_or_name' do
+      it 'validates that id or name is required' do
+        any_stub = stub(:required => true)
+        @cmd.expects(:any).with('option_id', 'option_name').returns(any_stub)
+        @cmd.validate_id_or_name
+      end
+
+      it 'accepts a custom record name' do
+        any_stub = stub(:required => true)
+        @cmd.expects(:any).with('option_content_view_id',
+                                'option_content_view_name'
+                               ).returns(any_stub)
+        @cmd.validate_id_or_name(:content_view)
+      end
+    end
+  end
+end

data/test/unit/id_resolver_test.rb

@@ -0,0 +1,58 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/id_resolver'
+
+module HammerCLIKatello
+  describe IdResolver do
+    let(:api) { mock('api') }
+    let(:searchables) { mock('searchables') }
+    let(:id_resolver) { IdResolver.new api, searchables }
+
+    before(:each) do
+      api.stubs(:resources).returns([])
+      api.stubs(:resource).returns([])
+    end
+
+    describe '#repository_ids' do
+      it 'accepts nil repository_names' do
+        id_resolver.stubs(:find_resources).returns([])
+        id_resolver.repository_ids({}).must_equal(nil)
+      end
+
+      it 'accepts repository_ids' do
+        id_resolver.repository_ids(
+          'option_repository_ids' => [1, 2]
+        ).must_equal [1, 2]
+      end
+
+      it 'accepts repository_names' do
+        id_resolver.stubs(:find_resources).returns(
+          [
+            {'id' => 1, 'name' => 'repo1'},
+            {'id' => 2, 'name' => 'repo2'}
+          ]
+        )
+        id_resolver.repository_ids(
+          'option_names' => %w(repo1 repo2)
+        ).must_equal [1, 2]
+      end
+    end
+
+    describe '#repository_id' do
+      it 'resolves ID from name' do
+        id_resolver.expects(:find_resource).with(:repositories, name: 'repo1').returns('id' => 5)
+        options = {name: 'repo1'}
+        id_resolver.repository_id(options).must_equal 5
+      end
+    end
+
+    describe '#content_view_version_id' do
+      it 'resolves ID from version number' do
+        options = {'option_version' => '2.0', 'option_content_view_id' => 4}
+        id_resolver.expects(:find_resources)
+                   .with(:content_view_versions, options)
+                   .returns(['id' => 5])
+        id_resolver.content_view_version_id(options).must_equal 5
+      end
+    end
+  end
+end

data/test/unit/messages_test.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require 'hammer_cli/testing/messages'
+
+include HammerCLI::Testing::Messages
+describe "message formatting" do
+  check_all_command_messages(HammerCLI::MainCommand, HammerCLIKatello::Command)
+end