hammer_cli_foreman 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c8e1d9e2bdf020465f92034a08e8348496fe4b4f
-  data.tar.gz: 8e5b33da07245341c8a0b8df40662736f5c4c83d
+SHA256:
+  metadata.gz: 879dc32762958668d6e95ffb5ff7ba04222b42be763aad77bd00045763074d45
+  data.tar.gz: 75334fc224d49d58d2b0f3ff9b420db02fa25d84df2f8595736e4fe92872fdcf
 SHA512:
-  metadata.gz: b4262e878d4e0cd9254cccf99ed75827559b525b55e42a402da594331d85df2ce8e1e23c7cc439271cb8649bbca14dfe4063b4913e99e01b7e88251adcf9feb2
-  data.tar.gz: 959f424ddfc94a4a60ca5da344945cb4859005e4529fdd14bcce61ff5ca5beb17bab7b937d308356cc73e969dd8bc36012642d94bc1e0a38296af4d446ac9c3d
+  metadata.gz: 6e0f879c792cadf51b3a53fcac50297f5620a203b1a7e2d0c85df655926f29da00f5452734a79e79f000fb3ab030ff3058cf569e3339c5991d942a2fb2145d20
+  data.tar.gz: 46800432d77b3cea0c324995b5cd4ba3a49d69bde6f6d4ba2fc6bd0e1b7c2a69f7ed6148f3489ba3a7912f2742396844a31666a29ea71076598f956349ccafa6

data/doc/release_notes.md

@@ -1,5 +1,18 @@
 Release notes
 =============
