hammer_cli_foreman_ansible 0.1.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 711d672a9da9e9f53bbf6b0d80160b768227ac25
-  data.tar.gz: 99c0f69340edf77b5652a2e9713e7fadc2616b3b
+SHA256:
+  metadata.gz: a63fcefc58731191aed327d9be1c107b16345f2428f825e339f41ee7cb8a4a5d
+  data.tar.gz: 6c9ce07e90583511bbe55a51273393b2b0e82a46ec7595ddf00bc106b52f3dd8
 SHA512:
-  metadata.gz: 393c2f267071a0c52292c1e97364516ef959f961bbece4f3f6fe6299025de5c241082c16b3bed423e6c9ec8dca0e9fefc07577bae38fde6b417cd87c2fc7c982
-  data.tar.gz: b70e4e201aaf651e0aafedadb85a2b2191f50aad5ae3e13089a7fb06216ceb8f926519a5ef9099833e05739279e623154b64bdcd29148070a2c58f6eaa88387e
+  metadata.gz: 7d37d4b6c5490fb66e0d62802f360286d9f0940ac0d26cb099fb065783305365fee3ec7e328d0e973b7366d04d746e0a6f488255ad4d7f1e3f9a1c5afdb2e9cb
+  data.tar.gz: 32c611d308d8d459d6940f5688f41581cccb59823044793366fe07361d04bcb459d24958f85a3fe2da63985b32246e8673c252fc295820a8156ead4031814aad

data/README.md

@@ -1,6 +1,16 @@
 # Hammer CLI Foreman Ansible
 
