hammer_cli_foreman 2.5.2 → 3.0.0

data/lib/hammer_cli_foreman/smart_class_parameter.rb

@@ -1,189 +0,0 @@
-module HammerCLIForeman
-
-  class SmartClassParametersBriefList < HammerCLIForeman::ListCommand
-    resource :smart_class_parameters, :index
-    command_name 'sc-params'
-
-    output do
-      field :id, _("Id")
-
-      field :parameter, _("Parameter")
-      field :default_value, _("Default Value")
-      field :override, _("Override")
-    end
-
-    def send_request
-      res = super
-      # FIXME: API returns doubled records, probably just if filtered by puppetclasses
-      # it seems group by environment is missing
-      # having the uniq to fix that
-      HammerCLI::Output::RecordCollection.new(res.uniq, :meta => res.meta)
-    end
-
-    def self.build_options_for(resource)
-      options = {}
-      options[:without] = [:host_id, :puppetclass_id, :environment_id, :hostgroup_id]
-      options[:expand] = {}
-      options[:expand][:except] = ([:hosts, :puppetclasses, :environments, :hostgroups] - [resource])
-      build_options(options)
-    end
-  end
-
-  class SmartClassParametersList < SmartClassParametersBriefList
-
-    output do
-      field :puppetclass_name, _("Puppet class")
-      field :puppetclass_id, _("Class Id"), Fields::Id
-    end
-  end
-
-  class SmartClassParameter < HammerCLIForeman::Command
-
-    resource :smart_class_parameters
-
-    class ListCommand < HammerCLIForeman::ListCommand
-
-      output SmartClassParametersList.output_definition
-
-      def extend_data(res)
-        res['parameter_type'] ||= 'string'
-        res
-      end
-
-      build_options
-
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironment.new)
-    end
-
-    class InfoCommand < HammerCLIForeman::InfoCommand
-
-      output ListCommand.output_definition do
-        field :description, _("Description")
-        field :parameter_type, _("Type")
-        field :hidden_value?, _("Hidden Value?")
-        field :omit, _("Omit"), Fields::Boolean
-        field :required, _("Required")
-
-        label _("Validator") do
-          field :validator_type, _("Type")
-          field :validator_rule, _("Rule")
-        end
-        label _("Override values") do
-          field :merge_overrides, _("Merge overrides"), Fields::Boolean
-          field :merge_default, _("Merge default value"), Fields::Boolean
-          field :avoid_duplicates, _("Avoid duplicates"), Fields::Boolean
-          field :override_value_order, _("Order"), Fields::LongText
-
-          collection :override_values, _("Values") do
-              field :id, _('Id')
-              field :match, _('Match')
-              field :value, _('Value')
-              field :omit, _('Omit'), Fields::Boolean
-          end
-        end
-        HammerCLIForeman::References.environments(self)
-        HammerCLIForeman::References.timestamps(self)
-      end
-
-      def extend_data(res)
-        res['parameter_type'] ||= 'string'
-        res['omit'] ||= false
-        res
-      end
-
-      build_options do |options|
-        options.expand.including(:puppetclasses)
-      end
-
-      validate_options do
-        if option(:option_name).exist?
-          any(:option_puppetclass_name, :option_puppetclass_id).required
-        end
-      end
-    end
-
-    class UpdateCommand < HammerCLIForeman::UpdateCommand
-
-      success_message _("Parameter updated.")
-      failure_message _("Could not update the parameter")
-
-      option '--default-value', 'VALUE', _('Value to use when there is no match')
-
-      build_options do |options|
-        options.expand.including(:puppetclasses)
-        options.without(:parameter_type, :validator_type, :override, :required, :override_value_order)
-      end
-
-      option "--override", "OVERRIDE", _("Override this parameter"),
-        :format => HammerCLI::Options::Normalizers::Bool.new
-      option "--required", "REQUIRED", _("This parameter is required"),
-        :format => HammerCLI::Options::Normalizers::Bool.new
-      option "--parameter-type", "PARAMETER_TYPE", _("Type of the parameter"),
-        :format => HammerCLI::Options::Normalizers::Enum.new(
-            ['string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'])
-      option "--validator-type", "VALIDATOR_TYPE", _("Type of the validator"),
-        :format => HammerCLI::Options::Normalizers::Enum.new(['regexp', 'list', ''])
-      option "--override-value-order", "OVERRIDE_VALUE_ORDER", _("The order in which values are resolved"),
-             :format => HammerCLI::Options::Normalizers::List.new
-
-      validate_options do
-        if option(:option_name).exist?
-          any(:option_puppetclass_name, :option_puppetclass_id).required
-        end
-      end
-
-      def request_params
-        params = super
-        override_order = params['smart_class_parameter']['override_value_order']
-        params['smart_class_parameter']['override_value_order'] = override_order.join("\n") if override_order.is_a?(Array)
-        params
-      end
-    end
-
-    class AddMatcherCommand < HammerCLIForeman::CreateCommand
-      resource :override_values
-      command_name 'add-matcher'
-
-      option '--value', 'VALUE', _('Override value, required if omit is false')
-
-      success_message _("Override value created.")
-      failure_message _("Could not create the override value")
-
-      build_options do |options|
-        options.expand.including(:puppetclasses)
-      end
-
-      validate_options do
-        if option(:option_omit).value
-          option(:option_value).rejected(:msg => _('Cannot use --value when --omit is true.'))
-        end
-
-        if option(:option_smart_class_parameter_name).exist?
-          any(:option_puppetclass_name, :option_puppetclass_id).required
-        end
-      end
-    end
-
-    class RemoveMatcherCommand < HammerCLIForeman::DeleteCommand
-      resource :override_values
-      command_name 'remove-matcher'
-
-      success_message _("Override value deleted.")
-      failure_message _("Could not delete the override value")
-
-      build_options do |options|
-        options.expand.including(:puppetclasses)
-      end
-
-      validate_options do
-        if option(:option_smart_class_parameter_name).exist?
-          any(:option_puppetclass_name, :option_puppetclass_id).required
-        end
-      end
-    end
-
-    autoload_subcommands
-
-  end
-
-end

