hammer_cli_katello 1.5.0 → 1.5.1

data/test/data/Readme.md

@@ -0,0 +1,5 @@
+# Data for tests
+
+Follow the [hammer-cli-foreman
+instructions](https://github.com/theforeman/hammer-cli-foreman/blob/master/test/data/README.md) with the Katello plugin installed in
+Foreman.

data/test/functional/acs/create_test.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+describe 'create content-credentials' do
+  before do
+    @cmd = %w(alternate-content-sources create)
+  end
+
+  let(:name) { 'pizza' }
+  let(:url) { 'http://proxy.example.com' }
+  let(:acs_type) { 'custom' }
+  let(:acs_content) { 'yum' }
+  let(:verify_ssl) { false }
+  let(:proxy_id) { 1 }
+  let(:subpaths) { ['test/repo1/'] }
+
+  it 'Creates an ACS' do
+    params = ["--name=#{name}", "--alternate-content-source-type=#{acs_type}",
+              "--base-url=#{url}", "--content-type=#{acs_content}", "--verify-ssl=#{verify_ssl}",
+              "--smart-proxy-ids=#{proxy_id}", "--subpaths=#{subpaths}"]
+
+    api_expects(:alternate_content_sources, :create, 'Create an ACS')
+
+    expected_result = success_result("Alternate Content Source created.\n")
+    result = run_cmd(@cmd + params)
+    assert_cmd(expected_result, result)
+  end
+end

data/test/functional/acs/delete_test.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+describe 'delete an acs' do
+  let(:id) { 1 }
+
+  it 'by id' do
+    api_expects(:alternate_content_sources, :destroy, 'delete acs').
+      with_params('id' => id)
+
+    command = %W(alternate-content-sources delete --id #{id})
+    assert_equal(0, run_cmd(command).exit_code)
+  end
+end

data/test/functional/acs/info_test.rb

@@ -0,0 +1,55 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require 'hammer_cli_katello/associating_commands'
+
+describe 'get acs info' do
+  before do
+    @cmd = %w(alternate-content-sources info)
+  end
+
+  it 'shows acs info by id' do
+    params = ['--id=1']
+    ex = api_expects(:alternate_content_sources, :show, 'Get info')
+    ex.returns(
+      'id' => 1,
+      'name' => 'Pizza ACS',
+      'label' => 'Pizza ACS',
+      'base_url' => 'https://proxy.example.com',
+      'alternate_content_source_type' => 'custom',
+      'content_type' => 'yum',
+      'smart_proxies' => {
+        'id' => 1,
+        'name' => 'centos7.example.com',
+        'url' => 'https://centos7.example.com:9090',
+        'created_at' => '2022-05-09T17:40:21.007Z',
+        'updated_at' => '2022-05-09T17:40:21.007Z',
+        'expired_logs' => 0,
+        'download_policy' => 'on_demand'
+      },
+      'subpaths' => [
+        'test/repo1'
+      ]
+    )
+    result = run_cmd(@cmd + params)
+    # rubocop:disable Style/WordArray
+    expected_fields = [['ID', '1'],
+                       ['Name', 'Pizza ACS'],
+                       ['Label', 'Pizza ACS'],
+                       ['Base URL', 'https://proxy.example.com'],
+                       ['Alternate content source type', 'custom'],
+                       ['Content type', 'yum'],
+                       ['Smart proxies', ''],
+                       ['Id', '1'],
+                       ['Name', 'centos7.example.com'],
+                       ['URL', 'https://centos7.example.com:9090'],
+                       ['Created at', '2022-05-09T17:40:21.007Z'],
+                       ['Updated at', '2022-05-09T17:40:21.007Z'],
+                       ['Expired logs', '0'],
+                       ['Download policy', 'on_demand'],
+                       ['Subpaths', ''],
+                       ['', 'test/repo1']]
+
+    # rubocop:enable Style/WordArray
+    expected_results = expected_fields.map { |field| success_result(FieldMatcher.new(*field)) }
+    expected_results.each { |expected|  assert_cmd(expected, result) }
+  end
+end

data/test/functional/acs/list_test.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+describe 'listing acs' do
+  before do
+    @cmd = %w(alternate-content-sources list)
+  end
+
+  let(:empty_response) do
+    {
+      "total" => 0,
+      "subtotal" => 0,
+      "page" => "1",
+      "per_page" => "1000",
+      "error" => nil,
+      "search" => nil,
+      "sort" => {
+        "by" => nil,
+        "order" => nil
+      },
+      "results" => []
+    }
+  end
+
+  let(:acs_response) do
+    {
+      'id' => 1,
+      'name' => 'pizza',
+      'alternate_content_source_type' => 'custom'
+    }
+  end
+
+  it "lists acs and returns empty response" do
+    ex = api_expects(:alternate_content_sources, :index, 'acs list') do |par|
+      par['page'] == 1 && par['per_page'] == 1000
+    end
+
+    ex.returns(empty_response)
+
+    expected_result = success_result("---|------|-----
+ID | NAME | TYPE
+---|------|-----
+")
+
+    result = run_cmd(@cmd)
+    assert_cmd(expected_result, result)
+  end
+
+  it "lists acs and returns response" do
+    ex = api_expects(:alternate_content_sources, :index, 'acs list') do |par|
+      par['page'] == 1 && par['per_page'] == 1000
+    end
+
+    ex.returns(acs_response)
+
+    expected_result = success_result("1  | pizza | custom
+---|-------|-------
+")
+
+    result = run_cmd(@cmd)
+    assert_cmd(expected_result, result)
+  end
+end

data/test/functional/acs/update_test.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+describe 'listing acs' do
+  before do
+    @cmd = %w(alternate-content-sources update)
+  end
+
+  let(:id) { 1 }
+  let(:desc) { 'pizza' }
+
+  it 'update acs' do
+    params = ["--id=#{id}", "--description=#{desc}"]
+
+    ex = api_expects(:alternate_content_sources, :update, 'acs update') do |par|
+      par['id'] == 1 && par['description'] == 'pizza'
+    end
+
+    ex.returns({})
+
+    result = run_cmd(@cmd + params)
+    assert_equal(result.exit_code, 0)
+  end
+end

data/test/functional/activation_key/add_host_collection_test.rb

@@ -0,0 +1,62 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/associating_commands'
+
+module HammerCLIKatello
+  module AssociatingCommands
+    module HostCollection
+      describe AddHostCollectionCommand do
+        it 'allows minimal options' do
+          ex = api_expects(:activation_keys, :show) do |p|
+            p[:id] == '1'
+          end
+          ex.returns('id' => 1, host_collections: [{}])
+
+          api_expects(:activation_keys, :update) do |p|
+            p['id'] == '1' && p['organization_id'] == 1 && p['host_collection_ids'] == ['3']
+          end
+
+          run_cmd(%w(activation-key add-host-collection --organization-id 1
+                     --host-collection-id 3 --id 1))
+        end
+
+        it 'allows resolving host collection name' do
+          ex = api_expects(:host_collections, :index) do |p|
+            p['name'] == 'hc3' && p['organization_id'] == 1
+          end
+          ex.returns(index_response([{'id' => 3}]))
+
+          ex = api_expects(:activation_keys, :show) do |p|
+            p[:id] == '1'
+          end
+          ex.returns(id: 1, host_collection_ids: [])
+
+          api_expects(:activation_keys, :update) do |p|
+            p['id'] == '1' && p['organization_id'] == 1 && p['host_collection_ids'] == ['3']
+          end
+
+          run_cmd(%w(activation-key add-host-collection --organization-id 1
+                     --host-collection hc3 --id 1))
+        end
+
+        it 'allows resolving activation key name' do
+          ex = api_expects(:activation_keys, :index) do |p|
+            p['name'] == 'ak1' && p['organization_id'] == 1
+          end
+          ex.at_least_once.returns(index_response([{'id' => 1}]))
+
+          ex = api_expects(:activation_keys, :show) do |p|
+            p[:id] == 1
+          end
+          ex.returns(id: 1, host_collections: [])
+
+          api_expects(:activation_keys, :update) do |p|
+            p['id'] == 1 && p['organization_id'] == 1 && p['host_collection_ids'] == ['3']
+          end
+
+          run_cmd(%w(activation-key add-host-collection --organization-id 1
+                     --host-collection-id 3 --name ak1))
+        end
+      end
+    end
+  end
+end

data/test/functional/activation_key/content_override_test.rb

@@ -0,0 +1,92 @@
+require File.join(File.dirname(__FILE__), '../../test_helper')
+require 'hammer_cli_katello/activation_key'
+
+describe 'activation-key content-override' do
+  before do
+    @cmd = %w(activation-key content-override)
+  end
+  it "attaches a content label" do
+    label = "foo"
+    value = '1'
+    id = 20
+    params = ["--id=#{id}", "--content-label=#{label}", "--value=#{value}"]
+    ex = api_expects(:activation_keys, :content_override) do |par|
+      par['id'] == id && par["content_overrides"][0]['content_label'] == label &&
+        par['content_overrides'][0]['value'] == value &&
+        par['content_overrides'][0]['name'] == "enabled"
+    end
+    ex.returns({})
+
+    expected_result = success_result("Updated content override.\n")
+
+    result = run_cmd(@cmd + params)
+    assert_cmd(expected_result, result)
+  end
+
+  it "attaches a content label with name" do
+    label = "foo"
+    value = '1'
+    id = 20
+    name = 'protected'
+    params = ["--id=#{id}", "--content-label=#{label}", "--value=#{value}",
+              "--override-name=#{name}"]
+    ex = api_expects(:activation_keys, :content_override) do |par|
+      par['id'] == id && par["content_overrides"][0]['content_label'] == label &&
+        par['content_overrides'][0]['value'] == value &&
+        par['content_overrides'][0]['name'] == name
+    end
+    ex.returns({})
+
+    expected_result = success_result("Updated content override.\n")
+
+    result = run_cmd(@cmd + params)
+    assert_cmd(expected_result, result)
+  end
+
+  it "removes override" do
+    label = "foo"
+    id = 20
+    params = ["--id=#{id}", "--content-label=#{label}", "--remove"]
+    ex = api_expects(:activation_keys, :content_override) do |par|
+      par['id'] == id && par["content_overrides"][0]['content_label'] == label &&
+        par['content_overrides'][0]['remove'] == true &&
+        par['content_overrides'][0]['name'] == "enabled"
+    end
+    ex.returns({})
+
+    expected_result = success_result("Updated content override.\n")
+
+    result = run_cmd(@cmd + params)
+    assert_cmd(expected_result, result)
+  end
+
+  it "removes override with name" do
+    label = "foo"
+    id = 20
+    name = 'protected'
+    params = ["--id=#{id}", "--content-label=#{label}", "--override-name=#{name}", "--remove"]
+    ex = api_expects(:activation_keys, :content_override) do |par|
+      par['id'] == id && par["content_overrides"][0]['content_label'] == label &&
+        par['content_overrides'][0]['remove'] == true &&
+        par['content_overrides'][0]['name'] == name
+    end
+    ex.returns({})
+
+    expected_result = success_result("Updated content override.\n")
+
+    result = run_cmd(@cmd + params)
+    assert_cmd(expected_result, result)
+  end
+
+  it "validation fails on no override value or remove" do
+    api_expects_no_call
+    label = "foo"
+    id = 20
+    name = 'protected'
+    params = ["--id=#{id}", "--content-label=#{label}", "--override-name=#{name}"]
+    result = run_cmd(@cmd + params)
+
+    assert(result.err[/At least one of options --remove, --value is required/],
+               "Remove or Value must be provided")
+  end
+end

data/test/functional/activation_key/create_test.rb

@@ -0,0 +1,33 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/activation_key'
+
+module HammerCLIKatello
+  describe ActivationKeyCommand do
+    describe CreateCommand do
+      it 'allows activation key creation' do
+        ex = api_expects(:organizations, :index) do |p|
+          p[:search] == "name = \"org1\""
+        end
+        ex.at_least_once.returns(index_response([{'id' => 1}]))
+
+        ex = api_expects(:lifecycle_environments, :index) do |p|
+          p['organization_id'] == 1 && p['name'] == 'test'
+        end
+        ex.returns(index_response([{'id' => 9}]))
+
+        ex = api_expects(:content_views, :index) do |p|
+          p['name'] == 'cv' && p['organization_id'] == 1
+        end
+        ex.returns(index_response([{'id' => 3}]))
+
+        api_expects(:activation_keys, :create) do |p|
+          p['name'] == 'ak' && p['environment_id'] == 9 && p['organization_id'] == 1 &&
+            p['content_view_id'] == 3
+        end
+
+        run_cmd(%w(activation-key create --organization org1 --name ak --content-view cv
+                   --lifecycle-environment test --unlimited-hosts))
+      end
+    end
+  end
+end

data/test/functional/activation_key/data/activation_key.json

@@ -0,0 +1,17 @@
+{
+  "service_level": null,
+  "id": "1",
+  "organization_id": "1",
+  "name": "test key2",
+  "description": "Activation key",
+  "unlimited_hosts": true,
+  "auto_attach": true,
+  "release_version": null,
+  "purpose_usage": "Usage",
+  "purpose_role": "Role",
+  "environment": {
+    "name": "Library",
+    "id": 1
+  },
+  "purpose_addons": "Test Addon1, Test Addon2"
+}

data/test/functional/activation_key/info_test.rb

@@ -0,0 +1,29 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/associating_commands'
+
+describe 'activation-key info' do
+  before do
+    @cmd = %w(activation-key info)
+  end
+
+  it "includes katello attributes" do
+    params = ['--id=1']
+    ex = api_expects(:activation_keys, :show, "Activation key") do |par|
+      par['id'] == 1
+    end
+
+    json_file = File.join(File.dirname(__FILE__), 'data', 'activation_key.json')
+    ex.returns(JSON.parse(File.read(json_file)))
+
+    result = run_cmd(@cmd + params)
+
+    expected_fields = [['Description', 'Activation key'],
+                       ['Purpose Usage', 'Usage'],
+                       ['Purpose Role', 'Role'],
+                       ['Purpose Addons', 'Test Addon1, Test Addon2'],
+                       ['Lifecycle Environment', 'Library']]
+
+    expected_results = expected_fields.map { |field| success_result(FieldMatcher.new(*field)) }
+    expected_results.each { |expected|  assert_cmd(expected, result) }
+  end
+end

data/test/functional/activation_key/list_test.rb

@@ -0,0 +1,68 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require File.join(File.dirname(__FILE__), '../lifecycle_environment/lifecycle_environment_helpers')
+
+describe 'listing activation-keys' do
+  include LifecycleEnvironmentHelpers
+
+  before do
+    @cmd = %w(activation-key list)
+  end
+
+  let(:org_id) { 1 }
+  let(:lifecycle_env_id) { 1 }
+  let(:empty_response) do
+    {
+      "total" => 0,
+      "subtotal" => 0,
+      "page" => "1",
+      "per_page" => "1000",
+      "error" => nil,
+      "search" => nil,
+      "sort" => {
+        "by" => nil,
+        "order" => nil
+      },
+      "results" => []
+    }
+  end
+
+  it "lists an organizations activation-keys" do
+    params = ["--organization-id=#{org_id}"]
+
+    ex = api_expects(:activation_keys, :index, 'Organization activation-key list') do |par|
+      par['organization_id'] == org_id && par['page'] == 1 &&
+        par['per_page'] == 1000
+    end
+
+    ex.returns(empty_response)
+
+    expected_result = success_result("---|------|------------|-----------------------|-------------
+ID | NAME | HOST LIMIT | LIFECYCLE ENVIRONMENT | CONTENT VIEW
+---|------|------------|-----------------------|-------------
+")
+
+    result = run_cmd(@cmd + params)
+    assert_cmd(expected_result, result)
+  end
+
+  it "lists the activation-keys belonging to a lifecycle environment by name" do
+    params = ["--organization-id=#{org_id}", '--lifecycle-environment=test']
+
+    expect_lifecycle_environment_search(org_id, 'test', lifecycle_env_id)
+
+    ex = api_expects(:activation_keys, :index, 'lifecycle activation-key list') do |par|
+      par['organization_id'] == org_id && par['page'] == 1 &&
+        par['per_page'] == 1000
+    end
+
+    ex.returns(empty_response)
+
+    expected_result = success_result("---|------|------------|-----------------------|-------------
+ID | NAME | HOST LIMIT | LIFECYCLE ENVIRONMENT | CONTENT VIEW
+---|------|------------|-----------------------|-------------
+")
+
+    result = run_cmd(@cmd + params)
+    assert_cmd(expected_result, result)
+  end
+end

data/test/functional/activation_key/product_content_test.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+describe 'listing available product content' do
+  let(:activation_key_id) { 1 }
+  let(:empty_response_table) do
+    <<eostring
+---|------|------|-----|---------|-------|------------------|---------
+ID | NAME | TYPE | URL | GPG KEY | LABEL | DEFAULT ENABLED? | OVERRIDE
+---|------|------|-----|---------|-------|------------------|---------
+eostring
+  end
+
+  it "lists content available for an activation key" do
+    ex = api_expects(:activation_keys, :product_content) do |p|
+      p['id'] = activation_key_id
+    end
+    ex.returns(index_response([]))
+    assert_cmd(
+      success_result(empty_response_table),
+      run_cmd(%w(activation-key product-content --id 1))
+    )
+  end
+end

data/test/functional/activation_key/remove_host_collection_test.rb

@@ -0,0 +1,62 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/associating_commands'
+
+module HammerCLIKatello
+  module AssociatingCommands
+    module HostCollection
+      describe RemoveHostCollectionCommand do
+        it 'allows minimal options' do
+          ex = api_expects(:activation_keys, :show) do |p|
+            p[:id] == '1'
+          end
+          ex.returns('id' => 1, host_collections: [{'id' => 3}])
+
+          api_expects(:activation_keys, :update) do |p|
+            p['id'] == '1' && p['organization_id'] == 1 && p['host_collection_ids'] == []
+          end
+
+          run_cmd(%w(activation-key remove-host-collection --organization-id 1
+                     --host-collection-id 3 --id 1))
+        end
+
+        it 'allows resolving host collection name' do
+          ex = api_expects(:host_collections, :index) do |p|
+            p['name'] == 'hc3' && p['organization_id'] == 1
+          end
+          ex.returns(index_response([{id: 1}]))
+
+          ex = api_expects(:activation_keys, :show) do |p|
+            p[:id] == '1'
+          end
+          ex.returns(id: 1, host_collections: [{'id' => 3}])
+
+          api_expects(:activation_keys, :update) do |p|
+            p['id'] == '1' && p['organization_id'] == 1 && p['host_collection_ids'] == []
+          end
+
+          run_cmd(%w(activation-key remove-host-collection --organization-id 1
+                     --host-collection hc3 --id 1))
+        end
+
+        it 'allows resolving activation key name' do
+          ex = api_expects(:activation_keys, :index) do |p|
+            p['name'] == 'ak1' && p['organization_id'] == 1
+          end
+          ex.at_least_once.returns(index_response([{'id' => 1}]))
+
+          ex = api_expects(:activation_keys, :show) do |p|
+            p[:id] == 1
+          end
+          ex.returns(id: 1, host_collections: [{'id' => 3}])
+
+          api_expects(:activation_keys, :update) do |p|
+            p['id'] == 1 && p['organization_id'] == 1 && p['host_collection_ids'] == []
+          end
+
+          run_cmd(%w(activation-key remove-host-collection --organization-id 1
+                     --host-collection-id 3 --name ak1))
+        end
+      end
+    end
+  end
+end

data/test/functional/activation_key/subscriptions_test.rb

@@ -0,0 +1,74 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/activation_key'
+
+module HammerCLIKatello
+  describe ActivationKeyCommand::SubscriptionsCommand do
+    it 'requires organization options' do
+      expected_error = "Could not find organization"
+      result = run_cmd(%w(activation-key subscriptions --name test))
+      assert_equal(result.err[/#{expected_error}/], expected_error)
+    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(activation-key subscriptions --id 1 --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(activation-key subscriptions --id 1 --organization-label org1))
+    end
+
+    it 'lists subscriptions available for the activation key' do
+      api_expects(:subscriptions, :index) do |p|
+        p['available_for'] == 'activation_key'
+      end
+      run_cmd(%w(activation-key subscriptions --organization-id 1 --id 1
+                 --available-for activation_key))
+    end
+
+    it 'lists subscriptions used by the activation key' do
+      api_expects(:subscriptions, :index) { |p| p['activation_key_id'] == '1' }
+      run_cmd(%w(activation-key subscriptions --organization-id 1 --id 1))
+    end
+
+    it 'allows activation_key_name' do
+      api_expects(:activation_keys, :index) { |p| p['name'] == 'ak1' }
+        .returns(index_response([{'id' => 1}]))
+      api_expects(:subscriptions, :index) { |p| p['activation_key_id'] == 1 }
+      run_cmd(%w(activation-key subscriptions --organization-id 1 --name ak1))
+    end
+
+    it 'allows a subscription to be added to an activation key' do
+      api_expects(:activation_keys, :add_subscriptions) do |p|
+        p['id'] == 1 && p['subscription_id'] == 3
+      end
+      run_cmd(%w(activation-key add-subscription --id 1 --subscription-id 3))
+    end
+
+    it 'allows a subscription to be added by name to an activation key with org label' do
+      api_expects(:organizations, :index) { |par| par[:search] == "label = \"org1\"" }
+        .returns(index_response([{'id' => 1}]))
+      api_expects(:subscriptions, :index) { |p| p['name'] == 'sub' }
+        .returns(index_response([{'name' => 'sub'}]))
+      api_expects(:activation_keys, :add_subscriptions) { |p| p['id'] == 1 }
+      run_cmd(%w(activation-key add-subscription --id 1 --subscription sub
+                 --organization-label org1))
+    end
+
+    it 'allows multiple subscriptions to be added to an activation key' do
+      api_expects(:activation_keys, :add_subscriptions) do |p|
+        p['id'] == 1 && p['subscriptions'] == [{'id' => '3'}, {'id' => '4'}]
+      end
+      run_cmd(%w(activation-key add-subscription --id 1 --subscriptions id=3,id=4))
+    end
+  end
+end