hammer_cli_foreman 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4664c32a15e81c3db327542d918d9eaebf516e11
-  data.tar.gz: 324c167ab2dba9419c86d16bec1b59ab313df949
+  metadata.gz: a6d49542beab521eda5d1780bf6effc51714df49
+  data.tar.gz: c8e9298892d68c30f192251b2beea23fe7ce53d6
 SHA512:
-  metadata.gz: d5b642b1ba7581539d667ac94de9ed9cc27daaa194d4d26e5101b0983dba77ab3d184e628359d8b32c2e90b72b4c66624a322ce02dab081a01bb3fde6397e703
-  data.tar.gz: 62f07b9d348b8ec921380b17b900a26622dff382733ce28d1d52908a684bd303f40b9617a9f46b4681286482ce5840ac5dbfca1f15b9a387e905d70de8d4c045
+  metadata.gz: f5335b895f5de74ccf6ad621cfea4e6e405ed8185e5f01c1c1755230332157018880b46f5d1f5ec022ba3474e4fccbf2469312b7f0c44a6db2025613412a7dcb
+  data.tar.gz: 01ba227af3fb1b4d11e242b373e0b6df484eeace5b37360b2a76ad487489c0178cba9fa385b8fe78f8b89d009c3921abddd51791f06969018ef16ac47da2b8cc

data/README.md

@@ -1,12 +1,14 @@
 Foreman commands for Hammer CLI
 ===============================
 
