hammer_cli_foreman 0.17.2 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cfafe507d907c2ab1aed91af69e697a96b3ebf53a986c95e08eb983d428d5c3
-  data.tar.gz: 66077cbc504c823917ce78e519f5483d6bb3dc64ca879926105ce9074e36a740
+  metadata.gz: 918e60154e914780c804e9b033bec387c7fdb2390db19c46023cf65d9238896a
+  data.tar.gz: 57dda224b72156be5abab4ca2f23e6fdf0ee13145137cdd0384d198d5730eb4b
 SHA512:
-  metadata.gz: 3cf5631ead2692b824488dfe9583fd6e08f39a10a51c52bef283ad073e8ce985566de787262704bee7811f84e1c57e8b44bfaddf1aa1247684c9db3c1b0fc16d
-  data.tar.gz: 4e708bb0f305e0affc530a9418030952c8bbea70183ab50500f336d7c4f9f355eef7dde9e877a16c7f333c8dfb44b9c6fc664d9eab57c9a232beaedb11e65d0f
+  metadata.gz: a54d4883620ffc7f974368651d5b8dfdbfeb245489236d3c76f0d9f4d850fe1083d62f48101c0dbc4ac1b10df577de54f43a7237cbcbfc89203f2693a01eec29
+  data.tar.gz: c1bc962fe6550212ed81a50ca0c5f6e05efe6b134079929a203e82c6432aef9646ce8dcf637a530579dfd9760add6366da71caf37892fbff90b22810fb03db7a

data/doc/host_create.md

@@ -16,7 +16,7 @@ Usage:
 
 Options:
  --architecture ARCHITECTURE_NAME                              Architecture name
- --architecture-id ARCHITECTURE_ID                              
+ --architecture-id ARCHITECTURE_ID
  --ask-root-password ASK_ROOT_PW                               One of true/false, yes/no, 1/0.
  --autoheal AUTOHEAL                                           Sets whether the Host will autoheal subscriptions upon checkin
                                                                One of true/false, yes/no, 1/0.
@@ -25,14 +25,14 @@ Options:
  --compute-attributes COMPUTE_ATTRS                            Compute resource attributes
                                                                Comma-separated list of key=value
  --compute-profile COMPUTE_PROFILE_NAME                        Name to search by
- --compute-profile-id COMPUTE_PROFILE_ID                        
+ --compute-profile-id COMPUTE_PROFILE_ID
  --compute-resource COMPUTE_RESOURCE_NAME                      Compute resource name
- --compute-resource-id COMPUTE_RESOURCE_ID                      
+ --compute-resource-id COMPUTE_RESOURCE_ID
  --config-group-ids CONFIG_GROUP_IDS                           IDs of associated config groups
                                                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
  --config-groups CONFIG_GROUP_NAMES                            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
  --content-source CONTENT_SOURCE_NAME                          Content Source name
- --content-source-id CONTENT_SOURCE_ID                          
+ --content-source-id CONTENT_SOURCE_ID
  --content-view CONTENT_VIEW_NAME                              Name to search by
  --content-view-id CONTENT_VIEW_ID                             Content view numeric identifier
  --domain DOMAIN_NAME                                          Domain name
@@ -40,12 +40,12 @@ Options:
  --enabled ENABLED                                             Include this host within Foreman reporting
                                                                One of true/false, yes/no, 1/0.
  --hostgroup HOSTGROUP_NAME                                    Hostgroup name
- --hostgroup-id HOSTGROUP_ID                                    
+ --hostgroup-id HOSTGROUP_ID
  --hostgroup-title HOSTGROUP_TITLE                             Hostgroup title
  --hypervisor-guest-uuids HYPERVISOR_GUEST_UUIDS               List of hypervisor guest uuids
                                                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
  --image IMAGE_NAME                                            Name to search by
- --image-id IMAGE_ID                                            
+ --image-id IMAGE_ID
  --installed-products-attributes INSTALLED_PRODUCTS_ATTRIBUTES List of products installed on the host
                                                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
  --interface INTERFACE                                         Interface parameters
