hammer_cli_foreman 0.15.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 62233eb974a9f156041f18292732d350bf18b0226057ed1cecea100275f68fd3
-  data.tar.gz: 93274e3f7bc825867aef25138b62c9f95204295ab9c9de31cd29b4c06a0b6594
+SHA1:
+  metadata.gz: c8e1d9e2bdf020465f92034a08e8348496fe4b4f
+  data.tar.gz: 8e5b33da07245341c8a0b8df40662736f5c4c83d
 SHA512:
-  metadata.gz: ab9825588fd58db08f0938343c4aa1f1f5790b20e5d8f73f4e60be2d8bd301df7826258674ddf396a519728b1f92d444ebe1ca6618a999990be2c5a0e6aeb5df
-  data.tar.gz: 77470ba002729d9ed2670f83045c4df0c64cd59441c633da80566253bb7184dd8678f6d79da790c6199bb22d4761a75f0fcae12c42f902182f5ac55d1ded7b94
+  metadata.gz: b4262e878d4e0cd9254cccf99ed75827559b525b55e42a402da594331d85df2ce8e1e23c7cc439271cb8649bbca14dfe4063b4913e99e01b7e88251adcf9feb2
+  data.tar.gz: 959f424ddfc94a4a60ca5da344945cb4859005e4529fdd14bcce61ff5ca5beb17bab7b937d308356cc73e969dd8bc36012642d94bc1e0a38296af4d446ac9c3d

data/doc/name_id_resolution.md

