hammer_cli_foreman 0.10.2 → 0.11.0

data/lib/hammer_cli_foreman/id_resolver.rb

@@ -40,13 +40,13 @@ module HammerCLIForeman
       :fact_value =>       [],
       :filter =>           [],
       :host =>             [ s_name(_("Host name")) ],
-      :hostgroup =>        [ s_name(_("Hostgroup name")), s("title", _("Hostgroup title"),:editable => false) ],
+      :hostgroup =>        [ s_name(_("Hostgroup name")), s("title", _("Hostgroup title"), :editable => false) ],
       # :image =>            [],
       :interface =>        [],
-      :location =>         [ s_name(_("Location name")) ],
+      :location =>         [ s_name(_("Location name")), s("title", _("Location title"), :editable => false) ],
       :medium =>           [ s_name(_("Medium name")) ],
       :model =>            [ s_name(_("Model name")) ],
-      :organization =>     [ s_name(_("Organization name")) ],
+      :organization =>     [ s_name(_("Organization name")), s("title", _("Organization title"), :editable => false) ],
       :operatingsystem =>  [ s("title", _("Operating system title"), :editable => false) ],
       :override_value =>   [],
       :ptable =>           [ s_name(_("Partition table name")) ],
@@ -144,7 +144,13 @@ module HammerCLIForeman
     end
 
     def get_ids(resource_name, options)
-      options[HammerCLI.option_accessor_name("ids")] || find_resources(resource_name, options).map{|r| r['id']}
+      if (ids = options[HammerCLI.option_accessor_name("ids")])
+        ids
+      elsif !options_empty?(@api.resource(resource_name), options)
+        find_resources(resource_name, options).map{|r| r['id']}
+      else
+        []
+      end
     end
 
     def find_resources(resource_name, options)
@@ -157,9 +163,16 @@ module HammerCLIForeman
     def find_puppetclasses(options)
       resource_name = :puppetclasses
       resource = @api.resource(resource_name)
-      results = resolved_call(resource_name, :index, options).first.values.flatten
-      raise ResolverError.new(_("one of %s not found") % resource.name, resource) if results.count < expected_record_count(options, resource)
-      results
+
+      if (ids = options[HammerCLI.option_accessor_name("ids")])
+        ids
+      elsif !options_empty?(resource, options)
+        results = resolved_call(resource_name, :index, options).first.values.flatten
+        raise ResolverError.new(_("one of %s not found") % resource.name, resource) if results.count < expected_record_count(options, resource)
+        results
+      else
+        []
+      end
     end
 
     def find_resource(resource_name, options)
@@ -249,6 +262,13 @@ module HammerCLIForeman
       pick_result(results, resource)['id']
     end
 
+    def options_empty?(resource, options)
+      searchables(resource).any? do |s|
+        values = options[HammerCLI.option_accessor_name(s.plural_name.to_s)]
+        values && values.respond_to?(:empty?) && values.empty?
+      end
+    end
+
     def create_smart_class_parameters_search_options(options)
       search_options = {}
       value = options[HammerCLI.option_accessor_name('name')]

data/lib/hammer_cli_foreman/location.rb

@@ -11,6 +11,7 @@ module HammerCLIForeman
 
       output do
         field :id, _("Id")
+        field :title, _("Title")
         field :name, _("Name")
         field :description, _("Description")
       end

data/lib/hammer_cli_foreman/organization.rb

@@ -11,6 +11,7 @@ module HammerCLIForeman
 
       output do
         field :id, _("Id")
+        field :title, _("Title")
         field :name, _("Name")
         field :description, _("Description")
       end

data/lib/hammer_cli_foreman/references.rb

@@ -13,10 +13,10 @@ module HammerCLIForeman
     def self.taxonomies(dsl)
       dsl.build do
         collection :locations, _("Locations"), :numbered => false, :hide_blank => true do
-          custom_field Fields::Reference
+          custom_field Fields::Reference, :name_key => :title
         end
         collection :organizations, _("Organizations"), :numbered => false, :hide_blank => true do
-          custom_field Fields::Reference
+          custom_field Fields::Reference, :name_key => :title
         end
       end
     end
@@ -121,6 +121,14 @@ module HammerCLIForeman
       end
     end
 
+    def self.all_parameters(dsl)
+      dsl.build do
+        collection :all_parameters, _("All parameters"), :numbered => false do
+          custom_field Fields::KeyValue
+        end
+      end
+    end
+
     def self.puppetclasses(dsl)
       dsl.build do
         collection :puppetclasses, _("Puppetclasses"), :numbered => false do

