hammer_cli_katello 1.1.3 → 1.2.0

data/test/functional/hostgroup/update_test.rb

@@ -0,0 +1,120 @@
+require_relative '../test_helper'
+require 'hammer_cli_foreman/hostgroup'
+module HammerCLIForeman
+  describe Hostgroup do
+    # These tests are only for the extensions Katello adds to the hostgroup command
+    # See hammer-cli-foreman for the core hostgroup tests
+    describe UpdateCommand do
+      it 'allows content source id' do
+        api_expects(:hostgroups, :update) do |p|
+          p['id'] == '1' && p['hostgroup']['content_source_id'] == 1
+        end
+        run_cmd(%w(hostgroup update --id 1 --content-source-id 1))
+      end
+
+      it 'allows content source name' do
+        content_source_name = "life_of_cs"
+        content_source_id = 111
+        hg_id = 441
+
+        api_expects(:smart_proxies, :index).
+          with_params(:search => "name = \"#{content_source_name}\"").
+          returns(index_response([{'id' => content_source_id}]))
+
+        api_expects(:hostgroups, :update).
+          with_params('id' => hg_id.to_s,
+                      'hostgroup' => {'content_source_id' => content_source_id
+                                     })
+
+        cmd = "hostgroup update --id #{hg_id} --content-source #{content_source_name}"
+        run_cmd(cmd.split)
+      end
+
+      it 'allows content view id' do
+        api_expects(:hostgroups, :update) do |p|
+          p['id'] == '1' && p['hostgroup']['content_view_id'] == 1
+        end
+        run_cmd(%w(hostgroup update --id 1 --content-view-id 1))
+      end
+
+      it 'allows content view name' do
+        ex = api_expects(:content_views, :index) do |p|
+          p[:search] = "name = \"cv1\"" && p['organization_id'] == '1'
+        end
+        ex.returns(index_response([{'id' => 1}]))
+        api_expects(:hostgroups, :update) do |p|
+          p['id'] == '1' && p['hostgroup']['content_view_id'] == 1
+        end
+        run_cmd(%w(hostgroup update --id 1 --content-view cv1 --query-organization-id 1))
+      end
+
+      it 'requires organization options to resolve content view name' do
+        api_expects_no_call
+        result = run_cmd(%w(hostgroup update --id 1 --content-view cv1))
+        assert_match(/--query-organization/, result.err)
+      end
+
+      it 'allows lifecycle environment id' do
+        api_expects(:hostgroups, :update) do |p|
+          p['id'] == '1' && p['hostgroup']['lifecycle_environment_id'] == 1 &&
+            p['hostgroup']['organization_ids'] == %w(1 2)
+        end
+        run_cmd(%w(hostgroup update --id 1 --lifecycle-environment-id 1 --organization-ids 1,2))
+      end
+
+      it 'allows lifecycle environment name' do
+        ex = api_expects(:lifecycle_environments, :index) do |p|
+          p[:name] = 'le1' && p['organization_id'] == '1'
+        end
+        ex.returns(index_response([{'id' => 1}]))
+        api_expects(:hostgroups, :update) do |p|
+          p['id'] == '1' && p['hostgroup']['lifecycle_environment_id'] == 1
+        end
+        run_cmd(%w(hostgroup update --id 1 --lifecycle-environment le1
+                   --query-organization-id 1 --organization-ids 1,2))
+      end
+
+      it 'requires organization options to resolve lifecycle environment name' do
+        api_expects_no_call
+        result = run_cmd(%w(hostgroup update --name hg1 --lifecycle-environment le1))
+        assert_match(/--query-organization/, result.err)
+      end
+
+      it 'requires organization options to resolve lifecycle environment name' do
+        api_expects_no_call
+        result = run_cmd(%w(hostgroup update --id 1 --lifecycle-environment le1))
+        assert_match(/--query-organization/, result.err)
+      end
+
+      it 'allows kickstart repository name' do
+        env_id = 100
+        cv_id = 200
+        repo_name = "life_of_kickstart"
+        repo_id = 111
+        hg_name = "mercury"
+        hg_id = 108
+
+        api_expects(:hostgroups, :index).
+          with_params(:search => "name = \"#{hg_name}\"").
+          returns(index_response([{'id' => hg_id}]))
+
+        api_expects(:repositories, :index).
+          with_params('name' => repo_name,
+                      'environment_id' => env_id,
+                      'content_view_id' => cv_id).
+          returns(index_response([{'id' => repo_id}]))
+
+        api_expects(:hostgroups, :update).
+          with_params('id' => hg_id,
+                      'hostgroup' => {'lifecycle_environment_id' => env_id,
+                                      'content_view_id' => cv_id,
+                                      'kickstart_repository_id' => repo_id
+                                     })
+
+        cmd = "hostgroup update --name #{hg_name} --lifecycle-environment-id #{env_id}"\
+              " --content-view-id #{cv_id} --kickstart-repository #{repo_name}"
+        run_cmd(cmd.split)
+      end
+    end
+  end
+end

