hammer_cli_foreman_ansible 0.3.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22b04f4732021b83a5f201c450ae645183a249b1fac74f9573eebc5b893e4761
-  data.tar.gz: 1e9a7ce94688a284ebd784178cc479ce19e83e1a5ba5c2e28d259ca1a5508565
+  metadata.gz: e2378fa0dc9b16ad52e6fb9c3d368c23b2d8db6d4ba64bfc31e273b1ba1b2e21
+  data.tar.gz: 3d702aa4392493735abd50d5acf2f382e9f5c42809d2d7b13558df951fb5e87c
 SHA512:
-  metadata.gz: 8444e5efcd1d36fef6925ae3fb2a6320c74da8d8a9e05e18efc257214ec2d7607bb8267f8d4451177f875fb69dc38da57c6ef844dfb84d57c3a506d98a410039
-  data.tar.gz: c3622e78574949e8ea728f18cbe6fc8368a2f6d4052c3015da1151d4ce0a7ad83d4c9fb872cca12d257dea6d3763377f49426c9c0018b19571b47fef111890ec
+  metadata.gz: '09b412c43b4a0050ee41d2e7e2657c1928c81fe1d84ead4323c70e254e92e31ac980c904b2c0d5f4e06f7970ab6269b60fb3d4ce39329607ee3328f0d25b6f56'
+  data.tar.gz: d8e97a5f33a6fa060f8f3b8c29886c8827eb5bca2170290dbce026c80bfbef2ae53878c96b0269a9e3863df7985189ecefa8b98419c8bfc81bab2323fcd10ffb

data/lib/hammer_cli_foreman_ansible/ansible.rb

@@ -16,6 +16,12 @@ module HammerCLIForemanAnsible
       'hammer_cli_foreman_ansible/ansible_variables'
     )
 
+    lazy_subcommand(
+      'inventory',
+      _('Ansible Inventory'),
+      'HammerCLIForemanAnsible::AnsibleInventoryCommand',
+      'hammer_cli_foreman_ansible/ansible_inventory'
+    )
     autoload_subcommands
   end
 end

data/lib/hammer_cli_foreman_ansible/ansible_inventory.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module HammerCLIForemanAnsible
+  class AnsibleInventoryCommand < HammerCLIForeman::Command
+    resource :ansible_inventories
+
+    class HostsCommand < HammerCLIForeman::Command
+      action :hosts
+      command_name 'hosts'
+      option '--as-json', :flag, _('Full response as json')
+
+      def print_data(data)
+        return super unless option_as_json?
+
+        puts JSON.pretty_generate(data)
+      end
+      build_options
+
+      extend_with(HammerCLIForemanAnsible::CommandExtensions::Inventory.new)
+    end
+
+    class HostgroupsCommand < HammerCLIForeman::Command
+      action :hostgroups
+      command_name 'hostgroups'
+      option '--as-json', :flag, _('Full response as json')
+
+      def print_data(data)
+        return super unless option_as_json?
+
+        puts JSON.pretty_generate(data)
+      end
+      build_options
+
+      extend_with(HammerCLIForemanAnsible::CommandExtensions::Inventory.new)
+    end
+
+    class ScheduleCommand < HammerCLIForeman::Command
+      action :schedule
+      command_name 'schedule'
+
+      output do
+        field :job_id, _('Job Id')
+        field :data_url, _('Data URL')
+      end
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+end
+

data/lib/hammer_cli_foreman_ansible/associated_ansible_role.rb