+### 0.17.0 (2019-04-24)
+* Add public key option in create compute resource CLI ([#25491](http://projects.theforeman.org/issues/25491))
+* Background template rendering ([PR #414](https://github.com/theforeman/hammer-cli-foreman/pull/414)) ([#26355](http://projects.theforeman.org/issues/26355))
+* Parameter type to parameter commands ([#26008](http://projects.theforeman.org/issues/26008))
+* New API data that needed for parameter_type fix ([#26008](http://projects.theforeman.org/issues/26008))
+* parameter_type option to parameter commands ([#26008](http://projects.theforeman.org/issues/26008))
+* Move compute resource validation to their class ([#26234](http://projects.theforeman.org/issues/26234))
+* Improve documentation of id fields in ovirt ([#26334](http://projects.theforeman.org/issues/26334))
+* Add rebuild-config subcommand for hostgroups ([#26129](http://projects.theforeman.org/issues/26129))
+* Add compute profile commands ([PR #398](https://github.com/theforeman/hammer-cli-foreman/pull/398)) ([#20538](http://projects.theforeman.org/issues/20538))
+* Display uptime ([#26019](http://projects.theforeman.org/issues/26019))
+* Hammer host update and set-parameters need clarification ([#25964](http://projects.theforeman.org/issues/25964))
+
 ### 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))

data/lib/hammer_cli_foreman.rb

@@ -45,6 +45,10 @@ module HammerCLIForeman
       'HammerCLIForeman::Audit', 'hammer_cli_foreman/audit'
     )
 
+    HammerCLI::MainCommand.lazy_subcommand('compute-profile', _("Manipulate compute profiles"),
+      'HammerCLIForeman::ComputeProfile', 'hammer_cli_foreman/compute_profile'
+    )
+
     HammerCLI::MainCommand.lazy_subcommand('compute-resource', _("Manipulate compute resources"),
       'HammerCLIForeman::ComputeResource', 'hammer_cli_foreman/compute_resource'
     )

data/lib/hammer_cli_foreman/common_parameter.rb

@@ -11,6 +11,7 @@ module HammerCLIForeman
       output do
         field :name, _("Name")
         field :value, _("Value")
+        field :parameter_type, _("Type")
       end
 
       build_options
@@ -27,6 +28,9 @@ module HammerCLIForeman
       option "--name", "NAME", _("Parameter name"), :required => true
       option "--value", "VALUE", _("Parameter value"), :required => true
       option "--hidden-value", "HIDDEN_VALUE", _("Should the value be hidden"), :format => HammerCLI::Options::Normalizers::Bool.new
+      option "--parameter-type", "PARAMETER_TYPE", _("Type of the parameter"),
+        :default => 'string',
+        :format => HammerCLI::Options::Normalizers::Enum.new(Parameter::KEY_TYPES)
 
       def action
         @action ||= parameter_exist? ? :update : :create

data/lib/hammer_cli_foreman/compute_attribute.rb

@@ -0,0 +1,318 @@
+require 'hammer_cli_foreman/image'
+require 'hammer_cli_foreman/compute_resource/register_compute_resources'
+require 'hammer_cli_foreman/compute_resource/help_utils'
+
+module HammerCLIForeman
+  class ComputeAttribute < HammerCLIForeman::Command
+    resource :compute_attributes
+
+    def self.get_params(options)
+      params = {}
+      params['compute_attribute'] = {}
+      profile = HammerCLIForeman.record_to_common_format(
+          HammerCLIForeman.foreman_resource(:compute_profiles).call(:show, 'id' => options['option_compute_profile_id'] )
+      )
+      params['compute_attribute'] = profile['compute_attributes'].select { |hash| hash['compute_resource_id'] == options['option_compute_resource_id']}[0] || {}
+      params['compute_attribute'].delete('attributes') if params['compute_attribute']['attributes']
+      params
+    end
+
+    def self.attribute_hash(attribute_list)
+      attribute_list.size.times.map { |idx| idx.to_s }.zip(attribute_list).to_h
+    end
+
+    class Create < HammerCLIForeman::CreateCommand
+        desc _('Create compute profile set of values')
+
+      option '--compute-attributes', 'COMPUTE_ATTRS', _('Compute resource attributes'),
+             :format => HammerCLI::Options::Normalizers::KeyValueList.new
+      option '--interface', 'INTERFACE', _('Interface parameters, should be comma separated list of values'),
+             :format => HammerCLI::Options::Normalizers::KeyValueList.new, :multivalued => true
+      option '--volume', 'VOLUME', _('Volume parameters, should be comma separated list of values'),
+             :format => HammerCLI::Options::Normalizers::KeyValueList.new, :multivalued => true
+
+      extend_help do |h|
+        ::HammerCLIForeman::ComputeResources.extend_help(h, :all)
+      end
+
+      validate_options do
+        any(:option_compute_profile_id, :option_compute_profile_name ).required
+        any(:option_compute_resource_id, :option_compute_resource_name).required
+      end
+
+      def request_params
+        params = super
+        compute_resource_name = HammerCLIForeman.record_to_common_format(HammerCLIForeman.foreman_resource(:compute_resources).call(:show, 'id' => options["option_compute_resource_id"] ))["provider_friendly_name"].downcase
+        interfaces_attr_name = ::HammerCLIForeman.compute_resources[compute_resource_name].interfaces_attrs_name
+        params['compute_attribute']['vm_attrs'] = option_compute_attributes || {}
+        params['compute_attribute']['vm_attrs'][interfaces_attr_name]= HammerCLIForeman::ComputeAttribute.attribute_hash(option_interface_list) unless option_interface_list.empty?
+        params['compute_attribute']['vm_attrs']['volumes_attributes'] = HammerCLIForeman::ComputeAttribute.attribute_hash(option_volume_list) unless option_volume_list.empty?
+        params
+      end
+
+      success_message _('Compute profile attributes are set.')
+      failure_message _('Could not set the compute profile attributes')
+      build_options
+    end
+
+    class Update < HammerCLIForeman::UpdateCommand
+      desc _('Update compute profile values')
+
+      option '--compute-attributes', 'COMPUTE_ATTRS', _('Compute resource attributes, should be comma separated list of values'),
+             :format => HammerCLI::Options::Normalizers::KeyValueList.new
+      option '--interface', 'INTERFACE', _('Interface parameters, should be comma separated list of values'),
+             :format => HammerCLI::Options::Normalizers::KeyValueList.new, :multivalued => true
+      option '--volume', 'VOLUME', _('Volume parameters, should be comma separated list of values'),
+             :format => HammerCLI::Options::Normalizers::KeyValueList.new, :multivalued => true
+
+      extend_help do |h|
+        ::HammerCLIForeman::ComputeResources.extend_help(h, :all)
+      end
+
+      validate_options do
+        any(:option_compute_profile_id, :option_compute_profile_name ).required
+        any(:option_compute_resource_id, :option_compute_resource_name).required
+      end
+
+
+      def request_params
+
+        params = HammerCLIForeman::ComputeAttribute.get_params(options)
+        compute_resource_name = HammerCLIForeman.record_to_common_format(HammerCLIForeman.foreman_resource(:compute_resources).call(:show, 'id' => options["option_compute_resource_id"] ))["provider_friendly_name"].downcase
+        interfaces_attr_name = ::HammerCLIForeman.compute_resources[compute_resource_name].interfaces_attrs_name
+
+        raise ArgumentError, "Compute profile value to update does not exist yet; it needs to be created first" if !params['compute_attribute'].key?('id')
+        params['id'] =  params['compute_attribute']['id']
+        vm_attrs = params['compute_attribute']['vm_attrs']
+        original_volumes = vm_attrs['volumes_attributes'] || {}
+        original_interfaces = vm_attrs[interfaces_attr_name] || {}
+
+        if options['option_compute_attributes']
+          vm_attrs = options['option_compute_attributes']
+          vm_attrs['volumes_attributes'] ||= original_volumes
+          vm_attrs[interfaces_attr_name] ||= original_interfaces
+        end
+        vm_attrs[interfaces_attr_name] = HammerCLIForeman::ComputeAttribute.attribute_hash(options['option_interface_list']) unless options['option_interface_list'].empty?
+        vm_attrs['volumes_attributes'] = HammerCLIForeman::ComputeAttribute.attribute_hash(options['option_volume_list']) unless options['option_volume_list'].empty?
+        params['compute_attribute']['vm_attrs'] = vm_attrs
+        params
+
+      end
+      success_message _('Compute profile attributes updated.')
+      failure_message _('Could not update the compute profile attributes')
+
+      build_options :without => :id
+    end
+
+    # Using the Update command because adding a new interface is done by modifying existing compute_attribute
+    class AddInterface < HammerCLIForeman::UpdateCommand
+      command_name 'add-interface'
+      desc _('Add interface for Compute Profile')
+      option '--interface', 'SET_VALUES', _('Interface parameters, should be comma separated list of values'),
+             :format => HammerCLI::Options::Normalizers::KeyValueList.new, :required => true
+
+      extend_help do |h|
+        ::HammerCLIForeman::ComputeResources.extend_help(h, :interface)
+      end
+
+      def validate_options
+        super
+        validator.any(:option_compute_profile_id,:option_compute_profile_name).required
+        validator.any(:option_compute_resource_id,:option_compute_resource_name).required
+      end
+
+      def request_params
+        params = HammerCLIForeman::ComputeAttribute.get_params(options)
+
+        raise ArgumentError, "Compute profile value to update does not exist yet; it needs to be created first" if !params['compute_attribute'].key?('id')
+        compute_resource_name = HammerCLIForeman.record_to_common_format(HammerCLIForeman.foreman_resource(:compute_resources).call(:show, 'id' => options["option_compute_resource_id"] ))["provider_friendly_name"].downcase
+
+
+        interfaces_attr_name = ::HammerCLIForeman.compute_resources[compute_resource_name].interfaces_attrs_name
+        interface_attr =  params['compute_attribute']['vm_attrs'][interfaces_attr_name] || {}
+        new_interface_id = (interface_attr.keys.max.to_i + 1 ).to_s if interface_attr.any?
+        new_interface_id ||= "0"
+        params['id'] = params['compute_attribute']['id']
+
+        params['compute_attribute']['vm_attrs'][interfaces_attr_name] ||= {}
+        params['compute_attribute']['vm_attrs'][interfaces_attr_name][new_interface_id] = option_interface
+        params
+      end
+
+      success_message _('Interface was created.')
+      failure_message _('Could not create interface')
+
+      build_options :without => :id
+    end
+
+    class UpdateInterface < HammerCLIForeman::UpdateCommand
+      command_name 'update-interface'
+
+      desc _('Update compute profile interface')
+
+      option '--interface', 'SET_VALUES', _('Interface parameters, should be comma separated list of values'),
+             :required => true,
+             :format => HammerCLI::Options::Normalizers::KeyValueList.new
+      option '--interface-id', 'INTERFACE_ID', _('Interface id'),
+             :required => true,
+             :format => HammerCLI::Options::Normalizers::Number.new
+
+      extend_help do |h|
+        ::HammerCLIForeman::ComputeResources.extend_help(h, :interface)
+      end
+
+      def validate_options
+        super
+        validator.any(:option_compute_profile_id, :option_compute_profile_name).required
+        validator.any(:option_compute_resource_id, :option_compute_resource_name).required
+      end
+
+      def request_params
+        params = HammerCLIForeman::ComputeAttribute.get_params(options)
+        raise ArgumentError, "Compute profile value to update does not exist yet; it needs to be created first" if !params['compute_attribute'].key?('id')
+        compute_resource_name = HammerCLIForeman.record_to_common_format(HammerCLIForeman.foreman_resource(:compute_resources).call(:show, 'id' => options["option_compute_resource_id"] ))["provider_friendly_name"].downcase
+        interfaces_attr_name = ::HammerCLIForeman.compute_resources[compute_resource_name].interfaces_attrs_name
+        params['id'] = params['compute_attribute']['id']
+        params['compute_attribute']['vm_attrs'][interfaces_attr_name] ||= {}
+        params['compute_attribute']['vm_attrs'][interfaces_attr_name][option_interface_id] = option_interface
+        params
+      end
+      success_message _('Interface was updated.')
+      failure_message _('Could not update interface')
+      build_options :without => :id
+    end
+
+    # Using the Update command because removing an interface is done by modifying existing compute_attribute
+    class RemoveInterface < HammerCLIForeman::UpdateCommand
+      command_name 'remove-interface'
+      desc _('Remove compute profile interface')
+      option '--interface-id', 'INTERFACE ID', _('Interface id'),
+             :format => HammerCLI::Options::Normalizers::Number.new , :required => true
+
+      def validate_options
+        super
+        validator.any(:option_compute_profile_id, :option_compute_profile_name).required
+        validator.any(:option_compute_resource_id, :option_compute_resource_name).required
+      end
+
+      def request_params
+        params = HammerCLIForeman::ComputeAttribute.get_params(options)
+        raise ArgumentError, "Compute profile value to update does not exist yet; it needs to be created first" if !params['compute_attribute'].key?('id')
+        compute_resource_name = HammerCLIForeman.record_to_common_format(HammerCLIForeman.foreman_resource(:compute_resources).call(:show, 'id' => options["option_compute_resource_id"] ))["provider_friendly_name"].downcase
+        interfaces_attr_name = ::HammerCLIForeman.compute_resources[compute_resource_name].interfaces_attrs_name
+        params['id'] = params['compute_attribute']['id']
+        if params['compute_attribute']['vm_attrs'][interfaces_attr_name].has_key?(option_interface_id.to_s)
+          params['compute_attribute']['vm_attrs'][interfaces_attr_name].delete(option_interface_id.to_s)
+        else
+          signal_usage_error _('unknown interface id')
+        end
+        params
+      end
+      success_message _('Interface was removed.')
+      failure_message _('Could not remove interface')
+      build_options :without => :id
+    end
+
+    # Using the Update command because adding a new volume is done by modifying existing compute_attribute
+    class AddVolume < HammerCLIForeman::UpdateCommand
+      command_name 'add-volume'
+      desc _('Add volume for Compute Profile')
+
+      option '--volume', 'VOLUME', _('Volume parameters, should be comma separated list of values'),
+             :format => HammerCLI::Options::Normalizers::KeyValueList.new, :required => true
+
+      extend_help do |h|
+        ::HammerCLIForeman::ComputeResources.extend_help(h, :volume)
+      end
+
+      def validate_options
+        super
+        validator.any(:option_compute_profile_id, :option_compute_profile_name).required
+        validator.any(:option_compute_resource_id, :option_compute_resource_name).required
+      end
+
+      def request_params
+        params = HammerCLIForeman::ComputeAttribute.get_params(options)
+        raise ArgumentError, "Compute profile value to update does not exist yet; it needs to be created first" if !params['compute_attribute'].key?('id')
+        volume_attr =  params['compute_attribute']['vm_attrs']['volumes_attributes'] || {}
+        new_volume_id = (volume_attr.keys.max.to_i + 1 ).to_s if volume_attr.any?
+        new_volume_id ||= "0"
+        params['id'] = params['compute_attribute']['id']
+        params['compute_attribute']['vm_attrs']['volumes_attributes'] ||= {}
+        params['compute_attribute']['vm_attrs']['volumes_attributes'][new_volume_id] = option_volume
+        params
+      end
+
+      success_message _('Volume was created.')
+      failure_message _('Could not create volume')
+      build_options :without => :id
+    end
+
+    class UpdateVolume < HammerCLIForeman::UpdateCommand
+      command_name 'update-volume'
+      desc _('Update compute profile volume')
+
+      option '--volume', 'VOLUME', _('Volume parameters, should be comma separated list of values'),
+             :required => true,
+             :format => HammerCLI::Options::Normalizers::KeyValueList.new
+      option '--volume-id', 'VOLUME_ID', _('Volume id'),
+             :required => true,
+             :format => HammerCLI::Options::Normalizers::Number.new
+
+      extend_help do |h|
+        ::HammerCLIForeman::ComputeResources.extend_help(h, :volume)
+      end
+
+
+      def validate_options
+        super
+        validator.any(:option_compute_profile_id, :option_compute_profile_name).required
+        validator.any(:option_compute_resource_id, :option_compute_resource_name).required
+      end
+
+      def request_params
+        params = HammerCLIForeman::ComputeAttribute.get_params(options)
+        raise ArgumentError, "Compute profile value to update does not exist yet; it needs to be created first" if !params['compute_attribute'].key?('id')
+        params['id'] = params['compute_attribute']['id']
+        params['compute_attribute']['vm_attrs']['volumes_attributes'] ||= {}
+        params['compute_attribute']['vm_attrs']['volumes_attributes'][option_volume_id] = option_volume
+        params
+      end
+      success_message _('Volume was updated.')
+      failure_message _('Could not update volume')
+      build_options :without => :id
+    end
+
+    # Using the Update command because removing a volume is done by modifying existing compute_attribute
+    class RemoveVolume < HammerCLIForeman::UpdateCommand
+      command_name 'remove-volume'
+      resource :compute_attributes
+      desc _('Remove compute profile volume')
+      option '--volume-id', 'VOLUME_ID', _('Volume id'),
+             :format => HammerCLI::Options::Normalizers::Number.new, :required=> true
+
+      def validate_options
+        super
+        validator.any(:option_compute_profile_id, :option_compute_profile_name).required
+        validator.any(:option_compute_resource_id, :option_compute_resource_name).required
+      end
+
+      def request_params
+        params = HammerCLIForeman::ComputeAttribute.get_params(options)
+        raise ArgumentError, "Compute profile value to update does not exist yet; it needs to be created first" if !params['compute_attribute'].key?('id')
+        params['id'] = params['compute_attribute']['id']
+        if params['compute_attribute']['vm_attrs']['volumes_attributes'].has_key?(option_volume_id.to_s)
+          params['compute_attribute']['vm_attrs']['volumes_attributes'].delete(option_volume_id.to_s)
+        else
+          signal_usage_error _('unknown volume id')
+        end
+        params
+      end
+      success_message _('Volume was removed.')
+      failure_message _('Could not remove volume')
+      build_options :without => :id
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_foreman/compute_profile.rb

@@ -0,0 +1,61 @@
+require 'hammer_cli_foreman/image'
+
+module HammerCLIForeman
+  class ComputeProfile < HammerCLIForeman::Command
+    resource :compute_profiles
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+      end
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output ListCommand.output_definition do
+
+        HammerCLIForeman::References.taxonomies(self)
+        HammerCLIForeman::References.timestamps(self)
+
+        collection :compute_attributes, _('Compute attributes') do
+          field :id, _('Id')
+          field :name, _('Name')
+          field nil, _('Compute Resource'), Fields::SingleReference, :key => :compute_resource
+          field :vm_attrs, _('VM attributes')
+        end
+      end
+      build_options
+    end
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      success_message _('Compute profile created.')
+      failure_message _('Could not create a compute profile')
+      build_options
+    end
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      success_message _('Compute profile updated.')
+      failure_message _('Could not update the compute profile')
+      validate_options do
+        any(:option_name,:option_id).required
+      end
+      build_options
+    end
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _('Compute profile deleted.')
+      failure_message _('Could not delete the Compute profile')
+      validate_options do
+        any(:option_name,:option_id).required
+      end
+      build_options
+    end
+
+    lazy_subcommand('values', _("Create update and delete Compute profile values"),
+                    'HammerCLIForeman::ComputeAttribute', 'hammer_cli_foreman/compute_attribute'
+    )
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_foreman/compute_resource.rb

@@ -1,4 +1,6 @@
 require 'hammer_cli_foreman/image'
+require 'hammer_cli_foreman/compute_resource/register_compute_resources'
+
 
 module HammerCLIForeman
 
@@ -69,34 +71,48 @@ module HammerCLIForeman
 
 
     class CreateCommand < HammerCLIForeman::CreateCommand
+      option "--public-key-path", "PUBLIC_KEY_PATH", _("Path to a file that contains oVirt public key (For oVirt only)"),
+             :format => HammerCLI::Options::Normalizers::File.new
 
-      VALIDATION_PER_PROVIDER = {
-        'libvirt'   => [:option_url],
-        'ovirt'     => [:option_url, :option_user, :option_password, :option_datacenter],
-        'openstack' => [:option_url, :option_user, :option_password],
-        'racksapce' => [:option_url],
-        'ec2'       => [:option_region, :option_user, :option_password],
-        'vmware'    => [:option_user, :option_password, :option_datacenter, :option_server]
-      }
 
       success_message _("Compute resource created.")
       failure_message _("Could not create the compute resource")
 
       build_options
 
-      validate_options do
-        required_options = (VALIDATION_PER_PROVIDER[
-          option(:option_provider).value.to_s.downcase
-        ] || []).unshift(:option_name, :option_provider).uniq
+      def request_params
+        params = super
+        params['compute_resource']['public_key'] = option_public_key_path if option_public_key_path
+        params
+      end
 
-        all(*required_options).required
+      validate_options do
+        if option(:option_provider).value.nil? || option(:option_name).value.nil?
+          all(:option_name, :option_provider).required
+        else
+          provider = ::HammerCLIForeman.compute_resources[option(:option_provider).value.to_s.downcase]
+          if provider
+            required_options = provider.mandatory_resource_options.map { |attr| "option_#{attr}".to_sym }
+            all(*required_options).required
+          else
+            raise ArgumentError, "incorrect/invalid --provider option"
+          end
+        end
       end
     end
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
+      option "--public-key-path", "PUBLIC_KEY_PATH", _("Path to a file that contains oVirt public key (For oVirt only)"),
+             :format => HammerCLI::Options::Normalizers::File.new
+
       success_message _("Compute resource updated.")
       failure_message _("Could not update the compute resource")
 
+      def request_params
+        params = super
+        params['compute_resource']['public_key'] = option_public_key_path if option_public_key_path
+        params
+      end
       build_options :without => :name
     end