data/test/functional/config_group_test.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require File.join(File.dirname(__FILE__), 'test_helper')
-
-describe 'config_group' do
-  describe 'list' do
-    before do
-      @cmd = %w[config-group list]
-      @config_groups = [{
-                          id: 1,
-                          name: 'config-group-test',
-                        }]
-    end
-
-    it 'should return a list of config groups' do
-      api_expects(:config_groups, :index, 'List config groups').returns(@config_groups)
-
-      output = IndexMatcher.new([
-                                  %w[ID NAME],
-                                  %w[1 config-group-test]
-                                ])
-      expected_result = success_result(output)
-
-      result = run_cmd(@cmd)
-      assert_cmd(expected_result, result)
-    end
-
-    it 'should run list command with defaults' do
-      providers = { 'foreman' => HammerCLIForeman::Defaults.new(api_connection({}, '2.1')) }
-      defaults = HammerCLI::Defaults.new(
-        {
-          organization_id: {
-            provider: 'foreman'
-          },
-          location_id: {
-            provider: 'foreman'
-          }
-        }
-      )
-      defaults.stubs(:write_to_file).returns(true)
-      defaults.stubs(:providers).returns(providers)
-      api_expects(:config_groups, :index, 'List config groups').returns(@config_groups)
-
-      result = run_cmd(@cmd, { use_defaults: true, defaults: defaults })
-      _(result.exit_code).must_equal HammerCLI::EX_OK
-    end
-  end
-end
-
-

data/test/functional/proxy_test.rb