data/lib/hammer_cli_foreman/smart_class_parameter.rb

@@ -107,7 +107,7 @@ module HammerCLIForeman
 
       build_options do |options|
         options.expand.including(:puppetclasses)
-        options.without(:parameter_type, :validator_type, :override, :required)
+        options.without(:parameter_type, :validator_type, :override, :required, :override_value_order)
       end
 
       option "--override", "OVERRIDE", _("Override this parameter."),
@@ -119,12 +119,21 @@ module HammerCLIForeman
             ['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 AddOverrideValueCommand < HammerCLIForeman::CreateCommand

data/lib/hammer_cli_foreman/smart_variable.rb

@@ -1,5 +1,27 @@
 module HammerCLIForeman
 
+  module SmartVariableUpdateCreateCommons
+
+    def self.included(base)
+      base.option "--variable-type", "VARIABLE_TYPE", _("Type of the variable."),
+                  :format => HammerCLI::Options::Normalizers::Enum.new(
+                      ['string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'])
+      base.option "--validator-type", "VALIDATOR_TYPE", _("Type of the validator."),
+                  :format => HammerCLI::Options::Normalizers::Enum.new(['regexp', 'list', ''])
+      base.option "--override-value-order", "OVERRIDE_VALUE_ORDER", _("The order in which values are resolved"),
+                  :format => HammerCLI::Options::Normalizers::List.new
+
+      base.build_options :without => [:variable_type, :validator_type, :override_value_order]
+    end
+
+    def request_params
+      params = super
+      override_order = params['smart_variable']['override_value_order']
+      params['smart_variable']['override_value_order'] = override_order.join("\n") if override_order.is_a?(Array)
+      params
+    end
+  end
+
   class SmartVariablesBriefList < HammerCLIForeman::ListCommand
     resource :smart_variables, :index
     command_name 'smart-variables'
@@ -80,31 +102,17 @@ module HammerCLIForeman
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
+      include SmartVariableUpdateCreateCommons
 
       success_message _("Smart variable [%{variable}] created")
       failure_message _("Could not create the smart variable")
-
-      build_options :without => [:variable_type, :validator_type]
-
-      option "--variable-type", "VARIABLE_TYPE", _("Type of the variable."),
-        :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', ''])
     end
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
+      include SmartVariableUpdateCreateCommons
 
       success_message _("Smart variable [%{variable}] updated")
       failure_message _("Could not update the smart variable")
-
-      build_options :without => [:variable_type, :validator_type]
-
-      option "--variable-type", "VARIABLE_TYPE", _("Type of the variable."),
-        :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', ''])
     end
 
 

data/lib/hammer_cli_foreman/subnet.rb

@@ -11,6 +11,7 @@ module HammerCLIForeman
         field :name, _("Name")
         field :network, _("Network")
         field :mask, _("Mask")
+        field :vlanid, _("VLAN ID")
       end
 
       build_options
@@ -20,6 +21,7 @@ module HammerCLIForeman
     class InfoCommand < HammerCLIForeman::InfoCommand
 
       output ListCommand.output_definition do
+        field :description, _("Description"), Fields::LongText, :hide_blank => true
         field :priority, _("Priority")
         field :dns, _("DNS"), Fields::Reference, :details => :url
         field :dns_primary, _("Primary DNS")
@@ -27,12 +29,12 @@ module HammerCLIForeman
         field :tftp, _("TFTP"), Fields::Reference, :details => :url
         field :dhcp, _("DHCP"), Fields::Reference, :details => :url
         field :ipam, _("IPAM")
-        field :vlanid, _("VLAN ID")
         field :gateway, _("Gateway")
         field :from, _("From")
         field :to, _("To")
         HammerCLIForeman::References.domains(self)
         HammerCLIForeman::References.taxonomies(self)
+        HammerCLIForeman::References.parameters(self)
       end
 
       build_options
@@ -44,7 +46,7 @@ module HammerCLIForeman
       success_message _("Subnet created")
       failure_message _("Could not create the subnet")
 
-      build_options
+      build_options :without => [:subnet_parameters_attributes]
     end
 
 
@@ -53,7 +55,7 @@ module HammerCLIForeman
       success_message _("Subnet updated")
       failure_message _("Could not update the subnet")
 
-      build_options
+      build_options :without => [:subnet_parameters_attributes]
     end
 
 
@@ -62,6 +64,34 @@ module HammerCLIForeman
       success_message _("Subnet deleted")
       failure_message _("Could not delete the subnet")
 
+      build_options :without => [:subnet_parameters_attributes]
+    end
+
+    class SetParameterCommand < HammerCLIForeman::Parameter::SetCommand
+      desc _("Create or update parameter for a subnet.")
+
+      success_message_for :update, _("Subnet parameter updated")
+      success_message_for :create, _("New subnet parameter created")
+      failure_message _("Could not set subnet parameter")
+
+      def validate_options
+        super
+        validator.any(:option_subnet_name, :option_subnet_id).required
+      end
+
+      build_options
+    end
+
+    class DeleteParameterCommand < HammerCLIForeman::Parameter::DeleteCommand
+      desc _("Delete parameter for a subnet.")
+
+      success_message _("Subnet parameter deleted")
+
+      def validate_options
+        super
+        validator.any(:option_subnet_name, :option_subnet_id).required
+      end
+
       build_options
     end
 

data/lib/hammer_cli_foreman/template.rb

@@ -7,7 +7,7 @@ module HammerCLIForeman
     module TemplateCreateUpdateCommons
 
       def option_snippet
-        option_type == "snippet"
+        option_type && (option_type == "snippet")
       end
 
       def option_template_kind_id

data/lib/hammer_cli_foreman/testing/api_expectations.rb

@@ -116,7 +116,9 @@ module HammerCLIForeman
       end
 
       class TestAuthenticator < ApipieBindings::Authenticators::BasicAuth
-        attr_reader :user
+        def user(ask=nil)
+          @user
+        end
       end
 
       class FakeApiConnection < HammerCLI::Apipie::ApiConnection

data/lib/hammer_cli_foreman/user.rb

@@ -11,6 +11,9 @@ module HammerCLIForeman
         field :login, _("Login")
         field :full_name, _("Name")
         field :mail, _("Email")
+        field :admin, _("Admin"), Fields::Boolean
+        field :last_login_on, _("Last login"), Fields::Date
+        field nil, _("Authorized by"), Fields::SingleReference, :key => :auth_source
       end
 
       def extend_data(user)
@@ -25,12 +28,9 @@ module HammerCLIForeman
     class InfoCommand < HammerCLIForeman::InfoCommand
 
       output ListCommand.output_definition do
-        field :admin, _("Admin"), Fields::Boolean
         field :effective_admin, _("Effective admin"), Fields::Boolean
-        field nil, _("Authorized by"), Fields::SingleReference, :key => :auth_source
         field :locale, _("Locale")
         field :timezone, _("Timezone")
-        field :last_login_on, _("Last login"), Fields::Date
         field :description, _("Description")
         custom_field Fields::Reference, :label => _("Default organization"), :path => [:default_organization]
         custom_field Fields::Reference, :label => _("Default location"), :path => [:default_location]
@@ -55,6 +55,21 @@ module HammerCLIForeman
       def self.included(base)
         base.option '--default-organization', 'DEFAULT_ORGANIZATION_NAME', _("Default organization name")
         base.option '--default-location', 'DEFAULT_LOCATION_NAME', _("Default location name")
+        base.option "--ask-password", "ASK_PW", " ",
+                    :format => HammerCLI::Options::Normalizers::Bool.new
+      end
+
+      def self.ask_password(type)
+        if type == :current
+          prompt = _("Enter user's current password:") + " "
+        elsif type == :new
+          prompt = _("Enter user's new password:") + " "
+        end
+        ask(prompt) {|q| q.echo = false}
+      end
+
+      def current_logged_user
+        HammerCLIForeman.foreman_api_connection.resource(:users).call(:show, :id => HammerCLIForeman.foreman_api_connection.authenticator.user(true))
       end
 
       def request_params
@@ -63,6 +78,11 @@ module HammerCLIForeman
         params['user']['default_organization_id'] ||= org_id unless org_id.nil?
         loc_id = location_id(option_default_location)
         params['user']['default_location_id'] ||= loc_id unless loc_id.nil?
+        params['user']['password'] = option_password unless option_password.nil?
+
+        if option_ask_password
+          params['user']['password'] = HammerCLIForeman::User::CommonUpdateOptions::ask_password(:new)
+        end
         params
       end
 
@@ -89,6 +109,20 @@ module HammerCLIForeman
       failure_message _("Could not update the user")
 
       include CommonUpdateOptions
+
+      def request_params
+        params = super
+
+        if (option_password || option_ask_password)
+          if current_logged_user["id"].to_s == params["id"].to_s
+            if (!option_current_password && (option_password || option_ask_password))
+              params['user']['current_password'] = HammerCLIForeman::User::CommonUpdateOptions::ask_password(:current)
+            end
+          end
+        end
+        params
+      end
+
       build_options
     end
 

data/lib/hammer_cli_foreman/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIForeman
   def self.version
-    @version ||= Gem::Version.new '0.10.2'
+    @version ||= Gem::Version.new '0.11.0'
   end
 end

data/test/functional/filter_test.rb

@@ -0,0 +1,146 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'filter' do
+  def api_expects_filter_info(options)
+    override = !!options[:override]
+    api_expects(:filters, :show, 'Get filter info').with_params({
+      :id => '1'
+    }).returns(@filter.merge('override?' => override))
+  end
+
+  def taxonomy_usage_error(action, cmd)
+    usage_error_result(
+      cmd,
+      'Organizations and locations can be set only for overriding filters',
+      "Could not #{action} the permission filter")
+  end
+
+  def assert_update_success(result)
+    assert_cmd(success_result("Permission filter for [User] updated\n"), result)
+  end
+
+  describe 'create' do
+    before do
+      @cmd = %w(filter create)
+    end
+
+    it 'prints error when taxonomies are used for a not-overriding filter' do
+      params = ['--organization-ids=1,2', '--location-ids=3,4', '--override=false']
+
+      api_expects_no_call
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(taxonomy_usage_error('create', @cmd), result)
+    end
+  end
+
+  describe 'update' do
+    before do
+      @cmd = %w(filter update)
+      @filter = {
+        "search" => nil,
+        "resource_type" => "User",
+        "unlimited?" => false,
+        "created_at" => "2017-07-18 14:34:09 UTC",
+        "updated_at" => "2017-07-18 14:34:09 UTC",
+        "override?" => true,
+        "id" => 404,
+        "role" => {
+          "name" => "Some Role",
+          "id" => 28,
+          "description" => "Description\nof the new\nrole",
+          "origin" => nil
+        },
+        "permissions" => [{
+            "name" => "view_users",
+            "id" => 164,
+            "resource_type" => "User"
+        }],
+        "locations" => [{
+          "id" => 28,
+          "name" => "location74",
+          "title" => "location74",
+          "description" => nil
+        }],
+        "organizations" => [{
+          "id" => 27,
+          "name" => "organization74",
+          "title" => "organization74",
+          "description" => nil
+        }]
+      }
+    end
+
+    it 'resets taxonomies when a filter is not-overriding' do
+      params = ['--id=1']
+
+      api_expects_filter_info(:override => false)
+      api_expects(:filters, :update, 'Update the filter').with_params({
+        'filter' => {
+          'organization_ids' => [],
+          'location_ids' => []
+        }
+      }).returns(@filter)
+
+      assert_update_success(run_cmd(@cmd + params))
+    end
+
+    it 'resets taxonomies when switching a filter to not-overriding' do
+      params = ['--id=1', '--override=false']
+
+      api_expects(:filters, :update, 'Update the filter').with_params({
+        'filter' => {
+          'organization_ids' => [],
+          'location_ids' => []
+        }
+      }).returns(@filter)
+
+      assert_update_success(run_cmd(@cmd + params))
+    end
+
+    it 'can add taxonomies when a filter is overriding' do
+      params = ['--id=1', '--organization-ids=1,2', '--location-ids=3,4']
+
+      api_expects_filter_info(:override => true)
+      api_expects(:filters, :update, 'Update the filter').with_params({
+        'filter' => {
+          'organization_ids' => ['1', '2'],
+          'location_ids' => ['3', '4']
+        }
+      }).returns(@filter)
+
+      assert_update_success(run_cmd(@cmd + params))
+    end
+
+    it 'can add taxonomies when switching a filter to overriding' do
+      params = ['--id=1', '--organization-ids=1,2', '--location-ids=3,4', '--override=true']
+
+      api_expects(:filters, :update, 'Update the filter').with_params({
+        'filter' => {
+          'organization_ids' => ['1', '2'],
+          'location_ids' => ['3', '4']
+        }
+      }).returns(@filter)
+
+      assert_update_success(run_cmd(@cmd + params))
+    end
+
+    it 'prints error when taxonomies are used on not-overriding' do
+      params = ['--id=1', '--organization-ids=1,2', '--location-ids=3,4']
+
+      api_expects_filter_info(:override => false)
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(taxonomy_usage_error('update', @cmd), result)
+    end
+
+    it 'prints error when taxonomies are used when switching a filter to not-overriding' do
+      params = ['--id=1', '--organization-ids=1,2', '--location-ids=3,4', '--override=false']
+
+      api_expects_no_call
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(taxonomy_usage_error('update', @cmd), result)
+    end
+  end
+end