hammer_cli_foreman 0.1.0 → 0.1.1

data/lib/hammer_cli_foreman/common_parameter.rb

@@ -13,16 +13,16 @@ module HammerCLIForeman
         field :value, _("Value")
       end
 
-      apipie_options
+      build_options
     end
 
-    class SetCommand < HammerCLIForeman::WriteCommand
+    class SetCommand < HammerCLIForeman::Command
 
       command_name "set"
       desc _("Set a global parameter.")
 
-      success_message_for :create, _("Created parameter [%{name}s] with value [%{value}s].")
-      success_message_for :update, _("Parameter [%{name}s] updated to [%{value}s].")
+      success_message_for :create, _("Created parameter [%{name}] with value [%{value}].")
+      success_message_for :update, _("Parameter [%{name}] updated to [%{value}].")
 
       option "--name", "NAME", _("parameter name"), :required => true
       option "--value", "VALUE", _("parameter value"), :required => true
@@ -52,13 +52,10 @@ module HammerCLIForeman
 
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _("Global parameter [%{name}] deleted.")
+      failure_message _("Could not delete the global parameter [%{name}]")
 
-      identifiers :name
-
-      success_message _("Global parameter [%{name}s] deleted.")
-      failure_message _("Could not delete the global parameter [%{name}s]")
-
-      apipie_options :without => :id
+      build_options :without => :id
     end
 
     autoload_subcommands

data/lib/hammer_cli_foreman/compute_resource.rb

@@ -13,12 +13,11 @@ module HammerCLIForeman
         field :provider, _("Provider")
       end
 
-      apipie_options
+      build_options
     end
 
 
     class InfoCommand < HammerCLIForeman::InfoCommand