@@ -0,0 +1,85 @@
+module HammerCLIForemanAnsible
+  module AssociatedAnsibleRole
+    # This method fetches all associated resource (ansible roles) ids
+    # to send them back via :update endpoint of the main resource (host/hostgroup)
+    # We use this array of ids to add or remove direct associations
+    # This method is used to 'reset' associated ids via HammerCLIForeman::[Add|Remove]AssociatedCommand
+    def get_current_ids
+      roles = HammerCLIForeman.record_to_common_format(resource.call(association_name(true), { id: get_identifier }))
+      return ids_to_keep_for_removal(roles) if self.class.command_names.include?('remove')
+
+      ids_to_keep_for_addition(roles)
+    end
+
+    # Since there are no option_sources available to deal with such cases (AssociatedCommand)
+    # Make sure we get id of the provided role before we try to get already associated ones
+    def get_new_ids
+      associated_identifiers = get_associated_identifiers
+      @associated_identifier = get_associated_identifier
+
+      ids = get_current_ids.map(&:to_s)
+
+      required_ids = associated_identifiers.nil? ? [] : associated_identifiers.map(&:to_s)
+      required_ids << @associated_identifier.to_s unless @associated_identifier.nil?
+
+      ids = if self.class.command_names.include?('remove')
+              ids.delete_if { |id| required_ids.include? id }
+            else
+              ids + required_ids
+            end
+      ids.uniq
+    end
+
+    private
+
+    # Treat inherited as we do in UI:
+    # - Don't allow to directly associate them (the role is not available to select)
+    # - If the same role was assigned AND inherited then treat it as it was just assigned (keep it)
+    # - If the role is indirectly associated only then don't associate it directly unless --force provided
+    def ids_to_keep_for_addition(roles)
+      roles.map do |role|
+        # Keep directly associated roles
+        next role['id'] if role['directly_assigned']
+
+        # Host groups can have not inherited and not directly assigned roles in the response.
+        # This means those roles are from hosts, skip them.
+        # Hosts cannot have such case.
+
+        # Pre-check to force stop the command if we're trying to add an already inherited role
+        # (in case we don't have it directly associated as well)
+        if @associated_identifier == role['id'] && role['inherited']
+          next role['id'] if option_force?
+
+          msg = _(
+            'Ansible role %{name} is already inherited from a host group. Please use %{option} for direct association.'
+          ) % { name: role['name'], option: '--force' }
+          raise ArgumentError, msg
+        end
+
+        # We skip not directly assigned and inherited
+        # Also skip not inherited for host groups
+        nil
+      end.compact
+    end
+
+    # Treat inherited as we do in UI:
+    # - Don't allow to remove them (the role is not available to select)
+    # - If the same role was assigned AND inherited then treat it as it was just assigned (keep or remove it)
+    # - If the role was inherited only then don't remove it
+    def ids_to_keep_for_removal(roles)
+      roles.map do |role|
+        # Keep or remove later directly associated roles
+        next role['id'] if role['directly_assigned']
+
+        # Pre-check to force stop the command if we're trying to remove not directly assigned role
+        if role['id'] == @associated_identifier
+          raise ArgumentError, _('Ansible role %s is not assigned directly and cannot be removed.') % role['name']
+        end
+
+        # We skip not directly assigned and inherited
+        # Also skip not inherited for host groups
+        nil
+      end.compact
+    end
+  end
+end