@@ -57,7 +57,7 @@ Options:
  --lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME            Name to search by
  --lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID           ID of the environment
  --location LOCATION_NAME                                      Location name
- --location-id LOCATION_ID                                      
+ --location-id LOCATION_ID
  --location-title LOCATION_TITLE                               Location title
  --mac MAC                                                     Required for managed host that is bare metal, not required if it's a
                                                                Virtual machine
@@ -65,12 +65,12 @@ Options:
                                                                Also determines whether several parameters are required or not
                                                                One of true/false, yes/no, 1/0.
  --medium MEDIUM_NAME                                          Medium name
- --medium-id MEDIUM_ID                                          
+ --medium-id MEDIUM_ID
  --model MODEL_NAME                                            Model name
- --model-id MODEL_ID                                            
- --name NAME                                                    
+ --model-id MODEL_ID
+ --name NAME
  --operatingsystem OPERATINGSYSTEM_TITLE                       Operating system title
- --operatingsystem-id OPERATINGSYSTEM_ID                        
+ --operatingsystem-id OPERATINGSYSTEM_ID
  --organization ORGANIZATION_NAME                              Organization name
  --organization-id ORGANIZATION_ID                             Organization ID
  --organization-title ORGANIZATION_TITLE                       Organization title
@@ -83,20 +83,20 @@ Options:
  --parameters PARAMS                                           Host parameters
                                                                Comma-separated list of key=value
  --partition-table PARTITION_TABLE_NAME                        Partition table name
- --partition-table-id PARTITION_TABLE_ID                        
+ --partition-table-id PARTITION_TABLE_ID
  --product PRODUCT_NAME                                        Name to search by
  --product-id PRODUCT_ID                                       Product numeric identifier
  --progress-report-id PROGRESS_REPORT_ID                       UUID to track orchestration tasks status, GET
                                                                /api/orchestration/:UUID/tasks
  --provision-method PROVISION_METHOD                           The method used to provision the host.
                                                                Possible value(s): 'build', 'image'
- --puppet-ca-proxy PUPPET_CA_PROXY_NAME                         
+ --puppet-ca-proxy PUPPET_CA_PROXY_NAME
  --puppet-ca-proxy-id PUPPET_CA_PROXY_ID                       Puppet CA proxy ID
  --puppet-class-ids PUPPET_CLASS_IDS                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
  --puppet-classes PUPPET_CLASS_NAMES                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
  --puppet-environment PUPPET_ENVIRONMENT_NAME                  Puppet Environment name
- --puppet-environment-id PUPPET_ENVIRONMENT_ID                                
- --puppet-proxy PUPPET_PROXY_NAME                               
+ --puppet-environment-id PUPPET_ENVIRONMENT_ID
+ --puppet-proxy PUPPET_PROXY_NAME
  --puppet-proxy-id PUPPET_PROXY_ID                             Puppet proxy ID
  --pxe-loader PXE_LOADER                                       DHCP filename option (Grub2/PXELinux by default)
                                                                Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI'
@@ -106,7 +106,7 @@ Options:
  --root-password ROOT_PW                                       Required if host is managed and value is not inherited from host group or default password in settings
  --service-level SERVICE_LEVEL                                 Service level to be used for autoheal
  --subnet SUBNET_NAME                                          Subnet name
- --subnet-id SUBNET_ID                                          
+ --subnet-id SUBNET_ID
  --volume VOLUME                                               Volume parameters
                                                                Comma-separated list of key=value
                                                                Can be specified multiple times.
@@ -187,7 +187,7 @@ Available keys for `--compute-attributes`:
 machine_type # one of available flavors
 image_id
 network