-This Hammer CLI plugin contains set of commands for [Foreman](http://theforeman.org/).
+This [Hammer CLI](https://github.com/theforeman/hammer-cli) plugin contains
+set of commands for [Foreman](http://theforeman.org/).
 
 
 Documentation
 -------------
 
+ - [Configuration](doc/configuration.md#configuration)
  - [Host creation](doc/host_create.md#host-creation)
 
 How to run
@@ -16,6 +18,15 @@ The work is still in progress and there are no builds ready yet. You can install
 See [Hammer CLI readme](https://github.com/theforeman/hammer-cli/blob/master/README.md#how-to-run) for details.
 
 
+Having issues?
+--------------
+
+If one of hammer commands doesn't work as you would expect, you can run `hammer -d ...` to get
+full debug output from the loggers. It should give you an idea what went wrong.
+
+If you have questions, don't hesitate to contact us on `foreman-users@googlegroups.com` or
+`FreeNode#foreman` irc channel.
+
 How to test
 ------------
 

data/doc/configuration.md

@@ -0,0 +1,13 @@
+Configuration
+=============
+
+Configuration is expected to be placed in one of hammer's configuration directories for plugins:
+- `/etc/hammer/cli.modules.d/`
+- `~/.hammer/cli.modules.d/`
+- `./.config/cli.modules.d/` (config dir in CWD)
+
+If you install `hammer_cli_foreman` from source you'll have to copy the config file manually
+from `config/foreman.yml`.
+
+See our [sample config file](https://github.com/theforeman/hammer-cli-foreman/blob/master/config/foreman.yml)
+that lists all available configuration options with descriptions.

data/lib/hammer_cli_foreman.rb

@@ -14,10 +14,13 @@ module HammerCLIForeman
   require 'hammer_cli_foreman/output'
   require 'hammer_cli_foreman/credentials'
   require 'hammer_cli_foreman/exception_handler'
+  require 'hammer_cli_foreman/searchables_option_builder'
+  require 'hammer_cli_foreman/id_resolver'
 
   begin
     require 'hammer_cli_foreman/commands'
     require 'hammer_cli_foreman/associating_commands'
+    require 'hammer_cli_foreman/references'
     require 'hammer_cli_foreman/parameter'
     require 'hammer_cli_foreman/common_parameter'
 

data/lib/hammer_cli_foreman/architecture.rb

@@ -11,19 +11,19 @@ module HammerCLIForeman
         field :name, _("Name")
       end
 
-      apipie_options
+      build_options
     end
 
 
     class InfoCommand < HammerCLIForeman::InfoCommand
 
       output ListCommand.output_definition do
-        field :operatingsystem_ids, _("OS ids"), Fields::List
-        field :created_at, _("Created at"), Fields::Date
-        field :updated_at, _("Updated at"), Fields::Date
+        HammerCLIForeman::References.operating_systems(self)
+        HammerCLIForeman::References.taxonomies(self)
+        HammerCLIForeman::References.timestamps(self)
       end
 
-      apipie_options
+      build_options
     end
 
 
@@ -31,7 +31,7 @@ module HammerCLIForeman
       success_message _("Architecture created")
       failure_message _("Could not create the architecture")
 
-      apipie_options
+      build_options
     end
 
 
@@ -39,7 +39,7 @@ module HammerCLIForeman
       success_message _("Architecture deleted")
       failure_message _("Could not delete the architecture")
 
-      apipie_options
+      build_options
     end
 
 
@@ -47,10 +47,10 @@ module HammerCLIForeman
       success_message _("Architecture updated")
       failure_message _("Could not update the architecture")
 
-      apipie_options
+      build_options
     end
 
-    include HammerCLIForeman::AssociatingCommands::OperatingSystem
+    HammerCLIForeman::AssociatingCommands::OperatingSystem.extend_command(self)
 
     autoload_subcommands
   end

data/lib/hammer_cli_foreman/associating_commands.rb

@@ -1,82 +1,114 @@
 module HammerCLIForeman
   module AssociatingCommands
 
+    module CommandExtension
+
+      def extend_command(base_command)
+        commands = self.constants.map {|c| self.const_get(c)}.select {|c| c < HammerCLI::AbstractCommand }
+
+        commands.each do |cmd|
+          plug_command(cmd, base_command)
+        end
+      end
+
+      def plug_command(command, base_command)
+        cmd_name = base_name(command)
+        base_name = base_name(base_command)
+
+        name = base_name + cmd_name
+
+        cmd_cls = Class.new(command)
+        base_command.const_set(name, cmd_cls)
+
+        cmd_cls.resource(base_command.resource.name)
+        #TODO: update messages to inherit from parents
+        cmd_cls.success_message(command.success_message)
+        cmd_cls.failure_message(command.failure_message)
+        cmd_cls.build_options
+      end
+
+      def base_name(cls)
+        cls.name.split("::")[-1]
+      end
+    end
+
     module Hostgroup
+      extend CommandExtension
+
       class AddHostgroupCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :hostgroups
-        apipie_options
       end
 
       class RemoveHostgroupCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :hostgroups
-        apipie_options
       end
     end
 
     module Environment
+      extend CommandExtension
+
       class AddEnvironmentCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :environments
-        apipie_options
       end
 
       class RemoveEnvironmentCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :environments
-        apipie_options
       end
     end
 
     module Domain
+      extend CommandExtension
+
       class AddDomainCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :domains
-        apipie_options
       end
 
       class RemoveDomainCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :domains
-        apipie_options
       end
     end
 
     module Medium
+      extend CommandExtension
+
       class AddMediumCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :media
-        apipie_options
       end
 
       class RemoveMediumCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :media
-        apipie_options
       end
     end
 
     module Subnet
+      extend CommandExtension
+
       class AddSubnetCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :subnets
-        apipie_options
       end
 
       class RemoveSubnetCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :subnets
-        apipie_options
       end
     end
 
     module ComputeResource
+      extend CommandExtension
+
       class AddComputeResourceCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :compute_resources
-        apipie_options
       end
 
       class RemoveComputeResourceCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :compute_resources
-        apipie_options
       end
     end
 
     module SmartProxy
+      extend CommandExtension
+
       class AddSmartProxyCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :smart_proxies
-        apipie_options
 
         def associated_resource_name
           "smart-proxy"
@@ -85,7 +117,6 @@ module HammerCLIForeman
 
       class RemoveSmartProxyCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :smart_proxies
-        apipie_options
 
         def associated_resource_name
           "smart-proxy"
@@ -94,21 +125,17 @@ module HammerCLIForeman
     end
 
     module User
-      class AddUserCommand < HammerCLIForeman::AddAssociatedCommand
-        associated_identifiers :id
+      extend CommandExtension
 
+      class AddUserCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :users
-        apipie_options
 
         success_message "The user has been associated"
         failure_message "Could not associate the user"
       end
 
       class RemoveUserCommand < HammerCLIForeman::RemoveAssociatedCommand
-        associated_identifiers :id
-
         associated_resource :users
-        apipie_options
 
         success_message "The user has been disassociated"
         failure_message "Could not disassociate the user"
@@ -116,36 +143,35 @@ module HammerCLIForeman
     end
 
     module ConfigTemplate
+      extend CommandExtension
+
       class AddConfigTemplateCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :config_templates
-        apipie_options
       end
 
       class RemoveConfigTemplateCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :config_templates
-        apipie_options
       end
     end
 
     module Organization
+      extend CommandExtension
+
       class AddOrganizationCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :organizations
-        apipie_options
       end
 
       class RemoveOrganizationCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :organizations
-        apipie_options
       end
     end
 
     module OperatingSystem
+      extend CommandExtension
+
       class AddOSCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :operatingsystems
 
-        associated_identifiers :id
-        apipie_options
-
         success_message _("Operating system has been associated")
         failure_message _("Could not associate the operating system")
       end
@@ -154,18 +180,16 @@ module HammerCLIForeman
       class RemoveOSCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :operatingsystems
 
-        associated_identifiers :id
-        apipie_options
-
         success_message _("Operating system has been disassociated")
         failure_message _("Could not disassociate the operating system")
       end
     end
 
     module Architecture
+      extend CommandExtension
+
       class AddArchitectureCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :architectures
-        apipie_options
 
         success_message _("Architecture has been associated")
         failure_message _("Could not associate the architecture")
@@ -174,7 +198,6 @@ module HammerCLIForeman
 
       class RemoveArchitectureCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :architectures
-        apipie_options
 
         success_message _("Architecture has been disassociated")
         failure_message _("Could not disassociate the architecture")
@@ -182,9 +205,10 @@ module HammerCLIForeman
     end
 
     module PartitionTable
+      extend CommandExtension
+
       class AddPartitionTableCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :ptables
-        apipie_options
 
         success_message _("Partition table has been associated")
         failure_message _("Could not associate the partition table")
@@ -193,7 +217,6 @@ module HammerCLIForeman
 
       class RemovePartitionTableCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :ptables
-        apipie_options
 
         success_message _("Partition table has been disassociated")
         failure_message _("Could not disassociate the partition table")

data/lib/hammer_cli_foreman/commands.rb

@@ -18,25 +18,22 @@ module HammerCLIForeman
     config[:api_version] = 2
     config[:aggressive_cache_checking] = HammerCLI::Settings.get(:foreman, :refresh_cache) || true
     config[:headers] = { "Accept-Language" => HammerCLI::I18n.locale }
+    config[:language] = HammerCLI::I18n.locale
     config[:timeout] = HammerCLI::Settings.get(:foreman, :request_timeout)
+    config[:timeout] = -1 if (config[:timeout] && config[:timeout].to_i < 0)
     config
   end
 
-  def self.foreman_resource(resource)
+  def self.foreman_api_connection
     HammerCLI::Connection.create(
-        CONNECTION_NAME,
-        HammerCLI::Apipie::Command.resource_config.merge(resource_config),
-        HammerCLI::Apipie::Command.connection_options).api.resource(resource)
+      CONNECTION_NAME,
+      HammerCLI::Apipie::Command.resource_config.merge(resource_config),
+      HammerCLI::Apipie::Command.connection_options
+    )
   end
 
-  module ConnectionSetup
-    def connection_name(resource_class)
-      CONNECTION_NAME
-    end
-
-    def resource_config
-      super.merge(HammerCLIForeman.resource_config)
-    end
+  def self.foreman_resource(resource)
+    foreman_api_connection.api.resource(resource)
   end
 
   def self.collection_to_common_format(data)
@@ -65,23 +62,71 @@ module HammerCLIForeman
       data.class <= Hash && data.keys.length == 1 ? data[data.keys[0]] : data
   end
 
-  class ReadCommand < HammerCLI::Apipie::ReadCommand
-    extend HammerCLIForeman::ConnectionSetup
-  end
 
-  class Command < ReadCommand
-  end
+  class Command < HammerCLI::Apipie::Command
+
+    def self.connection_name(resource_class)
+      CONNECTION_NAME
+    end
+
+    def self.resource_config
+      super.merge(HammerCLIForeman.resource_config)
+    end
+
+    def resolver
+      self.class.resolver
+    end
+
+    def searchables
+      self.class.searchables
+    end
+
+    def get_identifier
+      @identifier ||= get_resource_id(resource)
+      @identifier
+    end
+
+    def get_resource_id(resource, options={})
+      if options[:scoped]
+        opts = resolver.scoped_options(resource.singular_name, all_options)
+      else
+        opts = all_options
+      end
+      begin
+        resolver.send("#{resource.singular_name}_id", opts)
+      rescue HammerCLIForeman::MissingSeachOptions => e
+        raise e unless (options[:required] == false)
+      end
+    end
+
+    def self.resolver
+      api = HammerCLI::Connection.get("foreman").api
+      HammerCLIForeman::IdResolver.new(api, HammerCLIForeman::Searchables.new)
+    end
 
-  class WriteCommand < HammerCLI::Apipie::WriteCommand
-    extend HammerCLIForeman::ConnectionSetup
+    def self.searchables
+      @searchables ||= HammerCLIForeman::Searchables.new
+      @searchables
+    end
 
     def send_request
       HammerCLIForeman.record_to_common_format(super)
     end
 
+    def request_params
+      params = super
+      resolver.id_params(resource.action(action)).each do |api_param|
+        param_resource = resolver.param_to_resource(api_param.name)
+        resource_id = get_resource_id(param_resource, :scoped => true, :required => api_param.required?)
+        params[api_param.name] = resource_id if resource_id
+      end
+      params
+    end
+
   end
 
-  class ListCommand < ReadCommand
+
+  class ListCommand < Command
 
     action :index
 
@@ -91,7 +136,7 @@ module HammerCLIForeman
       :table
     end
 
-    def retrieve_data
+    def send_request
       data = super
       set = HammerCLIForeman.collection_to_common_format(data)
       set.map! { |r| extend_data(r) }
@@ -120,6 +165,7 @@ module HammerCLIForeman
 
     protected
 
+
     def browse_collection
       list_next = true
 
@@ -137,31 +183,89 @@ module HammerCLIForeman
     end
 
     def retrieve_and_print
-      d = retrieve_data
-      logger.watch "Retrieved data: ", d
+      d = send_request
       print_data d
       d
     end
 
+    def self.custom_option_builders
+      builders = super
+      if resource_defined?
+        builders += [
+          DependentSearchablesOptionBuilder.new(resolver.dependent_resources(resource, :required => true, :recursive => true), searchables),
+          DependentSearchablesOptionBuilder.new(resolver.dependent_resources(resource, :required => false, :recursive => false), searchables)
+        ]
+      end
+      builders
+    end
+
   end
 
 
-  class InfoCommand < ReadCommand
+  class SingleResourceCommand < Command
 
-    action :show
+    def self.custom_option_builders
+      builders = super
+      if resource_defined?
+        builders += [
+          SearchablesOptionBuilder.new(resource, searchables),
+          DependentSearchablesOptionBuilder.new(resolver.dependent_resources(resource, :required => true, :recursive => true), searchables),
+          DependentSearchablesOptionBuilder.new(resolver.dependent_resources(resource, :required => false, :recursive => false), searchables)
+        ]
+      end
+      builders
+    end
 
-    def self.command_name(name=nil)
-      super(name) || "info"
+    def request_params
+      params = super
+      params['id'] ||= get_identifier
+      params
+    end
+
+  end
+
+
+  class AssociatedResourceListCommand < ListCommand
+
+    option "--id", "ID", " "
+
+    def parent_resource
+      self.class.parent_resource
     end
 
-    identifiers :id, :name
+    def self.parent_resource(name=nil)
+      @parent_api_resource = HammerCLIForeman.foreman_resource(name) unless name.nil?
+      return @parent_api_resource if @parent_api_resource
+      return superclass.parent_resource if superclass.respond_to? :parent_resource
+    end
+
+    def self.custom_option_builders
+      [
+        HammerCLI::Apipie::OptionBuilder.new(resource.action(action), :require_options => false),
+        SearchablesOptionBuilder.new(parent_resource, searchables)
+      ]
+    end
 
     def request_params
+      id_param_name = "#{parent_resource.singular_name}_id"
+
       params = method_options
-      params.update('id' => get_identifier[0])
+      params[id_param_name] = get_resource_id(parent_resource)
+      params
+    end
+
+  end
+
+
+  class InfoCommand < SingleResourceCommand
+
+    action :show
+
+    def self.command_name(name=nil)
+      super(name) || "info"
     end
 
-    def retrieve_data
+    def send_request
       data = super
       record = HammerCLIForeman.record_to_common_format(data)
       extend_data(record)
@@ -178,7 +282,7 @@ module HammerCLIForeman
   end
 
 
-  class CreateCommand < WriteCommand
+  class CreateCommand < Command
 
     action :create
 
@@ -186,10 +290,22 @@ module HammerCLIForeman
       super(name) || "create"
     end
 
+    def self.custom_option_builders
+      builders = super
+      if resource_defined?
+        builders += [
+          SearchablesOptionBuilder.new(resource, searchables),
+          DependentSearchablesOptionBuilder.new(resolver.dependent_resources(resource, :required => true, :recursive => true), searchables),
+          DependentSearchablesOptionBuilder.new(resolver.dependent_resources(resource, :required => false, :recursive => false), searchables)
+        ]
+      end
+      builders
+    end
+
   end
 
 
-  class UpdateCommand < WriteCommand
+  class UpdateCommand < SingleResourceCommand
 
     action :update
 
@@ -197,23 +313,30 @@ module HammerCLIForeman
       super(name) || "update"
     end
 
-    identifiers :id, :name => :option_current_name
-
-    def self.setup_identifier_options
-      super
-      option "--new-name", "NEW_NAME", _("new name for the resource"), :attribute_name => :option_name if identifier? :name
+    def self.custom_option_builders
+      builders = super
+      if resource_defined?
+        builders += [
+          SearchablesUpdateOptionBuilder.new(resource, searchables)
+        ]
+      end
+      builders
     end
 
-    def request_params
-      params = method_options
-      params['id'] = get_identifier[0]
-      params
+    def method_options_for_params(params, include_nil=true)
+      opts = super
+      # overwrite searchables with correct values
+      searchables.for(resource).each do |s|
+        new_value = get_option_value("new_#{s.name}")
+        opts[s.name] = new_value unless new_value.nil?
+      end
+      opts
     end
 
   end
 
 
-  class DeleteCommand < WriteCommand
+  class DeleteCommand < SingleResourceCommand
 
     action :destroy
 
@@ -221,75 +344,44 @@ module HammerCLIForeman
       super(name) || "delete"
     end
 
-    identifiers :id, :name
-
-    def request_params
-      {'id' => get_identifier[0]}
-    end
-
   end
 
 
-  class AssociatedCommand < WriteCommand
-
-    identifiers :name, :id
-    action :update
-
-    def validate_options
-      associated_ids = self.class.declared_associated_identifiers.collect {|id_name| "associated_#{id_name}" }
-      validator.any(*associated_ids).required
-      validator.any(*self.class.declared_identifiers.values).required
-    end
+  class AssociatedCommand < Command
 
-    def self.apipie_options(options={})
-      setup_associated_identifier_options
-      super
-    end
+    option "--id", "ID", " "
 
-    def self.setup_associated_identifier_options
-      name = associated_resource.singular_name
-      option_switch = "--"+name.gsub('_', '-')
+    action :update
 
-      option option_switch, name.upcase, " ", :attribute_name => :associated_name do |value|
-        name_to_id(value, "name", associated_resource)
-      end if declared_associated_identifiers.include? :name
-      option option_switch+"-id", name.upcase+"_ID", " ", :attribute_name => :associated_id if declared_associated_identifiers.include? :id
+    def self.custom_option_builders
+      [
+        SearchablesOptionBuilder.new(resource, searchables),
+        DependentSearchablesOptionBuilder.new(resolver.dependent_resources(resource, :required => true, :recursive => true), searchables),
+        DependentSearchablesOptionBuilder.new(associated_resource, searchables),
+        DependentSearchablesOptionBuilder.new(resolver.dependent_resources(associated_resource, :required => true, :recursive => true), searchables)
+      ]
     end
 
-
     def associated_resource
       self.class.associated_resource
     end
 
-    def self.associated_resource(resource_class=nil)
-      @associated_api_resource = HammerCLIForeman.foreman_resource(resource_class) unless resource_class.nil?
-      return @associated_api_resource
+    def self.associated_resource(name=nil)
+      @associated_api_resource = HammerCLIForeman.foreman_resource(name) unless name.nil?
+      return @associated_api_resource if @associated_api_resource
+      return superclass.associated_resource if superclass.respond_to? :associated_resource
     end
 
-
-
-    def self.associated_identifiers(*keys)
-      @associated_identifiers = keys
+    def get_associated_identifier
+      get_resource_id(associated_resource, :scoped => true)
     end
 
-    def self.declared_associated_identifiers
-      if @associated_identifiers
-        return @associated_identifiers
-      elsif superclass.respond_to?(:declared_associated_identifiers, true)
-        superclass.declared_associated_identifiers
-      else
-        []
-      end
-    end
-
-    associated_identifiers :name, :id
-
     def get_new_ids
       []
     end
 
     def get_current_ids
-      item = HammerCLIForeman.record_to_common_format(resource.call(:show, {:id => get_identifier[0]}))
+      item = HammerCLIForeman.record_to_common_format(resource.call(:show, {:id => get_identifier}))
       if item.has_key?(association_name(true))
         item[association_name(true)].map { |assoc| assoc['id'] }
       else
@@ -297,19 +389,14 @@ module HammerCLIForeman
       end
     end
 
-    def get_required_id
-      item = HammerCLIForeman.record_to_common_format(associated_resource.call(:show, {:id => associated_id || associated_name}))
-      item['id']
-    end
-
     def request_params
-      params = super
+      params = method_options
       if params.key?(resource.singular_name)
         params[resource.singular_name] = {"#{association_name}_ids" => get_new_ids }
       else
         params["#{association_name}_ids"] = get_new_ids
       end
-      params['id'] = get_identifier[0]
+      params['id'] = get_identifier
       params
     end
 
@@ -331,8 +418,8 @@ module HammerCLIForeman
     end
 
     def get_new_ids
-      ids = get_current_ids
-      required_id = get_required_id
+      ids = get_current_ids.map(&:to_s)
+      required_id = get_associated_identifier.to_s
 
       ids << required_id unless ids.include? required_id
       ids
@@ -352,8 +439,8 @@ module HammerCLIForeman
     end
 
     def get_new_ids
-      ids = get_current_ids
-      required_id = get_required_id
+      ids = get_current_ids.map(&:to_s)
+      required_id = get_associated_identifier.to_s
 
       ids = ids.delete_if { |id| id == required_id }
       ids