data/lib/hammer_cli_foreman_ansible/command_extensions/inventory.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module HammerCLIForemanAnsible
+  module CommandExtensions
+    class Inventory < HammerCLI::CommandExtensions
+      output do |definition|
+        definition.append do
+          from 'foreman' do
+            field :hostname, _('Name')
+            field :fqdn, _('FQDN')
+            field :hostgroup, _('Host Group')
+            field :location, _('Location')
+            field :organization, _('Organization')
+            field :domainname, _('Domain')
+            field :foreman_domain_description, _('Foreman domain description')
+            field :owner_name, _('Owner name')
+            field :owner_email, _('Owner email')
+            field :ssh_authorized_keys, _('SSH authorized keys')
+            field :root_pw, _('Root password')
+            field :foreman_config_groups, _('Foreman config groups')
+            field :puppetmaster, _('Puppet master')
+            field :foreman_env, _('Puppet environment')
+
+            collection :foreman_subnets, _('Subnets') do
+              field :name, _('Name')
+              field :network, _('Network')
+              field :mask, _('Mask')
+              field :gateway, _('Gateway')
+              field :dns_primary, _('Primary DNS')
+              field :dns_secondary, _('Secondary DNS')
+              field :from, _('From')
+              field :to, _('To')
+              field :boot_mode, _('Boot mode')
+              field :ipam, _('IPAM')
+              field :vlanid, _('VLAN ID')
+              field :mtu, _('MTU')
+              field :nic_delay, _('NIC delay')
+              field :network_type, _('Network type')
+              field :description, _('Description')
+            end
+
+            collection :foreman_interfaces, _('Network interfaces') do
+              field :name, _('Interface Name')
+              field :identifier, _('Identifier')
+              field :attrs,  _('Attributes'),Fields::Field, hide_blank: true
+              field :mac, _('MAC address')
+              field :ip, _('IPv4 address'), Fields::Field, hide_blank: true
+              field :ip6, _('IPv6 address'), Fields::Field, hide_blank: true
+              field :virtual, _('Virtual'), Fields::Boolean
+              field :link, _('Link'), Fields::Boolean
+              field :managed, _('Managed'), Fields::Boolean
+              field :primary, _('Primary'), Fields::Boolean
+              field :provision, _('Provision'), Fields::Boolean
+              field :subnet6, _('IPv6 subnet')
+              field :tag, _('Tag')
+              field :attached_to, _('Attached to')
+              field :type, _('Type')
+              field :attached_devices, _('Attached devices')
+              from 'subnet' do
+                label _('Subnet'), hide_blank: true do
+                  field :name, _('Name')
+                  field :network, _('Network')
+                  field :mask, _('Mask')
+                  field :gateway, _('Gateway')
+                  field :dns_primary, _('Primary DNS')
+                  field :dns_secondary, _('Secondary DNS')
+                  field :from, _('From')
+                  field :to, _('To')
+                  field :boot_mode, _('Boot mode')
+                  field :ipam, _('IPAM')
+                  field :vlanid, _('VLAN ID')
+                  field :mtu, _('MTU')
+                  field :nic_delay, _('NIC delay')
+                  field :network_type, _('Network type')
+                  field :description, _('Description')
+                end
+              end
+            end
+
+            collection :foreman_users, _('Foreman Users'), numbered: false do
+              field :firstname, _('First name')
+              field :lastname, _('Last name')
+              field :mail, _('Email')
+              field :description, _('Description')
+              field :fullname, _('Full name')
+              field :ssh_authorized_keys, _('SSH authorized keys')
+            end
+          end
+
+          collection :foreman_ansible_roles, _('Foreman Ansible Roles'), numbered: false do
+            field :name, _('Role')
+          end
+
+          field :ansible_roles_check_mode, _('Ansible role check mode'), Fields::Boolean
+          field :host_packages, _('Host packages')
+          field :host_registration_insights, _('Host registration insights'), Fields::Boolean
+          field :host_registration_remote_execution, _('Host registration remote execution'), Fields::Boolean
+          field :remote_execution_ssh_keys, _('Remote execution ssh keys')
+          field :remote_execution_ssh_user, _('Remote execution ssh user')
+          field :remote_execution_effective_user_method, _('Remote execution effective user method')
+          field :remote_execution_connect_by_ip, _('Remote execution connect by IP'), Fields::Boolean
+        end
+      end
+
+      before_print do |data, cmd_obj|
+        unless cmd_obj.option_as_json?
+          new_data = data['all']['hosts'].each_with_object([]) do |hostname, arr|
+            data['_meta']['hostvars'][hostname]['foreman']['foreman_users'] = data['_meta']['hostvars'][hostname]['foreman']['foreman_users']&.map { |u| u[1] }
+            data['_meta']['hostvars'][hostname]['foreman_ansible_roles'] =  data['_meta']['hostvars'][hostname]['foreman_ansible_roles']&.map { |r| { 'name' => r } }
+            arr << {
+              'hostname' => hostname
+            }.merge(data['_meta']['hostvars'][hostname])
+          end
+          data.clear
+          data['results'] = new_data
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_ansible/command_extensions/job_template.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module HammerCLIForemanAnsible
+  module CommandExtensions
+    class JobTemplate < HammerCLI::CommandExtensions
+      before_print do |data|
+        unless data['provider_type'] == 'Ansible'
+          data.delete('ansible_callback_enabled')
+        end
+      end
+
+      output do |definition|
+        definition.insert(:before, :description) do
+          field :ansible_callback_enabled, _('Ansible Callback Enabled'), Fields::Boolean
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_ansible/command_extensions.rb

@@ -1 +1,3 @@
 require 'hammer_cli_foreman_ansible/command_extensions/resolver'
+require 'hammer_cli_foreman_ansible/command_extensions/inventory'
+require 'hammer_cli_foreman_ansible/command_extensions/job_template'

data/lib/hammer_cli_foreman_ansible/host.rb

@@ -11,7 +11,10 @@ module HammerCLIForemanAnsible
       class ListCommand < HammerCLIForeman::ListCommand
         action :ansible_roles
 
-        output HammerCLIForemanAnsible::AnsibleRolesCommand::ListCommand.output_definition
+        output(HammerCLIForemanAnsible::AnsibleRolesCommand::ListCommand.output_definition) do
+          field :inherited, _('Inherited'), Fields::Boolean
+          field :directly_assigned, _('Directly assigned'), Fields::Boolean
+        end
 
         build_options
       end
@@ -35,6 +38,45 @@ module HammerCLIForemanAnsible
 
         build_options
       end