-
       PROVIDER_SPECIFIC_FIELDS = {
         'ovirt' => [
           Fields::Field.new(:label => _('UUID'), :path => ["compute_resource", "uuid"])
@@ -44,17 +43,17 @@ module HammerCLIForeman
         field :url, _("Url")
         field :description, _("Description")
         field :user, _("User")
-        field :created_at, _("Created at"), Fields::Date
-        field :updated_at, _("Updated at"), Fields::Date
+        HammerCLIForeman::References.taxonomies(self)
+        HammerCLIForeman::References.timestamps(self)
       end
 
       def print_data(data)
         provider = data["provider"].downcase
         output_definition.fields.concat PROVIDER_SPECIFIC_FIELDS[provider]
-        print_collection(output_definition, data)
+        super(data)
       end
 
-      apipie_options
+      build_options
     end
 
 
@@ -63,7 +62,7 @@ module HammerCLIForeman
       success_message _("Compute resource created")
       failure_message _("Could not create the compute resource")
 
-      apipie_options
+      build_options
 
       validate_options do
         all(:option_name, :option_url, :option_provider).required
@@ -72,20 +71,18 @@ module HammerCLIForeman
 
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
-
       success_message _("Compute resource updated")
       failure_message _("Could not update the compute resource")
 
-      apipie_options
+      build_options :without => :name
     end
 
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
-
       success_message _("Compute resource deleted")
       failure_message _("Could not delete the compute resource")
 
-      apipie_options
+      build_options
     end
 
 

data/lib/hammer_cli_foreman/domain.rb

@@ -11,7 +11,7 @@ module HammerCLIForeman
         field :name, _("Name")
       end
 
-      apipie_options
+      build_options
     end
 
 
@@ -20,60 +20,48 @@ module HammerCLIForeman
       output ListCommand.output_definition do
         field :fullname, _("Description")
         field :dns_id, _("DNS Id")
-        field :created_at, _("Created at"), Fields::Date
-        field :updated_at, _("Updated at"), Fields::Date
-        collection :parameters, _("Parameters") do
-          field nil, nil, Fields::KeyValue
-        end
+        HammerCLIForeman::References.subnets(self)
+        HammerCLIForeman::References.taxonomies(self)
+        HammerCLIForeman::References.parameters(self)
+        HammerCLIForeman::References.timestamps(self)
       end
 
-      def extend_data(record)
-        record["parameters"] = HammerCLIForeman::Parameter.get_parameters(resource_config, :domain, record)
-        record
-      end
-
-      apipie_options
+      build_options
     end
 
 
     class CreateCommand < HammerCLIForeman::CreateCommand
 
-      success_message _("Domain [%{name}s] created")
+      success_message _("Domain [%{name}] created")
       failure_message _("Could not create the domain")
 
-      apipie_options :without => [:domain_parameters_attributes, :fullname]
       option "--description", "DESC", _("Full name describing the domain"), :attribute_name => :option_fullname
+      build_options :without => [:domain_parameters_attributes, :fullname]
     end
 
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
 
-      success_message _("Domain [%{name}s] updated")
+      success_message _("Domain [%{name}] updated")
       failure_message _("Could not update the domain")
 
-      apipie_options :without => [:domain_parameters_attributes, :name, :id, :fullname]
       option "--description", "DESC", _("Full name describing the domain"), :attribute_name => :option_fullname
+      build_options :without => [:domain_parameters_attributes, :fullname]
     end
 
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
 
-      success_message _("Domain [%{name}s] deleted")
+      success_message _("Domain [%{name}] deleted")
       failure_message _("Could not delete the domain")
 
-      apipie_options
+      build_options
     end
 
 
     class SetParameterCommand < HammerCLIForeman::Parameter::SetCommand
-
-      resource :parameters
-
       desc _("Create or update parameter for a domain.")
 
-      option "--domain-name", "DOMAIN_NAME", _("name of the domain the parameter is being set for")
-      option "--domain-id", "DOMAIN_ID", _("id of the domain the parameter is being set for")
-
       success_message_for :update, _("Domain parameter updated")
       success_message_for :create, _("New domain parameter created")
       failure_message _("Could not set domain parameter")
@@ -83,23 +71,13 @@ module HammerCLIForeman
         validator.any(:option_domain_name, :option_domain_id).required
       end
 
-      def base_action_params
-        {
-          "domain_id" => option_domain_id || option_domain_name
-        }
-      end
+      build_options
     end
 
 
     class DeleteParameterCommand < HammerCLIForeman::Parameter::DeleteCommand
-
-      resource :parameters
-
       desc _("Delete parameter for a domain.")
 
-      option "--domain-name", "DOMAIN_NAME", _("name of the domain the parameter is being deleted for")
-      option "--domain-id", "DOMAIN_ID", _("id of the domain the parameter is being deleted for")
-
       success_message _("Domain parameter deleted")
 
       def validate_options
@@ -107,11 +85,7 @@ module HammerCLIForeman
         validator.any(:option_domain_name, :option_domain_id).required
       end
 
-      def base_action_params
-        {
-          "domain_id" => option_domain_id || option_domain_name
-        }
-      end
+      build_options
     end
 
     autoload_subcommands

data/lib/hammer_cli_foreman/environment.rb

@@ -15,52 +15,47 @@ module HammerCLIForeman
         field :name, _("Name")
       end
 
-      apipie_options
+      build_options
     end
 
 
     class InfoCommand < HammerCLIForeman::InfoCommand
-
       output ListCommand.output_definition do
-        field :created_at, _("Created at"), Fields::Date
-        field :updated_at, _("Updated at"), Fields::Date
+        HammerCLIForeman::References.puppetclasses(self)
+        HammerCLIForeman::References.taxonomies(self)
+        HammerCLIForeman::References.timestamps(self)
       end
 
-      apipie_options
+      build_options
     end
 
 
     class CreateCommand < HammerCLIForeman::CreateCommand
-
       success_message _("Environment created")
       failure_message _("Could not create the environment")
 
-      apipie_options
+      build_options
     end
 
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
-
       success_message _("Environment updated")
       failure_message _("Could not update the environment")
 
-      apipie_options
+      build_options
     end
 
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
-
       success_message _("Environment deleted")
       failure_message _("Could not delete the environment")
 
-      apipie_options
+      build_options
     end
 
     class SCParamsCommand < HammerCLIForeman::SmartClassParametersList
-
-      apipie_options :without => [:host_id, :hostgroup_id, :puppetclass_id, :environment_id]
-      option ['--id', '--name'], 'ENVIRONMENT_ID', _('environment id/name'),
-            :required => true, :attribute_name => :environment_id
+      parent_resource :environments
+      build_options
     end
 
 

data/lib/hammer_cli_foreman/exceptions.rb

@@ -2,6 +2,10 @@ module HammerCLIForeman
 
   class OperationNotSupportedError < StandardError; end
 
+  # Resolver exceptions
+  class ResolverError < StandardError; end
+  class MissingSeachOptions < ResolverError; end
+
 end
 
 

data/lib/hammer_cli_foreman/fact.rb

@@ -6,7 +6,7 @@ module HammerCLIForeman
 
       resource :fact_values, :index
 
-      apipie_options
+      build_options
 
       output do
         field :host, _("Host")
@@ -14,17 +14,17 @@ module HammerCLIForeman
         field :value, _("Value")
       end
 
-      def retrieve_data
+      def send_request
         self.class.unhash_facts(super)
       end
 
-      def self.unhash_facts(facts_hash)
-        facts = facts_hash.first.inject([]) do |list, (host, facts)|
+      def self.unhash_facts(facts_collection)
+        facts = facts_collection.first.inject([]) do |list, (host, facts)|
           list + facts.collect do |(fact, value)|
             { :host => host, :fact => fact, :value => value }
           end
         end
-        HammerCLI::Output::RecordCollection.new(facts, :meta => facts_hash.meta)
+        HammerCLI::Output::RecordCollection.new(facts, :meta => facts_collection.meta)
       end
     end
 

data/lib/hammer_cli_foreman/host.rb

@@ -9,20 +9,6 @@ module HammerCLIForeman
   module CommonHostUpdateOptions
 
     def self.included(base)
-      base.apipie_options :without => [:host_parameters_attributes, :environment_id, :architecture_id, :domain_id,
-            :puppet_proxy_id, :operatingsystem_id,
-            # - temporarily disabled params until we add support for boolean options to apipie -
-            :build, :managed, :enabled, :start,
-            # - temporarily disabled params until they are fixed in API
-            :puppet_class_ids, #3884
-            # - temporarily disabled params that will be removed from the api ------------------
-            :provision_method, :capabilities, :flavour_ref, :image_ref, :start,
-            :network, :cpus, :memory, :provider, :type, :tenant_id, :image_id,
-            # - avoids future conflicts as :root_pass is currently missing in the api docs
-            :root_pass,
-            # ----------------------------------------------------------------------------------
-            :compute_resource_id, :ptable_id] + base.declared_identifiers.keys
-
       base.option "--environment-id", "ENVIRONMENT_ID", " "
       base.option "--architecture-id", "ARCHITECTURE_ID", " "
       base.option "--domain-id", "DOMAIN_ID", " "
@@ -30,7 +16,6 @@ module HammerCLIForeman
       base.option "--operatingsystem-id", "OPERATINGSYSTEM_ID", " "
       base.option "--partition-table-id", "PARTITION_TABLE_ID", " "
       base.option "--compute-resource-id", "COMPUTE_RESOURCE", " "
-      base.option "--partition-table-id", "PARTITION_TABLE", " "
       base.option "--puppetclass-ids", "PUPPETCLASS_IDS", " ",
         :format => HammerCLI::Options::Normalizers::List.new
       base.option "--root-password", "ROOT_PW", " "
@@ -58,6 +43,18 @@ module HammerCLIForeman
         :format => HammerCLI::Options::Normalizers::KeyValueList.new
       base.option "--provision-method", "METHOD", " ",
         :format => HammerCLI::Options::Normalizers::Enum.new(['build', 'image'])
+
+      base.build_options :without => [
+            # - temporarily disabled params until they are fixed in API ------------------------
+            # issue #3884
+            :puppet_class_ids,
+            # - temporarily disabled params that will be removed from the api ------------------
+            :provision_method, :capabilities, :flavour_ref, :image_ref, :start,
+            :network, :cpus, :memory, :provider, :type, :tenant_id, :image_id,
+            # - avoids future conflicts as :root_pass is currently missing in the api docs
+            :root_pass,
+            # ----------------------------------------------------------------------------------
+            :ptable_id, :host_parameters_attributes]
     end
 
     def self.ask_password
@@ -126,21 +123,24 @@ module HammerCLIForeman
       output do
         field :id, _("Id")
         field :name, _("Name")
-        field :operatingsystem_id, _("Operating System Id")
-        field :hostgroup_id, _("Host Group Id")
+        field nil, _("Operating System"), Fields::SingleReference, :key => :operatingsystem
+        field nil, _("Host Group"), Fields::SingleReference, :key => :hostgroup
         field :ip, _("IP")
         field :mac, _("MAC")
       end
 
-      apipie_options
+      build_options
     end
 
 
     class InfoCommand < HammerCLIForeman::InfoCommand
 
       def extend_data(host)
-        host["environment_name"] = host["environment"]["environment"]["name"] rescue nil
-        host["parameters"] = HammerCLIForeman::Parameter.get_parameters(resource_config, :host, host)
+        # FIXME: temporary fetching parameters until the api gets fixed.
+        # Noramlly they should come in the host's json.
+        # http://projects.theforeman.org/issues/5820
+        host["parameters"] = get_parameters(host["id"])
+
         host["_bmc_interfaces"] =
           host["interfaces"].select{|intfs| intfs["type"] == "Nic::BMC" } rescue []
         host["_managed_interfaces"] =
@@ -148,12 +148,16 @@ module HammerCLIForeman
         host
       end
 
+      def get_parameters(host_id)
+        params = HammerCLIForeman.foreman_resource(:parameters).call(:index, :host_id => host_id)
+        HammerCLIForeman.collection_to_common_format(params)
+      end
+
       output ListCommand.output_definition do
         field :uuid, _("UUID")
         field :certname, _("Cert name")
 
-        field :environment_name, _("Environment")
-        field :environment_id, _("Environment Id")
+        field nil, _("Environment"), Fields::SingleReference, :key => :environment
 
         field :managed, _("Managed")
         field :enabled, _("Enabled")
@@ -166,33 +170,27 @@ module HammerCLIForeman
         field :sp_name, _("SP Name")
         field :sp_ip, _("SP IP")
         field :sp_mac, _("SP MAC")
-        field :sp_subnet, _("SP Subnet")
-        field :sp_subnet_id, _("SP Subnet Id")
 
-        field :created_at, _("Created at"), Fields::Date
-        field :updated_at, _("Updated at"), Fields::Date
+        field nil, _("SP Subnet"), Fields::SingleReference, :key => :sp_subnet
+
         field :installed_at, _("Installed at"), Fields::Date
         field :last_report, _("Last report"), Fields::Date
 
         field :puppet_ca_proxy_id, _("Puppet CA Proxy Id")
-        field :medium_id, _("Medium Id")
-        field :model_id, _("Model Id")
+        field nil, _("Medium"), Fields::SingleReference, :key => :medium
+        field nil, _("Model"), Fields::SingleReference, :key => :model
         field :owner_id, _("Owner Id")
-        field :subnet_id, _("Subnet Id")
-        field :domain_id, _("Domain Id")
+        field nil, _("Subnet"), Fields::SingleReference, :key => :subnet
+        field nil, _("Domain"), Fields::SingleReference, :key => :domain
         field :puppet_proxy_id, _("Puppet Proxy Id")
         field :owner_type, _("Owner Type")
-        field :ptable_id, _("Partition Table Id")
-        field :architecture_id, _("Architecture Id")
-        field :image_id, _("Image Id")
-        field :compute_resource_id, _("Compute Resource Id")
+        field nil, _("Partition Table"), Fields::SingleReference, :key => :ptable
+        field nil, _("Architecture"), Fields::SingleReference, :key => :architecture
+        field nil, _("Image"), Fields::SingleReference, :key => :image
+        field nil, _("Compute Resource"), Fields::SingleReference, :key => :compute_resource
 
         field :comment, _("Comment")
 
-        collection :parameters, _("Parameters") do
-          field nil, nil, Fields::KeyValue
-        end
-
         collection :_bmc_interfaces, _("BMC Network Interfaces"), :hide_blank => true do
           field :id, _("Id")
           field :name, _("Name")
@@ -217,24 +215,24 @@ module HammerCLIForeman
           field :subnet_name, _("Subnet Name")
         end
 
+        HammerCLIForeman::References.parameters(self)
+        HammerCLIForeman::References.timestamps(self)
       end
 
-      apipie_options
+      build_options
     end
 
 
-    class StatusCommand < HammerCLI::Apipie::ReadCommand
-
-      identifiers :id, :name
-
+    class StatusCommand < HammerCLIForeman::SingleResourceCommand
       command_name "status"
+      action :status
 
       output do
         field :status, _("Status")
         field :power, _("Power")
       end
 
-      def retrieve_data
+      def send_request
         {
           :status => get_status,
           :power => get_power_status
@@ -243,7 +241,7 @@ module HammerCLIForeman
 
       def get_status
         params = {
-          'id' => get_identifier[0],
+          'id' => get_identifier,
         }
         status = resource.call(:status, params)
         status["status"]
@@ -251,19 +249,18 @@ module HammerCLIForeman
 
       def get_power_status
         params = {
-          'id' => get_identifier[0],
+          'id' => get_identifier,
           'power_action' => :state
         }
         status = resource.call(:power, params)
         status["power"]
       end
 
-      apipie_options
+      build_options
     end
 
 
-    class PuppetRunCommand < HammerCLIForeman::InfoCommand
-
+    class PuppetRunCommand < HammerCLIForeman::SingleResourceCommand
       command_name "puppetrun"
       action :puppetrun
 
@@ -271,77 +268,54 @@ module HammerCLIForeman
         print_message _('Puppet run triggered')
       end
 
-      apipie_options
+      build_options
     end
 
 
-    class FactsCommand < HammerCLIForeman::ListCommand
-
+    class FactsCommand < HammerCLIForeman::AssociatedResourceListCommand
       command_name "facts"
       resource :fact_values, :index
-      identifiers :id, :name
-
-      apipie_options :without => declared_identifiers.keys
+      parent_resource :hosts
 
       output do
         field :fact, _("Fact")
         field :value, _("Value")
       end
 
-      def request_params
-        params = method_options
-        params['host_id'] = get_identifier[0]
-        params
-      end
-
-      def retrieve_data
-        data = super
-        HammerCLIForeman::Fact::ListCommand.unhash_facts(data)
+      def send_request
+        HammerCLIForeman::Fact::ListCommand.unhash_facts(super)
       end
 
+      build_options
     end
 
 
-    class PuppetClassesCommand < HammerCLIForeman::ListCommand
-
+    class PuppetClassesCommand < HammerCLIForeman::AssociatedResourceListCommand
       command_name "puppet-classes"
-      resource :puppetclasses
-
-      identifiers :id, :name
+      resource :puppetclasses, :index
+      parent_resource :hosts
 
       output HammerCLIForeman::PuppetClass::ListCommand.output_definition
 
-      def retrieve_data
+      def send_request
         HammerCLIForeman::PuppetClass::ListCommand.unhash_classes(super)
       end
 
-      def request_params
-        params = method_options
-        params['host_id'] = get_identifier[0]
-        params
-      end
-
-      apipie_options
+      build_options :without => [:host_id, :hostgroup_id, :environment_id]
     end
 
 
-    class ReportsCommand < HammerCLIForeman::ListCommand
-
-      identifiers :id, :name
-
+    class ReportsCommand < HammerCLIForeman::AssociatedResourceListCommand
       command_name "reports"
-      resource :reports
-      output HammerCLIForeman::Report::ListCommand.output_definition
+      resource :reports, :index
+      parent_resource :hosts
 
-      apipie_options :without => :search
+      output HammerCLIForeman::Report::ListCommand.output_definition
 
-      def search
-        'host.id = %s' % get_identifier[0].to_s
-      end
+      build_options
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
-
       success_message _("Host created")
       failure_message _("Could not create the host")
 
@@ -364,7 +338,6 @@ module HammerCLIForeman
 
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
-
       success_message _("Host updated")
       failure_message _("Could not update the host")
 
@@ -373,23 +346,16 @@ module HammerCLIForeman
 
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
-
       success_message _("Host deleted")
       failure_message _("Could not delete the host")
 
-      apipie_options
+      build_options
     end
 
 
     class SetParameterCommand < HammerCLIForeman::Parameter::SetCommand
-
-      resource :parameters
-
       desc _("Create or update parameter for a host.")
 
-      option "--host-name", "HOST_NAME", _("name of the host the parameter is being set for")
-      option "--host-id", "HOST_ID", _("id of the host the parameter is being set for")
-
       success_message_for :update, _("Host parameter updated")
       success_message_for :create, _("New host parameter created")
       failure_message _("Could not set host parameter")
@@ -399,23 +365,13 @@ module HammerCLIForeman
         validator.any(:option_host_name, :option_host_id).required
       end
 
-      def base_action_params
-        {
-          "host_id" => option_host_id || option_host_name
-        }
-      end
+      build_options
     end
 
 
     class DeleteParameterCommand < HammerCLIForeman::Parameter::DeleteCommand
-
-      resource :parameters
-
       desc _("Delete parameter for a host.")
 
-      option "--host-name", "HOST_NAME", _("name of the host the parameter is being deleted for")
-      option "--host-id", "HOST_ID", _("id of the host the parameter is being deleted for")
-
       success_message _("Host parameter deleted")
 
       def validate_options
@@ -423,17 +379,11 @@ module HammerCLIForeman
         validator.any(:option_host_name, :option_host_id).required
       end
 
-      def base_action_params
-        {
-          "host_id" => option_host_id || option_host_name
-        }
-      end
+      build_options
     end
 
 
-    class StartCommand < HammerCLI::Apipie::WriteCommand
-
-      identifiers :id, :name
+    class StartCommand < HammerCLIForeman::SingleResourceCommand
       action :power
 
       command_name "start"
@@ -446,19 +396,17 @@ module HammerCLIForeman
 
       def request_params
         params = method_options
-        params['id'] = get_identifier[0]
+        params['id'] = get_identifier
         params
       end
 
-      apipie_options :without => :power_action
+      build_options :without => :power_action
     end
 
 
-    class StopCommand < HammerCLI::Apipie::WriteCommand
-
+    class StopCommand < HammerCLIForeman::SingleResourceCommand
       option '--force', :flag, _("Force turning off a host")
 
-      identifiers :id, :name
       action :power
 
       command_name "stop"
@@ -482,16 +430,14 @@ module HammerCLIForeman
 
       def request_params
         params = method_options
-        params['id'] = get_identifier[0]
+        params['id'] = get_identifier
         params
       end
 
-      apipie_options :without => :power_action
+      build_options :without => :power_action
     end
 
-    class RebootCommand < HammerCLI::Apipie::WriteCommand
-
-      identifiers :id, :name
+    class RebootCommand < HammerCLIForeman::SingleResourceCommand
       action :power
 
       command_name "reboot"
@@ -504,18 +450,16 @@ module HammerCLIForeman
 
       def request_params
         params = method_options
-        params['id'] = get_identifier[0]
+        params['id'] = get_identifier
         params
       end
 
-      apipie_options :without => :power_action
+      build_options :without => :power_action
     end
 
     class SCParamsCommand < HammerCLIForeman::SmartClassParametersList
-
-      apipie_options :without => [:host_id, :hostgroup_id, :puppetclass_id, :environment_id]
-      option ['--id', '--name'], 'HOST_ID', _('host id/name'),
-              :attribute_name => :option_host_id, :required => true
+      parent_resource :hosts
+      build_options
     end
 
     autoload_subcommands