data/test/functional/lifecycle_environment/create_test.rb

@@ -0,0 +1,14 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/lifecycle_environment'
+
+module HammerCLIKatello
+  describe LifecycleEnvironmentCommand::CreateCommand do
+    it 'allows minimal options' do
+      api_expects(:lifecycle_environments, :create) do |p|
+        p['name'] == 'le1' && p['prior_id'] == 3 && p['organization_id'] == 1
+      end
+
+      run_cmd(%w(lifecycle-environment create --name le1 --prior-id 3 --organization-id 1))
+    end
+  end
+end

data/test/functional/lifecycle_environment/lifecycle_environment_helpers.rb

@@ -0,0 +1,18 @@
+require_relative '../search_helpers'
+
+module LifecycleEnvironmentHelpers
+  include SearchHelpers
+
+  def expect_lifecycle_environment_search(org_id, name, id)
+    expect_lenient_search(:lifecycle_environments,
+                          params: {'name' => name, 'organization_id' => org_id},
+                          returns: {'id' => id})
+  end
+
+  def expect_lifecycle_environments_request(org_id, results)
+    ex = api_expects(:lifecycle_environments, :index, 'List the lifecycle environments') do |par|
+      par['organization_id'] == org_id
+    end
+    ex.returns(index_response(results))
+  end
+end

data/test/functional/lifecycle_environment/list_test.rb

@@ -0,0 +1,38 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/lifecycle_environment'
+
+module HammerCLIKatello
+  describe LifecycleEnvironmentCommand::ListCommand do
+    it 'allows minimal options' do
+      api_expects(:lifecycle_environments, :index)
+
+      run_cmd(%w(lifecycle-environment list))
+    end
+
+    describe 'allows organization' do
+      it 'id' do
+        api_expects(:lifecycle_environments, :index) { |p| p['organization_id'] == 1 }
+
+        run_cmd(%w(lifecycle-environment list --organization-id 1))
+      end
+
+      it 'name' do
+        api_expects(:organizations, :index) { |par| par[:search] == "name = \"org1\"" }
+          .at_least_once.returns(index_response([{'id' => 1}]))
+
+        api_expects(:lifecycle_environments, :index) { |p| p['organization_id'] == 1 }
+
+        run_cmd(%w(lifecycle-environment list --organization org1))
+      end
+
+      it 'label' do
+        api_expects(:organizations, :index) { |par| par[:search] == "label = \"org1\"" }
+          .at_least_once.returns(index_response([{'id' => 1}]))
+
+        api_expects(:lifecycle_environments, :index) { |p| p['organization_id'] == 1 }
+
+        run_cmd(%w(lifecycle-environment list --organization-label org1))
+      end
+    end
+  end
+end

data/test/functional/lifecycle_environment/update_test.rb

@@ -0,0 +1,14 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/lifecycle_environment'
+
+module HammerCLIKatello
+  describe LifecycleEnvironmentCommand::UpdateCommand do
+    it 'allows minimal options' do
+      api_expects(:lifecycle_environments, :update) do |p|
+        p['new_name'] == 'le3' && p['id'] == 3
+      end
+
+      run_cmd(%w(lifecycle-environment update --id 3 --new-name le3))
+    end
+  end
+end

data/test/functional/local_helper_test.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+describe 'local helper' do
+  before do
+    class SuperLocalTestHelper
+      def parse_subcommand
+        true
+      end
+    end
+
+    class LocalTestHelper < SuperLocalTestHelper
+      include HammerCLIKatello::LocalHelper
+    end
+
+    @local_helper = LocalTestHelper.new
+  end
+
+  it "does not fail if /usr/share/foreman exists" do
+    File.expects(:exist?).with('/usr/share/foreman').returns(true)
+    assert @local_helper.parse_subcommand
+  end
+
+  it "fails if /usr/share/foreman does not exist" do
+    File.expects(:exist?).with('/usr/share/foreman').returns(false)
+
+    assert_raises RuntimeError do
+      @local_helper.parse_subcommand
+    end
+  end
+end

data/test/functional/module_stream/info_test.rb