@@ -1,86 +0,0 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
-
-describe 'proxy' do
-  describe 'import-classes' do
-    let(:cmd) { ['proxy', 'import-classes'] }
-    let(:params) { ['--id=83'] }
-    let(:report) do
-      {
-        'message' => 'Successfully updated environment and puppetclasses from the on-disk puppet installation',
-        'environments_with_new_puppetclasses' => 2,
-        'environments_updated_puppetclasses' => 0,
-        'environments_obsolete' => 0,
-        'environments_ignored' => 0,
-        'results' => [{
-          'name' => 'development',
-          'actions' => [ 'new', 'update' ],
-          'new_puppetclasses' => [
-            'motd',
-            'hammer'
-          ],
-          'updated_puppetclasses' => [
-            'stdlib',
-            'vim'
-          ]
-        },{
-          'name' => 'production',
-          'actions' => [ 'obsolete', 'ignore' ],
-          'obsolete_puppetclasses' => [
-            'apache'
-          ],
-          'ignored_puppetclasses' => [
-            'hammer'
-          ]
-        }]
-      }
-    end
-    let(:no_change_report) do
-      {
-        'message' => 'No changes to your environments detected'
-      }
-    end
-
-    it 'prints detailed report' do
-      api_expects(:smart_proxies, :import_puppetclasses, 'Import classes')
-        .with_params('id' => '83')
-        .returns(report)
-
-      output = OutputMatcher.new([
-        'Result:',
-        '  Successfully updated environment and puppetclasses from the on-disk puppet installation',
-        'Changed environments:',
-        ' 1) development',
-        '    New classes:',
-        '        motd',
-        '        hammer',
-        '    Updated classes:',
-        '        stdlib',
-        '        vim',
-        ' 2) production',
-        '    Removed classes:',
-        '        apache',
-        '    Ignored classes:',
-        '        hammer'
-      ])
-      expected_result = success_result(output)
-
-      result = run_cmd(cmd + params)
-      assert_cmd(expected_result, result)
-    end
-
-    it 'prints a message when nothig has changed' do
-      api_expects(:smart_proxies, :import_puppetclasses, 'Import classes')
-        .with_params('id' => '83')
-        .returns(no_change_report)
-
-      output = OutputMatcher.new([
-        'Result:',
-        '  No changes to your environments detected'
-      ])
-      expected_result = success_result(output)
-
-      result = run_cmd(cmd + params)
-      assert_cmd(expected_result, result)
-    end
-  end
-end

data/test/functional/smart_class_parameter_test.rb

@@ -1,97 +0,0 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
-
-
-describe 'sc-params update' do
-  let(:cmd) { %w(sc-param update) }
-
-  it 'does not allow to update parameter name' do
-    params = ['--id=1', '--new-name=name2']
-
-    expected_result = usage_error_result(
-      cmd,
-      "Unrecognised option '--new-name'.",
-      "Could not update the parameter"
-    )
-
-    api_expects_no_call
-    result = run_cmd(cmd + params)
-    assert_cmd(expected_result, result)
-  end
-
-end
-
-describe 'sc-params add-matcher' do
-  let(:cmd) { %w(sc-param add-matcher) }
-  let(:override_value) { 'something' }
-  let(:match) { 'domain = example.com' }
-  let(:puppet_class) { { 'name' => 'motd', 'id' => '1' } }
-  let(:parameter) { { 'name' => 'content', 'id' => '2' } }
-  let(:base) { [
-    '--puppet-class', puppet_class['name'],
-    '--smart-class-parameter', parameter['name'],
-    '--match', match
-  ] }
-
-  def api_expects_parameter_search(puppet_class, parameter)
-    api_expects(:puppetclasses, :index, 'Find puppet class') do |par|
-      par[:search] == %Q(name = "#{puppet_class['name']}")
-    end.returns(index_response('motd' => [puppet_class]))
-
-    api_expects(:smart_class_parameters, :index, 'Find smart parameter') do |par|
-      par[:search] == %Q(key = "#{parameter['name']}") &&
-        par[:puppetclass_id] == puppet_class['id']
-    end.returns(index_response([parameter]))
-  end
-
-  it 'allows to set value' do
-    params = ['--value', override_value]
-    expected_result = success_result("Override value created.\n")
-
-    api_expects_parameter_search(puppet_class, parameter)
-
-    api_expects(:override_values, :create, 'Create override value').with_params(
-      :smart_class_parameter_id => parameter['id'],
-      :override_value => {
-        :match => match,
-        :value => override_value
-      }
-    )
-
-    result = run_cmd(cmd + base + params)
-    assert_cmd(expected_result, result)
-  end
-
-  it 'allows to set value with disabled puppet default' do
-    params = ['--value', override_value, '--omit', false]
-    expected_result = success_result("Override value created.\n")
-
-    api_expects_parameter_search(puppet_class, parameter)
-
-    api_expects(:override_values, :create, 'Create override value').with_params(
-      :smart_class_parameter_id => parameter['id'],
-      :override_value => {
-        :match => match,
-        :value => override_value,
-        :omit => false
-      }
-    )
-
-    result = run_cmd(cmd + base + params)
-    assert_cmd(expected_result, result)
-  end
-
-  it 'does not allow to use puppet default and value at the same time' do
-    params = ['--value', 'something', '--omit', true]
-
-    expected_result = usage_error_result(
-      cmd,
-      "Cannot use --value when --omit is true.",
-      'Could not create the override value'
-    )
-
-    api_expects_parameter_search(puppet_class, parameter)
-
-    result = run_cmd(cmd + base + params)
-    assert_cmd(expected_result, result)
-  end
-end

