hammer_cli_katello 1.5.0 → 1.5.1

data/test/functional/package/list_test.rb

@@ -0,0 +1,160 @@
+require_relative '../test_helper'
+require_relative '../repository/repository_helpers'
+require_relative '../product/product_helpers'
+require_relative '../organization/organization_helpers'
+require_relative '../lifecycle_environment/lifecycle_environment_helpers'
+require 'hammer_cli_katello/package'
+
+# rubocop:disable ModuleLength
+module HammerCLIKatello
+  describe PackageCommand::ListCommand do
+    include OrganizationHelpers
+    include LifecycleEnvironmentHelpers
+    include RepositoryHelpers
+    include ProductHelpers
+
+    it 'allows minimal options' do
+      api_expects(:packages, :index)
+
+      run_cmd(%w(package list))
+    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(:packages, :index)
+          .with_params('content_view_version_id' => 5)
+          .returns(index_response([{'id' => 1}, {'id' => 2}]))
+
+        run_cmd(%w(package 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(package 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 name' do
+        api_expects_no_call
+
+        r = run_cmd(%w(package list --content-view-version cvv1))
+        assert(r.err.include?("--content-view-id, --content-view is required"),
+               "Invalid error message")
+      end
+    end
+
+    describe 'repository options' do
+      it 'may be specified by ID' do
+        api_expects(:packages, :index).with_params('repository_id' => 1)
+
+        run_cmd(%w(package list --repository-id 1))
+      end
+
+      it 'require product ID when given repository name' do
+        api_expects_no_call
+
+        r = run_cmd(%w(package 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(:packages, :index).with_params('repository_id' => 1)
+
+        run_cmd(%w(package list --repository repo1 --product-id 2))
+      end
+    end
+
+    describe 'environment options' do
+      it 'may be specified environment name' do
+        org_id = 2
+        env_name = "dev"
+        expected_id = 6
+        expect_lifecycle_environment_search(org_id, env_name, expected_id)
+
+        api_expects(:packages, :index).with_params("organization_id" => org_id,
+                                                   "environment_id" => expected_id,
+                                                   "page" => 1, "per_page" => 1000)
+
+        run_cmd(%W(package list --environment=#{env_name} --organization-id=#{org_id}))
+      end
+
+      it 'may be specified environment name no org fails' do
+        api_expects_no_call
+        r = run_cmd(%w(package list --environment Library))
+        expec_err = "Missing options to search organization"
+        puts r.err
+        assert(r.err.include?(expec_err), "Invalid error message")
+      end
+    end
+
+    describe 'product options' do
+      it 'may be specified by ID' do
+        api_expects(:repositories, :index)
+          .with_params('product_id' => 1)
+          .returns(index_response([{'id' => 2}]))
+
+        api_expects(:packages, :index).with_params('repository_id' => 2)
+
+        run_cmd(%w(package list --product-id 1))
+      end
+
+      it 'fail if more than one repository is found' do
+        api_expects(:repositories, :index)
+          .with_params('product_id' => 1)
+          .returns(index_response([{'id' => 2}, {'id' => 3}]))
+
+        r = run_cmd(%w(package list --product-id 1))
+        assert(r.err.include?("Found more than one repository"), "Invalid error message: #{r.err}")
+      end
+
+      it 'requires organization options to resolve ID by name' do
+        api_expects_no_call
+
+        r = run_cmd(%w(package list --product product1))
+        expected_error = "--organization-id, --organization, --organization-label is required"
+        assert(r.err.include?(expected_error), "Invalid error message")
+      end
+
+      it 'allows organization ID when resolving ID by name' do
+        expect_product_search(3, 'product1', 1)
+
+        expect_generic_repositories_search({'product_id' => 1}, [{'id' => 2}])
+
+        api_expects(:packages, :index).with_params('repository_id' => 2)
+
+        run_cmd(%w(package list --product product1 --organization-id 3))
+      end
+
+      it 'allows organization name when resolving ID by name' do
+        expect_organization_search('org3', 3)
+
+        expect_product_search(3, 'product1', 1)
+
+        expect_generic_repositories_search({'product_id' => 1}, [{'id' => 2}])
+
+        api_expects(:packages, :index).with_params('repository_id' => 2)
+
+        run_cmd(%w(package list --product product1 --organization org3))
+      end
+
+      it 'allows organization label when resolving ID by name' do
+        expect_organization_search('org3', 3, field: 'label')
+
+        expect_product_search(3, 'product1', 1)
+
+        expect_generic_repositories_search({'product_id' => 1}, [{'id' => 2}])
+
+        api_expects(:packages, :index).with_params('repository_id' => 2)
+
+        run_cmd(%w(package list --product product1 --organization-label org3))
+      end
+    end
+  end
+end

data/test/functional/package_group/list_test.rb

@@ -0,0 +1,38 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/package_group'
+
+module HammerCLIKatello
+  describe PackageGroupCommand::ListCommand do
+    it 'allows minimal options' do
+      api_expects(:package_groups, :index)
+
+      run_cmd(%w(package-group list))
+    end
+
+    it 'can be provided by repository ID' do
+      api_expects(:package_groups, :index) do |params|
+        params['repository_id'] == 1
+      end
+
+      run_cmd(%w(package-group list --repository-id 1))
+    end
+
+    it 'needs product options with repository name' do
+      cmd = run_cmd(%w(package-group list --repository Repo))
+      api_expects_no_call
+      error_msg = "At least one of options --product, --product-id is required."
+      assert_match error_msg, cmd.err
+    end
+
+    it 'can be provided product id and repository name' do
+      api_expects(:repositories, :index)
+        .with_params(name: "Repo", product_id: 1)
+        .returns(index_response([{'id' => 1}]))
+
+      api_expects(:package_groups, :index)
+        .with_params(repository_id: 1)
+
+      run_cmd(%w(package-group list --repository Repo --product-id 1))
+    end
+  end
+end

data/test/functional/ping_test.rb

@@ -0,0 +1,61 @@
+require_relative 'test_helper'
+
+describe 'ping' do
+  let(:standard_response_services) do
+    {
+      'katello_agent' =>
+        {'status' => 'ok', 'message' => '0 Processed, 0 Failed', 'duration_ms' => '34'},
+      'foreman_tasks' =>
+        {'status' => 'ok', 'duration_ms' => '34'},
+      'candlepin' => {'status' => 'ok', 'duration_ms' => '34'},
+      'candlepin_events' =>
+        {'status' => 'ok', 'message' => '0 Processed, 0 Failed', 'duration_ms' => '34'},
+      'candlepin_auth' =>
+        {'status' => 'ok', 'duration_ms' => '34'},
+      'katello_events' =>
+        {'status' => 'ok', 'message' => '0 Processed, 0 Failed', 'duration_ms' => '34'},
+      'pulp3' =>
+        {'status' => 'ok', 'duration_ms' => '34'},
+      'pulp3_content' =>
+        {'status' => 'ok', 'duration_ms' => '34'}
+    }
+  end
+  let(:standard_response) do
+    {
+      'status' => 'ok',
+      'services' => standard_response_services
+    }
+  end
+  let(:standard_response_keys) do
+    %w(katello_agent foreman_tasks candlepin candlepin_events
+       candlepin_auth katello_events pulp3 pulp3_content).sort
+  end
+  let(:hammer_ping) { %w(ping katello) }
+
+  it 'does not require authentication' do
+    api_expects(:ping, :index).returns(standard_response)
+
+    run_cmd(hammer_ping)
+  end
+
+  it "includes all keys" do
+    api_expects(:ping, :index).returns(standard_response)
+
+    result = JSON.parse(run_cmd(%w(--output=json ping katello))&.out)&.first&.keys&.sort
+    expected = standard_response_keys
+
+    assert_equal result, expected
+  end
+
+  it "skips katello_agent if not included in API response" do
+    response_without_katello_agent = {
+      'status' => 'ok',
+      'services' => standard_response_services.select { |k, _v| k != 'katello_agent' }
+    }
+    api_expects(:ping, :index).returns(response_without_katello_agent)
+    result = JSON.parse(run_cmd(%w(--output=json ping katello))&.out)&.first&.keys&.sort
+    expected = standard_response_keys.select { |k| k != 'katello_agent' }
+
+    assert_equal result, expected
+  end
+end

data/test/functional/product/create_test.rb

@@ -0,0 +1,54 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require File.join(File.dirname(__FILE__), '../organization/organization_helpers')
+require File.join(File.dirname(__FILE__), '../sync_plan/sync_plan_helpers')
+require File.join(File.dirname(__FILE__), '../product/product_helpers')
+
+describe "create a product" do
+  include OrganizationHelpers
+  include SyncPlanHelpers
+  include ProductHelpers
+
+  it 'by organization ID and product name' do
+    api_expects(:products, :create, 'create a product') do |par|
+      par['organization_id'] == 1 && par['name'] = 'product1'
+    end
+
+    assert_equal(
+      0,
+      run_cmd(%w(product create --organization-id 1 --name product1)).exit_code
+    )
+  end
+
+  it 'by organization name and product name' do
+    expect_organization_search('org1', 1)
+    api_expects(:products, :create, 'create a product') do |par|
+      par['organization_id'] == 1 && par['name'] = 'product1'
+    end
+    assert_equal(
+      0,
+      run_cmd(%w(product create --organization org1 --name product1)).exit_code
+    )
+  end
+
+  it 'by organization name, product name, and sync plan' do
+    expect_organization_search('org1', 1)
+    expect_sync_plan_search(1, 'sync_plan1', 1)
+    api_expects(:products, :create, 'create a product with a sync plan') do |par|
+      par['organization_id'] == 1 &&
+        par['name'] == 'product1' &&
+        par['sync_plan_id'] == 1
+    end
+    command = %w(product create --organization org1 --name product1 --sync-plan sync_plan1)
+    assert_equal(
+      0,
+      run_cmd(command).exit_code
+    )
+  end
+
+  it 'fails if no organization is given' do
+    refute_equal(
+      0,
+      run_cmd(%w(product create --name product1)).exit_code
+    )
+  end
+end

data/test/functional/product/delete_test.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require File.join(File.dirname(__FILE__), '../organization/organization_helpers')
+require File.join(File.dirname(__FILE__), '../product/product_helpers')
+
+describe 'delete a product' do
+  include OrganizationHelpers
+  include ProductHelpers
+
+  it 'by ID' do
+    api_expects(:products, :destroy, 'delete a product') do |par|
+      par['id'] == 1
+    end
+    assert_equal(
+      0,
+      run_cmd(%w(product delete --id 1)).exit_code
+    )
+  end
+
+  it 'by organization ID and product name' do
+    expect_product_search(1, 'product1', 1)
+    api_expects(:products, :destroy, 'delete a product') do |par|
+      par['id'] == 1
+    end
+    assert_equal(
+      0,
+      run_cmd(%w(product delete --organization-id 1 --name product1)).exit_code
+    )
+  end
+
+  it 'by organization name and product name' do
+    expect_organization_search('org1', 1)
+    expect_product_search(1, 'product1', 1)
+    api_expects(:products, :destroy, 'delete a product') do |par|
+      par['id'] == 1
+    end
+    assert_equal(
+      0,
+      run_cmd(%w(product delete --organization org1 --name product1)).exit_code
+    )
+  end
+end

data/test/functional/product/info_test.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require File.join(File.dirname(__FILE__), '../organization/organization_helpers')
+require File.join(File.dirname(__FILE__), '../product/product_helpers')
+
+describe "get product info" do
+  include OrganizationHelpers
+  include ProductHelpers
+
+  it 'by ID' do
+    expect_product_show(:id => 1)
+    assert_equal(
+      0,
+      run_cmd(%w(product info --id 1)).exit_code
+    )
+  end
+
+  it 'by organization id and product name' do
+    expect_product_show(:name => 'product1', :org_id => 1, :id => 1)
+    assert_equal(
+      0,
+      run_cmd(%w(product info --organization-id 1 --name product1)).exit_code
+    )
+  end
+
+  it 'by organization name and product name' do
+    expect_organization_search('org1', 1)
+    expect_product_show(:name => 'product1', :org_id => 1, :id => 1)
+    assert_equal(
+      0,
+      run_cmd(%w(product info --organization org1 --name product1)).exit_code
+    )
+  end
+end

data/test/functional/product/list_test.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require File.join(File.dirname(__FILE__), 'product_helpers')
+
+describe "listing products" do
+  include ProductHelpers
+
+  let(:empty_response_table) do
+    <<eostring
+---|------|-------------|--------------|--------------|-----------
+ID | NAME | DESCRIPTION | ORGANIZATION | REPOSITORIES | SYNC STATE
+---|------|-------------|--------------|--------------|-----------
+eostring
+  end
+
+  it 'displays the table properly' do
+    api_expects(:products, :index, 'index products').returns(index_response([]))
+    assert_cmd(
+      success_result(empty_response_table),
+      run_cmd(%w(product list --organization-id 1))
+    )
+  end
+
+  it 'by organization ID' do
+    ex = api_expects(:products, :index, 'index products') do |par|
+      par['organization_id'] == 1
+    end
+    ex.returns(index_response([]))
+
+    assert_equal(
+      0,
+      run_cmd(%w(product list --organization-id 1)).exit_code
+    )
+  end
+
+  it 'by organization ID and subscription ID' do
+    ex = api_expects(:products, :index, 'organization product list') do |par|
+      par['organization_id'] == 1 && par['subscription_id'] == 1
+    end
+    ex.returns(index_response([]))
+
+    assert_equal(
+      0,
+      run_cmd(%w(product list --organization-id 1 --subscription-id 1)).exit_code
+    )
+  end
+
+  it 'by organization ID and sync plan ID' do
+    ex = api_expects(:products, :index, 'organization product list') do |par|
+      par['organization_id'] == 1 && par['sync_plan_id'] == 1
+    end
+    ex.returns(index_response([]))
+
+    assert_equal(
+      0,
+      run_cmd(%w(product list --organization-id 1 --sync-plan-id 1)).exit_code
+    )
+  end
+end

data/test/functional/product/product_helpers.rb

@@ -0,0 +1,24 @@
+module ProductHelpers
+  def expect_generic_product_search(params = {}, returns = {})
+    api_expects(:products, :index, 'Find the Product')
+      .with_params(params).returns(index_response([returns]))
+  end
+
+  def expect_product_search(org_id, name, id)
+    expect_generic_product_search({'name' => name, 'organization_id' => org_id}, 'id' => id)
+  end
+
+  def expect_product_show(options = {})
+    raise "#{__method__} must be called with :id" unless (options.keys & [:id]).size == 1
+
+    if options[:name]
+      raise "#{__method__} used with :name also requires :org_id" unless options[:org_id]
+      expect_product_search(options[:org_id], options[:name], options[:id])
+    end
+
+    ex = api_expects(:products, :show, 'Show a Product') do |par|
+      par['id'] == options[:id]
+    end
+    ex.returns(index_response([{'id' => options[:id]}]))
+  end
+end

data/test/functional/product/remove_sync_plan_test.rb

@@ -0,0 +1,35 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require File.join(File.dirname(__FILE__), '../organization/organization_helpers')
+require File.join(File.dirname(__FILE__), '../sync_plan/sync_plan_helpers')
+require File.join(File.dirname(__FILE__), '../product/product_helpers')
+
+describe "remove a product's sync plan" do
+  include OrganizationHelpers
+  include SyncPlanHelpers
+  include ProductHelpers
+
+  it "by product ID" do
+    api_expects(:products, :update, "set sync plan") do |params|
+      params['id'] == 1 && params['sync_plan_id'].nil?
+    end
+
+    assert_equal(
+      0,
+      run_cmd(%w(product remove-sync-plan --id 1)).exit_code
+    )
+  end
+
+  it "by product name" do
+    expect_product_search(1, 'product1', 1)
+    api_expects(:products, :update, "set sync plan") do |params|
+      params['id'] == 1 && params['sync_plan_id'].nil?
+    end
+
+    assert_equal(
+      0,
+      run_cmd(%w(product remove-sync-plan
+                 --organization-id 1
+                 --name product1)).exit_code
+    )
+  end
+end

data/test/functional/product/set_sync_plan_test.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require File.join(File.dirname(__FILE__), '../organization/organization_helpers')
+require File.join(File.dirname(__FILE__), '../sync_plan/sync_plan_helpers')
+require File.join(File.dirname(__FILE__), '../product/product_helpers')
+
+describe "set a product's sync plan" do
+  include OrganizationHelpers
+  include SyncPlanHelpers
+  include ProductHelpers
+
+  it "by product ID and sync-plan ID" do
+    api_expects(:products, :update, "set sync plan") do |params|
+      params['id'] == 1 && params['sync_plan_id'] == 1
+    end
+
+    assert_equal(
+      0,
+      run_cmd(%w(product set-sync-plan --id 1 --sync-plan-id 1)).exit_code
+    )
+  end
+
+  it "by product ID and sync-plan name (requires org ID)" do
+    expect_sync_plan_search(1, 'syncplan1', 1)
+    api_expects(:products, :update, "set sync plan") do |params|
+      params['id'] == 1 && params['sync_plan_id'] == 1
+    end
+
+    assert_equal(
+      0,
+      run_cmd(%w(product set-sync-plan --organization-id 1 --id 1 --sync-plan syncplan1)).exit_code
+    )
+  end
+
+  it "by product name and sync-plan name (both requiring org ID)" do
+    expect_product_search(1, 'product1', 1)
+    expect_sync_plan_search(1, 'syncplan1', 1)
+    api_expects(:products, :update, "set sync plan") do |params|
+      params['id'] == 1 && params['sync_plan_id'] == 1
+    end
+
+    assert_equal(
+      0,
+      run_cmd(%w(product set-sync-plan
+                 --organization-id 1
+                 --name product1
+                 --sync-plan syncplan1)).exit_code
+    )
+  end
+end

data/test/functional/product/update_proxy.rb

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+describe 'update an http proxy on a product' do
+  include ForemanTaskHelpers
+
+  before do
+    @cmd = %w(product update-proxy)
+  end
+
+  let(:sync_response) do
+    {
+      'id' => 1,
+      'state' => 'planned',
+      'action' => 'Update http proxy'
+    }
+  end
+
+  it 'updates product proxy policy' do
+    params = [
+      '--ids=1',
+      '--http-proxy-policy=use_selected_http_proxy',
+      '--http-proxy-id=1'
+    ]
+
+    ex = api_expects(:products_bulk_actions, :update_http_proxy, 'update an http-proxy')
+         .with_params('ids' => '1', 'http_proxy_policy' => 'use_selected_http_proxy',
+                      'http_proxy_id' => '1')
+    ex.returns(sync_response)
+
+    expect_foreman_task('3')
+
+    result = run_cmd(@cmd + params)
+    assert_equal(HammerCLI::EX_OK, result.exit_code)
+  end
+
+  it 'fails with missing required params' do
+    params = ['--proxy-id=1']
+
+    ex = api_expects(:products_bulk_actions, :update_http_proxy, 'update an http-proxy')
+         .with_params('proxy_id' => '1')
+    ex.returns(
+      'proxy_id' => '1'
+    )
+
+    result = run_cmd(@cmd + params)
+    assert_equal(result.exit_code, 70)
+  end
+end

data/test/functional/product/update_test.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require File.join(File.dirname(__FILE__), '../organization/organization_helpers')
+require File.join(File.dirname(__FILE__), '../product/product_helpers')
+
+describe 'update a product' do
+  include OrganizationHelpers
+  include ProductHelpers
+
+  it 'by product ID' do
+    api_expects(:products, :update, 'update a product') do |par|
+      par['id'] == 1 &&
+        par['description'] == 'new_description'
+    end
+    assert_equal(
+      0,
+      run_cmd(%w(product update --organization-id 1 --id 1 --description new_description)).exit_code
+    )
+  end
+
+  it 'by organization ID and product name' do
+    expect_product_search(1, 'product1', 1)
+    api_expects(:products, :update, 'update a product') do |par|
+      par['id'] == 1 &&
+        par['description'] == 'new_description'
+    end
+    command = %w(product update --organization-id 1 --name product1 --description new_description)
+    assert_equal(
+      0,
+      run_cmd(command).exit_code
+    )
+  end
+
+  it 'by organization name and product name' do
+    expect_organization_search('org1', 1)
+    expect_product_search(1, 'product1', 1)
+    api_expects(:products, :update, 'update a product') do |par|
+      par['id'] == 1 &&
+        par['description'] == 'new_description'
+    end
+    command = %w(product update --organization org1 --name product1 --description new_description)
+    assert_equal(
+      0,
+      run_cmd(command).exit_code
+    )
+  end
+end

data/test/functional/repository/create_test.rb

@@ -0,0 +1,21 @@
+require_relative '../test_helper'
+
+describe "create repository" do
+  let(:org_id) { 1 }
+  let(:product_id) { 2 }
+  let(:name) { "repo1" }
+  let(:content_type) { "yum" }
+
+  it 'with basic options' do
+    api_expects(:repositories, :create)
+      .with_params(
+        name: name,
+        product_id: product_id,
+        content_type: content_type)
+
+    command = %W(repository create --organization-id #{org_id} --product-id #{product_id}
+                 --content-type #{content_type} --name #{name})
+
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+end