+
+      class AddAnsibleRoleCommand < HammerCLIForeman::AddAssociatedCommand
+        prepend HammerCLIForemanAnsible::AssociatedAnsibleRole
+
+        command_name 'add'
+        associated_resource :ansible_roles
+        desc _('Associate an Ansible role')
+
+        option '--force', :flag, _('Associate the Ansible role even if it already is associated indirectly')
+
+        success_message _('Ansible role has been associated.')
+        failure_message _('Could not associate the Ansible role')
+
+        validate_options do
+          any(:option_name, :option_id).required
+          any(:option_ansible_role_name, :option_ansible_role_id).required
+        end
+
+        build_options
+      end
+
+      class RemoveAnsibleRoleCommand < HammerCLIForeman::RemoveAssociatedCommand
+        prepend HammerCLIForemanAnsible::AssociatedAnsibleRole
+
+        command_name 'remove'
+        associated_resource :ansible_roles
+        desc _('Disassociate an Ansible role')
+
+        success_message _('Ansible role has been disassociated.')
+        failure_message _('Could not disassociate the Ansible role')
+
+        validate_options do
+          any(:option_name, :option_id).required
+          any(:option_ansible_role_name, :option_ansible_role_id).required
+        end
+
+        build_options
+      end
+
       autoload_subcommands
     end
   end

data/lib/hammer_cli_foreman_ansible/hostgroup.rb

@@ -11,7 +11,10 @@ module HammerCLIForemanAnsible
       class ListCommand < HammerCLIForeman::ListCommand
         action :ansible_roles
 
-        output HammerCLIForemanAnsible::AnsibleRolesCommand::ListCommand.output_definition
+        output(HammerCLIForemanAnsible::AnsibleRolesCommand::ListCommand.output_definition) do
+          field :inherited, _('Inherited'), Fields::Boolean
+          field :directly_assigned, _('Directly assigned'), Fields::Boolean
+        end
 
         build_options
       end
@@ -36,6 +39,44 @@ module HammerCLIForemanAnsible
         build_options
       end
 
+      class AddAnsibleRoleCommand < HammerCLIForeman::AddAssociatedCommand
+        prepend HammerCLIForemanAnsible::AssociatedAnsibleRole
+
+        command_name 'add'
+        associated_resource :ansible_roles
+        desc _('Associate an Ansible role')
+
+        option '--force', :flag, _('Associate the Ansible role even if it already is associated indirectly')
+
+        success_message _('Ansible role has been associated.')
+        failure_message _('Could not associate the Ansible role')
+
+        validate_options do
+          any(:option_name, :option_title, :option_id).required
+          any(:option_ansible_role_name, :option_ansible_role_id).required
+        end
+
+        build_options
+      end
+
+      class RemoveAnsibleRoleCommand < HammerCLIForeman::RemoveAssociatedCommand
+        prepend HammerCLIForemanAnsible::AssociatedAnsibleRole
+
+        command_name 'remove'
+        associated_resource :ansible_roles
+        desc _('Disassociate an Ansible role')
+
+        success_message _('Ansible role has been disassociated.')
+        failure_message _('Could not disassociate the Ansible role')
+
+        validate_options do
+          any(:option_name, :option_title, :option_id).required
+          any(:option_ansible_role_name, :option_ansible_role_id).required
+        end
+
+        build_options
+      end
+
       autoload_subcommands
     end
   end

data/lib/hammer_cli_foreman_ansible/version.rb

@@ -2,6 +2,6 @@
 
 module HammerCLIForemanAnsible
   def self.version
-    @version ||= Gem::Version.new '0.3.4'
+    @version ||= Gem::Version.new '0.5.0'
   end
 end

data/lib/hammer_cli_foreman_ansible.rb

@@ -3,16 +3,20 @@ module HammerCLIForemanAnsible
   require 'hammer_cli_foreman'
   require 'hammer_cli_foreman/host'
   require 'hammer_cli_foreman/hostgroup'
+  require 'hammer_cli_foreman_remote_execution'
 
   require 'hammer_cli_foreman_ansible/version'
   require 'hammer_cli_foreman_ansible/i18n'
   require 'hammer_cli_foreman_ansible/ansible'
   require 'hammer_cli_foreman_ansible/ansible_roles'
+  require 'hammer_cli_foreman_ansible/associated_ansible_role'
   require 'hammer_cli_foreman_ansible/host'
   require 'hammer_cli_foreman_ansible/hostgroup'
 
   require 'hammer_cli_foreman_ansible/command_extensions'
 
+  HammerCLIForemanRemoteExecution::JobTemplate::InfoCommand.extend_with(HammerCLIForemanAnsible::CommandExtensions::JobTemplate.new)
+
   HammerCLI::MainCommand.lazy_subcommand(
     'ansible',
     'Manage foreman ansible',