-external_ip
+associate_external_ip
 ```
 
 ## Libvirt

data/doc/release_notes.md

@@ -1,13 +1,26 @@
 Release notes
 =============
-### 0.17.2 (2019-08-13)
+### 0.18.0 (2019-08-01)
+* Report template schedule works with --name ([#27339](http://projects.theforeman.org/issues/27339))
+* Possibility to change host loc/org via hammer ([PR #416](https://github.com/theforeman/hammer-cli-foreman/pull/416)) ([#26536](http://projects.theforeman.org/issues/26536))
+* Consider value not display name of compute_resource ([PR #432](https://github.com/theforeman/hammer-cli-foreman/pull/432)) ([#27343](http://projects.theforeman.org/issues/27343))
+* Return missing helper methods for host ([#27444](http://projects.theforeman.org/issues/27444))
+* Customize CR fields using provider_specific_fields ([#27342](http://projects.theforeman.org/issues/27342))
+* Added volume attributes for GCE ([#27342](http://projects.theforeman.org/issues/27342))
+* Add additional keys in GCE compute resource ([#27342](http://projects.theforeman.org/issues/27342))
+* Adds project domain flags ([#26668](http://projects.theforeman.org/issues/26668))
+* Remove duplicate options ([#27375](http://projects.theforeman.org/issues/27375))
+* Full-help doesn't asks for credentials ([#26894](http://projects.theforeman.org/issues/26894))
 * Update environments options for puppet context ([#27323](http://projects.theforeman.org/issues/27323))
-* Consistent puppet environment naming in hammer ([#23204](http://projects.theforeman.org/issues/23204))
-
-### 0.17.1 (2019-07-10)
-* Consistent puppet environment naming in hammer ([#23204](http://projects.theforeman.org/issues/23204))
+* Report template schedule shows job ID ([#27341](http://projects.theforeman.org/issues/27341))
+* Host creation with multi SCSI controllers ([#25093](http://projects.theforeman.org/issues/25093), [#26421](http://projects.theforeman.org/issues/26421))
+* Add Location and Description Fields ([#21764](http://projects.theforeman.org/issues/21764))
 * Create hostgroup with puppet classes ([#24717](http://projects.theforeman.org/issues/24717))
-* Fix help on commands with no resource ([#26865](http://projects.theforeman.org/issues/26865))
+* Consistent puppet environment naming in hammer ([#23204](http://projects.theforeman.org/issues/23204))
+* Add abstraction for subcommand searching ([PR #342](https://github.com/theforeman/hammer-cli-foreman/pull/342)) ([#21674](http://projects.theforeman.org/issues/21674))
+* Possibility to limit fields that are displayed ([PR #407](https://github.com/theforeman/hammer-cli-foreman/pull/407)) ([#19135](http://projects.theforeman.org/issues/19135))
+* action for false:FalseClass ([#26865](http://projects.theforeman.org/issues/26865))
+* Move image_id to the compute_attributes ([#6159](http://projects.theforeman.org/issues/6159))
 
 ### 0.17.0 (2019-04-24)
 * Add public key option in create compute resource CLI ([#25491](http://projects.theforeman.org/issues/25491))

data/lib/hammer_cli_foreman/command_extensions.rb

@@ -1,6 +1,5 @@
+require 'hammer_cli_foreman/command_extensions/fields'
 require 'hammer_cli_foreman/command_extensions/puppet_environment'
-require 'hammer_cli_foreman/command_extensions/puppet_environment'
-require 'hammer_cli_foreman/command_extensions/puppet_environments'
-require 'hammer_cli_foreman/command_extensions/option_sources'
 require 'hammer_cli_foreman/command_extensions/puppet_environments'
 require 'hammer_cli_foreman/command_extensions/option_sources'
+require 'hammer_cli_foreman/command_extensions/hosts'

data/lib/hammer_cli_foreman/command_extensions/fields.rb

@@ -0,0 +1,13 @@
+module HammerCLIForeman
+  module CommandExtensions
+    class Fields < HammerCLI::CommandExtensions
+      inheritable true
+
+      use_option :fields
+
+      option_sources do |sources, command|
+        sources << HammerCLIForeman::OptionSources::FieldsParams.new(command)
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman/command_extensions/hosts.rb

@@ -0,0 +1 @@
+require 'hammer_cli_foreman/command_extensions/hosts/help'

data/lib/hammer_cli_foreman/command_extensions/hosts/help.rb

@@ -0,0 +1,2 @@
+require 'hammer_cli_foreman/command_extensions/hosts/help/interfaces'
+require 'hammer_cli_foreman/command_extensions/hosts/help/compute_resources'

data/lib/hammer_cli_foreman/command_extensions/hosts/help/compute_resources.rb

@@ -0,0 +1,85 @@
+module HammerCLIForeman
+  module CommandExtensions
+    module Hosts
+      module Help
+        class ComputeResources < HammerCLI::CommandExtensions
+          class << self
+            attr_writer :current_providers, :add_host_specific_attrs,
+                        :attributes
+
+            def current_providers
+              @current_providers ||= HammerCLIForeman.compute_resources.keys
+              @current_providers
+            end
+
+            def add_host_specific_attrs?
+              @add_host_specific_attrs ||= false
+              @add_host_specific_attrs
+            end
+
+            def attributes
+              @attributes ||= :all
+              @attributes
+            end
+
+            def customized?
+              @customized
+            end
+
+            def customized=(boolean)
+              @customized ||= boolean
+            end
+
+            def custom(options = {})
+              new_self = Class.new(ComputeResources)
+              new_self.add_host_specific_attrs = options[:add_host_specific_attrs]
+              new_self.attributes = options[:attributes]
+              new_self.current_providers = options[:providers]
+              new_self.class_eval(&help_block)
+              new_self.customized = true
+              new_self
+            end
+
+            def help_block
+              @help_block ||= Proc.new do
+                help do |h|
+                  h.section(_('Provider specific options')) do |h|
+                    HammerCLIForeman.compute_resources.each do |name, provider|
+                      next unless current_providers.include?(name)
+
+                      h.section(provider.name, id: name.to_sym) do |h|
+                        compute_attributes = provider.compute_attributes
+                        compute_attributes += provider.host_attributes if add_host_specific_attrs?
+                        if %i[all volume].include?(attributes)
+                          h.section('--volume') do |h|
+                            h.list(provider.volume_attributes)
+                          end
+                        end
+                        if %i[all interface].include?(attributes)
+                          h.section('--interface') do |h|
+                            h.list(provider.interface_attributes)
+                          end
+                        end
+                        if %i[all compute].include?(attributes)
+                          h.section('--compute-attributes', id: :s_compute_attributes) do |h|
+                            h.list(compute_attributes, id: :l_compute_attributes)
+                          end
+                        end
+                      end
+                      provider.extend_help(h) if provider.respond_to?(:extend_help)
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          def initialize(options = {})
+            super
+            self.class.class_eval(&self.class.help_block) unless self.class.customized?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman/command_extensions/hosts/help/interfaces.rb

@@ -0,0 +1,55 @@
+module HammerCLIForeman
+  module CommandExtensions
+    module Hosts
+      module Help
+        class Interfaces < HammerCLI::CommandExtensions
+          help do |h|
+            h.section(_('Available keys for %{option}') % { :option => '--interface' }) do |h|
+              h.list(
+                [
+                  'mac',
+                  'ip',
+                  ['type', _('Possible values: %s') % 'interface, bmc, bond, bridge'],
+                  'name',
+                  'subnet_id',
+                  'domain_id',
+                  'identifier',
+                  ['managed',   'true/false'],
+                  ['primary',   _('%{value}, each managed hosts needs to have one primary interface.') % {:value => 'true/false'}],
+                  ['provision', 'true/false'],
+                  ['virtual',   'true/false']
+                ]
+              )
+              h.section(_('For %{condition}') % { :condition => 'virtual=true' }) do |h|
+                h.list(
+                  [
+                    ['tag',         _('VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.')],
+                    ['attached_to', _('Identifier of the interface to which this interface belongs, e.g. eth1.')]
+                  ]
+                )
+              end
+              h.section(_('For %{condition}') % { :condition => 'type=bond' }) do |h|
+                h.list(
+                  [
+                    ['mode',             _('Possible values: %s') % 'balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb'],
+                    ['attached_devices', _('Identifiers of slave interfaces, e.g. [eth1,eth2]')],
+                    'bond_options'
+                  ]
+                )
+              end
+              h.section(_('For %{condition}') % { :condition => 'type=bmc' }) do |h|
+                h.list(
+                  [
+                    ['provider', _('always IPMI')],
+                    'username',
+                    'password'
+                  ]
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman/commands.rb

@@ -230,6 +230,15 @@ module HammerCLIForeman
     RETRIEVE_ALL_PER_PAGE = 1000
     DEFAULT_PER_PAGE = 20
 
+    def self.output(definition = nil, &block)
+      super
+      begin
+        output_definition.update_field_sets('THIN', (searchables.for(resource).map(&:name) + ['id']).map(&:to_sym))
+      rescue StandardError => e
+        # Some subcommands may not have such fields or defined resource
+      end
+    end
+
     def adapter
       @context[:adapter] || :table
     end
@@ -278,6 +287,8 @@ module HammerCLIForeman
       super
     end
 
+    extend_with(HammerCLIForeman::CommandExtensions::Fields.new)
+
     protected
 
     def retrieve_all
@@ -324,6 +335,96 @@ module HammerCLIForeman
     end
   end
 
+  class AssociatedListSearchCommand < ListCommand
+    def self.search_resource(res, action = :index)
+      resource res, action
+      default_search_options
+    end
+
+    def self.default_search_options
+      option("--id", "ID", _("%s Id") % module_resource.singular_name)
+      option("--name", "NAME", _("%s name") % module_resource.singular_name)
+    end
+
+    def self.search_options_mapping(mapping = {})
+      { "name" => module_resource.singular_name,
+        "id" => "#{module_resource.singular_name}_id"
+      }.merge mapping
+    end
+
+    def option_sources
+      sources = super
+      sources.find_by_name('IdResolution').insert_relative(
+        :replace,
+        'SelfParam',
+         HammerCLI::Options::Sources::Base.new
+      )
+      sources
+    end
+
+    def validate_options
+      super
+      validator.any("option_name".to_sym, "option_id".to_sym).required
+    end
+
+    def parent_resource_name
+      self.class.module_resource.singular_name
+    end
+
+    def search_mapping(key)
+      self.class.search_options_mapping[key]
+    end
+
+    def parent_resource_name_attr
+      "name"
+    end
+
+    def parent_resource_id_attr
+      "id"
+    end
+
+    def name_attr(resource_name)
+      "#{resource_name}_name"
+    end
+
+    def id_attr(resource_name)
+      "#{resource_name}_id"
+    end
+
+    def request_params
+      params = super
+      search = []
+      search << params['search'] if params['search']
+
+      resource_name = get_option_value(parent_resource_name_attr)
+      search << %Q(#{search_mapping parent_resource_name_attr}="#{resource_name}") if resource_name
+
+      resource_id = get_option_value(parent_resource_id_attr)
+      search << "#{search_mapping parent_resource_id_attr}=#{resource_id}" if resource_id
+
+      search += taxonomy_request_params('organization', params)
+      search += taxonomy_request_params('location', params)
+
+      params['search'] = search.join(' and ') unless search.empty?
+      params
+    end
+
+    def taxonomy_request_params(taxonomy, params)
+      res = []
+      tax_name = get_option_value(name_attr taxonomy)
+      if tax_name
+        res << "#{name_attr taxonomy}=#{tax_name}"
+        params.delete(name_attr taxonomy)
+      end
+
+      tax_id = get_option_value(id_attr taxonomy)
+      if tax_id
+        res << "#{id_attr taxonomy}=#{tax_id}"
+        params.delete(id_attr taxonomy)
+      end
+      res
+    end
+  end
 
   class SingleResourceCommand < Command
 
@@ -364,6 +465,15 @@ module HammerCLIForeman
 
     action :show
 
+    def self.output(definition = nil, &block)
+      super
+      begin
+        output_definition.update_field_sets('THIN', (searchables.for(resource).map(&:name) + ['id']).map(&:to_sym))
+      rescue StandardError => e
+        # Some subcommands may not have such fields or defined resource
+      end
+    end
+
     def self.command_name(name=nil)
       super(name) || "info"
     end
@@ -381,6 +491,7 @@ module HammerCLIForeman
       print_record(output_definition, record)
     end
 
+    extend_with(HammerCLIForeman::CommandExtensions::Fields.new)
   end