@@ -0,0 +1,58 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/module_stream'
+
+module HammerCLIKatello
+  describe ModuleStreamCommand::InfoCommand do
+    it 'allows ID' do
+      api_expects(:module_streams, :show).with_params('id' => '1')
+
+      run_cmd(%w(module-stream info --id 1))
+    end
+
+    it 'resolves ID from name and repo id' do
+      api_expects(:module_streams, :index)
+        .with_params(search: "name = \"duck\"", name: "duck", repository_id: "1")
+        .returns(index_response([{'id' => 1}]))
+
+      api_expects(:module_streams, :show)
+        .with_params(repository_id: "1", id: 1)
+
+      run_cmd(%w(module-stream info --name duck --repository-id 1))
+    end
+
+    it 'resolves ID from name, repo name, and product id' do
+      api_expects(:module_streams, :index)
+        .with_params(search: "name = \"walrus\"")
+        .returns(index_response([{'id' => 1}]))
+
+      api_expects(:repositories, :index)
+        .with_params(name: 'zoo', product_id: 1)
+        .returns(index_response([{'id' => 1}]))
+
+      api_expects(:module_streams, :show)
+        .with_params(repository_id: 1, id: 1)
+
+      run_cmd(%w(module-stream info --name walrus --repository zoo --product-id 1))
+    end
+
+    it 'resolves ID from name, repo name, product name, and org id' do
+      api_expects(:products, :index)
+        .with_params(name: "habitat", organization_id: 1)
+        .returns(index_response([{'id' => 1}]))
+
+      api_expects(:module_streams, :index)
+        .with_params(search: "name = \"walrus\"")
+        .returns(index_response([{'id' => 1}]))
+
+      api_expects(:repositories, :index)
+        .with_params(name: 'zoo', product_id: 1)
+        .returns(index_response([{'id' => 1}]))
+
+      api_expects(:module_streams, :show)
+        .with_params(repository_id: 1, id: 1)
+
+      run_cmd(%w(module-stream info --name walrus --repository zoo
+                 --product habitat --organization-id 1))
+    end
+  end
+end

data/test/functional/module_stream/list_test.rb

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

data/test/functional/organization/delete_test.rb

@@ -0,0 +1,26 @@
+require_relative '../test_helper'
+
+module HammerCLIKatello
+  describe 'Organization::DeleteCommand' do
+    it 'it requires the organization ID and must be resolved from name' do
+      api_expects(:organizations, :index).with_params(
+        :search => "name = \"my_org\"", :per_page => 1000, :page => 1
+      )
+      run_cmd(%w(organization delete --name my_org))
+    end
+
+    it 'it requires the organization ID and must be resolved from name' do
+      api_expects(:organizations, :index).with_params(
+        :search => "label = \"my_org\"", :per_page => 1000, :page => 1
+      )
+      run_cmd(%w(organization delete --label my_org))
+    end
+
+    it 'it requires the organization ID and must be resolved from name' do
+      api_expects(:organizations, :index).with_params(
+        :search => "title = \"my_org\"", :per_page => 1000, :page => 1
+      )
+      run_cmd(%w(organization delete --title my_org))
+    end
+  end
+end

data/test/functional/organization/info_test.rb

@@ -0,0 +1,22 @@
+require_relative '../test_helper'
+require 'hammer_cli_katello/organization'
+require 'hammer_cli_katello/associating_commands'
+
+describe HammerCLIKatello::Organization::InfoCommand do
+  before do
+    @cmd = %w(organization info)
+  end
+
+  it "includes simple content access attributes" do
+    org_id = 2
+    params = ["--id=#{org_id}"]
+    api_expects(:organizations, :index).returns(index_response([{'id' => org_id}]))
+
+    api_expects(:organizations, :show)
+      .with_params('id' => org_id.to_s)
+      .returns("simple_content_access" => true, "id" => org_id)
+    result = run_cmd(@cmd + params)
+    expected = success_result(FieldMatcher.new('Simple Content Access', 'Enabled'))
+    assert_cmd(expected, result)
+  end
+end

data/test/functional/organization/organization_helpers.rb

@@ -0,0 +1,10 @@
+require_relative '../search_helpers'
+
+module OrganizationHelpers
+  include SearchHelpers
+
+  def expect_organization_search(name_or_label, id, field: 'name')
+    expect_generic_search(:organizations, params: {search: "#{field} = \"#{name_or_label}\""},
+                                          returns: {'id' => id}).at_least_once
+  end
+end

data/test/functional/package/list_test.rb

@@ -0,0 +1,158 @@
+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)
+
+        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 = "--organization, --organization-title, --organization-label, --organization-id"
+        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,59 @@
+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'}
+    }
+  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).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