-[Foreman Ansible](https://github.com/theforeman/foreman_ansible) plugin for Hammer CLI
+This Hammer CLI plugin contains set of commands for [foreman_ansible](
+  https://github.com/theforeman/foreman_ansible
+), a plugin to Foreman for Ansible.
+
+## Versions
+
+This is the list of which version of Foreman Ansible is needed to which version of this plugin.
+
+| hammer_cli_foreman_ansible | 0.1.0+ | 0.2.0+ | 0.3.0+ |
+|----------------------------|--------|--------|--------|
+|            foreman_ansible | 2.2.0+ | 2.3.2+ | 2.3.3+ |
 
 ## Installation
 
@@ -15,3 +25,8 @@
 
     # to confirm things work, this should return useful output
     hammer ansible --help
+
+## More info
+
+See our [Hammer CLI installation and configuration instuctions](
+https://github.com/theforeman/hammer-cli/blob/master/doc/installation.md#installation).

data/lib/hammer_cli_foreman_ansible.rb

@@ -7,11 +7,12 @@ module HammerCLIForemanAnsible
   require 'hammer_cli_foreman_ansible/version'
   require 'hammer_cli_foreman_ansible/i18n'
   require 'hammer_cli_foreman_ansible/ansible'
-  require 'hammer_cli_foreman_ansible/base'
   require 'hammer_cli_foreman_ansible/ansible_roles'
   require 'hammer_cli_foreman_ansible/host'
   require 'hammer_cli_foreman_ansible/hostgroup'
 
+  require 'hammer_cli_foreman_ansible/command_extensions'
+
   HammerCLI::MainCommand.lazy_subcommand(
     'ansible',
     'Manage foreman ansible',
@@ -19,15 +20,15 @@ module HammerCLIForemanAnsible
     'hammer_cli_foreman_ansible/ansible'
   )
   HammerCLIForeman::Host.lazy_subcommand(
-    HostAnsibleRolesCommand.command_name,
-    HostAnsibleRolesCommand.desc,
-    'HammerCLIForemanAnsible::HostAnsibleRolesCommand',
+    Host::AnsibleRolesCommand.command_name,
+    Host::AnsibleRolesCommand.desc,
+    'HammerCLIForemanAnsible::Host::AnsibleRolesCommand',
     'hammer_cli_foreman_ansible/host'
   )
   HammerCLIForeman::Hostgroup.lazy_subcommand(
-    HostgroupAnsibleRolesCommand.command_name,
-    HostgroupAnsibleRolesCommand.desc,
-    'HammerCLIForemanAnsible::HostgroupAnsibleRolesCommand',
+    Hostgroup::AnsibleRolesCommand.command_name,
+    Hostgroup::AnsibleRolesCommand.desc,
+    'HammerCLIForemanAnsible::Hostgroup::AnsibleRolesCommand',
     'hammer_cli_foreman_ansible/hostgroup'
   )
 end

data/lib/hammer_cli_foreman_ansible/ansible.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanAnsible
   class AnsibleCommand < HammerCLI::AbstractCommand
-
     lazy_subcommand(
       'roles',
       _('Manage ansible roles'),

data/lib/hammer_cli_foreman_ansible/ansible_roles.rb

@@ -1,14 +1,20 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanAnsible
   class AnsibleRolesCommand < HammerCLIForeman::Command
     resource :ansible_roles
 
-    class InfoCommand < HammerCLIForeman::InfoCommand
-      output BaseAnsibleRolesCommand.output_definition
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+        field :created_at, _('Imported at'), Fields::Date
+      end
       build_options
     end
 
-    class ListCommand < HammerCLIForeman::ListCommand
-      output AnsibleRolesCommand::InfoCommand.output_definition
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output AnsibleRolesCommand::ListCommand.output_definition
       build_options
     end
 
@@ -19,7 +25,19 @@ module HammerCLIForemanAnsible
       build_options
     end
 
-    class ChangedCommand < HammerCLIForeman::Command
+    class ImportCommand < HammerCLIForeman::Command
+      action :import
+      command_name 'import'
+
+      failure_message _('Could not import roles')
+
+      output do
+        field :message, _('Result'), Fields::LongText
+        collection :changed, _('Imported'), hide_blank: true do
+          field :name, nil
+        end
+      end
+
       def execute
         response = {}
         response['changed'] = send_request
@@ -30,33 +48,45 @@ module HammerCLIForemanAnsible
         print_data(response)
         HammerCLI::EX_OK
       end
+
+      build_options
     end
 
-    class ImportCommand < ChangedCommand
-      action :import
-      command_name 'import'
+    class ObsoleteCommand < HammerCLIForeman::Command
+      action :obsolete
+      command_name 'obsolete'
 
-      failure_message _('Could not import roles')
+      failure_message _('Could not obsolete roles')
 
       output do
         field :message, _('Result'), Fields::LongText
-        collection :changed, _('Imported'), hide_blank: true do
+        collection :changed, _('Obsoleted'), hide_blank: true do
           field :name, nil
         end
       end
 
+      def execute
+        response = {}
+        response['changed'] = send_request
+        response['message'] = _('The following ansible roles were changed')
+        if response['changed'].empty?
+          response['message'] = _('No changes in ansible roles detected.')
+        end
+        print_data(response)
+        HammerCLI::EX_OK
+      end
+
       build_options
     end
 
-    class ObsoleteCommand < ChangedCommand
-      action :obsolete
-      command_name 'obsolete'
+    class FetchCommand < HammerCLIForeman::Command
+      action :fetch
+      command_name 'fetch'
 
-      failure_message _('Could not obsolete roles')
+      failure_message _('Could not fetch roles')
 
       output do
-        field :message, _('Result'), Fields::LongText
-        collection :changed, _('Obsoleted'), hide_blank: true do
+        collection :ansible_roles, _('Ansible roles available to be imported') do
           field :name, nil
         end
       end
@@ -64,6 +94,28 @@ module HammerCLIForemanAnsible
       build_options
     end
 
+    class PlayHostsCommand < HammerCLIForeman::Command
+      resource :hosts
+      action :multiple_play_roles
+      command_name 'play-hosts'
+
+      success_message _("Ansible roles are being played. Job ID: %{id}")
+      failure_message _('Could not play roles on hosts')
+
+      build_options
+    end
+
+    class PlayHostgroupsCommand < HammerCLIForeman::Command
+      resource :hostgroups
+      action :multiple_play_roles
+      command_name 'play-hostgroups'
+
+      success_message _("Ansible roles are being played. Job ID: %{id}")
+      failure_message _('Could not play roles on hostgroups')
+
+      build_options
+    end
+
     autoload_subcommands
   end
 end

data/lib/hammer_cli_foreman_ansible/ansible_variables.rb

@@ -1,9 +1,21 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanAnsible
   class AnsibleVariablesCommand < HammerCLIForeman::Command
     resource :ansible_variables
 
     class ListCommand < HammerCLIForeman::ListCommand
-      output BaseAnsibleVariablesCommand.output_definition
+      output do
+        field :id, _('Id')
+
+        field :variable, _('Variable')
+        field :default_value, _('Default Value')
+        field :variable_type, _('Type')
+
+        field :ansible_role, _('Role')
+        field :ansible_role_id, _('Role Id'), Fields::Id
+      end
+
       build_options
     end
 
@@ -17,6 +29,7 @@ module HammerCLIForemanAnsible
           field :validator_rule, _("Rule")
         end
         label _("Override values") do
+          field :override, _("Override"), Fields::Boolean
           field :merge_overrides, _("Merge overrides"), Fields::Boolean
           field :merge_default, _("Merge default value"), Fields::Boolean
           field :avoid_duplicates, _("Avoid duplicates"), Fields::Boolean
@@ -33,6 +46,13 @@ module HammerCLIForemanAnsible
       build_options
     end
 
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      success_message _("Ansible variable [%{variable}] was created.")
+      failure_message _("Could not create the ansible variable")
+
+      build_options
+    end
+
     class DeleteCommand < HammerCLIForeman::DeleteCommand
       success_message _('Ansible variable [%{variable}] was deleted.')
       failure_message _('Could not delete the variable')
@@ -47,20 +67,7 @@ module HammerCLIForemanAnsible
       build_options
     end
 
-    class ChangedCommand < HammerCLIForeman::Command
-      def execute
-        response = {}
-        response['changed'] = send_request
-        response['message'] = _('The following ansible variables were changed')
-        if response['changed'].empty?
-          response['message'] = _('No changes in ansible variables detected.')
-        end
-        print_data(response)
-        HammerCLI::EX_OK
-      end
-    end
-
-    class ImportCommand < ChangedCommand
+    class ImportCommand < HammerCLIForeman::Command
       action :import
       command_name 'import'
 
@@ -73,10 +80,21 @@ module HammerCLIForemanAnsible
         end
       end
 
+      def execute
+        response = {}
+        response['changed'] = send_request
+        response['message'] = _('The following ansible variables were changed')
+        if response['changed'].empty?
+          response['message'] = _('No changes in ansible variables detected.')
+        end
+        print_data(response)
+        HammerCLI::EX_OK
+      end
+
       build_options
     end
 
-    class ObsoleteCommand < ChangedCommand
+    class ObsoleteCommand < HammerCLIForeman::Command
       action :obsolete
       command_name 'obsolete'
 
@@ -89,6 +107,17 @@ module HammerCLIForemanAnsible
         end
       end
 
+      def execute
+        response = {}
+        response['changed'] = send_request
+        response['message'] = _('The following ansible variables were changed')
+        if response['changed'].empty?
+          response['message'] = _('No changes in ansible variables detected.')
+        end
+        print_data(response)
+        HammerCLI::EX_OK
+      end
+
       build_options
     end
 

data/lib/hammer_cli_foreman_ansible/command_extensions.rb

@@ -0,0 +1 @@
+require 'hammer_cli_foreman_ansible/command_extensions/resolver'

data/lib/hammer_cli_foreman_ansible/command_extensions/resolver.rb

@@ -0,0 +1,15 @@
+module HammerCLIForemanAnsible
+  module ResolverExtension
+    def create_ansible_roles_search_options(options, mode = nil)
+      if defined? HammerCLIKatello::IdResolver
+        create_search_options_without_katello_api(options, api.resource(:ansible_roles), mode)
+      else
+        create_search_options(options, api.resource(:ansible_roles), mode)
+      end
+    end
+  end
+
+  ::HammerCLIForeman::IdResolver.instance_eval do
+    include ResolverExtension
+  end
+end

data/lib/hammer_cli_foreman_ansible/host.rb

@@ -1,6 +1,41 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanAnsible
-  class HostAnsibleRolesCommand < BaseAnsibleRolesCommand
+  class Host < HammerCLIForeman::Command
     resource :hosts
-    build_options
+
+    class AnsibleRolesCommand < HammerCLIForeman::Command
+      command_name 'ansible-roles'
+      desc _('Manage Ansible roles on a host')
+
+      class ListCommand < HammerCLIForeman::ListCommand
+        action :ansible_roles
+
+        output HammerCLIForemanAnsible::AnsibleRolesCommand::ListCommand.output_definition
+
+        build_options
+      end
+
+      class PlayCommand < HammerCLIForeman::Command
+        command_name 'play'
+        action :play_roles
+
+        success_message _('Ansible roles are being played. Job ID: %{id}')
+        failure_message _('Could not play roles on a host')
+
+        build_options
+      end
+
+      class AssignRolesCommand < HammerCLIForeman::Command
+        command_name 'assign'
+        action :assign_ansible_roles
+
+        success_message _('Ansible roles were assigned to the host')
+        failure_message _('Could not assign roles to the host')
+
+        build_options
+      end
+      autoload_subcommands
+    end
   end
 end

data/lib/hammer_cli_foreman_ansible/hostgroup.rb

@@ -1,6 +1,42 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanAnsible
-  class HostgroupAnsibleRolesCommand < BaseAnsibleRolesCommand
+  class Hostgroup < HammerCLIForeman::Command
     resource :hostgroups
-    build_options
+
+    class AnsibleRolesCommand < HammerCLIForeman::Command
+      command_name 'ansible-roles'
+      desc _('Manage Ansible roles on a hostgroup')
+
+      class ListCommand < HammerCLIForeman::ListCommand
+        action :ansible_roles
+
+        output HammerCLIForemanAnsible::AnsibleRolesCommand::ListCommand.output_definition
+
+        build_options
+      end
+
+      class PlayCommand < HammerCLIForeman::Command
+        command_name 'play'
+        action :play_roles
+
+        success_message _('Ansible roles are being played. Job ID: %{id}')
+        failure_message _('Could not play roles on a hostgroup')
+
+        build_options
+      end
+
+      class AssignRolesCommand < HammerCLIForeman::Command
+        command_name 'assign'
+        action :assign_ansible_roles
+
+        success_message _('Ansible roles were assigned to the hostgroup')
+        failure_message _('Could not assign roles to the hostgroup')
+
+        build_options
+      end
+
+      autoload_subcommands
+    end
   end
 end

data/lib/hammer_cli_foreman_ansible/i18n.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'hammer_cli/i18n'
 
 module HammerCLIForemanAnsible

data/lib/hammer_cli_foreman_ansible/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanAnsible
   def self.version
-    @version ||= Gem::Version.new '0.1.2'
+    @version ||= Gem::Version.new '0.3.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli_foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Oleh Fedorenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hammer_cli_foreman
@@ -80,7 +80,8 @@ files:
 - lib/hammer_cli_foreman_ansible/ansible.rb
 - lib/hammer_cli_foreman_ansible/ansible_roles.rb
 - lib/hammer_cli_foreman_ansible/ansible_variables.rb
-- lib/hammer_cli_foreman_ansible/base.rb
+- lib/hammer_cli_foreman_ansible/command_extensions.rb
+- lib/hammer_cli_foreman_ansible/command_extensions/resolver.rb
 - lib/hammer_cli_foreman_ansible/host.rb
 - lib/hammer_cli_foreman_ansible/hostgroup.rb
 - lib/hammer_cli_foreman_ansible/i18n.rb
@@ -105,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Foreman Ansible plugin for Hammer CLI

data/lib/hammer_cli_foreman_ansible/base.rb

@@ -1,40 +0,0 @@
-module HammerCLIForemanAnsible
-  class BaseAnsibleRolesCommand < HammerCLIForeman::Command
-    command_name 'ansible-roles'
-    desc _('List all Ansible roles')
-
-    action :ansible_roles
-
-    output do
-      field :id, _('Id')
-      field :name, _('Name')
-      field :created_at, _('Imported at'), Fields::Date
-    end
-
-    def adapter
-      :table
-    end
-  end
-
-  class BaseAnsibleVariablesCommand < HammerCLIForeman::Command
-    command_name 'ansible-variables'
-    desc _('List all Ansible variables')
-
-    action :ansible_variables
-
-    output do
-      field :id, _('Id')
-
-      field :variable, _('Variable')
-      field :default_value, _('Default Value')
-      field :variable_type, _('Type')
-
-      field :ansible_role, _('Role')
-      field :ansible_role_id, _('Role Id'), Fields::Id
-    end
-
-    def adapter
-      :table
-    end
-  end
-end