data/test/unit/config_group_test.rb

@@ -1,82 +0,0 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
-require File.join(File.dirname(__FILE__), 'apipie_resource_mock')
-
-require 'hammer_cli_foreman/config_group'
-
-describe HammerCLIForeman::ConfigGroup do
-  include CommandTestHelper
-
-  context "ListCommand" do
-    let(:cmd) { HammerCLIForeman::ConfigGroup::ListCommand.new("", ctx) }
-
-    before :each do
-      ResourceMocks.config_groups_index
-    end
-
-    context "parameters" do
-      it_should_accept "no arguments"
-      it_should_accept_search_params
-      it_should_fail_with 'organization param', ['--organization-id=1']
-      it_should_fail_with 'location param', ['--location-id=1']
-    end
-
-    context "output" do
-      let(:expected_record_count) { cmd.resource.call(:index).length }
-      it_should_print_n_records
-      it_should_print_columns ["ID", "Name"]
-    end
-  end
-
-  context "InfoCommand" do
-    let(:cmd) { HammerCLIForeman::ConfigGroup::InfoCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "id", ["--id=1"]
-      it_should_accept "name", ["--name=group_x"]
-      it_should_fail_with 'organization param', ['--organization-id=1']
-      it_should_fail_with 'location param', ['--location-id=1']
-    end
-
-    context "output" do
-      with_params ["--id=1"] do
-        it_should_print_n_records 1
-        it_should_print_column "Name"
-        it_should_print_column "ID"
-        it_should_print_column "Puppetclasses"
-      end
-    end
-  end
-
-  context "CreateCommand" do
-    let(:cmd) { HammerCLIForeman::ConfigGroup::CreateCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "name, puppetclass ids", ["--name=first_group", "--puppet-class-ids=1,2"]
-      it_should_fail_with 'organization param', ['--organization-id=1']
-      it_should_fail_with 'location param', ['--location-id=1']
-    end
-  end
-
-  context "DeleteCommand" do
-    let(:cmd) { HammerCLIForeman::ConfigGroup::DeleteCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "name", ["--name=group_x"]
-      it_should_accept "id", ["--id=1"]
-      it_should_fail_with 'organization param', ['--organization-id=1']
-      it_should_fail_with 'location param', ['--location-id=1']
-    end
-  end
-
-  context "UpdateCommand" do
-
-    let(:cmd) { HammerCLIForeman::ConfigGroup::UpdateCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "name", ["--name=group_x"]
-      it_should_accept "id", ["--id=1"]
-      it_should_fail_with 'organization param', ['--organization-id=1']
-      it_should_fail_with 'location param', ['--location-id=1']
-    end
-  end
-end

data/test/unit/puppet_class_test.rb

@@ -1,72 +0,0 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
-require File.join(File.dirname(__FILE__), 'apipie_resource_mock')
-
-require 'hammer_cli_foreman/puppet_class'
-
-describe HammerCLIForeman::PuppetClass do
-
-  include CommandTestHelper
-
-  context "ListCommand" do
-    before do
-      ResourceMocks.mock_action_call(:puppetclasses, :index, {})
-    end
-
-    let(:cmd) { HammerCLIForeman::PuppetClass::ListCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "no arguments"
-      # FIXME: the command should accept search parameters in future
-      # it_should_accept_search_params
-    end
-
-    context "output" do
-      let(:expected_record_count) do
-        # data are retuned in specific format
-        HammerCLIForeman.collection_to_common_format(cmd.resource.call(:index)).first.keys.count
-      end
-
-      it_should_print_n_records
-      it_should_print_column "Id"
-      it_should_print_column "Name"
-    end
-
-  end
-
-
-  context "InfoCommand" do
-
-    let(:cmd) { HammerCLIForeman::PuppetClass::InfoCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "id", ["--id=1"]
-      # it_should_fail_with "no arguments" # TODO: temporarily disabled, parameters are checked in the id resolver
-    end
-
-    context "output" do
-      with_params ["--id=1"] do
-        it_should_print_n_records 1
-        it_should_print_column "Id"
-        it_should_print_column "Name"
-      end
-    end
-
-  end
-
-  context "SCParamsCommand" do
-
-    before :each do
-      ResourceMocks.smart_class_parameters_index
-    end
-
-    let(:cmd) { HammerCLIForeman::PuppetClass::SCParamsCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "puppet-class", ["--puppet-class=cls"]
-      it_should_accept "puppet-class-id", ["--puppet-class-id=1"]
-      # it_should_fail_with "name or id missing", [] # TODO: temporarily disabled, parameters are checked in the id resolver
-    end
-
-  end
-
-end

data/test/unit/puppet_environment_test.rb

@@ -1,114 +0,0 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
-require File.join(File.dirname(__FILE__), 'apipie_resource_mock')
-
-require 'hammer_cli_foreman/puppet_environment'
-
-describe HammerCLIForeman::PuppetEnvironment do
-
-  include CommandTestHelper
-
-  context "ListCommand" do
-    before do
-      ResourceMocks.mock_action_call(:environments, :index, [])
-    end
-
-    let(:cmd) { HammerCLIForeman::PuppetEnvironment::ListCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "no arguments"
-      it_should_accept_search_params
-    end
-
-    context "output" do
-      let(:expected_record_count) { count_records(cmd.resource.call(:index)) }
-
-      it_should_print_n_records
-      it_should_print_column "Name"
-      it_should_print_column "Id"
-    end
-
-  end
-
-
-  context "InfoCommand" do
-
-    let(:cmd) { HammerCLIForeman::PuppetEnvironment::InfoCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "id", ["--id=1"]
-      it_should_accept "name", ["--name=env"]
-      # it_should_fail_with "no arguments"
-      # TODO: temporarily disabled, parameters are checked in the id resolver
-    end
-
-    context "output" do
-      with_params ["--id=1"] do
-        it_should_print_n_records 1
-        it_should_print_column "Name"
-        it_should_print_column "Id"
-        it_should_print_column "Created at"
-        it_should_print_column "Updated at"
-      end
-    end
-
-  end
-
-
-  context "CreateCommand" do
-
-    let(:cmd) { HammerCLIForeman::PuppetEnvironment::CreateCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "name", ["--name=env"]
-      # it_should_fail_with "name missing", []
-      # TODO: temporarily disabled, parameters are checked by the api
-    end
-
-  end
-
-
-  context "DeleteCommand" do
-
-    let(:cmd) { HammerCLIForeman::PuppetEnvironment::DeleteCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "name", ["--name=env"]
-      it_should_accept "id", ["--id=1"]
-      # it_should_fail_with "name or id missing", [] # TODO: temporarily disabled, parameters are checked in the id resolver
-    end
-
-  end
-
-
-  context "UpdateCommand" do
-
-    let(:cmd) { HammerCLIForeman::PuppetEnvironment::UpdateCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "name", ["--name=env", "--new-name=env2"]
-      it_should_accept "id", ["--id=1", "--new-name=env2"]
-      # it_should_fail_with "no params", [] # TODO: temporarily disabled, parameters are checked in the id resolver
-      # it_should_fail_with "name or id missing", ["--new-name=env2"] # TODO: temporarily disabled, parameters are checked in the id resolver
-    end
-
-  end
-
-  context "SCParamsCommand" do
-
-    before :each do
-      ResourceMocks.smart_class_parameters_index
-    end
-
-    let(:cmd) { HammerCLIForeman::PuppetEnvironment::SCParamsCommand.new("", ctx) }
-
-    context "parameters" do
-      it_should_accept "environment", ["--environment=env"]
-      it_should_accept "environment-id", ["--environment-id=1"]
-      it_should_accept "puppet-environment", ["--puppet-environment=env"]
-      it_should_accept "puppet-environment-id", ["--puppet-environment-id=1"]
-      # it_should_fail_with "name or id missing", [] # TODO: temporarily disabled, parameters are checked in the id resolver
-    end
-
-  end
-
-end