@@ -10,6 +10,18 @@ The ID resolution process consists of two parts:
 - building correct parameters (option builders are described [here](https://github.com/theforeman/hammer-cli-foreman/blob/master/doc/option_builder.md#option-builders))
 - the translation process itself ([IdResolver](https://github.com/theforeman/hammer-cli-foreman/blob/master/lib/hammer_cli_foreman/id_resolver.rb) takes care of that)
 
+The latter part is implemented three option sources wrapped in `IdResolution` for easier addressing.
+With this extension the whole structure of option processors in `hammer-cli-foreman` is:
+```
+- DefaultInputs
+    - CommandLine
+    - SavedDefaults
+- IdResolution
+    - IdParams
+    - IdsParams
+    - SelfParam
+```
+
 ID resolution step by step
 --------------------------
 
@@ -31,7 +43,7 @@ Differences in resolution of list of id's
 
 the lookup method is called `<resource_name>_ids` and in addition:
 - returns `cli_options['option_ids']` if it's not nil
-- returns empty list (`[]`) when the search option is set to empty string or empty list 
+- returns empty list (`[]`) when the search option is set to empty string or empty list
 
 It also ends up with exception when any of the ids was not resolved.
 
@@ -58,15 +70,15 @@ Behaviour tuning
 
 The resolution can be tuned at various levels.
 
-Most of the resources are searchable by name. However there are exceptions that either don't have a name 
-or offer more searchable fields. In such cases you have to update the definition 
+Most of the resources are searchable by name. However there are exceptions that either don't have a name
+or offer more searchable fields. In such cases you have to update the definition
 of searchable fields (SEARCHABLES) in [id_resolver](https://github.com/theforeman/hammer-cli-foreman/blob/master/lib/hammer_cli_foreman/id_resolver.rb).
 
-If you need to modify the lookup query (the `search` field) you can override the default one by adding a method 
+If you need to modify the lookup query (the `search` field) you can override the default one by adding a method
 returning the correct lookup options to the resolver class.
-The method should be called according to the following schema: 
-- `create_<resource_name>_search_options(options)` for single id lookup (takes precedence over the next one for single id lookups) 
-- `create_<resource_plural_name>_search_options(options)` combine for single and/or multiple ids lookup 
+The method should be called according to the following schema:
+- `create_<resource_name>_search_options(options)` for single id lookup (takes precedence over the next one for single id lookups)
+- `create_<resource_plural_name>_search_options(options)` combine for single and/or multiple ids lookup
 - `create_<resource_plural_name>_search_options(options, mode)` combined with extra parameter suggesting the lookup mode and being set to `:single`, `:multi` or `nil`
 
 For examples check the `id_resolver`.

data/doc/release_notes.md

@@ -1,11 +1,16 @@
 Release notes
 =============
-### 0.15.1 (2018-11-07)
+### 0.16.0 (2019-01-16)
+* Use make targets for translations from core ([#25724](http://projects.theforeman.org/issues/25724))
+* Allow mixing option sources and validations ([PR #402](https://github.com/theforeman/hammer-cli-foreman/pull/402)) ([#22253](http://projects.theforeman.org/issues/22253))
+* Include information about search fields ([#11431](http://projects.theforeman.org/issues/11431))
+* IPv6 subnet option in hostgroup create/update ([#18752](http://projects.theforeman.org/issues/18752))
+* Tests for message formats ([#7451](http://projects.theforeman.org/issues/7451))
 * Report templates - inputs, clone, interactive updates ([#24489](http://projects.theforeman.org/issues/24489))
 * Update API doc in tests to match Foreman 1.20 ([#25376](http://projects.theforeman.org/issues/25376))
 * Add a command for report templates ([#24489](http://projects.theforeman.org/issues/24489))
-* Request password regardless of redirection ([#14832](http://projects.theforeman.org/issues/14832))
 * Re-add --thin into host list ([PR #395](https://github.com/theforeman/hammer-cli-foreman/pull/395)) ([#25349](http://projects.theforeman.org/issues/25349))
+* Request password regardless of redirection ([#14832](http://projects.theforeman.org/issues/14832))
 
 ### 0.15.0 (2018-10-24)
 * Use SPDX 2.0 codes

data/lib/hammer_cli_foreman/auth_source.rb

@@ -7,7 +7,7 @@ module HammerCLIForeman
     subcommand 'ldap', HammerCLIForeman::AuthSourceLdap.desc, HammerCLIForeman::AuthSourceLdap
 
     class ListCommand < HammerCLIForeman::ListCommand
-      desc _('List all auth sources.')
+      desc _('List all auth sources')
 
       output do
         field :id, _('Id')

data/lib/hammer_cli_foreman/commands.rb

@@ -190,10 +190,13 @@ module HammerCLIForeman
 
     def option_sources
       sources = super
-      sources << HammerCLIForeman::OptionSources::IdParams.new(self)
-      sources << HammerCLIForeman::OptionSources::IdsParams.new(self)
-      sources << HammerCLIForeman::OptionSources::SelfParam.new(self)
-      sources
+
+      id_resolution = HammerCLI::Options::ProcessorList.new(name: 'IdResolution')
+      id_resolution << HammerCLIForeman::OptionSources::IdParams.new(self)
+      id_resolution << HammerCLIForeman::OptionSources::IdsParams.new(self)
+      id_resolution << HammerCLIForeman::OptionSources::SelfParam.new(self)
+
+      sources << id_resolution
     end
 
     private
@@ -250,6 +253,20 @@ module HammerCLIForeman
       return HammerCLI::EX_OK
     end
 
+    def help
+      meta = resource.action(action).apidoc[:metadata]
+      return super if meta.nil?
+
+      if meta && meta[:search] && respond_to?(:option_search)
+        self.class.extend_help do |h|
+          h.section(_('Search fields'), id: :search_fields_section) do |h|
+            h.list(search_fields_help(meta[:search]))
+          end
+        end
+      end
+      super
+    end
+
     protected
 
     def retrieve_all
@@ -277,6 +294,23 @@ module HammerCLIForeman
       retrieve_all
     end
 
+    def search_fields_help(search_fields)
+      return [] if search_fields.nil?
+
+      search_fields.each_with_object([]) do |field, help_list|
+        help_list << [
+          field[:name], search_field_help_value(field)
+        ]
+      end
+    end
+   
+    def search_field_help_value(field)
+      if field[:values] && field[:values].is_a?(Array)
+        _('Values') + ': ' + field[:values].join(', ')
+      else
+        field[:type] || field[:values]
+      end
+    end
   end
 
 

data/lib/hammer_cli_foreman/host.rb

@@ -489,7 +489,7 @@ module HammerCLIForeman
 
       command_name "disassociate"
       desc _("Disassociate a host")
-      success_message _("The host has been disassociated from VM")
+      success_message _("The host has been disassociated from VM.")
       failure_message _("Failed to disassociated host from VM")
 
       build_options

data/lib/hammer_cli_foreman/hostgroup.rb

@@ -17,6 +17,7 @@ module HammerCLIForeman
       base.option "--root-pass", "ROOT_PASSWORD",  _("Root password")
       base.option "--ask-root-pass", "ASK_ROOT_PW", "",
         :format => HammerCLI::Options::Normalizers::Bool.new
+      base.option "--subnet6", "SUBNET6_NAME", _("Subnet IPv6 name")
     end
 
     def self.ask_password
@@ -35,6 +36,8 @@ module HammerCLIForeman
 
       params['hostgroup']['root_pass'] = option_root_pass if option_root_pass
       params['hostgroup']['root_pass'] = HammerCLIForeman::HostgroupUpdateCreateCommons::ask_password if option_ask_root_pass
+
+      params['hostgroup']['subnet6_id'] = resolver.subnet_id('option_name' => option_subnet6) if option_subnet6
       params
     end
 

data/lib/hammer_cli_foreman/option_sources/id_params.rb

@@ -1,6 +1,6 @@
 module HammerCLIForeman
   module OptionSources
-    class IdParams
+    class IdParams < HammerCLI::Options::Sources::Base
       def initialize(command)
         @command = command
       end

data/lib/hammer_cli_foreman/option_sources/ids_params.rb

@@ -1,6 +1,6 @@
 module HammerCLIForeman
   module OptionSources
-    class IdsParams
+    class IdsParams < HammerCLI::Options::Sources::Base
       def initialize(command)
         @command = command
       end

data/lib/hammer_cli_foreman/option_sources/self_param.rb

@@ -1,6 +1,6 @@
 module HammerCLIForeman
   module OptionSources
-    class SelfParam
+    class SelfParam < HammerCLI::Options::Sources::Base
       def initialize(command)
         @command = command
       end

data/lib/hammer_cli_foreman/option_sources/user_params.rb

@@ -1,6 +1,6 @@
 module HammerCLIForeman
   module OptionSources
-    class UserParams
+    class UserParams < HammerCLI::Options::Sources::Base
       def initialize(command)
         @command = command
       end

data/lib/hammer_cli_foreman/version.rb

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

data/test/functional/commands/list_test.rb

@@ -33,6 +33,21 @@ describe HammerCLIForeman::ListCommand do
     HammerCLI::Settings.clear
   end
 
+  context 'help' do
+    let(:cmd) { ['host', 'list'] }
+    let(:params) { ['--help'] }
+
+    it 'shows search fields in help' do
+      result = run_cmd(cmd + params)
+      result.out.must_match(/.*Search fields:\s+(\S+\s+\S+)*\s+name\s+string/)
+    end
+
+    it 'formats enum values' do
+      result = run_cmd(cmd + params)
+      result.out.must_match(/.*Search fields:\s+(\S+\s+\S+)*\s+managed\s+Values: true, false/)
+    end
+  end
+
   describe "api interaction" do
     context "without per_page in settings" do
       it "fetches only first page when there's not enough records" do

data/test/functional/host_test.rb

@@ -276,7 +276,7 @@ describe 'disassociate host from vm' do
 
   it 'successful disassociate host' do
     params = ['--id=1']
-    expected_result = success_result("The host has been disassociated from VM\n")
+    expected_result = success_result("The host has been disassociated from VM.\n")
     api_expects(:hosts, :disassociate, 'disassociate hosts') do |params|
       params['id'] == "1"
     end.returns({})

data/test/functional/smart_class_parameter_test.rb

@@ -89,7 +89,8 @@ describe 'sc-params add-matcher' do
       'Could not create the override value'
     )
 
-    api_expects_no_call
+    api_expects_parameter_search(puppet_class, parameter)
+
     result = run_cmd(cmd + base + params)
     assert_cmd(expected_result, result)
   end

data/test/unit/commands_test.rb

@@ -196,3 +196,15 @@ describe HammerCLIForeman::Command do
   end
 
 end
+
+describe HammerCLIForeman::ListCommand do
+  class OpenListCommand < HammerCLIForeman::ListCommand
+    public :search_field_help_value
+  end
+
+  it 'formats enum values in search fields help' do
+    search_field = { name: 'managed', values: [true, false] }
+    expected_output = 'Values: true, false'
+    OpenListCommand.new({}).search_field_help_value(search_field).must_equal(expected_output)
+  end
+end

data/test/unit/messages_test.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'hammer_cli/testing/messages'
+
+include HammerCLI::Testing::Messages
+describe "message formatting" do
+  check_all_command_messages(
+    HammerCLI::MainCommand,
+    HammerCLIForeman::Command,
+    except: {
+      'HammerCLIForeman::PersonalAccessToken::CreateCommand' => [:success_message]
+    }
+  )
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli_foreman
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.16.0
 platform: ruby
 authors:
 - Tomáš Strachota
@@ -9,16 +9,13 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-17 00:00:00.000000000 Z
+date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hammer_cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.15.1
-    - - "<"
       - !ruby/object:Gem::Version
         version: 0.16.0
   type: :runtime
@@ -26,9 +23,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.15.1
-    - - "<"
       - !ruby/object:Gem::Version
         version: 0.16.0
 - !ruby/object:Gem::Dependency
@@ -498,6 +492,7 @@ files:
 - test/unit/image_test.rb
 - test/unit/location_test.rb
 - test/unit/media_test.rb
+- test/unit/messages_test.rb
 - test/unit/model_test.rb
 - test/unit/operating_system_test.rb
 - test/unit/option_builders_test.rb
@@ -540,7 +535,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Foreman commands for Hammer
@@ -832,6 +827,7 @@ test_files:
 - test/unit/architecture_test.rb
 - test/unit/defaults_test.rb
 - test/unit/puppet_class_test.rb
+- test/unit/messages_test.rb
 - test/unit/config_group_test.rb
 - test/unit/template_test.rb
 - test/unit/param_filters_test.rb